enumerize 0.8.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f08aba602317c54ffaf5f735e09a205a5d1a624c
-  data.tar.gz: 87f7613830f330b958dbd0a61f7a7ac89c262623
+  metadata.gz: fcc222d35f7bc7e96f344ebac473c10324a42bd9
+  data.tar.gz: 4509894cf1723e3df5403c8c93108c316b1ffbb1
 SHA512:
-  metadata.gz: a0226ef792ee39084f80286b886880003659bec15c62e1e98938048e6b3accb03b04330591e92d42a2d79f94fb874d80fe14395b4007d3576ac1285bb0b3ff77
-  data.tar.gz: 48448538be205b068c3c7f01ca68c6780e7e4d2fd0db6f353455ab1462f8db587e744633cd605c7872b77f6bf6ecd353e1ba076998ebc04108e04322ab024c48
+  metadata.gz: b1237ba9ede67eefc02b235ec0b74ff2bc6774f89479c22e0e5733dba911b487449bf24e49e82a3be2623cfb432198d6cedf59425f26fab11e36c8c11c073769
+  data.tar.gz: 98234b48c034f98cdd43e2379b8ad277dbad8d68088b3cabdfffe71767584028be87ead75629db81fc036862743e16bb5554c680f75d3aa22e814fada961c113

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

@@ -1,19 +1,34 @@
 language: ruby
+sudo: false
 services:
+  - postgresql
   - mongodb
-before_install:
-  - gem install bundler
 gemfile:
   - Gemfile
-  - Gemfile.rails4
+  - Gemfile.rails42
+  - Gemfile.rails51
+  - Gemfile.mongo_mapper
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - jruby-19mode
+  - 2.2.7
+  - 2.3.3
+  - 2.4.1
+  - jruby-9.1.8.0
+env:
+  global:
+    - DB_USER=postgres
+    - DB_PASS=
+  matrix:
+    - DB=sqlite3
+    - DB=postgresql
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: jruby-9.1.8.0
+  exclude:
+    - gemfile: Gemfile.mongo_mapper
+      env: DB=postgresql
+branches:
+  only:
+    - master
 notifications:
-  email:
-    recipients:
-      - lest@brainspec.com
-      - nashby@brainspec.com
-      - dreamfall@brainspec.com
+  email: false

data/CHANGELOG.md

@@ -1,3 +1,138 @@
+## master
+
+### enhancements
+
+### bug fix
+
+## 2.1.1 (May 1, 2017)
+
+### enhancements
+
+* Run tests with multiple DBs (SQLite and PostgreSQL). (by [tkawa](https://github.com/tkawa))
+
+### bug fix
+
+* Support deserialize and Rails 4.2 methods in the custom AR::Type class. (by [@lest](https://github.com/lest))
+* Support dumping custom AR type to JSON. (by [@lest](https://github.com/lest))
+
+## 2.1.0 (March 31, 2017)
+
+### enhancements
+
+* Support Active Record types serialization. (by [@lest](https://github.com/lest))
+
+## 2.0.1 (October 18, 2016)
+
+### bug fix
+
+* Support enumerized attributes in #update_all on relation objects. (by [@lest](https://github.com/lest))
+
+## 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
+
+* 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,7 @@
-source 'https://rubygems.org'
-
-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
+eval_gemfile('Gemfile.global')
 
+gem 'minitest', '~> 5.8'
+gem 'rails',    '5.0.2', require: false
+gem 'activerecord-jdbcsqlite3-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'rails-5', platform: :jruby
+gem 'activerecord-jdbcpostgresql-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'rails-5', platform: :jruby
 gem 'mongoid'
-gem 'mongo_mapper'
-gem 'simple_form'
-gem 'formtastic'

data/Gemfile.global

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec', :require => false
+
+gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
+gem 'pg', :platform => [:ruby, :mswin, :mingw]
+gem 'sequel'
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'psych'
+  gem 'rubinius-developer_tools'
+  gem 'rubysl-test-unit'
+end
+
+gem 'simple_form'
+gem 'formtastic'

data/Gemfile.mongo_mapper

@@ -0,0 +1,7 @@
+eval_gemfile('Gemfile.global')
+
+gem 'minitest', '~> 5.8'
+gem 'rails',    '4.2.8', :require => false
+gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+gem 'mongo_mapper'

data/Gemfile.rails42

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

data/Gemfile.rails51

@@ -0,0 +1,7 @@
+eval_gemfile('Gemfile.global')
+
+gem 'minitest', '~> 5.8'
+gem 'rails',    '5.1.0.rc1', require: false
+gem 'activerecord-jdbcsqlite3-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'rails-5', platform: :jruby
+gem 'activerecord-jdbcpostgresql-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'rails-5', platform: :jruby
+gem 'mongoid',  github: 'mongodb/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)
+# 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 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
@@ -168,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:
 
@@ -239,6 +252,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 +279,24 @@ class User < ActiveRecord::Base
 end
 ```
 
+get an array of all text values:
+
+```ruby
+@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:
@@ -308,12 +341,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/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

@@ -4,48 +4,34 @@ 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
 
+          const_get(:ActiveRecord_Relation).include(RelationMethods)
+          const_get(:ActiveRecord_AssociationRelation).include(RelationMethods)
+          const_get(:ActiveRecord_Associations_CollectionProxy).include(RelationMethods)
+
           # Since Rails use `allocate` method on models and initializes them with `init_with` method.
           # This way `initialize` method is not being called, but `after_initialize` callback always gets triggered.
           after_initialize :_set_default_value_for_enumerized_attributes
 
           # https://github.com/brainspec/enumerize/issues/111
           require 'enumerize/hooks/uniqueness'
-        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 = 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))
+          unless options[:multiple]
+            decorate_attribute_type(name, :enumerize) do |subtype|
+              Type.new(enumerized_attributes[name], subtype)
+            end
+          end
         end
       end
     end
 
     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] = value
+          _enumerized_values_for_validation[attr_name.to_s] = value
         end
 
         super
@@ -55,13 +41,55 @@ module Enumerize
       def becomes(klass)
         became = super
         klass.enumerized_attributes.each do |attr|
-          if attr.is_a? Multiple
+          # 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
+
+    module RelationMethods
+      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)
+            enumerize_value = attr.find_value(updates[attr.name])
+            updates[attr.name] = enumerize_value && enumerize_value.value
+          end
+        end
+
+        super(updates)
+      end
+    end
+
+    class Type < ActiveRecord::Type::Value
+      delegate :type, to: :@subtype
+
+      def initialize(attr, subtype)
+        @attr = attr
+        @subtype = subtype
+      end
+
+      def serialize(value)
+        v = @attr.find_value(value)
+        v && v.value
+      end
+
+      alias type_cast_for_database serialize
+
+      def deserialize(value)
+        @attr.find_value(value)
+      end
+
+      alias type_cast_from_database deserialize
+
+      def as_json(options = nil)
+        {attr: @attr.name, subtype: @subtype}.as_json(options)
+      end
+    end
   end
 end