mobility 0.6.0 → 0.7.0

data/lib/mobility/plugins/fallbacks.rb

@@ -18,7 +18,7 @@ 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
+In addition, fallbacks are disabled in certain situations. To explicitly disable
 fallbacks when reading and writing, you can pass the <tt>fallback: false</tt>
 option to the reader method. This can be useful to determine the actual
 value of the translated attribute, including a possible +nil+ value.

data/lib/mobility/plugins/locale_accessors.rb

@@ -56,28 +56,32 @@ If no locales are passed as an option to the initializer,
         warning_message = "locale passed as option to locale accessor will be ignored"
         normalized_locale = Mobility.normalize_locale(locale)
 
-        define_method "#{name}_#{normalized_locale}" do |**options|
+        module_eval <<-EOM, __FILE__, __LINE__ + 1
+        def #{name}_#{normalized_locale}(options = {})
           return super() if options.delete(:super)
-          warn warning_message if options[:locale]
-          public_send(name, **options, locale: locale)
+          warn "#{warning_message}" if options[:locale]
+          #{name}(**options, locale: :'#{locale}')
         end
 
-        define_method "#{name}_#{normalized_locale}?" do |**options|
+        def #{name}_#{normalized_locale}?(options = {})
           return super() if options.delete(:super)
-          warn warning_message if options[:locale]
-          public_send("#{name}?", **options, locale: locale)
+          warn "#{warning_message}" if options[:locale]
+          #{name}?(**options, locale: :'#{locale}')
         end
+        EOM
       end
 
       def define_writer(name, locale)
         warning_message = "locale passed as option to locale accessor will be ignored"
         normalized_locale = Mobility.normalize_locale(locale)
 
-        define_method "#{name}_#{normalized_locale}=" do |value, **options|
+        module_eval <<-EOM, __FILE__, __LINE__ + 1
+        def #{name}_#{normalized_locale}=(value, options = {})
           return super(value) if options.delete(:super)
-          warn warning_message if options[:locale]
-          public_send("#{name}=", value, **options, locale: locale)
+          warn "#{warning_message}" if options[:locale]
+          public_send(:#{name}=, value, **options, locale: :'#{locale}')
         end
+        EOM
       end
     end
   end

data/lib/mobility/plugins/presence.rb

@@ -8,6 +8,9 @@ module Mobility
 Applies presence filter to values fetched from backend and to values set on
 backend. Included by default, but can be disabled with +presence: false+ option.
 
+@note For performance reasons, the presence plugin filters only for empty
+  strings, not other values continued "blank" like empty arrays.
+
 =end
     module Presence
       # Applies presence plugin to attributes.
@@ -17,23 +20,28 @@ backend. Included by default, but can be disabled with +presence: false+ option.
         attributes.backend_class.include(self) if option
       end
 
-      # @group Backend Accessors
+      # @!group Backend Accessors
       # @!macro backend_reader
       # @option options [Boolean] presence
       #   *false* to disable presence filter.
       def read(locale, **options)
-        return super if options.delete(:presence) == false
-        value = super
-        value == false ? value : Util.presence(value)
+        options.delete(:presence) == false ? super : Presence[super]
       end
 
-      # @group Backend Accessors
       # @!macro backend_writer
       # @option options [Boolean] presence
       #   *false* to disable presence filter.
       def write(locale, value, **options)
-        return super if options.delete(:presence) == false
-        super(locale, value == false ? value : Util.presence(value), options)
+        if options.delete(:presence) == false
+          super
+        else
+          super(locale, Presence[value], options)
+        end
+      end
+      # @!endgroup
+
+      def self.[](value)
+        (value == "") ? nil : value
       end
     end
   end

data/lib/mobility/plugins/query.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Mobility
+  module Plugins
+=begin
+
+@see {Mobility::Plugins::ActiveRecord::Query}
+
+=end
+    module Query
+      class << self
+        def apply(attributes, option)
+          if option
+            include_query_module(attributes)
+          end
+        end
+
+        private
+
+        def include_query_module(attributes)
+          if Loaded::ActiveRecord && attributes.model_class < ::ActiveRecord::Base
+            require "mobility/plugins/active_record/query"
+            ActiveRecord::Query.apply(attributes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mobility/translates.rb

@@ -44,22 +44,22 @@ passed to accessors to configure backend (see example below).
 =end
   module Translates
     # Defines mobility accessor on model class.
-    # @param [Array<String>] attributes
-    # @param [Hash] options
-    # @yield Yields to block with backend as context
     # @!method mobility_accessor(*attributes, **options)
+    #   @param [Array<String>] attributes
+    #   @param [Hash] options
+    #   @yield Yields to block with backend as context
 
     # Defines mobility reader and presence method on model class.
-    # @param [Array<String>] attributes
-    # @param [Hash] options
-    # @yield Yields to block with backend as context
     # @!method mobility_reader(*attributes, **options)
+    #   @param [Array<String>] attributes
+    #   @param [Hash] options
+    #   @yield Yields to block with backend as context
 
     # Defines mobility writer on model class.
-    # @param [Array<String>] attributes
-    # @param [Hash] options
-    # @yield Yields to block with backend as context
     # @!method mobility_writer(*attributes, **options)
+    #   @param [Array<String>] attributes
+    #   @param [Hash] options
+    #   @yield Yields to block with backend as context
     %w[accessor reader writer].each do |method|
       class_eval <<-EOM, __FILE__, __LINE__ + 1
         def mobility_#{method}(*args, **options, &block)

data/lib/mobility/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mobility
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/rails/generators/mobility/templates/initializer.rb

@@ -21,6 +21,7 @@ Mobility.configure do |config|
   # ignored by models. (In most cases, you probably don't want to change this.)
   #
   # config.plugins = %i[
+  #   query
   #   cache
   #   dirty
   #   fallbacks

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chris Salzberg
@@ -30,7 +30,7 @@ cert_chain:
   eGDROPZoL5RXwiOnRbexxa7dcAxMrDfGB/hpiunIPWPsi4n5P7K/6OO/sGVMl9xv
   SZBPXjzrHdyOFLBYXB+PG7s3F/4=
   -----END CERTIFICATE-----
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -166,7 +166,6 @@ files:
 - README.md
 - Rakefile
 - lib/mobility.rb
-- lib/mobility/accumulator.rb
 - lib/mobility/active_model.rb
 - lib/mobility/active_model/backend_resetter.rb
 - lib/mobility/active_record.rb
@@ -176,7 +175,10 @@ files:
 - lib/mobility/active_record/text_translation.rb
 - lib/mobility/active_record/translation.rb
 - lib/mobility/active_record/uniqueness_validator.rb
-- lib/mobility/adapter.rb
+- lib/mobility/arel.rb
+- lib/mobility/arel/nodes.rb
+- lib/mobility/arel/nodes/pg_ops.rb
+- lib/mobility/arel/visitor.rb
 - lib/mobility/attributes.rb
 - lib/mobility/backend.rb
 - lib/mobility/backend/orm_delegator.rb
@@ -184,25 +186,15 @@ files:
 - lib/mobility/backends.rb
 - 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/json_query_methods.rb
-- lib/mobility/backends/active_record/container/jsonb_query_methods.rb
 - lib/mobility/backends/active_record/hstore.rb
-- lib/mobility/backends/active_record/hstore/query_methods.rb
 - lib/mobility/backends/active_record/json.rb
-- lib/mobility/backends/active_record/json/query_methods.rb
 - lib/mobility/backends/active_record/jsonb.rb
-- lib/mobility/backends/active_record/jsonb/query_methods.rb
 - 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
@@ -236,6 +228,7 @@ files:
 - lib/mobility/backends/table.rb
 - lib/mobility/configuration.rb
 - lib/mobility/fallbacks.rb
+- lib/mobility/interface.rb
 - lib/mobility/loaded.rb
 - lib/mobility/plugins.rb
 - lib/mobility/plugins/active_model.rb
@@ -243,6 +236,7 @@ files:
 - lib/mobility/plugins/active_record.rb
 - lib/mobility/plugins/active_record/attribute_methods.rb
 - lib/mobility/plugins/active_record/dirty.rb
+- lib/mobility/plugins/active_record/query.rb
 - lib/mobility/plugins/attribute_methods.rb
 - lib/mobility/plugins/cache.rb
 - lib/mobility/plugins/cache/translation_cacher.rb
@@ -252,6 +246,7 @@ files:
 - lib/mobility/plugins/fallthrough_accessors.rb
 - lib/mobility/plugins/locale_accessors.rb
 - lib/mobility/plugins/presence.rb
+- lib/mobility/plugins/query.rb
 - lib/mobility/plugins/sequel.rb
 - lib/mobility/plugins/sequel/dirty.rb
 - lib/mobility/sequel.rb
@@ -299,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Pluggable Ruby translation framework

data/lib/mobility/accumulator.rb

@@ -1,33 +0,0 @@
-module Mobility
-=begin
-
-Class to access Mobility across backends. In particular, keeps a record of
-which {Attributes} modules have been included on the model class.
-
-=end
-  class Accumulator
-    # @return [Array<Attributes>]
-    attr_reader :modules
-
-    # @param [Class] model_class Model class
-    def initialize
-      @modules = []
-    end
-
-    # @return [Array<String>] Translated attributes defined on model
-    def translated_attribute_names
-      modules.map(&:names).flatten
-    end
-
-    # Appends backend module to +modules+ array for later reference.
-    # @param [Attributes] backend_module Attributes module
-    def << backend_module
-      modules << backend_module
-    end
-
-    def initialize_dup(other)
-      @modules = other.modules.dup
-      super
-    end
-  end
-end

data/lib/mobility/adapter.rb

@@ -1,20 +0,0 @@
-module Mobility
-=begin
-
-Provides interface to access attributes across all backends of an instance.
-
-=end
-  class Adapter
-    # @param [Object] model Instance of model class
-    def initialize(model)
-      @model = model
-    end
-
-    # Fetch backend for an attribute
-    # @param [String] attribute Attribute
-    def backend_for(attribute)
-      @model.send(Backend.method_name(attribute))
-    end
-  end
-  private_constant :Adapter
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-require "mobility/backends/active_record/query_methods"
-
-module Mobility
-  module Backends
-    module ActiveRecord
-      class Column::QueryMethods < QueryMethods
-        def initialize(attributes, _)
-          super
-          q = self
-
-          define_method :where! do |opts, *rest|
-            super(q.convert_opts(opts), *rest)
-          end
-        end
-
-        def extended(relation)
-          super
-          q = self
-
-          mod = Module.new do
-            define_method :not do |opts, *rest|
-              super(q.convert_opts(opts), *rest)
-            end
-          end
-          relation.mobility_where_chain.include(mod)
-        end
-
-        def convert_opts(opts)
-          if i18n_keys = extract_attributes(opts)
-            opts = opts.with_indifferent_access
-            i18n_keys.each do |attr|
-              opts[Backends::Column.column_name_for(attr)] = collapse opts.delete(attr)
-            end
-          end
-          opts
-        end
-      end
-      Column.private_constant :QueryMethods
-    end
-  end
-end

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

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

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-require 'mobility/backends/active_record/pg_query_methods'
-require "mobility/backends/active_record/query_methods"
-
-module Mobility
-  module Backends
-    module ActiveRecord
-      class Container::JsonbQueryMethods < QueryMethods
-        include PgQueryMethods
-        attr_reader :column
-
-        def initialize(_attributes, options)
-          super
-          @column = arel_table[options[:column_name]]
-        end
-
-        def matches(key, locale)
-          build_infix(:'->', build_infix(:'->', column, build_quoted(locale)), build_quoted(key))
-        end
-
-        def exists(key, locale)
-          build_infix(:'?', column, build_quoted(locale)).and(
-            build_infix(:'?', build_infix(:'->', column, build_quoted(locale)), build_quoted(key)))
-        end
-
-        def quote(value)
-          build_quoted(value.to_json)
-        end
-      end
-      Container.private_constant :JsonbQueryMethods
-    end
-  end
-end