mobility 1.0.0.alpha → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2cfc984b6de27771cbdbe1e7cba1864134d7008a3c07a75a4f890ca0007a956
-  data.tar.gz: b7ea3bc4122a9f536a58bd00dc18b8c47151168e39dc8b315bdc5ade77e6385b
+  metadata.gz: a27c475aac12e8c93750cd6b11b7b339912c95bb24ada1e579c8f87598359388
+  data.tar.gz: faf2187673842e059b204715e774b2ef22d0a98e6162d7014ef875236a0db192
 SHA512:
-  metadata.gz: 745a3462d4ca4b9fe9a392a2c38e95a3a59626c8d560a7eaa5eb3650320c02a2b88797fe16bb5a203a3f0e42a401f632fcf620a5dcc0cc6e1f579dcb132a6a8e
-  data.tar.gz: 54031f4838a210915a964b954289e435cd4280c663b24c5516b6050318c9a0551b9912d36c968a71c17ac9199d30f0edea40cd4441046f38d4085f5195c73606
+  metadata.gz: 51dfb02fb8624897834dbc9260eb7edc67f6120f2971de120f7084e59df0865a027eca3ccae435ba77604fa8086760a1c682b9879a4c625be71368fa21d3b2c7
+  data.tar.gz: 5133980f0433ba31d157ebda7e1a8028dc84aa8d8dc7ab6b0df94861c347e60f34b09665eb890341998080be5256bea566f7e0dea62f96f6c85fcfd931319969

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Mobility Changelog
 
-## 1.0.0.alpha (unreleased)
+## 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.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.lock

@@ -1,38 +1,3 @@
-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:
@@ -43,22 +8,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (0.6.1)
-      actionpack (>= 0.9.5)
-    benchmark-ips (2.8.2)
-    builder (3.2.4)
+    allocation_stats (0.1.5)
+    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,20 +36,12 @@ 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)
-    pg (1.2.3)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -99,58 +49,39 @@ 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)
     yard (0.9.25)
-    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord!
-  activesupport!
+  allocation_stats
   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

@@ -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.alpha, a pre-release version of 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).**
@@ -54,11 +54,11 @@ 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.0.beta1'
 ```
 
 For the latest stable version of Mobility, see the readme on the

data/lib/mobility.rb

@@ -57,9 +57,13 @@ 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
 

data/lib/mobility/arel.rb

@@ -38,7 +38,7 @@ module Mobility
       attr_reader :locale
       attr_reader :attribute_name
 
-      def initialize(relation, column_name, locale, backend_class, attribute_name: nil)
+      def initialize(relation, column_name, locale, backend_class, attribute_name = nil)
         @backend_class = backend_class
         @locale = locale
         @attribute_name = attribute_name || column_name

data/lib/mobility/backend.rb

@@ -100,7 +100,7 @@ On top of this, a backend will normally:
     # @param [Symbol] locale Locale to read
     # @return [TrueClass,FalseClass] Whether translation is present for locale
     def present?(locale, options = {})
-      Util.present?(read(locale, options))
+      Util.present?(read(locale, **options))
     end
 
     # @!method model_class
@@ -120,6 +120,13 @@ On top of this, a backend will normally:
 
     # Defines setup hooks for backend to customize model class.
     module ClassMethods
+      # Returns valid option keys for this backend. This is overriden in
+      # backends to define which keys are valid for each backend class.
+      # @return [Array]
+      def valid_keys
+        []
+      end
+
       # Assign block to be called on model class.
       # @yield [attribute_names, options]
       # @note When called multiple times, setup blocks will be appended
@@ -179,15 +186,6 @@ On top of this, a backend will normally:
         EOM
       end
 
-      # Called from plugins to apply custom processing for this backend.
-      # Name is the name of the plugin.
-      # @param [Symbol] name Name of plugin
-      # @return [Boolean] Whether the plugin was applied
-      # @note This is currently only called by Plugins::Cache.
-      def apply_plugin(_)
-        false
-      end
-
       # Show useful information about this backend class, if it has no name.
       # @return [String]
       def inspect

data/lib/mobility/backends.rb

@@ -5,7 +5,7 @@ module Mobility
     class << self
       # @param [Symbol, Object] backend Name of backend to load.
       def load_backend(name)
-        return name if Module === name
+        return name if Module === name || name.nil?
 
         unless (backend = @backends[name])
           require "mobility/backends/#{name}"

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require "mobility/backends/active_record"
+require "mobility/backends/container"
 require "mobility/arel/nodes/pg_ops"
 
 module Mobility
@@ -11,11 +12,7 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
 =end
     class ActiveRecord::Container
       include ActiveRecord
-
-      # @!method column_name
-      #   Returns name of json or jsonb column used to store translations
-      #   @return [Symbol] (:translations) Name of translations column
-      option_reader :column_name
+      include Container
 
       # @!group Backend Accessors
       #

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

@@ -18,7 +18,7 @@ Implements the {Mobility::Backends::Hstore} backend for ActiveRecord models.
 
         # @!macro backend_writer
         def write(locale, value, options = {})
-          super(locale, value && value.to_s, options)
+          super(locale, value && value.to_s, **options)
         end
         # @!endgroup
 

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

@@ -51,7 +51,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
         #   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, attribute_name: attr.to_sym)
+          Arel::Attribute.new(aliased_table, :value, locale, self, attr.to_sym)
         end
 
         # Joins translations using either INNER/OUTER join appropriate to the query.

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

@@ -30,6 +30,10 @@ Implements {Mobility::Backends::Serialized} backend for ActiveRecord models.
       include ActiveRecord
       include HashValued
 
+      def self.valid_keys
+        super + [:format]
+      end
+
       # @!group Backend Configuration
       # @param (see Backends::Serialized.configure)
       # @option (see Backends::Serialized.configure)

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

@@ -283,7 +283,7 @@ columns to that table.
 
       # Returns translation for a given locale, or builds one if none is present.
       # @param [Symbol] locale
-      def translation_for(locale, _)
+      def translation_for(locale, **)
         translation = translations.in_locale(locale)
         translation ||= translations.build(locale: locale)
         translation

data/lib/mobility/backends/container.rb

@@ -19,8 +19,16 @@ stored).
 
 =end
     module Container
+      def self.included(backend_class)
+        backend_class.extend ClassMethods
+        backend_class.option_reader :column_name
+      end
+
+      module ClassMethods
+        def valid_keys
+          [:column_name]
+        end
+      end
     end
-
-    register_backend(:container, Container)
   end
 end

data/lib/mobility/backends/hash_valued.rb

@@ -36,6 +36,10 @@ Defines read and write methods that access the value at a key with value
       end
 
       module ClassMethods
+        def valid_keys
+          [:column_prefix, :column_suffix]
+        end
+
         def configure(options)
           options[:column_affix] = "#{options[:column_prefix]}%s#{options[:column_suffix]}"
         end

data/lib/mobility/backends/jsonb.rb

@@ -6,7 +6,7 @@ Stores translations as hash on Postgres jsonb column.
 
 ==Backend Options
 
-===+prefix+ and +suffix+
+===+column_prefix+ and +column_suffix+
 
 Prefix and suffix to add to attribute name to generate jsonb column name.
 

data/lib/mobility/backends/key_value.rb

@@ -54,13 +54,13 @@ other backends on model (otherwise one will overwrite the other).
 
       # @!group Backend Accessors
       # @!macro backend_reader
-      def read(locale, options = {})
-        translation_for(locale, options).value
+      def read(locale, **options)
+        translation_for(locale, **options).value
       end
 
       # @!macro backend_writer
-      def write(locale, value, options = {})
-        translation_for(locale, options).value = value
+      def write(locale, value, **options)
+        translation_for(locale, **options).value = value
       end
       # @!endgroup
 
@@ -83,6 +83,10 @@ other backends on model (otherwise one will overwrite the other).
       end
 
       module ClassMethods
+        def valid_keys
+          [:type, :association_name, :class_name]
+        end
+
         # @!group Backend Configuration
         # @option options [Symbol,String] type Column type to use
         # @option options [Symbol] association_name (:<type>_translations) Name
@@ -100,16 +104,9 @@ other backends on model (otherwise one will overwrite the other).
           end
         end
 
-        # Apply custom processing for plugin
-        # @param (see Backend::ClassMethods#apply_plugin)
-        # @return (see Backend::ClassMethods#apply_plugin)
-        def apply_plugin(name)
-          if name == :cache
-            include self::Cache
-            true
-          else
-            super
-          end
+        # Apply custom processing for cache plugin
+        def include_cache
+          include self::Cache
         end
 
         def table_alias(attr, locale)
@@ -123,7 +120,7 @@ other backends on model (otherwise one will overwrite the other).
           if cache.has_key?(locale)
             cache[locale]
           else
-            cache[locale] = super(locale, options)
+            cache[locale] = super(locale, **options)
           end
         end
 

data/lib/mobility/backends/sequel.rb

@@ -5,8 +5,8 @@ module Mobility
   module Backends
     module Sequel
       def self.included(backend_class)
-        backend_class.include(Backend)
-        backend_class.extend(ClassMethods)
+        backend_class.include Backend
+        backend_class.extend ClassMethods
       end
 
       module ClassMethods

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require "mobility/backends/sequel/json"
+require "mobility/backends/sequel"
 require "mobility/backends/sequel/jsonb"
+require "mobility/backends/container"
 
 module Mobility
   module Backends
@@ -11,10 +12,7 @@ Implements the {Mobility::Backends::Container} backend for Sequel models.
 =end
     class Sequel::Container
       include Sequel
-
-      # @!method column_name
-      #   @return [Symbol] (:translations) Name of translations column
-      option_reader :column_name
+      include Container
 
       # @!group Backend Accessors
       #

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

@@ -20,7 +20,7 @@ Implements the {Mobility::Backends::Hstore} backend for Sequel models.
         # @!group Backend Accessors
         # @!macro backend_writer
         def write(locale, value, options = {})
-          super(locale, value && value.to_s, options)
+          super(locale, value && value.to_s, **options)
         end
         # @!endgroup
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mobility/backends/sequel/pg_hash'
 
 Sequel.extension :pg_json, :pg_json_ops

data/lib/mobility/backends/sequel/serialized.rb

@@ -36,6 +36,10 @@ Sequel serialization plugin.
       include Sequel
       include HashValued
 
+      def self.valid_keys
+        super + [:format]
+      end
+
       # @!group Backend Configuration
       # @param (see Backends::Serialized.configure)
       # @option (see Backends::Serialized.configure)

data/lib/mobility/backends/table.rb

@@ -83,13 +83,13 @@ set.
 
       # @!group Backend Accessors
       # @!macro backend_reader
-      def read(locale, options = {})
-        translation_for(locale, options).send(attribute)
+      def read(locale, **options)
+        translation_for(locale, **options).send(attribute)
       end
 
       # @!macro backend_writer
-      def write(locale, value, options = {})
-        translation_for(locale, options).send("#{attribute}=", value)
+      def write(locale, value, **options)
+        translation_for(locale, **options).send("#{attribute}=", value)
       end
       # @!endgroup
 
@@ -104,25 +104,22 @@ set.
         model.send(association_name)
       end
 
-      def self.included(backend)
-        backend.extend ClassMethods
-        backend.option_reader :association_name
-        backend.option_reader :subclass_name
-        backend.option_reader :foreign_key
-        backend.option_reader :table_name
+      def self.included(backend_class)
+        backend_class.extend ClassMethods
+        backend_class.option_reader :association_name
+        backend_class.option_reader :subclass_name
+        backend_class.option_reader :foreign_key
+        backend_class.option_reader :table_name
       end
 
       module ClassMethods
-        # Apply custom processing for plugin
-        # @param (see Backend::Setup#apply_plugin)
-        # @return (see Backend::Setup#apply_plugin)
-        def apply_plugin(name)
-          if name == :cache
-            include self::Cache
-            true
-          else
-            super
-          end
+        def valid_keys
+          [:association_name, :subclass_name, :foreign_key, :table_name]
+        end
+
+        # Apply custom processing for cache plugin
+        def include_cache
+          include self::Cache
         end
 
         def table_alias(locale)
@@ -138,7 +135,7 @@ set.
           if cache.has_key?(locale)
             cache[locale]
           else
-            cache[locale] = super(locale, options)
+            cache[locale] = super(locale, **options)
           end
         end
 
@@ -157,7 +154,5 @@ set.
         end
       end
     end
-
-    register_backend(:table, Table)
   end
 end

data/lib/mobility/pluggable.rb

@@ -17,6 +17,10 @@ Works with {Mobility::Plugin}. (Subclassed by {Mobility::Translations}.)
         Plugin.configure(self, defaults, &block)
       end
 
+      def included_plugins
+        included_modules.grep(Plugin)
+      end
+
       def defaults
         @defaults ||= {}
       end
@@ -28,9 +32,25 @@ Works with {Mobility::Plugin}. (Subclassed by {Mobility::Translations}.)
     end
 
     def initialize(*, **options)
-      @options = self.class.defaults.merge(options)
+      initialize_options(options)
+      validate_options(@options)
     end
 
     attr_reader :options
+
+    private
+
+    def initialize_options(options)
+      @options = self.class.defaults.merge(options)
+    end
+
+    # This is overridden by backend plugin to exclude mixed-in backend options.
+    def validate_options(options)
+      plugin_keys = self.class.included_plugins.map { |p| Plugins.lookup_name(p) }
+      extra_keys = options.keys - plugin_keys
+      raise InvalidOptionKey, "No plugin configured for these keys: #{extra_keys.join(', ')}." unless extra_keys.empty?
+    end
+
+    class InvalidOptionKey < Error; end
   end
 end

data/lib/mobility/plugins.rb

@@ -14,6 +14,8 @@ declared in any order (dependencies will be resolved).
     class << self
       # @param [Symbol] name Name of plugin to load.
       def load_plugin(name)
+        return name if Module === name || name.nil?
+
         unless (plugin = @plugins[name])
           require "mobility/plugins/#{name}"
           raise LoadError, "plugin #{name} did not register itself correctly in Mobility::Plugins" unless (plugin = @plugins[name])

data/lib/mobility/plugins/active_model/dirty.rb

@@ -80,7 +80,12 @@ the ActiveRecord dirty plugin for more information.
           attribute_names.each do |name|
             dirty_handler_methods.each_pattern(name) do |method_name, attribute_method|
               define_method(method_name) do |*args|
-                mutations_from_mobility.send(attribute_method, Dirty.append_locale(name), *args)
+                # for %s_changed?(from:, to:) pattern
+                if (kwargs = args.last).is_a?(Hash)
+                  mutations_from_mobility.send(attribute_method, Dirty.append_locale(name), *args[0,-1], **kwargs)
+                else
+                  mutations_from_mobility.send(attribute_method, Dirty.append_locale(name), *args)
+                end
               end
             end
 
@@ -130,11 +135,12 @@ the ActiveRecord dirty plugin for more information.
             public_patterns.each do |pattern|
               method_name = pattern % 'attribute'
 
+              kwargs = pattern == '%s_changed?' ? ', **kwargs' : ''
               module_eval <<-EOM, __FILE__, __LINE__ + 1
-              def #{method_name}(attr_name, *rest)
+              def #{method_name}(attr_name, *rest#{kwargs})
                 if (mutations_from_mobility.attribute_changed?(attr_name) ||
                     mutations_from_mobility.attribute_previously_changed?(attr_name))
-                  mutations_from_mobility.send(#{method_name.inspect}, attr_name, *rest)
+                  mutations_from_mobility.send(#{method_name.inspect}, attr_name, *rest#{kwargs})
                 else
                   super
                 end
@@ -330,11 +336,11 @@ the ActiveRecord dirty plugin for more information.
           # @!group Backend Accessors
           # @!macro backend_writer
           # @param [Hash] options
-          def write(locale, value, options = {})
+          def write(locale, value, **options)
             locale_accessor = Mobility.normalize_locale_accessor(attribute, locale)
             if model.changed_attributes.has_key?(locale_accessor) && model.changed_attributes[locale_accessor] == value
               mutations_from_mobility.restore_attribute!(locale_accessor)
-            elsif read(locale, options.merge(locale: true)) != value
+            elsif read(locale, **options.merge(locale: true)) != value
               mutations_from_mobility.attribute_will_change!(locale_accessor)
             end
             super

data/lib/mobility/plugins/active_record/uniqueness_validation.rb

@@ -35,7 +35,7 @@ module Mobility
                 error_options = options.except(:case_sensitive, :scope, :conditions)
                 error_options[:value] = value
 
-                record.errors.add(attribute, :taken, error_options)
+                record.errors.add(attribute, :taken, **error_options)
               end
             else
               super

data/lib/mobility/plugins/backend.rb

@@ -32,18 +32,12 @@ Defines:
 
       def initialize(*args, **original_options)
         super
-        return unless Plugins::Backend.dependencies_satisfied?(self.class)
 
-        case options[:backend]
-        when String, Symbol, Class
-          @backend, @backend_options = options[:backend], options
-        when Array
-          @backend, @backend_options = options[:backend]
-          @backend_options = @backend_options.merge(original_options)
-        when NilClass
-          @backend = @backend_options = nil
-        else
-          raise ArgumentError, "backend must be either a backend name, a backend class, or a two-element array"
+        # Validate that the default backend from config has valid keys
+        if (default = self.class.defaults[:backend])
+          name, backend_options = default
+          extra_keys = backend_options.keys - backend.valid_keys
+          raise InvalidOptionKey, "These are not valid #{name} backend keys: #{extra_keys.join(', ')}." unless extra_keys.empty?
         end
 
         include InstanceMethods
@@ -58,8 +52,7 @@ Defines:
         klass.extend ClassMethods
 
         if backend
-          @backend_class = load_backend(backend).
-            build_subclass(klass, backend_options)
+          @backend_class = backend.build_subclass(klass, backend_options)
 
           backend_class.setup_model(klass, names)
 
@@ -83,10 +76,38 @@ Defines:
         raise e, "could not find a #{backend} backend. Did you forget to include an ORM plugin like active_record or sequel?"
       end
 
+      private
+
+      # Override to extract backend options from options hash.
+      def initialize_options(original_options)
+        super
+
+        case options[:backend]
+        when String, Symbol, Class
+          @backend, @backend_options = options[:backend], options
+        when Array
+          @backend, @backend_options = options[:backend]
+          @backend_options = @backend_options.merge(original_options)
+        when NilClass
+          @backend = @backend_options = nil
+        else
+          raise ArgumentError, "backend must be either a backend name, a backend class, or a two-element array"
+        end
+
+        @backend = load_backend(backend)
+      end
+
+      # Override default validation to exclude backend options, which may be
+      # mixed in with plugin options.
+      def validate_options(options)
+        return super unless backend
+        super(options.slice(*(options.keys - backend.valid_keys)))
+      end
+
       # Override default argument-handling in DSL to store kwargs passed along
       # with plugin name.
-      def self.configure_default(defaults, key, *args, **kwargs)
-        defaults[key] = [args[0], kwargs] unless args.empty?
+      def self.configure_default(defaults, key, backend = nil, backend_options = {})
+        defaults[key] = [backend, backend_options] if backend
       end
 
       module InstanceMethods
@@ -131,6 +152,8 @@ Defines:
           @mobility_backend_classes ||= {}
         end
       end
+
+      class InvalidOptionKey < Error; end
     end
 
     register_plugin(:backend, Backend)

data/lib/mobility/plugins/cache.rb

@@ -7,8 +7,7 @@ module Mobility
 Caches values fetched from the backend so subsequent fetches can be performed
 more quickly. The cache stores cached values in a simple hash, which is not
 optimal for some storage strategies, so some backends (KeyValue, Table) use a
-custom module through the {Mobility::Backend::Setup#apply_plugin} hook. For
-details see the documentation for these backends.
+custom module by defining a method, +include_cache+, on the backend class.
 
 The cache is reset when one of a set of events happens (saving, reloading,
 etc.). See {BackendResetter} for details.
@@ -28,12 +27,20 @@ Values are added to the cache in two ways:
       # Applies cache plugin to attributes.
       included_hook do |_, backend_class|
         if options[:cache]
-          backend_class.include(BackendMethods) unless backend_class.apply_plugin(:cache)
+          if backend_class.respond_to?(:include_cache)
+            backend_class.include_cache
+          else
+            include_cache(backend_class)
+          end
         end
       end
 
       private
 
+      def include_cache(backend_class)
+        backend_class.include BackendMethods
+      end
+
       # Used in ORM cache plugins
       def define_cache_hooks(klass, *reset_methods)
         mod = self
@@ -55,11 +62,11 @@ Values are added to the cache in two ways:
         # @!method read(locale, value, options = {})
         #   @option options [Boolean] cache *false* to disable cache.
         def read(locale, **options)
-          return super(locale, options) if options.delete(:cache) == false
+          return super(locale, **options) if options.delete(:cache) == false
           if cache.has_key?(locale)
             cache[locale]
           else
-            cache[locale] = super(locale, options)
+            cache[locale] = super(locale, **options)
           end
         end
 

data/lib/mobility/plugins/default.rb

@@ -90,7 +90,7 @@ The proc can accept zero to three arguments (see examples below)
         #   *false* to disable presence filter.
         def read(locale, accessor_options = {})
           default = accessor_options.has_key?(:default) ? accessor_options.delete(:default) : options[:default]
-          if (value = super(locale, accessor_options)).nil?
+          if (value = super(locale, **accessor_options)).nil?
             Default[default, locale: locale, accessor_options: accessor_options, model: model, attribute: attribute]
           else
             value

data/lib/mobility/plugins/fallbacks.rb

@@ -47,7 +47,7 @@ the current locale was +nil+.
   Mobility.locale = :ja
   post.title
   #=> "foo"
- 
+
   post.title = "bar"
   post.title
   #=> "bar"
@@ -144,15 +144,15 @@ the current locale was +nil+.
 
         def define_read(fallbacks)
           define_method :read do |locale, fallback: true, **options|
-            return super(locale, options) if !fallback || options[:locale]
+            return super(locale, **options) if !fallback || options[:locale]
 
             locales = fallback == true ? fallbacks[locale] : [locale, *fallback]
             locales.each do |fallback_locale|
-              value = super(fallback_locale, options)
+              value = super(fallback_locale, **options)
               return value if Util.present?(value)
             end
 
-            super(locale, options)
+            super(locale, **options)
           end
         end
 

data/lib/mobility/plugins/fallthrough_accessors.rb

@@ -24,14 +24,11 @@ model class is generated.
 
       default true
 
-      requires :reader
-      requires :writer
-
       # Apply fallthrough accessors plugin to attributes.
       # @param [Translations] translations
       # @param [Boolean] option
       initialize_hook do
-        if options[:fallthrough_accessors] && options[:reader] && options[:writer]
+        if options[:fallthrough_accessors]
           define_fallthrough_accessors(names)
         end
       end
@@ -47,9 +44,11 @@ model class is generated.
             locale, suffix = $2.split('_')
             locale = "#{locale}-#{suffix.upcase}" if suffix
             if $4 == '=' # writer
-              public_send(attribute_method, args[0], **(args[1] || {}), locale: locale)
+              kwargs = args[1].is_a?(Hash) ? args[1] : {}
+              public_send(attribute_method, args[0], **kwargs, locale: locale)
             else         # reader
-              public_send(attribute_method, **(args[0] || {}), locale: locale)
+              kwargs = args[0].is_a?(Hash) ? args[0] : {}
+              public_send(attribute_method, **kwargs, locale: locale)
             end
           else
             super(method_name, *args, &block)

data/lib/mobility/plugins/locale_accessors.rb

@@ -19,9 +19,6 @@ available locales for a Rails application) will be used by default.
 
       default true
 
-      requires :reader
-      requires :writer
-
       # Apply locale accessors plugin to attributes.
       # @param [Translations] translations
       # @param [Boolean] option
@@ -30,8 +27,8 @@ available locales for a Rails application) will be used by default.
           locales = Mobility.available_locales if locales == true
           names.each do |name|
             locales.each do |locale|
-              define_locale_reader(name, locale) if options[:reader]
-              define_locale_writer(name, locale) if options[:writer]
+              define_locale_reader(name, locale)
+              define_locale_writer(name, locale)
             end
           end
         end

data/lib/mobility/plugins/presence.rb

@@ -39,7 +39,7 @@ backend.
           if options.delete(:presence) == false
             super
           else
-            super(locale, Presence[value], options)
+            super(locale, Presence[value], **options)
           end
         end
         # @!endgroup

data/lib/mobility/plugins/reader.rb

@@ -19,13 +19,13 @@ Defines attribute reader that delegates to +Mobility::Backend#read+.
             class_eval <<-EOM, __FILE__, __LINE__ + 1
               def #{name}(locale: nil, **options)
                 #{Reader.setup_source}
-                mobility_backends[:#{name}].read(locale, options)
+                mobility_backends[:#{name}].read(locale, **options)
               end
             EOM
             class_eval <<-EOM, __FILE__, __LINE__ + 1
               def #{name}?(locale: nil, **options)
                 #{Reader.setup_source}
-                mobility_backends[:#{name}].present?(locale, options)
+                mobility_backends[:#{name}].present?(locale, **options)
               end
             EOM
           end

data/lib/mobility/plugins/sequel/dirty.rb

@@ -56,7 +56,7 @@ Automatically includes dirty plugin in model class when enabled.
             if model.column_changes.has_key?(locale_accessor) && model.initial_values[locale_accessor] == value
               super
               [model.changed_columns, model.initial_values].each { |h| h.delete(locale_accessor) }
-            elsif read(locale, options.merge(fallback: false)) != value
+            elsif read(locale, **options.merge(fallback: false)) != value
               model.will_change_column(locale_accessor)
               super
             end

data/lib/mobility/plugins/writer.rb

@@ -19,7 +19,7 @@ Defines attribute writer that delegates to +Mobility::Backend#write+.
             class_eval <<-EOM, __FILE__, __LINE__ + 1
               def #{name}=(value, locale: nil, **options)
                 #{Writer.setup_source}
-                mobility_backends[:#{name}].write(locale, value, options)
+                mobility_backends[:#{name}].write(locale, value, **options)
               end
             EOM
           end

data/lib/mobility/version.rb

@@ -9,7 +9,7 @@ module Mobility
     MAJOR = 1
     MINOR = 0
     TINY = 0
-    PRE = "alpha"
+    PRE = "beta1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/rails/generators/mobility/templates/initializer.rb

@@ -1,7 +1,7 @@
-Mobility.configure do |config|
+Mobility.configure do
 
   # PLUGINS
-  config.plugins do
+  plugins do
     # Backend
     #
     # Sets the default backend to use in models. This can be overridden in models

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Chris Salzberg
@@ -34,7 +34,7 @@ cert_chain:
   gSQml7TqcC6dZRsZRwYqzD9kUwdAJoCqno2CBUKs2l0yQAjFT36lRrVJznb7uWwa
   xpPFnsrtyaZW6Dty8TSG3qzmeGpmpIotA8x1VA==
   -----END CERTIFICATE-----
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store