mobility 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2476bba0d2ac7649a1fa88b936c4cb51935d4b84
-  data.tar.gz: a15090756064bce65bc9c7554f331fa63378b5ce
+  metadata.gz: c134f78117865e131baf9ceecb0c902cb63abb08
+  data.tar.gz: 2076ecc0e3164b962d1f5147e0af81d2ba9baac3
 SHA512:
-  metadata.gz: 7d93ae6f961fe488dc877dee008f8152b0390e8b485a4e34a558b49c9b9642bee79c7df60fd456732fdbc9c19aa9506e97295caba2d4014e1f834ea2e046faae
-  data.tar.gz: 8d4f4e0404691953173798542fb6d2021b206b42a1e2fea5d4ca7350414281261c86eb2610ef4cb8f6d2efd2def2630dfb40c92c0d1b7f071d66eeae9f252da4
+  metadata.gz: f6ec9f5003e16ace7ea7a77136266af20f5c86beb1ebea6ae4e83598d20bdf4d14971d6f029c2b1bd74763c599287e362b7b3204c51660606ab2b371a4620842
+  data.tar.gz: 8eae38b70cb15cb0eeec7dfb51f72e4076268312bdd73d63a9fda7611414d116e5bd95771a3042ca080ea4495c335e50a66f5c92a1beb6994e2d1d8d4c9d3bb9

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Mobility Changelog
 
+## 0.3
+
+### 0.3.0 (November 30, 2017)
+* `dup` support for table backend ([#84](https://github.com/shioyama/mobility/pull/84)). Thanks [@pwim](https://github.com/pwim)!
+* Disable fallbacks when using locale/fallthrough accessors
+  ([#86](https://github.com/shioyama/mobility/pull/86), [#87](https://github.com/shioyama/mobility/pull/87),
+  [#88](https://github.com/shioyama/mobility/pull/88), [#89](https://github.com/shioyama/mobility/pull/89))
+* Convert AttributeMethods to plugin
+  ([#102](https://github.com/shioyama/mobility/pull/102))
+* Ensure `cache_key` is invalidated when updating translations
+  ([#104](https://github.com/shioyama/mobility/pull/102)) Thanks
+  [@pwim](https://github.com/pwim)!
+* Update dependency versions ([#107](https://github.com/shioyama/mobility/pull/107))
+* Support new AR::Dirty methods ([#111](https://github.com/shioyama/mobility/pull/111))
+* Use `public_send` in LocaleAccessors plugin ([#117](https://github.com/shioyama/mobility/pull/117))
+
 ## 0.2
 
 ### 0.2.3 (September 14, 2017)

data/Gemfile

@@ -9,6 +9,9 @@ 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'
+      gem 'activerecord', '>= 5.2.0.beta1'
+      gem 'railties', '>= 5.2.0.beta1'
     else
       gem 'activerecord', '>= 5.1', '< 5.2'
     end
@@ -16,6 +19,8 @@ group :development, :test do
   elsif ENV['ORM'] == 'sequel'
     if ENV['SEQUEL_VERSION'] == '4.41'
       gem 'sequel', '>= 4.41.0', '< 4.46.0'
+    elsif ENV['SEQUEL_VERSION'] == 'latest'
+      gem 'sequel', '>= 5.0.0'
     else
       gem 'sequel', '>= 4.46.0', '< 5.0'
     end
@@ -27,7 +32,7 @@ group :development, :test do
     gem 'guard-rspec'
     gem 'pry-byebug'
     gem 'sqlite3'
-    gem 'mysql2', '~> 0.3.10'
+    gem 'mysql2', '~> 0.4.9'
     gem 'pg'
   end
 end

data/Gemfile.lock

@@ -1,45 +1,46 @@
 PATH
   remote: .
   specs:
-    mobility (0.2.2)
-      i18n (>= 0.6.10, < 0.9)
+    mobility (0.3.0.pre.alpha)
+      i18n (>= 0.6.10, < 0.10)
       request_store (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.1.3)
-      actionview (= 5.1.3)
-      activesupport (= 5.1.3)
+    actionpack (5.2.0.beta2)
+      actionview (= 5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
       rack (~> 2.0)
-      rack-test (~> 0.6.3)
+      rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.3)
-      activesupport (= 5.1.3)
+    actionview (5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.1.3)
-      activesupport (= 5.1.3)
-    activerecord (5.1.3)
-      activemodel (= 5.1.3)
-      activesupport (= 5.1.3)
-      arel (~> 8.0)
-    activesupport (5.1.3)
+    activemodel (5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+    activerecord (5.2.0.beta2)
+      activemodel (= 5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+      arel (>= 9.0)
+    activesupport (5.2.0.beta2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (8.0.0)
+    arel (9.0.0)
     builder (3.2.3)
-    byebug (9.0.6)
-    coderay (1.1.1)
+    byebug (9.1.0)
+    coderay (1.1.2)
     concurrent-ruby (1.0.5)
-    database_cleaner (1.6.1)
+    crass (1.0.3)
+    database_cleaner (1.6.2)
     diff-lcs (1.3)
-    erubi (1.6.1)
+    erubi (1.7.0)
     ffi (1.9.18)
     formatador (0.2.5)
     generator_spec (0.9.4)
@@ -59,91 +60,92 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (0.8.6)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    loofah (2.0.3)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     lumberjack (1.0.12)
-    method_source (0.8.2)
-    mini_portile2 (2.2.0)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
     minitest (5.10.3)
-    mysql2 (0.3.21)
+    mysql2 (0.4.10)
     nenv (0.3.0)
-    nokogiri (1.8.0)
-      mini_portile2 (~> 2.2.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
     pg (0.21.0)
-    pry (0.10.4)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.4.2)
-      byebug (~> 9.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
       pry (~> 0.10)
     rack (2.0.3)
-    rack-test (0.6.3)
-      rack (>= 1.0)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.1.3)
-      actionpack (= 5.1.3)
-      activesupport (= 5.1.3)
+    railties (5.2.0.beta2)
+      actionpack (= 5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.5.0)
+    rake (12.3.0)
     rb-fsevent (0.10.2)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
     request_store (1.3.2)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    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-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    slop (3.6.0)
     sqlite3 (1.3.13)
-    thor (0.19.4)
+    thor (0.20.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.3)
+    tzinfo (1.2.4)
       thread_safe (~> 0.1)
-    yard (0.9.9)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (>= 5.1, < 5.2)
+  activerecord (>= 5.2.0.beta1)
   bundler (~> 1.12)
   database_cleaner (~> 1.5, >= 1.5.3)
   generator_spec (~> 0.9.4)
   guard-rspec
   mobility!
-  mysql2 (~> 0.3.10)
+  mysql2 (~> 0.4.9)
   pg
   pry-byebug
-  rake (~> 10.0)
+  railties (>= 5.2.0.beta1)
+  rake (~> 12, >= 12.2.1)
   rspec (~> 3.0)
   sqlite3
   yard (~> 0.9.0)
 
 BUNDLED WITH
-   1.15.3
+   1.16.0.pre.2

data/README.md

@@ -16,7 +16,8 @@ Mobility
 Mobility is a gem for storing and retrieving translations as attributes on a
 class. These translations could be the content of blog posts, captions on
 images, tags on bookmarks, or anything else you might want to store in
-different languages.
+different languages. For examples of what Mobility can do, see the
+<a href="#companies-using-mobility">Companies using Mobility</a> section below.
 
 Storage of translations is handled by customizable "backends" which encapsulate
 different storage strategies. The default, preferred way to store translations
@@ -41,13 +42,17 @@ Mobility](http://dejimata.com/2017/3/3/translating-with-mobility). See also the
 works for future releases, and other pages of the [wiki][wiki] for more detail
 on usage.
 
+If you're coming from Globalize, be sure to also read the [Migrating from
+Globalize](https://github.com/shioyama/mobility/wiki/Migrating-from-Globalize)
+section of the wiki.
+
 Installation
 ------------
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 0.2.3'
+gem 'mobility', '~> 0.3.0'
 ```
 
 Mobility is cryptographically signed. To be sure the gem you install hasn't
@@ -104,7 +109,7 @@ See [Getting Started](#quickstart) to get started translating your models.
 ### Sequel
 
 Requirements:
-- Sequel >= 4.0
+- Sequel >= 4.0, < 5.0 (5.0 support is in the works)
 
 You can extend `Mobility` just like in ActiveRecord, or you can use the
 `mobility` plugin, which does the same thing:
@@ -222,7 +227,7 @@ locations, usually database columns. By default these values are stored as keys
 tables, one for strings and one for text columns, but this can be easily
 changed and/or customized (see the [Backends](#backends) section below).
 
-### Getting and Setting Translations
+### <a name="getset"></a> Getting and Setting Translations
 
 The easiest way to get or set a translation is to use the getter and setter
 methods described above (`word.name` and `word.name=`), but you may want to
@@ -309,6 +314,11 @@ word.name(locale: :fr)
 #=> "mobilité"
 ```
 
+Note that setting the locale this way will pass an option `locale: true` to the
+backend and all plugins. Plugins may use this option to change their behavior
+(passing the locale explicitly this way, for example, disables
+[fallbacks](#fallbacks), see below for details).
+
 You can also *set* the value of an attribute this way; however, since the
 `word.name = <value>` syntax does not accept any options, the only way to do this is to
 use `send` (this is included mostly for consistency):
@@ -387,8 +397,8 @@ translated attributes on a class:
 ```ruby
 class Word < ApplicationRecord
   extend Mobility
-  translates :name,    type: :string, fallbacks: { de: :ja, fr: :ja }
-  translates :meaning, type: :text,   fallbacks: { de: :ja, fr: :ja }
+  translates :name,    type: :string, fallbacks: { de: :ja, fr: :ja }, locale_accessors: true
+  translates :meaning, type: :text,   fallbacks: { de: :ja, fr: :ja }, locale_accessors: true
 end
 ```
 
@@ -404,17 +414,20 @@ but not for other locales:
 ```ruby
 Mobility.locale = :ja
 word = Word.create(name: "モビリティ", meaning: "(名詞):動きやすさ、可動性")
-word.name(locale: :de)
+Mobility.locale = :de
+word.name
 #=> "モビリティ"
-word.meaning(locale: :de)
+word.meaning
 #=> "(名詞):動きやすさ、可動性"
-word.name(locale: :fr)
+Mobility.locale = :fr
+word.name
 #=> "モビリティ"
-word.meaning(locale: :fr)
+word.meaning
 #=> "(名詞):動きやすさ、可動性"
-word.name(locale: :ru)
+Mobility.locale = :ru
+word.name
 #=> nil
-word.meaning(locale: :ru)
+word.meaning
 #=> nil
 ```
 
@@ -423,11 +436,14 @@ You can optionally disable fallbacks to get the real value for a given locale
 passing `fallback: false` (*singular*, not plural) to the getter method:
 
 ```ruby
-word.meaning(locale: :de, fallback: false)
+Mobility.locale = :de
+word.meaning(fallback: false)
 #=> nil
-word.meaning(locale: :fr, fallback: false)
+Mobility.locale = :fr
+word.meaning(fallback: false)
 #=> nil
-word.meaning(locale: :ja, fallback: false)
+Mobility.locale = :ja
+word.meaning(fallback: false)
 #=> "(名詞):動きやすさ、可動性"
 ```
 
@@ -439,11 +455,28 @@ Mobility.with_locale(:fr) do
   word.meaning = "(nf): aptitude à bouger, à se déplacer, à changer, à évoluer"
 end
 word.save
-word.meaning(locale: :de, fallback: false)
+Mobility.locale = :de
+word.meaning(fallback: false)
 #=> nil
-word.meaning(locale: :de, fallback: :fr)
+word.meaning(fallback: :fr)
 #=> "(nf): aptitude à bouger, à se déplacer, à changer, à évoluer"
-word.meaning(locale: :de, fallback: [:ja, :fr])
+word.meaning(fallback: [:ja, :fr])
+#=> "(名詞):動きやすさ、可動性"
+```
+
+Also note that passing a `locale` option into an attribute reader or writer, or
+using [locale accessors or fallthrough accessors](#getset) to get or set
+any attribute value, will disable fallbacks (just like `fallback: false`).
+(This will take precedence over any value of the `fallback` option.)
+
+Continuing from the last example:
+
+```ruby
+word.meaning(locale: :de)
+#=> nil
+word.meaning_de
+#=> nil
+Mobility.with_locale(:de) { word.meaning }
 #=> "(名詞):動きやすさ、可動性"
 ```
 
@@ -830,6 +863,18 @@ More Information
 - [API documentation][docs]
 - [Wiki][wiki]
 
+<a name="#companies-using-mobility"></a>Companies using Mobility
+------------------------
+
+<img alt="Logos of companies using Mobility" src="./img/companies-using-mobility.png" style="width: 100%" />
+
+- [Doorkeeper](https://www.doorkeeper.jp/)
+- [Oreegano](https://www.oreegano.com/)
+- [Venuu](https://venuu.fi)
+- ... <sup>&#10033;</sup>
+
+<sup>&#10033;</sup> <small>Post an issue or email me to add your company's name to this list.</small>
+
 License
 -------
 

data/lib/mobility.rb

@@ -89,7 +89,6 @@ module Mobility
 
       if Loaded::ActiveRecord
         model_class.include(ActiveRecord)                   if model_class < ::ActiveRecord::Base
-        model_class.include(ActiveRecord::AttributeMethods) if model_class.ancestors.include?(::ActiveRecord::AttributeMethods)
       end
 
       if Loaded::Sequel

data/lib/mobility/active_record.rb

@@ -5,7 +5,6 @@ Module loading ActiveRecord-specific classes for Mobility models.
 
 =end
   module ActiveRecord
-    require "mobility/active_record/attribute_methods"
     require "mobility/active_record/uniqueness_validator"
 
     def self.included(model_class)

data/lib/mobility/active_record/translation.rb

@@ -4,7 +4,7 @@ module Mobility
     class Translation < ::ActiveRecord::Base
       self.abstract_class = true
 
-      belongs_to :translatable, polymorphic: true
+      belongs_to :translatable, polymorphic: true, touch: true
 
       validates :key, presence: true, uniqueness: { scope: [:translatable_id, :translatable_type, :locale] }
       validates :translatable, presence: true

data/lib/mobility/attributes.rb

@@ -19,7 +19,7 @@ like including a module. Creating an instance like this:
 
   Attributes.new("title", backend: :my_backend, locale_accessors: [:en, :ja], cache: true, fallbacks: true)
 
-will generate an anonymous module that behaves like this:
+will generate an anonymous module that behaves (approximately) like this:
 
   Module.new do
     def title_backend
@@ -131,7 +131,7 @@ with other backends.
     def initialize(*attribute_names, method: :accessor, backend: Mobility.default_backend, **backend_options)
       raise ArgumentError, "method must be one of: reader, writer, accessor" unless %i[reader writer accessor].include?(method)
       @method = method
-      @options = Mobility.default_options.merge(backend_options)
+      @options = Mobility.default_options.to_h.merge(backend_options)
       @names = attribute_names.map(&:to_s)
       raise Mobility::BackendRequired, "Backend option required if Mobility.config.default_backend is not set." if backend.nil?
       @backend_name = backend
@@ -168,6 +168,17 @@ with other backends.
       names.each(&block)
     end
 
+    # Process options passed into accessor method before calling backend, and
+    # return locale
+    # @param [Hash] options Options hash passed to accessor method
+    # @return [Symbol] locale
+    def self.process_options!(options)
+      (options[:locale] || Mobility.locale).tap { |locale|
+        Mobility.enforce_available_locales!(locale)
+        options[:locale] &&= !!locale
+      }.to_sym
+    end
+
     private
 
     def define_backend(attribute)
@@ -179,24 +190,24 @@ with other backends.
     end
 
     def define_reader(attribute)
-      define_method attribute do |locale: Mobility.locale, **options|
+      define_method attribute do |**options|
         return super() if options.delete(:super)
-        Mobility.enforce_available_locales!(locale)
-        mobility_backend_for(attribute).read(locale.to_sym, options)
+        locale = Mobility::Attributes.process_options!(options)
+        mobility_backend_for(attribute).read(locale, options)
       end
 
-      define_method "#{attribute}?" do |locale: Mobility.locale, **options|
+      define_method "#{attribute}?" do |**options|
         return super() if options.delete(:super)
-        Mobility.enforce_available_locales!(locale)
-        mobility_backend_for(attribute).present?(locale.to_sym, options)
+        locale = Mobility::Attributes.process_options!(options)
+        mobility_backend_for(attribute).present?(locale, options)
       end
     end
 
     def define_writer(attribute)
-      define_method "#{attribute}=" do |value, locale: Mobility.locale, **options|
+      define_method "#{attribute}=" do |value, **options|
         return super(value) if options.delete(:super)
-        Mobility.enforce_available_locales!(locale)
-        mobility_backend_for(attribute).write(locale.to_sym, value, options)
+        locale = Mobility::Attributes.process_options!(options)
+        mobility_backend_for(attribute).write(locale, value, options)
       end
     end
 

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

@@ -136,7 +136,19 @@ columns to that table.
         translation_class.belongs_to :translated_model,
           class_name:  name,
           foreign_key: options[:foreign_key],
-          inverse_of:  association_name
+          inverse_of:  association_name,
+          touch: true
+
+        module_name = "MobilityArTable#{association_name.to_s.camelcase}"
+        unless const_defined?(module_name)
+          callback_methods = Module.new do
+            define_method :initialize_dup do |source|
+              super(source)
+              self.send("#{association_name}=", source.send(association_name).map(&:dup))
+            end
+          end
+          include const_set(module_name, callback_methods)
+        end
       end
 
       setup_query_methods(QueryMethods)

data/lib/mobility/configuration.rb

@@ -20,7 +20,17 @@ Stores shared Mobility configuration referenced by all backends.
     # may not include the keys 'backend' or 'model_class'.
     # @return [Hash]
     attr_reader :default_options
+
+    # @deprecated The default_options= setter has been deprecated. Set each
+    #   option on the default_options hash instead.
     def default_options=(options)
+      warn %{
+WARNING: The default_options= setter has been deprecated.
+Set each option on the default_options hash instead, like this:
+
+  config.default_options[:fallbacks] = { ... }
+  config.default_options[:dirty] = true
+}
       if (keys = options.keys & RESERVED_OPTION_KEYS).present?
         raise ReservedOptionKey,
           "Default options may not contain the following reserved keys: #{keys.join(', ')}"
@@ -63,24 +73,35 @@ Stores shared Mobility configuration referenced by all backends.
       @query_method = :i18n
       @default_fallbacks = lambda { |fallbacks| I18n::Locale::Fallbacks.new(fallbacks) }
       @default_accessor_locales = lambda { I18n.available_locales }
-      @default_options = {
+      @default_options = Options[{
         cache: true,
         dirty: false,
         fallbacks: nil,
         presence: true,
-        default: nil
-      }
+        default: nil,
+        attribute_methods: false
+      }]
       @plugins = %i[
         cache
         dirty
         fallbacks
         presence
         default
+        attribute_methods
         fallthrough_accessors
         locale_accessors
       ]
     end
 
     class ReservedOptionKey < Exception; end
+
+    class Options < Hash
+      def []=(key, _)
+        if RESERVED_OPTION_KEYS.include?(key)
+          raise Configuration::ReservedOptionKey, "Default options may not contain the following reserved key: #{key}"
+        end
+        super
+      end
+    end
   end
 end

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

@@ -30,8 +30,9 @@ value of the translated attribute if passed to it.
         def write(locale, value, options = {})
           locale_accessor = Mobility.normalize_locale_accessor(attribute, locale)
           if model.changed_attributes.has_key?(locale_accessor) && model.changed_attributes[locale_accessor] == value
-            model.attributes_changed_by_setter.except!(locale_accessor)
+            model.send(:attributes_changed_by_setter).except!(locale_accessor)
           elsif read(locale, options.merge(fallback: false)) != value
+            model.send(:mobility_changed_attributes) << locale_accessor
             model.send(:attribute_will_change!, locale_accessor)
           end
           super
@@ -63,6 +64,10 @@ value of the translated attribute if passed to it.
             private :restore_attribute!
           end
 
+          def included(model_class)
+            model_class.include ChangedAttributes
+          end
+
           private
 
           # Get method suffixes. Creating an object just to get the list of
@@ -74,6 +79,19 @@ value of the translated attribute if passed to it.
                 include ::ActiveModel::Dirty
               end.attribute_method_matchers.map(&:suffix).select { |m| m =~ /\A_/ }
           end
+
+          # Tracks which translated attributes have been changed, separate from
+          # the default tracking of changes in ActiveModel/ActiveRecord Dirty.
+          # This is required in order for the Mobility ActiveRecord Dirty
+          # plugin to correctly read the value of locale accessors like
+          # +title_en+ in dirty tracking.
+          module ChangedAttributes
+            private
+
+            def mobility_changed_attributes
+              @mobility_changed_attributes ||= Set.new
+            end
+          end
         end
       end
     end

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

@@ -0,0 +1,39 @@
+module Mobility
+  module Plugins
+=begin
+
+Module builder adding translated attributes to #attributes hash on model
+instance. See {Mobility::Plugins::AttributeMethods} for further details.
+
+=end
+    module ActiveRecord
+      module TranslatedAttributes
+        def translated_attributes
+          {}
+        end
+
+        def attributes
+          super.merge(translated_attributes)
+        end
+      end
+
+      class AttributeMethods < Module
+        def initialize(*attribute_names)
+          include TranslatedAttributes
+          define_method :translated_attributes do
+            super().merge(attribute_names.inject({}) do |attributes, name|
+              attributes.merge(name.to_s => send(name))
+            end)
+          end
+          delegate :translated_attribute_names, to: :class
+        end
+
+        def included(model_class)
+          model_class.class_eval do
+            define_method :untranslated_attributes, ::ActiveRecord::Base.instance_method(:attributes)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,17 @@ 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
+AR::Dirty plugin adds support for the following persistence-specific methods
+(for a model with a translated attribute +title+):
+- +saved_changes+
+- +saved_change_to_title?+
+- +saved_change_to_title+
+- +title_before_last_save+
+- +will_save_change_to_title?+
+- +title_change_to_be_saved+
+- +title_in_database+
+
 =end
     module ActiveRecord
       module Dirty
@@ -19,7 +30,33 @@ details on usage.
           def initialize(*attribute_names)
             super
             @attribute_names = attribute_names
+            define_method_overrides
+            define_attribute_methods if ::ActiveRecord::VERSION::STRING >= '5.1'
+          end
 
+          # Overrides +ActiveRecord::AttributeMethods::ClassMethods#has_attribute+ and
+          # +ActiveModel::AttributeMethods#_read_attribute+ to treat
+          # fallthrough attribute methods just like "real" attribute methods.
+          #
+          # @note Patching +has_attribute?+ is necessary as of AR 5.1 due to this commit[https://github.com/rails/rails/commit/4fed08fa787a316fa51f14baca9eae11913f5050].
+          #   (I have voiced my opposition to this change here[https://github.com/rails/rails/pull/27963#issuecomment-310092787]).
+          # @param [Attributes] attributes
+          def included(model_class)
+            super
+            names = @attribute_names
+            method_name_regex = /\A(#{names.join('|'.freeze)})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
+            has_attribute = Module.new do
+              define_method :has_attribute? do |attr_name|
+                super(attr_name) || !!method_name_regex.match(attr_name)
+              end
+            end
+            model_class.extend has_attribute
+            model_class.include ReadAttribute if ::ActiveRecord::VERSION::STRING >= '5.2'
+          end
+
+          private
+
+          def define_method_overrides
             changes_applied_method = ::ActiveRecord::VERSION::STRING < '5.1' ? :changes_applied : :changes_internally_applied
             define_method changes_applied_method do
               @previously_changed = changes
@@ -36,21 +73,49 @@ details on usage.
             end
           end
 
-          # Overrides +ActiveRecord::AttributeMethods::ClassMethods#has_attribute+ to treat fallthrough attribute methods
-          # just like "real" attribute methods.
+          # For AR >= 5.1 only
+          def define_attribute_methods
+            define_method :saved_changes do
+              (@previously_changed ||= ActiveSupport::HashWithIndifferentAccess.new).merge(super())
+            end
+
+            @attribute_names.each do |name|
+              define_method :"saved_change_to_#{name}?" do
+                previous_changes.include?(Mobility.normalize_locale_accessor(name))
+              end
+
+              define_method :"saved_change_to_#{name}" do
+                previous_changes[Mobility.normalize_locale_accessor(name)]
+              end
+
+              define_method :"#{name}_before_last_save" do
+                previous_changes[Mobility.normalize_locale_accessor(name)].first
+              end
+
+              alias_method :"will_save_change_to_#{name}?", :"#{name}_changed?"
+              alias_method :"#{name}_change_to_be_saved", :"#{name}_change"
+              alias_method :"#{name}_in_database", :"#{name}_was"
+            end
+          end
+
+          # Overrides _read_attribute to correctly dispatch reads on translated
+          # attributes to their respective setters, rather than to
+          # +@attributes+, which would otherwise return +nil+.
           #
-          # @note Patching +has_attribute?+ is necessary as of AR 5.1 due to this commit[https://github.com/rails/rails/commit/4fed08fa787a316fa51f14baca9eae11913f5050].
-          #   (I have voiced my opposition to this change here[https://github.com/rails/rails/pull/27963#issuecomment-310092787]).
-          # @param [Attributes] attributes
-          def included(model_class)
-            names = @attribute_names
-            method_name_regex = /\A(#{names.join('|'.freeze)})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
-            has_attribute = Module.new do
-              define_method :has_attribute? do |attr_name|
-                super(attr_name) || !!method_name_regex.match(attr_name)
+          # For background on why this is necessary, see:
+          # https://github.com/shioyama/mobility/issues/115
+          module ReadAttribute
+            # @note We first check if attributes has the key +attr+ to avoid
+            #   doing any extra work in case this is a "normal"
+            #   (non-translated) attribute.
+            def _read_attribute(attr, *args)
+              if @attributes.key?(attr)
+                super
+              else
+                mobility_changed_attributes.include?(attr) ? __send__(attr) : super
               end
             end
-            model_class.extend has_attribute
+            private :_read_attribute
           end
         end
       end

data/lib/mobility/plugins/attribute_methods.rb

@@ -0,0 +1,41 @@
+module Mobility
+  module Plugins
+=begin
+
+Adds translated attribute names and values to the hash returned by #attributes.
+Also adds a method #translated_attributes with names and values of translated
+attributes only.
+
+@note Adding translated attributes to +attributes+ can have unexpected
+  consequences, since these attributes do not have corresponding columns in the
+  model table. Using this plugin may lead to conflicts with other gems.
+
+=end
+    module AttributeMethods
+      class << self
+        # Applies attribute_methods plugin for a given option value.
+        # @param [Attributes] attributes
+        # @param [Boolean] option Value of option
+        # @raise [ArgumentError] if model class does not support dirty tracking
+        def apply(attributes, option)
+          if option
+            include_attribute_methods_module(attributes.model_class, *attributes.names)
+          end
+        end
+
+        private
+
+        def include_attribute_methods_module(model_class, *attribute_names)
+          module_builder =
+            if Loaded::ActiveRecord && model_class.ancestors.include?(::ActiveRecord::AttributeMethods)
+              require "mobility/plugins/active_record/attribute_methods"
+              Plugins::ActiveRecord::AttributeMethods
+            else
+              raise ArgumentError, "#{model_class} does not support AttributeMethods plugin."
+            end
+          model_class.include module_builder.new(*attribute_names)
+        end
+      end
+    end
+  end
+end

data/lib/mobility/plugins/dirty.rb

@@ -14,11 +14,7 @@ details.
 @note Dirty tracking can have unexpected results when combined with fallbacks.
   A change in the fallback locale value will not mark an attribute falling
   through to that locale as changed, even though it may look like it has
-  changed. However, when the value for the current locale is changed from nil
-  or blank to a new value, the change will be recorded as a change from that
-  fallback value, rather than from the nil or blank value. The specs are the
-  most reliable source of information on the interaction between dirty tracking
-  and fallbacks.
+  changed. See the specs for details on expected behavior.
 
 =end
     module Dirty

data/lib/mobility/plugins/fallbacks.rb

@@ -15,14 +15,20 @@ defaults to an instance of +I18n::Locale::Fallbacks+, but can be configured
 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. 
 
-In addition, fallbacks can be disabled when reading by passing <tt>fallback:
-false</tt> to the reader method. This can be useful to determine the actual
-value of the translated attribute, including a possible +nil+ value. You can
-also pass a locale or array of locales to the +fallback+ option to use that
-locale or locales that read, e.g. <tt>fallback: :fr</tt> would fetch the French
-translation if the value in the current locale was +nil+, whereas <tt>fallback:
-[:fr, :es]</tt> would try French, then Spanish if the value in the current
-locale was +nil+.
+In addition, fallbacks are disabled in certain situation. 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.
+
+The other situation where fallbacks are disabled is when the locale is
+specified explicitly, either by passing a `locale` option to the accessor or by
+using locale or fallthrough accessors. (See example below.)
+
+You can also pass a locale or array of locales to the +fallback+ option to use
+that locale or locales that read, e.g. <tt>fallback: :fr</tt> would fetch the
+French translation if the value in the current locale was +nil+, whereas
+<tt>fallback: [:fr, :es]</tt> would try French, then Spanish if the value in
+the current locale was +nil+.
 
 @see https://github.com/svenfuchs/i18n/wiki/Fallbacks I18n Fallbacks
 
@@ -76,6 +82,26 @@ locale was +nil+.
   #=> nil
   post.title(fallback: :fr)
   #=> "Mobilité"
+
+@example Fallbacks disabled
+  class Post
+    translates :title, fallbacks: { :'fr' => 'en' }, locale_accessors: true
+  end
+
+  I18n.default_locale = :en
+  Mobility.locale = :en
+  post = Post.new(title: "Mobility")
+
+  Mobility.locale = :fr
+  post.title
+  #=> "Mobility"
+  post.title(fallback: false)
+  #=> nil
+  post.title(locale: :fr)
+  #=> nil
+  post.title_fr
+  #=> nil
+
 =end
     class Fallbacks < Module
       # Applies fallbacks plugin to attributes.
@@ -92,17 +118,16 @@ locale was +nil+.
       private
 
       def define_read(fallbacks)
-        define_method :read do |locale, **options|
-          fallback = options.delete(:fallback)
-
-          if fallback == false || (fallback.nil? && fallbacks.nil?)
-            super(locale, options)
-          else
-            (fallback ? [locale, *fallback] : fallbacks[locale]).detect do |fallback_locale|
-              value = super(fallback_locale, options)
-              break value if Util.present?(value)
-            end
+        define_method :read do |locale, fallback: true, **options|
+          return super(locale, options) if !fallback || options[:locale]
+
+          locales = fallback == true ? fallbacks[locale] : [locale, *fallback]
+          locales.each do |fallback_locale|
+            value = super(fallback_locale, options)
+            return value if Util.present?(value)
           end
+
+          super(locale, options)
         end
       end
 
@@ -112,7 +137,7 @@ locale was +nil+.
         elsif option == true
           Mobility.default_fallbacks
         else
-          option
+          Hash.new { [] }
         end
       end
     end

data/lib/mobility/plugins/fallthrough_accessors.rb

@@ -46,12 +46,12 @@ model class is generated.
       def initialize(*attributes)
         method_name_regex = /\A(#{attributes.join('|'.freeze)})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
 
-        define_method :method_missing do |method_name, *arguments, &block|
+        define_method :method_missing do |method_name, *arguments, **options, &block|
           if method_name =~ method_name_regex
             attribute = $1.to_sym
             locale, suffix = $2.split('_'.freeze)
             locale = "#{locale}-#{suffix.upcase}".freeze if suffix
-            Mobility.with_locale(locale) { public_send("#{attribute}#{$4}".freeze, *arguments) }
+            public_send("#{attribute}#{$4}".freeze, *arguments, **options, locale: locale.to_sym)
           else
             super(method_name, *arguments, &block)
           end

data/lib/mobility/plugins/locale_accessors.rb

@@ -58,14 +58,14 @@ If no locales are passed as an option to the initializer,
 
         define_method "#{name}_#{normalized_locale}" do |**options|
           return super() if options.delete(:super)
-          warn warning_message if options.delete(:locale)
-          Mobility.with_locale(locale) { send(name, options) }
+          warn warning_message if options[:locale]
+          public_send(name, **options, locale: locale)
         end
 
         define_method "#{name}_#{normalized_locale}?" do |**options|
           return super() if options.delete(:super)
-          warn warning_message if options.delete(:locale)
-          Mobility.with_locale(locale) { send("#{name}?", options) }
+          warn warning_message if options[:locale]
+          public_send("#{name}?", **options, locale: locale)
         end
       end
 
@@ -75,8 +75,8 @@ If no locales are passed as an option to the initializer,
 
         define_method "#{name}_#{normalized_locale}=" do |value, **options|
           return super(value) if options.delete(:super)
-          warn warning_message if options.delete(:locale)
-          Mobility.with_locale(locale) { send("#{name}=", value, options) }
+          warn warning_message if options[:locale]
+          public_send("#{name}=", value, **options, locale: locale)
         end
       end
     end

data/lib/mobility/version.rb

@@ -1,3 +1,3 @@
 module Mobility
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Salzberg
@@ -30,7 +30,7 @@ cert_chain:
   eGDROPZoL5RXwiOnRbexxa7dcAxMrDfGB/hpiunIPWPsi4n5P7K/6OO/sGVMl9xv
   SZBPXjzrHdyOFLBYXB+PG7s3F/4=
   -----END CERTIFICATE-----
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -55,7 +55,7 @@ dependencies:
         version: 0.6.10
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -65,7 +65,7 @@ dependencies:
         version: 0.6.10
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -163,7 +169,6 @@ files:
 - lib/mobility/active_model.rb
 - lib/mobility/active_model/backend_resetter.rb
 - lib/mobility/active_record.rb
-- lib/mobility/active_record/attribute_methods.rb
 - lib/mobility/active_record/backend_resetter.rb
 - lib/mobility/active_record/model_translation.rb
 - lib/mobility/active_record/string_translation.rb
@@ -221,7 +226,9 @@ files:
 - lib/mobility/plugins/active_model.rb
 - lib/mobility/plugins/active_model/dirty.rb
 - lib/mobility/plugins/active_record.rb
+- lib/mobility/plugins/active_record/attribute_methods.rb
 - lib/mobility/plugins/active_record/dirty.rb
+- lib/mobility/plugins/attribute_methods.rb
 - lib/mobility/plugins/cache.rb
 - lib/mobility/plugins/cache/translation_cacher.rb
 - lib/mobility/plugins/default.rb

data/lib/mobility/active_record/attribute_methods.rb

@@ -1,36 +0,0 @@
-module Mobility
-  module ActiveRecord
-=begin
-
-Included into model if model has +ActiveRecord::AttributeMethods+ among its
-ancestors.
-
-=end
-    module AttributeMethods
-      delegate :translated_attribute_names, to: :class
-
-      # Adds translated attributes to +attributes+.
-      # @return [Array<String>] Model attributes
-      # @!method attributes
-      def self.included(model)
-        attributes_method = Module.new do
-          def attributes
-            super.merge(translated_attributes)
-          end
-        end
-        model.class_eval do
-          alias_method :untranslated_attributes, :attributes
-          include attributes_method
-        end
-      end
-
-      # Translated attributes defined on model.
-      # @return [Array<String>] Translated attributes
-      def translated_attributes
-        translated_attribute_names.inject({}) do |attributes, name|
-          attributes.merge(name.to_s => send(name))
-        end
-      end
-    end
-  end
-end