public
Description: Simple bitmask attribute support for ActiveRecord
Homepage:
Clone URL: git://github.com/bruce/bitmask-attribute.git
bruce (author)
Mon May 18 19:05:45 -0700 2009
commit  40c9753e40f2b1b82d7a6ff0c36e1c3b3bd2fb54
tree    21d8f77eaab37bfeeb72c3ace88b3a7fb1c778a0
parent  a43c784e3eb5971a1d223621d8b17066f89ad6e5
bitmask-attribute / README.markdown
100644 48 lines (32 sloc) 1.365 kb

bitmask-attribute

Transparent manipulation of bitmask attributes.

Example

Simply declare an existing integer column as a bitmask with its possible values.

class User < ActiveRecord::Base
  bitmask :roles, :as => [:writer, :publisher, :editor] 
end

You can then modify the column using the declared values without resorting to manual bitmasks.

user = User.create(:name => "Bruce", :roles => [:publisher, :editor])
user.roles
# => [:publisher, :editor]
user.roles << :writer
user.roles
# => [:publisher, :editor, :writer]

For the moment, querying for bitmasks is left as an exercise to the reader, but here's how to grab the bitmask for a specific possible value for use in your SQL query:

bitmask = User.bitmasks[:roles][:editor]
# Use `bitmask` as needed

Modifying possible values

Once you have data using a bitmask, don't change the order of the values, remove any values, or insert any new values in the array anywhere except at the end.

Contributing and reporting issues

Please feel free to fork & contribute fixes via GitHub pull requests. The official repository for this project is http://github.com/bruce/bitmask-attribute

Issues can be reported at http://github.com/bruce/bitmask-attribute/issues

Copyright

Copyright (c) 2007-2009 Bruce Williams. See LICENSE for details.