mandrews-has-bit-field 1.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.bundle

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm gemset use has-bit-field

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in has-bit-field.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    has-bit-field (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.10)
+      activesupport (= 2.3.10)
+    activesupport (2.3.10)
+    sqlite3-ruby (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 2.3.5)
+  has-bit-field!
+  sqlite3-ruby

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Paul Barry
+
+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.

data/README.md

@@ -0,0 +1,60 @@
+has-bit-field
+=============
+
+has-bit-field allows you to use one attribute of an object to store a bit field which stores the boolean state for multiple flags.
+
+To use this with Active Record, you would first require this gem in `config/environment.rb`:
+
+    config.gem "has-bit-field"
+
+Now in one of your models, you define a bit field like this:
+
+    class Person < ActiveRecord::Base
+      extend HasBitField
+      has_bit_field :bit_field, :likes_ice_cream, :plays_golf, :watches_tv, :reads_books
+    end
+
+This means that your database will have an integer column called `bit_field` which will hold the actual bit field.  This will generate getter and setter methods for each of the fields.  It will also generate a method that has `_bit` as a suffix which will give you the decimal value of the bit that that field is represented by in the bit field.  Also there will be a named scope for that field, as well as a named scope prefixed with `not_`, if class you are adding the bit field to responds to `named_scope`.  You can use it like this:
+
+    $ script/console 
+    Loading development environment (Rails 2.3.2)
+    p =>> p = Person.new
+    => #<Person id: nil, bit_field: nil, created_at: nil, updated_at: nil>
+    >> p.likes_ice_cream = "true"
+    => "true"
+    >> p.plays_golf = 1
+    => 1
+    >> p.save
+    => true
+    >> p = Person.find(p.id)
+    => #<Person id: 1, bit_field: 3, created_at: "2009-07-18 03:04:06", updated_at: "2009-07-18 03:04:06">
+    >> p.likes_ice_cream?
+    => true
+    >> p.reads_books?
+    => false
+    >> Person.plays_golf_bit
+    => 4
+    >> p = Person.likes_ice_cream.first
+    => #<Person id: 1, bit_field: 3, created_at: "2009-07-18 03:04:06", updated_at: "2009-07-18 03:04:06">
+    
+One of the great advantages of this approach is that it is easy to add additional flags as your application evolves without the overhead of adding new table columns since a single integer will be able to store at least 31 boolean flags.  A simple amendment to the model will create the new flag on the existing integer column 'on-the-fly'.  However, the order of the flags is vitally important and you should only ever add new flags on the end.
+
+    class Person < ActiveRecord::Base
+      extend HasBitField
+      has_bit_field :bit_field, :likes_ice_cream, :plays_golf, :watches_tv, :reads_books, :nut_allergy
+    end
+
+The new flag will be evaluated as false for existing rows on the database table until their values are explicitly set.  Be careful with the peanuts!
+
+Another gotcha to be aware of is when combining a bit field with Active Record's `validates_acceptance_of`.  When you call `validates_acceptance_of`, if there is no database column, Active Record will define an `attr_accessor` for that boolean field.  If you have already defined the bit field, this will clobber those methods.  Also, you need to set the value it's looking for to `true` instead of the default of `"1"`.  So here's an example of how to use it:
+
+    class Person < ActiveRecord::Base
+      extend HasBitField
+      validates_acceptance_of :read_books, :message => "You must agree to read", :accept => true
+      has_bit_field :bit_field, :likes_ice_cream, :plays_golf, :watches_tv, :reads_books
+    end
+      
+Copyright
+---------
+
+Copyright (c) 2009 Paul Barry. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/has-bit-field.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has-bit-field/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mandrews-has-bit-field"
+  s.version     = Has::Bit::Field::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Barry", 'Michael Andrews']
+  s.email       = ["mail@paulbarry.com"]
+  s.homepage    = "http://github.com/mandrews/has-bit-field"
+  s.summary     = "Provides an easy way to work with bit fields in active record"
+  s.description = "Provides an easy way to work with bit fields in active record"
+
+  s.rubyforge_project = "has-bit-field"
+  s.add_development_dependency "sqlite3-ruby"
+  s.add_development_dependency "activerecord", "~> 2.3.5"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/has-bit-field/version.rb

@@ -0,0 +1,7 @@
+module Has
+  module Bit
+    module Field
+      VERSION = "1.0.1"
+    end
+  end
+end

data/lib/has-bit-field.rb

@@ -0,0 +1,54 @@
+module HasBitField
+  # The first arguement +bit_field_attribute+ should be a symbol,
+  # the name of attribute that will hold the actual bit field
+  # all following arguments should also be symbols,
+  # which will be the name of each flag in the bit field
+  def has_bit_field(bit_field_attribute, *args)
+    constant = bit_field_attribute.to_s.pluralize.upcase
+    const_set(constant, args).freeze
+    args.each_with_index do |field,i|
+      class_eval %{
+        class << self
+          def #{field}_bit
+            (1 << #{i})
+          end
+        end
+
+        def #{field}
+          (#{bit_field_attribute} & self.class.#{field}_bit) != 0
+        end
+
+        alias #{field}? #{field}
+
+        def #{field}=(v)
+          if v.to_s == "true" || v.to_s == "1"
+            self.#{bit_field_attribute} = (#{bit_field_attribute} || 0) | self.class.#{field}_bit
+          else
+            self.#{bit_field_attribute} = (#{bit_field_attribute} || 0) & ~self.class.#{field}_bit
+          end
+        end
+
+        def #{field}_was
+          (#{bit_field_attribute}_was & self.class.#{field}_bit) != 0
+        end
+
+        def #{field}_changed?
+          #{field} != #{field}_was
+        end
+      }
+      if(respond_to?(:named_scope))
+        if table_exists? && columns_hash.has_key?(bit_field_attribute.to_s) && columns_hash[bit_field_attribute.to_s].null
+          class_eval %{
+            named_scope :#{field}, :conditions => ["#{table_name}.#{bit_field_attribute} IS NOT NULL AND (#{table_name}.#{bit_field_attribute} & ?) != 0", #{field}_bit]
+            named_scope :not_#{field}, :conditions => ["#{table_name}.#{bit_field_attribute} IS NULL OR (#{table_name}.#{bit_field_attribute} & ?) = 0", #{field}_bit]          
+          }
+        else
+          class_eval %{
+            named_scope :#{field}, :conditions => ["(#{table_name}.#{bit_field_attribute} & ?) != 0", #{field}_bit]
+            named_scope :not_#{field}, :conditions => ["(#{table_name}.#{bit_field_attribute} & ?) = 0", #{field}_bit]
+          }
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'has-bit-field'
+ActiveRecord::Base.extend HasBitField

data/test/has-bit-field_test.rb

@@ -0,0 +1,215 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database  => ":memory:"
+)
+
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Base.connection.create_table(:people) do |t|
+  t.integer :bit_field, :null => true
+end
+
+class Person < ActiveRecord::Base
+  extend HasBitField
+
+  has_bit_field :bit_field, :likes_ice_cream, :plays_golf, :watches_tv, :reads_books
+end
+
+
+ActiveRecord::Base.connection.create_table(:skills) do |t|
+  t.integer :outdoor_bit_field, :default => 0, :null => false
+  t.integer :indoor_bit_field, :default => 0, :null => false
+end
+
+class Skill < ActiveRecord::Base
+  extend HasBitField
+
+  validates_acceptance_of :chops_trees, :message => "You have to be a lumberjack", :accept => true
+  validates_acceptance_of :plays_piano, :message => "You must be a pianist", :accept => true
+
+  has_bit_field :outdoor_bit_field, :chops_trees, :builds_fences, :cuts_hedges
+  has_bit_field :indoor_bit_field, :plays_piano, :mops_floors, :makes_soup
+end
+
+class HasBitFieldTest < Test::Unit::TestCase
+
+  def test_bit_field
+    p = Person.new
+    [:likes_ice_cream, :plays_golf, :watches_tv, :reads_books].each do |f|
+      assert p.respond_to?("#{f}?"), "Expected #{p.inspect} to respond to #{f}?"
+      assert p.respond_to?("#{f}="), "Expected #{p.inspect} to respond to #{f}="
+    end
+
+    assert_equal Person.likes_ice_cream_bit, (1 << 0)
+    assert_equal Person.plays_golf_bit, (1 << 1)
+    assert_equal Person.watches_tv_bit, (1 << 2)
+    assert_equal Person.reads_books_bit, (1 << 3)
+
+    p.likes_ice_cream = true
+    assert p.likes_ice_cream?
+    assert !p.plays_golf?
+    assert !p.watches_tv?
+    assert !p.reads_books?
+
+    p.likes_ice_cream = true
+    assert p.likes_ice_cream?
+    assert !p.plays_golf?
+    assert !p.watches_tv?
+    assert !p.reads_books?
+
+    p.watches_tv = true
+    assert p.likes_ice_cream
+    assert !p.plays_golf
+    assert p.watches_tv
+    assert !p.reads_books
+
+    p.watches_tv = false
+    p.plays_golf = true
+    assert p.likes_ice_cream?
+    assert p.plays_golf?
+    assert !p.watches_tv?
+    assert !p.reads_books?
+
+    p.watches_tv = "1"
+    p.reads_books = "true"
+    assert p.likes_ice_cream?
+    assert p.plays_golf?
+    assert p.watches_tv?
+    assert p.reads_books?
+
+    p.likes_ice_cream = nil
+    p.plays_golf = 0
+    p.watches_tv = "0"
+    p.reads_books = "false"
+    assert !p.likes_ice_cream?
+    assert !p.plays_golf?
+    assert !p.watches_tv?
+    assert !p.reads_books?
+  end
+
+  def test_named_scopes_on_nullable_column
+    Person.delete_all
+    a = Person.new
+    a.plays_golf = true
+    a.reads_books = true
+    assert a.save
+
+    b = Person.new
+    b.likes_ice_cream = true
+    b.watches_tv = true
+    assert b.save
+
+    c = Person.create! :bit_field => 0
+
+    assert_equal [b], Person.likes_ice_cream.all(:order => "id")
+    assert_equal [a,c], Person.not_likes_ice_cream.all(:order => "id")
+
+    assert_equal [a], Person.plays_golf.all(:order => "id")
+    assert_equal [b,c], Person.not_plays_golf.all(:order => "id")
+
+    assert_equal [b], Person.watches_tv.all(:order => "id")
+    assert_equal [a,c], Person.not_watches_tv.all(:order => "id")
+
+    assert_equal [a], Person.reads_books.all(:order => "id")
+    assert_equal [b,c], Person.not_reads_books.all(:order => "id")
+  end
+
+  def test_named_scopes_on_non_nullable_column
+    Skill.delete_all
+    a = Skill.new
+    a.plays_piano = true
+    a.chops_trees = true
+    a.mops_floors = true
+    assert a.save, a.errors.full_messages.join(", ")
+
+    b = Skill.new
+    b.plays_piano = true
+    b.chops_trees = true
+    b.makes_soup = true
+    assert b.save, b.errors.full_messages.join(", ")
+
+    c = Skill.create! :plays_piano => true, :chops_trees => true
+
+    assert_equal [a,b,c], Skill.plays_piano.all(:order => "id")
+    assert_equal [], Skill.not_plays_piano.all(:order => "id")
+
+    assert_equal [a], Skill.mops_floors.all(:order => "id")
+    assert_equal [b,c], Skill.not_mops_floors.all(:order => "id")
+
+    assert_equal [b], Skill.makes_soup.all(:order => "id")
+    assert_equal [a,c], Skill.not_makes_soup.all(:order => "id")
+  end
+
+  def test_dirty_attributes
+    Person.delete_all
+    a = Person.new
+    a.plays_golf = true
+    a.reads_books = true
+    assert a.save
+
+    a.plays_golf = false
+    assert_equal false, a.plays_golf
+    assert_equal true, a.plays_golf_was
+    assert a.plays_golf_changed?
+    assert_equal true, a.reads_books
+    assert_equal true, a.reads_books_was
+    assert !a.reads_books_changed?
+  end
+
+  def test_ar_validations_no_default
+    s = Skill.new(:plays_piano => true, :builds_fences => true, :cuts_hedges => false)
+
+    assert_equal false, s.chops_trees?
+    assert_equal false, s.chops_trees
+    assert s.builds_fences?
+    assert !s.cuts_hedges?
+    assert !s.cuts_hedges
+
+    assert !s.valid?
+    assert s.errors[:chops_trees]
+
+    s.chops_trees = false
+    assert !s.chops_trees?
+    assert !s.valid?
+    assert s.errors[:chops_trees]
+
+    s.chops_trees = true
+    assert s.chops_trees?
+    assert s.valid?
+    assert !s.errors[:chops_trees]
+    assert s.save
+  end
+
+  def test_ar_validations_with_default
+    s = Skill.new(:chops_trees => true, :mops_floors => true, :makes_soup => false)
+
+    assert_equal false, s.plays_piano?
+    assert_equal false, s.plays_piano
+    assert s.mops_floors?
+    assert !s.makes_soup?
+    assert !s.makes_soup
+
+    assert !s.valid?
+    assert s.errors[:plays_piano]
+
+    s.plays_piano = false
+    assert !s.plays_piano?
+    assert !s.valid?
+    assert s.errors[:plays_piano]
+
+    s.plays_piano = true
+    assert s.plays_piano?
+    assert s.valid?
+    assert !s.errors[:plays_piano]
+    assert s.save
+  end
+
+  def test_defines_constant
+    assert_equal Person::BIT_FIELDS, [:likes_ice_cream, :plays_golf, :watches_tv, :reads_books]
+    assert_equal Skill::INDOOR_BIT_FIELDS, [:plays_piano, :mops_floors, :makes_soup]
+    assert_equal Skill::OUTDOOR_BIT_FIELDS, [:chops_trees, :builds_fences, :cuts_hedges]
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'test/unit'
+require 'active_record'
+require File.join(File.dirname(__FILE__), "../rails/init")
+require 'has-bit-field'
+
+#ActiveRecord::Base.logger = Logger.new($stdout)

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: mandrews-has-bit-field
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Paul Barry
+- Michael Andrews
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id002
+description: Provides an easy way to work with bit fields in active record
+email: 
+- mail@paulbarry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- has-bit-field.gemspec
+- lib/has-bit-field.rb
+- lib/has-bit-field/version.rb
+- rails/init.rb
+- test/has-bit-field_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mandrews/has-bit-field
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: has-bit-field
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Provides an easy way to work with bit fields in active record
+test_files: 
+- test/has-bit-field_test.rb
+- test/test_helper.rb