mobility 1.2.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5cedc8fabef42f478f93a4bb4fa1e8764759855dcded4d25f397c018f1811d2
-  data.tar.gz: 1fb647fdbcbafa3b8a5a6d47d71500e2481556aa72674c5269ea0dc560d63ca0
+  metadata.gz: d0dd974f8a077b31fc0ab41df158e4cac50c6aee4e7fd66348db1ed2ef5f78f9
+  data.tar.gz: ea72521a4bb8daedf08d3012353c591ec47f76e3fe6ec3c10b87e331a5404db9
 SHA512:
-  metadata.gz: ee138cb5544fc8942dc8a6dbf7fcfd54bf3829329075950755b8fea3ba676c430b880b14366dcfc09b66651b06577957e02130c5b4f2a62d7db96d02f1a150c8
-  data.tar.gz: 980502d8c285bedf8e2958a24cb77c129ee39f1cfb946c44bbd83f7cc89b30009a829bfb17b515aac9e02d3f3a810b1433cab416aabec67c1daab9c6f100683d
+  metadata.gz: 15b9df45774c9b3d4ae343b2f083b2a85ddfd7585283998b0dc624aa62eee5c6e5fade0737ae78b3dd728dd273a03dcf10afecabcca6eb8f90400619de0a7fa4
+  data.tar.gz: 1f199821139bf35b4e176f52dac0249f482ffb5edc9d7957d437e9262a908812fab01ba5dea52e18a9b1f37f92744b345c34ca0c84d97da0641f9fab19577704

data/CHANGELOG.md

@@ -1,22 +1,38 @@
 # Mobility Changelog
 
-## Unreleased
-- Assign blank values in pg hash backends
-  ([#516](https://github.com/shioyama/mobility/pull/516))
+## 1.2
 
-## 1.1
+### 1.2.4
+- Fix fallbacks performance regression
+  ([#548](https://github.com/shioyama/mobility/pull/548))
 
-## 1.2
+### 1.2.3
+- Fix passing wrong options to super in fallbacks plugin
+  ([#539](https://github.com/shioyama/mobility/pull/539))
+
+### 1.2.2
+- Make models work with `Marshal.dump`
+  ([#532](https://github.com/shioyama/mobility/pull/532))
+- Fix Sequel container op in Sequel
+  ([#533](https://github.com/shioyama/mobility/pull/533))
+- Simplify Fallbacks plugin
+  ([#531](https://github.com/shioyama/mobility/pull/531))
+
+### 1.2.1
+- Refactor ColumnFallback plugin
+  ([#530](https://github.com/shioyama/mobility/pull/530))
 
 ### 1.2.0
 - Add ColumnFallback plugin
-	([#512](https://github.com/shioyama/mobility/pull/512))
+  ([#512](https://github.com/shioyama/mobility/pull/512))
 - Fix Sequel querying on untranslated attributes in `i18n` block
-	([#529](https://github.com/shioyama/mobility/pull/529))
+  ([#529](https://github.com/shioyama/mobility/pull/529))
 - Allow passing configured backend class as third argument to setup
-	([#528](https://github.com/shioyama/mobility/pull/528))
+  ([#528](https://github.com/shioyama/mobility/pull/528))
 - Clearly distinguish backend classes from their configured subclasses
-	([#527](Clearly distinguish backend classes from their configured subclasses))
+  ([#527](https://github.com/shioyama/mobility/pull/527))
+
+## 1.1
 
 ### 1.1.3
 - Do not swallow keyword args on ruby 3 in fallthrough accessors

data/Gemfile.lock

@@ -1,28 +1,44 @@
+GIT
+  remote: https://github.com/rails/rails.git
+  revision: 5647a9c1ced68d20338552d47a3b755e10a271c4
+  branch: main
+  specs:
+    activemodel (7.0.0.alpha2)
+      activesupport (= 7.0.0.alpha2)
+    activerecord (7.0.0.alpha2)
+      activemodel (= 7.0.0.alpha2)
+      activesupport (= 7.0.0.alpha2)
+    activesupport (7.0.0.alpha2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+
 PATH
   remote: .
   specs:
-    mobility (1.2.0.alpha)
+    mobility (1.3.0.alpha)
       i18n (>= 0.6.10, < 2)
       request_store (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    benchmark-ips (2.8.4)
+    benchmark-ips (2.9.1)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     database_cleaner (1.99.0)
     diff-lcs (1.4.4)
-    ffi (1.15.0)
-    formatador (0.2.5)
-    guard (2.16.2)
+    ffi (1.15.4)
+    formatador (0.3.0)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -32,11 +48,12 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    listen (3.5.1)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
+    minitest (5.14.4)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -50,7 +67,7 @@ GEM
       pry (~> 0.13.0)
     rack (2.2.3)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     request_store (1.5.0)
@@ -68,15 +85,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    sequel (5.48.0)
     shellany (0.0.1)
     thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     yard (0.9.26)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord!
+  activesupport!
   benchmark-ips
   database_cleaner (~> 1.5, >= 1.5.3)
   guard-rspec
@@ -85,7 +105,6 @@ DEPENDENCIES
   pry-byebug
   rake (~> 12, >= 12.2.1)
   rspec (~> 3.0)
-  sequel (~> 5.0)
   yard (~> 0.9.0)
 
 BUNDLED WITH

data/README.md

@@ -55,7 +55,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 1.2.0'
+gem 'mobility', '~> 1.2.4'
 ```
 
 ### ActiveRecord (Rails)

data/lib/mobility/backend.rb

@@ -77,6 +77,12 @@ On top of this, a backend will normally:
       @attribute = args[1]
     end
 
+    def ==(backend)
+      backend.class == self.class &&
+        backend.attribute == attribute &&
+        backend.model == model
+    end
+
     # @!macro [new] backend_reader
     #   Gets the translated value for provided locale from configured backend.
     #   @param [Symbol] locale Locale to read

data/lib/mobility/backends/sequel/container.rb

@@ -100,7 +100,7 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
       # @return [Mobility::Backends::Sequel::Container::JSONOp,Mobility::Backends::Sequel::Container::JSONBOp]
       def self.build_op(attr, locale)
         klass = const_get("#{options[:column_type].upcase}Op")
-        klass.new(klass.new(column_name.to_sym)[locale.to_s]).get_text(attr)
+        klass.new(klass.new(column_name.to_sym).get(locale.to_s)).get_text(attr)
       end
 
       class JSONOp < ::Sequel::Postgres::JSONOp; end

data/lib/mobility/plugins/active_record/column_fallback.rb

@@ -14,120 +14,47 @@ Plugin to use an original column for a given locale, and otherwise use the backe
         requires :column_fallback, include: false
 
         included_hook do |_, backend_class|
-          case (column_fallback = options[:column_fallback])
+          backend_class.include BackendInstanceMethods
+          backend_class.extend BackendClassMethods
+        end
+
+        def self.use_column_fallback?(options, locale)
+          case column_fallback = options[:column_fallback]
           when TrueClass
-            backend_class.include I18nDefaultLocaleBackend
-          when Array, Proc
-            backend_class.include BackendModule.new(column_fallback)
+            locale == I18n.default_locale
+          when Array
+            column_fallback.include?(locale)
+          when Proc
+            column_fallback.call(locale)
           else
-            raise ArgumentError, "column_fallback value must be a boolean, an array of locales or a proc"
+            false
           end
         end
 
-        module I18nDefaultLocaleBackend
+        module BackendInstanceMethods
           def read(locale, **)
-            locale == I18n.default_locale ? model.read_attribute(attribute) : super
+            if ColumnFallback.use_column_fallback?(options, locale)
+              model.read_attribute(attribute)
+            else
+              super
+            end
           end
 
           def write(locale, value, **)
-            locale == I18n.default_locale ? model.send(:write_attribute, attribute, value) : super
-          end
-
-          def self.included(base)
-            base.extend(ClassMethods)
-          end
-
-          module ClassMethods
-            def build_node(attr, locale)
-              if locale == I18n.default_locale
-                model_class.arel_table[attr]
-              else
-                super
-              end
+            if ColumnFallback.use_column_fallback?(options, locale)
+              model.send(:write_attribute, attribute, value)
+            else
+              super
             end
           end
         end
 
-        class BackendModule < Module
-          def initialize(column_fallback)
-            case (@column_fallback = column_fallback)
-            when Array
-              define_array_accessors
-            when Proc
-              define_proc_accessors
-            end
-          end
-
-          def included(base)
-            base.extend(ClassMethods.new(@column_fallback))
-          end
-
-          private
-
-          def define_array_accessors
-            column_fallback = @column_fallback
-
-            module_eval <<-EOM, __FILE__, __LINE__ + 1
-            def read(locale, **)
-              if #{column_fallback}.include?(locale)
-                model.read_attribute(attribute)
-              else
-                super
-              end
-            end
-
-            def write(locale, value, **)
-              if #{column_fallback}.include?(locale)
-                model.send(:write_attribute, attribute, value)
-              else
-                super
-              end
-            end
-            EOM
-          end
-
-          def define_proc_accessors
-            column_fallback = @column_fallback
-
-            define_method :read do |locale, **options|
-              if column_fallback.call(locale)
-                model.read_attribute(attribute)
-              else
-                super(locale, **options)
-              end
-            end
-
-            define_method :write do |locale, value, **options|
-              if column_fallback.call(locale)
-                model.send(:write_attribute, attribute, value)
-              else
-                super(locale, value, **options)
-              end
-            end
-          end
-
-          class ClassMethods < Module
-            def initialize(column_fallback)
-              case column_fallback
-              when Array
-                module_eval <<-EOM, __FILE__, __LINE__ + 1
-                def build_node(attr, locale)
-                  if #{column_fallback}.include?(locale)
-                    model_class.arel_table[attr]
-                  else
-                    super
-                  end
-                end
-                EOM
-              when Proc
-                define_method(:build_node) do |attr, locale|
-                  if column_fallback.call(locale)
-                    model_class.arel_table[attr]
-                  else
-                    super(attr, locale)
-                  end
-                end
-              end
+        module BackendClassMethods
+          def build_node(attr, locale)
+            if ColumnFallback.use_column_fallback?(options, locale)
+              model_class.arel_table[attr]
+            else
+              super
             end
           end
         end

data/lib/mobility/plugins/backend.rb

@@ -114,15 +114,33 @@ Defines:
         defaults[key] = [backend, backend_options] if backend
       end
 
+      class MobilityBackends < Hash
+        def initialize(model)
+          @model = model
+          super()
+        end
+
+        def [](name)
+          return fetch(name) if has_key?(name)
+          return self[name.to_sym] if String === name
+          self[name] = @model.class.mobility_backend_class(name).new(@model, name.to_s)
+        end
+
+        def marshal_dump
+          @model
+        end
+
+        def marshal_load(model)
+          @model = model
+        end
+      end
+
       module InstanceMethods
         # Return a new backend for an attribute name.
         # @return [Hash] Hash of attribute names and backend instances
         # @api private
         def mobility_backends
-          @mobility_backends ||= ::Hash.new do |hash, name|
-            next hash[name.to_sym] if String === name
-            hash[name] = self.class.mobility_backend_class(name).new(self, name.to_s)
-          end
+          @mobility_backends ||= MobilityBackends.new(self)
         end
 
         def initialize_dup(other)

data/lib/mobility/plugins/fallbacks.rb

@@ -117,8 +117,21 @@ the current locale was +nil+.
       # Applies fallbacks plugin to attributes. Completely disables fallbacks
       # on model if option is +false+.
       included_hook do |_, backend_class|
-        fallbacks = options[:fallbacks]
-        backend_class.include(BackendReader.new(fallbacks, method(:generate_fallbacks))) unless fallbacks == false
+        unless options[:fallbacks] == false
+          backend_class.include(BackendInstanceMethods)
+
+          fallbacks =
+            if options[:fallbacks].is_a?(Hash)
+              generate_fallbacks(options[:fallbacks])
+            elsif options[:fallbacks] == true
+              generate_fallbacks({})
+            else
+              ::Hash.new { [] }
+            end
+
+          backend_class.singleton_class.attr_reader :fallbacks
+          backend_class.instance_variable_set(:@fallbacks, fallbacks)
+        end
       end
 
       private
@@ -134,36 +147,17 @@ the current locale was +nil+.
         end
       end
 
-      class BackendReader < Module
-        def initialize(fallbacks_option, fallbacks_generator)
-          @fallbacks_generator = fallbacks_generator
-          define_read(convert_option_to_fallbacks(fallbacks_option))
-        end
-
-        private
+      module BackendInstanceMethods
+        def read(locale, fallback: true, **kwargs)
+          return super(locale, **kwargs) if !fallback || kwargs[:locale]
 
-        def define_read(fallbacks)
-          define_method :read do |locale, fallback: true, **options|
-            return super(locale, **options) if !fallback || options[:locale]
-
-            locales = fallback == true ? fallbacks[locale] : [locale, *fallback]
-            locales.each do |fallback_locale|
-              value = super(fallback_locale, **options)
-              return value if Util.present?(value)
-            end
-
-            super(locale, **options)
+          locales = fallback == true ? self.class.fallbacks[locale] : [locale, *fallback]
+          locales.each do |fallback_locale|
+            value = super(fallback_locale, **kwargs)
+            return value if Util.present?(value)
           end
-        end
 
-        def convert_option_to_fallbacks(option)
-          if option.is_a?(::Hash)
-            @fallbacks_generator[option]
-          elsif option == true
-            @fallbacks_generator[{}]
-          else
-            ::Hash.new { [] }
-          end
+          super(locale, **kwargs)
         end
       end
     end

data/lib/mobility/plugins/sequel/column_fallback.rb

@@ -14,114 +14,47 @@ Plugin to use an original column for a given locale, and otherwise use the backe
         requires :column_fallback, include: false
 
         included_hook do |_, backend_class|
-          case (column_fallback = options[:column_fallback])
+          backend_class.include BackendInstanceMethods
+          backend_class.extend BackendClassMethods
+        end
+
+        def self.use_column_fallback?(options, locale)
+          case column_fallback = options[:column_fallback]
           when TrueClass
-            backend_class.include I18nDefaultLocaleBackend
-          when Array, Proc
-            backend_class.include BackendModule.new(column_fallback)
+            locale == I18n.default_locale
+          when Array
+            column_fallback.include?(locale)
+          when Proc
+            column_fallback.call(locale)
+          else
+            false
           end
         end
 
-        module I18nDefaultLocaleBackend
+        module BackendInstanceMethods
           def read(locale, **)
-            locale == I18n.default_locale ? model[attribute.to_sym] : super
+            if ColumnFallback.use_column_fallback?(options, locale)
+              model[attribute.to_sym]
+            else
+              super
+            end
           end
 
           def write(locale, value, **)
-            if locale == I18n.default_locale
+            if ColumnFallback.use_column_fallback?(options, locale)
               model[attribute.to_sym] = value
             else
               super
             end
           end
-
-          def self.included(base)
-            base.extend(ClassMethods)
-          end
-
-          module ClassMethods
-            def build_op(attr, locale)
-              if locale == I18n.default_locale
-                ::Sequel::SQL::QualifiedIdentifier.new(model_class.table_name, attr.to_sym)
-              else
-                super
-              end
-            end
-          end
         end
 
-        class BackendModule < Module
-          def initialize(column_fallback)
-            case (@column_fallback = column_fallback)
-            when Array
-              define_array_accessors
-            when Proc
-              define_proc_accessors
-            end
-          end
-
-          def included(base)
-            base.extend(ClassMethods.new(@column_fallback))
-          end
-
-          private
-
-          def define_array_accessors
-            column_fallback = @column_fallback
-
-            module_eval <<-EOM, __FILE__, __LINE__ + 1
-            def read(locale, **)
-              #{column_fallback}.include?(locale) ? model[attribute.to_sym] : super
-            end
-
-            def write(locale, value, **)
-              if #{column_fallback}.include?(locale)
-                model[attribute.to_sym] = value
-              else
-                super
-              end
-            end
-            EOM
-          end
-
-          def define_proc_accessors
-            column_fallback = @column_fallback
-
-            define_method :read do |locale, **options|
-              column_fallback.call(locale) ? model[attribute.to_sym] : super(locale, **options)
-            end
-
-            define_method :write do |locale, value, **options|
-              if column_fallback.call(locale)
-                model[attribute.to_sym] = value
-              else
-                super(locale, value, **options)
-              end
-            end
-          end
-
-          class ClassMethods < Module
-            def initialize(column_fallback)
-              case column_fallback
-              when Array
-                module_eval <<-EOM, __FILE__, __LINE__ + 1
-                def build_op(attr, locale)
-                  if #{column_fallback}.include?(locale)
-                    ::Sequel::SQL::QualifiedIdentifier.new(model_class.table_name, attr.to_sym)
-                  else
-                    super
-                  end
-                end
-                EOM
-              when Proc
-                define_method(:build_op) do |attr, locale|
-                  if column_fallback.call(locale)
-                    ::Sequel::SQL::QualifiedIdentifier.new(model_class.table_name, attr.to_sym)
-                  else
-                    super(attr, locale)
-                  end
-                end
-              end
+        module BackendClassMethods
+          def build_op(attr, locale)
+            if ColumnFallback.use_column_fallback?(options, locale)
+              ::Sequel::SQL::QualifiedIdentifier.new(model_class.table_name, attr.to_sym)
+            else
+              super
             end
           end
         end

data/lib/mobility/version.rb

@@ -8,7 +8,7 @@ module Mobility
   module VERSION
     MAJOR = 1
     MINOR = 2
-    TINY = 0
+    TINY = 4
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.4
 platform: ruby
 authors:
 - Chris Salzberg
@@ -34,7 +34,7 @@ cert_chain:
   eBMcZq0d1tbtv1M1UXND9mOfhLZ31YvoSTPkrJiRpljUNgD0+ugelnr1/5X/9k8y
   J9QOd3C5jpSShf/HMvpJnFuSYFm19cH9GrHjvw==
   -----END CERTIFICATE-----
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2021-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store