attr_bitwise 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fe35e1015d6b3d56fad87e17480767740a23dd0
-  data.tar.gz: c0ca410c937a40d73eab1b8dac53087cd93c4ab2
+  metadata.gz: 57bf7aecf5f3ba5b00efa5ea754231c9b9ed5cef
+  data.tar.gz: e7db4dc252699db2f4ac1ffbf17e450952c1ae2f
 SHA512:
-  metadata.gz: ddb05f9230a5a78c3f4534422eb8ec36c1ccabea059ce52a0b8fbc03456e468e59a64c3c7104afe9adfc5134c339223d94042d980d9e958359ed27fe96065927
-  data.tar.gz: 29bc9ace8d2e82f5459802ebd7e69d3a4978ef9712b6814a6742de4bd0606f0e78a1a2d2fdf3841aa2cd141dbda74646ba6baf9e106c977ac85a363ca353311f
+  metadata.gz: 69872ff915d08721f8691bebdbfa512427d841cecc6d01e6cd7a4b3eeab54ba8fc63a9c3a5a23cb3aeff1fbf9359749897874820c5a0c1c83ca3f8fb081e4329
+  data.tar.gz: 70f80d780266f62e51324652a8b85662f1e069bd296b10fd79ed5b64db40f50d57a5eb9876269bf9501efcf4fb96153fa01f15223751261e24537394836ace6a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attr_bitwise (0.0.2)
+    attr_bitwise (0.0.3)
       activesupport
 
 GEM

data/README.md

@@ -27,9 +27,16 @@ Bitwise attribute for ruby class and Rails model
 attr_bitwise :<name>, mapping: <values_sym> [, column_name: <column_name>]
 ```
 
+Alternatively, you can explicitly specify your states by supplying a hash with the values. 
+
+```ruby
+attr_bitwise :<name>, mapping: {<sym1: 1, sym2: 2, sym3: 4>} [, column_name: <column_name>]
+```
+
+
 ## Example
 
-You have a website with many locales (English, French, German...) with specific content in each locale. You want your users to be able to chose which content they want to see and you want to be able to query the users by the locales they have choosen.
+You have a website with many locales (English, French, German...) with specific content in each locale. You want your users to be able to chose which content they want to see and you want to be able to query the users by the locales they have chosen.
 
 Start with migration
 ```ruby

data/lib/attr_bitwise.rb

@@ -171,6 +171,7 @@ module AttrBitwise
 
     private
 
+
     # return mapping given a bitwise name
     def mapping_from_name(name)
       const_get("#{name}_mapping".upcase)
@@ -182,8 +183,13 @@ module AttrBitwise
     # each sym get a power of 2 value
     def build_mapping(symbols, name)
       mapping = {}.tap do |hash|
-        symbols.each_with_index do |key, i|
-          hash[key] = 2**i
+        if symbols.is_a?(Hash)
+          validate_user_defined_values!(symbols, name)
+          hash.merge!(symbols.sort_by{|k,v| v}.to_h)
+        else
+          symbols.each_with_index do |key, i|
+            hash[key] = 2**i
+          end
         end
         hash[:empty] = 0
       end
@@ -191,14 +197,24 @@ module AttrBitwise
       const_mapping_name = "#{name}_mapping".upcase
       const_set(const_mapping_name, mapping)
     end
+
+    def validate_user_defined_values!(hash, name)
+      hash.select{|key,value| (Math.log2(value) % 1.0)!=0}.tap do |invalid_options|
+        if invalid_options.any?
+          raise(ArgumentError, "#{name} value should be a power of two number (#{invalid_options.to_s})")
+        end
+      end
+    end
   end
 
+
   ##########################
   # Private instance methods
   ##########################
 
   private
 
+
   def force_to_bitwise_value(value_or_symbol, mapping)
     self.class.force_to_bitwise_value(value_or_symbol, mapping)
   end

data/lib/attr_bitwise/version.rb

@@ -1,3 +1,3 @@
 module AttrBitwise
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/attr_bitwise_user_defined_spec.rb

@@ -0,0 +1,217 @@
+require_relative '../lib/attr_bitwise.rb'
+
+describe AttrBitwise, 'with user defined mapping values' do
+
+  describe 'invalid options' do 
+
+
+    #wrap to ensure class is not evaluated until we are ready
+    let(:test_class) do 
+
+      class InvalidUserDefinedTestClass
+
+        include AttrBitwise
+
+        attr_accessor :fruits_value
+
+        attr_bitwise :fruits, mapping: {banana: 2, kiwi: 4, apple: 1, dog: 3, fish: 99}
+
+        def initialize
+          @fruits_value = 0
+        end
+
+      end
+
+    end
+    
+    context 'raise an exception with invalid options' do 
+      it do 
+        expect{test_class}.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe 'valid options' do 
+
+    # test class in order to test concern
+    class UserDefinedTestClass
+
+      include AttrBitwise
+
+      attr_accessor :fruits_value
+
+      attr_bitwise :fruits, mapping: {banana: 2, kiwi: 4, apple: 1}
+
+      def initialize
+        @fruits_value = 0
+      end
+
+    end
+
+
+    subject { UserDefinedTestClass.new }
+
+    context '.to_bitwise_values' do
+
+      context 'with Hash argument' do
+        it do
+          expect(
+            UserDefinedTestClass.to_bitwise_values(
+              {
+                a: :apple,
+                b: :banana
+              },
+              'fruits'
+            )
+          ).to eq [1, 2]
+        end
+      end
+
+      context 'with Array argument' do
+        it do
+          expect(UserDefinedTestClass.to_bitwise_values(
+            [:apple, :banana],
+            'fruits'
+          )).to eq [1, 2]
+        end
+      end
+
+      context 'with Fixnum argument' do
+        it do
+          expect(UserDefinedTestClass.to_bitwise_values(1, 'fruits')).to eq 1
+        end
+      end
+
+    end
+
+    context 'with `fruits` attribute_name' do
+
+      context '#fruits=' do
+
+        before { subject.fruits = [:banana, :apple] }
+
+        it 'should set proper value' do
+          expect(subject.fruits_value).to eq 3
+          expect(subject.fruits).to eq [:apple, :banana]
+        end
+
+      end
+
+      context '#fruits==' do
+
+        context 'when value is incorrect' do
+          before { subject.fruits = [:banana, :apple] }
+
+          it do
+            expect(subject.fruits == :banana).to eq false
+          end
+        end
+
+        context 'when value is correct' do
+          before { subject.fruits = [:banana] }
+
+          it do
+            expect(subject.fruits == :banana).to eq true
+          end
+        end
+
+      end
+
+      context 'with `fruits_value` = 0' do
+        context '#fruits' do
+
+          it do
+            expect(subject.fruits).to eq []
+          end
+
+        end
+
+        context '#add_fruit' do
+
+          it do
+            subject.add_fruit(:banana)
+            expect(subject.fruits).to eq [:banana]
+          end
+
+          context 'when called twice, each type remains unique' do
+            it do
+              subject.add_fruit(:banana)
+              subject.add_fruit(:banana)
+              expect(subject.fruits).to eq [:banana]
+            end
+          end
+
+        end
+
+        context '#fruit?(:banana)' do
+
+          it do
+            expect(subject.fruit?(:banana)).to eq false
+          end
+
+        end
+      end
+
+      context 'with `fruits_value` = 3' do
+
+        before { subject.fruits_value = 3 }
+
+        context '#fruits' do
+
+          it do
+            expect(subject.fruits).to eq [:apple, :banana]
+          end
+
+        end
+
+        context '#fruit?(:banana)' do
+
+          it do
+            expect(subject.fruit?(:banana)).to eq true
+          end
+
+        end
+
+        context '#remove_fruit' do
+
+          it do
+            subject.remove_fruit(:banana)
+            expect(subject.fruits).to eq [:apple]
+          end
+
+        end
+
+        context '#fruits_union' do
+
+          it do
+            expect(subject.fruits_union(1, 2, 4)).to eq [1, 3, 5, 2, 6, 4]
+          end
+
+        end
+
+        context '.bitwise_union' do
+
+          it do
+            expect(
+              TestClass.bitwise_union(1, 2, 'fruits')
+            ).to eq [1, 3, 2]
+          end
+
+        end
+
+        context '#bitwise_intersection' do
+
+          it do
+            expect(
+              TestClass.bitwise_intersection(1, 2, 'fruits')
+            ).to eq [3]
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_bitwise
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Charly POLY
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,6 +84,7 @@ files:
 - lib/attr_bitwise.rb
 - lib/attr_bitwise/version.rb
 - spec/attr_bitwise_spec.rb
+- spec/attr_bitwise_user_defined_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -110,3 +111,4 @@ specification_version: 4
 summary: Bitwise attribute for ruby class and Rails model
 test_files:
 - spec/attr_bitwise_spec.rb
+- spec/attr_bitwise_user_defined_spec.rb