DefaultScope

The DefaultScope plugin seeks to add the functionality of Rails' ActiveRecord::Base#default_scope to Wheels. While you can use set() right now in Wheels to alter the global defaults of the findAll() method, you can't set a scope for individual models. With this plugin, you can specify default values for the findAll() method on a specific model.

This plugin overrides the findAll() method and adds a new method called defaultScope().

New Methods

• defaultScope([ where, order, select, distinct, include, maxRows, page, perPage, count, handle, cache, reload, parameterize, returnAs, returnIncluded ])

This method is mixed in to your Models and is meant to be invoked from the init() method. It takes all of the same optional arguments as the findAll() method, and will set them as defaults for future calls to that method.

<!--- in any model --->
<cffunction name="init">
	<!--- assume we have a model containing user information, and
		you want to sort by the last name then first for most of your
		findAll() requests.  --->
	<cfset defaultScope(order="lastName, firstName") />
</cffunction>

Overridden Methods

• findAll()

While this method has been overridden in order to accommodate the new defaultScope settings, it still behaves the same as it did before. Use it the way you normally would. Just remember that you might have set some values in the defaultScope(). If you set new values for the same parameters here, those values will override the values set in defaultScope().

How to Use

Install it! Then the new method is automatically available to you.

Uninstallation

All you need to do is delete the /plugins/DefaultScope-x.x.zip file.

Thanks

To the rather active CFWheels Google group, and especially James Gibson who helped squirrel out an annoying bug during the initial development.

Release History

• 2010-04-05 -- 0.6.3
  • Compatibility update, through CFWheels 1.0.3
  • Fixing typo in column statistics methods
• 2009-12-19 -- 0.6.2
  • fix for DefaultScope causing issues with the calculations methods (andybellenie)
• 2009-12-09 -- 0.6.1
  • code cleanup
  • slight change to how the methods determine valid arguments for findAll() and defaultScope()
• 2009-12-08 -- 0.6
  • reduced loop overhead and simplified code (andybellenie)
• 2009-12-07 -- 0.5
  • initial public release
  • feature complete but probably bug-ridden
• 2009-12-05 -- 0.1
  • happy birthday

Problems/Known Issues

• If for some reason you decide to use ordered arguments rather than named arguments, then it won't work. The new findAll() expects named arguments only.
• The plugin could do with some testing and better documentation. Also, it would probably be good to steer away from my ... unorthodox method of defining arguments for methods.
• There's no consideration for environment at this time. It might be a good idea to cache the values from defaultScope() if you're in production mode. I need to learn how to do that.
• findAll() is used by the calculations methods (count, sum, average, etc.), which due to the SQL methods they use can't take an 'order' parameter. These methods are not making sure this parameter isn't being passed to findAll(), so this plugin now strips out the 'order' parameter before the calculations methods run. (Thanks, andybellenie, and you can see his path request for CFWheels to fix this at http://code.google.com/p/cfwheels/issues/detail?id=366)

License

(The MIT License)

Copyright (c) 2009 Joshua Clingenpeel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.