mobility 1.0.0.alpha → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2cfc984b6de27771cbdbe1e7cba1864134d7008a3c07a75a4f890ca0007a956
-  data.tar.gz: b7ea3bc4122a9f536a58bd00dc18b8c47151168e39dc8b315bdc5ade77e6385b
+  metadata.gz: cf9b852c3efdabe4bf4bd64e29a036f93b02169614965e37621f3f8b54315c7a
+  data.tar.gz: 3f4b71f87943fabcb6eae21c1960ffb20cb555cbb487c16a213ec4a5bb4f4824
 SHA512:
-  metadata.gz: 745a3462d4ca4b9fe9a392a2c38e95a3a59626c8d560a7eaa5eb3650320c02a2b88797fe16bb5a203a3f0e42a401f632fcf620a5dcc0cc6e1f579dcb132a6a8e
-  data.tar.gz: 54031f4838a210915a964b954289e435cd4280c663b24c5516b6050318c9a0551b9912d36c968a71c17ac9199d30f0edea40cd4441046f38d4085f5195c73606
+  metadata.gz: 49c5b97f0f2c4d1e260fa49b663334aca25fd8c0bbe5aa958a104d6cbbba31a6a6ea4403bb930f315258f2b07ef533fae0891f9fb189645ed2f1be56ff6e86ff
+  data.tar.gz: d132e09bc34036fdf7fe8cda20a7c337e714415b1999fdfd9319148e8584d3567a7f1fc494842bacbaebdb0881fc9b46b49a86b7de6a6ff8cc791f4feaf5192c

data/CHANGELOG.md

@@ -1,6 +1,59 @@
 # Mobility Changelog
 
-## 1.0.0.alpha (unreleased)
+### Unreleased
+- Remove `Mobility::Plugins::Attributes#each`
+  ([#475](https://github.com/shioyama/mobility/pull/475))
+- Add public method `Mobility::Plugins::ActiveRecord::Query.build_query`
+  ([#471](https://github.com/shioyama/mobility/pull/471))
+
+## 1.0
+
+1.0 is a rewrite of many internals of the gem. Please see the [wiki page on
+v1.0](https://github.com/shioyama/mobility/wiki/Introduction-to-Mobility-v1.0)
+for more details on how to upgrade.
+
+### 1.0.1
+
+- Make `Mobility::Plugins::ActiveRecord::Query::VirtualRow` and
+  `Mobility::Plugins::ActiveRecord::Query::QueryExtension`
+  ([#471](https://github.com/shioyama/mobility/pull/471)) public
+- Fix typo in initializer template
+  ([#474](https://github.com/shioyama/mobility/pull/474))
+
+### 1.0.0
+
+- Fix setting a locale from Rails config
+	([#468](https://github.com/shioyama/mobility/pull/468)) thanks
+	[sergey-alekseev](https://github.com/sergey-alekseev)!
+- Fixes validations with validates_uniqueness_of
+  ([#470](https://github.com/shioyama/mobility/pull/470)) thanks
+  [artplan1](https://github.com/artplan1)!
+
+### 1.0.0.rc1 (pre-release)
+
+- Remove `Mobility::ActiveRecord`, `Mobility::Sequel` and `Mobility::Arel`, and
+  general cleanup ([#464](https://github.com/shioyama/mobility/pull/464))
+
+### 1.0.0.beta2 (pre-release)
+
+- Refactor attributes & backend plugins and make `mobility_attributes` public
+  ([#462](https://github.com/shioyama/mobility/pull/462))
+- Make attribute_methods plugin depend on attributes
+  ([#461](https://github.com/shioyama/mobility/pull/461))
+
+### 1.0.0.beta1 (pre-release)
+
+- Remove `Mobility::Backend#apply_plugin`
+  ([#454](https://github.com/shioyama/mobility/pull/454))
+- Instance exec configure block if it takes no arguments
+  ([#456](https://github.com/shioyama/mobility/pull/456))
+- Raise an exception if invalid options are passed to Translations initializer
+  ([#457](https://github.com/shioyama/mobility/pull/457/files))
+- Fix Ruby 2.7 deprecation warnings
+  ([#460](https://github.com/shioyama/mobility/pull/460))
+
+### 1.0.0.alpha (pre-release)
+
 - Default fallbacks plugin to `true` when enabled
   ([#447](https://github.com/shioyama/mobility/pull/447))
 - Remove `Mobility::Backend.method_name`

data/Gemfile

@@ -8,20 +8,11 @@ orm, orm_version = ENV['ORM'], ENV['ORM_VERSION']
 group :development, :test do
   case orm
   when 'active_record'
-    orm_version ||= '6.0'
+    orm_version ||= '6.1'
     case orm_version
-    when '4.2'
-      gem 'activerecord', '>= 4.2.6', '< 5.0'
-    when '5.0'
-      gem 'activerecord', '>= 5.0', '< 5.1'
-    when '5.1'
-      gem 'activerecord', '>= 5.1', '< 5.2'
-    when '5.2'
-      gem 'activerecord', '>= 5.2.0', '< 5.3'
-      gem 'railties', '>= 5.2.0.rc2', '< 5.3'
-    when '6.0'
-      gem 'activerecord', '>= 6.0.0', '< 6.1'
-    when '6.1'
+    when '4.2', '5.0', '5.1', '5.2', '6.0', '6.1'
+      gem 'activerecord', "~> #{orm_version}.0"
+    when '6.2'
       git 'https://github.com/rails/rails.git' do
         gem 'activerecord'
         gem 'activesupport'
@@ -32,10 +23,8 @@ group :development, :test do
   when 'sequel'
     orm_version ||= '5'
     case orm_version
-    when '4'
-      gem 'sequel', '>= 4.46.0', '< 5.0'
     when '5'
-      gem 'sequel', '>= 5.0.0', '< 6.0.0'
+      gem 'sequel', "~> #{orm_version}.0"
     else
       raise ArgumentError, 'Invalid Sequel version'
     end

data/Gemfile.lock

@@ -1,64 +1,32 @@
-GIT
-  remote: https://github.com/rails/rails.git
-  revision: 0a608bd987fde4f9bc5bcf4bcebdb181d199cf4f
-  specs:
-    actionpack (6.1.0.alpha)
-      actionview (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-      rack (~> 2.0, >= 2.0.9)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-    activerecord (6.1.0.alpha)
-      activemodel (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-    activesupport (6.1.0.alpha)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    railties (6.1.0.alpha)
-      actionpack (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-      method_source
-      rake (>= 0.8.7)
-      thor (~> 1.0)
-
 PATH
   remote: .
   specs:
-    mobility (1.0.0.alpha)
+    mobility (1.0.0)
       i18n (>= 0.6.10, < 2)
       request_store (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (0.6.1)
-      actionpack (>= 0.9.5)
-    benchmark-ips (2.8.2)
-    builder (3.2.4)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    benchmark-ips (2.8.3)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.7)
-    crass (1.0.6)
     database_cleaner (1.8.5)
     diff-lcs (1.4.4)
-    erubi (1.9.0)
     ffi (1.13.1)
     formatador (0.2.5)
-    generator_spec (0.9.4)
-      activesupport (>= 3.0.0)
-      railties (>= 3.0.0)
     guard (2.16.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -78,16 +46,10 @@ GEM
     listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.7.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    lumberjack (1.2.7)
+    lumberjack (1.2.8)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
     minitest (5.14.2)
     nenv (0.3.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -99,58 +61,44 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (0.9.5)
-      actionmailer (>= 0.6.1)
-      actionpack (>= 1.4.0)
-      activerecord (>= 1.6.0)
-      rake (>= 0.4.15)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
     rake (12.3.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     request_store (1.5.0)
       rack (>= 1.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
     shellany (0.0.1)
     thor (1.0.1)
-    tzinfo (2.0.2)
-      concurrent-ruby (~> 1.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
     yard (0.9.25)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord!
-  activesupport!
+  activerecord (~> 6.0.0)
   benchmark-ips
   database_cleaner (~> 1.5, >= 1.5.3)
-  generator_spec (~> 0.9.4)
   guard-rspec
   mobility!
   pg
   pry-byebug
-  rails
   rake (~> 12, >= 12.2.1)
   rspec (~> 3.0)
   yard (~> 0.9.0)

data/README.md

@@ -12,11 +12,9 @@ Mobility
 [docs]: http://www.rubydoc.info/gems/mobility
 [wiki]: https://github.com/shioyama/mobility/wiki
 
-**This is the readme for the [`master`](https://github.com/shioyama/mobility)
-branch, which corresponds to v1.0.0.alpha, a pre-release version of Mobility.
-If you are using an earlier version (0.8.x or earlier), you probably want the
-readme on the [0-8-stable
-branch](https://github.com/shioyama/mobility/tree/0-8-stable).**
+**This is the readme for version 1.0 of Mobility. If you are using an earlier
+version (0.8.x or earlier), you probably want the readme on the [0-8
+branch](https://github.com/shioyama/mobility/tree/0-8).**
 
 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
@@ -54,16 +52,13 @@ section of the wiki.
 Installation
 ------------
 
-To use the latest (unreleased) version of Mobility, add this line to your
+To use the latest pre-version of Mobility 1.0, add this line to your
 application's Gemfile:
 
 ```ruby
-gem 'mobility', git: 'https://github.com/shioyama/mobility.git'
+gem 'mobility', '~> 1.0.1'
 ```
 
-For the latest stable version of Mobility, see the readme on the
-[0-8-stable](https://github.com/shioyama/mobility/tree/0-8-stable) branch.
-
 ### ActiveRecord (Rails)
 
 Requirements:
@@ -91,10 +86,10 @@ The generator will create an initializer file `config/initializers/mobility.rb`
 which looks something like this:
 
 ```ruby
-Mobility.configure do |config|
-  # PLUGINS
+Mobility.configure do
 
-  config.plugins do
+  # PLUGINS
+  plugins do
     backend :key_value
 
     active_record
@@ -107,15 +102,15 @@ Mobility.configure do |config|
 end
 ```
 
-Each method call inside the block passed to `config.plugins` declares a plugin,
-along with an optional default. To use a different default backend, you can
+Each method call inside the block passed to `plugins` declares a plugin, along
+with an optional default. To use a different default backend, you can
 change the default passed to the `backend` plugin, like this:
 
 ```diff
- Mobility.configure do |config|
-   # PLUGINS
+ Mobility.configure do
 
-   config.plugins do
+   # PLUGINS
+   plugins do
 -    backend :key_value
 +    backend :table
 ```
@@ -126,10 +121,10 @@ You can also set defaults for backend-specific options. Below, we set the
 default `type` option for the KeyValue backend to `:string`.
 
 ```diff
- Mobility.configure do |config|
-   # PLUGINS
+ Mobility.configure do
 
-   config.plugins do
+   # PLUGINS
+   plugins do
 -    backend :key_value
 +    backend :key_value, type: :string
    end
@@ -150,7 +145,7 @@ Requirements:
 When configuring Mobility, ensure that you include the `sequel` plugin:
 
 ```diff
- config.plugins do
+ plugins do
    backend :key_value
 
 -    active_record
@@ -297,7 +292,7 @@ accessors" in Mobility, and can be enabled by including the `locale_accessors`
 plugin, with a default set of accessors:
 
 ```diff
- config.plugins do
+ plugins do
    # ...
 +  locale_accessors [:en, :ja]
 ```
@@ -345,7 +340,7 @@ defined for a given locale.)
 Ensure the plugin is enabled:
 
 ```diff
- config.plugins do
+ plugins do
    # ...
 +  fallthrough_accessors
 ```
@@ -470,7 +465,7 @@ Mobility offers basic support for translation fallbacks. First, enable the
 `fallbacks` plugin:
 
 ```diff
- config.plugins do
+ plugins do
    # ...
 +  fallbacks
 +  locale_accessors
@@ -579,7 +574,7 @@ fallbacks](https://github.com/svenfuchs/i18n/wiki/Fallbacks).
 Another option is to assign a default value, using the `default` plugin:
 
 ```diff
- config.plugins do
+ plugins do
    # ...
 +  default 'foo'
 ```
@@ -632,7 +627,7 @@ have enabled an ORM plugin (either `active_record` or `sequel`), since the
 dirty plugin will depend on one of these being enabled.
 
 ```diff
- config.plugins do
+ plugins do
    # ...
    active_record
 +  dirty
@@ -722,7 +717,7 @@ can be quickly retrieved again. The cache plugin is included in the default
 configuration created by the install generator:
 
 ```diff
- config.plugins do
+ plugins do
    # ...
 +  cache
 ```
@@ -752,7 +747,7 @@ this feature, include the `query` plugin, and ensure you also have an ORM
 plugin enabled (`active_record` or `sequel`):
 
 ```diff
- config.plugins do
+ plugins do
    # ...
    active_record
 +  query

data/lib/mobility.rb

@@ -6,17 +6,71 @@ require 'mobility/version'
 =begin
 
 Mobility is a gem for storing and retrieving localized data through attributes
-on a class. The {Mobility} module includes all necessary methods and modules to
-support defining backend accessors on a class.
+on a class.
 
-To enable Mobility on a class, simply include or extend the {Mobility} module,
-and define any attribute accessors using {Translates#translates}.
+There are two ways to translate attributes on a class, both of which are
+variations on the same basic mechanism. The first and most common way is to
+extend the `Mobility` module, which adds a class method +translates+.
+Translated attributes can then be defined like this:
 
-  class MyClass
+  class Post
     extend Mobility
     translates :title, backend: :key_value
   end
 
+Behind the scenes, +translates+ simply creates an instance of
++Mobility.translations_class+, passes it whatever arguments are passed to
++translates+, and includes the instance (which is a module) into the class.
+
+So the above example is equivalent to:
+
+  class Post
+    Mobility.translations_class.new(:title, backend: :key_value)
+  end
+
+`Mobility.translations_class` is a subclass of `Mobility::Translations` created
+when `Mobility.configure` is called to configure Mobility. In fact, when you
+call `Mobility.configure`, it is the subclass of `Mobility::Translations` which
+is passed to the block as `config`. Plugins and plugin configuration is all
+applied to the same `Mobility.translations_class`.
+
+There is another way to use Mobility, which is to create your own subclass or
+subclasses of +Mobility::Translations+ and include them explicitly, without
+using +translates+.
+
+For example:
+
+  class Translations < Mobility::Translations
+    plugins do
+      backend :key_value
+      # ...
+    end
+  end
+
+  class Post
+    include Translations.new(:title)
+  end
+
+This usage might be handy if, for example, you want to have more complex
+configuration, where some models use some plugins while others do not. Since
+`Mobility::Translations` is a class like any other, you can subclass it and
+define plugins specifically on the subclass which are not present on its
+parent:
+
+  class TranslationsWithFallbacks < Translations
+    plugins do
+      fallbacks
+    end
+  end
+
+  class Comment
+    include TranslationsWithFallbacks.new(:author)
+  end
+
+In this case, +Comment+ uses +TranslationsWithFallbacks+ and thus has the
+fallbacks plugin, whereas +Post+ uses +Translations+ which does not have that
+plugin enabled.
+
 =end
 module Mobility
   # A generic exception used by Mobility.
@@ -50,6 +104,7 @@ module Mobility
       model_class.extend self
     end
 
+    # Alias to default backend defined on *translations_class+.
     # @return [Symbol,Class]
     def default_backend
       translations_class.defaults[:backend]
@@ -57,11 +112,14 @@ module Mobility
 
     # Configure Mobility
     # @yield [Mobility::Translations]
-    def configure
+    def configure(&block)
       translates_with(Class.new(Translations)) unless @translations_class
-      yield translations_class
+      if block.arity == 0
+        translations_class.instance_exec(&block)
+      else
+        yield translations_class
+      end
     end
-    # @!endgroup
 
     def translates_with(pluggable)
       raise ArgumentError, "translations class must be a subclass of Module." unless Module === pluggable
@@ -160,7 +218,7 @@ module Mobility
     #   methods (in LocaleAccessors) than is really necessary.
     def available_locales
       if defined?(Rails) && Rails.application
-        Rails.application.config.i18n.available_locales || I18n.available_locales
+        Rails.application.config.i18n.available_locales&.map(&:to_sym) || I18n.available_locales
       else
         I18n.available_locales
       end