mobility 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc2df8397e85a1748dabf599e88d5e351a67cb8e
-  data.tar.gz: 53329705a4e2f67cd9934cb3c791e43e7f32b5f2
+  metadata.gz: aca3c693e765d0214134a9aba41659f40f74f3a0
+  data.tar.gz: 4f3fd42701ae4dd0bfa0c6ee990a296ec4364d7c
 SHA512:
-  metadata.gz: 0df70deea72e9a4698c2946da51a069a8cd46b42c222bbe7a67b9549c407fa02b994c76e5ad8a02c4527fedd6035c670a9766dda3458350a7e02883daf979eb1
-  data.tar.gz: 8e67332a56f03d5ae6aa261ebdd9daa171105f85e254a0c10702af072a24314458c196967ef0edfa125af096d9dd03e9f8154d677cc2bb2701dd98792450dcf8
+  metadata.gz: 97ffa08e1c6cea2d3301bd642c1ce5c7ea86aae11d59402471afc236cdcc53b6daea6ac9bcfaf34b6cc7e509f09aed205e8b1cba65e1614adb2fd75f0107fda8
+  data.tar.gz: dc1581bded2b253d645172ad28b1e0f1cede386633d1a4d343603869da6561a165b408b7b6ca7722eca5ada6c1c29052b7c7c3f2f9f24f122b25db0fdc9001f2

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Mobility Changelog
 
+## 0.4
+
+### 0.4.0 (January 24, 2018)
+* Add new jsonb Container backend
+  ([#157](https://github.com/shioyama/mobility/pull/157))
+* Define attributes accessors with eval
+  ([#152](https://github.com/shioyama/mobility/pull/152))
+* Rename `default_fallbacks` to `new_fallbacks` / `fallbacks_generator=`
+  ([#148](https://github.com/shioyama/mobility/pull/148))
+* Warn user if `case_sensitive` option is passed to ActiveRecord uniqueness
+  validator ([#146](https://github.com/shioyama/mobility/pull/146))
+* Handle array of values to translated attribute query
+  ([#128](https://github.com/shioyama/mobility/pull/128))
+* Use module builder instance to define shared methods in closure
+  ([#130](https://github.com/shioyama/mobility/pull/130))
+* Query on translated json value with Sequel ORM
+  ([#155](https://github.com/shioyama/mobility/pull/155))
+* Refactor pg query methods ([#129](https://github.com/shioyama/mobility/pull/129))
+* Reduce object allocations
+  ([#156](https://github.com/shioyama/mobility/pull/156))
+
 ## 0.3
 
 ### 0.3.6 (December 25, 2017)

data/Gemfile

@@ -9,20 +9,18 @@ group :development, :test do
       gem 'activerecord', '>= 5.0', '< 5.1'
     elsif ENV['RAILS_VERSION'] == '4.2'
       gem 'activerecord', '>= 4.2.6', '< 5.0'
-    elsif ENV['RAILS_VERSION'] == '5.2'
+    elsif ENV['RAILS_VERSION'] == '5.1'
+      gem 'activerecord', '>= 5.1', '< 5.2'
+    else
       gem 'activerecord', '>= 5.2.0.beta1', '< 5.3'
       gem 'railties', '>= 5.2.0.beta1', '< 5.3'
-    else
-      gem 'activerecord', '>= 5.1', '< 5.2'
     end
     gem "generator_spec", '~> 0.9.4'
   elsif ENV['ORM'] == 'sequel'
-    if ENV['SEQUEL_VERSION'] == '4.41'
-      gem 'sequel', '>= 4.41.0', '< 4.46.0'
-    elsif ENV['SEQUEL_VERSION'] == '5.0'
-      gem 'sequel', '>= 5.0.0', '< 6.0.0'
-    else
+    if ENV['SEQUEL_VERSION'] == '4'
       gem 'sequel', '>= 4.46.0', '< 5.0'
+    else
+      gem 'sequel', '>= 5.0.0', '< 6.0.0'
     end
   end
 
@@ -33,6 +31,10 @@ group :development, :test do
     gem 'pry-byebug'
     gem 'sqlite3'
     gem 'mysql2', '~> 0.4.9'
-    gem 'pg'
+    gem 'pg', '< 1.0'
   end
 end
+
+group :benchmark do
+  gem "benchmark-ips"
+end

data/Gemfile.lock

@@ -33,6 +33,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
+    benchmark-ips (2.7.2)
     builder (3.2.3)
     byebug (9.1.0)
     coderay (1.1.2)
@@ -46,10 +47,10 @@ GEM
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    guard (2.14.1)
+    guard (2.14.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
@@ -72,7 +73,7 @@ GEM
     lumberjack (1.0.12)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
-    minitest (5.10.3)
+    minitest (5.11.1)
     mysql2 (0.4.10)
     nenv (0.3.0)
     nokogiri (1.8.1)
@@ -105,12 +106,13 @@ GEM
     rb-fsevent (0.10.2)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
-    request_store (1.3.2)
+    request_store (1.4.0)
+      rack (>= 1.4)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
       rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
+    rspec-core (3.7.1)
       rspec-support (~> 3.7.0)
     rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -133,13 +135,14 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (>= 5.2.0.beta1, < 5.3)
+  benchmark-ips
   bundler (~> 1.12)
   database_cleaner (~> 1.5, >= 1.5.3)
   generator_spec (~> 0.9.4)
   guard-rspec
   mobility!
   mysql2 (~> 0.4.9)
-  pg
+  pg (< 1.0)
   pry-byebug
   railties (>= 5.2.0.beta1, < 5.3)
   rake (~> 12, >= 12.2.1)

data/README.md

@@ -29,7 +29,7 @@ columns](http://dejimata.com/2017/3/3/translating-with-mobility#strategy-1) and
 [model translation
 tables](http://dejimata.com/2017/3/3/translating-with-mobility#strategy-2), as
 well as database-specific storage solutions such as
-[jsonb](https://www.postgresql.org/docs/current/static/datatype-json.html ) and
+[jsonb](https://www.postgresql.org/docs/current/static/datatype-json.html) and
 [Hstore](https://www.postgresql.org/docs/current/static/hstore.html) (for
 PostgreSQL).
 
@@ -54,7 +54,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 0.3.6'
+gem 'mobility', '~> 0.4.0'
 ```
 
 Mobility is cryptographically signed. To be sure the gem you install hasn't
@@ -103,7 +103,23 @@ end
 ```
 
 To use a different default backend, set `default_backend` to another value (see
-possibilities [below](#backends)). Other configuration options are
+possibilities [below](#backends)).
+
+You will likely also want to set default values for the various translation
+options described below. You can set these defaults by assigning values to keys
+on the `config.default_options` hash, like this (to set the default value for
+the `dirty` option to `true`):
+
+```diff
+ Mobility.configure do |config|
+   config.default_backend = :key_value
+   config.accessor_method = :translates
+   config.query_method    = :i18n
++  config.default_options[:dirty] = true
+end
+```
+
+Other configuration options are
 described in the [API
 docs](http://www.rubydoc.info/gems/mobility/Mobility/Configuration).
 
@@ -407,7 +423,7 @@ end
 
 Internally, Mobility assigns the fallbacks hash to an instance of
 `I18n::Locale::Fallbacks.new` (this can be customized by setting the
-`default_fallbacks` configuration option, see the [API documentation on
+`fallbacks_generator` configuration option, see the [API documentation on
 configuration](http://www.rubydoc.info/gems/mobility/Mobility/Configuration)).
 
 By setting fallbacks for German and French to Japanese, values will fall
@@ -484,7 +500,7 @@ Mobility.with_locale(:de) { word.meaning }
 ```
 
 For more details, see the [API documentation on
-fallbacks](http://www.rubydoc.info/gems/mobility/Mobility/Backend/Fallbacks)
+fallbacks](http://www.rubydoc.info/gems/mobility/Mobility/Plugins/Fallbacks)
 and [this article on I18n
 fallbacks](https://github.com/svenfuchs/i18n/wiki/Fallbacks).
 
@@ -518,8 +534,10 @@ word.name(default: 'bar')
 #=> 'bar'
 ```
 
-The default can also be a `Proc`, which will be passed the model and attribute
-name as keyword arguments. See the [API docs][docs] for details.
+The default can also be a `Proc`, which will be called with the context as the
+model itself, and passed optional arguments (attribute, locale and options
+passed to accessor) which can be used to customize behaviour. See the [API
+docs][docs] for details.
 
 ### <a name="dirty"></a>Dirty Tracking
 
@@ -545,6 +563,9 @@ class Post < ApplicationRecord
 end
 ```
 
+(If you want to enable dirty tracking on all models, set the
+`config.default_options[:dirty]` option in your Mobility configuration.)
+
 Let's assume we start with a post with a title in English and Japanese:
 
 ```ruby
@@ -602,8 +623,16 @@ Notice that Mobility uses locale suffixes to indicate which locale has changed;
 dirty tracking is implemented this way to ensure that it is clear what
 has changed in which locale, avoiding any possible ambiguity.
 
-For more details, see the [API documentation on dirty
-tracking](http://www.rubydoc.info/gems/mobility/Mobility/Backend/Dirty).
+For performance reasons, it is highly recommended that when using the Dirty
+plugin, you also enable [locale accessors](#getset) for all locales which will
+be used, so that methods like `title_en` above are defined; otherwise they will
+be caught by `method_missing` (using fallthrough accessors), which is much slower.
+The easiest way to do this is to set `config.default_options[:locale_accessors]
+= true` in your Mobility config, and make sure that `I18n.available_locales`
+includes all locales you use in production.
+
+For more details on dirty tracking, see the [API
+documentation](http://www.rubydoc.info/gems/mobility/Mobility/Plugins/Dirty).
 
 ### Cache
 
@@ -743,7 +772,7 @@ This will generate the `post_translations` table with columns `title` and
 the [Table
 Backend](https://github.com/shioyama/mobility/wiki/Table-Backend) page of the
 wiki and API documentation on the [`Mobility::Backend::Table`
-class](http://www.rubydoc.info/gems/mobility/Mobility/Backend/Table).
+class](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Table).
 
 ### Column Backend (like Traco)
 
@@ -761,7 +790,7 @@ rails generate mobility:translations post title:string content:text
 For more details, see the [Column
 Backend](https://github.com/shioyama/mobility/wiki/Column-Backend) page of the
 wiki and API documentation on the [`Mobility::Backend::Column`
-class](http://www.rubydoc.info/gems/mobility/Mobility/Backend/Column).
+class](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Column).
 
 ### PostgreSQL-specific Backends
 
@@ -775,12 +804,17 @@ or
 extensions with `DB.extension :pg_json` or `DB.extension :pg_hstore` (where
 `DB` is your database instance).
 
-Other details are covered in the [Postgres
-Backend](https://github.com/shioyama/mobility/wiki/Postgres-Backends) page of
-the wiki and in the API documentation
-([`Mobility::Backend::Jsonb`](http://www.rubydoc.info/gems/mobility/Mobility/Backend/Jsonb)
+Another option is to store all your translations on a single jsonb column (one
+per model). This is called the "container" backend.
+
+For details on these backends, see the [Postgres
+Backend](https://github.com/shioyama/mobility/wiki/Postgres-Backends-%28Column-Attribute%29)
+and [Container
+Backend](https://github.com/shioyama/mobility/wiki/Container-Backend)
+pages of the wiki and in the API documentation
+([`Mobility::Backend::Jsonb`](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Jsonb)
 and
-[`Mobility::Backend::Hstore`](http://www.rubydoc.info/gems/mobility/Mobility/Backend/Hstore)).
+[`Mobility::Backend::Hstore`](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Hstore)).
 
 Development
 -----------

data/lib/mobility.rb

@@ -149,8 +149,8 @@ module Mobility
     # (see Mobility::Configuration#query_method)
     # @!method query_method
 
-    # (see Mobility::Configuration#default_fallbacks)
-    # @!method default_fallbacks
+    # (see Mobility::Configuration#new_fallbacks)
+    # @!method new_fallbacks
 
     # (see Mobility::Configuration#default_backend)
     # @!method default_backend
@@ -169,10 +169,15 @@ module Mobility
       end
     end
 
-    define_method :default_fallbacks do |*args|
+    # TODO: Remove in v1.0
+    def default_fallbacks(*args)
       config.public_send(:default_fallbacks, *args)
     end
 
+    def new_fallbacks(*args)
+      config.public_send(:new_fallbacks, *args)
+    end
+
     # Configure Mobility
     # @yield [Mobility::Configuration] Mobility configuration
     def configure
@@ -210,8 +215,16 @@ module Mobility
     # @param [String,Symbol] locale
     # @raise [InvalidLocale] if locale is present but not available
     def enforce_available_locales!(locale)
+      # TODO: Remove conditional in v1.0
       if I18n.enforce_available_locales
         raise Mobility::InvalidLocale.new(locale) unless (I18n.locale_available?(locale) || locale.nil?)
+      else
+        warn <<-EOL
+WARNING: You called Mobility.enforce_available_locales! in a situation where
+I18n.enforce_available_locales is false. In the past, Mobility would do nothing
+in this case, but as of the next major release Mobility will ignore the I18n
+setting and enforce available locales whenever this method is called.
+EOL
       end
     end
 
@@ -223,7 +236,7 @@ module Mobility
 
     def set_locale(locale)
       locale = locale.to_sym if locale
-      enforce_available_locales!(locale)
+      enforce_available_locales!(locale) if I18n.enforce_available_locales
       storage[:mobility_locale] = locale
     end
   end
@@ -260,4 +273,5 @@ module Mobility
 
   class BackendRequired < ArgumentError; end
   class InvalidLocale < I18n::InvalidLocale; end
+  class NotImplementedError < StandardError; end
 end

data/lib/mobility/active_record.rb

@@ -7,15 +7,22 @@ Module loading ActiveRecord-specific classes for Mobility models.
   module ActiveRecord
     require "mobility/active_record/uniqueness_validator"
 
+    class QueryMethod < Module
+      def initialize(query_method)
+        module_eval <<-EOM, __FILE__, __LINE__ + 1
+          def #{query_method}
+            all
+          end
+        EOM
+      end
+    end
+
     def self.included(model_class)
-      query_method = Module.new do
-        define_method Mobility.query_method do
-          all
-        end
+      model_class.extend QueryMethod.new(Mobility.query_method)
+      unless model_class.const_defined?(:UniquenessValidator)
+        model_class.const_set(:UniquenessValidator,
+                              Class.new(::Mobility::ActiveRecord::UniquenessValidator))
       end
-      model_class.extend query_method
-      model_class.const_set(:UniquenessValidator,
-                            Class.new(::Mobility::ActiveRecord::UniquenessValidator))
       model_class.delegate :translated_attribute_names, to: :class
     end
   end

data/lib/mobility/active_record/uniqueness_validator.rb

@@ -1,10 +1,25 @@
 module Mobility
   module ActiveRecord
+=begin
+
+A backend-agnostic uniqueness validator for ActiveRecord translated attributes.
+
+@note This validator does not support case sensitivity, since doing so would
+  significantly complicate implementation.
+
+=end
     class UniquenessValidator < ::ActiveRecord::Validations::UniquenessValidator
+      # @param [ActiveRecord::Base] record Translated model
+      # @param [String] attribute Name of attribute
+      # @param [Object] value Attribute value
       def validate_each(record, attribute, value)
         klass = record.class
 
         if ((Array(options[:scope]) + [attribute]).map(&:to_s) & klass.translated_attribute_names).present?
+          warn %{
+WARNING: The Mobility uniqueness validator for translated attributes does not
+support case-insensitive validation. This option will be ignored for: #{attribute}
+} if options[:case_sensitive] == false
           return unless value.present?
           relation = klass.send(Mobility.query_method).where(attribute => value)
           relation = relation.where.not(klass.primary_key => record.id) if record.persisted?
@@ -25,10 +40,9 @@ module Mobility
       private
 
       def mobility_scope_relation(record, relation)
-        Array(options[:scope]).each do |scope_item|
-          relation = relation.where(scope_item => record.send(scope_item))
+        Array(options[:scope]).inject(relation) do |scoped_relation, scope_item|
+          scoped_relation.where(scope_item => record.send(scope_item))
         end
-        relation
       end
     end
   end

data/lib/mobility/attributes.rb

@@ -170,8 +170,11 @@ with other backends.
 
     # Process options passed into accessor method before calling backend, and
     # return locale
+    # @deprecated This method was mainly used internally but is no longer
+    #   needed. It will be removed in the next major release.
     # @param [Hash] options Options hash passed to accessor method
     # @return [Symbol] locale
+    # TODO: Remove in v1.0
     def self.process_options!(options)
       (options[:locale] || Mobility.locale).tap { |locale|
         Mobility.enforce_available_locales!(locale)
@@ -190,25 +193,45 @@ with other backends.
     end
 
     def define_reader(attribute)
-      define_method attribute do |**options|
-        return super() if options.delete(:super)
-        locale = Mobility::Attributes.process_options!(options)
-        mobility_backend_for(attribute).read(locale, options)
-      end
-
-      define_method "#{attribute}?" do |**options|
-        return super() if options.delete(:super)
-        locale = Mobility::Attributes.process_options!(options)
-        mobility_backend_for(attribute).present?(locale, options)
-      end
+      backend = Backend.method_name(attribute)
+      class_eval <<-EOM, __FILE__, __LINE__ + 1
+        def #{attribute}(**options)
+          return super() if options.delete(:super)
+          #{set_locale_from_options_inline}
+          #{backend}.read(locale, options)
+        end
+
+        def #{attribute}?(**options)
+          return super() if options.delete(:super)
+          #{set_locale_from_options_inline}
+          #{backend}.present?(locale, options)
+        end
+      EOM
     end
 
     def define_writer(attribute)
-      define_method "#{attribute}=" do |value, **options|
-        return super(value) if options.delete(:super)
-        locale = Mobility::Attributes.process_options!(options)
-        mobility_backend_for(attribute).write(locale, value, options)
-      end
+      backend = Backend.method_name(attribute)
+      class_eval <<-EOM, __FILE__, __LINE__ + 1
+        def #{attribute}=(value, **options)
+          return super(value) if options.delete(:super)
+          #{set_locale_from_options_inline}
+          #{backend}.write(locale, value, options)
+        end
+      EOM
+    end
+
+    # This string is evaluated inline in order to optimize performance of
+    # getters and setters, avoiding extra steps where they are unneeded.
+    def set_locale_from_options_inline
+      <<-EOL
+if options[:locale]
+  #{"Mobility.enforce_available_locales!(options[:locale])" if I18n.enforce_available_locales}
+  locale = options[:locale].to_sym
+  options[:locale] &&= !!locale
+else
+  locale = Mobility.locale
+end
+EOL
     end
 
     def get_backend_class(backend)