mobility 1.0.0.beta2 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2346e4ef46985b520c5feea3577a6644f213e1fe89e3dfd5960f3347c72a1134
-  data.tar.gz: df38726f94dca7139a3eb9cf838b27dfede5378c34290a5298e7dcde01bf3c90
+  metadata.gz: 8658079d8c9fad02763385921421140d2410cde1d505c286627de5a8c1819612
+  data.tar.gz: 9bb012a9f564971e0c24fd3015e20e17384d7cbd77f2f0a5f1f1505e5262277a
 SHA512:
-  metadata.gz: 236ad0894645f98bf2a21c6848b4ba439da84b24862a56f6fca878889a6cd9a79108711923961d2f9ee75b6a6ee8482fcefff213b5433736fa507332db0cc253
-  data.tar.gz: a3e78f97d08d26e18ac8187b961097e686c3fc5650f45ae84fb4aa1aad1ccd0970410f2b9e887d8618ed6c1a09e559b1fe3fd0428df591de011961a0c2da1379
+  metadata.gz: 0a4a8a38a27d6f727091062010087466c85bfe48ce369395adb5501bd9875cfba21a56bce6a13b92b5cf83746883934f4161835f1336adedd9539bbf1138c51b
+  data.tar.gz: ca65fdaf7af558d235fdb5ba45347b9ca2319d9e6d69ddf7611afa2a50a477a30998316ce8661ca640ced1d09cd05f6ff282b1edfebd79abf4830c142bdf95df

checksums.yaml.gz.sig

@@ -1,2 +1,3 @@
-��[�c�$��=����K��N����-��R��6�VA��
��(�hZu�j�;~�6�vL�vT3Ԃ�lc� P�:�2�{�Ie1�מ9�v��g�|�+9�ov#�ƆL��7�F�7��b���ϔ�![j{̖�jdF�wWr���K���4ۿZb!��w*�2̂��SV�}�������1�W(�S�;-�+��7�
-i��㜘~'�5t6��в����Q��Oд�K�`�NK3����~����
+8��>
+i!�]>T*Ho�m꿻��󒁹h�^B���"@�y ��1�$�{�{�Uq�K��Cu1+7
)�&y��/z���b�-�ޮ�]vR��^�.'$~��btam��b�}F@\?
+�Օ�
F?#�D�-��*�^�M�ɼ�̨��{�~��la�eY�f7 }o�<������Mye,H^��o@�^~ۦE�V0���aD��u���

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 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.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

data/Gemfile.lock

@@ -8,6 +8,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    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)
@@ -37,10 +48,12 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
+    minitest (5.14.2)
     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)
@@ -69,16 +82,22 @@ GEM
     rspec-support (3.10.0)
     shellany (0.0.1)
     thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
     yard (0.9.25)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (>= 6.0.0, < 6.1)
   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

@@ -13,7 +13,7 @@ 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.
+branch, which corresponds to v1.0.0.rc1, 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).**
@@ -58,7 +58,7 @@ To use the latest pre-version of Mobility 1.0, add this line to your
 application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 1.0.0.beta2'
+gem 'mobility', '~> 1.0.0.rc1'
 ```
 
 For the latest stable version of Mobility, see the readme on the
@@ -91,10 +91,10 @@ The generator will create an initializer file `config/initializers/mobility.rb`
 which looks something like this:
 
 ```ruby
-Mobility.configure do |config|
+Mobility.configure do
   # PLUGINS
 
-  config.plugins do
+  plugins do
     backend :key_value
 
     active_record

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

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

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "mobility/backends/active_record"
 require "mobility/backends/container"
-require "mobility/arel/nodes/pg_ops"
+require "mobility/plugins/arel/nodes/pg_ops"
 
 module Mobility
   module Backends
@@ -49,15 +49,15 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
 
         # @param [String] attr Attribute name
         # @param [Symbol] locale Locale
-        # @return [Mobility::Arel::Nodes::Json,Mobility::Arel::Nodes::Jsonb] Arel
+        # @return [Mobility::Plugins::Arel::Nodes::Json,Mobility::Arel::Nodes::Jsonb] Arel
         #   node for attribute on json or jsonb column
         def build_node(attr, locale)
           column = model_class.arel_table[column_name]
           case column_type
           when :json
-            Arel::Nodes::JsonContainer.new(column, build_quoted(locale), build_quoted(attr))
+            Plugins::Arel::Nodes::JsonContainer.new(column, build_quoted(locale), build_quoted(attr))
           when :jsonb
-            Arel::Nodes::JsonbContainer.new(column, build_quoted(locale), build_quoted(attr))
+            Plugins::Arel::Nodes::JsonbContainer.new(column, build_quoted(locale), build_quoted(attr))
           end
         end
 

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

@@ -1,5 +1,5 @@
 require 'mobility/backends/active_record/pg_hash'
-require 'mobility/arel/nodes/pg_ops'
+require 'mobility/plugins/arel/nodes/pg_ops'
 
 module Mobility
   module Backends
@@ -24,11 +24,11 @@ Implements the {Mobility::Backends::Hstore} backend for ActiveRecord models.
 
         # @param [String] attr Attribute name
         # @param [Symbol] locale Locale
-        # @return [Mobility::Arel::Nodes::Hstore] Arel node for value of
+        # @return [Mobility::Plugins::Arel::Nodes::Hstore] Arel node for value of
         #   attribute key on hstore column
         def self.build_node(attr, locale)
           column_name = column_affix % attr
-          Arel::Nodes::Hstore.new(model_class.arel_table[column_name], build_quoted(locale))
+          Plugins::Arel::Nodes::Hstore.new(model_class.arel_table[column_name], build_quoted(locale))
         end
       end
     end

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

@@ -1,5 +1,5 @@
 require 'mobility/backends/active_record/pg_hash'
-require 'mobility/arel/nodes/pg_ops'
+require 'mobility/plugins/arel/nodes/pg_ops'
 
 module Mobility
   module Backends
@@ -32,11 +32,11 @@ Implements the {Mobility::Backends::Json} backend for ActiveRecord models.
 
         # @param [String] attr Attribute name
         # @param [Symbol] locale Locale
-        # @return [Mobility::Arel::Nodes::Json] Arel node for value of
+        # @return [Mobility::Plugins::Arel::Nodes::Json] Arel node for value of
         #   attribute key on jsonb column
         def self.build_node(attr, locale)
           column_name = column_affix % attr
-          Arel::Nodes::Json.new(model_class.arel_table[column_name], build_quoted(locale))
+          Plugins::Arel::Nodes::Json.new(model_class.arel_table[column_name], build_quoted(locale))
         end
       end
     end

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

@@ -1,5 +1,5 @@
 require 'mobility/backends/active_record/pg_hash'
-require 'mobility/arel/nodes/pg_ops'
+require 'mobility/plugins/arel/nodes/pg_ops'
 
 module Mobility
   module Backends
@@ -32,11 +32,11 @@ Implements the {Mobility::Backends::Jsonb} backend for ActiveRecord models.
 
         # @param [String] attr Attribute name
         # @param [Symbol] locale Locale
-        # @return [Mobility::Arel::Nodes::Jsonb] Arel node for value of
+        # @return [Mobility::Plugins::Arel::Nodes::Jsonb] Arel node for value of
         #   attribute key on jsonb column
         def self.build_node(attr, locale)
           column_name = column_affix % attr
-          Arel::Nodes::Jsonb.new(model_class.arel_table[column_name], build_quoted(locale))
+          Plugins::Arel::Nodes::Jsonb.new(model_class.arel_table[column_name], build_quoted(locale))
         end
       end
     end

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

@@ -1,8 +1,6 @@
 # frozen-string-literal: true
 require "mobility/backends/active_record"
 require "mobility/backends/key_value"
-require "mobility/active_record/string_translation"
-require "mobility/active_record/text_translation"
 
 module Mobility
   module Backends
@@ -37,21 +35,21 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
           super
           if type = options[:type]
             options[:association_name] ||= :"#{options[:type]}_translations"
-            options[:class_name]       ||= Mobility::ActiveRecord.const_get("#{type.capitalize}Translation")
+            options[:class_name]       ||= const_get("#{type.capitalize}Translation")
           end
           options[:table_alias_affix] = "#{model_class}_%s_#{options[:association_name]}"
         rescue NameError
-          raise ArgumentError, "You must define a Mobility::ActiveRecord::#{type.capitalize}Translation class."
+          raise ArgumentError, "You must define a Mobility::Backends::ActiveRecord::KeyValue::#{type.capitalize}Translation class."
         end
         # @!endgroup
 
         # @param [String] attr Attribute name
         # @param [Symbol] _locale Locale
-        # @return [Mobility::Arel::Attribute] Arel attribute for aliased
+        # @return [Mobility::Plugins::Arel::Attribute] Arel attribute for aliased
         #   translation table value column
         def build_node(attr, locale)
           aliased_table = class_name.arel_table.alias(table_alias(attr, locale))
-          Arel::Attribute.new(aliased_table, :value, locale, self, attr.to_sym)
+          Plugins::Arel::Attribute.new(aliased_table, :value, locale, self, attr.to_sym)
         end
 
         # Joins translations using either INNER/OUTER join appropriate to the query.
@@ -119,7 +117,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
       # The title predicate has a non-nil value, so we can use an INNER JOIN,
       # whereas we are searching for nil content, which requires an OUTER JOIN.
       #
-      class Visitor < ::Mobility::Arel::Visitor
+      class Visitor < Plugins::Arel::Visitor
         private
 
         def visit_Arel_Nodes_Equality(object)
@@ -141,7 +139,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
             transform_values { OUTER_JOIN }
         end
 
-        def visit_Mobility_Arel_Attribute(object)
+        def visit_Mobility_Plugins_Arel_Attribute(object)
           if object.backend_class == backend_class && object.locale == locale
             { object.attribute_name => OUTER_JOIN }
           end
@@ -194,8 +192,8 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
 
       # Returns translation for a given locale, or builds one if none is present.
       # @param [Symbol] locale
-      # @return [Mobility::ActiveRecord::TextTranslation,Mobility::ActiveRecord::StringTranslation]
-      def translation_for(locale, _options = {})
+      # @return [Mobility::Backends::ActiveRecord::KeyValue::TextTranslation,Mobility::Backends::ActiveRecord::KeyValue::StringTranslation]
+      def translation_for(locale, **)
         translation = translations.find { |t| t.key == attribute && t.locale == locale.to_s }
         translation ||= translations.build(locale: locale, key: attribute)
         translation
@@ -205,12 +203,30 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
         def self.included(model_class)
           model_class.after_destroy do
             [:string, :text].each do |type|
-              Mobility::ActiveRecord.const_get("#{type.capitalize}Translation").
+              Mobility::Backends::ActiveRecord::KeyValue.const_get("#{type.capitalize}Translation").
                 where(translatable: self).destroy_all
             end
           end
         end
       end
+
+      class Translation < ::ActiveRecord::Base
+        self.abstract_class = true
+
+        belongs_to :translatable, polymorphic: true, touch: true
+
+        validates :key, presence: true, uniqueness: { scope: [:translatable_id, :translatable_type, :locale], case_sensitive: true }
+        validates :translatable, presence: true
+        validates :locale, presence: true
+      end
+
+      class TextTranslation < Translation
+        self.table_name = "mobility_text_translations"
+      end
+
+      class StringTranslation < Translation
+        self.table_name = "mobility_string_translations"
+      end
     end
 
     register_backend(:active_record_key_value, ActiveRecord::KeyValue)

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

@@ -1,7 +1,6 @@
 # frozen-string-literal: true
 require "mobility/backends/active_record"
 require "mobility/backends/table"
-require "mobility/active_record/model_translation"
 
 module Mobility
   module Backends
@@ -116,10 +115,10 @@ columns to that table.
 
         # @param [String] attr Attribute name
         # @param [Symbol] _locale Locale
-        # @return [Mobility::Arel::Attribute] Arel node for column on translation table
+        # @return [Mobility::Plugins::Arel::Attribute] Arel node for column on translation table
         def build_node(attr, locale)
           aliased_table = model_class.const_get(subclass_name).arel_table.alias(table_alias(locale))
-          Arel::Attribute.new(aliased_table, attr, locale, self)
+          Plugins::Arel::Attribute.new(aliased_table, attr, locale, self)
         end
 
         # Joins translations using either INNER/OUTER join appropriate to the
@@ -190,7 +189,7 @@ columns to that table.
       # we need an OUTER JOIN. In the second case, one attribute is matched
       # against a non-nil value, so we can use an INNER JOIN.
       #
-      class Visitor < Arel::Visitor
+      class Visitor < Plugins::Arel::Visitor
         private
 
         def visit_Arel_Nodes_Equality(object)
@@ -227,7 +226,7 @@ columns to that table.
           end
         end
 
-        def visit_Mobility_Arel_Attribute(object)
+        def visit_Mobility_Plugins_Arel_Attribute(object)
           # We compare table names here to ensure that attributes defined on
           # different backends but the same table will correctly get an OUTER
           # join when required. Use options[:table_name] here since we don't
@@ -245,7 +244,7 @@ columns to that table.
           if self.const_defined?(subclass_name, false)
             const_get(subclass_name, false)
           else
-            const_set(subclass_name, Class.new(Mobility::ActiveRecord::ModelTranslation))
+            const_set(subclass_name, Class.new(Translation))
           end
 
         translation_class.table_name = options[:table_name]
@@ -303,6 +302,12 @@ columns to that table.
           destroy(empty_translations) if empty_translations.any?
         end
       end
+
+      # Subclassed dynamically to generate translation class.
+      class Translation < ::ActiveRecord::Base
+        self.abstract_class = true
+        validates :locale, presence: true
+      end
     end
 
     register_backend(:active_record_table, ActiveRecord::Table)