mobility 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa18719235ac4c4f4dc7a50391d1aaa98e9963a0
-  data.tar.gz: 2aea9e420788a09176509fff75f1eb397656d6cd
+SHA256:
+  metadata.gz: e5043fe3bb4af2f09abf2cb81541680639b650777657e4ca776e178295b17ef8
+  data.tar.gz: cc8bead5891cd7ddcaf3d1166eb03102705c820551ffd75563219d293a2badc8
 SHA512:
-  metadata.gz: d59832bfc7f2e3b0672b5f8d690ec167731e49225cd2d135f1325fd4ac934a22bf040c3ddaaed9a56cb7e6d9ac6b050f0fb7458f6f7f8e456a6391a9337ad6ec
-  data.tar.gz: 8a0dde22222134bad52a65e47a83e4cc6829d3a5273aef7be06ca25491c01bdc3e53bd609079c65d45c16328506b1f4a88fc9ab43612ac8272f3d4485fc073a7
+  metadata.gz: b2753f7b33cac63eba6f8edee4a328cea6cc2f9f5ec36cf19a50a71731b7c1b1474b061c86ec82abd8b096b8aeb43d1e5900da8f17fd9e8c72d70052dbc8672b
+  data.tar.gz: 3eee2b8e73d06235472c3f1766eb64d2da8fd0367710d69865442c93c38a555fef6a8155f797d0e221ebb1fa74498786221b2da7896760841aaa2f20b2bf99ac

checksums.yaml.gz.sig

@@ -1,2 +1,3 @@
-�=^��&(�2x�P�f�^�n�_BE�i�ԟ;42?���ƴ�Ǿާ��Q���v����~l�YwW�w@��!
-��ƕyi���ϟ�
+#G��j�*l�:�)��y ��[��w� 33��d�Nz����`
+�<�[��P����$�
;����tS/趔9�v��Itm �ƒ\eP����F�_�y�n�WJܔhM������ES�;�� ���F,��x%�E�t7����aՑ��I��edd����&��)ױv��
��MB��,�l�d��eS�e���t3�3�:eQ�؛H����q��eJ9������N/�p<_���
+n2Ў �g���.����ߋ,K

data/CHANGELOG.md

@@ -1,8 +1,46 @@
 # Mobility Changelog
 
+## 0.7
+
+### 0.7.0 (May 30, 2018)
+
+* Restructure querying into plugin (ActiveRecord only)
+  ([#216](https://github.com/shioyama/mobility/pull/216),
+  [#225](https://github.com/shioyama/mobility/pull/225),
+  [#222](https://github.com/shioyama/mobility/pull/222), 
+* Support querying on multiple locales at once
+  ([#232](https://github.com/shioyama/mobility/pull/232))
+* Allow passing locale to query methods
+  ([#233](https://github.com/shioyama/mobility/pull/233))
+* Support matches and lower predicate methods
+  ([#235](https://github.com/shioyama/mobility/pull/235))
+* Implement case-insensitive uniqueness validation
+  ([#236](https://github.com/shioyama/mobility/pull/236),
+  [#237](https://github.com/shioyama/mobility/pull/237))
+* Support equality predicates between jsonb nodes
+  ([#240](https://github.com/shioyama/mobility/pull/240))
+* Prefer -> operator when comparing jsonb columns
+  ([#241](https://github.com/shioyama/mobility/pull/241))
+* Define options on subclassed backend class
+  ([#218](https://github.com/shioyama/mobility/pull/218))
+* Add column_affix 
+* Use module_eval to define locale_accessors
+  ([#219](https://github.com/shioyama/mobility/pull/219))
+* Improve performance of getters/setters
+  ([#220](https://github.com/shioyama/mobility/pull/220))
+* Do not include Default plugin by default
+  ([#223](https://github.com/shioyama/mobility/pull/223))
+* Add specific attribute types to basic usage example
+  ([#228](https://github.com/shioyama/mobility/pull/228)). Thanks
+  [thatguysimon](https://github.com/thatguysimon)!
+* Remove Mobility::Interface
+  ([#229](https://github.com/shioyama/mobility/pull/229))
+* Freeze attributes array
+  ([#230](https://github.com/shioyama/mobility/pull/230))
+
 ## 0.6
 
-### 0.6.1 (April 26, 2018)
+### 0.6.0 (April 26, 2018)
 
 * Add column_prefix/column_suffix options to hash backends
   ([#200](https://github.com/shioyama/mobility/pull/199) and

data/Gemfile.lock

@@ -8,14 +8,45 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      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)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      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)
-    byebug (10.0.0)
+    builder (3.2.3)
+    byebug (10.0.2)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
-    database_cleaner (1.6.2)
+    crass (1.0.4)
+    database_cleaner (1.7.0)
     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)
@@ -30,16 +61,23 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (1.0.0)
+    i18n (1.0.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)
-    lumberjack (1.0.12)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.0.13)
     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)
@@ -50,8 +88,21 @@ GEM
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    rack (2.0.4)
-    rake (12.3.0)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.3.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
@@ -71,29 +122,33 @@ 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)
-    yard (0.9.12)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    yard (0.9.13)
 
 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)
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/README.md

@@ -3,14 +3,11 @@ Mobility
 
 [![Gem Version](https://badge.fury.io/rb/mobility.svg)][gem]
 [![Build Status](https://travis-ci.org/shioyama/mobility.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/shioyama/mobility.svg)][gemnasium]
 [![Code Climate](https://api.codeclimate.com/v1/badges/72200f2b00c339ec4537/maintainability.svg)][codeclimate]
-
 [![Gitter Chat](https://badges.gitter.im/mobility-ruby/mobility.svg)](https://gitter.im/mobility-ruby/mobility)
 
 [gem]: https://rubygems.org/gems/mobility
 [travis]: https://travis-ci.org/shioyama/mobility
-[gemnasium]: https://gemnasium.com/shioyama/mobility
 [codeclimate]: https://codeclimate.com/github/shioyama/mobility
 [docs]: http://www.rubydoc.info/gems/mobility
 [wiki]: https://github.com/shioyama/mobility/wiki
@@ -54,7 +51,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 0.6.0'
+gem 'mobility', '~> 0.7.0'
 ```
 
 Mobility is cryptographically signed. To be sure the gem you install hasn't
@@ -169,6 +166,18 @@ class Word < ApplicationRecord
 end
 ```
 
+Note: When using the KeyValue backend, use the options hash to pass each attribute's type:
+
+```ruby
+class Word < ApplicationRecord
+  extend Mobility
+  translates :name,    type: :string
+  translates :meaning, type: :text
+end
+```
+
+This is important because this is how Mobility knows to which of the [two translation tables](https://github.com/shioyama/mobility/wiki/KeyValue-Backend) it should save your translation.
+
 You now have translated attributes `name` and `meaning` on the model `Word`.
 You can set their values like you would any other attribute:
 
@@ -658,13 +667,13 @@ complex implementations.
 
 ### <a name="querying"></a>Querying
 
-Database-backed Mobility backends also optionally support querying through
-`where` and other query methods (`not` and `find_by` for ActiveRecord models,
-`except` for Sequel models, etc). To query on these attributes, use the `i18n`
-class method, which will return a model relation extended with
-Mobility-specific query method overrides.
+Mobility backends also support querying on translated attributes, in two
+different ways. The first is via query methods like `where` (and `not` and
+`find_by` in ActiveRecord, and `except` in Sequel). To query this way, use the
+`i18n` class method, which will return a model relation or dataset extended
+with Mobility-specific query method overrides.
 
-So assuming a model:
+So for ActiveRecord, assuming a model:
 
 ```ruby
 class Post < ApplicationRecord
@@ -686,29 +695,29 @@ results in the SQL:
 
 ```sql
 SELECT "posts".* FROM "posts"
-INNER JOIN "mobility_string_translations" "title_mobility_string_translations"
-  ON "title_mobility_string_translations"."key" = 'title'
-  AND "title_mobility_string_translations"."locale" = 'en'
-  AND "title_mobility_string_translations"."translatable_type" = 'Post'
-  AND "title_mobility_string_translations"."translatable_id" = "posts"."id"
-INNER JOIN "mobility_text_translations" "content_mobility_text_translations"
-  ON "content_mobility_text_translations"."key" = 'content'
-  AND "content_mobility_text_translations"."locale" = 'en'
-  AND "content_mobility_text_translations"."translatable_type" = 'Post'
-  AND "content_mobility_text_translations"."translatable_id" = "posts"."id"
-WHERE "content_mobility_text_translations"."value" = 'bar'
-  AND "title_mobility_string_translations"."value" = 'foo'
+INNER JOIN "mobility_string_translations" "Post_title_en_string_translations"
+  ON "Post_title_en_string_translations"."key" = 'title'
+  AND "Post_title_en_string_translations"."locale" = 'en'
+  AND "Post_title_en_string_translations"."translatable_type" = 'Post'
+  AND "Post_title_en_string_translations"."translatable_id" = "posts"."id"
+INNER JOIN "mobility_text_translations" "Post_content_en_text_translations"
+  ON "Post_content_en_text_translations"."key" = 'content'
+  AND "Post_content_en_text_translations"."locale" = 'en'
+  AND "Post_content_en_text_translations"."translatable_type" = 'Post'
+  AND "Post_content_en_text_translations"."translatable_id" = "posts"."id"
+WHERE "Post_title_en_string_translations"."value" = 'foo'
+  AND "Post_content_en_text_translations"."value" = 'bar'
 ```
 
 As can be seen in the query above, behind the scenes Mobility joins two tables,
 one with string translations and one with text translations, and aliases the
-joins for each attribute so as to match the particular values passed in to the
-query. Details of how this is done can be found in the [Wiki page for the
-KeyValue
+joins for each attribute so as to match the particular model, attribute(s),
+locale(s) and value(s) passed in to the query. Details of how this is done can
+be found in the [Wiki page for the KeyValue
 backend](https://github.com/shioyama/mobility/wiki/KeyValue-Backend#querying).
 
-If you would prefer to avoid the `i18n` scope everywhere, define it as a
-default scope on your model:
+If you would prefer to avoid the `i18n` scope everywhere, you can define it as
+a default scope on your model:
 
 ```ruby
 class Post < ApplicationRecord
@@ -726,6 +735,29 @@ Post.find_by(title: "Introducing Mobility")
 #=> finds post with English title "Introducing Mobility"
 ```
 
+If you want more fine-grained control over your queries, you can alternatively
+pass a block to the query method and call attribute names from the block scope
+to build Arel predicates:
+
+```ruby
+Post.i18n do |title, content|
+  title.matches("foo").and(content.matches("bar"))
+end
+```
+
+which generates the same SQL as above, except the `WHERE` clause becomes:
+
+```sql
+SELECT "posts".* FROM "posts"
+  ...
+WHERE "Post_title_en_string_translations"."value" ILIKE 'foo'
+  AND "Post_content_en_text_translations"."value" ILIKE 'bar'
+```
+
+The block-format query format is very powerful and allows you to build complex
+backend-independent queries on translated and untranslated attributes without
+having to deal with the details of how these translations are stored.
+
 <a name="backends"></a>Backends
 --------
 
@@ -817,6 +849,10 @@ pages of the wiki and in the API documentation
 and
 [`Mobility::Backend::Hstore`](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Hstore)).
 
+*Note: The Json backend (`:json`) may also work with recent versions of MySQL
+with JSON column support, although this backend/db combination is not tested.
+See [this issue](https://github.com/shioyama/mobility/issues/226) for details.*
+
 Development
 -----------
 

data/lib/mobility.rb

@@ -25,8 +25,6 @@ in backends to define gem-dependent behavior.
 
 =end
 module Mobility
-  require "mobility/adapter"
-  require "mobility/accumulator"
   require "mobility/attributes"
   require "mobility/backend"
   require "mobility/backends"
@@ -83,8 +81,9 @@ module Mobility
     def extended(model_class)
       return if model_class.respond_to? :mobility_accessor
 
-      model_class.include(InstanceMethods)
-      model_class.extend(ClassMethods)
+      model_class.extend Translates
+      #TODO: Remove in v1.0
+      model_class.include InstanceMethods
 
       if translates = Mobility.config.accessor_method
         model_class.singleton_class.send(:alias_method, translates, :mobility_accessor)
@@ -177,6 +176,7 @@ module Mobility
       config.public_send(:default_fallbacks, *args)
     end
 
+    # TODO: Make private in v1.0
     def new_fallbacks(*args)
       config.public_send(:new_fallbacks, *args)
     end
@@ -244,48 +244,33 @@ EOL
     end
   end
 
+  # TODO: Remove entire module in v1.0
   module InstanceMethods
     # Fetch backend for an attribute
-    # @deprecated Use mobility.backend_for(attribute) instead.
+    # @deprecated Use mobility_backends[:<attribute>] instead.
     # @param [String] attribute Attribute
-    # TODO: Remove in v1.0
     def mobility_backend_for(attribute)
       warn %{
 WARNING: mobility_backend_for is deprecated and will be removed in the next
-major version of Mobility. Use <post>.mobility.backend_for(attributes)
-instead.}
-      mobility.backend_for(attribute)
-    end
-
-    def initialize_dup(other)
-      @mobility_backends = nil
-      super
+version of Mobility. Use <post>.<attribute>_backend instead.}
+      mobility_backends[attribute.to_sym]
     end
 
     def mobility
+      warn %{
+WARNING: <post>.mobility is deprecated and will be removed in the next
+version of Mobility. To get backends, use <post>.<attribute>_backend instead.}
       @mobility ||= Adapter.new(self)
     end
-  end
-
-  module ClassMethods
-    include Translates
-
-    def mobility
-      @mobility ||= Accumulator.new
-    end
 
-    def translated_attribute_names
-      mobility.translated_attribute_names
-    end
-
-    def inherited(subclass)
-      subclass.instance_variable_set(:@mobility, mobility.dup)
-      super
+    class Adapter < Struct.new(:model)
+      def backend_for(attribute)
+        model.mobility_backends[attribute.to_sym]
+      end
     end
+    private_constant :Adapter
   end
-  private_constant :ClassMethods, :InstanceMethods
 
-  class BackendRequired < ArgumentError; end
   class InvalidLocale < I18n::InvalidLocale; end
   class NotImplementedError < StandardError; end
 end

data/lib/mobility/active_record.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require "mobility/arel"
+
 module Mobility
 =begin
 
@@ -10,7 +12,6 @@ Module loading ActiveRecord-specific classes for Mobility models.
 
     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))
@@ -18,16 +19,5 @@ Module loading ActiveRecord-specific classes for Mobility models.
         delegate :translated_attribute_names, to: :class
       end
     end
-
-    class QueryMethod < Module
-      def initialize(query_method)
-        module_eval <<-EOM, __FILE__, __LINE__ + 1
-          def #{query_method}
-            all
-          end
-        EOM
-      end
-    end
-    private_constant :QueryMethod
   end
 end