enum_ish 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17516af44e8b97d4f175f6ed2059aab9ca70642a4df8ddf105c6986cbe8da43f
-  data.tar.gz: 91de1ab4345f33e60812fa52aca7441e41f7aa8015024db7d28a1cbd3120e79e
+  metadata.gz: 2536b44ce0b10dedf1ffb032c15d9198a45837b9dc9cacda64ef3e1694810f92
+  data.tar.gz: b51a0ed47f636aebc806cba78f7cc9fadd003b60c09ace3fd29e85a3cf29fb65
 SHA512:
-  metadata.gz: 85d4dcfbcc2fcdb7da3df9c763d772de245949743a1826850fa24d90457b1e480061cd95ad6c42336a4edba5246e02fd6f29d5821415de936c507cb9aedda4cd
-  data.tar.gz: fe398188119a564f482badffb665fbcabe0607975b9936f9c363aa7fbb11c2d765d8758ee70dcce5446f53bfa07f910d08662901f7a6485765fd6129c6a129f3
+  metadata.gz: 2be96b86a6286d62b357c73420fe65d63a990f84dbbebf044eac6adc9ea5a662a5f97aa44b43cfdce02717f4fa8019a98e9bfb180c2447bce19812b13e02b93e
+  data.tar.gz: e1339bf571d9a80658c2b5a108f7722af0b0d6f4e4196e28e7a083dd87b56700faf42ac1d09001b9ff03a52fefdb73302f66f1f9d72a61a15418e33c85f79fce

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,32 @@
 # CHANGELOG
 
+## 1.5.0
+
+* Add dictionary cache feature.
+* Change module inclusion. Use 'include EnumIsh::Base' instead of 'extend EnumIsh'.
+* Move configuration method to `EnumIsh`. Use `EnumIsh.configure` instead of 'EnumIsh::Config.configure'.
+
+## 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.

data/README.md

@@ -26,7 +26,7 @@ Extend your class using EnumIsh and define an enum-like field:
 
 ```ruby
 class User
-  extend EnumIsh
+  include EnumIsh::Base
   attr_accessor :status                    # status is a string field
   enum_ish :status, ['enable', 'disable']  # status has 'enable' or 'disable'
 end
@@ -82,7 +82,7 @@ Set default value:
 
 ```ruby
 class User
-  extend EnumIsh
+  include EnumIsh::Base
   attr_accessor :status
   enum_ish :status, ['enable', 'disable'], default: 'enable'
 end
@@ -95,7 +95,7 @@ Use default value with block:
 
 ```ruby
 class User
-  extend EnumIsh
+  include EnumIsh::Base
   attr_accessor :status, :flag
   enum_ish :status, ['enable', 'disable'], default: -> { flag ? 'enable' : 'disable' }
 end
@@ -110,7 +110,7 @@ Generate predicate methods:
 
 ```ruby
 class User
-  extend EnumIsh
+  include EnumIsh::Base
   attr_accessor :status
   enum_ish :status, ['enable', 'disable'], predicate: true
 end
@@ -121,13 +121,28 @@ user.status_enable?   #=> true
 user.status_disable?  #=> false
 ```
 
+Without prefix:
+
+```ruby
+class User
+  include EnumIsh::Base
+  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:
 
 ```ruby
 class User
-  extend EnumIsh
+  include EnumIsh::Base
   attr_accessor :status
   enum_ish :status, { _enable: 'enable', _disable: 'disable' }, accessor: true
 end
@@ -146,7 +161,7 @@ Generate accessor:
 
 ```ruby
 class User < ActiveRecord::Base
-  extend EnumIsh
+  include EnumIsh::Base
   enum_ish :status, { _enable: 'enable', _disable: 'disable' }, accessor: true
 end
 
@@ -159,11 +174,12 @@ Generate scope:
 
 ```ruby
 class User < ActiveRecord::Base
-  extend EnumIsh
+  include EnumIsh::Base
   enum_ish :status, ['enable', 'disable'], scope: true
 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
@@ -172,7 +188,7 @@ Generate validation:
 
 ```ruby
 class User < ActiveRecord::Base
-  extend EnumIsh
+  include EnumIsh::Base
   enum_ish :status, ['enable', 'disable'], validate: true
 end
 
@@ -181,6 +197,17 @@ user.status = 'INVALID'
 user.valid?  #=> false
 ```
 
+### Dictionary cache
+
+You can enable dictionary cache using rack middleware:
+
+```ruby
+Rails.application.config.middleware.use EnumIsh::DictionaryCache
+```
+
+This middleware enables dictionary cache for each request.
+Prformance of dictionary lookup will be improved in case one dictionary is used repeatedly in the same request.
+
 ## Contributing
 
 Bug reports and pull requests are welcome at https://github.com/kanety/enum_ish.

data/gemfiles/rails61.gemfile

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

data/lib/enum_ish.rb

@@ -1,27 +1,19 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'enum_ish/version'
-require 'enum_ish/errors'
 require 'enum_ish/config'
-require 'enum_ish/enum'
-require 'enum_ish/dictionary'
-require 'enum_ish/definer'
-require 'enum_ish/active_record_definer' if defined?(ActiveRecord::Base)
+require 'enum_ish/base'
+require 'enum_ish/dictionary_cache'
 
 module EnumIsh
-  def enum_ish(name, map, config = {})
-    enum = Enum.new(name, map, config)
-
-    self._enum_ish_enums ||= {}
-    self._enum_ish_enums[name.to_sym] = enum
-
-    if defined?(ActiveRecord::Base) && self.ancestors.include?(ActiveRecord::Base)
-      ActiveRecordDefiner.new(self).define(enum)
-    else
-      Definer.new(self).define(enum)
+  class << self
+    def configure
+      yield Config
     end
-  end
 
-  def self.extended(klass)
-    klass.class_attribute :_enum_ish_enums
+    def config
+      Config
+    end
   end
 end

data/lib/enum_ish/active_record_definer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'active_record_enum_type'
 
 module EnumIsh
@@ -24,7 +26,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 +40,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/active_record_enum_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EnumIsh
   class ActiveRecordEnumType < ActiveRecord::Type::Value
     def initialize(name, mapping, subtype)

data/lib/enum_ish/base.rb

@@ -0,0 +1,29 @@
+require_relative 'enum'
+require_relative 'dictionary'
+require_relative 'errors'
+require_relative 'definer'
+require_relative 'active_record_definer' if defined?(ActiveRecord::Base)
+
+module EnumIsh
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_enum_ish_enums
+      self._enum_ish_enums = {}
+    end
+
+    class_methods do
+      def enum_ish(name, map, config = {})
+        enum = Enum.new(name, map, config)
+        self._enum_ish_enums = _enum_ish_enums.merge(name.to_sym => enum)
+
+        if defined?(ActiveRecord::Base) && self.ancestors.include?(ActiveRecord::Base)
+          ActiveRecordDefiner.new(self).define(enum)
+        else
+          Definer.new(self).define(enum)
+        end
+      end
+    end
+  end
+end

data/lib/enum_ish/config.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module EnumIsh
   class Config
-    @@options = {
+    class_attribute :data
+
+    self.data = {
       text_prefix: '',
       text_suffix: '_text',
       options_prefix: '',
@@ -11,19 +15,13 @@ module EnumIsh
       scope_suffix: ''
     }
 
-    @@options.keys.each do |key|
+    data.keys.each do |key|
       define_singleton_method "#{key}" do
-        @@options[key]
+        data[key]
       end
 
       define_singleton_method "#{key}=" do |val|
-        @@options[key] = val
-      end
-    end
-
-    class << self
-      def configure
-        yield self
+        data[key] = val
       end
     end
   end

data/lib/enum_ish/definer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EnumIsh
   class Definer
     def initialize(klass)
@@ -32,13 +34,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
@@ -75,8 +87,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

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 module EnumIsh
   class Dictionary
+    CACHE_KEY = :_enum_ish_dictionary_cache
+
     def initialize(klass, enum, options = {})
       @klass = klass
-      @dict = load(enum, options)
+      @enum = enum
+      @options = options
+      @dict = cache { Lookup.new(@klass, @enum, @options).call }
     end
 
     def translate_value(value)
@@ -11,7 +17,7 @@ module EnumIsh
       else
         @dict[value] || value
       end
-   end
+    end
 
     def translate_options
       @dict.to_a.map { |value, label| [label, value] }
@@ -19,44 +25,72 @@ module EnumIsh
 
     private
 
-    def load(enum, options)
-      dict = translate_dict(enum, options)
-      filter(dict, options)
+    def cache
+      if (cache = Thread.current[CACHE_KEY]) != nil
+        cache[I18n.locale] ||= {}
+        cache[I18n.locale][@klass] ||= {}
+        cache[I18n.locale][@klass][@enum] ||= {}
+        cache[I18n.locale][@klass][@enum][@optons] ||= yield
+      else
+        yield
+      end
     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]
-      translated
+    class << self
+      def cache
+        Thread.current[CACHE_KEY] = {}
+        yield
+      ensure
+        Thread.current[CACHE_KEY] = nil
+      end
     end
+  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
+  class Lookup
+    def initialize(klass, enum, options = {})
+      @klass = klass
+      @enum = enum
+      @options = options
     end
 
-    def i18n_key(enum, options)
-      [enum.name, options[:format]].compact.join('/')
+    def call
+      i18n = lookup_for(@klass).transform_keys { |k| k.to_s.to_sym }
+
+      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
+
+      filter(dict)
     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])
+    private
+
+    def lookup_for(klass)
+      key = [@enum.name, @options[:format]].compact.join('/')
+      options = (@options[:i18n_options] || {}).merge(default: nil)
+
+      if klass.name.to_s.in?(['ActiveRecord::Base', 'Object'])
+        I18n.t(:"enum_ish.defaults.#{key}", **options) || @enum.mapping.invert
+      elsif klass.name.blank? || !klass.is_a?(Class)
+        resolve(klass.superclass)
+      else
+        I18n.t(:"enum_ish.#{klass.name.underscore}.#{key}", **options) || lookup_for(klass.superclass)
+      end
     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/dictionary_cache.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EnumIsh
+  class DictionaryCache
+    def initialize(app)
+      @app = app
+    end
+  
+    def call(env)
+      EnumIsh::Dictionary.cache do
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/enum_ish/enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EnumIsh
   class Enum
     attr_accessor :name

data/lib/enum_ish/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EnumIsh
   class Error < StandardError
   end

data/lib/enum_ish/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EnumIsh
-  VERSION = '1.3.1'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_ish
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-23 00:00:00.000000000 Z
+date: 2021-07-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,12 +114,15 @@ 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
+- lib/enum_ish/base.rb
 - lib/enum_ish/config.rb
 - lib/enum_ish/definer.rb
 - lib/enum_ish/dictionary.rb
+- lib/enum_ish/dictionary_cache.rb
 - lib/enum_ish/enum.rb
 - lib/enum_ish/errors.rb
 - lib/enum_ish/version.rb

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