enumerize 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5542a2d4391256f030660b112b5550d304f54364
-  data.tar.gz: 8146fa77598d876ae818b44f923382ec7fa87745
+  metadata.gz: a1ee47a15b97ca4432e16a29da74e928811cfa59
+  data.tar.gz: 025e85c0386121a06550ed0989bf0b8648b3df3e
 SHA512:
-  metadata.gz: 1ee6f8b28d3da326a8ab68a9d5a8639b5dca559b58f32d2104364c540911e26a294d7c733a954075be09aa72a5b4890df8304415e69228c89ece1f52b8411cba
-  data.tar.gz: b997d62b2e1e759b50cd89921af5f16a7e88e0356a3eb674540ff5562fdde09259920ca9522f001b38ad33419c251cfbe019305752c6ae2ab9947f4a1caf018b
+  metadata.gz: 8df3f6bac28f16da9b07d8104f4e9961491827c7e04932a6449c4f61d19ab7439a31f96c8a702cae340b38ce0ba9aec42ae1e8aea688a6e6aa3a09af9a07c83a
+  data.tar.gz: 25c120a8fbfc07367e8cf498cfba05489cf8d3d6833554422cf70560a2d470a09f56628f08aa7fef95f8d8aef49b5bc1e657c8132fde05ddcf80c74f0af2eacb

data/.travis.yml

@@ -1,25 +1,18 @@
 language: ruby
+sudo: false
 services:
   - mongodb
-before_install:
-  - gem install bundler
 gemfile:
   - Gemfile
+  - Gemfile.rails42
+  - Gemfile.mongo_mapper
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - jruby-19mode
+  - 2.2.5
+  - 2.3.1
+  - jruby-9.1.2.0
 matrix:
-  include:
-    - rvm: 2.2
-      gemfile: Gemfile.rails40
-    - rvm: 2.2
-      gemfile: Gemfile.mongo_mapper
+  allow_failures:
+    - gemfile: Gemfile
+      rvm: jruby-9.1.2.0
 notifications:
-  email:
-    recipients:
-      - lest@brainspec.com
-      - nashby@brainspec.com
-      - dreamfall@brainspec.com
+  email: false

data/CHANGELOG.md

@@ -4,6 +4,27 @@
 
 ### bug fix
 
+## 2.0.0 (August 10, 2016)
+
+### enhancements
+
+* Drop support for Ruby older than 2.2. Support only Ruby 2.2+. (by [@nashby](https://github.com/nashby))
+* Drop support for Rails 4.0 and 4.1. Support only Rails 4.2 and newer. (by [@lest](https://github.com/lest))
+* Support Rails 5.0. (by [@nashby](https://github.com/nashby) and [@lest](https://github.com/lest))
+* Allow to pass enumerize values to `ActiveRecord#update_all` (by [@DmitryTsepelev](https://github.com/DmitryTsepelev) and [@ianwhite](https://github.com/ianwhite))
+   
+  ```ruby
+  User.update_all(status: :blocked)
+  ```
+  
+### bug fix
+
+* Rescue MissingAttributeError on attribute writing. (by [@embs](https://github.com/embs))
+* Fix presence validation for multiple attributes when the list contains a blank string. (by [@smoriwaki](https://github.com/smoriwaki))
+* Replace deprecated alias_method_chain with Module#prepend. (by [@koenpunt](https://github.com/koenpunt) and [@akm](https://github.com/akm))
+* Make it compatible with `globalize` gem. (by [@falm](https://github.com/falm))
+* Prevent method getter from being called when no default_value is being set. (by [@arjan0307](https://github.com/arjan0307))
+
 ## 1.1.1 (January 25, 2016)
 
 ### bug fix

data/Gemfile

@@ -1,5 +1,6 @@
 eval_gemfile('Gemfile.global')
 
 gem 'minitest', '~> 5.8'
-gem 'rails',    '4.2.4', :require => false
-gem 'mongoid',  '~> 5.0'
+gem 'rails',    '5.0.0', require: false
+gem 'activerecord-jdbcsqlite3-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'rails-5', platform: :jruby
+gem 'mongoid',  github: 'mongodb/mongoid'

data/Gemfile.global

@@ -6,7 +6,6 @@ gem 'rake'
 gem 'rspec', :require => false
 
 gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 gem 'sequel'
 
 platforms :rbx do

data/Gemfile.mongo_mapper

@@ -1,5 +1,6 @@
 eval_gemfile('Gemfile.global')
 
 gem 'minitest', '~> 5.8'
-gem 'rails',    '4.2.4', :require => false
+gem 'rails',    '4.2.7', :require => false
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 gem 'mongo_mapper'

data/Gemfile.rails42

@@ -0,0 +1,6 @@
+eval_gemfile('Gemfile.global')
+
+gem 'minitest', '~> 5.8'
+gem 'rails',    '4.2.7', :require => false
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+gem 'mongoid',  '~> 5.0'

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# Enumerize [![TravisCI](https://secure.travis-ci.org/brainspec/enumerize.svg?branch=master)](http://travis-ci.org/brainspec/enumerize) [![Gemnasium](https://gemnasium.com/brainspec/enumerize.svg)](https://gemnasium.com/brainspec/enumerize)
 
 Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper/Sequel support
 
@@ -180,6 +180,7 @@ user.sex = 'male'
 user.male?   # => true
 user.female? # => false
 ```
+:warning: If `enumerize` is used with Mongoid, it's not recommended to use `"writer"` as a field value since `writer?` is defined by Mongoid. [See more](https://github.com/brainspec/enumerize/issues/235). :warning:
 
 Using prefix:
 
@@ -284,6 +285,18 @@ get an array of all text values:
 @user.interests.texts # shortcut for @user.interests.map(&:text)
 ```
 
+Also, the reader method can be overridden, referencing the enumerized attribute value using `super`:
+
+```ruby
+def sex
+  if current_user.admin?
+    "Super#{super}"
+  else
+    super
+  end
+end
+```
+
 ### SimpleForm
 
 If you are using SimpleForm gem you don't need to specify input type (`:select` by default) and collection:

data/enumerize.gemspec

@@ -4,6 +4,7 @@ require File.expand_path('../lib/enumerize/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Sergey Nartimov"]
   gem.email         = "team@brainspec.com"
+  gem.licenses      = ['MIT']
   gem.description   = %q{Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper support}
   gem.summary       = %q{Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper support}
   gem.homepage      = "https://github.com/brainspec/enumerize"

data/lib/enumerize/activerecord.rb

@@ -19,7 +19,7 @@ module Enumerize
 
     module InstanceMethods
       # https://github.com/brainspec/enumerize/issues/74
-      def write_attribute(attr_name, value)
+      def write_attribute(attr_name, value, *options)
         if self.class.enumerized_attributes[attr_name]
           _enumerized_values_for_validation[attr_name.to_s] = value
         end
@@ -31,11 +31,26 @@ module Enumerize
       def becomes(klass)
         became = super
         klass.enumerized_attributes.each do |attr|
-          became.send("#{attr.name}=", send(attr.name))
+          # Rescue when column associated to the enum does not exist.
+          begin
+            became.send("#{attr.name}=", send(attr.name))
+          rescue ActiveModel::MissingAttributeError
+          end
         end
 
         became
       end
     end
+
+    def update_all(updates)
+      if updates.is_a?(Hash)
+        enumerized_attributes.each do |attr|
+          next if updates[attr.name].blank? || attr.kind_of?(Enumerize::Multiple)
+          updates[attr.name] = attr.find_value(updates[attr.name]).value
+        end
+      end
+
+      super(updates)
+    end
   end
 end

data/lib/enumerize/attribute.rb

@@ -174,7 +174,7 @@ module Enumerize
             @#{name} = raw_values
           end
 
-          _enumerized_values_for_validation['#{name}'] = values.respond_to?(:map) ? values.map(&:to_s) : values
+          _enumerized_values_for_validation['#{name}'] = values.respond_to?(:map) ? values.reject(&:blank?).map(&:to_s) : values
 
           #{name}
         end

data/lib/enumerize/base.rb

@@ -2,19 +2,11 @@ module Enumerize
   module Base
     def self.included(base)
       base.extend ClassMethods
+      base.singleton_class.prepend ClassMethods::Hook
 
       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
@@ -37,10 +29,10 @@ module Enumerize
         @enumerized_attributes ||= AttributeMap.new
       end
 
-      def inherited_with_enumerized(subclass)
-        enumerized_attributes.add_dependant subclass.enumerized_attributes
-        if respond_to?(:inherited_without_enumerized, true)
-          inherited_without_enumerized subclass
+      module Hook
+        def inherited(subclass)
+          enumerized_attributes.add_dependant subclass.enumerized_attributes
+          super subclass
         end
       end
 
@@ -93,22 +85,26 @@ module Enumerize
 
     def _set_default_value_for_enumerized_attributes
       self.class.enumerized_attributes.each do |attr|
-        if respond_to?(attr.name)
-          attr_value = public_send(attr.name)
-        else
-          next
-        end
+        next if attr.default_value.nil?
+        begin
+          if respond_to?(attr.name)
+            attr_value = public_send(attr.name)
+          else
+            next
+          end
 
-        value_for_validation = _enumerized_values_for_validation[attr.name.to_s]
+          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 (!attr_value || attr_value.empty?) && (!value_for_validation || value_for_validation.empty?)
+            value = attr.default_value
 
-          if value.respond_to?(:call)
-            value = value.arity == 0 ? value.call : value.call(self)
-          end
+            if value.respond_to?(:call)
+              value = value.arity == 0 ? value.call : value.call(self)
+            end
 
-          public_send("#{attr.name}=", value)
+            public_send("#{attr.name}=", value)
+          end
+        rescue ActiveModel::MissingAttributeError
         end
       end
     end

data/lib/enumerize/hooks/formtastic.rb

@@ -3,13 +3,8 @@ require 'active_support/concern'
 module Enumerize
   module Hooks
     module FormtasticFormBuilderExtension
-      extend ActiveSupport::Concern
 
-      included do
-        alias_method_chain :input, :enumerize
-      end
-
-      def input_with_enumerize(method, options={})
+      def input(method, options={})
         klass = object.class
 
         if klass.respond_to?(:enumerized_attributes) && (attr = klass.enumerized_attributes[method])
@@ -20,10 +15,10 @@ module Enumerize
           end
         end
 
-        input_without_enumerize(method, options)
+        super(method, options)
       end
     end
   end
 end
 
-::Formtastic::FormBuilder.send :include, Enumerize::Hooks::FormtasticFormBuilderExtension
+::Formtastic::FormBuilder.send :prepend, Enumerize::Hooks::FormtasticFormBuilderExtension

data/lib/enumerize/hooks/sequel_dataset.rb

@@ -1,19 +1,15 @@
 module Enumerize
   module Hooks
     module SequelDataset
-      def self.included(klass)
-        klass.alias_method_chain :literal_append, :enumerize
-      end
-
-      def literal_append_with_enumerize(sql, v)
+      def literal_append(sql, v)
         if v.is_a?(Enumerize::Value)
-          literal_append(sql, v.value)
+          super(sql, v.value)
         else
-          literal_append_without_enumerize(sql, v)
+          super(sql, v)
         end
       end
     end
   end
 end
 
-::Sequel::Dataset.send :include, Enumerize::Hooks::SequelDataset
+::Sequel::Dataset.send :prepend, Enumerize::Hooks::SequelDataset

data/lib/enumerize/hooks/simple_form.rb

@@ -3,21 +3,15 @@ require 'active_support/concern'
 module Enumerize
   module Hooks
     module SimpleFormBuilderExtension
-      extend ActiveSupport::Concern
 
-      included do
-        alias_method_chain :input, :enumerize
-        alias_method_chain :input_field, :enumerize
-      end
-
-      def input_with_enumerize(attribute_name, options={}, &block)
+      def input(attribute_name, options={}, &block)
         add_input_options_for_enumerized_attribute(attribute_name, options)
-        input_without_enumerize(attribute_name, options, &block)
+        super(attribute_name, options, &block)
       end
 
-      def input_field_with_enumerize(attribute_name, options={})
+      def input_field(attribute_name, options={})
         add_input_options_for_enumerized_attribute(attribute_name, options)
-        input_field_without_enumerize(attribute_name, options)
+        super(attribute_name, options)
       end
 
       private
@@ -37,4 +31,4 @@ module Enumerize
   end
 end
 
-::SimpleForm::FormBuilder.send :include, Enumerize::Hooks::SimpleFormBuilderExtension
+::SimpleForm::FormBuilder.send :prepend, Enumerize::Hooks::SimpleFormBuilderExtension

data/lib/enumerize/hooks/uniqueness.rb

@@ -3,21 +3,16 @@ require 'active_support/concern'
 module Enumerize
   module Hooks
     module UniquenessValidator
-      extend ActiveSupport::Concern
 
-      included do
-        alias_method_chain :validate_each, :enumerize
-      end
-
-      def validate_each_with_enumerize(record, name, value)
+      def validate_each(record, name, value)
         if record.class.respond_to?(:enumerized_attributes) && (attr = record.class.enumerized_attributes[name])
           value = attr.find_value(value).try(:value)
         end
 
-        validate_each_without_enumerize(record, name, value)
+        super(record, name, value)
       end
     end
   end
 end
 
-::ActiveRecord::Validations::UniquenessValidator.send :include, Enumerize::Hooks::UniquenessValidator
+::ActiveRecord::Validations::UniquenessValidator.send :prepend, Enumerize::Hooks::UniquenessValidator

data/lib/enumerize/integrations/rspec/matcher.rb

@@ -115,7 +115,7 @@ module Enumerize
         end
 
         def matches_multiple?
-          subject.instance_variable_defined?("@_#{expected_attr}_enumerized_set")
+          subject.public_send(expected_attr).is_a?(Enumerize::Set)
         end
 
         def matches_scope?

data/lib/enumerize/value.rb

@@ -34,10 +34,10 @@ module Enumerize
     def i18n_keys
       @i18n_keys ||= begin
         i18n_keys = i18n_scopes
-        i18n_keys << [:"enumerize.defaults.#{@attr.name}.#{self}"]
-        i18n_keys << [:"enumerize.#{@attr.name}.#{self}"]
+        i18n_keys << :"enumerize.defaults.#{@attr.name}.#{self}"
+        i18n_keys << :"enumerize.#{@attr.name}.#{self}"
         i18n_keys << self.underscore.humanize # humanize value if there are no translations
-        i18n_keys.flatten
+        i18n_keys
       end
     end
 

data/lib/enumerize/version.rb

@@ -1,3 +1,3 @@
 module Enumerize
-  VERSION = "1.1.1"
+  VERSION = "2.0.0"
 end

data/test/activerecord_test.rb

@@ -53,6 +53,10 @@ class User < ActiveRecord::Base
   enumerize :status, :in => { active: 1, blocked: 2 }, scope: true
 
   enumerize :account_type, :in => [:basic, :premium]
+
+  # There is no column for relationship enumeration for testing purposes: model
+  # should not be broken even if the associated column does not exist yet.
+  enumerize :relationship, :in => [:single, :married]
 end
 
 class UniqStatusUser < User
@@ -60,6 +64,10 @@ class UniqStatusUser < User
   validates :sex, presence: true
 end
 
+class InterestsRequiredUser < User
+  validates :interests, presence: true
+end
+
 describe Enumerize::ActiveRecordSupport do
   it 'sets nil if invalid value is passed' do
     user = User.new
@@ -298,6 +306,24 @@ describe Enumerize::ActiveRecordSupport do
     user.errors[:status].wont_be :empty?
   end
 
+  it 'validates presence with multiple attributes' do
+    user = InterestsRequiredUser.new
+    user.interests = []
+    user.valid?
+
+    user.errors[:interests].wont_be :empty?
+
+    user.interests = ['']
+    user.valid?
+
+    user.errors[:interests].wont_be :empty?
+
+    user.interests = [:dancing, :programming]
+    user.valid?
+
+    user.errors[:interests].must_be_empty
+  end
+
   it 'is valid after #becomes' do
     User.delete_all
     user = User.new
@@ -345,4 +371,63 @@ describe Enumerize::ActiveRecordSupport do
 
     assert_equal [1, 2], YAML.load(user.changes.to_yaml)[:status]
   end
+
+  it 'allows using update_all' do
+    User.delete_all
+
+    user = User.create(status: :active, account_type: :premium)
+
+    User.update_all(status: :blocked)
+    user.reload
+    user.status.must_equal 'blocked'
+
+    User.update_all(status: :active, account_type: :basic)
+    user.reload
+    user.status.must_equal 'active'
+    user.account_type.must_equal 'basic'
+  end
+
+  it 'allows using update_all for multiple enumerize' do
+    User.delete_all
+
+    klass = Class.new(User)
+    klass.enumerize :interests, in: { music: 0, sports: 1, dancing: 2, programming: 3}, multiple: true
+
+    user = klass.create(status: :active)
+    klass.update_all(status: :blocked, interests: [:music, :dancing])
+
+    user = klass.find(user.id)
+    user.status.must_equal 'blocked'
+    user.interests.must_equal %w(music dancing)
+  end
+
+  it 'allows using update_all with values' do
+    User.delete_all
+
+    user = User.create(status: :active)
+
+    User.update_all(status: 2)
+    user.reload
+    user.status.must_equal 'blocked'
+  end
+
+  it 'preserves string usage of update_all' do
+    User.delete_all
+
+    user = User.create(name: "Fred")
+
+    User.update_all("name = 'Frederick'")
+    user.reload
+    user.name.must_equal 'Frederick'
+  end
+
+  it 'preserves interpolated array usage of update_all' do
+    User.delete_all
+
+    user = User.create(name: "Fred")
+
+    User.update_all(["name = :name", {name: 'Frederick'}])
+    user.reload
+    user.name.must_equal 'Frederick'
+  end
 end

data/test/base_test.rb

@@ -41,7 +41,7 @@ describe Enumerize::Base do
     end
   end
 
-  it 'scopes translation by i18 key' do
+  it 'scopes translation by i18n key' do
     def klass.model_name
       name = "ExampleClass"
       def name.i18n_key
@@ -171,7 +171,7 @@ describe Enumerize::Base do
 
     object = klass.new
     object.foo.must_be_nil
-    object.attributes.must_equal({:foo => nil})
+    object.attributes.must_equal({})
 
     object.foo = 'test'
     object.foo.must_equal 'test'

data/test/mongoid_test.rb

@@ -65,6 +65,13 @@ describe Enumerize do
     user.role.must_equal 'user'
   end
 
+  it 'does not set default value for not selected attributes' do
+    model.delete_all
+    model.create!(sex: :male)
+
+    assert_equal ['_id'], model.only(:id).first.attributes.keys
+  end
+
   it 'validates inclusion' do
     user = model.new
     user.role = 'wrong'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumerize
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Sergey Nartimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,7 +38,7 @@ files:
 - Gemfile
 - Gemfile.global
 - Gemfile.mongo_mapper
-- Gemfile.rails40
+- Gemfile.rails42
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -88,7 +88,8 @@ files:
 - test/test_helper.rb
 - test/value_test.rb
 homepage: https://github.com/brainspec/enumerize
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -106,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper support

data/Gemfile.rails40

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