simple_enum 2.1.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7331e48556b80c03d4dddd1c17d9d6c8b20b134b
-  data.tar.gz: 2c392e3587e6a6298d6fb50148283fbfd6c3e334
+  metadata.gz: 788b09549df8143f67025e1c15785ccfcf6b2ff4
+  data.tar.gz: e1a274edb7723d4f9b354cdcae0f40179dba4a8b
 SHA512:
-  metadata.gz: ede4ed642e42d1ba5414692390dc698633a0068dc476afd790016919cd5e22b3d2a2d3515b35e5816b8003ae1fc6d5e8bbb1280ed27876f74363899e9c68d6d9
-  data.tar.gz: 0d90bcc8dfe99ddd5b16c3004e280e7a1bd837830302257a54d2361f04b2280c3de330f1fd93c57bda0a414141e391d1452ea2d42a7ed6dc9bb5b4d59c6bdac4
+  metadata.gz: 24a99e865d791190a5468b67b40345438fd32eaf7973a3d08e176ad90ef0cce5dcd9dad9614df22bff5155e74ff1bc179b41aaed007e22a0ab530a584254adab
+  data.tar.gz: 70b69f2c0a4b1516485fba415fd62a492b680a0d4e5d09030ca2a27af790cb2a08d5f872860e399a0dca117f57384e3656eb3d6e6aa60eb61c9031b4aad0e55a

data/README.md

@@ -113,7 +113,7 @@ User.females                            # => #<ActiveRecord::Relation:0x0.....>
   end
   ```
 
-  **Disclaimer**: if you _ever_ decide to reorder this array, beaware that any
+  **Disclaimer**: if you _ever_ decide to reorder this array, beware that any
   previous mapping is lost. So it's recommended to create mappings (that might
   change) using hashes instead of arrays. For stuff like gender it might be
   probably perfectly fine to use arrays though.
@@ -208,7 +208,7 @@ User.females                            # => #<ActiveRecord::Relation:0x0.....>
 
   ```ruby
   # See lib/simple_enum.rb for other options
-  SimpleEnum.with = [:accessor, :scope]
+  SimpleEnum.with = [:attribute, :scope]
   ```
 
 ### View Helpers
@@ -223,11 +223,23 @@ so expect them to change in future versions of SimpleEnum.
   translate_enum user, :gender # => "Frau" # assuming :de and translations exist
   te user, :gender # translate_enum is also aliased to te
   ```
+  
+  Provide translations in the i18n yaml file like:
+  
+  ```ruby
+    de:
+      enums:
+        gender:
+          female: 'Frau'
+          male: 'Mann'
+  ```
+  
 - Build a select tag with a translated dropdown and symbol as value:
 
   ```ruby
   select :user, :gender, enum_option_pairs(User, :gender)
   ```
+  
 - ...and one with the index as value:
 
   ```ruby
@@ -255,16 +267,16 @@ User.females # => returns an ActiveRecord::Relation
 Contributors
 ------------
 
-- @dmitry - bugfixes and other improvements
-- @tarsolya - implemented all the ruby 1.9 and rails 3 goodness!
-- @dbalatero - rails 2.3.5 bugfix & validator fixes
-- @johnthethird - feature for `_for_select` to return the values
+- [@dmitry](https://github.com/dmitry) - bugfixes and other improvements
+- [@tarsolya](https://github.com/tarsolya) - implemented all the ruby 1.9 and rails 3 goodness!
+- [@dbalatero](https://github.com/dbalatero) - rails 2.3.5 bugfix & validator fixes
+- [@johnthethird](https://github.com/johnthethird) - feature for `_for_select` to return the values
 - @sinsiliux - ruby 1.9 fixes and removed AR dependency
-- @sled - mongoid support
-- @abrom - `find_by_...` method
-- @mhuggins - translations fixes
-- @patbenatar - for helping move towards 2.0 (scopes et all)
-- @abacha - translation helpers, README fixes
+- [@sled](https://github.com/sled) - mongoid support
+- [@abrom](https://github.com/abrom) - `find_by_...` method
+- [@mhuggins](https://github.com/mhuggins) - translations fixes
+- [@patbenatar](https://github.com/patbenatar) - for helping move towards 2.0 (scopes et all)
+- [@abacha](https://github.com/abacha) - translation helpers, README fixes
 - and all others: https://github.com/lwe/simple_enum/graphs/contributors thanks
 
 License & Copyright

data/lib/simple_enum/accessors.rb

@@ -15,4 +15,14 @@ module SimpleEnum
       klass.new(name, enum, options[:source], options[:prefix])
     end
   end
+
+  # Public: Extension method to register a custom accessor.
+  #
+  # key - The Symbol of the accessor key, e.g. `:bitwise`
+  # clazz - The Class with the accessor implementation
+  #
+  # Returns nothing
+  def self.register_accessor(key, clazz)
+    Accessors::ACCESSORS[key] = clazz
+  end
 end

data/lib/simple_enum/accessors/accessor.rb

@@ -33,7 +33,13 @@ module SimpleEnum
       end
 
       def was(object)
-        enum.key(object.send(:attribute_was, source))
+        changes = object.send(:changed_attributes)
+        key = changes.fetch(source, read_before_type_cast(object))
+        enum.key(key) if key
+      end
+
+      def scope(relation, value)
+        relation.where(source => value)
       end
 
       def to_s

data/lib/simple_enum/attribute.rb

@@ -13,6 +13,9 @@ module SimpleEnum
   # original method.
   #
   module Attribute
+    # Registered registrator methods from extensions
+    EXTENSIONS = []
+
     def as_enum(name, values, options = {})
       options.assert_valid_keys(:source, :prefix, :with, :accessor, :map)
 
@@ -27,6 +30,10 @@ module SimpleEnum
         send "generate_enum_#{feature}_methods_for", enum, accessor
       end
 
+      EXTENSIONS.uniq.each do |extension|
+        send "generate_enum_#{extension}_extension_for", enum, accessor
+      end
+
       enum
     end
 
@@ -70,8 +77,21 @@ module SimpleEnum
       return unless respond_to?(:scope)
 
       enum.each_pair do |key, value|
-        scope "#{accessor.prefix}#{key.pluralize}", -> { where(accessor.source => value) }
+        scope "#{accessor.prefix}#{key.pluralize}", -> { accessor.scope(self, value) }
       end
     end
   end
+
+  # Public: Register a generator method and add module as part of
+  # SimpleEnum::Attribute. The generator method is called after all default
+  # generators have been created, this allows to override/change existing methods.
+  #
+  # name - The Symbol with the name of the extension
+  # mod - The Module implementing `generate_enum_{name}_extension_for` method
+  #
+  # Returns nothing
+  def self.register_generator(name, mod)
+    Attribute.send :include, mod
+    Attribute::EXTENSIONS << name.to_s
+  end
 end

data/lib/simple_enum/enum.rb

@@ -25,6 +25,10 @@ module SimpleEnum
     end
     alias_method :[], :value
 
+    def fetch(key)
+      value(key) || raise("Key \"#{key}\" not found")
+    end
+
     def each_pair(&block)
       hash.each_pair(&block)
     end
@@ -38,6 +42,10 @@ module SimpleEnum
       hash.keys
     end
 
+    def values
+      hash.values
+    end
+
     def values_at(*keys)
       keys = keys.map(&:to_s)
       hash.values_at(*keys)

data/lib/simple_enum/version.rb

@@ -1,5 +1,5 @@
 module SimpleEnum
 
   # The current `SimpleEnum` version.
-  VERSION = "2.1.1"
+  VERSION = "2.2.1"
 end

data/simple_enum.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake', '>= 10.1.0'
   s.add_development_dependency 'activerecord', '>= 4.0.0'
-  s.add_development_dependency 'mongoid', '>= 4.0.0.beta1'
+  s.add_development_dependency 'mongoid', '>= 4.0.0'
   s.add_development_dependency 'rspec', '~> 2.14'
 end

data/spec/simple_enum/accessors_spec.rb

@@ -19,6 +19,22 @@ describe SimpleEnum::Accessors do
     end
   end
 
+  context '.register_accessor' do
+    let(:accessor) { Class.new { def initialize(*args); end } }
+    subject { described_class.accessor(:gender, "enum", accessor: :would_be) }
+
+    before { SimpleEnum.register_accessor :would_be, accessor }
+    after { SimpleEnum::Accessors::ACCESSORS.delete(:would_be) }
+
+    it 'adds accessor to ACCESSORS' do
+      expect(SimpleEnum::Accessors::ACCESSORS[:would_be]).to eq accessor
+    end
+
+    it 'allows to create an instance of our WouldBeAccessor' do
+      expect(subject).to be_a accessor
+    end
+  end
+
   context 'Accessor' do
     subject { described_class::Accessor.new(:gender, enum) }
 
@@ -125,41 +141,44 @@ describe SimpleEnum::Accessors do
 
     context '#selected?' do
       it 'returns false when gender_cd is nil' do
-        expect(subject.selected?(object)).to be_false
-        expect(subject.selected?(object, :male)).to be_false
+        expect(subject.selected?(object)).to be_falsey
+        expect(subject.selected?(object, :male)).to be_falsey
       end
 
       it 'returns true when gender_cd is != nil' do
-        expect(subject.selected?(klass.new(0))).to be_true
-        expect(subject.selected?(klass.new(1))).to be_true
+        expect(subject.selected?(klass.new(0))).to be_truthy
+        expect(subject.selected?(klass.new(1))).to be_truthy
       end
 
       it 'returns true when gender_cd is 0 and :male is passed' do
-        expect(subject.selected?(klass.new(0), :male)).to be_true
+        expect(subject.selected?(klass.new(0), :male)).to be_truthy
       end
 
       it 'returns false when gender_cd is 0 and :female is passed' do
-        expect(subject.selected?(klass.new(0), :female)).to be_false
+        expect(subject.selected?(klass.new(0), :female)).to be_falsey
       end
 
       it 'returns false when gender_cd is 1 and :other is passed' do
-        expect(subject.selected?(klass.new(0), :other)).to be_false
+        expect(subject.selected?(klass.new(0), :other)).to be_falsey
       end
     end
 
     context '#changed?' do
       it 'delegates to attribute_changed?' do
         expect(object).to receive(:attribute_changed?).with('gender_cd') { true }
-        expect(subject.changed?(object)).to be_true
+        expect(subject.changed?(object)).to be_truthy
       end
     end
 
-    context 'was' do
-      it 'delegates to attribute_was and resolves symbol' do
-        expect(object).to receive(:attribute_was).with('gender_cd') { 1 }
-        expect(subject.was(object)).to eq :female
+    context '#was' do
+      let(:changes) do
+        { 'gender_cd' => 1 }
       end
 
+      it 'delegates to changed_attributes and resolves symbol' do
+        expect(object).to receive(:changed_attributes) { changes }
+        expect(subject.was(object)).to eq :female
+      end
     end
   end
 
@@ -170,33 +189,86 @@ describe SimpleEnum::Accessors do
     it 'does not raise error "private method attribute_was called"' do
       object.gender = :female
       expect do
-        expect(object.gender_changed?).to be_true
+        expect(object.gender_changed?).to be_truthy
         expect(object.gender_was).to eq :male
       end.to_not raise_error
     end
+
+    context 'github.com/lwe/simple_enum/issues/109' do
+      fake_active_record(:klass) {
+        as_enum(:gender_cd, %w{female male}, source: :gender_cd)
+        as_enum(:role_cd, %w{completed cap dnf dns}, map: :string, source: :role_cd)
+      }
+      let(:object) { klass.create(role_cd: "cap", gender_cd: :female) }
+
+      context '#gender_cd_was' do
+        it 'returns nil when nil' do
+          expect(klass.create.gender_cd_was).to be_nil
+        end
+
+        it 'returns the current gender' do
+          expect(object.gender_cd_was).to eq :female
+        end
+
+        it 'returns the old gender' do
+          object.gender_cd = :male
+          expect(object.gender_cd_was).to eq :female
+        end
+      end
+
+      context '#role_cd_was' do
+        it 'returns nil when nil' do
+          expect(klass.create.role_cd_was).to be_nil
+        end
+
+        it 'returns the current role' do
+          expect(object.role_cd_was).to eq :cap
+        end
+
+        it 'returns completed when changed' do
+          object.role_cd = :completed
+          expect(object.role_cd_was).to eq :cap
+        end
+      end
+    end
+  end
+
+  context '#scope' do
+    fake_active_record(:klass) { as_enum :gender, [:male, :female] }
+    let(:accessor) { described_class::Accessor.new(:gender, enum) }
+    subject { accessor.scope(klass, 1) }
+
+    it 'returns an ActiveRecord::Relation' do
+      expect(subject).to be_a(ActiveRecord::Relation)
+    end
+
+    it "queries for gender_cd = 1" do
+      values_hash = { "gender_cd" => 1 }
+      expect(subject.where_values_hash).to eq values_hash
+    end
   end
 
   context 'IgnoreAccessor' do
     subject { described_class::IgnoreAccessor.new(:gender, enum) }
 
     it 'sets gender_cd to 0 with symbol' do
-      expect(subject.write(object, :male)).to_not be_false
+      expect(subject.write(object, :male)).to_not be_falsey
       expect(object.gender_cd).to eq 0
     end
 
     it 'sets gender_cd to 1 via value (1)' do
-      expect(subject.write(object, 1)).to_not be_false
+      expect(subject.write(object, 1)).to_not be_falsey
       expect(object.gender_cd).to eq 1
     end
 
     it 'sets gender_cd to nil' do
-      expect(subject.write(object, nil)).to be_false
+      expect(subject.write(object, nil)).to be_falsey
       expect(object.gender_cd).to be_nil
     end
 
     it 'keeps existing value when unknown value is passed' do
       object.gender_cd = 1
-      expect(subject.write(object, :other)).to be_false
+      expect(subject.write(object, :other)).to be_falsey
       expect(object.gender_cd).to eq 1
     end
   end

data/spec/simple_enum/attribute_spec.rb

@@ -10,6 +10,37 @@ describe SimpleEnum::Attribute do
     end
   end
 
+  context '.register_generator' do
+    let(:mod) {
+      Module.new do
+        def generate_enum_spec_extension_for(enum, accessor)
+          module_eval { attr_accessor :some_reader }
+          simple_enum_module.module_eval do
+            define_method("extension_method") { "as_enum(#{enum.name})" }
+          end
+        end
+      end
+    }
+
+    before { SimpleEnum.register_generator :spec, mod }
+    after { described_class::EXTENSIONS.clear }
+
+    subject { klass.new }
+
+    it 'adds "spec" to EXTENSIONS' do
+      expect(described_class::EXTENSIONS).to eq %w{spec}
+    end
+
+    it 'calls generate_enum_spec_extension_for during as_enum' do
+      expect(subject.extension_method).to eq "as_enum(gender)"
+    end
+
+    it 'allows to add behavior to class itself (e.g. attr_accessor)' do
+      subject.some_reader = "some value"
+      expect(subject.some_reader).to eq "some value"
+    end
+  end
+
   context 'generate_enum_class_accessors_for' do
     context '.genders' do
       subject { klass.genders }
@@ -48,7 +79,7 @@ describe SimpleEnum::Attribute do
     context '#gender?' do
       it 'delegates to accessor' do
         expect(accessor).to receive(:selected?).with(subject, nil) { nil }
-        expect(subject.gender?).to be_false
+        expect(subject.gender?).to be_falsey
       end
     end
   end
@@ -70,7 +101,7 @@ describe SimpleEnum::Attribute do
 
       it 'delegates #gender_changed? to accessor' do
         expect(accessor).to receive(:changed?).with(subject) { true }
-        expect(subject.gender_changed?).to be_true
+        expect(subject.gender_changed?).to be_truthy
       end
 
       it 'delegates #gender_was to accesso' do
@@ -99,17 +130,17 @@ describe SimpleEnum::Attribute do
 
       it 'delegates #gender? to accessor' do
         expect(accessor).to receive(:selected?).with(subject, nil) { :female }
-        expect(subject.gender?).to be_true
+        expect(subject.gender?).to be_truthy
       end
 
       it 'delegates #male? to accessor' do
         expect(accessor).to receive(:selected?).with(subject, 'male') { true }
-        expect(subject.male?).to be_true
+        expect(subject.male?).to be_truthy
       end
 
       it 'delegates #female? to accessor' do
         expect(accessor).to receive(:selected?).with(subject, 'female') { false }
-        expect(subject.female?).to be_false
+        expect(subject.female?).to be_falsey
       end
 
       it 'delegates #male! to accessor' do
@@ -129,17 +160,17 @@ describe SimpleEnum::Attribute do
 
       it 'delegates #gender? to accessor' do
         expect(accessor).to receive(:selected?).with(subject, nil) { :female }
-        expect(subject.gender?).to be_true
+        expect(subject.gender?).to be_truthy
       end
 
       it 'delegates #gender_male? to accessor' do
         expect(accessor).to receive(:selected?).with(subject, 'male') { true }
-        expect(subject.gender_male?).to be_true
+        expect(subject.gender_male?).to be_truthy
       end
 
       it 'delegates #gender_female? to accessor' do
         expect(accessor).to receive(:selected?).with(subject, 'female') { false }
-        expect(subject.gender_female?).to be_false
+        expect(subject.gender_female?).to be_falsey
       end
 
       it 'delegates #gender_male! to accessor' do
@@ -159,25 +190,23 @@ describe SimpleEnum::Attribute do
       as_enum :gender, [:male, :female], with: [:scope]
     }
 
-    shared_examples_for 'returning a relation' do |value|
-      it 'returns an ActiveRecord::Relation' do
-        expect(subject).to be_a(ActiveRecord::Relation)
-      end
+    let(:accessor) { klass.genders_accessor }
 
-      it "queries for gender_cd = #{value}" do
-        values_hash = { "gender_cd" => value }
-        expect(subject.where_values_hash).to eq values_hash
+    shared_examples_for 'delegates to accessor#scope' do |value|
+      it 'delegates to #scope' do
+        expect(accessor).to receive(:scope).with(klass, value)
+        subject
       end
     end
 
     context '.males' do
       subject { klass.males }
-      it_behaves_like 'returning a relation', 0
+      it_behaves_like 'delegates to accessor#scope', 0
     end
 
     context '.females' do
       subject { klass.females }
-      it_behaves_like 'returning a relation', 1
+      it_behaves_like 'delegates to accessor#scope', 1
     end
 
     context 'with prefix' do
@@ -187,12 +216,12 @@ describe SimpleEnum::Attribute do
 
       context '.gender_males' do
         subject { klass.gender_males }
-        it_behaves_like 'returning a relation', 0
+        it_behaves_like 'delegates to accessor#scope', 0
       end
 
       context '.gender_females' do
         subject { klass.gender_females }
-        it_behaves_like 'returning a relation', 1
+        it_behaves_like 'delegates to accessor#scope', 1
       end
     end
 

data/spec/simple_enum/enum_spec.rb

@@ -38,6 +38,12 @@ describe SimpleEnum::Enum do
     end
   end
 
+  context '#values' do
+    it 'returns the values in the order added' do
+      expect(subject.values).to eq [0, 1]
+    end
+  end
+
   context '#each_pair (aliased to #each)' do
     it 'yields twice with #each_pair' do
       expect { |b| subject.each_pair(&b) }.to yield_control.exactly(2).times
@@ -70,6 +76,24 @@ describe SimpleEnum::Enum do
     end
   end
 
+  context '#fetch' do
+    it 'looks up by string' do
+      expect(subject.fetch('male')).to eq 0
+    end
+
+    it 'looks up by symbol' do
+      expect(subject.fetch(:female)).to eq 1
+    end
+
+    it 'looks up by value' do
+      expect(subject.fetch(0)).to be 0
+    end
+
+    it 'throws exception when key is not found' do
+      expect{subject.fetch(:inexistent)}.to raise_error(/not found/i)
+    end
+  end
+
   context '#key' do
     it 'returns symbolized key for supplied value' do
       expect(subject.key(0)).to eq :male
@@ -83,20 +107,20 @@ describe SimpleEnum::Enum do
 
   context '#include?' do
     it 'returns true by string' do
-      expect(subject.include?('male')).to be_true
+      expect(subject.include?('male')).to be_truthy
     end
 
     it 'returns true by symbol' do
-      expect(subject.include?(:female)).to be_true
+      expect(subject.include?(:female)).to be_truthy
     end
 
     it 'returns true by checking actual value' do
-      expect(subject.include?(1)).to be_true
+      expect(subject.include?(1)).to be_truthy
     end
 
     it 'returns false when neither in keys nor values' do
-      expect(subject.include?(:other)).to be_false
-      expect(subject.include?(2)).to be_false
+      expect(subject.include?(:other)).to be_falsey
+      expect(subject.include?(2)).to be_falsey
     end
   end
 

data/spec/support/mongoid_support.rb

@@ -4,17 +4,16 @@ module MongoidSupport
   def self.connection
     @connection ||= begin
       Mongoid.configure.connect_to("simple_enum_mongoid_test")
-      Mongoid.default_session.options[:max_retries] = 0
     end
-    Mongoid.default_session
+    Mongoid.default_client
   end
 
   def self.included(base)
     base.before {
       begin
-        MongoidSupport.connection.collection_names
-      rescue Moped::Errors::ConnectionFailure
-        pending "Start MongoDB server to run Mongoid integration tests..."
+        MongoidSupport.connection.list_databases
+      rescue
+        skip "Start MongoDB server to run Mongoid integration tests..."
       end
     }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_enum
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Lukas Westermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta1
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple enum-like field support for models.