mobility 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43cf8100f2f537180ffae1d90e7ac2bd78ba045e
-  data.tar.gz: 5e62d1a469b7c438779a212844737b97c6251384
+  metadata.gz: 517f855df0698bb34baeac4033972a5950df7333
+  data.tar.gz: 569bf64eb02f45abd227d75bf28e53fd8a2aa4a1
 SHA512:
-  metadata.gz: c93092fb57649f458305fa368e72156137751e6d740ead6206b91325d5daf6b1287102096eb69c10ef238f503ea33b80f1383c1f98d94ecddda2ba728ee68be7
-  data.tar.gz: e018ec6117e9c5029a7a1249bc01e8f276eb5102583166074205ba3e23f133b039b83da33bb51e2488f75328b86e73faa5ea860016748e1081779c4e7cc28eb4
+  metadata.gz: d6431a9d3884fffec244488d8f56e906f5a514eb9f74e14b9d6fff192fe43046ad3bfe6a00720bf27e383e613c38b8269fac2a58aa6996b25b483aac6450b6bd
+  data.tar.gz: d78ecb91bd70a1f3266a550f5fb69297e0259dd08ba7cae7091bec8146fb85d72230d9d0ebeea803118a11f96fc5ac41cf7b2041f9efdd60daed81d1dba10342

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## 0.4
 
+### 0.5.0 (March 16, 2018)
+* Support PostgreSQL json column format as Json backend and dynamically in
+  Container backend ([#182](https://github.com/shioyama/mobility/pull/182) and
+  [#184](https://github.com/shioyama/mobility/pull/184), respectively)
+* Fall through to `I18n.fallbacks` when defined
+  ([#180](https://github.com/shioyama/mobility/pull/180))
+* Improve comments in Rails initializer
+  ([#186](https://github.com/shioyama/mobility/pull/186))
+* Use pragma comments to freeze strings everywhere
+  ([#177](https://github.com/shioyama/mobility/pull/177))
+
 ### 0.4.3 (February 18, 2018)
 * Add missing require in container backend
   ([#174](https://github.com/shioyama/mobility/pull/174))

data/Gemfile.lock

@@ -1,33 +1,33 @@
 PATH
   remote: .
   specs:
-    mobility (0.4.2)
-      i18n (>= 0.6.10, < 0.10)
+    mobility (0.5.0)
+      i18n (>= 0.6.10, < 1.1)
       request_store (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.0.rc1)
-      actionview (= 5.2.0.rc1)
-      activesupport (= 5.2.0.rc1)
+    actionpack (5.2.0.beta2)
+      actionview (= 5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
       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.rc1)
-      activesupport (= 5.2.0.rc1)
+    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.2.0.rc1)
-      activesupport (= 5.2.0.rc1)
-    activerecord (5.2.0.rc1)
-      activemodel (= 5.2.0.rc1)
-      activesupport (= 5.2.0.rc1)
+    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.rc1)
+    activesupport (5.2.0.beta2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -35,14 +35,14 @@ GEM
     arel (9.0.0)
     benchmark-ips (2.7.2)
     builder (3.2.3)
-    byebug (9.1.0)
+    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.0)
-    ffi (1.9.21)
+    erubi (1.7.1)
+    ffi (1.9.23)
     formatador (0.2.5)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
@@ -61,13 +61,13 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (0.9.3)
+    i18n (0.9.5)
       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.1.1)
+    loofah (2.2.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     lumberjack (1.0.12)
@@ -85,25 +85,25 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.5.1)
-      byebug (~> 9.1)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
       pry (~> 0.10)
     rack (2.0.4)
-    rack-test (0.8.2)
+    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.rc1)
-      actionpack (= 5.2.0.rc1)
-      activesupport (= 5.2.0.rc1)
+    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 (12.3.0)
-    rb-fsevent (0.10.2)
+    rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
     request_store (1.4.0)
@@ -134,7 +134,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (>= 5.2.0.beta1, < 5.3)
+  activerecord (= 5.2.0.beta2)
   benchmark-ips
   bundler (~> 1.12)
   database_cleaner (~> 1.5, >= 1.5.3)
@@ -144,7 +144,7 @@ DEPENDENCIES
   mysql2 (~> 0.4.9)
   pg (< 1.0)
   pry-byebug
-  railties (>= 5.2.0.beta1, < 5.3)
+  railties (= 5.2.0.beta2)
   rake (~> 12, >= 12.2.1)
   rspec (~> 3.0)
   sqlite3

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
+[json/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.4.3'
+gem 'mobility', '~> 0.5.0'
 ```
 
 Mobility is cryptographically signed. To be sure the gem you install hasn't
@@ -794,11 +794,11 @@ class](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Column).
 
 ### PostgreSQL-specific Backends
 
-Mobility also supports jsonb and Hstore storage options, if you are using
+Mobility also supports JSON and Hstore storage options, if you are using
 PostgreSQL as your database. To use this option, create column(s) on the model
-table for each translated attribute, and set your backend to `:jsonb` or
-`:hstore`. If you are using Sequel, note that you will need to enable the
-[pg_json](http://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/pg_json_rb.html)
+table for each translated attribute, and set your backend to `:json`, `:jsonb`
+or `:hstore`. If you are using Sequel, note that you
+will need to enable the [pg_json](http://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/pg_json_rb.html)
 or
 [pg_hstore](http://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/pg_hstore_rb.html)
 extensions with `DB.extension :pg_json` or `DB.extension :pg_hstore` (where
@@ -857,8 +857,8 @@ they conform to the same expected behaviour. These examples can be found in:
 - `spec/support/shared_examples/querying_examples.rb` (specs for
   [querying](#querying))
 - `spec/support/shared_examples/serialization_examples.rb` (specialized specs
-  for backends which store translations as a Hash: `serialized`, `hstore` and
-  `jsonb` backends)
+  for backends which store translations as a Hash: `serialized`, `hstore`,
+  `json` and `jsonb` backends)
 
 A minimal test can simply define a model class and use helpers defined in
 `spec/support/helpers.rb` to run these examples, by extending either

data/lib/mobility.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n'
 require 'request_store'
 require 'mobility/version'
@@ -24,15 +25,17 @@ 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"
   require "mobility/backend_resetter"
   require "mobility/configuration"
+  require "mobility/fallbacks"
   require "mobility/loaded"
   require "mobility/plugins"
   require "mobility/translates"
-  require "mobility/wrapper"
 
   # General error for version compatibility conflicts
   class VersionNotSupportedError < ArgumentError; end
@@ -194,7 +197,7 @@ module Mobility
     #   Mobility.normalize_locale("pt-BR")
     #   #=> "pt_br"
     def normalize_locale(locale = Mobility.locale)
-      "#{locale.to_s.downcase.sub("-", "_")}".freeze
+      "#{locale.to_s.downcase.sub("-", "_")}"
     end
     alias_method :normalized_locale, :normalize_locale
 
@@ -208,7 +211,7 @@ module Mobility
     #   Mobility.normalize_locale_accessor(:bar, "pt-BR")
     #   #=> "bar_pt_br"
     def normalize_locale_accessor(attribute, locale = Mobility.locale)
-      "#{attribute}_#{normalize_locale(locale)}".freeze
+      "#{attribute}_#{normalize_locale(locale)}"
     end
 
     # Raises InvalidLocale exception if the locale passed in is present but not available.
@@ -243,22 +246,32 @@ EOL
 
   module InstanceMethods
     # Fetch backend for an attribute
+    # @deprecated Use mobility.backend_for(attribute) instead.
     # @param [String] attribute Attribute
+    # TODO: Remove in v1.0
     def mobility_backend_for(attribute)
-      send(Backend.method_name(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
     end
+
+    def mobility
+      @mobility ||= Adapter.new(self)
+    end
   end
 
   module ClassMethods
     include Translates
 
     def mobility
-      @mobility ||= Mobility::Wrapper.new(self)
+      @mobility ||= Mobility::Accumulator.new
     end
 
     def translated_attribute_names

data/lib/mobility/{wrapper.rb → accumulator.rb}

@@ -6,14 +6,12 @@ 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.
 
 =end
-  class Wrapper < SimpleDelegator
+  class Accumulator
     # @return [Array<Attributes>]
     attr_reader :modules
-    alias :model_class :__getobj__
 
     # @param [Class] model_class Model class
-    def initialize(model_class)
-      super
+    def initialize
       @modules = []
     end
 

data/lib/mobility/active_record.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mobility
 =begin
 

data/lib/mobility/active_record/backend_resetter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/active_model/backend_resetter"
 
 module Mobility

data/lib/mobility/active_record/string_translation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/active_record/translation"
 
 module Mobility

data/lib/mobility/active_record/text_translation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/active_record/translation"
 
 module Mobility

data/lib/mobility/adapter.rb

@@ -0,0 +1,19 @@
+module Mobility
+=begin
+
+Provides interface to access attributes across all backends of an instance.
+
+=end
+  class Adapter
+    # @param [Object] model Instance of model class
+    def initialize(model)
+      @model = model
+    end
+
+    # Fetch backend for an attribute
+    # @param [String] attribute Attribute
+    def backend_for(attribute)
+      @model.send(Backend.method_name(attribute))
+    end
+  end
+end

data/lib/mobility/attributes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/util"
 
 module Mobility
@@ -138,7 +139,7 @@ with other backends.
     end
 
     # Setup backend class, include modules into model class, add this
-    # attributes module to shared {Mobility::Wrapper} and setup model with
+    # attributes module to shared {Mobility::Accumulator} and setup model with
     # backend setup block (see {Mobility::Backend::Setup#setup_model}).
     # @param klass [Class] Class of model
     def included(klass)

data/lib/mobility/backend.rb

@@ -116,7 +116,7 @@ On top of this, a backend will normally:
     # @return [String] name of backend reader method
     def self.method_name(attribute)
       @backend_method_names ||= {}
-      @backend_method_names[attribute] ||= "#{attribute}_backend".freeze
+      @backend_method_names[attribute] ||= "#{attribute}_backend"
     end
 
     # Defines setup hooks for backend to customize model class.

data/lib/mobility/backend/orm_delegator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mobility
   module Backend
 =begin
@@ -16,15 +17,15 @@ Adds {#for} method to backend to return ORM-specific backend.
       # @param [Class] model_class Class of model
       # @return [Class] Class of backend to use for model
       def for(model_class)
-        namespace = name.split('::'.freeze)
+        namespace = name.split('::')
         if Loaded::ActiveRecord && model_class < ::ActiveRecord::Base
           require_backend("active_record", namespace.last.underscore)
-          const_get(namespace.insert(-2, "ActiveRecord".freeze).join("::".freeze))
+          const_get(namespace.insert(-2, "ActiveRecord").join("::"))
         elsif Loaded::Sequel && model_class < ::Sequel::Model
           require_backend("sequel", namespace.last.underscore)
-          const_get(namespace.insert(-2, "Sequel".freeze).join("::".freeze))
+          const_get(namespace.insert(-2, "Sequel").join("::"))
         else
-          raise ArgumentError, "#{namespace.last} backend can only be used by ActiveRecord or Sequel models".freeze
+          raise ArgumentError, "#{namespace.last} backend can only be used by ActiveRecord or Sequel models"
         end
       end
 

data/lib/mobility/backend_resetter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
 =begin
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/active_record"
 require "mobility/backends/column"
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/active_record/query_methods"
 
 module Mobility

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/active_record"
 
 module Mobility
@@ -10,7 +11,8 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
     class ActiveRecord::Container
       include ActiveRecord
 
-      require 'mobility/backends/active_record/container/query_methods'
+      require 'mobility/backends/active_record/container/json_query_methods'
+      require 'mobility/backends/active_record/container/jsonb_query_methods'
 
       # @return [Symbol] name of container column
       attr_reader :column_name
@@ -47,8 +49,14 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
 
       # @!group Backend Configuration
       # @option options [Symbol] column_name (:translations) Name of column on which to store translations
+      # @raise [InvalidColumnType] if the type of the container column is not json or jsonb
       def self.configure(options)
         options[:column_name] ||= :translations
+        options[:column_name] = options[:column_name].to_sym
+        options[:column_type] = options[:model_class].type_for_attribute(options[:column_name].to_s).try(:type)
+        unless %i[json jsonb].include?(options[:column_type])
+          raise InvalidColumnType, "#{options[:column_name]} must be a column of type json or jsonb"
+        end
       end
       # @!endgroup
 
@@ -59,7 +67,9 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
         end
       end
 
-      setup do |_attributes, options|
+      backend_class = self
+
+      setup do |attributes, options|
         store options[:column_name], coder: Coder
 
         # Fix for duping depth-2 jsonb column in AR < 5.0
@@ -78,9 +88,14 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
             include const_set(module_name, dupable)
           end
         end
-      end
 
-      setup_query_methods(QueryMethods)
+        query_methods = backend_class.const_get("#{options[:column_type].capitalize}QueryMethods")
+        extend(Module.new do
+          define_method ::Mobility.query_method do
+            super().extending(query_methods.new(attributes, options))
+          end
+        end)
+      end
 
       private
 
@@ -113,6 +128,8 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
           obj
         end
       end
+
+      class InvalidColumnType < StandardError; end
     end
   end
 end