mobility 0.8.13 → 1.0.0

data/lib/mobility/plugins.rb

@@ -2,35 +2,38 @@ module Mobility
 =begin
 
 Plugins allow modular customization of backends independent of the backend
-itself. They are enabled through the {Configuration.plugins} configuration
-setting, which takes an array of symbols corresponding to plugin names. The
-order of these names is important since it determines the order in which
-plugins will be applied.
+itself. They are enabled through {Mobility::Translations.plugins} (delegated to
+from {Mobility.configure}), which takes a block within which plugins can be
+declared in any order (dependencies will be resolved).
 
-So if our {Configuration.plugins} is an array +[:foo]+, and we call
-`translates` on our model, +Post+, like this:
+=end
+  module Plugins
+    @plugins = {}
+    @names = {}
 
-  class Post
-    translates :title, foo: true
-  end
+    class << self
+      # @param [Symbol] name Name of plugin to load.
+      def load_plugin(name)
+        return name if Module === name || name.nil?
 
-Then the +Foo+ plugin will be applied with the option value +true+. Applying a
-module calls a class method, +apply+ (in this case +Foo.apply+), which takes
-two arguments:
+        unless (plugin = @plugins[name])
+          require "mobility/plugins/#{name}"
+          raise LoadError, "plugin #{name} did not register itself correctly in Mobility::Plugins" unless (plugin = @plugins[name])
+        end
+        plugin
+      end
 
-- an instance of the {Attributes} class, +attributes+, from which the backend
-  can configure the backend class (+attributes.backend_class+) and the model
-  (+attributes.model_class+), and the +attributes+ module itself (which
-  will be included into the backend).
-- the value of the +option+ passed into the model with +translates+ (in this
-  case, +true+).
+      # @param [Module] plugin Plugin module to lookup. Plugin must already be loaded.
+      def lookup_name(plugin)
+        @names.fetch(plugin)
+      end
 
-Typically, the plugin will include a module into either
-+attributes.backend_class+ or +attributes+ itself, configured according to the
-option value. For examples, see classes under the {Mobility::Plugins} namespace.
+      def register_plugin(name, plugin)
+        @plugins[name] = plugin
+        @names[plugin] = name
+      end
 
-=end
-  module Plugins
-    OPTION_UNSET = Object.new
+      class LoadError < Error; end
+    end
   end
 end

data/lib/mobility/plugins/active_model.rb

@@ -1,6 +1,23 @@
+require_relative "./active_model/dirty"
+require_relative "./active_model/cache"
+
 module Mobility
   module Plugins
+=begin
+
+Plugin for ActiveModel models. In practice, this is simply a wrapper to include
+a few plugins which apply to models which include ActiveModel::Dirty but are
+not ActiveRecord models.
+
+=end
     module ActiveModel
+      extend Plugin
+
+      requires :active_model_dirty
+      requires :active_model_cache
+      requires :backend, include: :before
     end
+
+    register_plugin(:active_model, ActiveModel)
   end
 end

data/lib/mobility/plugins/active_model/cache.rb

@@ -0,0 +1,26 @@
+# frozen-string-literal: true
+
+module Mobility
+  module Plugins
+    module ActiveModel
+=begin
+
+Adds hooks to clear Mobility cache when AM dirty reset methods are called.
+
+=end
+      module Cache
+        extend Plugin
+
+        requires :cache, include: false
+
+        included_hook do |klass, _|
+          if options[:cache]
+            define_cache_hooks(klass, :changes_applied, :clear_changes_information)
+          end
+        end
+      end
+    end
+
+    register_plugin(:active_model_cache, ActiveModel::Cache)
+  end
+end

data/lib/mobility/plugins/active_model/dirty.rb

@@ -42,106 +42,138 @@ the ActiveRecord dirty plugin for more information.
 
 =end
       module Dirty
-        # Builds module which adds suffix/prefix methods for translated
-        # attributes so they act like normal dirty-tracked attributes.
-        class MethodsBuilder < Module
-          delegate :dirty_class, :handler_methods_module, :method_patterns, to: :class
+        extend Plugin
 
-          def initialize(*attribute_names)
-            define_dirty_methods(attribute_names)
+        requires :dirty, include: false
+
+        initialize_hook do
+          if options[:dirty]
+            define_dirty_methods(names)
+            include dirty_handler_methods
           end
+        end
 
-          def included(model_class)
-            model_class.include InstanceMethods
-            model_class.include handler_methods_module
+        included_hook do |klass, backend_class|
+          raise TypeError, "#{name} should include ActiveModel::Dirty to use the active_model plugin" unless active_model_dirty_class?(klass)
 
-            # In earlier versions of Rails, these methods are private
-            %i[clear_attribute_changes clear_changes_information changes_applied].each do |method_name|
-              if dirty_class.private_instance_methods.include?(method_name)
-                model_class.class_eval { private method_name }
-              end
-            end
-          end
+          if options[:dirty]
+            private_methods = InstanceMethods.instance_methods & klass.private_instance_methods
+            klass.include InstanceMethods
+            klass.class_eval { private(*private_methods) }
 
-          def append_locale(attr_name)
-            Mobility.normalize_locale_accessor(attr_name)
+            backend_class.include BackendMethods
           end
+        end
 
-          private
+        private
 
-          def define_dirty_methods(attribute_names)
-            m = self
+        # Overridden in AR::Dirty plugin to define a different HandlerMethods module
+        def dirty_handler_methods
+          HandlerMethods
+        end
 
-            attribute_names.each do |name|
-              method_patterns.each do |pattern|
-                define_method(pattern % name) do |*args|
-                  mutations_from_mobility.send(pattern % 'attribute', m.append_locale(name), *args)
-                end
-              end
+        def active_model_dirty_class?(klass)
+          klass.ancestors.include?(::ActiveModel::Dirty)
+        end
 
-              define_method "restore_#{name}!" do
-                locale_accessor = m.append_locale(name)
-                if mutations_from_mobility.attribute_changed?(locale_accessor)
-                  __send__("#{name}=", mutations_from_mobility.attribute_was(locale_accessor))
-                  mutations_from_mobility.restore_attribute!(locale_accessor)
+        def define_dirty_methods(attribute_names)
+          attribute_names.each do |name|
+            dirty_handler_methods.each_pattern(name) do |method_name, attribute_method|
+              define_method(method_name) do |*args|
+                # for %s_changed?(from:, to:) pattern
+                if (kwargs = args.last).is_a?(Hash)
+                  mutations_from_mobility.send(attribute_method, Dirty.append_locale(name), *args[0,-1], **kwargs)
+                else
+                  mutations_from_mobility.send(attribute_method, Dirty.append_locale(name), *args)
                 end
               end
             end
 
-            # This private method override is necessary to make
-            # +restore_attributes+ (which is public) work with translated
-            # attributes.
-            define_method :restore_attribute! do |attr|
-              attribute_names.include?(attr.to_s) ? send("restore_#{attr}!") : super(attr)
-            end
-            private :restore_attribute!
-          end
-
-          class << self
-            def handler_methods_module
-              @handler_methods_module ||= (AttributeHandlerMethods.new.tap do |mod|
-                public_method_patterns.each do |pattern|
-                  method_name = pattern % 'attribute'
-
-                  mod.module_eval <<-EOM, __FILE__, __LINE__ + 1
-                  def #{method_name}(attr_name, *rest)
-                    if (mutations_from_mobility.attribute_changed?(attr_name) ||
-                        mutations_from_mobility.attribute_previously_changed?(attr_name))
-                      mutations_from_mobility.send(#{method_name.inspect}, attr_name, *rest)
-                    else
-                      super
-                    end
-                  end
-                  EOM
-                end
-              end)
+            define_method "restore_#{name}!" do
+              locale_accessor = Dirty.append_locale(name)
+              if mutations_from_mobility.attribute_changed?(locale_accessor)
+                __send__("#{name}=", mutations_from_mobility.attribute_was(locale_accessor))
+                mutations_from_mobility.restore_attribute!(locale_accessor)
+              end
             end
+          end
+
+          # This private method override is necessary to make
+          # +restore_attributes+ (which is public) work with translated
+          # attributes.
+          define_method :restore_attribute! do |attr|
+            attribute_names.include?(attr.to_s) ? send("restore_#{attr}!") : super(attr)
+          end
+          private :restore_attribute!
+        end
 
-            # Get method suffixes. Creating an object just to get the list of
-            # suffixes is simplest given they change from Rails version to version.
-            def method_patterns
-              @method_patterns ||=
-                (dirty_class.attribute_method_matchers.map { |p| "#{p.prefix}%s#{p.suffix}" } - excluded_method_patterns)
+        def self.append_locale(attr_name)
+          Mobility.normalize_locale_accessor(attr_name)
+        end
+
+        # Module builder which mimics dirty method handlers on a given dirty class.
+        # Used to mimic ActiveModel::Dirty and ActiveRecord::Dirty, which have
+        # similar but slightly different sets of handler methods. Doing it this
+        # way with introspection allows us to support basically all AR/AM
+        # versions without changes here.
+        class HandlerMethodsBuilder < Module
+          attr_reader :klass
+
+          # @param [Class] klass Dirty class to mimic
+          def initialize(klass)
+            @klass = klass
+            define_handler_methods
+          end
+
+          def each_pattern(attr_name)
+            patterns.each do |pattern|
+              yield pattern % attr_name, pattern % 'attribute'
             end
+          end
+
+          def define_handler_methods
+            public_patterns.each do |pattern|
+              method_name = pattern % 'attribute'
 
-            def public_method_patterns
-              @public_method_patterns ||= method_patterns.select do |p|
-                !dirty_class.private_instance_methods.include?(:"#{p % 'attribute'}")
+              kwargs = pattern == '%s_changed?' ? ', **kwargs' : ''
+              module_eval <<-EOM, __FILE__, __LINE__ + 1
+              def #{method_name}(attr_name, *rest#{kwargs})
+                if (mutations_from_mobility.attribute_changed?(attr_name) ||
+                    mutations_from_mobility.attribute_previously_changed?(attr_name))
+                  mutations_from_mobility.send(#{method_name.inspect}, attr_name, *rest#{kwargs})
+                else
+                  super
+                end
               end
+              EOM
             end
+          end
 
-            def dirty_class
-              @dirty_class ||= Class.new { include ::ActiveModel::Dirty }
-            end
+          # Get method suffixes. Creating an object just to get the list of
+          # suffixes is simplest given they change from Rails version to version.
+          def patterns
+            @patterns ||=
+              (klass.attribute_method_matchers.map { |p| "#{p.prefix}%s#{p.suffix}" } - excluded_patterns)
+          end
 
-            private
+          private
 
-            def excluded_method_patterns
-              ['%s', 'restore_%s!']
+          def public_patterns
+            @public_patterns ||= patterns.select do |p|
+              klass.public_method_defined?(p % 'attribute')
             end
           end
+
+          def excluded_patterns
+            ['%s', 'restore_%s!']
+          end
         end
 
+        # Module which defines generic handler methods like
+        # +attribute_changed?+ that are patched to work with translated
+        # attributes.
+        HandlerMethods = HandlerMethodsBuilder.new(Class.new { include ::ActiveModel::Dirty })
+
         module InstanceMethods
           def changed_attributes
             super.merge(mutations_from_mobility.changed_attributes)
@@ -186,9 +218,16 @@ the ActiveRecord dirty plugin for more information.
           end
         end
 
-        # Give the module builder a name so it's easier to see in the model's ancestors
-        class AttributeHandlerMethods < Module; end
-
+        # @note Seriously, I really don't want to reproduce all of
+        #   ActiveModel::Dirty here, but having fought with upstream changes
+        #   many many times I finally decided it's more future-proof to just
+        #   re-implement the stuff we need here, to avoid weird breakage.
+        #
+        #   Although this is somewhat ugly, at least it's explicit and since
+        #   it's self-defined (rather than hooking into fickle private methods
+        #   in Rails), it won't break all of a sudden. We just need to ensure
+        #   that specs are up-to-date with the latest weird dirty method
+        #   pattern Rails has decided to support.
         class MobilityMutationTracker
           OPTION_NOT_GIVEN = Object.new
 
@@ -297,11 +336,11 @@ the ActiveRecord dirty plugin for more information.
           # @!group Backend Accessors
           # @!macro backend_writer
           # @param [Hash] options
-          def write(locale, value, options = {})
+          def write(locale, value, **options)
             locale_accessor = Mobility.normalize_locale_accessor(attribute, locale)
             if model.changed_attributes.has_key?(locale_accessor) && model.changed_attributes[locale_accessor] == value
               mutations_from_mobility.restore_attribute!(locale_accessor)
-            elsif read(locale, options.merge(locale: true)) != value
+            elsif read(locale, **options.merge(locale: true)) != value
               mutations_from_mobility.attribute_will_change!(locale_accessor)
             end
             super
@@ -316,5 +355,7 @@ the ActiveRecord dirty plugin for more information.
         end
       end
     end
+
+    register_plugin(:active_model_dirty, ActiveModel::Dirty)
   end
 end

data/lib/mobility/plugins/active_record.rb

@@ -1,6 +1,43 @@
+# frozen_string_literal: true
+require_relative "./active_record/backend"
+require_relative "./active_record/dirty"
+require_relative "./active_record/cache"
+require_relative "./active_record/query"
+require_relative "./active_record/uniqueness_validation"
+
 module Mobility
+=begin
+
+Plugin for ActiveRecord models.
+
+=end
   module Plugins
     module ActiveRecord
+      extend Plugin
+
+      requires :arel
+
+      requires :active_record_backend, include: :after
+      requires :active_record_dirty
+      requires :active_record_cache
+      requires :active_record_query
+      requires :active_record_uniqueness_validation
+
+
+      included_hook do |klass|
+        unless active_record_class?(klass)
+          name = klass.name || klass.to_s
+          raise TypeError, "#{name} should be a subclass of ActiveRecord::Base to use the active_record plugin"
+        end
+      end
+
+      private
+
+      def active_record_class?(klass)
+        klass < ::ActiveRecord::Base
+      end
     end
+
+    register_plugin(:active_record, ActiveRecord)
   end
 end

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

@@ -0,0 +1,27 @@
+# frozen-string-literal: true
+
+module Mobility
+  module Plugins
+    module ActiveRecord
+      module Backend
+        extend Plugin
+
+        requires :backend, include: :before
+
+        def load_backend(backend)
+          if Symbol === backend
+            require "mobility/backends/active_record/#{backend}"
+            Backends.load_backend("active_record_#{backend}".to_sym)
+          else
+            super
+          end
+        rescue LoadError => e
+          raise unless e.message =~ /active_record\/#{backend}/
+          super
+        end
+      end
+    end
+
+    register_plugin(:active_record_backend, ActiveRecord::Backend)
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen-string-literal: true
+require "mobility/plugins/active_model/cache"
+
+module Mobility
+  module Plugins
+    module ActiveRecord
+=begin
+
+Resets cache on calls to +reload+, in addition to other AM dirty reset
+methods.
+
+=end
+      module Cache
+        extend Plugin
+
+        requires :cache, include: false
+
+        included_hook do |klass, _|
+          if options[:cache]
+            define_cache_hooks(klass, :changes_applied, :clear_changes_information, :reload)
+          end
+        end
+      end
+    end
+
+    register_plugin(:active_record_cache, ActiveRecord::Cache)
+  end
+end