mobility 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0b92c27c73b5d4052c752d8d63a5b6790696f89
-  data.tar.gz: b58166a5c8ef6acdb721b5d4976be04834b65031
+  metadata.gz: aa18719235ac4c4f4dc7a50391d1aaa98e9963a0
+  data.tar.gz: 2aea9e420788a09176509fff75f1eb397656d6cd
 SHA512:
-  metadata.gz: 497358cffc62727e4197b38cca78eb7b7fec7b591921fc814ee84c915be6925f3082d7820f07541212ad42704e6dd55a89503b59ce56b14c56aaa8823108b7d8
-  data.tar.gz: 82b9f2c2de83f49ba2b2bc2f716d3aacc61631cb430e29977c6d7281b87f85b871b73aa6b71f5dce9b2e54f15f4bbf0659c48c3ec462753f5012aa602eb9d9c6
+  metadata.gz: d59832bfc7f2e3b0672b5f8d690ec167731e49225cd2d135f1325fd4ac934a22bf040c3ddaaed9a56cb7e6d9ac6b050f0fb7458f6f7f8e456a6391a9337ad6ec
+  data.tar.gz: 8a0dde22222134bad52a65e47a83e4cc6829d3a5273aef7be06ca25491c01bdc3e53bd609079c65d45c16328506b1f4a88fc9ab43612ac8272f3d4485fc073a7

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-$��y�;i�����I�mLJ�(������xeܧ��U��R�ˀ�"<֋�ժb]a����N�B��s�.p���:^6��n�f���?^��=��z�҇q��';��.�����A�_P0F%�b�-U�b��V��fqW*#&��#�M:W �-���'��I%����
-���o�A��v��uh���gH�����ȠtSڽ�Y�<P-ba�,�X�S�B��	G�4�v�E$�ź�B��,J
+�=^��&(�2x�P�f�^�n�_BE�i�ԟ;42?���ƴ�Ǿާ��Q���v����~l�YwW�w@��!
+��ƕyi���ϟ�

data/CHANGELOG.md

@@ -1,6 +1,44 @@
 # Mobility Changelog
 
-## 0.4
+## 0.6
+
+### 0.6.1 (April 26, 2018)
+
+* Add column_prefix/column_suffix options to hash backends
+  ([#200](https://github.com/shioyama/mobility/pull/199) and
+  [#201](https://github.com/shioyama/mobility/pull/201))
+* Require specifying type for KeyValue backends
+  ([#200](https://github.com/shioyama/mobility/pull/200))
+* Remove table backend index on foreign key alone
+  ([#198](https://github.com/shioyama/mobility/pull/198))
+* Test/cleanup index name truncation in backend generators
+  ([#197](https://github.com/shioyama/mobility/pull/197))
+* Improve translations generators
+  ([#196](https://github.com/shioyama/mobility/pull/196))
+* Enforce null: false constraint on columns consistently
+  ([#205](https://github.com/shioyama/mobility/pull/205))
+* Add extension to find translations in a locale for Table backend
+  ([#202](https://github.com/shioyama/mobility/pull/202))
+* Ignore non-arel nodes in joins_values
+  ([#206](https://github.com/shioyama/mobility/pull/206))
+* Collapse duplicates in array-valued query hash
+  ([#207](https://github.com/shioyama/mobility/pull/207))
+* Remove unneeded anonymous module in backend resetters
+  ([#213](https://github.com/shioyama/mobility/pull/213))
+* Make constants private
+  ([#214](https://github.com/shioyama/mobility/pull/214))
+* Use IN when querying on array values with PG backends
+  ([#209](https://github.com/shioyama/mobility/pull/209))
+* Remove some deprecated methods
+  ([#215](https://github.com/shioyama/mobility/pull/215))
+* Explicitly implement matches/has_locale methods everywhere
+  ([#194](https://github.com/shioyama/mobility/pull/194))
+* Refactor Mobility::Backends::AR::QueryMethods using MobilityWhereChain module
+  ([#193](https://github.com/shioyama/mobility/pull/193))
+* Add missing documentation
+  ([#192](https://github.com/shioyama/mobility/pull/192))
+
+## 0.5
 
 ### 0.5.1 (March 21, 2018)
 * Fix issues with Dirty plugin in ActiveRecord 5.2.0.rc2
@@ -17,6 +55,8 @@
 * Use pragma comments to freeze strings everywhere
   ([#177](https://github.com/shioyama/mobility/pull/177))
 
+## 0.4
+
 ### 0.4.3 (February 18, 2018)
 * Add missing require in container backend
   ([#174](https://github.com/shioyama/mobility/pull/174))

data/Gemfile.lock

@@ -1,52 +1,21 @@
 PATH
   remote: .
   specs:
-    mobility (0.5.0)
+    mobility (0.6.0)
       i18n (>= 0.6.10, < 1.1)
       request_store (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.0.rc2)
-      actionview (= 5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
-    activerecord (5.2.0.rc2)
-      activemodel (= 5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
-      arel (>= 9.0)
-    activesupport (5.2.0.rc2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
     benchmark-ips (2.7.2)
-    builder (3.2.3)
     byebug (10.0.0)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
-    crass (1.0.3)
     database_cleaner (1.6.2)
     diff-lcs (1.3)
-    erubi (1.7.1)
     ffi (1.9.23)
     formatador (0.2.5)
-    generator_spec (0.9.4)
-      activesupport (>= 3.0.0)
-      railties (>= 3.0.0)
     guard (2.14.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -67,17 +36,10 @@ GEM
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    loofah (2.2.1)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
     lumberjack (1.0.12)
     method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
     mysql2 (0.4.10)
     nenv (0.3.0)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -89,19 +51,6 @@ GEM
       byebug (~> 10.0)
       pry (~> 0.10)
     rack (2.0.4)
-    rack-test (0.8.3)
-      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.2.0.rc2)
-      actionpack (= 5.2.0.rc2)
-      activesupport (= 5.2.0.rc2)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
     rake (12.3.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
@@ -122,31 +71,27 @@ GEM
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
     ruby_dep (1.5.0)
+    sequel (5.7.1)
     shellany (0.0.1)
     sqlite3 (1.3.13)
     thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
     yard (0.9.12)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (>= 5.2.0.rc2, < 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 (< 1.0)
   pry-byebug
-  railties (>= 5.2.0.rc2, < 5.3)
   rake (~> 12, >= 12.2.1)
   rspec (~> 3.0)
+  sequel (>= 5.0.0, < 6.0.0)
   sqlite3
   yard (~> 0.9.0)
 

data/README.md

@@ -54,7 +54,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 0.5.1'
+gem 'mobility', '~> 0.6.0'
 ```
 
 Mobility is cryptographically signed. To be sure the gem you install hasn't
@@ -107,8 +107,12 @@ 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`):
+on the `config.default_options` hash. Below, we turn on the Dirty plugin by
+default, so it will be enabled for all models.
+
+You can also set defaults for backend-specific options. Below, we set the
+default `type` option for the KeyValue backend to `:string` (this is
+unnecessary and will be ignored if you are using a different backend).
 
 ```diff
  Mobility.configure do |config|
@@ -116,11 +120,12 @@ the `dirty` option to `true`):
    config.accessor_method = :translates
    config.query_method    = :i18n
 +  config.default_options[:dirty] = true
++  config.default_options[:type]  = :string
 end
 ```
 
-Other configuration options are
-described in the [API
+We will assume the configuration above in the examples that follow. Other
+configuration options are described in the [API
 docs](http://www.rubydoc.info/gems/mobility/Mobility/Configuration).
 
 See [Getting Started](#quickstart) to get started translating your models.
@@ -136,8 +141,7 @@ You can extend `Mobility` just like in ActiveRecord, or you can use the
 ```ruby
 class Word < ::Sequel::Model
   plugin :mobility
-  translates :name,    type: :string
-  translates :meaning, type: :text
+  translates :name, :meaning
 end
 ```
 
@@ -161,15 +165,12 @@ of options, like this:
 ```ruby
 class Word < ApplicationRecord
   extend Mobility
-  translates :name,    type: :string
-  translates :meaning, type: :text
+  translates :name, :meaning
 end
 ```
 
-You now have translated attributes `name` (as a string column) and `meaning`
-(as a text column) on the model `Word`. You can set their values like you
-would any other attribute:
-
+You now have translated attributes `name` and `meaning` on the model `Word`.
+You can set their values like you would any other attribute:
 
 ```ruby
 word = Word.new
@@ -262,7 +263,7 @@ option when defining translated attributes on the model class:
 ```ruby
 class Word < ApplicationRecord
   extend Mobility
-  translates :name, type: :string, locale_accessors: [:en, :ja]
+  translates :name, locale_accessors: [:en, :ja]
 end
 ```
 
@@ -302,7 +303,7 @@ For example, if we define `Word` this way:
 ```ruby
 class Word < ApplicationRecord
   extend Mobility
-  translates :name, type: :string, fallthrough_accessors: true
+  translates :name, fallthrough_accessors: true
 end
 ```
 
@@ -368,7 +369,7 @@ reading and writing from the backend instance this way.
 
 The `write` methods do not call underlying backend's methods to persist the change.
 This is up to the user (e.g. with ActiveRecord you should call `save` write
-the changes to the database.
+the changes to the database).
 
 ### Setting the Locale
 
@@ -416,8 +417,8 @@ translated attributes on a class:
 ```ruby
 class Word < ApplicationRecord
   extend Mobility
-  translates :name,    type: :string, fallbacks: { de: :ja, fr: :ja }, locale_accessors: true
-  translates :meaning, type: :text,   fallbacks: { de: :ja, fr: :ja }, locale_accessors: true
+  translates :name,    fallbacks: { de: :ja, fr: :ja }, locale_accessors: true
+  translates :meaning, fallbacks: { de: :ja, fr: :ja }, locale_accessors: true
 end
 ```
 
@@ -511,7 +512,7 @@ Another option is to assign a default value, which will be used if the result of
 ```ruby
 class Word < ApplicationRecord
   extend Mobility
-  translates :name, type: :string, default: 'foo'
+  translates :name, default: 'foo'
 end
 
 Mobility.locale = :ja
@@ -559,7 +560,7 @@ dirty tracking is not specific to AR and works for non-persisted models as well)
 ```ruby
 class Post < ApplicationRecord
   extend Mobility
-  translates :title, type: :string, dirty: true
+  translates :title, dirty: true
 end
 ```
 
@@ -644,7 +645,7 @@ false` when defining an attribute, like this:
 ```ruby
 class Word < ApplicationRecord
   extend Mobility
-  translates :name, type: :string, cache: false
+  translates :name, cache: false
 end
 ```
 

data/lib/mobility.rb

@@ -143,7 +143,7 @@ module Mobility
     # @!group Configuration Methods
     # @return [Mobility::Configuration] Mobility configuration
     def config
-      @configuration ||= Mobility::Configuration.new
+      @configuration ||= Configuration.new
     end
 
     # (see Mobility::Configuration#accessor_method)
@@ -271,7 +271,7 @@ instead.}
     include Translates
 
     def mobility
-      @mobility ||= Mobility::Accumulator.new
+      @mobility ||= Accumulator.new
     end
 
     def translated_attribute_names
@@ -283,6 +283,7 @@ instead.}
       super
     end
   end
+  private_constant :ClassMethods, :InstanceMethods
 
   class BackendRequired < ArgumentError; end
   class InvalidLocale < I18n::InvalidLocale; end

data/lib/mobility/accumulator.rb

@@ -2,8 +2,7 @@ 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. It is also a
-simple delegator, so any missing method will be delegated to the model class.
+which {Attributes} modules have been included on the model class.
 
 =end
   class Accumulator

data/lib/mobility/active_model/backend_resetter.rb

@@ -9,7 +9,7 @@ Backend resetter for ActiveModel models. Adds hook to reset backend when
     class BackendResetter < Mobility::BackendResetter
 
       # (see Mobility::BackendResetter#initialize)
-      def initialize(attribute_names)
+      def initialize(attribute_names, &block)
         super
 
         model_reset_method = @model_reset_method

data/lib/mobility/active_record.rb

@@ -8,6 +8,17 @@ Module loading ActiveRecord-specific classes for Mobility models.
   module ActiveRecord
     require "mobility/active_record/uniqueness_validator"
 
+    def self.included(model_class)
+      model_class.class_eval do
+        extend QueryMethod.new(Mobility.query_method)
+        unless const_defined?(:UniquenessValidator)
+          const_set(:UniquenessValidator,
+                    Class.new(::Mobility::ActiveRecord::UniquenessValidator))
+        end
+        delegate :translated_attribute_names, to: :class
+      end
+    end
+
     class QueryMethod < Module
       def initialize(query_method)
         module_eval <<-EOM, __FILE__, __LINE__ + 1
@@ -17,14 +28,6 @@ Module loading ActiveRecord-specific classes for Mobility models.
         EOM
       end
     end
-
-    def self.included(model_class)
-      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.delegate :translated_attribute_names, to: :class
-    end
+    private_constant :QueryMethod
   end
 end

data/lib/mobility/active_record/backend_resetter.rb

@@ -11,16 +11,15 @@ Backend resetter for ActiveRecord models. Adds hook on +reload+ event to
 =end
     class BackendResetter < Mobility::ActiveModel::BackendResetter
 
-      # @param [Class] model_class Class of model to which backend resetter will be applied
-      def included(model_class)
+      # (see Mobility::BackendResetter#initialize)
+      def initialize(attribute_names, &block)
+        super
+
         model_reset_method = @model_reset_method
 
-        mod = Module.new do
-          define_method :reload do |*args|
-            super(*args).tap { instance_eval(&model_reset_method) }
-          end
+        define_method :reload do |*args|
+          super(*args).tap { instance_eval(&model_reset_method) }
         end
-        model_class.include mod
       end
     end
   end

data/lib/mobility/active_record/uniqueness_validator.rb

@@ -3,10 +3,20 @@ module Mobility
 =begin
 
 A backend-agnostic uniqueness validator for ActiveRecord translated attributes.
+To use the validator, you must +extend Mobility+ before calling +validates+
+(see example below).
 
 @note This validator does not support case sensitivity, since doing so would
   significantly complicate implementation.
 
+@example Validating uniqueness on translated model
+  class Post < ActiveRecord::Base
+    extend Mobility
+    translates :title
+
+    # This must come *after* extending Mobility.
+    validates :title, uniqueness: true
+  end
 =end
     class UniquenessValidator < ::ActiveRecord::Validations::UniquenessValidator
       # @param [ActiveRecord::Base] record Translated model
@@ -15,7 +25,7 @@ A backend-agnostic uniqueness validator for ActiveRecord translated attributes.
       def validate_each(record, attribute, value)
         klass = record.class
 
-        if ((Array(options[:scope]) + [attribute]).map(&:to_s) & klass.translated_attribute_names).present?
+        if (([*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}
@@ -40,7 +50,7 @@ support case-insensitive validation. This option will be ignored for: #{attribut
       private
 
       def mobility_scope_relation(record, relation)
-        Array(options[:scope]).inject(relation) do |scoped_relation, scope_item|
+        [*options[:scope]].inject(relation) do |scoped_relation, scope_item|
           scoped_relation.where(scope_item => record.send(scope_item))
         end
       end