mobility 0.4.3 → 0.5.0

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'mobility/backends/active_record/pg_query_methods'
+require "mobility/backends/active_record/query_methods"
+
+module Mobility
+  module Backends
+    class ActiveRecord::Container::JsonQueryMethods < ActiveRecord::QueryMethods
+      include ActiveRecord::PgQueryMethods
+      attr_reader :column_name, :column
+
+      def initialize(_attributes, options)
+        super
+        @column_name = options[:column_name]
+        @column      = arel_table[@column_name]
+      end
+
+      private
+
+      def matches(key, value, locale)
+        build_infix(:'->>',
+                    build_infix(:'->', column, quote(locale)),
+                    quote(key)).eq(value && value.to_s)
+      end
+
+      def has_locale(key, locale)
+        matches(key, nil, locale).not
+      end
+    end
+  end
+end

data/lib/mobility/backends/active_record/container/{query_methods.rb → jsonb_query_methods.rb}

@@ -1,8 +1,10 @@
-require "mobility/backends/active_record/jsonb"
+# frozen_string_literal: true
+require 'mobility/backends/active_record/pg_query_methods'
+require "mobility/backends/active_record/query_methods"
 
 module Mobility
   module Backends
-    class ActiveRecord::Container::QueryMethods < ActiveRecord::QueryMethods
+    class ActiveRecord::Container::JsonbQueryMethods < ActiveRecord::QueryMethods
       include ActiveRecord::PgQueryMethods
       attr_reader :column_name, :column
 

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

@@ -0,0 +1,36 @@
+require 'mobility/backends/active_record/pg_hash'
+
+module Mobility
+  module Backends
+=begin
+
+Implements the {Mobility::Backends::Json} backend for ActiveRecord models.
+
+@see Mobility::Backends::ActiveRecord::HashValued
+
+=end
+    class ActiveRecord::Json < ActiveRecord::PgHash
+      require 'mobility/backends/active_record/json/query_methods'
+
+      # @!group Backend Accessors
+      #
+      # @note Translation may be string, integer or boolean-valued since
+      #   value is stored on a JSON hash.
+      # @param [Symbol] locale Locale to read
+      # @param [Hash] options
+      # @return [String,Integer,Boolean] Value of translation
+      # @!method read(locale, **options)
+
+      # @!group Backend Accessors
+      # @note Translation may be string, integer or boolean-valued since
+      #   value is stored on a JSON hash.
+      # @param [Symbol] locale Locale to write
+      # @param [String,Integer,Boolean] value Value to write
+      # @param [Hash] options
+      # @return [String,Integer,Boolean] Updated value
+      # @!method write(locale, value, **options)
+
+      setup_query_methods(QueryMethods)
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'mobility/backends/active_record/pg_query_methods'
+require "mobility/backends/active_record/query_methods"
+
+module Mobility
+  module Backends
+    class ActiveRecord::Json::QueryMethods < ActiveRecord::QueryMethods
+      include ActiveRecord::PgQueryMethods
+
+      private
+
+      def matches(key, value, locale)
+        build_locale_infix(key, locale).eq(value.to_s)
+      end
+
+      def has_locale(key, locale)
+        build_locale_infix(key, locale).eq(nil).not
+      end
+
+      def build_locale_infix(key, locale)
+        build_infix(:'->>', arel_table[key], quote(locale))
+      end
+    end
+  end
+end

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

@@ -14,16 +14,16 @@ Implements the {Mobility::Backends::Jsonb} backend for ActiveRecord models.
 
       # @!group Backend Accessors
       #
-      # @note Translation may be string, integer or boolean-valued since
-      #   value is stored on a JSON hash.
+      # @note Translation may be any json type, but querying will only work on
+      #   string-typed values.
       # @param [Symbol] locale Locale to read
       # @param [Hash] options
       # @return [String,Integer,Boolean] Value of translation
       # @!method read(locale, **options)
 
       # @!group Backend Accessors
-      # @note Translation may be string, integer or boolean-valued since
-      #   value is stored on a JSON hash.
+      # @note Translation may be any json type, but querying will only work on
+      #   string-typed values.
       # @param [Symbol] locale Locale to write
       # @param [String,Integer,Boolean] value Value to write
       # @param [Hash] options

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mobility/backends/active_record/pg_query_methods'
 require "mobility/backends/active_record/query_methods"
 

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

@@ -38,7 +38,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
       def self.configure(options)
         super
         type = options[:type]
-        options[:class_name] ||= Mobility::ActiveRecord.const_get("#{type.capitalize}Translation".freeze)
+        options[:class_name] ||= Mobility::ActiveRecord.const_get("#{type.capitalize}Translation")
         options[:class_name] = options[:class_name].constantize if options[:class_name].is_a?(String)
         options[:association_name] ||= :"#{options[:type]}_translations"
         %i[type association_name].each { |key| options[key] = options[key].to_sym }
@@ -103,7 +103,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
         # Clean up *all* leftover translations of this model, only once.
         def mobility_destroy_key_value_translations
           [:string, :text].freeze.each do |type|
-            Mobility::ActiveRecord.const_get("#{type.capitalize}Translation".freeze).
+            Mobility::ActiveRecord.const_get("#{type.capitalize}Translation").
               where(translatable: self).destroy_all
           end
         end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/active_record/query_methods"
 
 module Mobility

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/active_record"
 require "mobility/backends/hash_valued"
 

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

@@ -103,7 +103,7 @@ code.
         end
 
         def build_infix(*args)
-          Arel::Nodes::InfixOperation.new(*args)
+          arel_table.grouping(Arel::Nodes::InfixOperation.new(*args))
         end
 
         def quote(value)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/active_record"
 require "mobility/backends/hash_valued"
 require "mobility/backends/serialized"

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/active_record/query_methods"
 
 module Mobility

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

@@ -101,7 +101,7 @@ columns to that table.
       #   to append to model class to generate translation class
       def self.configure(options)
         table_name = options[:model_class].table_name
-        options[:table_name]  ||= "#{table_name.singularize}_translations".freeze
+        options[:table_name]  ||= "#{table_name.singularize}_translations"
         options[:foreign_key] ||= table_name.downcase.singularize.camelize.foreign_key
         if (association_name = options[:association_name]).present?
           options[:subclass_name] ||= association_name.to_s.singularize.camelize.freeze
@@ -158,7 +158,7 @@ columns to that table.
       setup_query_methods(QueryMethods)
 
       def translation_for(locale, _)
-        translation = translations.find { |t| t.locale == locale.to_s.freeze }
+        translation = translations.find { |t| t.locale == locale.to_s }
         translation ||= translations.build(locale: locale)
         translation
       end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/active_record/query_methods"
 
 module Mobility

data/lib/mobility/backends/column.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
   module Backends
 =begin

data/lib/mobility/backends/json.rb

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

data/lib/mobility/backends/jsonb.rb

@@ -1,6 +1,5 @@
 module Mobility
   module Backends
-
 =begin
 
 Stores translations as hash on Postgres jsonb column.

data/lib/mobility/backends/key_value.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/plugins/cache"
 
 module Mobility

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/sequel"
 require "mobility/backends/column"
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/sequel/query_methods"
 
 module Mobility

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

@@ -8,7 +8,8 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
     class Sequel::Container
       include Sequel
 
-      require 'mobility/backends/sequel/container/query_methods'
+      require 'mobility/backends/sequel/container/json_query_methods'
+      require 'mobility/backends/sequel/container/jsonb_query_methods'
 
       # @return [Symbol] name of container column
       attr_reader :column_name
@@ -47,6 +48,12 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
       # @option options [Symbol] column_name (:translations) Name of column on which to store translations
       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
+        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"
+        end
       end
       # @!endgroup
       #
@@ -57,6 +64,8 @@ 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
@@ -73,9 +82,14 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
 
         plugin :defaults_setter
         attributes.each { |attribute| default_values[attribute.to_sym] = {} }
-      end
 
-      setup_query_methods(QueryMethods)
+        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
 
@@ -94,6 +108,8 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
         end
         translations[locale.to_s][attribute] = value
       end
+
+      class InvalidColumnType < StandardError; end
     end
   end
 end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require "mobility/backends/sequel/pg_query_methods"
+require "mobility/backends/sequel/query_methods"
+
+Sequel.extension :pg_json, :pg_json_ops
+
+module Mobility
+  module Backends
+    class Sequel::Container::JsonQueryMethods < Sequel::QueryMethods
+      include Sequel::PgQueryMethods
+      attr_reader :column_name
+
+      def initialize(attributes, options)
+        super
+        @column_name = options[:column_name]
+        define_query_methods
+      end
+
+      private
+
+      def matches(key, value, locale)
+        build_op(column_name)[locale].get_text(key.to_s) =~ value.to_s
+      end
+
+      def has_locale(key, locale)
+        build_op(column_name)[locale].get_text(key.to_s) !~ nil
+      end
+
+      def build_op(key)
+        ::Sequel.pg_json_op(key)
+      end
+    end
+  end
+end

data/lib/mobility/backends/sequel/container/{query_methods.rb → jsonb_query_methods.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/sequel/pg_query_methods"
 require "mobility/backends/sequel/query_methods"
 
@@ -5,7 +6,7 @@ Sequel.extension :pg_json, :pg_json_ops
 
 module Mobility
   module Backends
-    class Sequel::Container::QueryMethods < Sequel::QueryMethods
+    class Sequel::Container::JsonbQueryMethods < Sequel::QueryMethods
       include Sequel::PgQueryMethods
       attr_reader :column_name
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mobility/backends/sequel/pg_query_methods'
 require "mobility/backends/sequel/query_methods"
 

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

@@ -0,0 +1,36 @@
+require 'mobility/backends/sequel/pg_hash'
+
+module Mobility
+  module Backends
+=begin
+
+Implements the {Mobility::Backends::Json} backend for Sequel models.
+
+@see Mobility::Backends::Sequel::HashValued
+
+=end
+    class Sequel::Json < Sequel::PgHash
+      require 'mobility/backends/sequel/json/query_methods'
+
+      # @!group Backend Accessors
+      #
+      # @note Translation may be any json type, but querying will only work on
+      #   string-typed values.
+      # @param [Symbol] locale Locale to read
+      # @param [Hash] options
+      # @return [String,Integer,Boolean] Value of translation
+      # @!method read(locale, **options)
+
+      # @!group Backend Accessors
+      # @note Translation may be any json type, but querying will only work on
+      #   string-typed values.
+      # @param [Symbol] locale Locale to write
+      # @param [String,Integer,Boolean] value Value to write
+      # @param [Hash] options
+      # @return [String,Integer,Boolean] Updated value
+      # @!method write(locale, value, **options)
+
+      setup_query_methods(QueryMethods)
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require "mobility/backends/sequel/pg_query_methods"
+require "mobility/backends/sequel/query_methods"
+
+Sequel.extension :pg_json, :pg_json_ops
+
+module Mobility
+  module Backends
+    class Sequel::Json::QueryMethods < Sequel::QueryMethods
+      include Sequel::PgQueryMethods
+
+      private
+
+      def matches(key, value, locale)
+        build_op(key).get_text(locale) =~ value.to_s
+      end
+
+      def has_locale(key, locale)
+        build_op(key).get_text(locale) !~ nil
+      end
+
+      def build_op(key)
+        ::Sequel.pg_json_op(key)
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
-require 'mobility/backends/sequel/pg_query_methods'
+# frozen_string_literal: true
+require "mobility/backends/sequel/pg_query_methods"
 require "mobility/backends/sequel/query_methods"
 
 Sequel.extension :pg_json, :pg_json_ops