enum_ish 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b366f9ef0d71e73ff92c214008d0459135a03cc5aa6b32d944c1bdc5c5042d8e
-  data.tar.gz: a428a5f900c77c1caf3c6c9344cbc30e4cee6f10e99868d5b1b18d481bc5ed5c
+  metadata.gz: 34d21d01c11cb32143d1ce656228165fc93059f820b60f2cc109668a61e70680
+  data.tar.gz: a26baa4da8d0ae6e5ad1dce8cdf169f24fbe79ec8ddc88acf5fb2180db817b6f
 SHA512:
-  metadata.gz: d0cfa988dc99c79277ae238f9235743655ec7b51e1ca6e8a3df22951b91e2091193926ca76c5e449663dc2ed64734652303dec847ee377709fba1f9f013a3efc
-  data.tar.gz: 48b90411d86d74ef8a4c62d0676deb93d0a784376acbb5127fdfd08b9778d46cef8d8c38b85ae754e609ae496f817568d16289f759069934f8e7188a502d9663
+  metadata.gz: cc05a7517f723a1df0f521e031d2c171ed6a3ad0614974326c52464ce5ecf7f89b5e591f0da34a15fac70212ab44ab883f64b7dff45b67ba865c153c2ebd3dd9
+  data.tar.gz: 8cb363ef8d2f7988dee963d3baef608b076484afa46268f1d08a7b21fe5ef12c736d09cb05ba3e6efaa01ce8b6acbf85f0748aef6d39a407338b499aa94f22c4

data/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
+        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61']
+        exclude:
+          - ruby: 2.3
+            gemfile: rails60
+          - ruby: 2.3
+            gemfile: rails61
+          - ruby: 2.4
+            gemfile: rails60
+          - ruby: 2.4
+            gemfile: rails61
+          - ruby: 3.0
+            gemfile: rails50
+          - ruby: 3.0
+            gemfile: rails51
+          - ruby: 3.0
+            gemfile: rails52
+
+    name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Prepare test
+      run: |
+        cd spec/dummy
+        BUNDLE_GEMFILE=../../${{ env.BUNDLE_GEMFILE }} RAILS_ENV=test bundle exec rake db:create db:migrate db:seed
+        cd ../..
+    - name: Run test
+      run: |
+        bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # CHANGELOG
 
+## 1.4.1
+
+* Avoid overwrite of superclass's `_enum_ish_enums`.
+* Filter ancestors for dictionary lookup.
+
+## 1.4.0
+
+* Generate `not` scope for activerecord class.
+* Add prefix option to define short predicate method.
+* Search translation including ancestor classes.
+* Support multiple arguments for scope.
+* Fix predicate and validation bugs for field with `accessor: true`.
+
+## 1.3.3
+
+* Support rails 6.1.
+
+## 1.3.2
+
+* Fix deprecation warning for ruby 2.7.
+
+## 1.3.1
+
+* Fix default value for model included ActiveModel.
+
 ## 1.3.0
 
 * Support array field.

data/README.md

@@ -121,6 +121,21 @@ user.status_enable?   #=> true
 user.status_disable?  #=> false
 ```
 
+Without prefix:
+
+```ruby
+class User
+  extend EnumIsh
+  attr_accessor :status
+  enum_ish :status, ['enable', 'disable'], predicate: { prefix: false }
+end
+
+user = User.new
+user.status = 'enable'
+user.enable?   #=> true
+user.disable?  #=> false
+```
+
 ### Accessor
 
 Generate getter and setter for aliased symbols instead of raw values:
@@ -164,6 +179,7 @@ class User < ActiveRecord::Base
 end
 
 User.with_status(:enable)  #=> SELECT "users".* FROM "users" WHERE "users"."status" = "enable"
+User.with_status_not(:enable)  #=> SELECT "users".* FROM "users" WHERE "users"."status" != 'enable'
 ```
 
 #### Validation

data/gemfiles/rails61.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/enum_ish.rb

@@ -22,6 +22,15 @@ module EnumIsh
   end
 
   def self.extended(klass)
+    super
     klass.class_attribute :_enum_ish_enums
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def inherited(subclass)
+      super
+      subclass._enum_ish_enums = self._enum_ish_enums.dup
+    end
   end
 end

data/lib/enum_ish/active_record_definer.rb

@@ -24,7 +24,13 @@ module EnumIsh
           enum.mapping.fetch(value, value)
         end
 
-        decorate_attribute_type(enum.name, :enum) do |subtype|
+        args =
+          if ActiveRecord.version > Gem::Version.new('6.1.0.a')
+            [enum.name]
+          else
+            [enum.name, :enum]
+          end
+        decorate_attribute_type(*args) do |subtype|
           EnumIsh::ActiveRecordEnumType.new(enum.name, enum.mapping, subtype)
         end
       end
@@ -32,9 +38,12 @@ module EnumIsh
 
     def define_scope(enum)
       @klass.class_eval do
-        scope "#{Config.scope_prefix}#{enum.name}#{Config.scope_suffix}", ->(value) {
+        scope "#{Config.scope_prefix}#{enum.name}#{Config.scope_suffix}", ->(*value) {
           where(enum.name => enum.mapping.fetch(value, value))
         }
+        scope "#{Config.scope_prefix}#{enum.name}_not#{Config.scope_suffix}", ->(*value) {
+          where.not(enum.name => enum.mapping.fetch(value, value))
+        }
       end
     end
   end

data/lib/enum_ish/definer.rb

@@ -32,13 +32,23 @@ module EnumIsh
 
     def define_predicate(enum)
       enum.mapping.each do |enum_key, enum_value|
+        method_name = if enum.setting[:predicate].is_a?(Hash) && enum.setting[:predicate][:prefix] == false
+          "#{enum_key}?"
+        else
+          "#{enum.name}_#{enum_key}?"
+        end
+        target_value = if enum.setting[:accessor]
+          enum_key
+        else
+          enum_value
+        end
         @klass.class_eval do
-          define_method "#{enum.name}_#{enum_key}?".tr('.', '_') do
+          define_method method_name.tr('.', '_') do
             value = public_send(enum.name)
             if value.is_a?(Array)
-              value == [enum_value]
+              value == [target_value]
             else
-              value == enum_value
+              value == target_value
             end
           end
         end
@@ -49,15 +59,15 @@ module EnumIsh
       mod = Module.new
       mod.module_eval do
         define_method :initialize do |*args|
+          super(*args)
           if respond_to?(enum.name) && public_send(enum.name).nil?
             default = enum.setting[:default]
             default = instance_exec(&default) if default.kind_of?(Proc)
             public_send("#{enum.name}=", default)
           end
-          super(*args)
         end
       end
-      @klass.prepend mod
+      @klass.send(:include, mod)
     end
 
     def define_accessor(enum)
@@ -75,8 +85,13 @@ module EnumIsh
     end
 
     def define_validate(enum)
+      targets = if enum.setting[:accessor]
+        enum.mapping.keys
+      else
+        enum.mapping.values
+      end
       @klass.class_eval do
-        validates enum.name, inclusion: { in: enum.mapping.values }, allow_nil: true
+        validates enum.name, inclusion: { in: targets }, allow_nil: true
       end
     end
 

data/lib/enum_ish/dictionary.rb

@@ -2,7 +2,9 @@ module EnumIsh
   class Dictionary
     def initialize(klass, enum, options = {})
       @klass = klass
-      @dict = load(enum, options)
+      @enum = enum
+      @options = options
+      @dict = load_dict
     end
 
     def translate_value(value)
@@ -11,7 +13,7 @@ module EnumIsh
       else
         @dict[value] || value
       end
-   end
+    end
 
     def translate_options
       @dict.to_a.map { |value, label| [label, value] }
@@ -19,44 +21,52 @@ module EnumIsh
 
     private
 
-    def load(enum, options)
-      dict = translate_dict(enum, options)
-      filter(dict, options)
-    end
+    def load_dict
+      i18n = load_from_i18n.transform_keys { |k| k.to_s.to_sym }
 
-    def translate_dict(enum, options)
-      dict = load_dict(enum, options)
-      translated = enum.mapping.map { |k, v| dict[k] ? [k, dict[k]] : [k, v.to_s] }.to_h
-      translated = translated.map { |k, v| [enum.mapping[k], v] }.to_h unless enum.setting[:accessor]
-      translated
-    end
+      dict = {}
+      if @enum.setting[:accessor]
+        @enum.mapping.each { |k, v| dict[k] = i18n[k].to_s }
+      else
+        @enum.mapping.each { |k, v| dict[v] = i18n[k].to_s }
+      end
 
-    def load_dict(enum, options)
-      key = i18n_key(enum, options)
-      dict = I18n.t("enum_ish.#{@klass.name.underscore}.#{key}", i18n_options(enum, options))
-      dict.map { |k, v| [k.to_s.to_sym, v.to_s] }.to_h
+      filter(dict)
     end
 
-    def i18n_key(enum, options)
-      [enum.name, options[:format]].compact.join('/')
+    def load_from_i18n
+      key = [@enum.name, @options[:format]].compact.join('/')
+      options = (@options[:i18n_options] || {}).merge(default: nil)
+      dict = I18n.t(:"enum_ish.#{@klass.name.underscore}.#{key}", **options)
+      return dict if dict
+
+      i18n_ancestors.each do |ancestor|
+        dict = I18n.t(:"enum_ish.#{ancestor.name.underscore}.#{key}", **options)
+        return dict if dict
+      end
+
+      dict = I18n.t(:"enum_ish.defaults.#{key}", **options)
+      return dict if dict
+
+      @enum.mapping.invert
     end
 
-    def i18n_options(enum, options)
-      key = i18n_key(enum, options)
-      opts = options[:i18n_options] || {}
-      opts.merge(default: [:"enum_ish.defaults.#{key}", enum.mapping.invert])
+    def i18n_ancestors
+      @klass.ancestors.drop(1)
+            .take_while { |a| a.name != 'ActiveRecord::Base' && a.name != 'Object' }
+            .select { |a| a.is_a?(Class) && !a.name.empty? }
     end
 
-    def filter(translated, options)
-      if options[:except]
-        except = Array(options[:except])
-        translated.reject! { |k, v| except.include?(k) }
+    def filter(dict)
+      if @options[:except]
+        except = Array(@options[:except])
+        dict.reject! { |k, v| except.include?(k) }
       end
-      if options[:only]
-        only = Array(options[:only])
-        translated.select! { |k, v| only.include?(k) }
+      if @options[:only]
+        only = Array(@options[:only])
+        dict.select! { |k, v| only.include?(k) }
       end
-      translated
+      dict
     end
   end
 end

data/lib/enum_ish/version.rb

@@ -1,3 +1,3 @@
 module EnumIsh
-  VERSION = '1.3.0'
+  VERSION = '1.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_ish
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,9 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -114,6 +114,7 @@ files:
 - gemfiles/rails51.gemfile
 - gemfiles/rails52.gemfile
 - gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
 - lib/enum_ish.rb
 - lib/enum_ish/active_record_definer.rb
 - lib/enum_ish/active_record_enum_type.rb
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A ruby and rails extension to generate enum-like methods

data/.travis.yml

@@ -1,23 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-gemfile:
-  - gemfiles/rails50.gemfile
-  - gemfiles/rails51.gemfile
-  - gemfiles/rails52.gemfile
-  - gemfiles/rails60.gemfile
-matrix:
-  exclude:
-  - rvm: 2.3
-    gemfile: gemfiles/rails60.gemfile
-  - rvm: 2.4
-    gemfile: gemfiles/rails60.gemfile
-before_script:
-  - cd spec/dummy
-  - bundle exec rake db:create db:migrate db:seed RAILS_ENV=test
-  - cd ../..
-script:
-  - bundle exec rspec