mobility 1.0.0.beta1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a27c475aac12e8c93750cd6b11b7b339912c95bb24ada1e579c8f87598359388
-  data.tar.gz: faf2187673842e059b204715e774b2ef22d0a98e6162d7014ef875236a0db192
+  metadata.gz: 8c59ad405d9183d4a2a27905ecace4c3f25e1fdb7492646bed76866b5eefab8a
+  data.tar.gz: 557c434ad2858d524b68a9580a0ae77b03a4361cc6e8b3b46f8883610c4c2598
 SHA512:
-  metadata.gz: 51dfb02fb8624897834dbc9260eb7edc67f6120f2971de120f7084e59df0865a027eca3ccae435ba77604fa8086760a1c682b9879a4c625be71368fa21d3b2c7
-  data.tar.gz: 5133980f0433ba31d157ebda7e1a8028dc84aa8d8dc7ab6b0df94861c347e60f34b09665eb890341998080be5256bea566f7e0dea62f96f6c85fcfd931319969
+  metadata.gz: 8479d64a5db0190980afede4f638ecfb67a895312afa8c1d9d742a52c07298bf5898a0796606c9287907ebec5989dcb177ab41ced41d651f8843e057beb0e8f1
+  data.tar.gz: fb61359a451ff909d81137365538bbdfa7726672da5bfe4ce75ee59b5ab07de9b6a9b9784708b65de998b75921551ed87ba81b3d04a27dae401c0918419b9283

data/CHANGELOG.md

@@ -1,10 +1,60 @@
 # Mobility Changelog
 
+### 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))
+- Allow setting locale per node in query block
+  ([#479](https://github.com/shioyama/mobility/pull/479))
+- Add `Mobility.validate_locale!`
+  ([#479](https://github.com/shioyama/mobility/pull/479))
+- Call after_destroy in setup block to delete associated translations
+  ([#487](https://github.com/shioyama/mobility/pull/487))
+- Add key, value and belongs_to options to key-value backend
+  ([#488](https://github.com/shioyama/mobility/pull/488)) thanks
+  [sedubois](https://github.com/sedubois)!
+
 ## 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 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.2
+- Fix `Mobility.default_backend`
+  ([#497](https://github.com/shioyama/mobility/pull/497))
+
+### 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)
+### 1.0.0.beta1 (pre-release)
 
 - Remove `Mobility::Backend#apply_plugin`
   ([#454](https://github.com/shioyama/mobility/pull/454))
@@ -15,7 +65,7 @@
 - Fix Ruby 2.7 deprecation warnings
   ([#460](https://github.com/shioyama/mobility/pull/460))
 
-## 1.0.0.alpha (pre-release)
+### 1.0.0.alpha (pre-release)
 
 - Default fallbacks plugin to `true` when enabled
   ([#447](https://github.com/shioyama/mobility/pull/447))

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,14 +1,24 @@
 PATH
   remote: .
   specs:
-    mobility (1.0.0.alpha)
+    mobility (1.0.1)
       i18n (>= 0.6.10, < 2)
       request_store (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    allocation_stats (0.1.5)
+    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)
@@ -38,10 +48,12 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
+    minitest (5.14.3)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    pg (1.2.3)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -70,17 +82,22 @@ GEM
     rspec-support (3.10.0)
     shellany (0.0.1)
     thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
     yard (0.9.25)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  allocation_stats
+  activerecord (~> 6.0.0)
   benchmark-ips
   database_cleaner (~> 1.5, >= 1.5.3)
   guard-rspec
   mobility!
+  pg
   pry-byebug
   rake (~> 12, >= 12.2.1)
   rspec (~> 3.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.beta, 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
@@ -58,12 +56,9 @@ To use the latest pre-version of Mobility 1.0, add this line to your
 application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 1.0.0.beta1'
+gem 'mobility', '~> 1.0.2'
 ```
 
-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]
@@ -65,7 +120,6 @@ module Mobility
         yield translations_class
       end
     end
-    # @!endgroup
 
     def translates_with(pluggable)
       raise ArgumentError, "translations class must be a subclass of Module." unless Module === pluggable
@@ -164,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

data/lib/mobility/backends/active_record.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 require "mobility/backend"
-require "mobility/arel"
+require "mobility/plugins/arel"
 
 module Mobility
   module Backends

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

@@ -57,7 +57,7 @@ can be run again to add new attributes or locales.)
       #   on model table
       def self.build_node(attr, locale)
         model_class.arel_table[Column.column_name_for(attr, locale)]
-          .extend(::Mobility::Arel::MobilityExpressions)
+          .extend(Plugins::Arel::MobilityExpressions)
       end
 
       private