mobility 0.3.6 → 0.4.0

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

@@ -1,4 +1,4 @@
-require 'mobility/backends/sequel/postgres_query_methods'
+require 'mobility/backends/sequel/pg_query_methods'
 require "mobility/backends/sequel/query_methods"
 
 Sequel.extension :pg_json, :pg_json_ops
@@ -6,12 +6,12 @@ Sequel.extension :pg_json, :pg_json_ops
 module Mobility
   module Backends
     class Sequel::Jsonb::QueryMethods < Sequel::QueryMethods
-      include PostgresQueryMethods
+      include Sequel::PgQueryMethods
 
       def initialize(attributes, _)
         super
 
-        define_query_methods("pg_jsonb")
+        define_query_methods
 
         attributes.each do |attribute|
           define_method :"first_by_#{attribute}" do |value|
@@ -20,6 +20,20 @@ module Mobility
           end
         end
       end
+
+      private
+
+      def contains_value(key, value, locale)
+        build_op(key).contains({ locale => value }.to_json)
+      end
+
+      def has_locale(key, locale)
+        build_op(key).has_key?(locale)
+      end
+
+      def build_op(key)
+        ::Sequel.pg_jsonb_op(key)
+      end
     end
   end
 end

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

@@ -3,6 +3,7 @@ require "mobility/util"
 require "mobility/backends/sequel"
 require "mobility/backends/key_value"
 require "mobility/sequel/column_changes"
+require "mobility/sequel/hash_initializer"
 require "mobility/sequel/string_translation"
 require "mobility/sequel/text_translation"
 
@@ -82,7 +83,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
         end
         include callback_methods
 
-        include Mobility::Sequel::ColumnChanges.new(attributes)
+        include Mobility::Sequel::ColumnChanges.new(*attributes)
 
         private
 

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

@@ -36,11 +36,11 @@ module Mobility
       end
 
       def define_query_methods(association_name)
-        attributes_extractor = @attributes_extractor
+        q = self
 
         %w[exclude or where].each do |method_name|
           define_method method_name do |*conds, &block|
-            if i18n_keys = attributes_extractor.call(conds.first)
+            if i18n_keys = q.extract_attributes(conds.first)
               cond = conds.first.dup
               i18n_nulls = i18n_keys.select { |key| cond[key].nil? }
               i18n_keys.each { |attr| cond[::Sequel[:"#{attr}_#{association_name}"][:value]] = cond.delete(attr) }

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

@@ -27,11 +27,7 @@ jsonb).
       end
 
       setup do |attributes|
-        method_overrides = Module.new do
-          define_method :initialize_set do |values|
-            attributes.each { |attribute| self[attribute.to_sym] = {} }
-            super(values)
-          end
+        before_validation = Module.new do
           define_method :before_validation do
             attributes.each do |attribute|
               self[attribute.to_sym].delete_if { |_, v| Util.blank?(v) }
@@ -39,8 +35,9 @@ jsonb).
             super()
           end
         end
-        include method_overrides
-        include Mobility::Sequel::ColumnChanges.new(attributes)
+        include before_validation
+        include Mobility::Sequel::HashInitializer.new(*attributes)
+        include Mobility::Sequel::ColumnChanges.new(*attributes)
 
         plugin :defaults_setter
         attributes.each { |attribute| default_values[attribute.to_sym] = {} }

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

@@ -0,0 +1,85 @@
+module Mobility
+  module Backends
+    module Sequel
+=begin
+
+Defines query methods for Postgres backends. Including class must define two
+private methods:
+
+- a private method +contains_value+ which takes a key (column name), value and
+  locale and returns an SQL expression, and checks that the column has the
+  specified value in the specified locale
+- a private method +has_locale+ which takes a key (column name) and locale, and
+  returns an SQL expression which checks that the column has a value in the
+  locale
+
+(The +contains_value+ method is implemented slightly differently for hstore and
+jsonb columns.)
+
+=end
+      module PgQueryMethods
+
+        # Create query for conditions and translated keys
+        # @note This is a destructive action, it will alter +cond+.
+        #
+        # @param [Hash] cond Hash of attribute/value pairs
+        # @param [Array] keys Translated attribute names
+        # @param [Boolean] invert Invert query, true for +exclude+, false otherwise
+        # @return [Sequel::SQL::Expression] Query expression
+        def create_query!(cond, keys, invert = false)
+          keys.map { |key|
+            values = cond.delete(key)
+            values = [values] unless values.is_a?(Array)
+            values.map { |value| create_query_op(key, value, invert) }.inject(&:|)
+          }.inject(invert ? :| : :&)
+        end
+
+        private
+
+        def define_query_methods
+          %w[exclude or where].each do |method_name|
+            define_query_method(method_name)
+          end
+        end
+
+        def define_query_method(method_name)
+          q = self
+
+          define_method method_name do |*cond, &block|
+            if i18n_keys = q.extract_attributes(cond.first)
+              cond = cond.first
+
+              query = q.create_query!(cond, i18n_keys, method_name == "exclude")
+              if method_name == "or"
+                query = ::Sequel.&(cond, query) unless cond.empty?
+                super(query, &block)
+              else
+                super(cond, &block).where(query)
+              end
+            else
+              super(*cond, &block)
+            end
+          end
+        end
+
+        def create_query_op(key, value, invert)
+          locale = Mobility.locale.to_s
+
+          if invert
+            has_locale(key, locale) & ~contains_value(key, value, locale)
+          else
+            value.nil? ? ~has_locale(key, locale) : contains_value(key, value, locale)
+          end
+        end
+
+        def contains_value(_key, _value, _locale)
+          raise NotImplementedError
+        end
+
+        def has_locale(_key, _locale)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -13,9 +13,10 @@ models. For details see backend-specific subclasses.
         # @param [Array<String>] attributes Translated attributes
         def initialize(attributes, _)
           @attributes = attributes.map!(&:to_sym)
-          @attributes_extractor = lambda do |cond|
-            cond.is_a?(Hash) && Util.presence(cond.keys & attributes)
-          end
+        end
+
+        def extract_attributes(cond)
+          cond.is_a?(Hash) && Util.presence(cond.keys & @attributes)
         end
       end
     end

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

@@ -3,13 +3,14 @@ require "mobility/backends/sequel/query_methods"
 module Mobility
   module Backends
     class Sequel::Serialized::QueryMethods < Sequel::QueryMethods
+      include Serialized
+
       def initialize(attributes, _)
         super
-        attributes_extractor = @attributes_extractor
-        cond_checker = Backends::Serialized.attr_checker(attributes_extractor)
+        q = self
 
         define_method :where do |*cond, &block|
-          cond_checker.call(cond.first) || super(*cond, &block)
+          q.check_opts(cond.first) || super(*cond, &block)
         end
       end
     end

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

@@ -83,7 +83,7 @@ Implements the {Mobility::Backends::Table} backend for Sequel models.
         end
         include callback_methods
 
-        include Mobility::Sequel::ColumnChanges.new(attributes)
+        include Mobility::Sequel::ColumnChanges.new(*attributes)
       end
 
       setup_query_methods(QueryMethods)

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

@@ -35,14 +35,14 @@ module Mobility
       end
 
       def define_query_methods(association_name, translation_class, **)
-        attributes_extractor = @attributes_extractor
+        q = self
 
         # See note in AR Table QueryMethods class about limitations of
         # query methods on translated attributes when searching on nil values.
         #
         %w[exclude or where].each do |method_name|
           define_method method_name do |*conds, &block|
-            if i18n_keys = attributes_extractor.call(conds.first)
+            if i18n_keys = q.extract_attributes(conds.first)
               cond = conds.first.dup
               outer_join = method_name == "or" || i18n_keys.all? { |key| cond[key].nil? }
               i18n_keys.each { |attr| cond[::Sequel[translation_class.table_name][attr]] = cond.delete(attr) }

data/lib/mobility/backends/serialized.rb

@@ -60,14 +60,12 @@ Format for serialization. Either +:yaml+ (default) or +:json+.
             lambda { |v| JSON.parse(v, symbolize_names: true) }
           end
         end
+      end
 
-        def attr_checker(attributes_extractor)
-          lambda do |cond|
-            if keys = attributes_extractor.call(cond)
-              raise ArgumentError,
-                "You cannot query on mobility attributes translated with the Serialized backend (#{keys.join(", ")})."
-            end
-          end
+      def check_opts(opts)
+        if keys = extract_attributes(opts)
+          raise ArgumentError,
+            "You cannot query on mobility attributes translated with the Serialized backend (#{keys.join(", ")})."
         end
       end
     end

data/lib/mobility/configuration.rb

@@ -45,12 +45,42 @@ Set each option on the default_options hash instead, like this:
     # @return [Array<Symbol>]
     attr_accessor :plugins
 
-    # Default fallbacks instance
+    # Generate new fallbacks instance
+    # @note This method will call the proc defined in the variable set by the
+    # +fallbacks_generator=+ setter, passing the first argument to its `call`
+    # method. By default the generator returns an instance of
+    # +I18n::Locale::Fallbacks+.
+    # @param fallbacks [Hash] Fallbacks hash passed to generator
     # @return [I18n::Locale::Fallbacks]
+    def new_fallbacks(fallbacks = {})
+      @fallbacks_generator.call(fallbacks)
+    end
+
+    # Assign proc which, passed a set of fallbacks, returns a default fallbacks
+    # instance. By default this is a proc which takes fallbacks and returns an
+    # instance of +I18n::Locale::Fallbacks+.
+    # @param [Proc] fallbacks generator
+    attr_writer :fallbacks_generator
+
+    # @deprecated Use {#new_fallbacks} instead.
     def default_fallbacks(fallbacks = {})
-      @default_fallbacks.call(fallbacks)
+      warn %{
+WARNING: The default_fallbacks configuration getter has been renamed
+new_fallbacks to avoid confusion. The original method default_fallbacks will be
+removed in the next major version of Mobility.
+}
+      new_fallbacks(fallbacks)
+    end
+
+    # @deprecated Use {#fallbacks_generator=} instead.
+    def default_fallbacks=(fallbacks)
+      warn %{
+WARNING: The default_fallbacks= configuration setter has been renamed
+fallbacks_generator= to avoid confusion. The original method
+default_fallbacks= will be removed in the next major version of Mobility.
+}
+      self.fallbacks_generator = fallbacks
     end
-    attr_writer :default_fallbacks
 
     # Default backend to use (can be symbol or actual backend class)
     # @return [Symbol,Class]
@@ -71,7 +101,7 @@ Set each option on the default_options hash instead, like this:
     def initialize
       @accessor_method = :translates
       @query_method = :i18n
-      @default_fallbacks = lambda { |fallbacks| I18n::Locale::Fallbacks.new(fallbacks) }
+      @fallbacks_generator = lambda { |fallbacks| I18n::Locale::Fallbacks.new(fallbacks) }
       @default_accessor_locales = lambda { I18n.available_locales }
       @default_options = Options[{
         cache: true,

data/lib/mobility/plugins/active_record/dirty.rb

@@ -9,7 +9,7 @@ module Mobility
 Dirty tracking for AR models. See {Mobility::Plugins::ActiveModel::Dirty} for
 details on usage.
 
-In addition to methods added by {Mobility::Plugins::ActiveModel::Diryt}, the
+In addition to methods added by {Mobility::Plugins::ActiveModel::Dirty}, the
 AR::Dirty plugin adds support for the following persistence-specific methods
 (for a model with a translated attribute +title+):
 - +saved_changes+

data/lib/mobility/plugins/fallbacks.rb

@@ -8,12 +8,14 @@ Falls back to one or more alternative locales in case no value is defined for a
 given locale.
 
 For +fallbacks: true+, Mobility will use the value of
-{Mobility::Configuration#default_fallbacks} for the fallbacks instance. This
-defaults to an instance of +I18n::Locale::Fallbacks+, but can be configured
-(see {Mobility::Configuration}).
+{Mobility::Configuration#new_fallbacks} for the fallbacks instance. This
+defaults to an instance of +I18n::Locale::Fallbacks+, but can be
+configured (see {Mobility::Configuration}).
 
 If a hash is passed to the +fallbacks+ option, a new fallbacks instance will be
-created for the model with the hash defining additional fallbacks. 
+created for the model with the hash defining additional fallbacks. To set a
+default value for this hash, use set the value of `default_options[:fallbacks]`
+in your Mobility configuration (see below).
 
 In addition, fallbacks are disabled in certain situation. To explicitly disable
 fallbacks when reading and writing, you can pass the <tt>fallback: false</tt>
@@ -102,6 +104,18 @@ the current locale was +nil+.
   post.title_fr
   #=> nil
 
+@example Setting default fallbacks across all models
+  Mobility.configure do |config|
+    # ...
+    config.default_options[:fallbacks] = { :'fr' => 'en' }
+    # ...
+  end
+
+  class Post
+    # Post will fallback from French to English by default
+    translates :title, fallbacks: true
+  end
+
 =end
     class Fallbacks < Module
       # Applies fallbacks plugin to attributes.
@@ -133,9 +147,9 @@ the current locale was +nil+.
 
       def convert_option_to_fallbacks(option)
         if option.is_a?(Hash)
-          Mobility.default_fallbacks(option)
+          Mobility.new_fallbacks(option)
         elsif option == true
-          Mobility.default_fallbacks
+          Mobility.new_fallbacks
         else
           Hash.new { [] }
         end

data/lib/mobility/sequel/column_changes.rb

@@ -8,17 +8,14 @@ setter method is called.
 =end
     class ColumnChanges < Module
       # @param [Array<String>] attributes Backend attributes
-      def initialize(attributes)
-        @attributes = attributes
-
+      def initialize(*attributes)
         attributes.each do |attribute|
           define_method "#{attribute}=".freeze do |value, **options|
             if !options[:super] && send(attribute) != value
               locale = options[:locale] || Mobility.locale
               column = attribute.to_sym
               column_with_locale = :"#{attribute}_#{Mobility.normalize_locale(locale)}"
-              @changed_columns << column_with_locale if !changed_columns.include?(column_with_locale)
-              @changed_columns << column             if !changed_columns.include?(column)
+              @changed_columns = changed_columns | [column, column_with_locale]
             end
             super(value, **options)
           end

data/lib/mobility/sequel/hash_initializer.rb

@@ -0,0 +1,19 @@
+module Mobility
+  module Sequel
+=begin
+
+Internal class used to initialize column value(s) by default to a hash.
+
+=end
+    class HashInitializer < Module
+      def initialize(*columns)
+        class_eval <<-EOM, __FILE__, __LINE__ + 1
+          def initialize_set(values)
+            #{columns.map { |c| "self[:#{c}] = {}" }.join(';')}
+            super
+          end
+        EOM
+      end
+    end
+  end
+end

data/lib/mobility/util.rb

@@ -1,5 +1,3 @@
-require "singleton"
-
 module Mobility
 =begin
 

data/lib/mobility/version.rb

@@ -1,3 +1,3 @@
 module Mobility
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Salzberg
@@ -30,7 +30,7 @@ cert_chain:
   eGDROPZoL5RXwiOnRbexxa7dcAxMrDfGB/hpiunIPWPsi4n5P7K/6OO/sGVMl9xv
   SZBPXjzrHdyOFLBYXB+PG7s3F/4=
   -----END CERTIFICATE-----
-date: 2017-12-25 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -184,6 +184,8 @@ files:
 - lib/mobility/backends/active_record.rb
 - lib/mobility/backends/active_record/column.rb
 - lib/mobility/backends/active_record/column/query_methods.rb
+- lib/mobility/backends/active_record/container.rb
+- lib/mobility/backends/active_record/container/query_methods.rb
 - lib/mobility/backends/active_record/hstore.rb
 - lib/mobility/backends/active_record/hstore/query_methods.rb
 - lib/mobility/backends/active_record/jsonb.rb
@@ -191,12 +193,14 @@ files:
 - lib/mobility/backends/active_record/key_value.rb
 - lib/mobility/backends/active_record/key_value/query_methods.rb
 - lib/mobility/backends/active_record/pg_hash.rb
+- lib/mobility/backends/active_record/pg_query_methods.rb
 - lib/mobility/backends/active_record/query_methods.rb
 - lib/mobility/backends/active_record/serialized.rb
 - lib/mobility/backends/active_record/serialized/query_methods.rb
 - lib/mobility/backends/active_record/table.rb
 - lib/mobility/backends/active_record/table/query_methods.rb
 - lib/mobility/backends/column.rb
+- lib/mobility/backends/container.rb
 - lib/mobility/backends/hash_valued.rb
 - lib/mobility/backends/hstore.rb
 - lib/mobility/backends/jsonb.rb
@@ -205,6 +209,8 @@ files:
 - lib/mobility/backends/sequel.rb
 - lib/mobility/backends/sequel/column.rb
 - lib/mobility/backends/sequel/column/query_methods.rb
+- lib/mobility/backends/sequel/container.rb
+- lib/mobility/backends/sequel/container/query_methods.rb
 - lib/mobility/backends/sequel/hstore.rb
 - lib/mobility/backends/sequel/hstore/query_methods.rb
 - lib/mobility/backends/sequel/jsonb.rb
@@ -212,7 +218,7 @@ files:
 - lib/mobility/backends/sequel/key_value.rb
 - lib/mobility/backends/sequel/key_value/query_methods.rb
 - lib/mobility/backends/sequel/pg_hash.rb
-- lib/mobility/backends/sequel/postgres_query_methods.rb
+- lib/mobility/backends/sequel/pg_query_methods.rb
 - lib/mobility/backends/sequel/query_methods.rb
 - lib/mobility/backends/sequel/serialized.rb
 - lib/mobility/backends/sequel/serialized/query_methods.rb
@@ -242,6 +248,7 @@ files:
 - lib/mobility/sequel.rb
 - lib/mobility/sequel/backend_resetter.rb
 - lib/mobility/sequel/column_changes.rb
+- lib/mobility/sequel/hash_initializer.rb
 - lib/mobility/sequel/model_translation.rb
 - lib/mobility/sequel/string_translation.rb
 - lib/mobility/sequel/text_translation.rb
@@ -276,7 +283,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.7
+      version: 2.2.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="