enumerize 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07d568d0eb005ebea8b0ded7cb260d6c7792b1d676bd46f8441c7e33445e366c
-  data.tar.gz: b811acb983e8fac641fb2b9f9340089e8fd6149b1431af7f12446cb5203c39e1
+  metadata.gz: a2c0c71e8e7b38b6ec3eb0e0f53429a21465bd1dcea61ea87761a497fa9f55ab
+  data.tar.gz: b2803acb5138d2a471ddf84cbcc8b5b3fde56507e8f6db7135ea7ea6f50f5f98
 SHA512:
-  metadata.gz: b68609dbbc3eede78b640395ef59bf149f1bf00d7b55f2b03a1397430f4e8816bd6a19bdfe06151e28fb1a64a9595fe48893810b015899b00d4991af6539f5d7
-  data.tar.gz: 3999ab755693815c52779ca0124f6aec629a1dd639c41d33330211b0948f6f9d4aa3d79a3f20713bb99a508afa5b7e2b776a0465fe0c3c5a3c250043bbdfc0aa
+  metadata.gz: 3cb1506ba0eed847bf0e8f09df719ad06f88034b3f58988046bad0f36ecbcabf8e43f8b31f2e38160f15cf0d7886667fbc36a59b91b73f85a6b09efd6d925877
+  data.tar.gz: 4e927b95541a1cd89584d65c7abc5bd1ab7b0fdcda8abaa7e9c53c7b0b4c0e928c5a2055e0c160ffd0e1b295f276d534909f0411c0c6ea35342ee10f2dca9380

data/.github/workflows/ruby.yml

@@ -33,6 +33,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby-version: ['2.7', '3.0', '3.1']
+        test: ['minitest', 'rspec']
         gemfile:
           - Gemfile
           - Gemfile.rails60
@@ -58,6 +59,7 @@ jobs:
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
       DB: "${{ matrix.db }}"
+      TEST_FRAMEWORK: "${{ matrix.test }}"
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 2.7.0 (July 7, 2023)
+
+### bug fix
+
+* Warn about already defined predicate methods only when we generate predicate methods with `predicate: true` (by [@nashby](https://github.com/nashby))
+* Define `Type#cast` instead of deserialize to fix serialization issue. (by [@nashby](https://github.com/nashby))
+* Fix `Undefined method 'enumerize' for RSpec::ExampleGroups` (by [@softwaregravy](https://github.com/softwaregravy))
+  
+### enchancements
+
+* Add support for procs as `i18n_scope` option value. (by [@nashby](https://github.com/nashby))
+
+  ```ruby
+  enumerize :color, in: %w[green blue], i18n_scope: proc { |value| "color" }
+  ```
+
 ## 2.6.1 (March 17, 2023)
 
 ### bug fix

data/Gemfile.global

@@ -3,7 +3,10 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'rspec', :require => false
+
+if ENV['TEST_FRAMEWORK'] == 'rspec'
+  gem 'rspec', :require => false
+end
 
 gem 'pg', '~> 1.2.3', :platform => [:ruby, :mswin, :mingw]
 gem 'sequel'

data/README.md

@@ -161,6 +161,7 @@ class Person
 
   enumerize :status, in: %w[student employed retired], i18n_scope: "status"
   enumerize :roles, in: %w[user admin], i18n_scope: ["user.roles", "roles"]
+  enumerize :color, in: %w[green blue], i18n_scope: proc { |value| "color" }
 end
 
 # localization file

data/Rakefile

@@ -4,7 +4,6 @@
 require "bundler/gem_tasks"
 
 require 'rake/testtask'
-require 'rspec/core/rake_task'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -12,6 +11,11 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-RSpec::Core::RakeTask.new
+if ENV['TEST_FRAMEWORK'] == 'rspec'
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
 
-task :default => [:test, :spec]
+  task :default => [:spec]
+else
+  task :default => [:test]
+end

data/lib/enumerize/activerecord.rb

@@ -115,11 +115,11 @@ module Enumerize
 
       alias type_cast_for_database serialize
 
-      def deserialize(value)
+      def cast(value)
         @attr.find_value(value)
       end
 
-      alias type_cast_from_database deserialize
+      alias type_cast_from_database cast
 
       def as_json(options = nil)
         {attr: @attr.name}.as_json(options)

data/lib/enumerize/attribute.rb

@@ -12,11 +12,7 @@ module Enumerize
 
       @klass  = klass
       @name   = name.to_sym
-
-      if options[:i18n_scope]
-        raise ArgumentError, ':i18n_scope option accepts only String or Array of strings' unless Array(options[:i18n_scope]).all? { |s| s.is_a?(String) }
-        @i18n_scope = options[:i18n_scope]
-      end
+      @i18n_scope = options[:i18n_scope]
 
       value_class = options.fetch(:value_class, Value)
       @values = Array(options[:in]).map { |v| value_class.new(self, *v).freeze }

data/lib/enumerize/predicates.rb

@@ -69,8 +69,22 @@ module Enumerize
       end
 
       def build(klass)
+        warn_on_already_defined_methods
+
         klass.delegate(*names, to: @attr.name, prefix: @options[:prefix], allow_nil: true)
       end
+
+      def warn_on_already_defined_methods
+        names.each do |name|
+          method_name = [@options[:prefix], name].compact.join('_')
+
+          if @attr.klass.respond_to?(method_name)
+            warn(
+              "Predicate method `#{name}` is already defined as #{@attr.klass.name}##{name}. Use enumerize's :prefix option to avoid it"
+            )
+          end
+        end
+      end
     end
   end
 end

data/lib/enumerize/value.rb

@@ -10,16 +10,16 @@ module Enumerize
     attr_reader :value
 
     def initialize(attr, name, value=nil)
-      if self.class.method_defined?("#{name}?")
-        warn("It's not recommended to use `#{name}` as a field value since `#{name}?` is defined. (#{attr.klass.name}##{attr.name})")
-      end
-
       @attr  = attr
       @value = value.nil? ? name.to_s : value
 
       super(name.to_s)
 
-      @i18n_keys = @attr.i18n_scopes.map { |s| :"#{s}.#{self}" }
+      @i18n_keys = @attr.i18n_scopes.map do |s|
+        scope = Utils.call_if_callable(s, @value)
+
+        :"#{scope}.#{self}"
+      end
       @i18n_keys << :"enumerize.defaults.#{@attr.name}.#{self}"
       @i18n_keys << :"enumerize.#{@attr.name}.#{self}"
       @i18n_keys << ActiveSupport::Inflector.humanize(ActiveSupport::Inflector.underscore(self)) # humanize value if there are no translations

data/lib/enumerize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Enumerize
-  VERSION = '2.6.1'
+  VERSION = '2.7.0'
 end

data/lib/enumerize.rb

@@ -82,7 +82,7 @@ module Enumerize
   end
 
   begin
-    require 'rspec'
+    require 'rspec/matchers'
   rescue LoadError
   else
     require 'enumerize/integrations/rspec'

data/test/activerecord_test.rb

@@ -249,6 +249,15 @@ class ActiveRecordTest < MiniTest::Spec
     expect(user.interests).must_equal %w[music dancing]
   end
 
+  it 'has enumerized values in active record attributes after reload' do
+    User.delete_all
+    user = User.new
+    user.status = :blocked
+    user.save!
+    user.reload
+    expect(user.attributes["status"]).must_equal 'blocked'
+  end
+
   it 'validates inclusion when using write_attribute with string attribute' do
     user = User.new
     user.send(:write_attribute, 'role', 'wrong')

data/test/attribute_test.rb

@@ -37,10 +37,6 @@ class AttributeTest < MiniTest::Spec
       build_attr nil, 'foo', :in => %w[a b], :i18n_scope => %w[bar buzz]
       expect(attr.i18n_scopes).must_equal %w[bar buzz]
     end
-
-    it 'accepts only string scopes' do
-      expect(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

data/test/predicates_test.rb

@@ -6,6 +6,8 @@ class PredicatesTest < MiniTest::Spec
   let(:kklass) do
     Class.new do
       extend Enumerize
+
+      def self.c?; end
     end
   end
 
@@ -62,4 +64,22 @@ class PredicatesTest < MiniTest::Spec
     expect(object).wont_respond_to :a?
     expect(object).must_respond_to :b?
   end
+
+  it 'warns if predicate method is already defined' do
+    assert_output(nil, /`c\?` is already defined/) do
+      kklass.enumerize(:bar, in: %w(a b c), predicates: true)
+    end
+  end
+
+  it 'does not warn if predicate has prefix and does not collide with defined method' do
+    assert_output(nil, '') do
+      kklass.enumerize(:bar, in: %w(a b c), predicates: { prefix: 'bar' })
+    end
+  end
+
+  it 'does not warn if predicate method is already defined but enumerize does not generate predicates' do
+    assert_output(nil, '') do
+      kklass.enumerize(:bar, in: %w(a b c))
+    end
+  end
 end

data/test/value_test.rb

@@ -8,6 +8,9 @@ class ValueTest < MiniTest::Spec
   end
 
   class Attr < Struct.new(:values, :name, :i18n_scopes, :klass)
+    def value?(value)
+      values.include?(value)
+    end
   end
 
   let(:attr) { Attr.new([], "attribute_name", [], Model) }
@@ -84,6 +87,14 @@ class ValueTest < MiniTest::Spec
         expect(val.text).must_be :==, "Scope specific translation"
       end
     end
+
+    it 'allows to pass a proc as i18n_scopes param' do
+      attr.i18n_scopes = [proc { |v| "other.scope.#{v}" }]
+
+      store_translations(:en, :other => {:scope => {:"1" => {:test_value => "Scope specific translation"}}}) do
+        expect(val.text).must_be :==, "Scope specific translation"
+      end
+    end
   end
 
   describe 'boolean methods comparison' do
@@ -150,9 +161,5 @@ class ValueTest < MiniTest::Spec
     it 'no output if undefined boolean method' do
       assert_silent() { Enumerize::Value.new(attr, 'test_value') }
     end
-
-    it 'error output if defined boolean method' do
-      assert_output(nil, /`empty\?` is defined/) { Enumerize::Value.new(attr, 'empty') }
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumerize
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Sergey Nartimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport