enumerize 2.1.2 → 2.4.0

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'enumerize'
 require 'rspec/matchers/fail_matchers'

data/test/activemodel_test.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+if defined?(::ActiveModel::Attributes)
+
+describe Enumerize do
+  class ActiveModelUser
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    extend Enumerize
+
+    attribute :name, :string
+    enumerize :sex, :in => %w[male female]
+    enumerize :role, :in => %w[admin user], :default => 'user'
+    enumerize :interests, :in => [:music, :sports, :dancing, :programming], :multiple => true
+  end
+
+  class InterestsRequiredActiveModelUser < ActiveModelUser
+    validates :interests, presence: true
+  end
+
+  let(:model) { ActiveModelUser }
+
+  it 'initialize value' do
+    user = model.new(:name => 'active_model_user', :sex => :male, :role => :user, :interests => [:music, :programming])
+    user.sex.must_equal 'male'
+    user.sex_text.must_equal 'Male'
+    user.role.must_equal 'user'
+    user.role_text.must_equal 'User'
+    user.interests.must_equal %w(music programming)
+  end
+
+  it 'sets nil if invalid value is passed' do
+    user = model.new
+    user.sex = :invalid
+    user.sex.must_be_nil
+  end
+
+  it 'stores value' do
+    user = model.new
+    user.sex = :female
+    user.sex.must_equal 'female'
+  end
+
+  it 'has default value' do
+    model.new.role.must_equal 'user'
+  end
+
+  it 'validates inclusion' do
+    user = model.new
+    user.role = 'wrong'
+    user.wont_be :valid?
+  end
+
+  it 'supports multiple attributes' do
+    user = ActiveModelUser.new
+    user.interests.must_be_instance_of Enumerize::Set
+    user.interests.must_be_empty
+    user.interests << :music
+    user.interests.must_equal %w(music)
+    user.interests << :sports
+    user.interests.must_equal %w(music sports)
+
+    user.interests = []
+    interests = user.interests
+    interests << :music
+    interests.must_equal %w(music)
+    interests << :dancing
+    interests.must_equal %w(music dancing)
+  end
+
+  it 'returns invalid multiple value for validation' do
+    user = ActiveModelUser.new
+    user.interests << :music
+    user.interests << :invalid
+    values = user.read_attribute_for_validation(:interests)
+    values.must_equal %w(music invalid)
+  end
+
+  it 'validates multiple attributes' do
+    user = ActiveModelUser.new
+    user.interests << :invalid
+    user.wont_be :valid?
+
+    user.interests = Object.new
+    user.wont_be :valid?
+
+    user.interests = ['music', '']
+    user.must_be :valid?
+  end
+
+  it 'validates presence with multiple attributes' do
+    user = InterestsRequiredActiveModelUser.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
+end
+
+else
+  # Skip
+end

data/test/activerecord_test.rb

@@ -44,7 +44,10 @@ ActiveRecord::Base.connection.instance_eval do
     t.string :name
     t.string :interests
     t.integer :status
+    t.text :settings
+    t.integer :skill
     t.string :account_type, :default => :basic
+    t.string :foo
   end
 
   create_table :documents do |t|
@@ -78,13 +81,18 @@ class User < ActiveRecord::Base
   extend Enumerize
   include RoleEnum
 
-  enumerize :sex, :in => [:male, :female]
+  store :settings, accessors: [:language]
+
+  enumerize :sex, :in => [:male, :female], scope: :shallow
+  enumerize :language, :in => [:en, :jp]
 
   serialize :interests, Array
   enumerize :interests, :in => [:music, :sports, :dancing, :programming], :multiple => true
 
   enumerize :status, :in => { active: 1, blocked: 2 }, scope: true
 
+  enumerize :skill, :in => { noob: 0, casual: 1, pro: 2 }, scope: :shallow
+
   enumerize :account_type, :in => [:basic, :premium]
 
   # There is no column for relationship enumeration for testing purposes: model
@@ -103,6 +111,26 @@ class InterestsRequiredUser < User
   validates :interests, presence: true
 end
 
+class SkipValidationsUser < ActiveRecord::Base
+  self.table_name = "users"
+  include SkipValidationsEnum
+end
+
+class  DoNotSkipValidationsUser < ActiveRecord::Base
+  self.table_name = "users"
+  include DoNotSkipValidationsEnum
+end
+
+class SkipValidationsLambdaUser < ActiveRecord::Base
+  self.table_name = "users"
+  include SkipValidationsLambdaEnum
+end
+
+class SkipValidationsLambdaWithParamUser < ActiveRecord::Base
+  self.table_name = "users"
+  include SkipValidationsLambdaWithParamEnum
+end
+
 describe Enumerize::ActiveRecordSupport do
   it 'sets nil if invalid value is passed' do
     user = User.new
@@ -128,6 +156,21 @@ describe Enumerize::ActiveRecordSupport do
     end
   end
 
+  it 'sets nil if invalid stored attribute value is passed' do
+    user = User.new
+    user.language = :invalid
+    user.language.must_be_nil
+  end
+
+  it 'saves stored attribute value' do
+    User.delete_all
+    user = User.new
+    user.language = :en
+    user.save!
+    user.reload
+    user.language.must_equal 'en'
+  end
+
   it 'has default value' do
     User.new.role.must_equal 'user'
     User.new.attributes['role'].must_equal 'user'
@@ -137,7 +180,9 @@ describe Enumerize::ActiveRecordSupport do
     User.delete_all
     User.create!(:sex => :male)
 
-    assert_equal ['id'], User.select(:id).first.attributes.keys
+    user = User.select(:id).first
+    user.attributes['role'].must_equal nil
+    user.attributes['lambda_role'].must_equal nil
   end
 
   it 'has default value with lambda' do
@@ -173,6 +218,14 @@ describe Enumerize::ActiveRecordSupport do
     user.errors[:role].must_include 'is not included in the list'
   end
 
+  it 'sets value to enumerized field from db when record is reloaded' do
+    user = User.create!(interests: [:music])
+    User.find(user.id).update(interests: %i[music dancing])
+    user.interests.must_equal %w[music]
+    user.reload
+    user.interests.must_equal %w[music dancing]
+  end
+
   it 'validates inclusion when using write_attribute with string attribute' do
     user = User.new
     user.send(:write_attribute, 'role', 'wrong')
@@ -212,6 +265,31 @@ describe Enumerize::ActiveRecordSupport do
     user.read_attribute(:role).must_be_nil
   end
 
+  it 'validates inclusion when :skip_validations = false' do
+    user = DoNotSkipValidationsUser.new
+    user.foo = 'wrong'
+    user.wont_be :valid?
+    user.errors[:foo].must_include 'is not included in the list'
+  end
+
+  it 'does not validate inclusion when :skip_validations = true' do
+    user = SkipValidationsUser.new
+    user.foo = 'wrong'
+    user.must_be :valid?
+  end
+
+  it 'supports :skip_validations option as lambda' do
+    user = SkipValidationsLambdaUser.new
+    user.foo = 'wrong'
+    user.must_be :valid?
+  end
+
+  it 'supports :skip_validations option as lambda with a parameter' do
+    user = SkipValidationsLambdaWithParamUser.new
+    user.foo = 'wrong'
+    user.must_be :valid?
+  end
+
   it 'supports multiple attributes' do
     user = User.new
     user.interests.must_be_empty
@@ -263,7 +341,11 @@ describe Enumerize::ActiveRecordSupport do
   it 'stores custom values for multiple attributes' do
     User.delete_all
 
-    klass = Class.new(User)
+    klass = Class.new(User) do
+      def self.name
+        'UserSubclass'
+      end
+    end
     klass.enumerize :interests, in: { music: 0, sports: 1, dancing: 2, programming: 3}, multiple: true
 
     user = klass.new
@@ -281,6 +363,7 @@ describe Enumerize::ActiveRecordSupport do
 
     user_1 = User.create!(status: :active, role: :admin)
     user_2 = User.create!(status: :blocked)
+    user_3 = User.create!(sex: :male, skill: :pro)
 
     User.with_status(:active).must_equal [user_1]
     User.with_status(:blocked).must_equal [user_2]
@@ -289,7 +372,8 @@ describe Enumerize::ActiveRecordSupport do
     User.without_status(:active).must_equal [user_2]
     User.without_status(:active, :blocked).must_equal []
 
-    User.having_role(:admin).must_equal [user_1]
+    User.male.must_equal [user_3]
+    User.pro.must_equal [user_3]
   end
 
   it 'ignores not enumerized values that passed to the scope method' do
@@ -433,7 +517,11 @@ describe Enumerize::ActiveRecordSupport do
   it 'allows using update_all for multiple enumerize' do
     User.delete_all
 
-    klass = Class.new(User)
+    klass = Class.new(User) do
+      def self.name
+        'UserSubclass'
+      end
+    end
     klass.enumerize :interests, in: { music: 0, sports: 1, dancing: 2, programming: 3}, multiple: true
 
     user = klass.create(status: :active)
@@ -522,4 +610,38 @@ describe Enumerize::ActiveRecordSupport do
     user = YAML.load(User.create(status: :blocked).to_yaml)
     user.status.must_equal 'blocked'
   end
+
+  # https://github.com/brainspec/enumerize/issues/304
+  it "fallbacks to a raw passed value if AR type can't find value in the attribute" do
+    table = User.arel_table
+    sql = User.where(table[:account_type].matches '%foo%').to_sql
+
+    sql.must_include 'LIKE \'%foo%\''
+  end
+
+  if Rails::VERSION::MAJOR >= 6
+    it 'supports AR#insert_all' do
+      User.delete_all
+
+      User.insert_all([{ sex: :male }])
+      User.insert_all([{ status: :active }])
+      User.insert_all([{ interests: [:music, :sports] }])
+
+      User.exists?(sex: :male).must_equal true
+      User.exists?(status: :active).must_equal true
+      User.exists?(interests: [:music, :sports]).must_equal true
+    end
+
+    it 'supports AR#upsert_all' do
+      User.delete_all
+
+      User.upsert_all([{ sex: :male }])
+      User.upsert_all([{ status: :active }])
+      User.upsert_all([{ interests: [:music, :sports] }])
+
+      User.exists?(sex: :male).must_equal true
+      User.exists?(status: :active).must_equal true
+      User.exists?(interests: [:music, :sports]).must_equal true
+    end
+  end
 end

data/test/attribute_map_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module Enumerize

data/test/attribute_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe Enumerize::Attribute do
@@ -14,6 +16,11 @@ describe Enumerize::Attribute do
     attr.values.must_equal %w[a b]
   end
 
+  it 'returns frozen values' do
+    build_attr nil, :foo, :in => [:a, :b]
+    attr.values.map(&:frozen?).must_equal [true, true]
+  end
+
   it 'converts name to symbol' do
     build_attr nil, 'foo', :in => %w[a b]
     attr.name.must_equal :foo

data/test/base_test.rb

@@ -1,32 +1,34 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe Enumerize::Base do
-  let(:klass) do
+  let(:kklass) do
     Class.new do
       extend Enumerize
     end
   end
 
   let(:subklass) do
-    Class.new(klass)
+    Class.new(kklass)
   end
 
-  let(:object) { klass.new }
+  let(:object) { kklass.new }
 
   it 'returns nil when not set' do
-    klass.enumerize(:foo, :in => [:a, :b])
+    kklass.enumerize(:foo, :in => [:a, :b])
     object.foo.must_be_nil
   end
 
   it 'returns value that was set' do
-    klass.enumerize(:foo, :in => [:a, :b])
+    kklass.enumerize(:foo, :in => [:a, :b])
     object.foo = :a
     object.foo.must_equal 'a'
   end
 
   it 'returns translation' do
     store_translations(:en, :enumerize => {:foo => {:a => 'a text'}}) do
-      klass.enumerize(:foo, :in => [:a, :b])
+      kklass.enumerize(:foo, :in => [:a, :b])
       object.foo = :a
       object.foo.text.must_equal 'a text'
       object.foo_text.must_equal 'a text'
@@ -36,14 +38,14 @@ describe Enumerize::Base do
 
   it 'returns nil as translation when value is nil' do
     store_translations(:en, :enumerize => {:foo => {:a => 'a text'}}) do
-      klass.enumerize(:foo, :in => [:a, :b])
+      kklass.enumerize(:foo, :in => [:a, :b])
       object.foo_text.must_be_nil
     end
   end
 
   it 'scopes translation by i18n key' do
-    def klass.model_name
-      name = "ExampleClass"
+    def kklass.model_name
+      name = String.new("ExampleClass")
       def name.i18n_key
         'example_class'
       end
@@ -52,7 +54,7 @@ describe Enumerize::Base do
     end
 
     store_translations(:en, :enumerize => {:example_class => {:foo => {:a => 'a text scoped'}}}) do
-      klass.enumerize(:foo, :in => [:a, :b])
+      kklass.enumerize(:foo, :in => [:a, :b])
       object.foo = :a
       object.foo.text.must_equal 'a text scoped'
       object.foo_text.must_equal 'a text scoped'
@@ -61,88 +63,88 @@ describe Enumerize::Base do
 
   it 'returns humanized value if there are no translations' do
     store_translations(:en, :enumerize => {}) do
-      klass.enumerize(:foo, :in => [:a, :b])
+      kklass.enumerize(:foo, :in => [:a, :b])
       object.foo = :a
       object.foo_text.must_equal 'A'
     end
   end
 
   it 'stores value as string' do
-    klass.enumerize(:foo, :in => [:a, :b])
+    kklass.enumerize(:foo, :in => [:a, :b])
     object.foo = :a
     object.instance_variable_get(:@foo).must_be_instance_of String
   end
 
   it 'handles default value' do
-    klass.enumerize(:foo, :in => [:a, :b], :default => :b)
+    kklass.enumerize(:foo, :in => [:a, :b], :default => :b)
     object.foo.must_equal 'b'
   end
 
   it 'handles default value with lambda' do
-    klass.enumerize(:foo, :in => [:a, :b], :default => lambda { :b })
+    kklass.enumerize(:foo, :in => [:a, :b], :default => lambda { :b })
     object.foo.must_equal 'b'
   end
 
   it 'injects object instance into lamda default value' do
-    klass.enumerize(:foo, :in => [:a, :b], :default => lambda { |obj| :b if obj.is_a? klass })
+    kklass.enumerize(:foo, :in => [:a, :b], :default => lambda { |obj| :b if obj.is_a? kklass })
     object.foo.must_equal 'b'
   end
 
   it 'raises exception on invalid default value' do
     proc {
-      klass.enumerize(:foo, :in => [:a, :b], :default => :c)
+      kklass.enumerize(:foo, :in => [:a, :b], :default => :c)
     }.must_raise ArgumentError
   end
 
   it 'has enumerized attributes' do
-    klass.enumerized_attributes.must_be_empty
-    klass.enumerize(:foo, :in => %w[a b])
-    klass.enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
+    kklass.enumerized_attributes.must_be_empty
+    kklass.enumerize(:foo, :in => %w[a b])
+    kklass.enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
   end
 
   it "doesn't override existing method" do
-    method = klass.method(:name)
-    klass.enumerize(:name, :in => %w[a b], :default => 'a')
-    klass.method(:name).must_equal method
+    method = kklass.method(:name)
+    kklass.enumerize(:name, :in => %w[a b], :default => 'a')
+    kklass.method(:name).must_equal method
   end
 
   it "inherits enumerized attributes from a parent class" do
-    klass.enumerize(:foo, :in => %w[a b])
+    kklass.enumerize(:foo, :in => %w[a b])
     subklass.enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
   end
 
   it "inherits enumerized attributes from a grandparent class" do
-    klass.enumerize(:foo, :in => %w[a b])
+    kklass.enumerize(:foo, :in => %w[a b])
     Class.new(subklass).enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
   end
 
   it "doesn't add enumerized attributes to parent class" do
-    klass.enumerize(:foo, :in => %w[a b])
+    kklass.enumerize(:foo, :in => %w[a b])
     subklass.enumerize(:bar, :in => %w[c d])
 
-    klass.enumerized_attributes[:bar].must_be_nil
+    kklass.enumerized_attributes[:bar].must_be_nil
   end
 
   it 'adds new parent class attributes to subclass' do
-    subklass = Class.new(klass)
-    klass.enumerize :foo, :in => %w[a b]
+    subklass = Class.new(kklass)
+    kklass.enumerize :foo, :in => %w[a b]
     subklass.enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
   end
 
   it 'stores nil value' do
-    klass.enumerize(:foo, :in => [:a, :b])
+    kklass.enumerize(:foo, :in => [:a, :b])
     object.foo = nil
     object.instance_variable_get(:@foo).must_be_nil
   end
 
   it 'casts value to string for validation' do
-    klass.enumerize(:foo, :in => [:a, :b])
+    kklass.enumerize(:foo, :in => [:a, :b])
     object.foo = :c
     object.read_attribute_for_validation(:foo).must_equal 'c'
   end
 
   it "doesn't cast nil to string for validation" do
-    klass.enumerize(:foo, :in => [:a, :b])
+    kklass.enumerize(:foo, :in => [:a, :b])
     object.foo = nil
     object.read_attribute_for_validation(:foo).must_be_nil
   end
@@ -179,7 +181,7 @@ describe Enumerize::Base do
   end
 
   it 'stores hash values' do
-    klass.enumerize(:foo, :in => {:a => 1, :b => 2})
+    kklass.enumerize(:foo, :in => {:a => 1, :b => 2})
 
     object.foo = :a
     object.instance_variable_get(:@foo).must_equal 1
@@ -191,7 +193,7 @@ describe Enumerize::Base do
   end
 
   it 'returns custom value' do
-    klass.enumerize(:foo, :in => {:a => 1, :b => 2})
+    kklass.enumerize(:foo, :in => {:a => 1, :b => 2})
 
     object.foo = :a
     object.foo_value.must_equal 1