mobility 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d41db6e7a795ddcef9e26a6707ead0b0e292e18a4555851f0c190e9572895f53
-  data.tar.gz: dd1e77bbb86a8bb7f5a5740fdf5b2c3a5096c0474e651691a9c80d5fb3b000d0
+  metadata.gz: 93685e1d8296d7f0f9c2a74e07a40af397fa1eef52d2d8c51d63ac6ed7a33812
+  data.tar.gz: be5beb1769d824f8687b0d2e5b796738ffa98dd35e6018de126ce909e089c278
 SHA512:
-  metadata.gz: adc549d6843493f3f711ffa892b2fde61de54077510a6b12a488c25196e8993c2d7b49d16cf851b2deaef551388ed9830db1a8099ba707aba5a5facd868bd4b0
-  data.tar.gz: 6c80e9f23841f09559a4f047dac424a9a0d3f94c918fce9f4ceda80b48391b6774022d9a1936ff67f65cc4942824466ab92632fe18fddcb3ae71a150599d5c48
+  metadata.gz: 0dfa4ca2101b75d34a62d8a445bb58cf84a75d39346568bd816d064bdfc637fb11e8e79cf963789d18cde779ce588fff596d264b728f68cf53c382ad57a5ccb9
+  data.tar.gz: 3b907f55dffe8823d12f2b04bb57fea611cea6ac316f4572859c484e8692a89179d1114c8966ad801007d6833615943abf9c7ff89be5c924f9b9b719cdc25894

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Mobility Changelog
 
-## 0.7
+## 0.8
+
+### 0.8.0 (September 11, 2018)
+* Support order clause on translated queries (ActiveRecord)
+  ([#261](https://github.com/shioyama/mobility/pull/261)) 
+* Restructure Sequel querying into plugin
+  ([#255](https://github.com/shioyama/mobility/pull/255),
+  [#267](https://github.com/shioyama/mobility/pull/267),
+  [#268](https://github.com/shioyama/mobility/pull/267))
+* Default locale to Mobility.locale in apply_scope
+  ([#263](https://github.com/shioyama/mobility/pull/263))
 
 ### 0.7.6 (July 6, 2018)
 * Sequel pg_hash require hash_initializer
@@ -33,7 +43,7 @@
 * 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),
+  [#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
@@ -49,7 +59,8 @@
   ([#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
+* Add column_affix when configuring options
+  ([#217](https://github.com/shioyama/mobility/pull/217))
 * Use module_eval to define locale_accessors
   ([#219](https://github.com/shioyama/mobility/pull/219))
 * Improve performance of getters/setters

data/Gemfile.lock

@@ -8,14 +8,45 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      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.2)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
+    crass (1.0.4)
     database_cleaner (1.7.0)
     diff-lcs (1.3)
+    erubi (1.7.1)
     ffi (1.9.24)
     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)
@@ -36,10 +67,17 @@ GEM
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
+    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.4)
+      mini_portile2 (~> 2.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -51,6 +89,19 @@ GEM
       byebug (~> 10.0)
       pry (~> 0.10)
     rack (2.0.5)
+    rack-test (1.1.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.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rake (12.3.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
@@ -74,19 +125,25 @@ GEM
     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.14)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (>= 5.2.0.rc2, < 5.3)
   benchmark-ips
   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)
   sqlite3

data/README.md

@@ -51,7 +51,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 0.7.6'
+gem 'mobility', '~> 0.8.0'
 ```
 
 Mobility is cryptographically signed. To be sure the gem you install hasn't
@@ -673,7 +673,7 @@ different ways. The first is via query methods like `where` (and `not` and
 `i18n` class method, which will return a model relation or dataset extended
 with Mobility-specific query method overrides.
 
-So for ActiveRecord, assuming a model:
+So for ActiveRecord, assuming a model using KeyValue as its default backend:
 
 ```ruby
 class Post < ApplicationRecord
@@ -740,7 +740,7 @@ 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|
+Post.i18n do
   title.matches("foo").and(content.matches("bar"))
 end
 ```
@@ -756,7 +756,8 @@ WHERE "Post_title_en_string_translations"."value" ILIKE 'foo'
 
 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.
+having to deal with the details of how these translations are stored. The same
+interface is supported with Sequel to build datasets.
 
 <a name="backends"></a>Backends
 --------
@@ -930,6 +931,16 @@ Integrations
 * [friendly_id-mobility](https://github.com/shioyama/friendly_id-mobility): Use
   Mobility with [FriendlyId](https://github.com/norman/friendly_id).
 
+Tutorials
+---------
+
+- [Polyglot content in a rails
+  app](https://revs.runtime-revolution.com/polyglot-content-in-a-rails-app-aed823854955)
+- [Translating with
+  Mobility](https://dejimata.com/2017/3/3/translating-with-mobility)
+- [JSONify your Ruby
+  Translations](https://dejimata.com/2018/3/20/jsonify-your-ruby-translations)
+
 More Information
 ----------------
 

data/lib/mobility.rb

@@ -117,7 +117,7 @@ module Mobility
     # Sets Mobility locale
     # @param [Symbol] locale Locale to set
     # @raise [InvalidLocale] if locale is nil or not in
-    #   +I18n.available_locales+ (if +I18n.enforce_available_locales+ is +true+)
+    #   +Mobility.available_locales+ (if +I18n.enforce_available_locales+ is +true+)
     # @return [Symbol] Locale
     def locale=(locale)
       set_locale(locale)
@@ -239,6 +239,22 @@ EOL
       end
     end
 
+    # Returns available locales. Defaults to I18n.available_locales, but will
+    # use Rails.application.config.i18n.available_locales if Rails is loaded
+    # and config is non-nil.
+    # @return [Array<Symbol>] Available locales
+    # @note The special case for Rails is necessary due to the fact that Rails
+    #   may load the model before setting +I18n.available_locales+. If we
+    #   simply default to +I18n.available_locales+, we may define many more
+    #   methods (in LocaleAccessors) than is really necessary.
+    def available_locales
+      if Loaded::Rails && Rails.application
+        Rails.application.config.i18n.available_locales || I18n.available_locales
+      else
+        I18n.available_locales
+      end
+    end
+
     protected
 
     def read_locale

data/lib/mobility/active_record/uniqueness_validator.rb

@@ -27,7 +27,7 @@ To use the validator, you must +extend Mobility+ before calling +validates+
 
         if (([*options[:scope]] + [attribute]).map(&:to_s) & klass.mobility_attributes).present?
           return unless value.present?
-          relation = klass.__mobility_query_scope__ do |m|
+          relation = klass.unscoped.__mobility_query_scope__ do |m|
             node = m.__send__(attribute)
             options[:case_sensitive] == false ? node.lower.eq(value.downcase) : node.eq(value)
           end

data/lib/mobility/arel/nodes.rb

@@ -2,13 +2,10 @@
 module Mobility
   module Arel
     module Nodes
-      class Unary  < ::Arel::Nodes::Unary;  end
       class Binary < ::Arel::Nodes::Binary; end
       class Grouping < ::Arel::Nodes::Grouping; end
-      class Equality < ::Arel::Nodes::Equality; end
 
       ::Arel::Visitors::ToSql.class_eval do
-        alias :visit_Mobility_Arel_Nodes_Equality :visit_Arel_Nodes_Equality
         alias :visit_Mobility_Arel_Nodes_Grouping :visit_Arel_Nodes_Grouping
       end
     end

data/lib/mobility/arel/nodes/pg_ops.rb

@@ -19,10 +19,6 @@ module Mobility
           include ::Arel::OrderPredications
           include ::Arel::AliasPredication
 
-          def eq other
-            Equality.new self, quoted_node(other)
-          end
-
           def lower
             super self
           end

data/lib/mobility/attributes.rb

@@ -20,53 +20,61 @@ 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 (approximately) like this:
+will generate an anonymous module that behaves approximately like this:
 
   Module.new do
-    def title_backend
-      # Create a subclass of Mobility::Backends::MyBackend and include in it:
+    def mobility_backends
+      # Returns a memoized hash with attribute name keys and backend instance
+      # values.  When a key is fetched from the hash, the hash calls
+      # +self.class.mobility_backend_class(name)+ (where +name+ is the
+      # attribute name) to get the backend class, then instantiate it (passing
+      # the model instance and attribute name to its initializer) and return it.
+      #
+      # The backend class returned from the class method
+      # +mobility_backend_class+ returns a subclass of
+      # +Mobility::Backends::MyBackend+ and includes into it:
+      #
       # - Mobility::Plugins::Cache (from the +cache: true+ option)
-      # - Mobility::Plugins::Fallbacks (from the +fallbacks: true+ option)
+      # - instance of Mobility::Plugins::Fallbacks (from the +fallbacks: true+ option)
       # - Mobility::Plugins::Presence (by default, disabled by +presence: false+)
-      # Then instantiate the backend, memoize it, and return it.
     end
 
-    def title(**options)
-      title_backend.read(Mobility.locale, **options).presence
+    def title(locale: Mobility.locale)
+      mobility_backends[:title].read(locale)
     end
 
-    def title?(**options)
-      title_backend.read(Mobility.locale, **options).present?
+    def title?(locale: Mobility.locale)
+      mobility_backends[:title].read(locale).present?
     end
 
-    def title=(value)
-      title_backend.write(Mobility.locale, value.presence)
+    def title=(value, locale: Mobility.locale)
+      mobility_backends[:title].write(locale, value)
     end
 
     # Start Locale Accessors
     #
-    def title_en(**options)
-      title_backend.read(:en, **options).presence
+    def title_en
+      title(locale: :en)
     end
 
-    def title_en?(**options)
-      title_backend.read(:en, **options).present?
+    def title_en?
+      title?(locale: :en)
     end
 
     def title_en=(value)
-      title_backend.write(:en, value.presence)
+      public_send(:title=, value, locale: :en)
     end
 
-    def title_ja(**options)
-      title_backend.read(:ja, **options).presence
+    def title_ja
+      title(locale: :ja)
     end
 
-    def title_ja?(**options)
-      title_backend.read(:ja, **options).present?
+    def title_ja?
+      title?(locale: :ja)
     end
 
     def title_ja=(value)
-      title_backend.write(:ja, value.presence)
+      public_send(:title=, value, locale: :ja)
     end
     # End Locale Accessors
   end
@@ -75,6 +83,10 @@ Including this module into a model class will thus add the backend method, the
 reader, writer and presence methods, and the locale accessor so the model
 class. (These methods are in fact added to the model in an +included+ hook.)
 
+Note that some simplifications have been made above for readability. (In
+reality, all getters and setters accept an options hash which is passed along
+to the backend instance.)
+
 ==Setting up the Model Class
 
 Accessor methods alone are of limited use without a hook to actually modify the
@@ -88,9 +100,6 @@ This allows a backend to do things like (for example) define associations on a
 model class required by the backend, as happens in the {Backends::KeyValue} and
 {Backends::Table} backends.
 
-The +setup+ block is also used to extend the query scope/dataset (+i18n+ by
-default) with backend-specific query method support.
-
 Since setup blocks are evaluated on the model class, it is possible that
 backends can conflict (for example, overwriting previously defined methods).
 Care should be taken to avoid defining methods on the model class, or where
@@ -244,6 +253,7 @@ EOL
     module InstanceMethods
       # Return a new backend for an attribute name.
       # @return [Hash] Hash of attribute names and backend instances
+      # @api private
       def mobility_backends
         @mobility_backends ||= Hash.new do |hash, name|
           next hash[name.to_sym] if String === name
@@ -262,7 +272,7 @@ EOL
       # of this model.
       # @return [Array<Mobility::Attributes>] Attribute modules
       def mobility_modules
-        ancestors.select { |mod| Attributes === mod }
+        ancestors.grep(Attributes)
       end
 
       # Return translated attribute names on this model.
@@ -271,6 +281,13 @@ EOL
         mobility_modules.map(&:names).flatten.uniq
       end
 
+      # Return true if attribute name is translated on this model.
+      # @param [String, Symbol] Attribute name
+      # @return [Boolean]
+      def mobility_attribute?(name)
+        mobility_attributes.include?(name.to_s)
+      end
+
       # @!method translated_attribute_names
       # @return (see #mobility_attributes)
       alias translated_attribute_names mobility_attributes

data/lib/mobility/backends/active_record.rb

@@ -22,10 +22,10 @@ module Mobility
 
         # @param [ActiveRecord::Relation] relation Relation to scope
         # @param [Object] predicate Arel predicate
-        # @param [Symbol] locale Locale
+        # @param [Symbol] locale (Mobility.locale) Locale
         # @option [Boolean] invert
         # @return [ActiveRecord::Relation] Relation with scope added
-        def apply_scope(relation, _predicate, _locale, invert: false)
+        def apply_scope(relation, _predicate, _locale = Mobility.locale, invert: false)
           relation
         end
 

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

@@ -14,8 +14,8 @@ translatable columns to the model table with:
   rails generate mobility:translations post title:string
 
 The generated migration will add columns +title_<locale>+ for every locale in
-+I18n.available_locales+. (The generator can be run again to add new attributes
-or locales.)
++Mobility.available_locales+ (i.e. +I18n.available_locales+). (The generator
+can be run again to add new attributes or locales.)
 
 @example
   class Post < ActiveRecord::Base

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

@@ -29,8 +29,6 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
       include ActiveRecord
       include KeyValue
 
-      option_reader :table_alias_affix
-
       class << self
         # @!group Backend Configuration
         # @option (see Mobility::Backends::KeyValue::ClassMethods#configure)
@@ -59,10 +57,10 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
         # Joins translations using either INNER/OUTER join appropriate to the query.
         # @param [ActiveRecord::Relation] relation Relation to scope
         # @param [Object] predicate Arel predicate
-        # @param [Symbol] locale Locale
+        # @param [Symbol] locale (Mobility.locale) Locale
         # @option [Boolean] invert
         # @return [ActiveRecord::Relation] relation Relation with joins applied (if needed)
-        def apply_scope(relation, predicate, locale, invert: false)
+        def apply_scope(relation, predicate, locale = Mobility.locale, invert: false)
           visitor = Visitor.new(self, locale)
           visitor.accept(predicate).inject(relation) do |rel, (attr, join_type)|
             join_type &&= ::Arel::Nodes::InnerJoin if invert
@@ -72,10 +70,6 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
 
         private
 
-        def table_alias(attr, locale)
-          table_alias_affix % "#{attr}_#{Mobility.normalize_locale(locale)}"
-        end
-
         def join_translations(relation, key, locale, join_type)
           return relation if already_joined?(relation, key, locale, join_type)
           m = model_class.arel_table
@@ -114,7 +108,10 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
       #   end
       #
       #   backend_class = Post.mobility_backend_class(:title)
-      #   visitor = Mobility::Backends::ActiveRecord::KeyValue::Visitor.new(backend_class)
+      #   visitor = Mobility::Backends::ActiveRecord::KeyValue::Visitor.new(backend_class, :en)
+      #
+      #   title   = backend_class.build_node("title", :en)   # arel node for title
+      #   content = backend_class.build_node("content", :en) # arel node for content
       #
       #   visitor.accept(title.eq("foo").and(content.eq(nil)))
       #   #=> { title: Arel::Nodes::InnerJoin, content: Arel::Nodes::OuterJoin }