mobility 0.5.1 → 0.6.0

data/lib/mobility/plugins/cache/translation_cacher.rb

@@ -15,24 +15,24 @@ and also to cache translation *records* in {Mobility::Backends::Table} and
       class TranslationCacher < Module
         # @param [Symbol] fetch_method Name of translation fetch method to cache
         def initialize(fetch_method)
-          define_method fetch_method do |locale, **options|
-            return super(locale, options) if options.delete(:cache) == false
-            if cache.has_key?(locale)
-              cache[locale]
-            else
-              cache[locale] = super(locale, options)
+          class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{fetch_method} locale, **options
+              return super(locale, options) if options.delete(:cache) == false
+              if cache.has_key?(locale)
+                cache[locale]
+              else
+                cache[locale] = super(locale, options)
+              end
             end
-          end
+          EOM
 
-          define_method :cache do
-            @cache ||= {}
-          end
-
-          define_method :clear_cache do
-            @cache = {}
-          end
+          include CacheMethods
+        end
 
-          private :cache, :clear_cache
+        module CacheMethods
+          private
+          def cache;       @cache ||= {}; end
+          def clear_cache; @cache = {};   end
         end
       end
     end

data/lib/mobility/plugins/default.rb

@@ -73,13 +73,6 @@ The proc can accept zero to three arguments (see examples below)
           default = options.has_key?(:default) ? options.delete(:default) : default_option
           if (value = super(locale, options)).nil?
             return default unless default.is_a?(Proc)
-            # TODO: Remove in v1.0
-            if default.parameters.any? { |n, v| [:keyreq, :keyopt].include?(n) && [:model, :attribute, :locale, :options].include?(v) }
-              warn %{
-WARNING: Passing keyword arguments to a Proc in the Default plugin is
-deprecated. See the API documentation for details.}
-              return default.call(model: model, attribute: attribute, locale: locale, options: options)
-            end
             args = [attribute, locale, options]
             args = args.first(default.arity) unless default.arity < 0
             model.instance_exec(*args, &default)

data/lib/mobility/plugins/fallbacks.rb

@@ -37,6 +37,7 @@ the current locale was +nil+.
 
 @example With default fallbacks enabled (falls through to default locale)
   class Post
+    extend Mobility
     translates :title, fallbacks: true
   end
 
@@ -54,6 +55,7 @@ the current locale was +nil+.
 
 @example With additional fallbacks enabled
   class Post
+    extend Mobility
     translates :title, fallbacks: { :'en-US' => 'de-DE', :pt => 'de-DE' }
   end
 
@@ -70,6 +72,7 @@ the current locale was +nil+.
 
 @example Passing fallback option when reading value
   class Post
+    extend Mobility
     translates :title, fallbacks: true
   end
 
@@ -88,6 +91,7 @@ the current locale was +nil+.
 
 @example Fallbacks disabled
   class Post
+    extend Mobility
     translates :title, fallbacks: { :'fr' => 'en' }, locale_accessors: true
   end
 

data/lib/mobility/sequel.rb

@@ -6,12 +6,18 @@ Module loading Sequel-specific classes for Mobility models.
 =end
   module Sequel
     def self.included(model_class)
-      query_method = Module.new do
-        define_method Mobility.query_method do
-          dataset
-        end
+      model_class.extend DatasetMethod.new(Mobility.query_method)
+    end
+
+    class DatasetMethod < Module
+      def initialize(query_method)
+        module_eval <<-EOM, __FILE__, __LINE__ + 1
+          def #{query_method}
+            dataset
+          end
+        EOM
       end
-      model_class.extend query_method
     end
+    private_constant :DatasetMethod
   end
 end

data/lib/mobility/sequel/backend_resetter.rb

@@ -8,16 +8,15 @@ method is called.
 =end
     class BackendResetter < Mobility::BackendResetter
 
-      # @param [Class] model_class Class of model to which backend resetter will be applied
-      def included(model_class)
+      # (see Mobility::BackendResetter#initialize)
+      def initialize(attribute_names, &block)
+        super
+
         model_reset_method = @model_reset_method
 
-        mod = Module.new do
-          define_method :refresh do
-            super().tap { instance_eval(&model_reset_method) }
-          end
+        define_method :refresh do
+          super().tap { instance_eval(&model_reset_method) }
         end
-        model_class.include mod
       end
     end
   end

data/lib/mobility/sequel/column_changes.rb

@@ -10,14 +10,14 @@ setter method is called.
 =end
     class ColumnChanges < Module
       # @param [Array<String>] attributes Backend attributes
-      def initialize(*attributes)
+      def initialize(attributes, column_affix: "%s")
         attributes.each do |attribute|
           define_method "#{attribute}=" do |value, **options|
             if !options[:super] && send(attribute) != value
               locale = options[:locale] || Mobility.locale
-              column = attribute.to_sym
-              column_with_locale = :"#{attribute}_#{Mobility.normalize_locale(locale)}"
-              @changed_columns = changed_columns | [column, column_with_locale]
+              column = (column_affix % attribute).to_sym
+              attribute_with_locale = :"#{attribute}_#{Mobility.normalize_locale(locale)}"
+              @changed_columns = changed_columns | [column, attribute.to_sym, attribute_with_locale]
             end
             super(value, **options)
           end

data/lib/mobility/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mobility
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

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

@@ -30,6 +30,10 @@ module Mobility
         attributes.select { |a| !a.reference? && a.has_index? }
       end
 
+      def translation_index_name(column, *columns)
+        truncate_index_name("index_#{table_name}_on_#{[column, *columns].join('_and_')}")
+      end
+
       private
 
       def check_data_source!

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

@@ -25,18 +25,6 @@ module Mobility
       def foreign_key
         "#{model_table_name.singularize}_id"
       end
-
-      def translation_index_name
-        truncate_index_name("index_#{table_name}_on_#{foreign_key}")
-      end
-
-      def translation_locale_index_name
-        truncate_index_name("index_#{table_name}_on_locale")
-      end
-
-      def translation_unique_index_name
-        truncate_index_name("index_#{table_name}_on_#{foreign_key}_and_locale")
-      end
     end
   end
 end

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

@@ -4,11 +4,11 @@ class <%= migration_class_name %> < <%= activerecord_migration_class %>
 <% I18n.available_locales.each do |locale| -%>
 <% column_name = Mobility.normalize_locale_accessor(attribute.name, locale) -%>
 <% if connection.column_exists?(table_name, column_name) -%>
-<% warn "#{column_name} already exists, skipping." %>
+<% warn "#{column_name} already exists, skipping." -%>
 <% else -%>
     add_column :<%= table_name %>, :<%= column_name %>, :<%= attribute.type %><%= attribute.inject_options %>
     <%- if attribute.has_index? -%>
-    add_index  :<%= table_name %>, :<%= column_name %><%= attribute.inject_index_options %>
+    add_index  :<%= table_name %>, :<%= column_name %><%= attribute.inject_index_options %>, name: :<%= translation_index_name(column_name) %>
     <%- end -%>
 <% end -%>
 <% end -%>

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

@@ -2,12 +2,12 @@ class CreateStringTranslations < <%= activerecord_migration_class %>
 
   def change
     create_table :mobility_string_translations do |t|
-      t.string  :locale
-      t.string  :key
+      t.string  :locale,            null: false
+      t.string  :key,               null: false
       t.string  :value
-      t.integer :translatable_id
-      t.string  :translatable_type
-      t.timestamps
+      t.integer :translatable_id,   null: false
+      t.string  :translatable_type, null: false
+      t.timestamps                  null: false
     end
     add_index :mobility_string_translations, [:translatable_id, :translatable_type, :locale, :key], unique: true, name: :index_mobility_string_translations_on_keys
     add_index :mobility_string_translations, [:translatable_id, :translatable_type, :key], name: :index_mobility_string_translations_on_translatable_attribute

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

@@ -2,12 +2,12 @@ class CreateTextTranslations < <%= activerecord_migration_class %>
 
   def change
     create_table :mobility_text_translations do |t|
-      t.string  :locale
-      t.string  :key
+      t.string  :locale,            null: false
+      t.string  :key,               null: false
       t.text    :value
-      t.integer :translatable_id
-      t.string  :translatable_type
-      t.timestamps
+      t.integer :translatable_id,   null: false
+      t.string  :translatable_type, null: false
+      t.timestamps                  null: false
     end
     add_index :mobility_text_translations, [:translatable_id, :translatable_type, :locale, :key], unique: true, name: :index_mobility_text_translations_on_keys
     add_index :mobility_text_translations, [:translatable_id, :translatable_type, :key], name: :index_mobility_text_translations_on_translatable_attribute

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

@@ -77,4 +77,12 @@ Mobility.configure do |config|
   # Note: The dirty plugin enables fallthrough_accessors by default.
   #
   # config.default_options[:fallthrough_accessors] = true
+
+  # You can also include backend-specific default options. For example, if you
+  # want to default to using the text-type translation table with the KeyValue
+  # backend, you can set that as a default by uncommenting this line, or change
+  # it to :string to default to the string-type translation table instead. (For
+  # other backends, this option is ignored.)
+  #
+  # config.default_options[:type] = :text
 end

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

@@ -5,11 +5,10 @@ class <%= migration_class_name %> < <%= activerecord_migration_class %>
     add_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %>
   <%- elsif attribute.respond_to?(:token?) && attribute.token? -%>
     add_column :<%= table_name %>, :<%= attribute.name %>, :string<%= attribute.inject_options %>
-    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
-  <%- else -%>
+    add_index :<%= table_name %>, [:<%= attribute.index_name %><%= attribute.inject_index_options %>, :locale], name: :<%= translation_index_name(attribute.index_name, "locale") %>, unique: true <%- else -%>
     add_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %>
     <%- if attribute.has_index? -%>
-    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+    add_index :<%= table_name %>, [:<%= attribute.index_name %><%= attribute.inject_index_options %>, :locale], name: :<%= translation_index_name(attribute.index_name, "locale") %>
     <%- end -%>
   <%- end -%>
 <% end -%>

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

@@ -17,12 +17,11 @@ class <%= migration_class_name %> < <%= activerecord_migration_class %>
       t.timestamps null: false
     end
 
-    add_index :<%= table_name %>, :<%= foreign_key %>, name: :<%= translation_index_name %>
-    add_index :<%= table_name %>, :locale, name: :<%= translation_locale_index_name %>
-    add_index :<%= table_name %>, [:<%= foreign_key %>, :locale], name: :<%= translation_unique_index_name %>, unique: true
+    add_index :<%= table_name %>, :locale, name: :<%= translation_index_name("locale") %>
+    add_index :<%= table_name %>, [:<%= foreign_key %>, :locale], name: :<%= translation_index_name(foreign_key, "locale") %>, unique: true
 
 <%- attributes_with_index.each do |attribute| -%>
-    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+  add_index :<%= table_name %>, [:<%= attribute.index_name %><%= attribute.inject_index_options %>, :locale], name: :<%= translation_index_name(attribute.index_name, "locale") %>
 <%- end -%>
   end
 end

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

@@ -29,16 +29,17 @@ skipped.
 Other backends are not supported, for obvious reasons:
 * the +key_value+ backend does not need any model-specific migrations, simply
   run the install generator.
-* +jsonb+, +hstore+ and +serialized+ backends simply require a single column on
-  a model table, which can be added with the normal Rails migration generator.
+* +json+, +jsonb+, +hstore+, +serialized+, and +container+ backends simply
+  require a single column on a model table, which can be added with the normal
+  Rails migration generator.
 
 =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)" }
+    SUPPORTED_BACKENDS = %w[column table].freeze
+    BACKEND_OPTIONS = { type: :string, desc: "Backend to use for translations (defaults to Mobility.default_backend)" }.freeze
     argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
 
-    class_option(:backend, BACKEND_OPTIONS)
+    class_option(:backend, BACKEND_OPTIONS.dup)
     invoke_from_option :backend
 
     def self.class_options(options = nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Chris Salzberg
@@ -30,7 +30,7 @@ cert_chain:
   eGDROPZoL5RXwiOnRbexxa7dcAxMrDfGB/hpiunIPWPsi4n5P7K/6OO/sGVMl9xv
   SZBPXjzrHdyOFLBYXB+PG7s3F/4=
   -----END CERTIFICATE-----
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -180,7 +180,6 @@ files:
 - lib/mobility/attributes.rb
 - lib/mobility/backend.rb
 - lib/mobility/backend/orm_delegator.rb
-- lib/mobility/backend/stringify_locale.rb
 - lib/mobility/backend_resetter.rb
 - lib/mobility/backends.rb
 - lib/mobility/backends/active_record.rb

data/lib/mobility/backend/stringify_locale.rb

@@ -1,18 +0,0 @@
-module Mobility
-  module Backend
-=begin
-
-Module which stringifies the locale passed in to read and write methods.
-
-=end
-    module StringifyLocale
-      def read(locale, options = {})
-        super(locale.to_s, options)
-      end
-
-      def write(locale, value, options = {})
-        super(locale.to_s, value, options)
-      end
-    end
-  end
-end