enum_ish 1.2.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58df4091edebc5965ce060bd1342f7088f4749aaa18977c76655b44fa823245d
-  data.tar.gz: 3e97c949be6dc3a88bc03aa20fd5317e681cc68681857581bc9d24abc0fcb38c
+  metadata.gz: 53a6b89fe82d91b0ae54a440f3ba3a4908af751b3b22064f3ddd085257f975d9
+  data.tar.gz: 033b3df71e3286482f86ad0cce38084cc7c745cf13c5c06ad3cec146c3a577ac
 SHA512:
-  metadata.gz: 2a08c825b4b4e77c904f77cf5088026d34dd66439c9553a47cce1abecc4dd7d52cc9514c3b48f9fab81d7bef4263bd0eb5e3cea34afdbbc446513e672a5f0276
-  data.tar.gz: 62bd16fd0c155a7ca5144be68fb12d3b413996ce1a316caf70ede933842ce757d315054f47641d6a9de5b2dd1b1cc4744745c735a845c9cece3550d465e53622
+  metadata.gz: f55c27359c26b39c6500357594e318da8027198b45073bfd772d9ae9047f295d53e2c23ffabf54118cb308c399b8dce546e4db0a23e6564534a7a28c9f18bdfc
+  data.tar.gz: ca8144b132543120f9fb810398df2252ad8e1051c76e32242fef1d6029ab9a458b988902271c779580c6673fe1f6ac2cada24dd4b8ce7edf499669991721d21a

data/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-16.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,29 @@
 # CHANGELOG
 
+## 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.
+
 ## 1.2.3
 
 * Keep enum definitions as a hash internally.

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/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

@@ -15,27 +15,41 @@ module EnumIsh
     def define_text(enum)
       @klass.class_eval do
         define_method "#{Config.text_prefix}#{enum.name}#{Config.text_suffix}" do |options = {}|
-          value = public_send(enum.name)
-          dic = Dictionary.new(self.class).load(enum, options)
-          dic[value] || value
+          dict = Dictionary.new(self.class, enum, options)
+          dict.translate_value(public_send(enum.name))
         end
-      end        
+      end
     end
 
     def define_options(enum)
       @klass.class_eval do
         define_singleton_method "#{Config.options_prefix}#{enum.name}#{Config.options_suffix}" do |options = {}|
-          dic = Dictionary.new(self).load(enum, options)
-          dic.to_a.map { |value, label| [label, value] }
+          dict = Dictionary.new(self, enum, options)
+          dict.translate_options
         end
       end
     end
 
     def define_predicate(enum)
-      enum.mapping.each do |key, value|
+      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}_#{key}?".tr('.', '_') do
-            public_send(enum.name) == value
+          define_method method_name.tr('.', '_') do
+            value = public_send(enum.name)
+            if value.is_a?(Array)
+              value == [target_value]
+            else
+              value == target_value
+            end
           end
         end
       end
@@ -45,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)
@@ -62,17 +76,22 @@ module EnumIsh
           instance_variable_get("@#{enum.name}")
         end
         define_method "#{enum.name}" do
-          enum.mapping.invert[instance_variable_get("@#{enum.name}")]
+          enum.to_sym(instance_variable_get("@#{enum.name}"))
         end
         define_method "#{enum.name}=" do |value|
-          instance_variable_set("@#{enum.name}", enum.mapping.fetch(value, value))
+          instance_variable_set("@#{enum.name}", enum.to_raw(value))
         end
       end
     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

@@ -1,17 +1,30 @@
 module EnumIsh
   class Dictionary
-    def initialize(klass)
+    def initialize(klass, enum, options = {})
       @klass = klass
+      @dict = load(enum, options)
     end
 
-    def load(enum, options = {})
-      translated = translate(enum, options)
-      filter(translated, options)
+    def translate_value(value)
+      if value.is_a?(Array)
+        value.map { |v| @dict[v] || v }
+      else
+        @dict[value] || value
+      end
+   end
+
+    def translate_options
+      @dict.to_a.map { |value, label| [label, value] }
     end
 
     private
 
-    def translate(enum, options)
+    def load(enum, options)
+      dict = translate_dict(enum, options)
+      filter(dict, options)
+    end
+
+    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]
@@ -20,7 +33,7 @@ module EnumIsh
 
     def load_dict(enum, options)
       key = i18n_key(enum, options)
-      dict = I18n.t("enum_ish.#{@klass.name.underscore}.#{key}", i18n_options(enum, options))
+      dict = I18n.t("enum_ish.#{@klass.name.to_s.underscore}.#{key}", **i18n_options(enum, options))
       dict.map { |k, v| [k.to_s.to_sym, v.to_s] }.to_h
     end
 
@@ -31,7 +44,12 @@ module EnumIsh
     def i18n_options(enum, options)
       key = i18n_key(enum, options)
       opts = options[:i18n_options] || {}
-      opts.merge(default: [:"enum_ish.defaults.#{key}", enum.mapping.invert])
+      opts.merge(default: i18n_ancestors(key) + [:"enum_ish.defaults.#{key}", enum.mapping.invert])
+    end
+
+    def i18n_ancestors(key)
+      ancestors = @klass.ancestors.drop(1).select { |a| a.is_a?(Class) && !a.name.empty? }
+      ancestors.map { |a| :"enum_ish.#{a.name.underscore}.#{key}" }
     end
 
     def filter(translated, options)

data/lib/enum_ish/enum.rb

@@ -10,6 +10,23 @@ module EnumIsh
       @setting = init_setting(setting)
     end
 
+    def to_raw(value)
+      if value.is_a?(Array)
+        value.map { |v| @mapping.fetch(v, v) }
+      else
+        @mapping.fetch(value, value)
+      end
+    end
+
+    def to_sym(value)
+      inverted = @mapping.invert
+      if value.is_a?(Array)
+        value.map { |v| inverted[v] }
+      else
+        inverted[value]
+      end
+    end
+
     private
 
     def init_mapping(mapping)

data/lib/enum_ish/version.rb

@@ -1,3 +1,3 @@
 module EnumIsh
-  VERSION = '1.2.3'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_ish
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-05 00:00:00.000000000 Z
+date: 2021-05-05 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.2.3
 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