mobility 0.7.6 → 0.8.0

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

@@ -126,10 +126,10 @@ columns to that table.
         # query.
         # @param [ActiveRecord::Relation] relation Relation to scope
         # @param [Object] predicate Arel predicate
-        # @param [Symbol] locale Locale
+        # @param [Symbol] locale (Mobility.locale) Locale
         # @option [Boolean] invert
         # @return [ActiveRecord::Relation] relation Relation with joins applied (if needed)
-        def apply_scope(relation, predicate, locale, invert: false)
+        def apply_scope(relation, predicate, locale = Mobility.locale, invert: false)
           visitor = Visitor.new(self, locale)
           if join_type = visitor.accept(predicate)
             join_type &&= Visitor::INNER_JOIN if invert
@@ -141,10 +141,6 @@ columns to that table.
 
         private
 
-        def table_alias(locale)
-          "#{table_name}_#{Mobility.normalize_locale(locale)}"
-        end
-
         def join_translations(relation, locale, join_type)
           return relation if already_joined?(relation, locale, join_type)
           m = model_class.arel_table
@@ -179,7 +175,10 @@ columns to that table.
       #   end
       #
       #   backend_class = Post.mobility_backend_class(:title)
-      #   visitor = Mobility::Backends::ActiveRecord::Table::Visitor.new(backend_class)
+      #   visitor = Mobility::Backends::ActiveRecord::Table::Visitor.new(backend_class, :en)
+      #
+      #   title   = backend_class.build_node("title", :en)   # arel node for title
+      #   content = backend_class.build_node("content", :en) # arel node for content
       #
       #   visitor.accept(title.eq(nil).and(content.eq(nil)))
       #   #=> Arel::Nodes::OuterJoin

data/lib/mobility/backends/column.rb

@@ -6,7 +6,7 @@ module Mobility
 
 Stores translated attribute as a column on the model table. To use this
 backend, ensure that the model table has columns named +<attribute>_<locale>+
-for every locale in +I18n.available_locales+.
+for every locale in +Mobility.available_locales+ (i.e. +I18n.available_locales+).
 
 If you are using Rails, you can use the +mobility:translations+ generator to
 create a migration adding these columns to the model table with:
@@ -14,7 +14,7 @@ create a migration adding these columns to the model table with:
   rails generate mobility:translations post title:string
 
 The generated migration will add columns +title_<locale>+ for every locale in
-+I18n.available_locales+. (The generator can be run again to add new attributes
++Mobility.available_locales+. (The generator can be run again to add new attributes
 or locales.)
 
 ==Backend Options

data/lib/mobility/backends/key_value.rb

@@ -81,6 +81,7 @@ other backends on model (otherwise one will overwrite the other).
         backend_class.extend ClassMethods
         backend_class.option_reader :association_name
         backend_class.option_reader :class_name
+        backend_class.option_reader :table_alias_affix
       end
 
       module ClassMethods
@@ -119,6 +120,10 @@ each translated model, or set a default option in your configuration.
             super
           end
         end
+
+        def table_alias(attr, locale)
+          table_alias_affix % "#{attr}_#{Mobility.normalize_locale(locale)}"
+        end
       end
 
       module Cache

data/lib/mobility/backends/sequel.rb

@@ -1,19 +1,32 @@
 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)
+        backend_class.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # @param [Symbol] name Attribute name
+        # @param [Symbol] locale Locale
+        def [](name, locale)
+          build_op(name.to_s, locale)
+        end
+
+        # @param [String] _attr Attribute name
+        # @param [Symbol] _locale Locale
+        # @return Op for this translated attribute
+        def build_op(_attr, _locale)
+          raise NotImplementedError
+        end
+
+        # @param [Sequel::Dataset] dataset Dataset to prepare
+        # @param [Object] predicate Predicate
+        # @param [Symbol] locale Locale
+        # @return [Sequel::Dataset] Prepared dataset
+        def prepare_dataset(dataset, _predicate, _locale)
+          dataset
+        end
       end
     end
   end

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

@@ -13,8 +13,6 @@ Implements the {Mobility::Backends::Column} backend for Sequel models.
       include Sequel
       include Column
 
-      require 'mobility/backends/sequel/column/query_methods'
-
       # @!group Backend Accessors
       # @!macro backend_reader
       def read(locale, _options = nil)
@@ -34,7 +32,10 @@ Implements the {Mobility::Backends::Column} backend for Sequel models.
         available_locales.each { |l| yield(l) if present?(l) }
       end
 
-      setup_query_methods(QueryMethods)
+      def self.build_op(attr, locale)
+        ::Sequel::SQL::QualifiedIdentifier.new(model_class.table_name,
+                                               Column.column_name_for(attr, locale))
+      end
 
       private
 

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

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+require "mobility/backends/sequel/json"
+require "mobility/backends/sequel/jsonb"
+
 module Mobility
   module Backends
 =begin
@@ -8,9 +12,6 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
     class Sequel::Container
       include Sequel
 
-      require 'mobility/backends/sequel/container/json_query_methods'
-      require 'mobility/backends/sequel/container/jsonb_query_methods'
-
       # @!method column_name
       #   @return [Symbol] (:translations) Name of translations column
       option_reader :column_name
@@ -58,8 +59,6 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
         end
       end
 
-      backend_class = self
-
       setup do |attributes, options|
         column_name = options[:column_name]
         before_validation = Module.new do
@@ -76,13 +75,6 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
 
         plugin :defaults_setter
         attributes.each { |attribute| default_values[attribute.to_sym] = {} }
-
-        query_methods = backend_class.const_get("#{options[:column_type].capitalize}QueryMethods")
-        extend(Module.new do
-          define_method ::Mobility.query_method do
-            super().with_extend(query_methods.new(attributes, options))
-          end
-        end)
       end
 
       private
@@ -104,6 +96,23 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
       end
 
       class InvalidColumnType < StandardError; end
+
+      # @param [Symbol] name Attribute name
+      # @param [Symbol] locale Locale
+      # @return [Mobility::Backends::Sequel::Container::JSONOp,Mobility::Backends::Sequel::Container::JSONBOp]
+      def self.build_op(attr, locale)
+        klass = const_get("#{options[:column_type].upcase}Op")
+        klass.new(klass.new(column_name.to_sym)[locale.to_s]).get_text(attr)
+      end
+
+      class JSONOp < ::Sequel::Postgres::JSONOp; end
+
+      class JSONBOp < Jsonb::JSONBOp
+        def to_question
+          left = @value.args[0].value
+          JSONBOp === left ? ::Sequel.&(super, left.to_question) : super
+        end
+      end
     end
   end
 end

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

@@ -1,5 +1,7 @@
 require 'mobility/backends/sequel/pg_hash'
 
+Sequel.extension :pg_hstore, :pg_hstore_ops
+
 module Mobility
   module Backends
 =begin
@@ -11,8 +13,6 @@ Implements the {Mobility::Backends::Hstore} backend for Sequel models.
 =end
     module Sequel
       class Hstore < PgHash
-        require 'mobility/backends/sequel/hstore/query_methods'
-
         # @!group Backend Accessors
         # @!macro backend_reader
         # @!method read(locale, options = {})
@@ -24,7 +24,15 @@ Implements the {Mobility::Backends::Hstore} backend for Sequel models.
         end
         # @!endgroup
 
-        setup_query_methods(QueryMethods)
+        # @param [Symbol] name Attribute name
+        # @param [Symbol] locale Locale
+        # @return [Mobility::Backends::Sequel::Hstore::HStoreOp]
+        def self.build_op(attr, locale)
+          column_name = column_affix % attr
+          HStoreOp.new(column_name.to_sym)[locale.to_s]
+        end
+
+        class HStoreOp < ::Sequel::Postgres::HStoreOp; end
       end
     end
   end

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

@@ -1,5 +1,7 @@
 require 'mobility/backends/sequel/pg_hash'
 
+Sequel.extension :pg_json, :pg_json_ops
+
 module Mobility
   module Backends
 =begin
@@ -11,8 +13,6 @@ Implements the {Mobility::Backends::Json} backend for Sequel models.
 =end
     module Sequel
       class Json < PgHash
-        require 'mobility/backends/sequel/json/query_methods'
-
         # @!group Backend Accessors
         #
         # @!method read(locale, options = {})
@@ -31,7 +31,15 @@ Implements the {Mobility::Backends::Json} backend for Sequel models.
         #   @return [String,Integer,Boolean] Updated value
         # @!endgroup
 
-        setup_query_methods(QueryMethods)
+        # @param [Symbol] name Attribute name
+        # @param [Symbol] locale Locale
+        # @return [Mobility::Backends::Sequel::Json::JSONOp]
+        def self.build_op(attr, locale)
+          column_name = column_affix % attr
+          JSONOp.new(column_name.to_sym).get_text(locale.to_s)
+        end
+
+        class JSONOp < ::Sequel::Postgres::JSONOp; end
       end
     end
   end

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

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
 require 'mobility/backends/sequel/pg_hash'
 
+Sequel.extension :pg_json, :pg_json_ops
+
 module Mobility
   module Backends
 =begin
@@ -11,8 +14,6 @@ Implements the {Mobility::Backends::Jsonb} backend for Sequel models.
 =end
     module Sequel
       class Jsonb < PgHash
-        require 'mobility/backends/sequel/jsonb/query_methods'
-
         # @!group Backend Accessors
         #
         # @!method read(locale, **options)
@@ -31,7 +32,38 @@ Implements the {Mobility::Backends::Jsonb} backend for Sequel models.
         #   @return [String,Integer,Boolean] Updated value
         # @!endgroup
 
-        setup_query_methods(QueryMethods)
+        # @param [Symbol] name Attribute name
+        # @param [Symbol] locale Locale
+        # @return [Mobility::Backends::Sequel::Jsonb::JSONBOp]
+        def self.build_op(attr, locale)
+          column_name = column_affix % attr
+          JSONBOp.new(column_name.to_sym).get_text(locale.to_s)
+        end
+
+        class JSONBOp < ::Sequel::Postgres::JSONBOp
+          def to_dash_arrow
+            column = @value.args[0].value
+            locale = @value.args[1]
+            ::Sequel.pg_jsonb_op(column)[locale]
+          end
+
+          def to_question
+            column = @value.args[0].value
+            locale = @value.args[1]
+            ::Sequel.pg_jsonb_op(column).has_key?(locale)
+          end
+
+          def =~(other)
+            case other
+            when Integer, Hash
+              to_dash_arrow =~ other.to_json
+            when NilClass
+              ~to_question
+            else
+              super
+            end
+          end
+        end
       end
     end
   end

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

@@ -6,6 +6,7 @@ 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
@@ -23,23 +24,104 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
       include KeyValue
       include Util
 
-      require 'mobility/backends/sequel/key_value/query_methods'
-
-      # @!group Backend Configuration
-      # @option (see Mobility::Backends::KeyValue::ClassMethods#configure)
-      # @raise (see Mobility::Backends::KeyValue::ClassMethods#configure)
-      # @raise [CacheRequired] if cache is disabled
-      def self.configure(options)
-        raise CacheRequired, "Cache required for Sequel::KeyValue backend" if options[:cache] == false
-        super
-        if type = options[:type]
-          options[:association_name] ||= :"#{options[:type]}_translations"
-          options[:class_name]       ||= Mobility::Sequel.const_get("#{type.capitalize}Translation")
+      class << self
+        # @!group Backend Configuration
+        # @option (see Mobility::Backends::KeyValue::ClassMethods#configure)
+        # @raise (see Mobility::Backends::KeyValue::ClassMethods#configure)
+        # @raise [CacheRequired] if cache is disabled
+        def configure(options)
+          raise CacheRequired, "Cache required for Sequel::KeyValue backend" if options[:cache] == false
+          super
+          if type = options[:type]
+            options[:association_name] ||= :"#{options[:type]}_translations"
+            options[:class_name]       ||= Mobility::Sequel.const_get("#{type.capitalize}Translation")
+          end
+          options[:table_alias_affix] = "#{options[: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)
+        end
+
+        # @param [Sequel::Dataset] dataset Dataset to prepare
+        # @param [Object] predicate Predicate
+        # @param [Symbol] locale Locale
+        # @return [Sequel::Dataset] Prepared dataset
+        def prepare_dataset(dataset, predicate, locale)
+          visit(predicate, locale).inject(dataset) do |ds, (attr, join_type)|
+            join_translations(ds, attr, locale, join_type)
+          end
+        end
+
+        private
+
+        def join_translations(dataset, attr, locale, join_type)
+          dataset.join_table(join_type,
+                             class_name.table_name,
+                             {
+                               key: attr.to_s,
+                               locale: locale.to_s,
+                               translatable_type: model_class.name,
+                               translatable_id: ::Sequel[:"#{model_class.table_name}"][:id]
+                             },
+                             table_alias: table_alias(attr, locale))
+        end
+
+        # @return [Hash] Hash of attribute/join_type pairs
+        def visit(predicate, locale)
+          case predicate
+          when Array
+            visit_collection(predicate, locale)
+          when ::Mobility::Sequel::SQL::QualifiedIdentifier
+            visit_sql_identifier(predicate, locale)
+          when ::Sequel::SQL::BooleanExpression
+            visit_boolean(predicate, locale)
+          when ::Sequel::SQL::Expression
+            visit(predicate.args, locale)
+          else
+            {}
+          end
+        end
+
+        def visit_boolean(boolean, locale)
+          if boolean.op == :IS
+            nils, ops = boolean.args.partition(&:nil?)
+            if hash = visit(ops, locale)
+              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] }]
+            else
+              {}
+            end
+          elsif boolean.op == :OR
+            hash = boolean.args.map { |op| visit(op, locale) }.
+              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] }]
+          else
+            visit(boolean.args, locale)
+          end
+        end
+
+        def visit_collection(collection, locale)
+          collection.map { |p| visit(p, locale) }.compact.inject do |hash, visited|
+            visited.merge(hash) { |_, old, new| old == :inner ? old : new }
+          end
+        end
+
+        def visit_sql_identifier(identifier, locale)
+          if identifier.backend_class == self && identifier.locale == locale
+            { identifier.attribute_name => :inner }
+          else
+            {}
+          end
         end
-      rescue NameError
-        raise ArgumentError, "You must define a Mobility::Sequel::#{type.capitalize}Translation class."
       end
-      # @!endgroup
 
       setup do |attributes, options|
         association_name   = options[:association_name]
@@ -75,8 +157,6 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
         include Mobility::Sequel::ColumnChanges.new(attributes)
       end
 
-      setup_query_methods(QueryMethods)
-
       # Returns translation for a given locale, or initializes one if none is present.
       # @param [Symbol] locale
       # @return [Mobility::Sequel::TextTranslation,Mobility::Sequel::StringTranslation]