mobility 0.1.20 → 0.2.0

data/lib/mobility/{backend → backends}/hstore.rb

@@ -1,5 +1,5 @@
 module Mobility
-  module Backend
+  module Backends
 
 =begin
 
@@ -9,13 +9,13 @@ Stores translations as hash on Postgres hstore column.
 
 This backend has no options.
 
-@see Mobility::Backend::ActiveRecord::Hstore
-@see Mobility::Backend::Sequel::Hstore
+@see Mobility::Backends::ActiveRecord::Hstore
+@see Mobility::Backends::Sequel::Hstore
 @see https://www.postgresql.org/docs/current/static/hstore.html PostgreSQL Documentation for hstore
 
 =end
     module Hstore
-      include OrmDelegator
+      extend Backend::OrmDelegator
     end
   end
 end

data/lib/mobility/{backend → backends}/jsonb.rb

@@ -1,5 +1,5 @@
 module Mobility
-  module Backend
+  module Backends
 
 =begin
 
@@ -9,13 +9,13 @@ Stores translations as hash on Postgres jsonb column.
 
 This backend has no options.
 
-@see Mobility::Backend::ActiveRecord::Jsonb
-@see Mobility::Backend::Sequel::Jsonb
+@see Mobility::Backends::ActiveRecord::Jsonb
+@see Mobility::Backends::Sequel::Jsonb
 @see https://www.postgresql.org/docs/current/static/datatype-json.html PostgreSQL Documentation for JSON Types
 
 =end
     module Jsonb
-      include OrmDelegator
+      extend Backend::OrmDelegator
     end
   end
 end

data/lib/mobility/backends/key_value.rb

@@ -0,0 +1,111 @@
+require "mobility/plugins/cache"
+
+module Mobility
+  module Backends
+=begin
+
+Stores attribute translation as attribute/value pair on a shared translations
+table, using a polymorphic relationship between a translation class and models
+using the backend. By default, two tables are assumed to be present supporting
+string and text translations: a +mobility_text_translations+ table for
+text-valued translations and a +string_translations+ table for
+string-valued translations (the only difference being the column type of the
++value+ column on the table).
+
+==Backend Options
+
+===+association_name+
+
+Name of association on model. Defaults to +text_translations+ (if +type+ is
++:text+) or +string_translations+ (if +type+ is +:string+). If specified,
+ensure name does not overlap with other methods on model or with the
+association name used by other backends on model (otherwise one will overwrite
+the other).
+
+===+type+
+
+Currently, either +:text+ or +:string+ is supported. Determines which class to
+use for translations, which in turn determines which table to use to store
+translations (by default +text_translations+ for text type,
++string_translations+ for string type).
+
+===+class_name+
+
+Class to use for translations when defining association. By default,
+{Mobility::ActiveRecord::TextTranslation} or
+{Mobility::ActiveRecord::StringTranslation} for ActiveRecord models (similar
+for Sequel models). If string is passed in, it will be constantized to get the
+class.
+
+@see Mobility::Backends::ActiveRecord::KeyValue
+@see Mobility::Backends::Sequel::KeyValue
+
+=end
+    module KeyValue
+      extend Backend::OrmDelegator
+
+      # @return [Symbol] name of the association
+      attr_reader :association_name
+
+      # @!macro backend_constructor
+      # @option options [Symbol] association_name Name of association
+      def initialize(model, attribute, options = {})
+        super
+        @association_name = options[:association_name]
+      end
+
+      # @!group Backend Accessors
+      # @!macro backend_reader
+      def read(locale, options = {})
+        translation_for(locale, options).value
+      end
+
+      # @!macro backend_reader
+      def write(locale, value, options = {})
+        translation_for(locale, options).tap { |t| t.value = value }.value
+      end
+      # @!endgroup
+
+      # @!macro backend_iterator
+      def each_locale
+        translations.each { |t| yield(t.locale.to_sym) if t.key == attribute }
+      end
+
+      private
+
+      def translations
+        model.send(association_name)
+      end
+
+      def self.included(backend)
+        backend.extend ClassMethods
+      end
+
+      module ClassMethods
+        # @!group Backend Configuration
+        # @option options [Symbol,String] type (:text) Column type to use
+        # @raise [ArgumentError] if type is not either :text or :string
+        def configure(options)
+          options[:type] = (options[:type] || :text).to_sym
+          raise ArgumentError, "type must be one of: [text, string]" unless [:text, :string].include?(options[:type])
+        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
+        end
+      end
+
+      module Cache
+        include Plugins::Cache::TranslationCacher.new(:translation_for)
+      end
+    end
+  end
+end

data/lib/mobility/{backend → backends}/null.rb

@@ -1,5 +1,5 @@
 module Mobility
-  module Backend
+  module Backends
 =begin
 
 Backend which does absolutely nothing. Mostly for testing purposes.
@@ -10,14 +10,14 @@ Backend which does absolutely nothing. Mostly for testing purposes.
 
       # @!group Backend Accessors
       # @return [NilClass]
-      def read(*); end
+      def read(_, _ = {}); end
 
       # @return [NilClass]
-      def write(*); end
+      def write(_, _, _ = {}); end
       # @!endgroup
 
       # @!group Backend Configuration
-      def self.configure(*); end
+      def self.configure(_); end
       # @!endgroup
     end
   end

data/lib/mobility/backends/sequel.rb

@@ -0,0 +1,20 @@
+module Mobility
+  module Backends
+    module Sequel
+      def setup_query_methods(query_methods)
+        setup do |attributes, options|
+          extend(Module.new do
+            define_method ::Mobility.query_method do
+              super().with_extend(query_methods.new(attributes, options))
+            end
+          end)
+        end
+      end
+
+      def self.included(backend_class)
+        backend_class.include(Backend)
+        backend_class.extend(self)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require "mobility/backends/sequel"
+require "mobility/backends/column"
+
+module Mobility
+  module Backends
+=begin
+
+Implements the {Mobility::Backends::Column} backend for Sequel models.
+
+=end
+    class Sequel::Column
+      include Sequel
+      include Column
+
+      require 'mobility/backends/sequel/column/query_methods'
+
+      # @!group Backend Accessors
+      # @!macro backend_reader
+      def read(locale, _ = {})
+        column = column(locale)
+        model[column] if model.columns.include?(column)
+      end
+
+      # @!group Backend Accessors
+      # @!macro backend_writer
+      def write(locale, value, _ = {})
+        column = column(locale)
+        model[column] = value if model.columns.include?(column)
+      end
+
+      # @!macro backend_iterator
+      def each_locale
+        available_locales.each { |l| yield(l) if present?(l) }
+      end
+
+      setup_query_methods(QueryMethods)
+
+      private
+
+      def available_locales
+        @available_locales ||= get_column_locales
+      end
+
+      def get_column_locales
+        column_name_regex = /\A#{attribute}_([a-z]{2}(_[a-z]{2})?)\z/.freeze
+        model.columns.map do |c|
+          (match = c.to_s.match(column_name_regex)) && match[1].to_sym
+        end.compact
+      end
+    end
+  end
+end

data/lib/mobility/{backend → backends}/sequel/column/query_methods.rb

@@ -1,7 +1,9 @@
+require "mobility/backends/sequel/query_methods"
+
 module Mobility
-  module Backend
-    class Sequel::Column::QueryMethods < Backend::Sequel::QueryMethods
-      def initialize(attributes, **)
+  module Backends
+    class Sequel::Column::QueryMethods < Sequel::QueryMethods
+      def initialize(attributes, _)
         super
         attributes_extractor = @attributes_extractor
 

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

@@ -0,0 +1,29 @@
+require 'mobility/backends/sequel/pg_hash'
+
+module Mobility
+  module Backends
+=begin
+
+Implements the {Mobility::Backends::Hstore} backend for Sequel models.
+
+@see Mobility::Backends::Sequel::HashValued
+
+=end
+    class Sequel::Hstore < Sequel::PgHash
+      require 'mobility/backends/sequel/hstore/query_methods'
+
+      # @!group Backend Accessors
+      # @!macro backend_reader
+      # @!method read(locale, **options)
+
+      # @!group Backend Accessors
+      # @!macro backend_writer
+      def write(locale, value, options = {})
+        super(locale, value && value.to_s, options)
+      end
+      # @!endgroup
+
+      setup_query_methods(QueryMethods)
+    end
+  end
+end

data/lib/mobility/{backend → backends}/sequel/hstore/query_methods.rb

@@ -1,13 +1,14 @@
-require 'mobility/backend/sequel/postgres_query_methods'
+require 'mobility/backends/sequel/postgres_query_methods'
+require "mobility/backends/sequel/query_methods"
 
 Sequel.extension :pg_hstore, :pg_hstore_ops
 
 module Mobility
-  module Backend
+  module Backends
     class Sequel::Hstore::QueryMethods < Sequel::QueryMethods
       include PostgresQueryMethods
 
-      def initialize(attributes, **)
+      def initialize(attributes, _)
         super
 
         define_query_methods("hstore")

data/lib/mobility/{backend → backends}/sequel/jsonb.rb

@@ -1,16 +1,16 @@
-require 'mobility/backend/sequel/hash_valued'
+require 'mobility/backends/sequel/pg_hash'
 
 module Mobility
-  module Backend
+  module Backends
 =begin
 
-Implements the {Mobility::Backend::Jsonb} backend for Sequel models.
+Implements the {Mobility::Backends::Jsonb} backend for Sequel models.
 
-@see Mobility::Backend::Sequel::HashValued
+@see Mobility::Backends::Sequel::HashValued
 
 =end
-    class Sequel::Jsonb < Sequel::HashValued
-      require 'mobility/backend/sequel/jsonb/query_methods'
+    class Sequel::Jsonb < Sequel::PgHash
+      require 'mobility/backends/sequel/jsonb/query_methods'
 
       # @!group Backend Accessors
       #

data/lib/mobility/{backend → backends}/sequel/jsonb/query_methods.rb

@@ -1,13 +1,14 @@
-require 'mobility/backend/sequel/postgres_query_methods'
+require 'mobility/backends/sequel/postgres_query_methods'
+require "mobility/backends/sequel/query_methods"
 
 Sequel.extension :pg_json, :pg_json_ops
 
 module Mobility
-  module Backend
+  module Backends
     class Sequel::Jsonb::QueryMethods < Sequel::QueryMethods
       include PostgresQueryMethods
 
-      def initialize(attributes, **)
+      def initialize(attributes, _)
         super
 
         define_query_methods("pg_jsonb")

data/lib/mobility/{backend → backends}/sequel/key_value.rb

@@ -1,10 +1,16 @@
 # frozen-string-literal: true
+require "mobility/util"
+require "mobility/backends/sequel"
+require "mobility/backends/key_value"
+require "mobility/sequel/column_changes"
+require "mobility/sequel/string_translation"
+require "mobility/sequel/text_translation"
 
 module Mobility
-  module Backend
+  module Backends
 =begin
 
-Implements the {Mobility::Backend::KeyValue} backend for Sequel models.
+Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
 
 @note This backend requires the cache to be enabled in order to track
   and store changed translations, since Sequel does not support +build+-type
@@ -14,11 +20,9 @@ Implements the {Mobility::Backend::KeyValue} backend for Sequel models.
     class Sequel::KeyValue
       include Sequel
       include KeyValue
+      include Util
 
-      require 'mobility/backend/sequel/key_value/query_methods'
-
-      # @return [Symbol] name of the association
-      attr_reader :association_name
+      require 'mobility/backends/sequel/key_value/query_methods'
 
       # @return [Class] translation model class
       attr_reader :class_name
@@ -26,27 +30,14 @@ Implements the {Mobility::Backend::KeyValue} backend for Sequel models.
       # @!macro backend_constructor
       # @option options [Symbol] association_name Name of association
       # @option options [Class] class_name Translation model class
-      def initialize(model, attribute, **options)
+      def initialize(model, attribute, options = {})
         super
-        @association_name = options[:association_name]
         @class_name       = options[:class_name]
       end
 
-      # @!group Backend Accessors
-      # @!macro backend_reader
-      def read(locale, **_)
-        translation_for(locale).value
-      end
-
-      # @!macro backend_writer
-      def write(locale, value, **_)
-        translation_for(locale).tap { |t| t.value = value }.value
-      end
-      # @!endgroup
-
       # @!group Backend Configuration
       # @option options [Symbol,String] type (:text) Column type to use
-      # @option options [Symbol] associaiton_name (:mobility_text_translations) Name of association method
+      # @option options [Symbol] associaiton_name (:text_translations) Name of association method
       # @option options [Symbol] class_name ({Mobility::Sequel::TextTranslation}) Translation class
       # @raise [CacheRequired] if cache is disabled
       # @raise [ArgumentError] if type is not either :text or :string
@@ -56,7 +47,7 @@ Implements the {Mobility::Backend::KeyValue} backend for Sequel models.
         type = options[:type]
         options[:class_name] ||= Mobility::Sequel.const_get("#{type.capitalize}Translation".freeze)
         options[:class_name] = options[:class_name].constantize if options[:class_name].is_a?(String)
-        options[:association_name] ||= options[:class_name].table_name.to_sym
+        options[:association_name] ||= :"#{options[:type]}_translations"
         %i[type association_name].each { |key| options[key] = options[key].to_sym }
       end
       # @!endgroup
@@ -82,7 +73,7 @@ Implements the {Mobility::Backend::KeyValue} backend for Sequel models.
         callback_methods = Module.new do
           define_method :before_save do
             super()
-            send(association_name).select { |t| attributes.include?(t.key) && t.value.blank? }.each(&:destroy)
+            send(association_name).select { |t| attributes.include?(t.key) && Util.blank?(t.value) }.each(&:destroy)
           end
           define_method :after_save do
             super()
@@ -112,22 +103,10 @@ Implements the {Mobility::Backend::KeyValue} backend for Sequel models.
 
       setup_query_methods(QueryMethods)
 
-      # @!group Cache Methods
-      # @return [KeyValue::TranslationsCache]
-      def new_cache
-        KeyValue::TranslationsCache.new(self)
-      end
-
-      # @return [Boolean]
-      def write_to_cache?
-        true
-      end
-      # @!endgroup
-
       # 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)
+      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
@@ -135,13 +114,23 @@ Implements the {Mobility::Backend::KeyValue} backend for Sequel models.
 
       # Saves translation which have been built and which have non-blank values.
       def save_translations
-        cache.each_translation do |translation|
-          next unless translation.value.present?
-          translation.id ? translation.save : model.send("add_#{association_name.to_s.singularize}", translation)
+        cache.each_value do |translation|
+          next unless present?(translation.value)
+          translation.id ? translation.save : model.send("add_#{singularize(association_name)}", translation)
         end
       end
 
       class CacheRequired < ::StandardError; end
+
+      module Cache
+        include KeyValue::Cache
+
+        private
+
+        def translations
+          (model.send(association_name) + cache.values).uniq
+        end
+      end
     end
   end
 end