enumerize 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89ff95b68f2d587db0234b6cae3b434c904b8575
-  data.tar.gz: d758065069a4f5ab996281648c12df3a4ba70b1f
+  metadata.gz: 964f689869d7570459451bae1068a737f69a7db2
+  data.tar.gz: b1c59894d98bd2656d01c5bca52f4dc15a7fa42a
 SHA512:
-  metadata.gz: 91ee9ff2df723ab6e83155fe4e9697f9e8dcf12cd11b42dbb0822de7da4c2050269561f51e316ec6ac71b3e3ea77cfc74c70eb899a24af34366cf6a657e9fa3b
-  data.tar.gz: 2e77cbb5dbe9abb980984ce5837ad41009ad5dddc9bf13ceae86dccb58d294feead696a6cbff41a517607587284ba26bb04bfa4d65b82e31e864fed6c72c6ccb
+  metadata.gz: 61ca5ff5fcaac6dd6a38622fbf2af35f74896bf57f9f317cbc2b7b918814ab9b4aa5e9a6437de14b709a72b61d2d09c04c7d86a6504335faed7fd008c21b2051
+  data.tar.gz: 8a5e9bb95f72b0abbdd5619ace2299ed8d3001d520d747751d00a84d474ecdfb82a3fce065c6af3d9e422fe1d38cdf288e286d578a95fda836b0f02606ee4c21

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## master
+
+### enhancements
+
+### bug fix
+
+## 0.10.0 (February 17, 2015) ##
+
+### enhancements
+
+ * Add scopes support to mongoid documents (by [@nashby](https://github.com/nashby))
+ * Use underscore.humanize in #text to make use of Inflector acronyms (by [@mintuhouse](https://github.com/mintuhouse))
+ * Raise an exception when :scope option is used together with :multiple option (by [@maurogeorge](https://github.com/maurogeorge))
+ * Use alias_method_chain instead of overriding Class#inherited (by [@yuroyoro](https://github.com/yuroyoro))
+ * Shortcut methods to retrieve enumerize values (by [@CyborgMaster](https://github.com/CyborgMaster))
+ * Extend equality operator to support comparing with symbols and custom values (e.g. integers) (by [@CyborgMaster](https://github.com/CyborgMaster))
+
 ## 0.9.0 (December 11, 2014) ##
 
 ### enhancements

data/README.md

@@ -251,6 +251,8 @@ User.having_status(:blocked).with_sex(:male, :female)
 # SELECT "users".* FROM "users" WHERE "users"."status" IN (2) AND "users"."sex" IN ('male', 'female')
 ```
 
+:warning: It is not possible to define a scope when using the `:multiple` option. :warning:
+
 Array-like attributes with plain ruby objects:
 
 ```ruby

data/lib/enumerize.rb

@@ -14,6 +14,11 @@ module Enumerize
 
   autoload :ActiveRecordSupport, 'enumerize/activerecord'
 
+  module Scope
+    autoload :ActiveRecord, 'enumerize/scope/activerecord'
+    autoload :Mongoid,      'enumerize/scope/mongoid'
+  end
+
   def self.included(base)
     ActiveSupport::Deprecation.warn '`include Enumerize` was deprecated. Please use `extend Enumerize`.', caller
     extended(base)
@@ -23,6 +28,8 @@ module Enumerize
     base.send :include, Enumerize::Base
     base.extend Enumerize::Predicates
     base.extend Enumerize::ActiveRecordSupport
+    base.extend Enumerize::Scope::ActiveRecord if defined?(::ActiveRecord::Base)
+    base.extend Enumerize::Scope::Mongoid      if defined?(::Mongoid::Document)
 
     if defined?(::RailsAdmin)
       require 'enumerize/integrations/rails_admin'

data/lib/enumerize/activerecord.rb

@@ -5,10 +5,6 @@ module Enumerize
 
       _enumerize_module.dependent_eval do
         if defined?(::ActiveRecord::Base) && self < ::ActiveRecord::Base
-          if options[:scope]
-            _define_scope_methods!(name, options)
-          end
-
           include InstanceMethods
 
           # Since Rails use `allocate` method on models and initializes them with `init_with` method.
@@ -21,26 +17,6 @@ module Enumerize
       end
     end
 
-    private
-
-    def _define_scope_methods!(name, options)
-      scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
-
-      define_singleton_method scope_name do |*values|
-        values = values.map { |value| enumerized_attributes[name].find_value(value).value }
-        values = values.first if values.size == 1
-
-        where(name => values)
-      end
-
-      if options[:scope] == true
-        define_singleton_method "without_#{name}" do |*values|
-          values = values.map { |value| enumerized_attributes[name].find_value(value).value }
-          where(arel_table[name].not_in(values))
-        end
-      end
-    end
-
     module InstanceMethods
       # https://github.com/brainspec/enumerize/issues/74
       def write_attribute(attr_name, value)

data/lib/enumerize/attribute.rb

@@ -4,6 +4,7 @@ module Enumerize
 
     def initialize(klass, name, options={})
       raise ArgumentError, ':in option is required' unless options[:in]
+      raise ArgumentError, ':scope option does not work with option :multiple' if options[:multiple] && options[:scope]
 
       extend Multiple if options[:multiple]
 
@@ -25,6 +26,12 @@ module Enumerize
         @default_value = find_default_value(options[:default])
         raise ArgumentError, 'invalid default value' unless @default_value
       end
+
+      # Define methods to get each value
+      @values.each do |v|
+        metaclass = class << self; self; end
+        metaclass.send(:define_method, v.to_s) { v }
+      end
     end
 
     def find_default_value(value)
@@ -39,6 +46,10 @@ module Enumerize
       @value_hash[value.to_s] unless value.nil?
     end
 
+    def find_values(*values)
+      values.map { |value| find_value(value) }.compact
+    end
+
     def i18n_scopes
       @i18n_scopes ||= if i18n_scope
         scopes = Array(i18n_scope)

data/lib/enumerize/base.rb

@@ -6,6 +6,14 @@ module Enumerize
       if base.respond_to?(:validate)
         base.validate :_validate_enumerized_attributes
       end
+
+      class << base
+        if (method_defined?(:inherited) || private_method_defined?(:inherited)) && (not method_defined? :inherited_without_enumerized)
+          alias_method :inherited_without_enumerized, :inherited
+        end
+
+        alias_method :inherited, :inherited_with_enumerized
+      end
     end
 
     module ClassMethods
@@ -28,9 +36,11 @@ module Enumerize
         @enumerized_attributes ||= AttributeMap.new
       end
 
-      def inherited(subclass)
+      def inherited_with_enumerized(subclass)
         enumerized_attributes.add_dependant subclass.enumerized_attributes
-        super
+        if respond_to?(:inherited_without_enumerized, true)
+          inherited_without_enumerized subclass
+        end
       end
 
       private

data/lib/enumerize/scope/activerecord.rb

@@ -0,0 +1,37 @@
+module Enumerize
+  module Scope
+    module ActiveRecord
+      def enumerize(name, options={})
+        super
+
+        _enumerize_module.dependent_eval do
+          if self < ::ActiveRecord::Base
+            if options[:scope]
+              _define_scope_methods!(name, options)
+            end
+          end
+        end
+      end
+
+      private
+
+      def _define_scope_methods!(name, options)
+        scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
+
+        define_singleton_method scope_name do |*values|
+          values = enumerized_attributes[name].find_values(*values).map(&:value)
+          values = values.first if values.size == 1
+
+          where(name => values)
+        end
+
+        if options[:scope] == true
+          define_singleton_method "without_#{name}" do |*values|
+            values = enumerized_attributes[name].find_values(*values).map(&:value)
+            where(arel_table[name].not_in(values))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/scope/mongoid.rb

@@ -0,0 +1,40 @@
+module Enumerize
+  module Scope
+    module Mongoid
+      def enumerize(name, options={})
+        super
+
+        _enumerize_module.dependent_eval do
+          if self < ::Mongoid::Document
+            if options[:scope]
+              _define_scope_methods!(name, options)
+            end
+          end
+        end
+      end
+
+      private
+
+      def _define_scope_methods!(name, options)
+        scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
+
+        define_singleton_method scope_name do |*values|
+          values = enumerized_attributes[name].find_values(*values).map(&:value)
+
+          if values.size == 1
+            where(name => values.first)
+          else
+            where(name.in => values)
+          end
+        end
+
+        if options[:scope] == true
+          define_singleton_method "without_#{name}" do |*values|
+            values = enumerized_attributes[name].find_values(*values).map(&:value)
+            not_in(name => values)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/value.rb

@@ -17,6 +17,10 @@ module Enumerize
       I18n.t(i18n_keys[0], :default => i18n_keys[1..-1])
     end
 
+    def ==(other)
+      super(other.to_s) || value == other
+    end
+
     def encode_with(coder)
       coder.represent_object(self.class.superclass, @value)
     end
@@ -36,7 +40,7 @@ module Enumerize
         i18n_keys = i18n_scopes
         i18n_keys << [:"enumerize.defaults.#{@attr.name}.#{self}"]
         i18n_keys << [:"enumerize.#{@attr.name}.#{self}"]
-        i18n_keys << self.humanize # humanize value if there are no translations
+        i18n_keys << self.underscore.humanize # humanize value if there are no translations
         i18n_keys.flatten
       end
     end

data/lib/enumerize/version.rb

@@ -1,3 +1,3 @@
 module Enumerize
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/test/activerecord_test.rb

@@ -242,6 +242,12 @@ describe Enumerize::ActiveRecordSupport do
     User.having_role(:admin).must_equal [user_1]
   end
 
+  it 'ignores not enumerized values that passed to the scope method' do
+    User.delete_all
+
+    User.with_status(:foo).must_equal []
+  end
+
   it 'allows either key or value as valid' do
     user_1 = User.new(status: :active)
     user_2 = User.new(status: 1)

data/test/attribute_test.rb

@@ -85,6 +85,14 @@ describe Enumerize::Attribute do
     end
   end
 
+  it 'sets up shortcut methods for each value' do
+    build_attr nil, :foo, :in => {:a => 1, :b => 2}
+    attr.a.value.must_equal 1
+    attr.b.value.must_equal 2
+    attr.a.text.must_equal 'A'
+    attr.b.text.must_equal 'B'
+  end
+
   describe 'values hash with zero' do
     before do
       build_attr nil, :foo, :in => {:a => 1, :b => 2, :c => 0}
@@ -99,6 +107,10 @@ describe Enumerize::Attribute do
       attr.find_value(2).must_equal 'b'
       attr.find_value(0).must_equal 'c'
     end
+
+    it 'finds all values by hash values' do
+      attr.find_values(1, 2, 0).must_equal ['a', 'b', 'c']
+    end
   end
 
   describe 'boolean values hash' do

data/test/mongoid_test.rb

@@ -17,8 +17,8 @@ describe Enumerize do
 
     field :sex
     field :role
-    enumerize :sex, :in => %w[male female]
-    enumerize :role, :in => %w[admin user], :default => 'user'
+    enumerize :sex, :in => %w[male female], scope: true
+    enumerize :role, :in => %w[admin user], :default => 'user', scope: :having_role
     enumerize :mult, :in => %w[one two three four], :multiple => true
   end
 
@@ -76,4 +76,28 @@ describe Enumerize do
     user = model.first
     user.mult.to_a.must_equal ['one', 'two']
   end
+
+  it 'adds scope' do
+    model.delete_all
+
+    user_1 = model.create!(sex: :male, role: :admin)
+    user_2 = model.create!(sex: :female, role: :user)
+
+    model.with_sex(:male).to_a.must_equal [user_1]
+    model.with_sex(:female).to_a.must_equal [user_2]
+    model.with_sex(:male, :female).to_set.must_equal [user_1, user_2].to_set
+
+    model.without_sex(:male).to_a.must_equal [user_2]
+    model.without_sex(:female).to_a.must_equal [user_1]
+    model.without_sex(:male, :female).to_a.must_equal []
+
+    model.having_role(:admin).to_a.must_equal [user_1]
+    model.having_role(:user).to_a.must_equal [user_2]
+  end
+
+  it 'ignores not enumerized values that passed to the scope method' do
+    model.delete_all
+
+    model.with_sex(:foo).must_equal []
+  end
 end

data/test/multiple_test.rb

@@ -33,4 +33,10 @@ describe Enumerize::Base do
     klass.enumerize :foos, in: %w(a b c), multiple: true
     object.wont_respond_to :foos_value
   end
+
+  it "cannot define multiple with scope" do
+    assert_raises ArgumentError do
+      klass.enumerize :foos, in: %w(a b c), multiple: true, scope: true
+    end
+  end
 end

data/test/value_test.rb

@@ -2,14 +2,27 @@ require 'test_helper'
 
 describe Enumerize::Value do
   let(:attr)  { Struct.new(:values).new([]) }
-  let(:value) { Enumerize::Value.new(attr, 'test_value') }
+  let(:value) { Enumerize::Value.new(attr, 'test_value', 1) }
 
   it 'is a string' do
     value.must_be_kind_of String
   end
 
-  it 'is compared to string' do
-    value.must_be :==, 'test_value'
+  describe 'equality' do
+    it 'is compared to string' do
+      value.must_be :==, 'test_value'
+      value.wont_be :==, 'not_value'
+    end
+
+    it 'is compared to symbol' do
+      value.must_be :==, :test_value
+      value.wont_be :==, :not_value
+    end
+
+    it 'is compared to integer' do
+      value.must_be :==, 1
+      value.wont_be :==, 2
+    end
   end
 
   describe 'translation' do
@@ -106,6 +119,8 @@ describe Enumerize::Value do
   end
 
   describe 'serialization' do
+    let(:value) { Enumerize::Value.new(attr, 'test_value') }
+
     it 'should be serialized to yaml as string value' do
       assert_equal YAML.dump('test_value'), YAML.dump(value)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumerize
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Sergey Nartimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,6 +56,8 @@ files:
 - lib/enumerize/module_attributes.rb
 - lib/enumerize/predicatable.rb
 - lib/enumerize/predicates.rb
+- lib/enumerize/scope/activerecord.rb
+- lib/enumerize/scope/mongoid.rb
 - lib/enumerize/set.rb
 - lib/enumerize/value.rb
 - lib/enumerize/version.rb
@@ -97,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper support