enumerize 0.8.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f08aba602317c54ffaf5f735e09a205a5d1a624c
-  data.tar.gz: 87f7613830f330b958dbd0a61f7a7ac89c262623
+  metadata.gz: 5542a2d4391256f030660b112b5550d304f54364
+  data.tar.gz: 8146fa77598d876ae818b44f923382ec7fa87745
 SHA512:
-  metadata.gz: a0226ef792ee39084f80286b886880003659bec15c62e1e98938048e6b3accb03b04330591e92d42a2d79f94fb874d80fe14395b4007d3576ac1285bb0b3ff77
-  data.tar.gz: 48448538be205b068c3c7f01ca68c6780e7e4d2fd0db6f353455ab1462f8db587e744633cd605c7872b77f6bf6ecd353e1ba076998ebc04108e04322ab024c48
+  metadata.gz: 1ee6f8b28d3da326a8ab68a9d5a8639b5dca559b58f32d2104364c540911e26a294d7c733a954075be09aa72a5b4890df8304415e69228c89ece1f52b8411cba
+  data.tar.gz: b997d62b2e1e759b50cd89921af5f16a7e88e0356a3eb674540ff5562fdde09259920ca9522f001b38ad33419c251cfbe019305752c6ae2ab9947f4a1caf018b

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.ruby-version
 .yardoc
 .idea/
 enumerize.iml
@@ -12,6 +13,7 @@ _yardoc
 coverage
 doc/
 lib/bundler/man
+log/*
 pkg
 rdoc
 spec/reports

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -5,12 +5,18 @@ before_install:
   - gem install bundler
 gemfile:
   - Gemfile
-  - Gemfile.rails4
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
+  - 2.2
   - jruby-19mode
+matrix:
+  include:
+    - rvm: 2.2
+      gemfile: Gemfile.rails40
+    - rvm: 2.2
+      gemfile: Gemfile.mongo_mapper
 notifications:
   email:
     recipients:

data/CHANGELOG.md

@@ -1,3 +1,94 @@
+## master
+
+### enhancements
+
+### bug fix
+
+## 1.1.1 (January 25, 2016)
+
+### bug fix
+
+* Fix exception when using predicate methods and enumerized values have dash in it. (by [@nashby](https://github.com/nashby))
+
+## 1.1.0 (November 15, 2015)
+
+### enhancements
+ * Add Sequel support. (by [@mrbrdo](https://github.com/mrbrdo))
+ * Add qualifiers to RSpec matcher. (by [@maurogeorge](https://github.com/maurogeorge))
+ * Support hash in the RSpec matcher. (by [@maurogeorge](https://github.com/maurogeorge))
+
+### bug fix
+
+## 1.0.0 (August 2, 2015)
+
+### enhancements
+ * Add `texts` method for getting an array of text values of the enumerized field with multiple type. (by [@huynhquancam](https://github.com/huynhquancam))
+ * Drop Rails 3.2 support. (by [@nashby](https://github.com/nashby))
+
+### bug fix
+
+ * Fix conflicts when Active Record and Mongoid are used at the same time. (by [@matsu911](https://github.com/matsu911))
+
+## 0.11.0 (March 29, 2015) ##
+
+### enhancements
+ * Add ability to set default value for enumerized field with multiple type. (by [@nashby](https://github.com/nashby))
+ * Support Rails 4.2. (by [@lest](https://github.com/lest))
+
+### bug fix
+ * Use Mongoid's `:in` method for generated scopes, fix chained scopes. (by [@nashby](https://github.com/nashby))
+ * Use `after_initialize` callback to set default value in Mongoid documents. (by [@nashby](https://github.com/nashby))
+
+## 0.10.1 (March 4, 2015) ##
+
+### bug fix
+
+ * Use method_missing instead of defining singleton class methods to allow Marshal serialization (by [@lest](https://github.com/lest))
+
+## 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
+
+  * Add :value_class option (by [@lest](https://github.com/lest))
+  * Use 'defaults' scope in the localization file for the attributes that used across several models. This will help to avoid conflicting keys with model names and attribute names. Example:
+
+  ```yml
+    en:
+      enumerize:
+        defaults:
+          sex:
+            male: Male
+            female: Female
+  ```
+
+  You still can use the old solution without "default" scope:
+
+  ```yml
+    en:
+      enumerize:
+        sex:
+          male: Male
+          female: Female
+  ```
+  (by [@nashby](https://github.com/nashby))
+
+### bug fix
+  * Store values for validation using string keys (by [@nagyt234](https://github.com/nagyt234))
+  * Store custom values for multiple attributes (by [@lest](https://github.com/lest))
+  * Support validations after using AR#becomes (by [@lest](https://github.com/lest))
+  * Do not try to set attribute for not selected attributes (by [@dany1468](https://github.com/dany1468))
+
 ## 0.8.0 (March 4, 2014) ##
 
 ### enhancements

data/Gemfile

@@ -1,23 +1,5 @@
-source 'https://rubygems.org'
+eval_gemfile('Gemfile.global')
 
-gemspec
-
-gem 'rake'
-gem 'minitest', '~> 4.1'
-gem 'rspec', :require => false
-
-gem 'rails', '~> 3.2.0', :require => false
-gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-  gem 'rubinius-developer_tools'
-  gem 'rubysl-test-unit'
-end
-
-gem 'mongoid'
-gem 'mongo_mapper'
-gem 'simple_form'
-gem 'formtastic'
+gem 'minitest', '~> 5.8'
+gem 'rails',    '4.2.4', :require => false
+gem 'mongoid',  '~> 5.0'

data/{Gemfile.rails4 → Gemfile.global}

@@ -3,12 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'minitest', '~> 4.1'
 gem 'rspec', :require => false
 
-gem 'rails', '4.0.1', :require => false
 gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
 gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+gem 'sequel'
 
 platforms :rbx do
   gem 'rubysl', '~> 2.0'
@@ -17,7 +16,5 @@ platforms :rbx do
   gem 'rubysl-test-unit'
 end
 
-gem 'mongoid', github: 'mongoid/mongoid', ref: 'f91feef0a0c6b83a1b878e154f1014536aa1c298'
-gem 'mongo_mapper', github: 'jnunemaker/mongomapper'
 gem 'simple_form'
-gem 'formtastic', github: 'justinfrench/formtastic'
+gem 'formtastic'

data/Gemfile.mongo_mapper

@@ -0,0 +1,5 @@
+eval_gemfile('Gemfile.global')
+
+gem 'minitest', '~> 5.8'
+gem 'rails',    '4.2.4', :require => false
+gem 'mongo_mapper'

data/Gemfile.rails40

@@ -0,0 +1,5 @@
+eval_gemfile('Gemfile.global')
+
+gem 'minitest', '~> 4.1'
+gem 'rails',    '4.0.13', :require => false
+gem 'mongoid'

data/README.md

@@ -1,6 +1,6 @@
 # Enumerize [![TravisCI](https://secure.travis-ci.org/brainspec/enumerize.png?branch=master)](http://travis-ci.org/brainspec/enumerize) [![Gemnasium](https://gemnasium.com/brainspec/enumerize.png)](https://gemnasium.com/brainspec/enumerize)
 
-Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper support
+Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper/Sequel support
 
 ## Installation
 
@@ -34,6 +34,17 @@ Note that enumerized values are just identificators so if you want to use multi-
 ActiveRecord:
 
 ```ruby
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :sex
+      t.string :role
+
+      t.timestamps
+    end
+  end
+end
+
 class User < ActiveRecord::Base
   extend Enumerize
 
@@ -78,17 +89,18 @@ en:
         female: "Female"
 ```
 
-or if you use `sex` attribute across several models you can use this:
+or if you use `sex` attribute across several models you can use `defaults` scope:
 
 ```ruby
 en:
   enumerize:
-    sex:
-      male: "Male"
-      female: "Female"
+    defaults:
+      sex:
+        male: "Male"
+        female: "Female"
 ```
 
-You can also pass `i18n_scope` option to specify scope (or array of scopes) storring the translations. Note that `i18n_scope` option does not accept scope as array:
+You can also pass `i18n_scope` option to specify scope (or array of scopes) storing the translations.
 
 
 ```ruby
@@ -239,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
@@ -264,6 +278,12 @@ class User < ActiveRecord::Base
 end
 ```
 
+get an array of all text values:
+
+```ruby
+@user.interests.texts # shortcut for @user.interests.map(&:text)
+```
+
 ### SimpleForm
 
 If you are using SimpleForm gem you don't need to specify input type (`:select` by default) and collection:
@@ -308,12 +328,155 @@ Also you can use builtin RSpec matcher:
 class User
   extend Enumerize
 
-  enumerize :sex, in: [:male, :female], default: :male
+  enumerize :sex, in: [:male, :female]
+end
+
+describe User do
+  it { should enumerize(:sex) }
+
+  # or with RSpec 3 expect syntax
+  it { is_expected.to enumerize(:sex) }
+end
+```
+
+#### Qualifiers
+
+##### in
+
+Use `in` to test usage of the `:in` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female]
 end
 
 describe User do
   it { should enumerize(:sex).in(:male, :female) }
-  it { should enumerize(:sex).in(:male, :female).with_default(:male) }
+end
+```
+
+You can test enumerized attribute value using custom values with the `in`
+qualifier.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: { male: 0, female: 1 }
+end
+
+describe User do
+  it { should enumerize(:sex).in(male: 0, female: 1) }
+end
+```
+
+##### with_default
+
+Use `with_default` to test usage of the `:default` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], default: :female
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_default(:female) }
+end
+```
+
+##### with_i18n_scope
+
+Use `with_i18n_scope` to test usage of the `:i18n_scope` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], i18n_scope: 'sex'
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_i18n_scope('sex') }
+end
+```
+
+##### with_predicates
+
+Use `with_predicates` to test usage of the `:predicates` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], predicates: true
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_predicates(true) }
+end
+```
+
+You can text prefixed predicates with the `with_predicates` qualifiers.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], predicates: { prefix: true }
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_predicates(prefix: true) }
+end
+```
+
+##### with_scope
+
+Use `with_scope` to test usage of the `:scope` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], scope: true
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_scope(true) }
+end
+```
+
+You can text custom scope with the `with_scope` qualifiers.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], scope: :having_sex
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_scope(scope: :having_sex) }
+end
+```
+
+##### with_multiple
+
+Use `with_multiple` to test usage of the `:multiple` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], multiple: true
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_multiple(true) }
 end
 ```
 

data/Rakefile

@@ -10,8 +10,6 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-RSpec::Core::RakeTask.new('default') do |t|
-  t.pattern = FileList['test/rspec_spec.rb']
-end
+RSpec::Core::RakeTask.new
 
-task :default => :test
+task :default => [:test, :spec]

data/lib/enumerize/activerecord.rb

@@ -4,11 +4,7 @@ module Enumerize
       super
 
       _enumerize_module.dependent_eval do
-        if defined?(::ActiveRecord::Base) && self < ::ActiveRecord::Base
-          if options[:scope]
-            _define_scope_methods!(name, options)
-          end
-
+        if self < ::ActiveRecord::Base
           include InstanceMethods
 
           # Since Rails use `allocate` method on models and initializes them with `init_with` method.
@@ -21,31 +17,11 @@ 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)
         if self.class.enumerized_attributes[attr_name]
-          _enumerized_values_for_validation[attr_name] = value
+          _enumerized_values_for_validation[attr_name.to_s] = value
         end
 
         super
@@ -55,9 +31,7 @@ module Enumerize
       def becomes(klass)
         became = super
         klass.enumerized_attributes.each do |attr|
-          if attr.is_a? Multiple
-            became.send("#{attr.name}=", send(attr.name))
-          end
+          became.send("#{attr.name}=", send(attr.name))
         end
 
         became

data/lib/enumerize/attribute.rb

@@ -4,12 +4,16 @@ 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]
 
       @klass  = klass
       @name   = name.to_sym
-      @values = Array(options[:in]).map { |v| Value.new(self, *v) }
+
+      value_class = options.fetch(:value_class, Value)
+      @values = Array(options[:in]).map { |v| value_class.new(self, *v) }
+
       @value_hash = Hash[@values.map { |v| [v.value.to_s, v] }]
       @value_hash.merge! Hash[@values.map { |v| [v.to_s, v] }]
 
@@ -36,6 +40,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)
@@ -67,6 +75,10 @@ module Enumerize
       values.map { |v| [v.text, v.to_s] }
     end
 
+    def respond_to_missing?(method, include_private=false)
+      @value_hash.include?(method.to_s) || super
+    end
+
     def define_methods!(mod)
       mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{name}
@@ -84,8 +96,6 @@ module Enumerize
         end
 
         def #{name}=(new_value)
-          _enumerized_values_for_validation[:#{name}] = new_value.nil? ? nil : new_value.to_s
-
           allowed_value_or_nil = self.class.enumerized_attributes[:#{name}].find_value(new_value)
           allowed_value_or_nil = allowed_value_or_nil.value unless allowed_value_or_nil.nil?
 
@@ -96,6 +106,10 @@ module Enumerize
           else
             @#{name} = allowed_value_or_nil
           end
+
+          _enumerized_values_for_validation['#{name}'] = new_value.nil? ? nil : new_value.to_s
+
+          allowed_value_or_nil
         end
 
         def #{name}_text
@@ -107,9 +121,27 @@ module Enumerize
         end
       RUBY
     end
+
+    private
+
+    def method_missing(method)
+      if @value_hash.include?(method.to_s)
+        find_value(method)
+      else
+        super
+      end
+    end
   end
 
   module Multiple
+    def find_default_value(value)
+      if value.respond_to?(:call)
+        value
+      else
+        find_values(*value)
+      end
+    end
+
     def define_methods!(mod)
       mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{name}
@@ -131,19 +163,19 @@ module Enumerize
         end
 
         def #{name}=(values)
-          _enumerized_values_for_validation[:#{name}] = values.respond_to?(:map) ? values.map(&:to_s) : values
-
           @_#{name}_enumerized_set = Enumerize::Set.new(self, self.class.enumerized_attributes[:#{name}], values)
-          string_values = #{name}.values.map(&:to_str)
+          raw_values = #{name}.values.map(&:value)
 
           if defined?(super)
-            super string_values
+            super raw_values
           elsif respond_to?(:write_attribute, true)
-            write_attribute '#{name}', string_values
+            write_attribute '#{name}', raw_values
           else
-            @#{name} = string_values
+            @#{name} = raw_values
           end
 
+          _enumerized_values_for_validation['#{name}'] = values.respond_to?(:map) ? values.map(&:to_s) : values
+
           #{name}
         end
       RUBY

data/lib/enumerize/base.rb

@@ -6,6 +6,15 @@ module Enumerize
       if base.respond_to?(:validate)
         base.validate :_validate_enumerized_attributes
       end
+
+      class << base
+        if (method_defined?(:inherited) || private_method_defined?(:inherited)) && !private_method_defined?(:inherited_without_enumerized)
+          alias_method :inherited_without_enumerized, :inherited
+          private :inherited_without_enumerized
+        end
+
+        alias_method :inherited, :inherited_with_enumerized
+      end
     end
 
     module ClassMethods
@@ -28,9 +37,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
@@ -50,10 +61,14 @@ module Enumerize
     end
 
     def read_attribute_for_validation(key)
+      key = key.to_s
+
       if _enumerized_values_for_validation.has_key?(key)
         _enumerized_values_for_validation[key]
-      else
+      elsif defined?(super)
         super
+      else
+        send(key)
       end
     end
 
@@ -78,15 +93,15 @@ module Enumerize
 
     def _set_default_value_for_enumerized_attributes
       self.class.enumerized_attributes.each do |attr|
-        # remove after dropping support for Rails 3.x
-        # https://github.com/brainspec/enumerize/issues/101
-        attr_value = begin
-          public_send(attr.name)
-        rescue ActiveModel::MissingAttributeError
-          nil
+        if respond_to?(attr.name)
+          attr_value = public_send(attr.name)
+        else
+          next
         end
 
-        if !attr_value && !_enumerized_values_for_validation.key?(attr.name)
+        value_for_validation = _enumerized_values_for_validation[attr.name.to_s]
+
+        if (!attr_value || attr_value.empty?) && (!value_for_validation || value_for_validation.empty?)
           value = attr.default_value
 
           if value.respond_to?(:call)