has-bit-field 0.3.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/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "activerecord"
+gem "jeweler"
+gem "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,50 @@
+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 "pjb3-has-bit-field", :lib => "has-bit-field", :source => "http://gems.github.com"
+
+Now in one of your models, you define a bit field like this:
+
+    class Person < ActiveRecord::Base
+      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
+      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!
+      
+Copyright
+---------
+
+Copyright (c) 2009 Paul Barry. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "has-bit-field"
+    gem.summary = %Q{Provides an easy way for dealing with bit fields and active record}
+    gem.email = "mail@paulbarry.com"
+    gem.homepage = "http://github.com/pjb3/has-bit-field"
+    gem.authors = ["Paul Barry"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has-bit-field #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/has-bit-field.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has-bit-field}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Barry"]
+  s.date = %q{2010-08-03}
+  s.email = %q{mail@paulbarry.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "has-bit-field.gemspec",
+     "lib/has-bit-field.rb",
+     "rails/init.rb",
+     "test/has-bit-field_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/pjb3/has-bit-field}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Provides an easy way for dealing with bit fields and active record}
+  s.test_files = [
+    "test/has-bit-field_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/has-bit-field.rb

@@ -0,0 +1,36 @@
+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)
+    args.each_with_index do |field,i|
+      (class << self; self end).send(:define_method, "#{field}_bit") do
+        (1 << i)
+      end
+      define_method(field) do
+        (send(bit_field_attribute).to_i & self.class.send("#{field}_bit")) != 0
+      end
+      define_method("#{field}?") do
+        send(field)
+      end
+      define_method("#{field}=") do |v|
+        if v.to_s == "true" || v.to_s == "1"
+          send("#{bit_field_attribute}=", ((send(bit_field_attribute) || 0) | self.class.send("#{field}_bit")))
+        else
+          send("#{bit_field_attribute}=", ((send(bit_field_attribute) || 0) & ~self.class.send("#{field}_bit")))
+        end
+      end
+      define_method("#{field}_was") do
+        (send("#{bit_field_attribute}_was") & self.class.send("#{field}_bit")) != 0
+      end
+      define_method("#{field}_changed?") do
+        send(field) != send("#{field}_was")
+      end
+      if(respond_to?(:named_scope))
+        named_scope field, :conditions => ["#{table_name}.#{bit_field_attribute} IS NOT NULL AND (#{table_name}.#{bit_field_attribute} & ?) != 0", send("#{field}_bit")]
+        named_scope "not_#{field}", :conditions => ["#{table_name}.#{bit_field_attribute} IS NULL OR (#{table_name}.#{bit_field_attribute} & ?) = 0", send("#{field}_bit")]
+      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,116 @@
+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
+end
+
+class Person < ActiveRecord::Base
+  extend HasBitField
+  #attr_accessor :bit_field
+  has_bit_field :bit_field, :likes_ice_cream, :plays_golf, :watches_tv, :reads_books
+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
+    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!
+
+    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_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
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+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'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: has-bit-field
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
+platform: ruby
+authors: 
+- Paul Barry
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-03 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mail@paulbarry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- has-bit-field.gemspec
+- lib/has-bit-field.rb
+- rails/init.rb
+- test/has-bit-field_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/pjb3/has-bit-field
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides an easy way for dealing with bit fields and active record
+test_files: 
+- test/has-bit-field_test.rb
+- test/test_helper.rb