mobility 1.0.0.beta2 → 1.0.0.rc1

data/lib/mobility/backends/sequel.rb

@@ -30,6 +30,38 @@ module Mobility
         def prepare_dataset(dataset, _predicate, _locale)
           dataset
         end
+
+        # Forces Sequel to notice changes when Mobility setter method is
+        # called.
+        # TODO: Find a better way to do this.
+        def define_column_changes(mod, attributes, column_affix: "%s")
+          mod.class_eval do
+            attributes.each do |attribute|
+              define_method "#{attribute}=" do |value, **options|
+                if !options[:super] && send(attribute) != value
+                  locale = options[:locale] || Mobility.locale
+                  column = (column_affix % attribute).to_sym
+                  attribute_with_locale = :"#{attribute}_#{Mobility.normalize_locale(locale)}"
+                  @changed_columns = changed_columns | [column, attribute.to_sym, attribute_with_locale]
+                end
+                super(value, **options)
+              end
+            end
+          end
+        end
+
+        # Initialize column value(s) by default to a hash.
+        # TODO: Find a better way to do this.
+        def define_hash_initializer(mod, columns)
+          mod.class_eval do
+            class_eval <<-EOM, __FILE__, __LINE__ + 1
+              def initialize_set(values)
+                #{columns.map { |c| "self[:#{c}] = {}" }.join(';')}
+                super
+              end
+            EOM
+          end
+        end
       end
     end
   end

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

@@ -57,9 +57,11 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
         end
       end
 
+      backend = self
+
       setup do |attributes, options|
         column_name = options[:column_name]
-        before_validation = Module.new do
+        mod = Module.new do
           define_method :before_validation do
             self[column_name].each do |k, v|
               v.delete_if { |_locale, translation| Util.blank?(translation) }
@@ -68,8 +70,8 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
             super()
           end
         end
-        include before_validation
-        include Mobility::Sequel::HashInitializer.new(column_name)
+        include mod
+        backend.define_hash_initializer(mod, [column_name])
 
         plugin :defaults_setter
         attributes.each { |attribute| default_values[attribute.to_sym] = {} }

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

@@ -2,11 +2,6 @@
 require "mobility/util"
 require "mobility/backends/sequel"
 require "mobility/backends/key_value"
-require "mobility/sequel/column_changes"
-require "mobility/sequel/hash_initializer"
-require "mobility/sequel/string_translation"
-require "mobility/sequel/text_translation"
-require "mobility/sequel/sql"
 
 module Mobility
   module Backends
@@ -34,7 +29,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
           super
           if type = options[:type]
             options[:association_name] ||= :"#{options[:type]}_translations"
-            options[:class_name]       ||= Mobility::Sequel.const_get("#{type.capitalize}Translation")
+            options[:class_name]       ||= const_get("#{type.capitalize}Translation")
           end
           options[:table_alias_affix] = "#{model_class}_%s_#{options[:association_name]}"
         rescue NameError
@@ -43,7 +38,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
         # @!endgroup
 
         def build_op(attr, locale)
-          ::Mobility::Sequel::SQL::QualifiedIdentifier.new(table_alias(attr, locale), :value, locale, self, attribute_name: attr)
+          QualifiedIdentifier.new(table_alias(attr, locale), :value, locale, self, attr)
         end
 
         # @param [Sequel::Dataset] dataset Dataset to prepare
@@ -75,7 +70,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
           case predicate
           when Array
             visit_collection(predicate, locale)
-          when ::Mobility::Sequel::SQL::QualifiedIdentifier
+          when QualifiedIdentifier
             visit_sql_identifier(predicate, locale)
           when ::Sequel::SQL::BooleanExpression
             visit_boolean(predicate, locale)
@@ -128,6 +123,8 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
         end
       end
 
+      backend = self
+
       setup do |attributes, options|
         association_name   = options[:association_name]
         translations_class = options[:class_name]
@@ -159,13 +156,14 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
         include callback_methods
 
         include DestroyKeyValueTranslations
-        include Mobility::Sequel::ColumnChanges.new(attributes)
+        include(mod = Module.new)
+        backend.define_column_changes(mod, attributes)
       end
 
       # Returns translation for a given locale, or initializes one if none is present.
       # @param [Symbol] locale
-      # @return [Mobility::Sequel::TextTranslation,Mobility::Sequel::StringTranslation]
-      def translation_for(locale, _)
+      # @return [Mobility::Backends::Sequel::KeyValue::TextTranslation,Mobility::Backends::Sequel::KeyValue::StringTranslation]
+      def translation_for(locale, **)
         translation = model.send(association_name).find { |t| t.key == attribute && t.locale == locale.to_s }
         translation ||= class_name.new(locale: locale, key: attribute)
         translation
@@ -184,7 +182,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
         def after_destroy
           super
           [:string, :text].freeze.each do |type|
-            Mobility::Sequel.const_get("#{type.capitalize}Translation").
+            Mobility::Backends::Sequel::KeyValue.const_get("#{type.capitalize}Translation").
               where(translatable_id: id, translatable_type: self.class.name).destroy
           end
         end
@@ -201,6 +199,75 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
           (model.send(association_name) + cache.values).uniq
         end
       end
+
+      class QualifiedIdentifier < ::Sequel::SQL::QualifiedIdentifier
+        attr_reader :backend_class, :locale, :attribute_name
+
+        def initialize(table, column, locale, backend_class, attribute_name)
+          @backend_class = backend_class
+          @locale = locale
+          @attribute_name = attribute_name || column
+          super(table, column)
+        end
+      end
+
+      module Translation
+        def self.included(base)
+          base.class_eval do
+            plugin :validation_helpers
+
+            # Paraphased from sequel_polymorphic gem
+            #
+            model = underscore(self.to_s)
+            plural_model = pluralize(model)
+            many_to_one :translatable,
+              reciprocal: plural_model.to_sym,
+              reciprocal_type: :many_to_one,
+              setter: (proc do |able_instance|
+                self[:translatable_id]   = (able_instance.pk if able_instance)
+                self[:translatable_type] = (able_instance.class.name if able_instance)
+              end),
+              dataset: (proc do
+                translatable_type = send :translatable_type
+                translatable_id   = send :translatable_id
+                return if translatable_type.nil? || translatable_id.nil?
+                klass = self.class.send(:constantize, translatable_type)
+                klass.where(klass.primary_key => translatable_id)
+              end),
+              eager_loader: (proc do |eo|
+                id_map = {}
+                eo[:rows].each do |model|
+                  model_able_type = model.send :translatable_type
+                  model_able_id = model.send :translatable_id
+                  model.associations[:translatable] = nil
+                  ((id_map[model_able_type] ||= {})[model_able_id] ||= []) << model if !model_able_type.nil? && !model_able_id.nil?
+                end
+                id_map.each do |klass_name, id_map|
+                  klass = constantize(camelize(klass_name))
+                  klass.where(klass.primary_key=>id_map.keys).all do |related_obj|
+                    id_map[related_obj.pk].each do |model|
+                      model.associations[:translatable] = related_obj
+                    end
+                  end
+                end
+              end)
+
+            def validate
+              super
+              validates_presence [:locale, :key, :translatable_id, :translatable_type]
+              validates_unique   [:locale, :key, :translatable_id, :translatable_type]
+            end
+          end
+        end
+      end
+
+      class TextTranslation < ::Sequel::Model(:mobility_text_translations)
+        include Translation
+      end
+
+      class StringTranslation < ::Sequel::Model(:mobility_string_translations)
+        include Translation
+      end
     end
 
     register_backend(:sequel_key_value, Sequel::KeyValue)

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/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

@@ -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
 

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