enum_set 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 490f7a3dc76517686a72eac0e8ddb6d09bc44efc
-  data.tar.gz: 5eec2d3ed8f99f8cda35914b12ce88e1cab2b7a0
+  metadata.gz: 3682009c6b023e8c935a2227c7d4304f0956b595
+  data.tar.gz: 5ba288b5a0c68ae9f95470e4f309d3c44d8386e1
 SHA512:
-  metadata.gz: 8bb1aa81251e9dd0d7a15e72ff75aaddaf988d5cddceda1cc6c8baf05a64f256ac034d8286c0dcc32ec62c8b15d1e42fc73e3c51975420b75286f3ec58c11222
-  data.tar.gz: 56f0f8a5cca344fca525be8189d2905b5c0472de361a40ff6e910da8602db8135b5eb6c0e567f2c2ab53ad140714a8dde93e3bdf5d42a520dc1b1c8a7fb07bbd
+  metadata.gz: 620ec3609ae8b28ba87d669b37ae73316d54ec2e52a7d810982717d637b20bc84a8a15638196b1599f9285f6fe358e4ccb7b542dd8c563782dcc0126d3128250
+  data.tar.gz: 4754ead9b98b762babe767f12054e6c19f35c4a8fc16de8ffd4fee98862dbb948bba7fa447b0c9dd3a1ffa17e9f16a2267a89f111edd67d9ce806a886e39ae4b

data/README.md

@@ -18,14 +18,30 @@ as well as an array setter.
 
 ## Usage
 
+### Array Specification
+
 ```ruby
 # user.rb
 class User < ActiveRecord::Base
   include EnumSet
   enum_set roles: [:admin, :super_user, :kaiser]
 end
+```
+
+### Hash Specification
+
+```ruby
+# user.rb
+class User < ActiveRecord::Base
+  include EnumSet
+  # N.B.: values must be powers of 2
+  enum_set roles: { admin: 1, super_user: 4, kaiser: 256 }
+end
+```
+
+### Elsewhere
 
-# elsewhere.rb
+```ruby
 user = User.create(roles: [:super_user])
 
 user.super_user? # => true
@@ -35,6 +51,7 @@ super_users = User.super_user.all # will include `user`
 
 user.roles <<= :kaiser # Adds `:kaiser` role to `user`
 user.roles # => [:super_user, :kaiser]
+user.roles <<= :gender # raises `EnumSet::EnumError`, since `:gender` isn't a role
 ```
 
 ## Notes

data/lib/enum_set.rb

@@ -10,8 +10,15 @@ module EnumSet
   module ClassMethods
     def enum_set(enums)
       enums.each do |column, names|
-        names.map!(&:to_sym)
-        names_with_bits = names.each_with_index.map { |name, i| [name, 1 << i] }
+        if !names.is_a?(Hash)
+          names = Hash[
+            names.each_with_index.map do |name, i|
+              [name, 1 << i]
+            end
+          ]
+        end
+
+        names_with_bits = names.symbolize_keys
 
         define_method :"#{column}_bitfield" do
           self[column] || 0
@@ -27,16 +34,20 @@ module EnumSet
           }
         end
 
-        define_method :"#{column}=" do |array|
-          new_value = send("#{column}_bitfield")
+        define_method :"#{column}=" do |values|
+          case values
+          when Array
+            values.each do |val|
+              raise EnumError.new("Unrecognized value for #{column}: #{val.inspect}") unless names.include?(val)
+            end
 
-          array.each do |val|
-            raise EnumError.new("Unrecognized value for #{column}: #{val.inspect}") unless names.include?(val)
-          end
+            current_value = send("#{column}_bitfield")
 
-          array.each do |val|
-            bit = names_with_bits.find { |name,_| name == val.to_sym }.last
-            new_value |= bit
+            new_value = values.reduce(current_value) do |acc, val|
+              acc | names_with_bits[val.to_sym]
+            end
+          when Fixnum
+            new_value = values
           end
 
           self[column] = new_value
@@ -44,7 +55,7 @@ module EnumSet
         end
 
         define_method column do
-          names.select { |name| send(:"#{name}?") }
+          names_with_bits.keys.select { |name| send(:"#{name}?") }
         end
       end
     end

data/lib/enum_set/version.rb

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

data/spec/enum_set_spec.rb

@@ -0,0 +1,108 @@
+require 'database'
+require 'enum_set'
+
+describe EnumSet do
+  class User < ActiveRecord::Base
+  end
+
+  context 'when the enum is defined with a hash' do
+    class UserWithHashRoles < User
+      include EnumSet
+
+      enum_set roles: { king: 16, kaiser: 256 }
+    end
+
+    let!(:user) { UserWithHashRoles.create!(:roles => [:kaiser]) }
+
+    it 'defines a boolean method for each value' do
+      expect(user).to be_kaiser
+      expect(user).to_not be_king
+    end
+
+    it 'retrieves applicable enum values' do
+      expect(user.roles).to eq [:kaiser]
+    end
+
+    describe 'array setters' do
+      it 'lets enum values be set' do
+        user.roles <<= :king
+        user.save!
+        expect(user.reload).to be_king
+      end
+
+      context 'when a nonexistent enum value is provided' do
+        it 'raises a NameError' do
+          expect {
+            user.roles <<= :gender
+          }.to raise_error EnumSet::EnumError
+        end
+      end
+    end
+
+    describe 'integer setters' do
+      let(:kaiser) { 256 }
+
+      it 'lets enum values be set by integers' do
+        user.roles = kaiser
+        expect(user).to be_kaiser
+        expect(user).to_not be_king
+      end
+    end
+
+    it 'scopes by enum value' do
+      expect(UserWithHashRoles.kaiser).to include user
+      expect(UserWithHashRoles.king).to_not include user
+    end
+  end
+end
+
+context 'when the enum is defined with an array' do
+  class UserWithArrayRoles < User
+    include EnumSet
+
+    enum_set roles: [:admin, :super_user, :basic_user]
+  end
+
+  let!(:user) { UserWithArrayRoles.create!(:roles => [:super_user]) }
+
+  it 'defines a boolean method for each value' do
+    expect(user).to be_super_user
+    expect(user).to_not be_admin
+  end
+
+  it 'retrieves applicable enum values' do
+    expect(user.roles).to eq [:super_user]
+  end
+
+  describe 'array setters' do
+    it 'lets enum values be set' do
+      user.roles <<= :admin
+      user.save!
+      expect(user.reload).to be_admin
+    end
+
+    context 'when a nonexistent enum value is provided' do
+      it 'raises a NameError' do
+        expect {
+          user.roles <<= :gender
+        }.to raise_error EnumSet::EnumError
+      end
+    end
+  end
+
+  describe 'integer setters' do
+    let(:admin_and_basic_user) { 0b101 }
+
+    it 'lets enum values be set by integers' do
+      user.roles = admin_and_basic_user
+      expect(user).to be_admin
+      expect(user).to be_basic_user
+      expect(user).to_not be_super_user
+    end
+  end
+
+  it 'scopes by enum value' do
+    expect(UserWithArrayRoles.super_user).to include user
+    expect(UserWithArrayRoles.admin).to_not include user
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_set
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Bree Stanwyck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,7 @@ files:
 - lib/enum_set.rb
 - lib/enum_set/version.rb
 - spec/database.rb
-- spec/enum_many_spec.rb
+- spec/enum_set_spec.rb
 homepage: https://github.com/breestanwyck/enum_set
 licenses:
 - MIT
@@ -139,5 +139,5 @@ summary: Allows using a single integer column as a set of booleans, with bitfiel
   storage.
 test_files:
 - spec/database.rb
-- spec/enum_many_spec.rb
+- spec/enum_set_spec.rb
 has_rdoc: 

data/spec/enum_many_spec.rb

@@ -1,42 +0,0 @@
-require 'database'
-require 'enum_set'
-
-describe EnumSet do
-  class User < ActiveRecord::Base
-    include EnumSet
-
-    enum_set roles: [:admin, :super_user, :basic_user]
-  end
-
-  let!(:user) { User.create!(:roles => [:super_user]) }
-
-  it 'defines a boolean method for each value' do
-    expect(user).to be_super_user
-    expect(user).to_not be_admin
-  end
-
-  it 'retrieves applicable enum values' do
-    expect(user.roles).to eq [:super_user]
-  end
-
-  describe 'array setters' do
-    it 'lets enum values be set' do
-      user.roles <<= :admin
-      user.save!
-      expect(user.reload).to be_admin
-    end
-
-    context 'when a nonexistent enum value is provided' do
-      it 'raises a NameError' do
-        expect {
-          user.roles <<= :gender
-        }.to raise_error EnumSet::EnumError
-      end
-    end
-  end
-
-  it 'scopes by enum value' do
-    expect(User.super_user).to include user
-    expect(User.admin).to_not include user
-  end
-end