mobility 0.8.11 → 1.0.0.rc1

data/lib/mobility/backends/hash.rb

@@ -0,0 +1,39 @@
+module Mobility
+  module Backends
+=begin
+
+Backend which stores translations in an in-memory hash.
+
+=end
+    class Hash
+      include Backend
+
+      # @!group Backend Accessors
+      # @!macro backend_reader
+      # @return [Object]
+      def read(locale, _ = {})
+        translations[locale]
+      end
+
+      # @!macro backend_writer
+      # @return [Object]
+      def write(locale, value, _ = {})
+        translations[locale] = value
+      end
+      # @!endgroup
+
+      # @!macro backend_iterator
+      def each_locale
+        translations.each { |l, _| yield l }
+      end
+
+      private
+
+      def translations
+        @translations ||= {}
+      end
+    end
+
+    register_backend(:hash, Hash)
+  end
+end

data/lib/mobility/backends/hash_valued.rb

@@ -36,6 +36,10 @@ Defines read and write methods that access the value at a key with value
       end
 
       module ClassMethods
+        def valid_keys
+          [:column_prefix, :column_suffix]
+        end
+
         def configure(options)
           options[:column_affix] = "#{options[:column_prefix]}%s#{options[:column_suffix]}"
         end

data/lib/mobility/backends/hstore.rb

@@ -17,7 +17,6 @@ Prefix and suffix to add to attribute name to generate hstore column name.
 
 =end
     module Hstore
-      extend Backend::OrmDelegator
     end
   end
 end

data/lib/mobility/backends/json.rb

@@ -16,7 +16,6 @@ Prefix and suffix to add to attribute name to generate json column name.
 
 =end
     module Json
-      extend Backend::OrmDelegator
     end
   end
 end

data/lib/mobility/backends/jsonb.rb

@@ -6,7 +6,7 @@ Stores translations as hash on Postgres jsonb column.
 
 ==Backend Options
 
-===+prefix+ and +suffix+
+===+column_prefix+ and +column_suffix+
 
 Prefix and suffix to add to attribute name to generate jsonb column name.
 
@@ -16,7 +16,6 @@ Prefix and suffix to add to attribute name to generate jsonb column name.
 
 =end
     module Jsonb
-      extend Backend::OrmDelegator
     end
   end
 end

data/lib/mobility/backends/key_value.rb

@@ -44,8 +44,6 @@ other backends on model (otherwise one will overwrite the other).
 
 =end
     module KeyValue
-      extend Backend::OrmDelegator
-
       # @!method association_name
       #   Returns the name of the polymorphic association.
       #   @return [Symbol] Name of the association
@@ -56,13 +54,13 @@ other backends on model (otherwise one will overwrite the other).
 
       # @!group Backend Accessors
       # @!macro backend_reader
-      def read(locale, options = {})
-        translation_for(locale, options).value
+      def read(locale, **options)
+        translation_for(locale, **options).value
       end
 
       # @!macro backend_writer
-      def write(locale, value, options = {})
-        translation_for(locale, options).value = value
+      def write(locale, value, **options)
+        translation_for(locale, **options).value = value
       end
       # @!endgroup
 
@@ -85,9 +83,13 @@ other backends on model (otherwise one will overwrite the other).
       end
 
       module ClassMethods
+        def valid_keys
+          [:type, :association_name, :class_name]
+        end
+
         # @!group Backend Configuration
         # @option options [Symbol,String] type Column type to use
-        # @option options [Symbol] associaiton_name (:<type>_translations) Name
+        # @option options [Symbol] association_name (:<type>_translations) Name
         #   of association method, defaults to +<type>_translations+
         # @option options [Symbol] class_name Translation class, defaults to
         #   +Mobility::<ORM>::<type>Translation+
@@ -98,27 +100,13 @@ other backends on model (otherwise one will overwrite the other).
           options[:association_name] &&= options[:association_name].to_sym
           options[:class_name]       &&= Util.constantize(options[:class_name])
           if !(options[:type] || (options[:class_name] && options[:association_name]))
-            # TODO: Remove warning and raise ArgumentError in v1.0
-            warn %{
-WARNING: In previous versions, the Mobility KeyValue backend defaulted to a
-text type column, but this behavior is now deprecated and will be removed in
-the next release. Either explicitly specify the type by passing type: :text in
-each translated model, or set a default option in your configuration.
-  }
-            options[:type] = :text
+            raise ArgumentError, "KeyValue backend requires an explicit type option, either text or string."
           end
         end
 
-        # Apply custom processing for plugin
-        # @param (see Backend::Setup#apply_plugin)
-        # @return (see Backend::Setup#apply_plugin)
-        def apply_plugin(name)
-          if name == :cache
-            include self::Cache
-            true
-          else
-            super
-          end
+        # Apply custom processing for cache plugin
+        def include_cache
+          include self::Cache
         end
 
         def table_alias(attr, locale)
@@ -127,7 +115,24 @@ each translated model, or set a default option in your configuration.
       end
 
       module Cache
-        include Plugins::Cache::TranslationCacher.new(:translation_for)
+        def translation_for(locale, **options)
+          return super(locale, options) if options.delete(:cache) == false
+          if cache.has_key?(locale)
+            cache[locale]
+          else
+            cache[locale] = super(locale, **options)
+          end
+        end
+
+        def clear_cache
+          @cache = {}
+        end
+
+        private
+
+        def cache
+          @cache ||= {}
+        end
       end
     end
   end

data/lib/mobility/backends/null.rb

@@ -20,5 +20,7 @@ Backend which does absolutely nothing. Mostly for testing purposes.
       def self.configure(_); end
       # @!endgroup
     end
+
+    register_backend(:null, Null)
   end
 end

data/lib/mobility/backends/sequel.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+require "mobility/backend"
+
 module Mobility
   module Backends
     module Sequel
       def self.included(backend_class)
-        backend_class.include(Backend)
-        backend_class.extend(ClassMethods)
+        backend_class.include Backend
+        backend_class.extend ClassMethods
       end
 
       module ClassMethods
@@ -27,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/column.rb

@@ -50,5 +50,7 @@ Implements the {Mobility::Backends::Column} backend for Sequel models.
         end.compact
       end
     end
+
+    register_backend(:sequel_column, Sequel::Column)
   end
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require "mobility/backends/sequel/json"
+require "mobility/backends/sequel"
 require "mobility/backends/sequel/jsonb"
+require "mobility/backends/container"
 
 module Mobility
   module Backends
@@ -11,10 +12,7 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
 =end
     class Sequel::Container
       include Sequel
-
-      # @!method column_name
-      #   @return [Symbol] (:translations) Name of translations column
-      option_reader :column_name
+      include Container
 
       # @!group Backend Accessors
       #
@@ -44,7 +42,7 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
       def self.configure(options)
         options[:column_name] ||= :translations
         options[:column_name] = options[:column_name].to_sym
-        column_name, db_schema = options[:column_name], options[:model_class].db_schema
+        column_name, db_schema = options[:column_name], model_class.db_schema
         options[:column_type] = db_schema[column_name] && (db_schema[column_name][:db_type]).to_sym
         unless %i[json jsonb].include?(options[:column_type])
           raise InvalidColumnType, "#{options[:column_name]} must be a column of type json or jsonb"
@@ -59,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) }
@@ -70,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] = {} }
@@ -114,5 +114,7 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
         end
       end
     end
+
+    register_backend(:sequel_container, Sequel::Container)
   end
 end

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

@@ -20,7 +20,7 @@ Implements the {Mobility::Backends::Hstore} backend for Sequel models.
         # @!group Backend Accessors
         # @!macro backend_writer
         def write(locale, value, options = {})
-          super(locale, value && value.to_s, options)
+          super(locale, value && value.to_s, **options)
         end
         # @!endgroup
 
@@ -35,5 +35,7 @@ Implements the {Mobility::Backends::Hstore} backend for Sequel models.
         class HStoreOp < ::Sequel::Postgres::HStoreOp; end
       end
     end
+
+    register_backend(:sequel_hstore, Sequel::Hstore)
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mobility/backends/sequel/pg_hash'
 
 Sequel.extension :pg_json, :pg_json_ops
@@ -42,5 +43,7 @@ Implements the {Mobility::Backends::Json} backend for Sequel models.
         class JSONOp < ::Sequel::Postgres::JSONOp; end
       end
     end
+
+    register_backend(:sequel_json, Sequel::Json)
   end
 end

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

@@ -55,7 +55,7 @@ Implements the {Mobility::Backends::Jsonb} backend for Sequel models.
 
           def =~(other)
             case other
-            when Integer, Hash
+            when Integer, ::Hash
               to_dash_arrow =~ other.to_json
             when NilClass
               ~to_question
@@ -66,5 +66,7 @@ Implements the {Mobility::Backends::Jsonb} backend for Sequel models.
         end
       end
     end
+
+    register_backend(:sequel_jsonb, Sequel::Jsonb)
   end
 end

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,16 +29,16 @@ 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] = "#{options[:model_class]}_%s_#{options[:association_name]}"
+          options[:table_alias_affix] = "#{model_class}_%s_#{options[:association_name]}"
         rescue NameError
           raise ArgumentError, "You must define a Mobility::Sequel::#{type.capitalize}Translation class."
         end
         # @!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)
@@ -93,7 +88,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
               join_type = nils.empty? ? :inner : :left_outer
               # TODO: simplify to hash.transform_values { join_type } when
               #   support for Ruby 2.3 is deprecated
-              Hash[hash.keys.map { |key| [key, join_type] }]
+              ::Hash[hash.keys.map { |key| [key, join_type] }]
             else
               {}
             end
@@ -101,13 +96,13 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
             hash = visit(boolean.args, locale)
             # TODO: simplify to hash.transform_values { :inner } when
             #   support for Ruby 2.3 is deprecated
-            Hash[hash.keys.map { |key| [key, :inner] }]
+            ::Hash[hash.keys.map { |key| [key, :inner] }]
           elsif boolean.op == :OR
             hash = boolean.args.map { |op| visit(op, locale) }.
-              compact.inject(&:merge)
+              compact.inject(:merge)
             # TODO: simplify to hash.transform_values { :left_outer } when
             #   support for Ruby 2.3 is deprecated
-            Hash[hash.keys.map { |key| [key, :left_outer] }]
+            ::Hash[hash.keys.map { |key| [key, :left_outer] }]
           else
             visit(boolean.args, locale)
           end
@@ -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]
@@ -153,19 +150,20 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
           end
           define_method :after_save do
             super()
-            attributes.each { |attribute| public_send(Backend.method_name(attribute)).save_translations }
+            attributes.each { |attribute| mobility_backends[attribute].save_translations }
           end
         end
         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,77 @@ 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)
   end
 end