enumerize 0.3.0 → 2.3.1

data/test/mongoid_test.rb

@@ -1,24 +1,35 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
+begin
+
 silence_warnings do
   require 'mongoid'
 end
 
 Mongoid.configure do |config|
-  config.master  = Mongo::Connection.new('127.0.0.1', 27017).db('enumerize-test-suite')
-  config.use_utc = true
-  config.include_root_in_json = true
+  config.connect_to('enumerize-test-suite')
+  config.options = { use_utc: true, include_root_in_json: true }
 end
 
 describe Enumerize do
   class MongoidUser
     include Mongoid::Document
-    include Enumerize
+    extend Enumerize
 
     field :sex
     field :role
-    enumerize :sex, :in => %w[male female]
-    enumerize :role, :in => %w[admine user], :default => 'user'
+    field :foo
+    field :skill
+
+    enumerize :sex,    :in => %w[male female], scope: true
+    enumerize :status, :in => %w[notice warning error], scope: true
+    enumerize :role,   :in => %w[admin user], :default => 'user', scope: :having_role
+    enumerize :mult,   :in => %w[one two three four], :multiple => true
+    enumerize :foo,    :in => %w[bar baz], :skip_validations => true
+    enumerize :skill,  :in => { noob: 0, casual: 1, pro: 2 }, scope: :shallow
+    enumerize :account_type, :in => %w[basic premium], scope: :shallow
   end
 
   before { $VERBOSE = nil }
@@ -29,7 +40,7 @@ describe Enumerize do
   it 'sets nil if invalid value is passed' do
     user = model.new
     user.sex = :invalid
-    user.sex.must_equal nil
+    user.sex.must_be_nil
   end
 
   it 'saves value' do
@@ -54,12 +65,41 @@ describe Enumerize do
     model.new.role.must_equal 'user'
   end
 
+  it 'uses after_initialize callback to set default value' do
+    model.delete_all
+    model.create!(sex: 'male', role: nil)
+
+    user = model.where(sex: 'male').first
+    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'
     user.wont_be :valid?
   end
 
+  it 'does not validate inclusion when :skip_validations option passed' do
+    user = model.new
+    user.foo = 'wrong'
+    user.must_be :valid?
+  end
+
+  it 'sets value to enumerized field from db when record is reloaded' do
+    user = model.create!(mult: [:one])
+    model.find(user.id).update(mult: %i[two three])
+    user.mult.must_equal %w[one]
+    user.reload
+    user.mult.must_equal %w[two three]
+  end
+
   it 'assigns value on loaded record' do
     model.delete_all
     model.create!(:sex => :male)
@@ -67,4 +107,55 @@ describe Enumerize do
     user.sex = :female
     user.sex.must_equal 'female'
   end
+
+  it 'loads multiple properly' do
+    model.delete_all
+
+    model.create!(:mult => ['one', 'two'])
+    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)
+    user_3 = model.create!(skill: :pro, account_type: :premium)
+
+    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_set.must_equal [user_2, user_3].to_set
+    model.without_sex(:female).to_set.must_equal [user_1, user_3].to_set
+    model.without_sex(:male, :female).to_a.must_equal [user_3]
+
+    model.having_role(:admin).to_a.must_equal [user_1]
+    model.having_role(:user).to_a.must_equal [user_2, user_3]
+
+    model.pro.to_a.must_equal [user_3]
+    model.premium.to_a.must_equal [user_3]
+  end
+
+  it 'chains scopes' do
+    model.delete_all
+
+    user_1 = model.create!(status: :notice)
+    user_2 = model.create!(status: :warning)
+    user_3 = model.create!(status: :error)
+
+    model.with_status(:notice, :warning).with_status(:notice, :error).to_a.must_equal [user_1]
+    model.with_status(:notice, :warning).union.with_status(:notice, :error).to_a.must_equal [user_1, user_2, user_3]
+  end
+
+  it 'ignores not enumerized values that passed to the scope method' do
+    model.delete_all
+
+    model.with_sex(:foo).must_equal []
+  end
+end
+
+rescue LoadError
+  # Skip
 end

data/test/multiple_test.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+describe Enumerize::Base do
+  let(:kklass) do
+    Class.new do
+      extend Enumerize
+    end
+  end
+
+  let(:subklass) do
+    Class.new(kklass)
+  end
+
+  let(:object) { kklass.new }
+
+  it 'returns [] when not set' do
+    kklass.enumerize :foos, in: %w(a b), multiple: true
+    object.foos.must_equal []
+  end
+
+  it 'returns setted array' do
+    kklass.enumerize :foos, in: %w(a b c), multiple: true
+    object.foos = %w(a c)
+    object.foos.must_equal %w(a c)
+  end
+
+  it 'sets default value as single value' do
+    kklass.enumerize :foos, in: %w(a b c), default: 'b', multiple: true
+    object.foos.must_equal %w(b)
+  end
+
+  it 'sets default value as array of one element' do
+    kklass.enumerize :foos, in: %w(a b c), default: %w(b), multiple: true
+    object.foos.must_equal %w(b)
+  end
+
+  it 'sets default value as array of several elements' do
+    kklass.enumerize :foos, in: %w(a b c), default: %w(b c), multiple: true
+    object.foos.must_equal %w(b c)
+  end
+
+  it "doesn't define _text method" do
+    kklass.enumerize :foos, in: %w(a b c), multiple: true
+    object.wont_respond_to :foos_text
+  end
+
+  it "doesn't define _value method" do
+    kklass.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
+      kklass.enumerize :foos, in: %w(a b c), multiple: true, scope: true
+    end
+  end
+end

data/test/predicates_test.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+describe Enumerize::Predicates do
+  let(:kklass) do
+    Class.new do
+      extend Enumerize
+    end
+  end
+
+  let(:object) { kklass.new }
+
+  it 'creates predicate methods' do
+    kklass.enumerize(:foo, in: %w(a b), predicates: true)
+    object.must_respond_to :a?
+    object.must_respond_to :b?
+  end
+
+  it 'creates predicate methods when enumerized values have dash in it' do
+    kklass.enumerize(:foo, in: %w(foo-bar bar-foo), predicates: true)
+    object.must_respond_to :foo_bar?
+    object.must_respond_to :bar_foo?
+  end
+
+  it 'creates predicate methods on multiple attribute' do
+    kklass.enumerize(:foo, in: %w(a b), predicates: true, multiple: true)
+    object.must_respond_to :a?
+    object.must_respond_to :b?
+  end
+
+  it 'checks values' do
+    kklass.enumerize(:foo, in: %w(a b), predicates: true)
+    object.foo = 'a'
+    object.a?.must_equal true
+    object.b?.must_equal false
+  end
+
+  it 'checks values on multiple attribute' do
+    kklass.enumerize(:foo, in: %w(a b), predicates: true, multiple: true)
+    object.foo << :a
+    object.a?.must_equal true
+    object.b?.must_equal false
+  end
+
+  it 'prefixes methods' do
+    kklass.enumerize(:foo, in: %w(a b), predicates: { prefix: 'bar' })
+    object.wont_respond_to :a?
+    object.wont_respond_to :b?
+    object.must_respond_to :bar_a?
+    object.must_respond_to :bar_b?
+  end
+
+  it 'accepts only option' do
+    kklass.enumerize(:foo, in: %w(a b), predicates: { only: :a })
+    object.must_respond_to :a?
+    object.wont_respond_to :b?
+  end
+
+  it 'accepts except option' do
+    kklass.enumerize(:foo, in: %w(a b), predicates: { except: :a })
+    object.wont_respond_to :a?
+    object.must_respond_to :b?
+  end
+end

data/test/rails_admin_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class RailsAdminSpec < MiniTest::Spec
+  let(:kklass) do
+    Class.new do
+      extend Enumerize
+    end
+  end
+
+  let(:object) { kklass.new }
+
+  it 'defines enum method' do
+    store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+      kklass.enumerize(:foo, in: [:a, :b])
+      object.foo_enum.must_equal [['a text', 'a'], ['b text', 'b']]
+    end
+  end
+
+  it 'defines enum properly for custom values enumerations' do
+    store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+      kklass.enumerize(:foo, in: {:a => 1, :b => 2})
+      object.foo_enum.must_equal [['a text', 'a'], ['b text', 'b']]
+    end
+  end
+end

data/test/sequel_test.rb

@@ -0,0 +1,341 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'sequel'
+require 'logger'
+require 'jdbc/sqlite3' if RUBY_PLATFORM == 'java'
+
+module SequelTest
+  silence_warnings do
+    DB = if RUBY_PLATFORM == 'java'
+      Sequel.connect('jdbc:sqlite::memory:')
+    else
+      Sequel.sqlite
+    end
+    DB.loggers << Logger.new(nil)
+  end
+
+  DB.create_table :users do
+    primary_key :id
+    String :sex
+    String :role
+    String :lambda_role
+    String :name
+    String :interests
+    String :status
+    Integer :skill
+    String :account_type, default: "basic"
+    String :foo
+  end
+
+  DB.create_table :documents do
+    primary_key :id
+    String :visibility
+    Time :created_at
+    Time :updated_at
+  end
+
+  class Document < Sequel::Model
+    plugin :enumerize
+    enumerize :visibility, :in => [:public, :private, :protected], :scope => true, :default => :public
+  end
+
+  module RoleEnum
+    extend Enumerize
+    enumerize :role, :in => [:user, :admin], :default => :user, scope: :having_role
+    enumerize :lambda_role, :in => [:user, :admin], :default => lambda { :admin }
+  end
+
+  class User < Sequel::Model
+    plugin :serialization, :json, :interests
+    plugin :dirty
+    plugin :defaults_setter
+    plugin :validation_helpers
+    plugin :enumerize
+    include RoleEnum
+
+    enumerize :sex, :in => [:male, :female], scope: :shallow
+
+    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]
+  end
+
+  class UniqStatusUser < User
+    def validate
+      super
+      validates_unique :status
+      validates_presence :sex
+    end
+  end
+
+  class SkipValidationsUser < Sequel::Model(:users)
+    include SkipValidationsEnum
+  end
+
+  class DoNotSkipValidationsUser < Sequel::Model(:users)
+    include DoNotSkipValidationsEnum
+  end
+
+  class SkipValidationsLambdaUser < Sequel::Model(:users)
+    include SkipValidationsLambdaEnum
+  end
+
+  class SkipValidationsLambdaWithParamUser < Sequel::Model(:users)
+    include SkipValidationsLambdaWithParamEnum
+  end
+
+  describe Enumerize::SequelSupport do
+    it 'sets nil if invalid value is passed' do
+      user = User.new
+      user.sex = :invalid
+      user.sex.must_be_nil
+    end
+
+    it 'saves value' do
+      User.filter{ true }.delete
+      user = User.new
+      user.sex = :female
+      user.save
+      user.sex.must_equal 'female'
+    end
+
+    it 'loads value' do
+      User.filter{ true }.delete
+      User.create(:sex => :male)
+      store_translations(:en, :enumerize => {:sex => {:male => 'Male'}}) do
+        user = User.first
+        user.sex.must_equal 'male'
+        user.sex_text.must_equal 'Male'
+      end
+    end
+
+    it 'has default value' do
+      User.new.role.must_equal 'user'
+      User.new.values[:role].must_equal 'user'
+    end
+
+    it 'does not set default value for not selected attributes' do
+      User.filter{ true }.delete
+      User.create(:sex => :male)
+
+      assert_equal [:id], User.select(:id).first.values.keys
+    end
+
+    it 'has default value with lambda' do
+      User.new.lambda_role.must_equal 'admin'
+      User.new.values[:lambda_role].must_equal 'admin'
+    end
+    it 'uses after_initialize callback to set default value' do
+      User.filter{ true }.delete
+      User.create(sex: 'male', lambda_role: nil)
+
+      user = User.where(:sex => 'male').first
+      user.lambda_role.must_equal 'admin'
+    end
+
+    it 'uses default value from db column' do
+      User.new.account_type.must_equal 'basic'
+    end
+
+    it 'validates inclusion' do
+      user = User.new
+      user.role = 'wrong'
+      user.wont_be :valid?
+      user.errors[:role].must_include 'is not included in the list'
+    end
+
+    it 'validates inclusion on mass assignment' do
+      assert_raises Sequel::ValidationFailed do
+        User.create(role: 'wrong')
+      end
+    end
+
+    it "uses persisted value for validation if it hasn't been set" do
+      user = User.create :sex => :male
+      User[user.id].read_attribute_for_validation(:sex).must_equal 'male'
+    end
+
+    it 'is valid with empty string assigned' do
+      user = User.new
+      user.role = ''
+      user.must_be :valid?
+    end
+
+    it 'stores nil when empty string assigned' do
+      user = User.new
+      user.role = ''
+      user.values[: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 ||= []
+      user.interests.must_be_empty
+      user.interests << "music"
+      user.interests.must_equal %w(music)
+      user.save
+
+      user = User[user.id]
+      user.interests.must_be_instance_of Enumerize::Set
+      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 = User.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 = User.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 'stores custom values for multiple attributes' do
+      User.filter{ true }.delete
+
+      klass = Class.new(User)
+      klass.enumerize :interests, in: { music: 0, sports: 1, dancing: 2, programming: 3}, multiple: true
+
+      user = klass.new
+      user.interests << :music
+      user.interests.must_equal %w(music)
+      user.save
+
+      user = klass[user.id]
+      user.interests.must_equal %w(music)
+    end
+
+    it 'adds scope' do
+      User.filter{ true }.delete
+
+      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).to_a.must_equal [user_1]
+      User.with_status(:blocked).to_a.must_equal [user_2]
+      User.with_status(:active, :blocked).to_set.must_equal [user_1, user_2].to_set
+
+      User.without_status(:active).to_a.must_equal [user_2]
+      User.without_status(:active, :blocked).to_a.must_equal []
+
+      User.having_role(:admin).to_a.must_equal [user_1]
+      User.male.to_a.must_equal [user_3]
+      User.pro.to_a.must_equal [user_3]
+    end
+
+    it 'allows either key or value as valid' do
+      user_1 = User.new(status: :active)
+      user_2 = User.new(status: 1)
+      user_3 = User.new(status: '1')
+
+      user_1.status.must_equal 'active'
+      user_2.status.must_equal 'active'
+      user_3.status.must_equal 'active'
+
+      user_1.must_be :valid?
+      user_2.must_be :valid?
+      user_3.must_be :valid?
+    end
+
+    it 'supports defining enumerized attributes on abstract class' do
+      Document.filter{ true }.delete
+
+      document = Document.new
+      document.visibility = :protected
+      document.visibility.must_equal 'protected'
+    end
+
+    it 'supports defining enumerized scopes on abstract class' do
+      Document.filter{ true }.delete
+
+      document_1 = Document.create(visibility: :public)
+      document_2 = Document.create(visibility: :private)
+
+      Document.with_visibility(:public).to_a.must_equal [document_1]
+    end
+
+    it 'validates uniqueness' do
+      user = User.create(status: :active, sex: "male")
+
+      user = UniqStatusUser.new
+      user.sex = "male"
+      user.status = :active
+      user.valid?.must_equal false
+
+      user.errors[:status].wont_be :empty?
+    end
+
+    it "doesn't update record" do
+      Document.filter{ true }.delete
+
+      expected = Time.new(2010, 10, 10)
+
+      document = Document.new
+      document.updated_at = expected
+      document.save
+
+      document = Document.last
+      document.save
+
+      assert_equal expected, document.updated_at
+    end
+
+    it 'changes from dirty should be serialized as scalar values' do
+      user = User.create(:status => :active)
+      user.status = :blocked
+
+      expected = { status: [1, 2] }.to_yaml
+      assert_equal expected, user.column_changes.to_yaml
+    end
+  end
+end