mobility 1.0.0.alpha → 1.0.1

data/lib/mobility/plugins/attribute_methods.rb

@@ -15,6 +15,7 @@ attributes only.
       extend Plugin
 
       default true
+      requires :attributes
 
       initialize_hook do |*names|
         include InstanceMethods

data/lib/mobility/plugins/attributes.rb

@@ -32,8 +32,15 @@ for aggregating attributes.
       end
 
       included_hook do |klass|
-        klass.extend ClassMethods
-        @names.each { |name| klass.register_mobility_attribute(name) }
+        names = @names
+
+        klass.class_eval do
+          extend ClassMethods
+          names.each { |name| mobility_attributes << name.to_s }
+          mobility_attributes.uniq!
+        rescue FrozenError
+          raise FrozenAttributesError, "Attempting to translate these attributes on #{klass}, which has already been subclassed: #{names.join(', ')}."
+        end
       end
 
       module ClassMethods
@@ -44,25 +51,20 @@ for aggregating attributes.
           mobility_attributes.include?(name.to_s)
         end
 
-        # Register a new attribute name. Public, but treat as internal.
-        # @param [String, Symbol] Attribute name
-        def register_mobility_attribute(name)
-          (self.mobility_attributes << name.to_s).uniq!
-        end
-
-        def inherited(klass)
-          super
-          mobility_attributes.each { |name| klass.register_mobility_attribute(name) }
-        end
-
-        protected
-
         # Return translated attribute names on this model.
         # @return [Array<String>] Attribute names
         def mobility_attributes
           @mobility_attributes ||= []
         end
+
+        def inherited(klass)
+          super
+          attrs = mobility_attributes.freeze # ensure attributes are not modified after being inherited
+          klass.class_eval { @mobility_attributes = attrs.dup }
+        end
       end
+
+      class FrozenAttributesError < Error; end
     end
 
     register_plugin(:attributes, Attributes)

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,13 +52,15 @@ 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)
 
-          @names.each do |name|
-            klass.register_mobility_backend_class(name, @backend_class)
+          names = @names
+          backend_class = @backend_class
+
+          klass.class_eval do
+            names.each { |name| mobility_backend_classes[name.to_sym] = backend_class }
           end
 
           backend_class
@@ -83,10 +79,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
@@ -116,12 +140,9 @@ Defines:
           raise KeyError, "No backend for: #{name}"
         end
 
-        def register_mobility_backend_class(name, backend_class)
-          mobility_backend_classes[name.to_sym] = backend_class
-        end
-
         def inherited(klass)
-          klass.mobility_backend_classes.merge!(@mobility_backend_classes)
+          parent_classes = mobility_backend_classes.freeze # ensure backend classes are not modified after being inherited
+          klass.class_eval { @mobility_backend_classes = parent_classes.dup }
           super
         end
 
@@ -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

@@ -51,12 +51,12 @@ Automatically includes dirty plugin in model class when enabled.
           # @!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).to_sym
             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

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

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

@@ -1,5 +1,4 @@
 class CreateStringTranslations < <%= activerecord_migration_class %>
-
   def change
     create_table :mobility_string_translations do |t|
       t.string :locale, null: false

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

@@ -1,5 +1,4 @@
 class CreateTextTranslations < <%= activerecord_migration_class %>
-
   def change
     create_table :mobility_text_translations do |t|
       t.string :locale, null: false

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

@@ -1,7 +1,6 @@
-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
@@ -104,5 +103,14 @@ Mobility.configure do |config|
     #
     # Or define specific defaults by uncommenting line below
     # locale_accessors [:en, :ja]
+
+    # Attribute Methods
+    #
+    # Adds translated attributes to +attributes+ hash, and defines methods
+    # +translated_attributes+ and +untranslated_attributes+ which return hashes
+    # with translated and untranslated attributes, respectively. Be aware that
+    # this plugin can create conflicts with other gems.
+    #
+    # attribute_methods
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha
+  version: 1.0.1
 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-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -156,14 +156,6 @@ files:
 - README.md
 - Rakefile
 - lib/mobility.rb
-- lib/mobility/active_record/model_translation.rb
-- lib/mobility/active_record/string_translation.rb
-- lib/mobility/active_record/text_translation.rb
-- lib/mobility/active_record/translation.rb
-- lib/mobility/arel.rb
-- lib/mobility/arel/nodes.rb
-- lib/mobility/arel/nodes/pg_ops.rb
-- lib/mobility/arel/visitor.rb
 - lib/mobility/backend.rb
 - lib/mobility/backends.rb
 - lib/mobility/backends/active_record.rb
@@ -209,6 +201,9 @@ files:
 - lib/mobility/plugins/active_record/dirty.rb
 - lib/mobility/plugins/active_record/query.rb
 - lib/mobility/plugins/active_record/uniqueness_validation.rb
+- lib/mobility/plugins/arel.rb
+- lib/mobility/plugins/arel/nodes.rb
+- lib/mobility/plugins/arel/nodes/pg_ops.rb
 - lib/mobility/plugins/attribute_methods.rb
 - lib/mobility/plugins/attributes.rb
 - lib/mobility/plugins/backend.rb
@@ -228,13 +223,6 @@ files:
 - lib/mobility/plugins/sequel/dirty.rb
 - lib/mobility/plugins/sequel/query.rb
 - lib/mobility/plugins/writer.rb
-- lib/mobility/sequel/column_changes.rb
-- lib/mobility/sequel/hash_initializer.rb
-- lib/mobility/sequel/model_translation.rb
-- lib/mobility/sequel/sql.rb
-- lib/mobility/sequel/string_translation.rb
-- lib/mobility/sequel/text_translation.rb
-- lib/mobility/sequel/translation.rb
 - lib/mobility/translations.rb
 - lib/mobility/util.rb
 - lib/mobility/version.rb
@@ -259,7 +247,13 @@ metadata:
   homepage_uri: https://github.com/shioyama/mobility
   source_code_uri: https://github.com/shioyama/mobility
   changelog_uri: https://github.com/shioyama/mobility/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: |2
+
+  Warning: Mobility v1.0 includes backwards-incompatible changes (mostly around configuration).
+
+  If you are upgrading from an earlier version, please see:
+  - https://github.com/shioyama/mobility/releases/tag/v1.0.0
+  - https://github.com/shioyama/mobility/wiki/Introduction-to-Mobility-v1.0
 rdoc_options: []
 require_paths:
 - lib
@@ -270,9 +264,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: