mobility 0.4.3 → 0.5.0

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

@@ -46,7 +46,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
         super
         raise CacheRequired, "Cache required for Sequel::KeyValue backend" if options[:cache] == false
         type = options[:type]
-        options[:class_name] ||= Mobility::Sequel.const_get("#{type.capitalize}Translation".freeze)
+        options[:class_name] ||= Mobility::Sequel.const_get("#{type.capitalize}Translation")
         options[:class_name] = options[:class_name].constantize if options[:class_name].is_a?(String)
         options[:association_name] ||= :"#{options[:type]}_translations"
         %i[type association_name].each { |key| options[key] = options[key].to_sym }
@@ -78,7 +78,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
           end
           define_method :after_save do
             super()
-            attributes.each { |attribute| mobility_backend_for(attribute).save_translations }
+            attributes.each { |attribute| public_send(Backend.method_name(attribute)).save_translations }
           end
         end
         include callback_methods
@@ -93,7 +93,7 @@ Implements the {Mobility::Backends::KeyValue} backend for Sequel models.
             def after_destroy
               super
               [:string, :text].freeze.each do |type|
-                Mobility::Sequel.const_get("#{type.capitalize}Translation".freeze).
+                Mobility::Sequel.const_get("#{type.capitalize}Translation").
                   where(translatable_id: id, translatable_type: self.class.name).destroy
               end
             end

data/lib/mobility/backends/sequel/key_value/query_methods.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/sequel/query_methods"
 
 module Mobility

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/util"
 require "mobility/backends/sequel"
 require "mobility/backends/hash_valued"

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/util"
 
 module Mobility

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/sequel"
 require "mobility/backends/hash_valued"
 require "mobility/backends/serialized"

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/sequel/query_methods"
 
 module Mobility

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/util"
 require "mobility/backends/sequel"
 require "mobility/backends/key_value"

data/lib/mobility/backends/sequel/table/query_methods.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backends/sequel/query_methods"
 
 module Mobility

data/lib/mobility/backends/serialized.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/util"
 
 module Mobility

data/lib/mobility/backends/table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/plugins/cache"
 
 module Mobility

data/lib/mobility/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
 =begin
 
@@ -101,15 +103,11 @@ default_fallbacks= will be removed in the next major version of Mobility.
     def initialize
       @accessor_method = :translates
       @query_method = :i18n
-      @fallbacks_generator = lambda { |fallbacks| I18n::Locale::Fallbacks.new(fallbacks) }
+      @fallbacks_generator = lambda { |fallbacks| Mobility::Fallbacks.build(fallbacks) }
       @default_accessor_locales = lambda { I18n.available_locales }
       @default_options = Options[{
         cache: true,
-        dirty: false,
-        fallbacks: nil,
         presence: true,
-        default: nil,
-        attribute_methods: false
       }]
       @plugins = %i[
         cache

data/lib/mobility/fallbacks.rb

@@ -0,0 +1,28 @@
+module Mobility
+=begin
+
+Subclasses +I18n::Locale::Fallbacks+ such that instances of this class
+fall through to fallbacks defined in +I18n.fallbacks+. This allows models to
+customize fallbacks while still falling through to any fallbacks defined
+globally.
+
+=end
+  class Fallbacks < ::I18n::Locale::Fallbacks
+    # @param [Symbol] locale
+    # @return [Array] locales
+    def [](locale)
+      super | I18n.fallbacks[locale]
+    end
+
+    # For this set of fallbacks, return a new fallbacks hash.
+    # @param [Hash] fallbacks
+    # @return [I18n::Locale::Fallbacks,Mobility::Fallbacks] fallbacks hash
+    def self.build(fallbacks)
+      if I18n.respond_to?(:fallbacks)
+        new(fallbacks)
+      else
+        I18n::Locale::Fallbacks.new(fallbacks)
+      end
+    end
+  end
+end

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

@@ -45,21 +45,21 @@ value of the translated attribute if passed to it.
           def initialize(*attribute_names)
             attribute_names.each do |name|
               method_suffixes.each do |suffix|
-                define_method "#{name}#{suffix}".freeze do
-                  __send__("attribute#{suffix}".freeze, Mobility.normalize_locale_accessor(name))
+                define_method "#{name}#{suffix}" do
+                  __send__("attribute#{suffix}", Mobility.normalize_locale_accessor(name))
                 end
               end
 
-              define_method "restore_#{name}!".freeze do
+              define_method "restore_#{name}!" do
                 locale_accessor = Mobility.normalize_locale_accessor(name)
                 if attribute_changed?(locale_accessor)
-                  __send__("#{name}=".freeze, changed_attributes[locale_accessor])
+                  __send__("#{name}=", changed_attributes[locale_accessor])
                 end
               end
             end
 
             define_method :restore_attribute! do |attr|
-              attribute_names.include?(attr.to_s) ? send("restore_#{attr}!".freeze) : super(attr)
+              attribute_names.include?(attr.to_s) ? send("restore_#{attr}!") : super(attr)
             end
             private :restore_attribute!
           end

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

@@ -46,7 +46,7 @@ AR::Dirty plugin adds support for the following persistence-specific methods
 
             if ::ActiveRecord::VERSION::MAJOR == 5 && ::ActiveRecord::VERSION::MINOR == 1
               names = @attribute_names
-              method_name_regex = /\A(#{names.join('|'.freeze)})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
+              method_name_regex = /\A(#{names.join('|')})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
               has_attribute = Module.new do
                 define_method :has_attribute? do |attr_name|
                   super(attr_name) || !!method_name_regex.match(attr_name)

data/lib/mobility/plugins/cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/plugins/cache/translation_cacher"
 
 module Mobility

data/lib/mobility/plugins/default.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
   module Plugins
 =begin

data/lib/mobility/plugins/dirty.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/backend_resetter"
 require "mobility/plugins/fallthrough_accessors"
 

data/lib/mobility/plugins/fallbacks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/util"
 
 module Mobility
@@ -118,7 +119,8 @@ the current locale was +nil+.
 
 =end
     class Fallbacks < Module
-      # Applies fallbacks plugin to attributes.
+      # Applies fallbacks plugin to attributes. Completely disables fallbacks
+      # on model if option is +false+.
       # @param [Attributes] attributes
       # @param [Boolean] option
       def self.apply(attributes, option)

data/lib/mobility/plugins/fallthrough_accessors.rb

@@ -44,14 +44,14 @@ model class is generated.
 
       # @param [String] One or more attributes
       def initialize(*attributes)
-        method_name_regex = /\A(#{attributes.join('|'.freeze)})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
+        method_name_regex = /\A(#{attributes.join('|')})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
 
         define_method :method_missing do |method_name, *arguments, **options, &block|
           if method_name =~ method_name_regex
             attribute = $1.to_sym
-            locale, suffix = $2.split('_'.freeze)
-            locale = "#{locale}-#{suffix.upcase}".freeze if suffix
-            public_send("#{attribute}#{$4}".freeze, *arguments, **options, locale: locale.to_sym)
+            locale, suffix = $2.split('_')
+            locale = "#{locale}-#{suffix.upcase}" if suffix
+            public_send("#{attribute}#{$4}", *arguments, **options, locale: locale.to_sym)
           else
             super(method_name, *arguments, &block)
           end

data/lib/mobility/plugins/locale_accessors.rb

@@ -53,7 +53,7 @@ If no locales are passed as an option to the initializer,
       private
 
       def define_reader(name, locale)
-        warning_message = "locale passed as option to locale accessor will be ignored".freeze
+        warning_message = "locale passed as option to locale accessor will be ignored"
         normalized_locale = Mobility.normalize_locale(locale)
 
         define_method "#{name}_#{normalized_locale}" do |**options|
@@ -70,7 +70,7 @@ If no locales are passed as an option to the initializer,
       end
 
       def define_writer(name, locale)
-        warning_message = "locale passed as option to locale accessor will be ignored".freeze
+        warning_message = "locale passed as option to locale accessor will be ignored"
         normalized_locale = Mobility.normalize_locale(locale)
 
         define_method "#{name}_#{normalized_locale}=" do |value, **options|

data/lib/mobility/plugins/presence.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/util"
 
 module Mobility

data/lib/mobility/sequel/column_changes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
   module Sequel
 =begin
@@ -10,7 +12,7 @@ setter method is called.
       # @param [Array<String>] attributes Backend attributes
       def initialize(*attributes)
         attributes.each do |attribute|
-          define_method "#{attribute}=".freeze do |value, **options|
+          define_method "#{attribute}=" do |value, **options|
             if !options[:super] && send(attribute) != value
               locale = options[:locale] || Mobility.locale
               column = attribute.to_sym

data/lib/mobility/sequel/hash_initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
   module Sequel
 =begin

data/lib/mobility/sequel/string_translation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/sequel/translation"
 
 module Mobility

data/lib/mobility/sequel/text_translation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "mobility/sequel/translation"
 
 module Mobility

data/lib/mobility/translates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
 =begin
 

data/lib/mobility/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
 =begin
 
@@ -40,7 +42,7 @@ Some useful methods on strings, borrowed in parts from Sequel and ActiveSupport.
     # @return [String]
     def camelize(str)
       call_or_yield str do
-        str.to_s.sub(/^[a-z\d]*/) { $&.capitalize }.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/'.freeze, '::'.freeze)
+        str.to_s.sub(/^[a-z\d]*/) { $&.capitalize }.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
       end
     end
 

data/lib/mobility/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mobility
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/rails/generators/mobility/active_record_migration_compatibility.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rails/generators/active_record"
 require "active_record/migration"
 

data/lib/rails/generators/mobility/backend_generators/base.rb

@@ -53,15 +53,15 @@ module Mobility
       end
 
       def template
-        "#{backend}_translations".freeze
+        "#{backend}_translations"
       end
 
       def migration_dir
-        File.expand_path("db/migrate".freeze)
+        File.expand_path("db/migrate")
       end
 
       def migration_file
-        "create_#{file_name}_#{attributes.map(&:name).join('_and_')}_translations_for_mobility_#{backend}_backend".freeze
+        "create_#{file_name}_#{attributes.map(&:name).join('_and_')}_translations_for_mobility_#{backend}_backend"
       end
     end
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rails/generators"
 
 require_relative "./active_record_migration_compatibility"

data/lib/rails/generators/mobility/install_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rails/generators"
 require "rails/generators/active_record"
 require_relative "./active_record_migration_compatibility"

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

@@ -1,5 +1,80 @@
 Mobility.configure do |config|
+  # Sets the default backend to use in models. This can be overridden in models
+  # by passing +backend: ...+ to +translates+.
   config.default_backend = :key_value
+
+  # By default, Mobility uses the +translates+ class method in models to
+  # describe translated attributes, but you can configure this method to be
+  # whatever you like. This may be useful if using Mobility alongside another
+  # translation gem which uses the same method name.
   config.accessor_method = :translates
+
+  # To query on translated attributes, you need to append a scope to your
+  # model. The name of this scope is +i18n+ by default, but this can be changed
+  # to something else.
   config.query_method    = :i18n
+
+  # Uncomment and remove (or add) items to (from) this list to completely
+  # disable/enable plugins globally (so they cannot be used and are never even
+  # loaded). Note that if you remove an item from the list, you will not be
+  # able to use the plugin at all, and any options for the plugin will be
+  # ignored by models. (In most cases, you probably don't want to change this.)
+  #
+  # config.plugins = %i[
+  #   cache
+  #   dirty
+  #   fallbacks
+  #   presence
+  #   default
+  #   attribute_methods
+  #   fallthrough_accessors
+  #   locale_accessors
+  # ]
+
+  # The translation cache is on by default, but you can turn it off by
+  # uncommenting this line. (This may be helpful in debugging.)
+  #
+  # config.default_options[:cache] = false
+
+  # Dirty tracking is disabled by default. Uncomment this line to enable it.
+  # If you enable this, you should also enable +locale_accessors+ by default
+  # (see below).
+  #
+  # config.default_options[:dirty] = true
+
+  # No fallbacks are used by default. To define default fallbacks, uncomment
+  # and set the default fallback option value here. A "true" value will use
+  # whatever is defined by +I18n.fallbacks+ (if defined), or alternatively will
+  # fallback to your +I18n.default_locale+.
+  #
+  # config.default_options[:fallbacks] = true
+
+  # The Presence plugin converts empty strings to nil when fetching and setting
+  # translations. By default it is on, uncomment this line to turn it off.
+  #
+  # config.default_options[:presence] = false
+
+  # Set a default value to use if the translation is nil. By default this is
+  # off, uncomment and set a default to use it across all models (you probably
+  # don't want to do that).
+  #
+  # config.default_options[:default] = ...
+
+  # Uncomment to enable locale_accessors by default on models. A true value
+  # will use the locales defined in I18n.available_locales. If you want
+  # something else, pass an array of locales instead.
+  #
+  # config.default_options[:locale_accessors] = true
+
+  # Uncomment to enable fallthrough accessors by default on models. This will
+  # allow you to call any method with a suffix like _en or _pt_br, and Mobility
+  # will catch the suffix and convert it into a locale in +method_missing+. If
+  # you don't need this kind of open-ended fallthrough behavior, it's better
+  # to use locale_accessors instead (which define methods) since method_missing
+  # is very slow. (You can use both fallthrough and locale accessor plugins
+  # together without conflict.)
+  #
+  # Note: The dirty plugin enables fallthrough_accessors by default.
+  #
+  # config.default_options[:fallthrough_accessors] = true
 end

data/lib/rails/generators/mobility/translations_generator.rb

@@ -35,7 +35,7 @@ Other backends are not supported, for obvious reasons:
 =end
   class TranslationsGenerator < ::Rails::Generators::NamedBase
     SUPPORTED_BACKENDS = %w[column table]
-    BACKEND_OPTIONS = { type: :string, desc: "Backend to use for translations (defaults to Mobility.default_backend)".freeze }
+    BACKEND_OPTIONS = { type: :string, desc: "Backend to use for translations (defaults to Mobility.default_backend)" }
     argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
 
     class_option(:backend, BACKEND_OPTIONS)
@@ -50,7 +50,7 @@ Other backends are not supported, for obvious reasons:
     def self.prepare_for_invocation(name, value)
       if name == :backend
         if SUPPORTED_BACKENDS.include?(value)
-          require_relative "./backend_generators/#{value}_backend".freeze
+          require_relative "./backend_generators/#{value}_backend"
           Mobility::BackendGenerators.const_get("#{value}_backend".camelcase.freeze)
         else
           begin
@@ -70,7 +70,7 @@ Other backends are not supported, for obvious reasons:
 
     def say_status(status, message, *args)
       if status == :invoke && SUPPORTED_BACKENDS.include?(message)
-        super(status, "#{message}_backend".freeze, *args)
+        super(status, "#{message}_backend", *args)
       else
         super
       end