bitmask_attributes 0.3.0 → 0.4.0

data/CHANGELOG.rdoc

@@ -1,3 +1,48 @@
+=== Version 0.4.0 - 2012-12-14 19:37:49 +0000
+
+Adrian Gomez (1):
+* Fixing issue #22
+
+Brad Dunbar (1):
+* Add default option.
+
+Dominik Bamberger (5):
+* Introduce raw bitmask setter.
+* Ensure unsupported values for raw bitmasks raise an exception
+* First reset instance variable then write attribute.
+* Introduce inverse convenience class method
+* Allow only valid entries when setting raw bitmask values directly
+
+François DELFORT (2):
+* Handle single table inheritance
+* Fix for handling STI table
+
+Joel Moss (7):
+* Merge pull request #17 from teeparham/patch-1
+* Merge pull request #18 from tight/master
+* Merge pull request #29 from adimitrov/include-table-name
+* Merge pull request #33 from teeparham/or_is_null
+* Merge pull request #30 from pathable/default
+* Bundle update
+* Merge branch 'master' of github.com:joelmoss/bitmask_attributes
+
+Steve Hoeksema (2):
+* Strip trailing whitespace
+* Add table name to one scope that missed out
+
+Tee Parham (2):
+* update sample controller code
+* add table name scope to or_is_null_condition
+
+alexanderd (1):
+* Include table name in scope definitions
+
+steve emmons (3):
+* Merge pull request #26 from b4mboo/inverse_convenience
+* Merge pull request #25 from b4mboo/raw_bitmask_setter
+* Merge pull request #23 from Moove-it/master
+
+
 === Version 0.3.0 - 2012-04-30 21:36:18 +0100
 
 Aaron Hamid (1):
@@ -9,42 +54,17 @@ Andre Duffeck (1):
 Ivan Buiko (1):
 * Adding retrieval by exact value
 
-Joel Moss (9):
-* Merge pull request #6 from incandescent/fix-scope-proc
-* Merge pull request #4 from SUSE/fix_values_for
-* Bundle update
-* Adding retrieval by exact value
-* Merge branch 'retrieval-by-exact-value'
-* Resolved merge conflict
-* Merge pull request #9 from numerex/master
-* Merge pull request #13 from spemmons/master
-* Merge pull request #16 from spemmons/master
-
 Sebastian Borrazas (1):
 * Not raising exception when the bitmask column is not found, since its adding it on a migration
 
 spemmons (22):
 * detect whether or not nulls are possible with an attribute and remove OR conditions checking if it is null or not
-* ignore RubyMine info
-* merge changes with joel moss for scopes
 * check for model not being ready when creating scopes
 * support nulls with an explicit attribute, not by inspecting the model due to preloading issues
-* add documentation for the :null option
 * support multiple values in the "without_..." scope that excludes match for of any of the bits; previously 2nd and following values were ignored
-* update documentation to reflect support for multiple arguments to "without_..."
-* update documentation to reflect support for multiple arguments to "without_..."
-* update documentation to reflect support for multiple arguments to "without_..."
-* added tests to verify the validity of zykadelic's complaint that "with_" scopes were improperly including "OR IS NOT NULL" and fixed the code by removing the condition in this case
 * DRY-up scope expressions, standardizing on "no_" and "bitmask_for_...(*values)" instead of repeating more complex calculations; also found another example of zykadelic's complaint with "with_any_" that is fixed and has tests
 * add travis configuration file
-* follow buffpojken in forcing string-interpolated model to work in global scope
-* Merge branch 'master' of github.com:spemmons/bitmask_attributes
-* remove out-dated helpers that, although no longer used, were being loaded by Travis-CI and failing
-* clarify travis config to fix failing CI build that works locally
-* apparently 1.9.2 doesn't work... will figure out why later
-* add :zero option and tests
-* check for a string match instead of a symbol to allow values arriving from web forms and services to match properly
-* added documentation for the :zero attribute
+* add :zero_value option and tests
 * rename :zero to :zero_value for clarity
 
 steve emmons (3):
@@ -65,3 +85,4 @@ Joel Moss (3):
 
 
 
+

data/Gemfile.lock

@@ -1,40 +1,51 @@
 PATH
   remote: .
   specs:
-    bitmask_attributes (0.2.4)
+    bitmask_attributes (0.3.0)
       activerecord (~> 3.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.2)
-      activesupport (= 3.2.2)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
       builder (~> 3.0.0)
-    activerecord (3.2.2)
-      activemodel (= 3.2.2)
-      activesupport (= 3.2.2)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.2)
+    activesupport (3.2.9)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    ansi (1.4.2)
+    ansi (1.4.3)
     arel (3.0.2)
-    builder (3.0.0)
-    i18n (0.6.0)
-    json (1.6.5)
-    multi_json (1.1.0)
-    rake (0.9.2.2)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    builder (3.0.4)
+    i18n (0.6.1)
+    json (1.7.5)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.5.0)
+    rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
-    sdoc (0.3.16)
+    sdoc (0.3.20)
       json (>= 1.1.3)
       rdoc (~> 3.10)
-    shoulda (2.11.3)
-    sqlite3 (1.3.5)
-    turn (0.8.3)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    sqlite3 (1.3.6)
+    turn (0.9.6)
       ansi
-    tzinfo (0.3.32)
+    tzinfo (0.3.35)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -137,7 +137,7 @@ will not change the attribute. For example:
     In controller...
         def update
             @some_model = SomeModel.find(params[:id])
-            params[:some_attribute] ||= []
+            params[:some_model][:some_attribute] ||= []
             @some_model.update_attributes(params)
         end
 

data/lib/bitmask_attributes.rb

@@ -9,18 +9,35 @@ module BitmaskAttributes
       unless options[:as] && options[:as].kind_of?(Array)
         raise ArgumentError, "Must provide an Array :as option"
       end
-      bitmask_definitions[attribute] = Definition.new(attribute, options[:as].to_a,options[:null].nil? || options[:null],options[:zero_value],&extension)
+
+      if default = options[:default]
+        after_initialize do
+          send("#{attribute}=", default) unless send("#{attribute}?")
+        end
+      end
+
+      bitmask_definitions[attribute] = Definition.new(attribute, options[:as].to_a,options[:null].nil? || options[:null], options[:zero_value], &extension)
       bitmask_definitions[attribute].install_on(self)
     end
-    
+
     def bitmask_definitions
-      @bitmask_definitions ||= {}
+      base_class.base_class_bitmask_definitions
     end
-    
+
     def bitmasks
+      base_class.base_class_bitmasks
+    end
+
+    protected
+
+    def base_class_bitmask_definitions
+      @bitmask_definitions ||= {}
+    end
+
+    def base_class_bitmasks
       @bitmasks ||= {}
     end
-  end  
+  end
 end
 
-ActiveRecord::Base.send :include, BitmaskAttributes
+ActiveRecord::Base.send :include, BitmaskAttributes

data/lib/bitmask_attributes/definition.rb

@@ -1,7 +1,7 @@
 module BitmaskAttributes
   class Definition
     attr_reader :attribute, :values, :allow_null, :zero_value, :extension
-    
+
     def initialize(attribute, values=[],allow_null = true,zero_value = nil, &extension)
       @attribute = attribute
       @values = values
@@ -9,7 +9,7 @@ module BitmaskAttributes
       @allow_null = allow_null
       @zero_value = zero_value
     end
-    
+
     def install_on(model)
       validate_for model
       generate_bitmasks_on model
@@ -29,10 +29,19 @@ module BitmaskAttributes
         return if defined?(Rails) && Rails.configuration.cache_classes || !model.table_exists?
 
         unless model.columns.detect { |col| col.name == attribute.to_s }
-          Rails.logger.warn "WARNING: `#{attribute}' is not an attribute of `#{model}'. But, it's ok if it happens during migrations and your \"bitmasked\" attribute is still not created."
+          missing_attribute(attribute, model)
+        end
+      end
+
+      def missing_attribute(attribute, model)
+        message = "WARNING: `#{attribute}' is not an attribute of `#{model.class.name}'. But, it's ok if it happens during migrations and your \"bitmasked\" attribute is still not created."
+        if defined?(Rails)
+          Rails.logger.warn message
+        else
+          STDERR.puts message
         end
       end
-    
+
       def generate_bitmasks_on(model)
         model.bitmasks[attribute] = HashWithIndifferentAccess.new.tap do |mapping|
           values.each_with_index do |value, index|
@@ -40,12 +49,12 @@ module BitmaskAttributes
           end
         end
       end
-    
+
       def override(model)
         override_getter_on(model)
         override_setter_on(model)
       end
-    
+
       def override_getter_on(model)
         model.class_eval %(
           def #{attribute}
@@ -53,16 +62,26 @@ module BitmaskAttributes
           end
         )
       end
-    
+
       def override_setter_on(model)
         model.class_eval %(
           def #{attribute}=(raw_value)
             values = raw_value.kind_of?(Array) ? raw_value : [raw_value]
             self.#{attribute}.replace(values.reject{|value| #{eval_string_for_zero('value')}})
           end
+          def #{attribute}_bitmask=(entry)
+            unless entry.is_a? Fixnum
+              raise ArgumentError, "Expected a Fixnum, but got: \#{entry.inspect}"
+            end
+            unless entry.between?(0, 2 ** (self.class.bitmasks[:#{attribute}].size - 1))
+              raise ArgumentError, "Unsupported value for #{attribute}: \#{entry.inspect}"
+            end
+            @#{attribute} = nil
+            self.send(:write_attribute, :#{attribute}, entry)
+          end
         )
       end
-    
+
       # Returns the defined values as an Array.
       def create_attribute_methods_on(model)
         model.class_eval %(
@@ -71,7 +90,7 @@ module BitmaskAttributes
           end                                   # end
         )
       end
-    
+
       def create_convenience_class_method_on(model)
         model.class_eval %(
           def self.bitmask_for_#{attribute}(*values)
@@ -84,13 +103,24 @@ module BitmaskAttributes
               bitmask | bit
             end
           end
+
+          def self.#{attribute}_for_bitmask(entry)
+            unless entry.is_a? Fixnum
+              raise ArgumentError, "Expected a Fixnum, but got: \#{entry.inspect}"
+            end
+            self.bitmasks[:#{attribute}].inject([]) do |values, (value, bitmask)|
+              values.tap do
+                values << value.to_sym if (entry & bitmask > 0)
+              end
+            end
+          end
         )
       end
 
       def create_convenience_instance_methods_on(model)
         values.each do |value|
           model.class_eval %(
-            def #{attribute}_for_#{value}?                  
+            def #{attribute}_for_#{value}?
               self.#{attribute}?(:#{value})
             end
           )
@@ -107,29 +137,29 @@ module BitmaskAttributes
           end
         )
       end
-    
+
       def create_scopes_on(model)
-        or_is_null_condition = " OR #{attribute} IS NULL" if allow_null
+        or_is_null_condition = " OR #{model.table_name}.#{attribute} IS NULL" if allow_null
 
         model.class_eval %(
           scope :with_#{attribute},
             proc { |*values|
               if values.blank?
-                where('#{attribute} > 0')
+                where('#{model.table_name}.#{attribute} > 0')
               else
                 sets = values.map do |value|
                   mask = ::#{model}.bitmask_for_#{attribute}(value)
-                  "#{attribute} & \#{mask} <> 0"
+                  "#{model.table_name}.#{attribute} & \#{mask} <> 0"
                 end
                 where(sets.join(' AND '))
               end
             }
-          scope :without_#{attribute}, 
+          scope :without_#{attribute},
             proc { |*values|
               if values.blank?
                 no_#{attribute}
               else
-                where("#{attribute} & ? = 0#{or_is_null_condition}", ::#{model}.bitmask_for_#{attribute}(*values))
+                where("#{model.table_name}.#{attribute} & ? = 0#{or_is_null_condition}", ::#{model}.bitmask_for_#{attribute}(*values))
               end
             }
 
@@ -138,27 +168,27 @@ module BitmaskAttributes
               if values.blank?
                 no_#{attribute}
               else
-                where("#{attribute} = ?", ::#{model}.bitmask_for_#{attribute}(*values))
+                where("#{model.table_name}.#{attribute} = ?", ::#{model}.bitmask_for_#{attribute}(*values))
               end
             }
-          
-          scope :no_#{attribute}, proc { where("#{attribute} = 0#{or_is_null_condition}") }
+
+          scope :no_#{attribute}, proc { where("#{model.table_name}.#{attribute} = 0#{or_is_null_condition}") }
 
           scope :with_any_#{attribute},
             proc { |*values|
               if values.blank?
-                where('#{attribute} > 0')
+                where('#{model.table_name}.#{attribute} > 0')
               else
-                where("#{attribute} & ? <> 0", ::#{model}.bitmask_for_#{attribute}(*values))
+                where("#{model.table_name}.#{attribute} & ? <> 0", ::#{model}.bitmask_for_#{attribute}(*values))
               end
             }
         )
         values.each do |value|
           model.class_eval %(
             scope :#{attribute}_for_#{value},
-                  proc { where('#{attribute} & ? <> 0', ::#{model}.bitmask_for_#{attribute}(:#{value})) }
+                  proc { where('#{model.table_name}.#{attribute} & ? <> 0', ::#{model}.bitmask_for_#{attribute}(:#{value})) }
           )
-        end      
+        end
       end
 
       def eval_string_for_zero(value_string)

data/lib/bitmask_attributes/version.rb

@@ -1,3 +1,3 @@
 module BitmaskAttributes
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

data/test/bitmask_attributes/definition_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class BitmaskAttributesTest < ActiveSupport::TestCase
+
+  context 'validate_for' do
+    context 'when missing column' do
+      setup do
+        @column = Class.new do
+          attr_reader :name
+
+          def initialize(name); @name = name end
+        end
+
+        @model = Class.new do
+          attr_reader :columns
+
+          def initialize(columns); @columns = columns end
+
+          def table_exists?; true end
+
+          def self.name; 'Model' end
+        end
+      end
+
+      should 'not fail' do
+        definition = BitmaskAttributes::Definition.new(:missing_column)
+
+        some_model = @model.new([@column.new(:name)])
+        definition.send(:validate_for, some_model)
+      end
+    end
+  end
+
+end

data/test/bitmask_attributes_test.rb

@@ -53,6 +53,14 @@ class BitmaskAttributesTest < ActiveSupport::TestCase
         assert_stored campaign, :phone, :email
       end
 
+      should "can assign raw bitmask values" do
+        campaign = @campaign_class.new
+        campaign.medium_bitmask = 3
+        assert_stored campaign, :web, :print
+        campaign.medium_bitmask = 0
+        assert_empty campaign.medium
+      end
+
       should "can save bitmask to db and retrieve values transparently" do
         campaign = @campaign_class.new(:medium => [:web, :print])
         assert_stored campaign, :web, :print
@@ -78,6 +86,18 @@ class BitmaskAttributesTest < ActiveSupport::TestCase
         assert_unsupported { campaign.medium = [:so_will_this] }
       end
 
+      should "can only use Fixnum values for raw bitmask values" do
+        campaign = @campaign_class.new(:medium => :web)
+        assert_unsupported { campaign.medium_bitmask = :this_will_fail }
+      end
+
+      should "cannot use unsupported values for raw bitmask values" do
+        campaign = @campaign_class.new(:medium => :web)
+        number_of_attributes = @campaign_class.bitmasks[:medium].size
+        assert_unsupported { campaign.medium_bitmask = (2 ** number_of_attributes) }
+        assert_unsupported { campaign.medium_bitmask = -1 }
+      end
+
       should "can determine bitmasks using convenience method" do
         assert @campaign_class.bitmask_for_medium(:web, :print)
         assert_equal(
@@ -90,6 +110,15 @@ class BitmaskAttributesTest < ActiveSupport::TestCase
         assert_unsupported { @campaign_class.bitmask_for_medium(:web, :and_this_isnt_valid)  }
       end
 
+      should "can determine bitmask entries using inverse convenience method" do
+        assert @campaign_class.medium_for_bitmask(3)
+        assert_equal([:web, :print], @campaign_class.medium_for_bitmask(3))
+      end
+
+      should "assert use of non Fixnum value in inverse convenience method will result in exception" do
+        assert_unsupported { @campaign_class.medium_for_bitmask(:this_isnt_valid)  }
+      end
+
       should "hash of values is with indifferent access" do
         string_bit = nil
         assert_nothing_raised do
@@ -174,7 +203,7 @@ class BitmaskAttributesTest < ActiveSupport::TestCase
           assert_equal [@campaign2, @campaign7], @company.campaigns.without_medium(:web, :print)
           assert_equal [@campaign2, @campaign3, @campaign4], @company.campaigns.without_medium(:print, :phone)
         end
-        
+
         should "support retrieval by exact value" do
           assert_equal [@campaign4], @company.campaigns.with_exact_medium(:web)
           assert_equal [@campaign1], @company.campaigns.with_exact_medium(:web, :print)
@@ -270,6 +299,15 @@ class BitmaskAttributesTest < ActiveSupport::TestCase
     end
   end
 
+  should "accept a default value option" do
+    assert_equal DefaultValue.new.default_sym, [:y]
+    assert_equal DefaultValue.new.default_array, [:y, :z]
+    assert_equal DefaultValue.new(:default_sym => :x).default_sym, [:x]
+    assert_equal DefaultValue.new(:default_array => [:x]).default_array, [:x]
+  end
+
   context_with_classes 'Campaign with null attributes',CampaignWithNull,CompanyWithNull
   context_with_classes 'Campaign without null attributes',CampaignWithoutNull,CompanyWithoutNull
-end
+  context_with_classes 'SubCampaign with null attributes',SubCampaignWithNull,CompanyWithNull
+  context_with_classes 'SubCampaign without null attributes',SubCampaignWithoutNull,CompanyWithoutNull
+end

data/test/support/models.rb

@@ -1,7 +1,8 @@
-ActiveRecord::Schema.define do 
+ActiveRecord::Schema.define do
   create_table :campaign_with_nulls do |t|
     t.integer :company_id
     t.integer :medium, :allow_zero, :misc, :Legacy
+    t.string :type # STI
   end
   create_table :company_with_nulls do |t|
     t.string :name
@@ -9,10 +10,14 @@ ActiveRecord::Schema.define do
   create_table :campaign_without_nulls do |t|
     t.integer :company_id
     t.integer :medium, :allow_zero, :misc, :Legacy, :null => false, :default => 0
+    t.string :type # STI
   end
   create_table :company_without_nulls do |t|
     t.string :name
   end
+  create_table :default_values do |t|
+    t.integer :default_sym, :default_array
+  end
 end
 
 # Pseudo models for testing purposes
@@ -33,6 +38,9 @@ class CampaignWithNull < ActiveRecord::Base
   bitmask :Legacy, :as => [:upper, :case]
 end
 
+class SubCampaignWithNull < CampaignWithNull
+end
+
 class CompanyWithoutNull < ActiveRecord::Base
   has_many :campaigns,:class_name => 'CampaignWithoutNull',:foreign_key => 'company_id'
 end
@@ -47,4 +55,12 @@ class CampaignWithoutNull < ActiveRecord::Base
     end
   end
   bitmask :Legacy, :as => [:upper, :case], :null => false
-end
+end
+
+class SubCampaignWithoutNull < CampaignWithNull
+end
+
+class DefaultValue < ActiveRecord::Base
+  bitmask :default_sym, :as => [:x, :y, :z], :default => :y
+  bitmask :default_array, :as => [:x, :y, :z], :default => [:y, :z]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitmask_attributes
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,7 @@ files:
 - lib/bitmask_attributes/definition.rb
 - lib/bitmask_attributes/value_proxy.rb
 - lib/bitmask_attributes/version.rb
+- test/bitmask_attributes/definition_test.rb
 - test/bitmask_attributes_test.rb
 - test/support/models.rb
 - test/test_helper.rb
@@ -108,6 +109,7 @@ signing_key:
 specification_version: 3
 summary: Simple bitmask attribute support for ActiveRecord
 test_files:
+- test/bitmask_attributes/definition_test.rb
 - test/bitmask_attributes_test.rb
 - test/support/models.rb
 - test/test_helper.rb