mobility 0.8.10 → 1.0.0.beta2

data/lib/mobility/backends.rb

@@ -1,4 +1,24 @@
 module Mobility
   module Backends
+    @backends = {}
+
+    class << self
+      # @param [Symbol, Object] backend Name of backend to load.
+      def load_backend(name)
+        return name if Module === name || name.nil?
+
+        unless (backend = @backends[name])
+          require "mobility/backends/#{name}"
+          raise LoadError, "backend #{name} did not register itself correctly in Mobility::Backends" unless (backend = @backends[name])
+        end
+        backend
+      end
+    end
+
+    def self.register_backend(name, mod)
+      @backends[name] = mod
+    end
+
+    class LoadError < Error; end
   end
 end

data/lib/mobility/backends/active_record.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+require "mobility/backend"
+require "mobility/arel"
+
 module Mobility
   module Backends
     module ActiveRecord

data/lib/mobility/backends/active_record/column.rb

@@ -73,5 +73,7 @@ can be run again to add new attributes or locales.)
         end.compact
       end
     end
+
+    register_backend(:active_record_column, ActiveRecord::Column)
   end
 end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require "mobility/backends/active_record"
+require "mobility/backends/container"
 require "mobility/arel/nodes/pg_ops"
 
 module Mobility
@@ -11,11 +12,7 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
 =end
     class ActiveRecord::Container
       include ActiveRecord
-
-      # @!method column_name
-      #   Returns name of json or jsonb column used to store translations
-      #   @return [Symbol] (:translations) Name of translations column
-      option_reader :column_name
+      include Container
 
       # @!group Backend Accessors
       #
@@ -71,7 +68,7 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
         private
 
         def get_column_type
-          options[:model_class].type_for_attribute(options[:column_name].to_s).try(:type).tap do |type|
+          model_class.type_for_attribute(options[:column_name].to_s).try(:type).tap do |type|
             unless %i[json jsonb].include? type
               raise InvalidColumnType, "#{options[:column_name]} must be a column of type json or jsonb"
             end
@@ -122,7 +119,7 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
 
       class Coder
         def self.dump(obj)
-          if obj.is_a? Hash
+          if obj.is_a? ::Hash
             obj.inject({}) do |translations, (locale, value)|
               value.each do |k, v|
                 (translations[locale] ||= {})[k] = v if v.present?
@@ -141,5 +138,7 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
 
       class InvalidColumnType < StandardError; end
     end
+
+    register_backend(:active_record_container, ActiveRecord::Container)
   end
 end

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

@@ -18,7 +18,7 @@ Implements the {Mobility::Backends::Hstore} backend for ActiveRecord models.
 
         # @!macro backend_writer
         def write(locale, value, options = {})
-          super(locale, value && value.to_s, options)
+          super(locale, value && value.to_s, **options)
         end
         # @!endgroup
 
@@ -32,5 +32,7 @@ Implements the {Mobility::Backends::Hstore} backend for ActiveRecord models.
         end
       end
     end
+
+    register_backend(:active_record_hstore, ActiveRecord::Hstore)
   end
 end

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

@@ -40,5 +40,7 @@ Implements the {Mobility::Backends::Json} backend for ActiveRecord models.
         end
       end
     end
+
+    register_backend(:active_record_json, ActiveRecord::Json)
   end
 end

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

@@ -40,5 +40,7 @@ Implements the {Mobility::Backends::Jsonb} backend for ActiveRecord models.
         end
       end
     end
+
+    register_backend(:active_record_jsonb, ActiveRecord::Jsonb)
   end
 end

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

@@ -39,7 +39,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
             options[:association_name] ||= :"#{options[:type]}_translations"
             options[:class_name]       ||= Mobility::ActiveRecord.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::ActiveRecord::#{type.capitalize}Translation class."
         end
@@ -51,7 +51,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
         #   translation table value column
         def build_node(attr, locale)
           aliased_table = class_name.arel_table.alias(table_alias(attr, locale))
-          Arel::Attribute.new(aliased_table, :value, locale, self, attribute_name: attr.to_sym)
+          Arel::Attribute.new(aliased_table, :value, locale, self, attr.to_sym)
         end
 
         # Joins translations using either INNER/OUTER join appropriate to the query.
@@ -119,7 +119,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
       # The title predicate has a non-nil value, so we can use an INNER JOIN,
       # whereas we are searching for nil content, which requires an OUTER JOIN.
       #
-      class Visitor < Arel::Visitor
+      class Visitor < ::Mobility::Arel::Visitor
         private
 
         def visit_Arel_Nodes_Equality(object)
@@ -137,7 +137,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
         alias :visit_Array :visit_collection
 
         def visit_Arel_Nodes_Or(object)
-          [object.left, object.right].map(&method(:visit)).compact.inject(&:merge).
+          [object.left, object.right].map(&method(:visit)).compact.inject(:merge).
             transform_values { OUTER_JOIN }
         end
 
@@ -212,5 +212,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
         end
       end
     end
+
+    register_backend(:active_record_key_value, ActiveRecord::KeyValue)
   end
 end

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

@@ -30,7 +30,7 @@ Internal class used by ActiveRecord backends backed by a Postgres data type
 
         class Coder
           def self.dump(obj)
-            if obj.is_a? Hash
+            if obj.is_a? ::Hash
               obj.inject({}) do |translations, (locale, value)|
                 translations[locale] = value if value.present?
                 translations

data/lib/mobility/backends/active_record/serialized.rb

@@ -30,6 +30,10 @@ Implements {Mobility::Backends::Serialized} backend for ActiveRecord models.
       include ActiveRecord
       include HashValued
 
+      def self.valid_keys
+        super + [:format]
+      end
+
       # @!group Backend Configuration
       # @param (see Backends::Serialized.configure)
       # @option (see Backends::Serialized.configure)
@@ -72,5 +76,7 @@ Implements {Mobility::Backends::Serialized} backend for ActiveRecord models.
         EOM
       end
     end
+
+    register_backend(:active_record_serialized, ActiveRecord::Serialized)
   end
 end

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

@@ -101,7 +101,7 @@ columns to that table.
         # @option options [Symbol] subclass_name (:Translation) Name of subclass
         #   to append to model class to generate translation class
         def configure(options)
-          table_name = options[:model_class].table_name
+          table_name = model_class.table_name
           options[:table_name]  ||= "#{table_name.singularize}_translations"
           options[:foreign_key] ||= table_name.downcase.singularize.camelize.foreign_key
           if (association_name = options[:association_name]).present?
@@ -153,7 +153,7 @@ columns to that table.
         def already_joined?(relation, locale, join_type)
           if join = get_join(relation, locale)
             return true if (join_type == Visitor::OUTER_JOIN) || (Visitor::INNER_JOIN === join)
-            relation.joins_values = relation.joins_values - [join]
+            relation.joins_values -= [join]
           end
           false
         end
@@ -265,7 +265,7 @@ columns to that table.
           touch: true
 
         before_save do
-          required_attributes = self.class.mobility_attributes & translation_class.attribute_names
+          required_attributes = translation_class.attribute_names.select { |name| self.class.mobility_attribute?(name) }
           send(association_name).destroy_empty_translations(required_attributes)
         end
 
@@ -283,7 +283,7 @@ columns to that table.
 
       # Returns translation for a given locale, or builds one if none is present.
       # @param [Symbol] locale
-      def translation_for(locale, _)
+      def translation_for(locale, **)
         translation = translations.in_locale(locale)
         translation ||= translations.build(locale: locale)
         translation
@@ -304,5 +304,7 @@ columns to that table.
         end
       end
     end
+
+    register_backend(:active_record_table, ActiveRecord::Table)
   end
 end

data/lib/mobility/backends/column.rb

@@ -27,8 +27,6 @@ be ignored if set, since it would cause a conflict with column accessors.
 
 =end
     module Column
-      extend Backend::OrmDelegator
-
       # Returns name of column where translated attribute is stored
       # @param [Symbol] locale
       # @return [String]
@@ -44,10 +42,6 @@ be ignored if set, since it would cause a conflict with column accessors.
         normalized_locale = Mobility.normalize_locale(locale)
         "#{attribute}_#{normalized_locale}".to_sym
       end
-
-      def self.included(base)
-        base.extend Backend::OrmDelegator
-      end
     end
   end
 end

data/lib/mobility/backends/container.rb

@@ -19,7 +19,16 @@ stored).
 
 =end
     module Container
-      extend Backend::OrmDelegator
+      def self.included(backend_class)
+        backend_class.extend ClassMethods
+        backend_class.option_reader :column_name
+      end
+
+      module ClassMethods
+        def valid_keys
+          [:column_name]
+        end
+      end
     end
   end
 end

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