enum_ish 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34d21d01c11cb32143d1ce656228165fc93059f820b60f2cc109668a61e70680
-  data.tar.gz: a26baa4da8d0ae6e5ad1dce8cdf169f24fbe79ec8ddc88acf5fb2180db817b6f
+  metadata.gz: 2536b44ce0b10dedf1ffb032c15d9198a45837b9dc9cacda64ef3e1694810f92
+  data.tar.gz: b51a0ed47f636aebc806cba78f7cc9fadd003b60c09ace3fd29e85a3cf29fb65
 SHA512:
-  metadata.gz: cc05a7517f723a1df0f521e031d2c171ed6a3ad0614974326c52464ce5ecf7f89b5e591f0da34a15fac70212ab44ab883f64b7dff45b67ba865c153c2ebd3dd9
-  data.tar.gz: 8cb363ef8d2f7988dee963d3baef608b076484afa46268f1d08a7b21fe5ef12c736d09cb05ba3e6efaa01ce8b6acbf85f0748aef6d39a407338b499aa94f22c4
+  metadata.gz: 2be96b86a6286d62b357c73420fe65d63a990f84dbbebf044eac6adc9ea5a662a5f97aa44b43cfdce02717f4fa8019a98e9bfb180c2447bce19812b13e02b93e
+  data.tar.gz: e1339bf571d9a80658c2b5a108f7722af0b0d6f4e4196e28e7a083dd87b56700faf42ac1d09001b9ff03a52fefdb73302f66f1f9d72a61a15418e33c85f79fce

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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`.

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
@@ -125,7 +125,7 @@ Without prefix:
 
 ```ruby
 class User
-  extend EnumIsh
+  include EnumIsh::Base
   attr_accessor :status
   enum_ish :status, ['enable', 'disable'], predicate: { prefix: false }
 end
@@ -142,7 +142,7 @@ 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
@@ -161,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
 
@@ -174,7 +174,7 @@ Generate scope:
 
 ```ruby
 class User < ActiveRecord::Base
-  extend EnumIsh
+  include EnumIsh::Base
   enum_ish :status, ['enable', 'disable'], scope: true
 end
 
@@ -188,7 +188,7 @@ Generate validation:
 
 ```ruby
 class User < ActiveRecord::Base
-  extend EnumIsh
+  include EnumIsh::Base
   enum_ish :status, ['enable', 'disable'], validate: true
 end
 
@@ -197,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/lib/enum_ish.rb

@@ -1,36 +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)
-    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
+    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

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)

data/lib/enum_ish/dictionary.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module EnumIsh
   class Dictionary
+    CACHE_KEY = :_enum_ish_dictionary_cache
+
     def initialize(klass, enum, options = {})
       @klass = klass
       @enum = enum
       @options = options
-      @dict = load_dict
+      @dict = cache { Lookup.new(@klass, @enum, @options).call }
     end
 
     def translate_value(value)
@@ -21,8 +25,36 @@ module EnumIsh
 
     private
 
-    def load_dict
-      i18n = load_from_i18n.transform_keys { |k| k.to_s.to_sym }
+    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
+
+    class << self
+      def cache
+        Thread.current[CACHE_KEY] = {}
+        yield
+      ensure
+        Thread.current[CACHE_KEY] = nil
+      end
+    end
+  end
+
+  class Lookup
+    def initialize(klass, enum, options = {})
+      @klass = klass
+      @enum = enum
+      @options = options
+    end
+
+    def call
+      i18n = lookup_for(@klass).transform_keys { |k| k.to_s.to_sym }
 
       dict = {}
       if @enum.setting[:accessor]
@@ -34,27 +66,19 @@ module EnumIsh
       filter(dict)
     end
 
-    def load_from_i18n
+    private
+
+    def lookup_for(klass)
       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
+      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
-
-      dict = I18n.t(:"enum_ish.defaults.#{key}", **options)
-      return dict if dict
-
-      @enum.mapping.invert
-    end
-
-    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(dict)

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.4.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.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,9 +118,11 @@ files:
 - 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