mobility 1.0.0.alpha → 1.0.1

data/lib/mobility/backend.rb

@@ -100,7 +100,7 @@ On top of this, a backend will normally:
     # @param [Symbol] locale Locale to read
     # @return [TrueClass,FalseClass] Whether translation is present for locale
     def present?(locale, options = {})
-      Util.present?(read(locale, options))
+      Util.present?(read(locale, **options))
     end
 
     # @!method model_class
@@ -120,6 +120,13 @@ On top of this, a backend will normally:
 
     # Defines setup hooks for backend to customize model class.
     module ClassMethods
+      # Returns valid option keys for this backend. This is overriden in
+      # backends to define which keys are valid for each backend class.
+      # @return [Array]
+      def valid_keys
+        []
+      end
+
       # Assign block to be called on model class.
       # @yield [attribute_names, options]
       # @note When called multiple times, setup blocks will be appended
@@ -179,15 +186,6 @@ On top of this, a backend will normally:
         EOM
       end
 
-      # Called from plugins to apply custom processing for this backend.
-      # Name is the name of the plugin.
-      # @param [Symbol] name Name of plugin
-      # @return [Boolean] Whether the plugin was applied
-      # @note This is currently only called by Plugins::Cache.
-      def apply_plugin(_)
-        false
-      end
-
       # Show useful information about this backend class, if it has no name.
       # @return [String]
       def inspect

data/lib/mobility/backends.rb

@@ -5,7 +5,7 @@ module Mobility
     class << self
       # @param [Symbol, Object] backend Name of backend to load.
       def load_backend(name)
-        return name if Module === name
+        return name if Module === name || name.nil?
 
         unless (backend = @backends[name])
           require "mobility/backends/#{name}"

data/lib/mobility/backends/active_record.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 require "mobility/backend"
-require "mobility/arel"
+require "mobility/plugins/arel"
 
 module Mobility
   module Backends

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

@@ -57,7 +57,7 @@ can be run again to add new attributes or locales.)
       #   on model table
       def self.build_node(attr, locale)
         model_class.arel_table[Column.column_name_for(attr, locale)]
-          .extend(::Mobility::Arel::MobilityExpressions)
+          .extend(Plugins::Arel::MobilityExpressions)
       end
 
       private

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require "mobility/backends/active_record"
-require "mobility/arel/nodes/pg_ops"
+require "mobility/backends/container"
+require "mobility/plugins/arel/nodes/pg_ops"
 
 module Mobility
   module Backends
@@ -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
       #
@@ -52,15 +49,15 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
 
         # @param [String] attr Attribute name
         # @param [Symbol] locale Locale
-        # @return [Mobility::Arel::Nodes::Json,Mobility::Arel::Nodes::Jsonb] Arel
+        # @return [Mobility::Plugins::Arel::Nodes::Json,Mobility::Arel::Nodes::Jsonb] Arel
         #   node for attribute on json or jsonb column
         def build_node(attr, locale)
           column = model_class.arel_table[column_name]
           case column_type
           when :json
-            Arel::Nodes::JsonContainer.new(column, build_quoted(locale), build_quoted(attr))
+            Plugins::Arel::Nodes::JsonContainer.new(column, build_quoted(locale), build_quoted(attr))
           when :jsonb
-            Arel::Nodes::JsonbContainer.new(column, build_quoted(locale), build_quoted(attr))
+            Plugins::Arel::Nodes::JsonbContainer.new(column, build_quoted(locale), build_quoted(attr))
           end
         end
 

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

@@ -1,5 +1,5 @@
 require 'mobility/backends/active_record/pg_hash'
-require 'mobility/arel/nodes/pg_ops'
+require 'mobility/plugins/arel/nodes/pg_ops'
 
 module Mobility
   module Backends
@@ -18,17 +18,17 @@ 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
 
         # @param [String] attr Attribute name
         # @param [Symbol] locale Locale
-        # @return [Mobility::Arel::Nodes::Hstore] Arel node for value of
+        # @return [Mobility::Plugins::Arel::Nodes::Hstore] Arel node for value of
         #   attribute key on hstore column
         def self.build_node(attr, locale)
           column_name = column_affix % attr
-          Arel::Nodes::Hstore.new(model_class.arel_table[column_name], build_quoted(locale))
+          Plugins::Arel::Nodes::Hstore.new(model_class.arel_table[column_name], build_quoted(locale))
         end
       end
     end

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

@@ -1,5 +1,5 @@
 require 'mobility/backends/active_record/pg_hash'
-require 'mobility/arel/nodes/pg_ops'
+require 'mobility/plugins/arel/nodes/pg_ops'
 
 module Mobility
   module Backends
@@ -32,11 +32,11 @@ Implements the {Mobility::Backends::Json} backend for ActiveRecord models.
 
         # @param [String] attr Attribute name
         # @param [Symbol] locale Locale
-        # @return [Mobility::Arel::Nodes::Json] Arel node for value of
+        # @return [Mobility::Plugins::Arel::Nodes::Json] Arel node for value of
         #   attribute key on jsonb column
         def self.build_node(attr, locale)
           column_name = column_affix % attr
-          Arel::Nodes::Json.new(model_class.arel_table[column_name], build_quoted(locale))
+          Plugins::Arel::Nodes::Json.new(model_class.arel_table[column_name], build_quoted(locale))
         end
       end
     end

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

@@ -1,5 +1,5 @@
 require 'mobility/backends/active_record/pg_hash'
-require 'mobility/arel/nodes/pg_ops'
+require 'mobility/plugins/arel/nodes/pg_ops'
 
 module Mobility
   module Backends
@@ -32,11 +32,11 @@ Implements the {Mobility::Backends::Jsonb} backend for ActiveRecord models.
 
         # @param [String] attr Attribute name
         # @param [Symbol] locale Locale
-        # @return [Mobility::Arel::Nodes::Jsonb] Arel node for value of
+        # @return [Mobility::Plugins::Arel::Nodes::Jsonb] Arel node for value of
         #   attribute key on jsonb column
         def self.build_node(attr, locale)
           column_name = column_affix % attr
-          Arel::Nodes::Jsonb.new(model_class.arel_table[column_name], build_quoted(locale))
+          Plugins::Arel::Nodes::Jsonb.new(model_class.arel_table[column_name], build_quoted(locale))
         end
       end
     end

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

@@ -1,8 +1,6 @@
 # frozen-string-literal: true
 require "mobility/backends/active_record"
 require "mobility/backends/key_value"
-require "mobility/active_record/string_translation"
-require "mobility/active_record/text_translation"
 
 module Mobility
   module Backends
@@ -37,21 +35,21 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
           super
           if type = options[:type]
             options[:association_name] ||= :"#{options[:type]}_translations"
-            options[:class_name]       ||= Mobility::ActiveRecord.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
-          raise ArgumentError, "You must define a Mobility::ActiveRecord::#{type.capitalize}Translation class."
+          raise ArgumentError, "You must define a Mobility::Backends::ActiveRecord::KeyValue::#{type.capitalize}Translation class."
         end
         # @!endgroup
 
         # @param [String] attr Attribute name
         # @param [Symbol] _locale Locale
-        # @return [Mobility::Arel::Attribute] Arel attribute for aliased
+        # @return [Mobility::Plugins::Arel::Attribute] Arel attribute for aliased
         #   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)
+          Plugins::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 +117,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 < ::Mobility::Arel::Visitor
+      class Visitor < Plugins::Arel::Visitor
         private
 
         def visit_Arel_Nodes_Equality(object)
@@ -141,7 +139,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
             transform_values { OUTER_JOIN }
         end
 
-        def visit_Mobility_Arel_Attribute(object)
+        def visit_Mobility_Plugins_Arel_Attribute(object)
           if object.backend_class == backend_class && object.locale == locale
             { object.attribute_name => OUTER_JOIN }
           end
@@ -194,8 +192,8 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
 
       # Returns translation for a given locale, or builds one if none is present.
       # @param [Symbol] locale
-      # @return [Mobility::ActiveRecord::TextTranslation,Mobility::ActiveRecord::StringTranslation]
-      def translation_for(locale, _options = {})
+      # @return [Mobility::Backends::ActiveRecord::KeyValue::TextTranslation,Mobility::Backends::ActiveRecord::KeyValue::StringTranslation]
+      def translation_for(locale, **)
         translation = translations.find { |t| t.key == attribute && t.locale == locale.to_s }
         translation ||= translations.build(locale: locale, key: attribute)
         translation
@@ -205,12 +203,30 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
         def self.included(model_class)
           model_class.after_destroy do
             [:string, :text].each do |type|
-              Mobility::ActiveRecord.const_get("#{type.capitalize}Translation").
+              Mobility::Backends::ActiveRecord::KeyValue.const_get("#{type.capitalize}Translation").
                 where(translatable: self).destroy_all
             end
           end
         end
       end
+
+      class Translation < ::ActiveRecord::Base
+        self.abstract_class = true
+
+        belongs_to :translatable, polymorphic: true, touch: true
+
+        validates :key, presence: true, uniqueness: { scope: [:translatable_id, :translatable_type, :locale], case_sensitive: true }
+        validates :translatable, presence: true
+        validates :locale, presence: true
+      end
+
+      class TextTranslation < Translation
+        self.table_name = "mobility_text_translations"
+      end
+
+      class StringTranslation < Translation
+        self.table_name = "mobility_string_translations"
+      end
     end
 
     register_backend(:active_record_key_value, ActiveRecord::KeyValue)

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)

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

@@ -1,7 +1,6 @@
 # frozen-string-literal: true
 require "mobility/backends/active_record"
 require "mobility/backends/table"
-require "mobility/active_record/model_translation"
 
 module Mobility
   module Backends
@@ -116,10 +115,10 @@ columns to that table.
 
         # @param [String] attr Attribute name
         # @param [Symbol] _locale Locale
-        # @return [Mobility::Arel::Attribute] Arel node for column on translation table
+        # @return [Mobility::Plugins::Arel::Attribute] Arel node for column on translation table
         def build_node(attr, locale)
           aliased_table = model_class.const_get(subclass_name).arel_table.alias(table_alias(locale))
-          Arel::Attribute.new(aliased_table, attr, locale, self)
+          Plugins::Arel::Attribute.new(aliased_table, attr, locale, self)
         end
 
         # Joins translations using either INNER/OUTER join appropriate to the
@@ -190,7 +189,7 @@ columns to that table.
       # we need an OUTER JOIN. In the second case, one attribute is matched
       # against a non-nil value, so we can use an INNER JOIN.
       #
-      class Visitor < Arel::Visitor
+      class Visitor < Plugins::Arel::Visitor
         private
 
         def visit_Arel_Nodes_Equality(object)
@@ -227,7 +226,7 @@ columns to that table.
           end
         end
 
-        def visit_Mobility_Arel_Attribute(object)
+        def visit_Mobility_Plugins_Arel_Attribute(object)
           # We compare table names here to ensure that attributes defined on
           # different backends but the same table will correctly get an OUTER
           # join when required. Use options[:table_name] here since we don't
@@ -245,7 +244,7 @@ columns to that table.
           if self.const_defined?(subclass_name, false)
             const_get(subclass_name, false)
           else
-            const_set(subclass_name, Class.new(Mobility::ActiveRecord::ModelTranslation))
+            const_set(subclass_name, Class.new(Translation))
           end
 
         translation_class.table_name = options[:table_name]
@@ -283,7 +282,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
@@ -303,6 +302,12 @@ columns to that table.
           destroy(empty_translations) if empty_translations.any?
         end
       end
+
+      # Subclassed dynamically to generate translation class.
+      class Translation < ::ActiveRecord::Base
+        self.abstract_class = true
+        validates :locale, presence: true
+      end
     end
 
     register_backend(:active_record_table, ActiveRecord::Table)

data/lib/mobility/backends/container.rb

@@ -19,8 +19,16 @@ stored).
 
 =end
     module Container
+      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
-
-    register_backend(:container, Container)
   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/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.
 

data/lib/mobility/backends/key_value.rb

@@ -54,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
 
@@ -83,6 +83,10 @@ 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] association_name (:<type>_translations) Name
@@ -100,16 +104,9 @@ other backends on model (otherwise one will overwrite the other).
           end
         end
 
-        # Apply custom processing for plugin
-        # @param (see Backend::ClassMethods#apply_plugin)
-        # @return (see Backend::ClassMethods#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)
@@ -123,7 +120,7 @@ other backends on model (otherwise one will overwrite the other).
           if cache.has_key?(locale)
             cache[locale]
           else
-            cache[locale] = super(locale, options)
+            cache[locale] = super(locale, **options)
           end
         end