mobility 0.8.13 → 1.0.0

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

@@ -40,29 +40,44 @@ locale suffix, so +title_en+, +title_pt_br+, etc.)
 
 =end
       module Dirty
-        class MethodsBuilder < ActiveModel::Dirty::MethodsBuilder
-          # @param [Attributes] attributes
-          def included(model_class)
-            super
+        extend Plugin
 
-            model_class.include InstanceMethods
+        requires :dirty, include: false
+        requires :active_model_dirty, include: :before
+
+        initialize_hook do
+          if options[:dirty]
+            include InstanceMethods
           end
+        end
 
-          class << self
-            def dirty_class
-              @dirty_class ||= (Class.new do
-                # In earlier versions of Rails, these are needed to avoid an
-                # exception when including the AR Dirty module outside of an
-                # AR::Base class. Eventually we should be able to drop them.
-                def self.after_create; end
-                def self.after_update; end
-
-                include ::ActiveRecord::AttributeMethods::Dirty
-              end)
-            end
+        included_hook do |_, backend_class|
+          if options[:dirty]
+            backend_class.include BackendMethods
           end
         end
 
+        private
+
+        def dirty_handler_methods
+          HandlerMethods
+        end
+
+        # Module which defines generic ActiveRecord::Dirty handler methods like
+        # +attribute_before_last_save+ that are patched to work with translated
+        # attributes.
+        HandlerMethods = ActiveModel::Dirty::HandlerMethodsBuilder.new(
+          Class.new do
+            # In earlier versions of Rails, these are needed to avoid an
+            # exception when including the AR Dirty module outside of an
+            # AR::Base class. Eventually we should be able to drop them.
+            def self.after_create; end
+            def self.after_update; end
+
+            include ::ActiveRecord::AttributeMethods::Dirty
+          end
+        )
+
         module InstanceMethods
           if ::ActiveRecord::VERSION::STRING >= '5.1' # define patterns added in 5.1
             def saved_changes
@@ -98,5 +113,7 @@ locale suffix, so +title_en+, +title_pt_br+, etc.)
         BackendMethods = ActiveModel::Dirty::BackendMethods
       end
     end
+
+    register_plugin(:active_record_dirty, ActiveRecord::Dirty)
   end
 end

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

@@ -1,4 +1,6 @@
 # frozen-string-literal: true
+require "active_record/relation"
+
 module Mobility
   module Plugins
 =begin
@@ -15,45 +17,47 @@ enabled for any one attribute on the model.
 =end
     module ActiveRecord
       module Query
-        class << self
-          def apply(attributes)
-            attributes.model_class.class_eval do
+        extend Plugin
+
+        requires :query, include: false
+
+        included_hook do |klass, backend_class|
+          plugin = self
+          if options[:query]
+            raise MissingBackend, "backend required for Query plugin" unless backend_class
+
+            klass.class_eval do
               extend QueryMethod
-              extend FindByMethods.new(*attributes.names)
-              singleton_class.send :alias_method, Mobility.query_method, :__mobility_query_scope__
+              extend FindByMethods.new(*plugin.names)
+              singleton_class.send :alias_method, plugin.query_method, :__mobility_query_scope__
             end
-            attributes.backend_class.include self
+            backend_class.include BackendMethods
           end
+        end
 
+        class << self
           def attribute_alias(attribute, locale = Mobility.locale)
             "__mobility_%s_%s__"  % [attribute, ::Mobility.normalize_locale(locale)]
           end
         end
 
-        # @note We use +instance_variable_get+ here to get the +AttributeSet+
-        #   rather than the hash of attributes. Getting the full hash of
-        #   attributes is a performance hit and better to avoid if unnecessary.
-        # TODO: Improve this.
-        def read(locale, **)
-          if (model_attributes_defined? &&
-              model_attributes.key?(alias_ = Query.attribute_alias(attribute, locale)))
-            model_attributes[alias_].value
-          else
-            super
+        module BackendMethods
+          # @note We use +instance_variable_get+ here to get the +AttributeSet+
+          #   rather than the hash of attributes. Getting the full hash of
+          #   attributes is a performance hit and better to avoid if unnecessary.
+          # TODO: Improve this.
+          def read(locale, **)
+            if model.instance_variable_defined?(:@attributes) &&
+                (model_attributes = model.instance_variable_get(:@attributes)).key?(alias_ = Query.attribute_alias(attribute, locale))
+              model_attributes[alias_].value
+            else
+              super
+            end
           end
         end
 
-        private
-
-        def model_attributes_defined?
-          model.instance_variable_defined?(:@attributes)
-        end
-
-        def model_attributes
-          model.instance_variable_get(:@attributes)
-        end
-
         module QueryMethod
+          # This is required for UniquenessValidator.
           def __mobility_query_scope__(locale: Mobility.locale, &block)
             if block_given?
               VirtualRow.build_query(self, locale, &block)
@@ -121,7 +125,7 @@ enabled for any one attribute on the model.
             case opts
             when Symbol, String
               @klass.mobility_attribute?(opts) ? order({ opts => :asc }, *rest) : super
-            when Hash
+            when ::Hash
               i18n_keys, keys = opts.keys.partition(&@klass.method(:mobility_attribute?))
               return super if i18n_keys.empty?
 
@@ -182,7 +186,7 @@ enabled for any one attribute on the model.
 
             class << self
               def build(scope, where_opts, invert: false, &block)
-                return yield unless Hash === where_opts
+                return yield unless ::Hash === where_opts
 
                 opts = where_opts.with_indifferent_access
                 locale = opts.delete(:locale) || Mobility.locale
@@ -195,11 +199,11 @@ enabled for any one attribute on the model.
               # Builds a translated relation for a given opts hash and optional
               # invert boolean.
               def _build(scope, opts, locale, invert)
-                return yield unless scope.respond_to?(:mobility_modules)
+                return yield if (mods = translation_modules(scope)).empty?
 
                 keys, predicates = opts.keys.map(&:to_s), []
 
-                query_map = scope.mobility_modules.inject(IDENTITY) do |qm, mod|
+                query_map = mods.inject(IDENTITY) do |qm, mod|
                   i18n_keys = mod.names & keys
                   next qm if i18n_keys.empty?
 
@@ -215,7 +219,11 @@ enabled for any one attribute on the model.
                 return yield if query_map == IDENTITY
 
                 relation = opts.empty? ? scope : yield(opts)
-                query_map[relation.where(predicates.inject(&:and))]
+                query_map[relation.where(predicates.inject(:and))]
+              end
+
+              def translation_modules(scope)
+                scope.model.ancestors.grep(::Mobility::Translations)
               end
 
               def build_predicate(node, values)
@@ -267,6 +275,10 @@ enabled for any one attribute on the model.
 
         private_constant :QueryExtension, :FindByMethods
       end
+
+      class MissingBackend < Mobility::Error; end
     end
+
+    register_plugin(:active_record_query, ActiveRecord::Query)
   end
 end

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

@@ -0,0 +1,64 @@
+module Mobility
+  module Plugins
+    module ActiveRecord
+      module UniquenessValidation
+        extend Plugin
+
+        requires :query, include: false
+
+        included_hook do |klass|
+          klass.class_eval do
+            unless const_defined?(:UniquenessValidator, false)
+              self.const_set(:UniquenessValidator, Class.new(UniquenessValidator))
+
+              def self.validates_uniqueness_of(*attr_names)
+                validates_with(UniquenessValidator, _merge_attributes(attr_names))
+              end
+            end
+          end
+        end
+
+        class UniquenessValidator < ::ActiveRecord::Validations::UniquenessValidator
+          # @param [ActiveRecord::Base] record Translated model
+          # @param [String] attribute Name of attribute
+          # @param [Object] value Attribute value
+          def validate_each(record, attribute, value)
+            klass = record.class
+
+            if ([*options[:scope]] + [attribute]).any? { |name| klass.mobility_attribute?(name) }
+              return unless value.present?
+              relation = klass.unscoped.__mobility_query_scope__ do |m|
+                node = m.__send__(attribute)
+                options[:case_sensitive] == false ? node.lower.eq(value.downcase) : node.eq(value)
+              end
+              relation = relation.where.not(klass.primary_key => record.id) if record.persisted?
+              relation = mobility_scope_relation(record, relation)
+              relation = relation.merge(options[:conditions]) if options[:conditions]
+
+              if relation.exists?
+                error_options = options.except(:case_sensitive, :scope, :conditions)
+                error_options[:value] = value
+
+                record.errors.add(attribute, :taken, **error_options)
+              end
+            else
+              super
+            end
+          end
+
+          private
+
+          def mobility_scope_relation(record, relation)
+            [*options[:scope]].inject(relation) do |scoped_relation, scope_item|
+              scoped_relation.__mobility_query_scope__ do |m|
+                m.__send__(scope_item).eq(record.send(scope_item))
+              end
+            end
+          end
+        end
+      end
+    end
+
+    register_plugin(:active_record_uniqueness_validation, ActiveRecord::UniquenessValidation)
+  end
+end

data/lib/mobility/plugins/arel.rb

@@ -0,0 +1,125 @@
+# frozen-string-literal: true
+
+module Mobility
+  module Plugins
+=begin
+
+Plugin for Mobility Arel customizations. Basically used as a namespace to store
+Arel-specific classes and modules.
+
+=end
+    module Arel
+      extend Plugin
+
+      module MobilityExpressions
+        include ::Arel::Expressions
+
+        # @note This is necessary in order to ensure that when a translated
+        #   attribute is selected with an alias using +AS+, the resulting
+        #   expression can still be counted without blowing up.
+        #
+        #   Extending +::Arel::Expressions+ is necessary to convince ActiveRecord
+        #   that this node should not be stringified, which otherwise would
+        #   result in garbage SQL.
+        #
+        # @see https://github.com/rails/rails/blob/847342c25c61acaea988430dc3ab66a82e3ed486/activerecord/lib/active_record/relation/calculations.rb#L261
+        def as(*)
+          super
+            .extend(::Arel::Expressions)
+            .extend(Countable)
+        end
+
+        module Countable
+          # @note This allows expressions with selected translated attributes to
+          #   be counted.
+          def count(*args)
+            left.count(*args)
+          end
+        end
+      end
+
+      class Attribute < ::Arel::Attributes::Attribute
+        include MobilityExpressions
+
+        attr_reader :backend_class
+        attr_reader :locale
+        attr_reader :attribute_name
+
+        def initialize(relation, column_name, locale, backend_class, attribute_name = nil)
+          @backend_class = backend_class
+          @locale = locale
+          @attribute_name = attribute_name || column_name
+          super(relation, column_name)
+        end
+      end
+
+      class Visitor < ::Arel::Visitors::Visitor
+        INNER_JOIN = ::Arel::Nodes::InnerJoin
+        OUTER_JOIN = ::Arel::Nodes::OuterJoin
+
+        attr_reader :backend_class, :locale
+
+        def initialize(backend_class, locale)
+          super()
+          @backend_class, @locale = backend_class, locale
+        end
+
+        private
+
+        def visit(*args)
+          super
+        rescue TypeError
+          visit_default(*args)
+        end
+
+        def visit_collection(_objects)
+          raise NotImplementedError
+        end
+        alias :visit_Array :visit_collection
+
+        def visit_Arel_Nodes_Unary(object)
+          visit(object.expr)
+        end
+
+        def visit_Arel_Nodes_Binary(object)
+          visit_collection([object.left, object.right])
+        end
+
+        def visit_Arel_Nodes_Function(object)
+          visit_collection(object.expressions)
+        end
+
+        def visit_Arel_Nodes_Case(object)
+          visit_collection([object.case, object.conditions, object.default])
+        end
+
+        def visit_Arel_Nodes_And(object)
+          visit_Array(object.children)
+        end
+
+        def visit_Arel_Nodes_Node(object)
+          visit_default(object)
+        end
+
+        def visit_Arel_Attributes_Attribute(object)
+          visit_default(object)
+        end
+
+        def visit_default(_object)
+          nil
+        end
+      end
+
+      module Nodes
+        class Binary < ::Arel::Nodes::Binary; end
+        class Grouping < ::Arel::Nodes::Grouping; end
+
+        ::Arel::Visitors::ToSql.class_eval do
+          alias :visit_Mobility_Plugins_Arel_Nodes_Grouping :visit_Arel_Nodes_Grouping
+        end
+      end
+    end
+
+    register_plugin(:arel, Arel)
+  end
+end

data/lib/mobility/plugins/arel/nodes.rb

@@ -0,0 +1,15 @@
+# frozen-string-literal: true
+module Mobility
+  module Plugins
+    module Arel
+      module Nodes
+        class Binary < ::Arel::Nodes::Binary; end
+        class Grouping < ::Arel::Nodes::Grouping; end
+
+        ::Arel::Visitors::ToSql.class_eval do
+          alias :visit_Mobility_Plugins_Arel_Nodes_Grouping :visit_Arel_Nodes_Grouping
+        end
+      end
+    end
+  end
+end

data/lib/mobility/plugins/arel/nodes/pg_ops.rb

@@ -0,0 +1,134 @@
+# frozen-string-literal: true
+require "mobility/plugins/arel"
+
+module Mobility
+  module Plugins
+    module Arel
+      module Nodes
+        %w[
+          JsonDashArrow
+          JsonDashDoubleArrow
+          JsonbDashArrow
+          JsonbDashDoubleArrow
+          JsonbQuestion
+          HstoreDashArrow
+          HstoreQuestion
+        ].each do |name|
+          const_set name, (Class.new(Binary) do
+            include ::Arel::Predications
+            include ::Arel::OrderPredications
+            include ::Arel::AliasPredication
+            include MobilityExpressions
+
+            def lower
+              super self
+            end
+          end)
+        end
+
+        # Needed for AR 4.2, can be removed when support is deprecated
+        if ::ActiveRecord::VERSION::STRING < '5.0'
+          [JsonbDashDoubleArrow, HstoreDashArrow].each do |klass|
+            klass.class_eval do
+              def quoted_node other
+                other && super
+              end
+            end
+          end
+        end
+
+        class Jsonb  < JsonbDashDoubleArrow
+          def to_dash_arrow
+            JsonbDashArrow.new left, right
+          end
+
+          def to_question
+            JsonbQuestion.new left, right
+          end
+
+          def eq other
+            case other
+            when NilClass
+              to_question.not
+            when Integer, Array, ::Hash
+              to_dash_arrow.eq other.to_json
+            when Jsonb
+              to_dash_arrow.eq other.to_dash_arrow
+            when JsonbDashArrow
+              to_dash_arrow.eq other
+            else
+              super
+            end
+          end
+        end
+
+        class Hstore < HstoreDashArrow
+          def to_question
+            HstoreQuestion.new left, right
+          end
+
+          def eq other
+            other.nil? ? to_question.not : super
+          end
+        end
+
+        class Json < JsonDashDoubleArrow; end
+
+        class JsonContainer < Json
+          def initialize column, locale, attr
+            super(Nodes::JsonDashArrow.new(column, locale), attr)
+          end
+        end
+
+        class JsonbContainer < Jsonb
+          def initialize column, locale, attr
+            @column, @locale = column, locale
+            super(JsonbDashArrow.new(column, locale), attr)
+          end
+
+          def eq other
+            other.nil? ? super.or(JsonbQuestion.new(@column, @locale).not) : super
+          end
+        end
+      end
+
+      module Visitors
+        def visit_Mobility_Plugins_Arel_Nodes_JsonDashArrow o, a
+          json_infix o, a, '->'
+        end
+
+        def visit_Mobility_Plugins_Arel_Nodes_JsonDashDoubleArrow o, a
+          json_infix o, a, '->>'
+        end
+
+        def visit_Mobility_Plugins_Arel_Nodes_JsonbDashArrow o, a
+          json_infix o, a, '->'
+        end
+
+        def visit_Mobility_Plugins_Arel_Nodes_JsonbDashDoubleArrow o, a
+          json_infix o, a, '->>'
+        end
+
+        def visit_Mobility_Plugins_Arel_Nodes_JsonbQuestion o, a
+          json_infix o, a, '?'
+        end
+
+        def visit_Mobility_Plugins_Arel_Nodes_HstoreDashArrow o, a
+          json_infix o, a, '->'
+        end
+
+        def visit_Mobility_Plugins_Arel_Nodes_HstoreQuestion o, a
+          json_infix o, a, '?'
+        end
+
+        private
+
+        def json_infix o, a, opr
+          visit(Nodes::Grouping.new(::Arel::Nodes::InfixOperation.new(opr, o.left, o.right)), a)
+        end
+      end
+
+      ::Arel::Visitors::PostgreSQL.include Visitors
+    end
+  end
+end