has_bitfield 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

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

@@ -0,0 +1,60 @@
+= has_bitfield
+
+A rails gem for easy bitfield support.
+
+Has support form multiple bitfield columns.  See http://github.com/aka47/has_flags for a gem with a different feature set.
+
+== Install
+
+  gem install has_bitfield
+
+== Usage
+  class MyClass << ActiveRecord::Base
+    has_bitfield :column_name,
+         1 => :flag1,
+         2 => :flag2,
+         3 => :flag3
+  end
+
+== Attribute Accessors
+   readers: name, name?
+   writer: name=(v)
+   where 'name' is the name of the bit field.  the (v) parameter can be true/false, "true"/"false", 0/1, 'yes'/'no',
+   or :yes/:no.  specifically, the following (v) inputs evaluate to true:
+     [ true, 'true', 'yes', :yes, 'ok', :ok, 1, '1' ]
+   all others, including nil evaluate false.
+   groups_name = [Array of flags] , not the plural
+   groups_name << name
+   groups_name
+   group_ids
+   group_ids = [Array of flag-ids]
+
+
+The database table must include the column 'column_name' as an integer.
+
+Defaults are set in per column 'after_initialized' callbacks.  If your model needs to use this
+callback, define it in the class and invoke: initialize_column_name.
+
+  class MyClass << ActiveRecord::Base
+    has_bitfield :my_flags,
+         1 => {:flag1  => { :default => false }},
+         2 => :flag2,
+         3 => :flag3
+
+    after_initialize :initialize_my_flags
+  end
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Hugo Duncan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "has_bitfield"
+    gem.summary = %Q{A rails gem for easy bitfield support.}
+    gem.description = %Q{Enable bitfield properties in ActiveRecord models.}
+    gem.email = "hugo_duncan@yahoo.com"
+    gem.homepage = "http://github.com/hugoduncan/has_bitfield"
+    gem.authors = ["Hugo Duncan"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has_bitfield #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/has_bitfield.rb

@@ -0,0 +1,137 @@
+module HasBitfield
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  FLAG_VALUE_OPTIONS = [:default] unless defined? FLAG_VALUE_OPTIONS
+  FLAG_OPTIONS = [:as,:name] unless defined? FLAG_OPTIONS
+
+  module ClassMethods
+    def has_bitfield(name, flags_hash)
+      @has_bitfield ||= {}
+      values = {}
+      bits = {}
+      defaults = {}
+      bit_names = {}
+      field = flags_hash.delete(:as) || "#{name}_flags".to_sym
+      @has_bitfield[name] = {
+        :as => field,
+        :values => values,
+        :bit_names => bit_names,
+        :defaults => defaults
+      }
+
+      default_mask = 0
+
+      flags_hash.each do |key, flag|
+        flag_name, options = hash_for_flag(flag)
+        raise ArgumentError, "has_bitfield: keys should be positive integers less than or equal to 32.
+ '#{key}' is invalid as a key for '#{flag_name}'." unless is_valid_bit?(key)
+
+        value = 2**(key - 1)
+        values[flag] = value
+        bit_names[key] = flag
+        default = options.has_key?(:default) ? options[:default] : false;
+        defaults[key] = default
+        default_mask = default_mask | value if default
+        methods_for_flag(flag_name, value, field)
+      end
+
+      method_for_name(name, field)
+      method_for_initialize(name, default_mask, field)
+    end
+
+    protected
+
+    def methods_for_flag(flag, value, field)
+      class_eval <<-EVAL
+        def #{flag}?
+          flag_set?(:#{field}, #{value})
+        end
+
+        def #{flag}
+          flag_set?(:#{field}, #{value})
+        end
+
+        def #{flag}=(value)
+          if value.is_a?(String)
+            value = Integer(value)
+            value = (value!=0)
+          end
+          value ? set_flag(:#{field}, #{value}) : clear_flag(:#{field}, #{value})
+        end
+
+        def self.#{flag}_condition
+          condition_for_flag(:#{field}, #{value}, true)
+        end
+
+        def self.not_#{flag}_condition
+          condition_for_flag(:#{field}, #{value}, false)
+        end
+        EVAL
+    end
+
+    def method_for_initialize(name, mask, field)
+      class_eval <<-EVAL
+          def initialize_#{name}
+            self[:#{field}] = #{mask}
+               end
+        EVAL
+    end
+
+    def method_for_name(name, field)
+      class_eval <<-EVAL
+          def #{name}
+            self[:#{field}]
+          end
+        EVAL
+    end
+
+    def flag_metadata
+      @has_bitfield
+    end
+
+    def has_flag?(flag)
+      @has_bitfield.any? { |name, meta| meta.values.keys.include?(flag) }
+    end
+
+    private
+      def condition_for_flag(field, value, enabled)
+        "(#{table_name}.#{field} & #{value} = #{enabled ? '1': '0'})"
+      end
+
+      def is_valid_bit?(key)
+        key > 0 && key == key.to_i && key < 33
+      end
+
+      def hash_for_flag(value)
+        if value.is_a?(Symbol)
+          [ value, {} ]
+        else
+          if value.size != 1
+            raise ArgumentError("invalid flag specification for #{value.inspect}")
+          end
+          [ value.keys[0], value.values[0] ]
+        end
+      end
+  end # module
+
+    private
+  def set_flag(field, value)
+    self[field] = self[field] | value
+  end
+
+  def clear_flag(field, value)
+    self[field] = self[field] & ~value
+  end
+
+  def flag_set?(field, value)
+    self[field] & value != 0
+  end
+
+  def flag_clear?(field, value)
+    self[field] & value == 0
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'has_bitfield'
+
+class Test::Unit::TestCase
+end

data/test/test_has_bitfield.rb

@@ -0,0 +1,171 @@
+require 'helper'
+require 'active_support/core_ext'
+require 'active_support/test_case'
+
+# ActiveRecord proxies
+module Proxy
+  class Column
+    def name
+      'flags'
+    end
+    def type
+      :integer
+    end
+  end
+
+  class Base < Hash
+    def self.columns
+      [Column.new]
+    end
+
+    def flags=(value)
+      self[:flags] = value
+    end
+
+    def flags
+      self[:flags]
+    end
+
+  end
+end
+
+class Foo < Proxy::Base
+  include ::HasBitfield
+
+  def self.table_name
+    "foos"
+  end
+
+  has_bitfield(:my_flags,
+               :as => :flags,
+               1 => :active,
+               2 => :suspended,
+               3 => { :another => { :default => true } } )
+end
+
+class HasBitfieldTest < ActiveSupport::TestCase
+
+  test "should raise an exception when a negative bit is specified" do
+    assert_raises ArgumentError do
+      eval(<<-EOF
+        class Invalid < Proxy::Base
+          include ::HasBitfield
+          has_bitfield({ -1 => :error })
+        end
+        EOF
+        )
+    end
+  end
+
+  test "should raise an exception when a zero bit is specified" do
+    assert_raises ArgumentError do
+      eval(<<-EOF
+        class Invalid < Proxy::Base
+          include ::HasBitfield
+          has_bitfield({ 0 => :error })
+        end
+      EOF
+      )
+    end
+  end
+
+  test "should raise an exception when a bit above 32 is specified" do
+    assert_raises ArgumentError do
+      eval(<<-EOF
+        class Invalid < Proxy::Base
+          include ::HasBitfield
+          has_bitfield({ 33 => :error })
+        end
+      EOF
+      )
+    end
+  end
+
+  def setup
+    @foo = Foo.new
+  end
+
+  test "test class should have flags field" do
+    @foo.flags = 1
+    assert_equal 1, @foo.flags
+    assert_equal 1, @foo[:flags]
+
+    @foo[:flags] = 2
+    assert_equal 2, @foo.flags
+    assert_equal 2, @foo[:flags]
+  end
+
+  test "should have my_flags reader" do
+    @foo.flags = 1
+    assert_equal 1, @foo.my_flags
+
+    @foo[:flags] = 2
+    assert_equal 2, @foo.my_flags
+  end
+
+  test "should return the initialized flag field" do
+    @foo.initialize_my_flags
+    assert_equal 4, @foo.my_flags
+  end
+
+  test "should correctly define predicate" do
+    @foo[:flags] = 4
+    assert !@foo.active?
+    assert !@foo.suspended?
+    assert @foo.another?
+  end
+
+  test "should correctly define reader" do
+    @foo[:flags] = 4
+    assert !@foo.active
+    assert !@foo.suspended
+    assert @foo.another
+  end
+
+  test "should correctly define assignment" do
+    @foo[:flags] = 4
+    @foo.active = true
+    assert @foo.active?
+    assert !@foo.suspended?
+    assert @foo.another?
+
+    @foo.active = false
+    assert !@foo.active?
+    assert !@foo.suspended?
+    assert @foo.another?
+  end
+
+  test "should correctly assign from string" do
+    @foo[:flags] = 4
+    @foo.active="1"
+    assert @foo.active
+    @foo.active="0"
+    assert !@foo.active
+  end
+
+  test "should define condition" do
+    assert_equal "(foos.flags & 1 = 1)", Foo.active_condition
+  end
+
+  test "should define negated condition" do
+    assert_equal "(foos.flags & 1 = 0)", Foo.not_active_condition
+  end
+
+  test "should correctly assign current value" do
+    @foo[:flags] = 4
+    @foo.active = true
+    2.times do
+      @foo.active = false
+      assert !@foo.active?
+    end
+  end
+
+  test "should have an initial value" do
+    @foo.initialize_my_flags
+    assert_equal false, @foo.active?
+    assert_equal false, @foo.suspended?
+    assert_equal true, @foo.another?
+  end
+
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: has_bitfield
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Hugo Duncan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-16 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Enable bitfield properties in ActiveRecord models.
+email: hugo_duncan@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/has_bitfield.rb
+- test/helper.rb
+- test/test_has_bitfield.rb
+has_rdoc: true
+homepage: http://github.com/hugoduncan/has_bitfield
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A rails gem for easy bitfield support.
+test_files: 
+- test/helper.rb
+- test/test_has_bitfield.rb