API name change ideas for Infusion 1.0

Colin Clark colin.clark at utoronto.ca
Mon Mar 30 18:19:45 UTC 2009


Hi everyone,

As part of the Infusion 1.0 cleanup parade, we're going to consider  
improving the names of parts of our API. This has to be done with  
care, and we'll want to consider backwards compatibility for each  
method we rename.

Rules for the API renaming process:

1. Nominate your suggestions for methods to rename either on list or  
in the channel
2. The component co-coordinators need to be included in the renaming  
discussion
3. Propose a strategy for enabling backwards compatibility
4. Be gentle. Naming debates can easily fall into "bike shed"  
arguments or hurt people's feelings.

Here's my list of names that I'd like to see us discuss:

* The DARApplier and associated names
The DARApplier is the newest part of our framework. As model layer  
infrastrcture, the DARApplier allows components to make requests to  
the framework for changes in the model. It provides a scheme for  
validation routines to be plugged into this change request pipeline,  
and for change events to be fired as a result of successful updates to  
the model.

* Fluid.js: fluid.findKeyInObject()
This is a framework utility that performs reverse lookups in an  
object: pass in a value, and you'll get its associated key. This name  
always confuses me about the order and nature of the arguments.

* DataBinding.js: fluid.assembleSuperModel()
This one is a bit confusing. I'm not sure how and when I'd use it, and  
some in the community has said it reminds them of nerds in their  
basement. Enough said.

* UIEnhancer
UIEnhancer is the companion to UI Options, and is the component  
responsible for actually transforming the page based on user  
preferences. I like the name, but I wonder if it will be confused with  
the concept of Progressive Enhancement. We'll likely add framework- 
level support for progressively enhancing components in a future  
release. Maybe UITransfomer instead?

* Uploader.js: fileQueueView.repairFromUpload()
This is part of the Uploader's file queue view, and is called after  
the upload completes. I've never quite understood what it does from  
the name.

Ideas? Other methods you think we should rename?

Colin

---
Colin Clark
Technical Lead, Fluid Project
Adaptive Technology Resource Centre, University of Toronto
http://fluidproject.org




More information about the fluid-work mailing list