mobility 1.0.0.beta1 → 1.0.2

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

@@ -2,8 +2,6 @@
 require "mobility/util"
 require "mobility/backends/sequel"
 require "mobility/backends/hash_valued"
-require "mobility/sequel/column_changes"
-require "mobility/sequel/hash_initializer"
 
 module Mobility
   module Backends
@@ -35,10 +33,12 @@ jsonb).
           model[column_name.to_sym]
         end
 
+        backend = self
+
         setup do |attributes, options|
           columns = attributes.map { |attribute| (options[:column_affix] % attribute).to_sym }
 
-          before_validation = Module.new do
+          mod = Module.new do
             define_method :before_validation do
               columns.each do |column|
                 self[column].delete_if { |_, v| Util.blank?(v) }
@@ -46,9 +46,9 @@ jsonb).
               super()
             end
           end
-          include before_validation
-          include Mobility::Sequel::HashInitializer.new(*columns)
-          include Mobility::Sequel::ColumnChanges.new(attributes, column_affix: options[:column_affix])
+          include mod
+          backend.define_hash_initializer(mod, columns)
+          backend.define_column_changes(mod, attributes, column_affix: options[:column_affix])
 
           plugin :defaults_setter
           columns.each { |column| default_values[column] = {} }

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

@@ -2,9 +2,6 @@
 require "mobility/util"
 require "mobility/backends/sequel"
 require "mobility/backends/table"
-require "mobility/sequel/column_changes"
-require "mobility/sequel/model_translation"
-require "mobility/sequel/sql"
 
 module Mobility
   module Backends
@@ -52,7 +49,7 @@ Implements the {Mobility::Backends::Table} backend for Sequel models.
         # @param [Symbol] locale Locale
         # @return [Sequel::SQL::QualifiedIdentifier]
         def build_op(attr, locale)
-          ::Mobility::Sequel::SQL::QualifiedIdentifier.new(table_alias(locale), attr, locale, self, attribute_name: attr)
+          ::Sequel::SQL::QualifiedIdentifier.new(table_alias(locale), attr || :value)
         end
 
         # @param [Sequel::Dataset] dataset Dataset to prepare
@@ -83,7 +80,7 @@ Implements the {Mobility::Backends::Table} backend for Sequel models.
           case predicate
           when Array
             visit_collection(predicate, locale)
-          when ::Mobility::Sequel::SQL::QualifiedIdentifier
+          when ::Sequel::SQL::QualifiedIdentifier
             visit_sql_identifier(predicate, locale)
           when ::Sequel::SQL::BooleanExpression
             visit_boolean(predicate, locale)
@@ -119,6 +116,8 @@ Implements the {Mobility::Backends::Table} backend for Sequel models.
         end
       end
 
+      backend = self
+
       setup do |attributes, options|
         association_name = options[:association_name]
         subclass_name    = options[:subclass_name]
@@ -128,7 +127,7 @@ Implements the {Mobility::Backends::Table} backend for Sequel models.
             const_get(subclass_name, false)
           else
             const_set(subclass_name, Class.new(::Sequel::Model(options[:table_name]))).tap do |klass|
-              klass.include ::Mobility::Sequel::ModelTranslation
+              klass.include Translation
             end
           end
 
@@ -155,10 +154,11 @@ Implements the {Mobility::Backends::Table} backend for Sequel models.
         end
         include callback_methods
 
-        include Mobility::Sequel::ColumnChanges.new(attributes)
+        include(mod = Module.new)
+        backend.define_column_changes(mod, attributes)
       end
 
-      def translation_for(locale, _)
+      def translation_for(locale, **)
         translation = model.send(association_name).find { |t| t.locale == locale.to_s }
         translation ||= translation_class.new(locale: locale)
         translation
@@ -174,6 +174,16 @@ Implements the {Mobility::Backends::Table} backend for Sequel models.
         end
       end
 
+      module Translation
+        def self.included(base)
+          base.plugin :validation_helpers
+        end
+
+        def validate
+          super
+          validates_presence [:locale]
+        end
+      end
       class CacheRequired < ::StandardError; end
     end
 

data/lib/mobility/backends/table.rb

@@ -10,8 +10,9 @@ Stores attribute translation as rows on a model-specific translation table
 the table name for a model +Post+ with table +posts+ will be
 +post_translations+, and the translation class will be +Post::Translation+. The
 translation class is dynamically created when the backend is initialized on the
-model class, and subclasses {Mobility::ActiveRecord::ModelTranslation} (for AR
-models) or inherits {Mobility::Sequel::ModelTranslation} (for Sequel models).
+model class, and subclasses
+{Mobility::Backends::ActiveRecord::Table::Translation} (for AR models) or
+inherits {Mobility::Backends::Sequel::Table::Translation} (for Sequel models).
 
 The backend expects the translations table (+post_translations+) to have:
 
@@ -140,17 +141,21 @@ set.
         end
 
         def clear_cache
-          model_cache && model_cache.clear
+          cache.clear
         end
 
         private
 
         def cache
-          model_cache || model.instance_variable_set(:"@__mobility_#{association_name}_cache", {})
+          if model.instance_variable_defined?(cache_name)
+            model.instance_variable_get(cache_name)
+          else
+            model.instance_variable_set(cache_name, {})
+          end
         end
 
-        def model_cache
-          model.instance_variable_get(:"@__mobility_#{association_name}_cache")
+        def cache_name
+          @cache_name ||= :"@__mobility_#{association_name}_cache"
         end
       end
     end

data/lib/mobility/plugin.rb

@@ -121,8 +121,8 @@ Also includes a +configure+ class method to apply plugins to a pluggable
     # Does this class include all plugins this plugin depends (directly) on?
     # @param [Class] klass Pluggable class
     def dependencies_satisfied?(klass)
-      required_plugins = dependencies.keys.map { |name| Plugins.load_plugin(name) }
-      (required_plugins - klass.included_modules).none?
+      plugin_keys = klass.included_plugins.map { |plugin| Plugins.lookup_name(plugin) }
+      (dependencies.keys - plugin_keys).none?
     end
 
     # Specifies a dependency of this plugin.

data/lib/mobility/plugins/active_record.rb

@@ -15,12 +15,15 @@ Plugin for ActiveRecord models.
     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

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

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module Mobility
   module Plugins
     module ActiveRecord

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

@@ -67,9 +67,9 @@ enabled for any one attribute on the model.
           end
         end
 
-        # Internal class to create a "clean room" for manipulating translated
-        # attribute nodes in an instance-eval'ed block. Inspired by Sequel's
-        # (much more sophisticated) virtual rows.
+        # Creates a "clean room" for manipulating translated attribute nodes in
+        # an instance-eval'ed block. Inspired by Sequel's (much more
+        # sophisticated) virtual rows.
         class VirtualRow < BasicObject
           attr_reader :__backends
 
@@ -108,7 +108,7 @@ enabled for any one attribute on the model.
             end
           end
         end
-        private_constant :QueryMethod, :VirtualRow
+        private_constant :QueryMethod
 
         module QueryExtension
           def where!(opts, *rest)
@@ -199,7 +199,7 @@ 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 if (mods = attribute_modules(scope)).empty?
+                return yield if (mods = translation_modules(scope)).empty?
 
                 keys, predicates = opts.keys.map(&:to_s), []
 
@@ -222,7 +222,7 @@ enabled for any one attribute on the model.
                 query_map[relation.where(predicates.inject(:and))]
               end
 
-              def attribute_modules(scope)
+              def translation_modules(scope)
                 scope.model.ancestors.grep(::Mobility::Translations)
               end
 
@@ -273,7 +273,7 @@ enabled for any one attribute on the model.
           end
         end
 
-        private_constant :QueryExtension, :FindByMethods
+        private_constant :FindByMethods
       end
 
       class MissingBackend < Mobility::Error; end

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

@@ -10,6 +10,10 @@ module Mobility
           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

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