enumerize 0.3.0 → 2.3.1

data/test/attribute_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe Enumerize::Attribute do
@@ -14,15 +16,64 @@ 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
   end
 
-  it 'returns options for select' do
-    store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
-      build_attr nil, :foo, :in => %w[a b]
-      attr.options.must_equal [['a text', 'a'], ['b text', 'b']]
+  it 'uses custom value class' do
+    value_class = Class.new(Enumerize::Value)
+    build_attr nil, 'foo', :in => %w[a b], :value_class => value_class
+    attr.values.first.must_be_instance_of value_class
+  end
+
+  describe 'i18n scopes' do
+    it 'returns scopes from options' do
+      build_attr nil, 'foo', :in => %w[a b], :i18n_scope => %w[bar buzz]
+      attr.i18n_scopes.must_equal %w[bar buzz]
+    end
+
+    it 'accepts only string scopes' do
+      proc { build_attr nil, 'foo', :in => %w[a b], :i18n_scope => [%w[bar buzz], "bar.buzz"] }.must_raise ArgumentError
+    end
+  end
+
+  describe 'options for select' do
+    it 'returns all options for select' do
+      store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+        build_attr nil, :foo, :in => %w[a b]
+        attr.options.must_equal [['a text', 'a'], ['b text', 'b']]
+      end
+    end
+
+    it 'returns requested options for select via :only' do
+      store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+        build_attr nil, :foo, :in => %w[a b]
+        attr.options(:only => :a).must_equal [['a text', 'a']]
+        attr.options(:only => [:b]).must_equal [['b text', 'b']]
+        attr.options(:only => []).must_equal []
+      end
+    end
+
+    it 'returns requested options for select via :except' do
+      store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+        build_attr nil, :foo, :in => %w[a b]
+        attr.options(:except => :a).must_equal [['b text', 'b']]
+        attr.options(:except => :b).must_equal [['a text', 'a']]
+        attr.options(:except => []).must_equal [['a text', 'a'], ['b text', 'b']]
+      end
+    end
+
+    it 'does not work with both :only and :except' do
+      store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+        build_attr nil, :foo, :in => %w[a b]
+        proc { attr.options(:except => [], :only => []) }.must_raise ArgumentError
+      end
     end
   end
 
@@ -40,4 +91,51 @@ describe Enumerize::Attribute do
       attr.find_value(2).must_equal 'b'
     end
   end
+
+  it 'sets up shortcut methods for each value' do
+    build_attr nil, :foo, :in => {:a => 1, :b => 2}
+
+    attr.must_respond_to :a
+    attr.must_respond_to :b
+
+    attr.a.value.must_equal 1
+    attr.b.value.must_equal 2
+    attr.a.text.must_equal 'A'
+    attr.b.text.must_equal 'B'
+  end
+
+  describe 'values hash with zero' do
+    before do
+      build_attr nil, :foo, :in => {:a => 1, :b => 2, :c => 0}
+    end
+
+    it 'returns hash keys as values' do
+      attr.values.must_equal %w[a b c]
+    end
+
+    it 'finds values by hash values' do
+      attr.find_value(1).must_equal 'a'
+      attr.find_value(2).must_equal 'b'
+      attr.find_value(0).must_equal 'c'
+    end
+
+    it 'finds all values by hash values' do
+      attr.find_values(1, 2, 0).must_equal ['a', 'b', 'c']
+    end
+  end
+
+  describe 'boolean values hash' do
+    before do
+      build_attr nil, :foo, :in => {:a => true, :b => false}
+    end
+
+    it 'returns hash keys as values' do
+      attr.values.must_equal %w[a b]
+    end
+
+    it 'finds values by hash values' do
+      attr.find_value(true).must_equal 'a'
+      attr.find_value(false).must_equal 'b'
+    end
+  end
 end

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
-      include Enumerize
+      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])
-    object.foo.must_equal nil
+    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])
-      object.foo_text.must_equal nil
+      kklass.enumerize(:foo, :in => [:a, :b])
+      object.foo_text.must_be_nil
     end
   end
 
-  it 'scopes translation by i18 key' do
-    def klass.model_name
-      name = "ExampleClass"
+  it 'scopes translation by i18n key' do
+    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,80 +63,90 @@ 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
+    kklass.enumerize(:foo, :in => [:a, :b], :default => lambda { :b })
+    object.foo.must_equal 'b'
+  end
+
+  it 'injects object instance into lamda default value' do
+    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_equal 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_equal 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_equal nil
+    object.read_attribute_for_validation(:foo).must_be_nil
   end
 
   it 'calls super in the accessor method' do
@@ -154,22 +166,22 @@ describe Enumerize::Base do
 
     klass = Class.new do
       include accessors
-      include Enumerize
+      extend Enumerize
 
       enumerize :foo, :in => %w[test]
     end
 
     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'
     object.attributes.must_equal(:foo => 'test')
   end
 
-  it 'returns stores hash values' do
-    klass.enumerize(:foo, :in => {:a => 1, :b => 2})
+  it 'stores hash values' do
+    kklass.enumerize(:foo, :in => {:a => 1, :b => 2})
 
     object.foo = :a
     object.instance_variable_get(:@foo).must_equal 1
@@ -179,4 +191,14 @@ describe Enumerize::Base do
     object.instance_variable_get(:@foo).must_equal 2
     object.foo.must_equal 'b'
   end
+
+  it 'returns custom value' do
+    kklass.enumerize(:foo, :in => {:a => 1, :b => 2})
+
+    object.foo = :a
+    object.foo_value.must_equal 1
+
+    object.foo = :b
+    object.foo_value.must_equal 2
+  end
 end

data/test/formtastic_test.rb

@@ -1,31 +1,28 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
-if defined? Formtastic::Helpers::InputHelper
-  module Formtastic
-    module Helpers
-      module InputHelper
-        remove_method :input_class
-        def input_class(as)
-          input_class_with_const_defined(as)
-        end
-      end
-    end
-  end
-end
+Formtastic::FormBuilder.action_class_finder = Formtastic::ActionClassFinder
+Formtastic::FormBuilder.input_class_finder  = Formtastic::InputClassFinder
 
 class FormtasticSpec < MiniTest::Spec
   include ViewTestHelper
-  if defined? Formtastic::SemanticFormHelper
-    include Formtastic::SemanticFormHelper
-  else
-    include Formtastic::Helpers::FormHelper
+  include Formtastic::Helpers::FormHelper
+
+  class Thing < Struct.new(:name)
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+
+    def persisted?
+      false
+    end
   end
 
   class User < Struct.new(:sex, :age)
     extend ActiveModel::Naming
     include ActiveModel::Conversion
 
-    include Enumerize
+    extend Enumerize
 
     enumerize :sex, :in => [:male, :female]
 
@@ -34,10 +31,30 @@ class FormtasticSpec < MiniTest::Spec
     end
   end
 
+  class Post < Struct.new(:category, :title)
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+
+    extend Enumerize
+
+    enumerize :categories, :in => [:music, :games], :multiple => true
+
+    def persisted?
+      false
+    end
+  end
+
+  class Registration < Struct.new(:sex)
+    extend Enumerize
+
+    enumerize :sex, in: [:male, :female]
+  end
+
   before { $VERBOSE = nil }
   after  { $VERBOSE = true }
 
   let(:user) { User.new }
+  let(:post) { Post.new }
 
   it 'renders select with enumerized values' do
     concat(semantic_form_for(user) do |f|
@@ -48,6 +65,49 @@ class FormtasticSpec < MiniTest::Spec
     assert_select 'select option[value=female]'
   end
 
+  it 'renders multiple select with enumerized values' do
+    concat(semantic_form_for(post) do |f|
+      f.input(:categories)
+    end)
+
+    assert_select 'select[multiple=multiple]'
+    assert_select 'select option[value=music]'
+    assert_select 'select option[value=games]'
+  end
+
+  it 'renders multiple select with selected enumerized value' do
+    post.categories << :music
+
+    concat(semantic_form_for(post) do |f|
+      f.input(:categories)
+    end)
+
+    assert_select 'select[multiple=multiple]'
+    assert_select 'select option[value=music][selected=selected]'
+    assert_select 'select option[value=games][selected=selected]', count: 0
+  end
+
+  it 'renders checkboxes with enumerized values' do
+    concat(semantic_form_for(post) do |f|
+      f.input(:categories, as: :check_boxes)
+    end)
+
+    assert_select 'select[multiple=multiple]', count: 0
+    assert_select 'input[type=checkbox][value=music]'
+    assert_select 'input[type=checkbox][value=games]'
+  end
+
+  it 'renders checkboxes with selected enumerized value' do
+    post.categories << :music
+
+    concat(semantic_form_for(post) do |f|
+      f.input(:categories, as: :check_boxes)
+    end)
+
+    assert_select 'input[type=checkbox][value=music][checked=checked]'
+    assert_select 'input[type=checkbox][value=games][checked=checked]', count: 0
+  end
+
   it 'renders radio buttons with enumerized values' do
     concat(semantic_form_for(user) do |f|
       f.input :sex, :as => :radio
@@ -64,4 +124,29 @@ class FormtasticSpec < MiniTest::Spec
 
     assert_select 'input[type=text]'
   end
+
+  it 'does not affect not enumerized classes' do
+    concat(semantic_form_for(Thing.new) do |f|
+      f.input(:name)
+    end)
+
+    assert_select 'input[type=text]'
+  end
+
+  it 'renders select with enumerized values for non-ActiveModel object' do
+    concat(semantic_form_for(Registration.new, as: 'registration', url: '/') do |f|
+      f.input(:sex)
+    end)
+
+    assert_select 'select option[value=male]'
+    assert_select 'select option[value=female]'
+  end
+
+  it 'does not affect forms without object' do
+    concat(semantic_form_for('') do |f|
+      f.input(:name)
+    end)
+
+    assert_select 'input[type=text]'
+  end
 end

data/test/module_attributes_test.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class ModuleAttributesSpec < MiniTest::Spec
   it 'inherits attribute from the module' do
     mod = Module.new do
-      include Enumerize
+      extend Enumerize
       enumerize :sex, :in => %w[male female], :default => 'male'
     end
 
@@ -16,7 +18,7 @@ class ModuleAttributesSpec < MiniTest::Spec
 
   it 'uses new attributes from the module' do
     mod = Module.new do
-      include Enumerize
+      extend Enumerize
     end
 
     klass = Class.new
@@ -26,4 +28,25 @@ class ModuleAttributesSpec < MiniTest::Spec
     klass.new.sex.must_equal 'male'
     klass.sex.must_be_instance_of Enumerize::Attribute
   end
+
+  it 'validates attributes' do
+    mod = Module.new do
+      extend Enumerize
+      enumerize :sex, :in => %w[male female]
+    end
+
+    klass = Class.new do
+      include ActiveModel::Validations
+      include mod
+
+      def self.model_name
+        ActiveModel::Name.new(self, nil, 'name')
+      end
+    end
+
+    object = klass.new
+    object.sex = 'wrong'
+    object.wont_be :valid?
+    object.errors[:sex].must_include 'is not included in the list'
+  end
 end

data/test/mongo_mapper_test.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+begin
+
+silence_warnings do
+  require 'mongo_mapper'
+end
+
+MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+MongoMapper.database   = 'enumerize-test-suite-of-mongomapper'
+
+describe Enumerize do
+  class MongoMapperUser
+    include MongoMapper::Document
+    extend Enumerize
+
+    key :sex
+    key :role
+    key :foo
+
+    enumerize :sex,  :in => %w[male female]
+    enumerize :role, :in => %w[admin user], :default => 'user'
+    enumerize :foo,  :in => %w[bar baz], :skip_validations => true
+  end
+
+  before { $VERBOSE = nil }
+  after  { $VERBOSE = true }
+
+  let(:model) { MongoMapperUser }
+
+  it 'sets nil if invalid value is passed' do
+    user = model.new
+    user.sex = :invalid
+    user.sex.must_be_nil
+  end
+
+  it 'saves value' do
+    model.delete_all
+    user = model.new
+    user.sex = :female
+    user.save!
+    user.sex.must_equal 'female'
+  end
+
+  it 'loads value' do
+    model.delete_all
+    model.create!(:sex => :male)
+    store_translations(:en, :enumerize => {:sex => {:male => 'Male'}}) do
+      user = model.first
+      user.sex.must_equal 'male'
+      user.sex_text.must_equal 'Male'
+    end
+  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 'does not validate inclusion when :skip_validations option passed' do
+    user = model.new
+    user.foo = 'wrong'
+    user.must_be :valid?
+  end
+
+  it 'assigns value on loaded record' do
+    model.delete_all
+    model.create!(:sex => :male)
+    user = model.first
+    user.sex = :female
+    user.sex.must_equal 'female'
+  end
+end
+
+rescue LoadError
+  # Skip
+end