mobility 0.8.10 → 1.0.0.beta2

data/lib/mobility/plugins/writer.rb

@@ -0,0 +1,44 @@
+# frozen-string-literal: true
+
+module Mobility
+  module Plugins
+    module Writer
+=begin
+
+Defines attribute writer that delegates to +Mobility::Backend#write+.
+
+=end
+      extend Plugin
+
+      default true
+      requires :backend
+
+      initialize_hook do |*names|
+        if options[:writer]
+          names.each do |name|
+            class_eval <<-EOM, __FILE__, __LINE__ + 1
+              def #{name}=(value, locale: nil, **options)
+                #{Writer.setup_source}
+                mobility_backends[:#{name}].write(locale, value, **options)
+              end
+            EOM
+          end
+        end
+      end
+
+      def self.setup_source
+        <<-EOL
+        return super(value) if options[:super]
+        if (locale &&= locale.to_sym)
+          #{"Mobility.enforce_available_locales!(locale)" if I18n.enforce_available_locales}
+          options[:locale] = true
+        else
+          locale = Mobility.locale
+        end
+        EOL
+      end
+    end
+
+    register_plugin(:writer, Writer)
+  end
+end

data/lib/mobility/translations.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+require "mobility/pluggable"
+
+module Mobility
+=begin
+
+Module containing translation accessor methods and other methods for accessing
+translations.
+
+Normally this class will be created by calling +translates+ on the model class,
+added when extending {Mobility}, but it can also be used independent of that
+macro.
+
+==Including Translations in a Class
+
+Since {Translations} is a subclass of +Module+, including an instance of it is
+like including a module. Options passed to the initializer are passed to
+plugins (if those plugins have been enabled).
+
+We can first enable plugins by subclassing `Mobility::Translations`, and
+calling +plugins+ to enable any plugins we want to use. We want reader and
+writer methods for accessing translations, so we enable those plugins:
+
+  class Translations < Mobility::Translations
+    plugins do
+      reader
+      writer
+    end
+  end
+
+Both `reader` and `writer` depend on the `backend` plugin, so this is also enabled.
+
+Then create an instance like this:
+
+  Translations.new("title", backend: :my_backend)
+
+This will generate an anonymous module that behaves approximately like this:
+
+  Module.new do
+    # From Mobility::Plugins::Backend module
+    #
+    def mobility_backends
+      # Returns a memoized hash with attribute name keys and backend instance
+      # values.  When a key is fetched from the hash, the hash calls
+      # +self.class.mobility_backend_class(name)+ (where +name+ is the
+      # attribute name) to get the backend class, then instantiate it (passing
+      # the model instance and attribute name to its initializer) and return it.
+    end
+
+    # From Mobility::Plugins::Reader module
+    #
+    def title(locale: Mobility.locale)
+      mobility_backends[:title].read(locale)
+    end
+
+    def title?(locale: Mobility.locale)
+      mobility_backends[:title].read(locale).present?
+    end
+
+    # From Mobility::Plugins::Writer module
+    def title=(value, locale: Mobility.locale)
+      mobility_backends[:title].write(locale, value)
+    end
+  end
+
+Including this module into a model class will thus add the backends method and
+reader and writer methods for accessing translations. Other plugins (e.g.
+fallbacks, cache) modify the result returned by the backend, by hooking into
+the +included+ callback method on the module, see {Mobility::Plugin} for
+details.
+
+==Setting up the Model Class
+
+Accessor methods alone are of limited use without a hook to actually modify the
+model class. This hook is provided by the {Backend::Setup#setup_model} method,
+which is added to every backend class when it includes the {Backend} module.
+
+Assuming the backend has defined a setup block by calling +setup+, this block
+will be called when {Translations} is {#included} in the model class, passed
+attributes and options defined when the backend was defined on the model class.
+This allows a backend to do things like (for example) define associations on a
+model class required by the backend, as happens in the {Backends::KeyValue} and
+{Backends::Table} backends.
+
+Since setup blocks are evaluated on the model class, it is possible that
+backends can conflict (for example, overwriting previously defined methods).
+Care should be taken to avoid defining methods on the model class, or where
+necessary, ensure that names are defined in such a way as to avoid conflicts
+with other backends.
+
+=end
+  class Translations < Pluggable
+    include Plugins.load_plugin(:attributes)
+  end
+end

data/lib/mobility/version.rb

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 
 module Mobility
-  VERSION = "0.8.10"
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY = 0
+    PRE = "beta2"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
 end

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

@@ -1,90 +1,108 @@
-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
+Mobility.configure do
 
-  # 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
+  # PLUGINS
+  plugins do
+    # Backend
+    #
+    # Sets the default backend to use in models. This can be overridden in models
+    # by passing +backend: ...+ to +translates+.
+    #
+    # To default to a different backend globally, replace +:key_value+ by another
+    # backend name.
+    #
+    backend :key_value
 
-  # 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
+    # ActiveRecord
+    #
+    # Defines ActiveRecord as ORM, and enables ActiveRecord-specific plugins.
+    active_record
 
-  # 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[
-  #   query
-  #   cache
-  #   dirty
-  #   fallbacks
-  #   presence
-  #   default
-  #   attribute_methods
-  #   fallthrough_accessors
-  #   locale_accessors
-  # ]
+    # Accessors
+    #
+    # Define reader and writer methods for translated attributes. Remove either
+    # to disable globally, or pass +reader: false+ or +writer: false+ to
+    # +translates+ in any translated model.
+    #
+    reader
+    writer
 
-  # 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
+    # Backend Reader
+    #
+    # Defines reader to access the backend for any attribute, of the form
+    # +<attribute>_backend+.
+    #
+    backend_reader
+    #
+    # Or pass an interpolation string to define a different pattern:
+    # backend_reader "%s_translations"
 
-  # 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
+    # Query
+    #
+    # Defines a scope on the model class which allows querying on
+    # translated attributes. The default scope is named +i18n+, pass a different
+    # name as default to change the global default, or to +translates+ in any
+    # model to change it for that model alone.
+    #
+    query
 
-  # 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
+    # Cache
+    #
+    # Comment out to disable caching reads and writes.
+    #
+    cache
 
-  # 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
+    # Dirty
+    #
+    # Uncomment this line to include and enable globally:
+    # dirty
+    #
+    # Or uncomment this line to include but disable by default, and only enable
+    # per model by passing +dirty: true+ to +translates+.
+    # dirty 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] = ...
+    # Fallbacks
+    #
+    # Uncomment line below to enable fallbacks, using +I18n.fallbacks+.
+    # fallbacks
+    #
+    # Or uncomment this line to enable fallbacks with a global default.
+    # fallbacks { :pt => :en }
 
-  # Uncomment to enable locale_accessors by default on models. A true value
-  # will use the locales defined either in
-  # Rails.application.config.i18n.available_locales or I18n.available_locales.
-  # If you want something else, pass an array of locales instead.
-  #
-  # config.default_options[:locale_accessors] = true
+    # Presence
+    #
+    # Converts blank strings to nil on reads and writes. Comment out to
+    # disable.
+    #
+    presence
 
-  # 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
+    # Default
+    #
+    # Set a default translation per attributes. When enabled, passing +default:
+    # 'foo'+ sets a default translation string to show in case no translation is
+    # present. Can also be passed a proc.
+    #
+    # default 'foo'
 
-  # 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
+    # Fallthrough Accessors
+    #
+    # Uses method_missing to define locale-specific accessor methods like
+    # +title_en+, +title_en=+, +title_fr+, +title_fr=+ for each translated
+    # attribute. If you know what set of locales you want to support, it's
+    # generally better to use Locale Accessors (or both together) since
+    # +method_missing+ is very slow.  (You can use both fallthrough and locale
+    # accessor plugins together without conflict.)
+    #
+    # fallthrough_accessors
+
+    # Locale Accessors
+    #
+    # Uses +def+ to define accessor methods for a set of locales. By default uses
+    # +I18n.available_locales+, but you can pass the set of locales with
+    # +translates+ and/or set a global default here.
+    #
+    # locale_accessors
+    #
+    # Or define specific defaults by uncommenting line below
+    # locale_accessors [:en, :ja]
+  end
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Chris Salzberg
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain:
 - |
@@ -34,7 +34,7 @@ cert_chain:
   gSQml7TqcC6dZRsZRwYqzD9kUwdAJoCqno2CBUKs2l0yQAjFT36lRrVJznb7uWwa
   xpPFnsrtyaZW6Dty8TSG3qzmeGpmpIotA8x1VA==
   -----END CERTIFICATE-----
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -156,23 +156,15 @@ files:
 - README.md
 - Rakefile
 - lib/mobility.rb
-- lib/mobility/active_model.rb
-- lib/mobility/active_model/backend_resetter.rb
-- lib/mobility/active_record.rb
-- lib/mobility/active_record/backend_resetter.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/active_record/uniqueness_validator.rb
 - lib/mobility/arel.rb
 - lib/mobility/arel/nodes.rb
 - lib/mobility/arel/nodes/pg_ops.rb
 - lib/mobility/arel/visitor.rb
-- lib/mobility/attributes.rb
 - lib/mobility/backend.rb
-- lib/mobility/backend/orm_delegator.rb
-- lib/mobility/backend_resetter.rb
 - lib/mobility/backends.rb
 - lib/mobility/backends/active_record.rb
 - lib/mobility/backends/active_record/column.rb
@@ -186,6 +178,7 @@ files:
 - lib/mobility/backends/active_record/table.rb
 - lib/mobility/backends/column.rb
 - lib/mobility/backends/container.rb
+- lib/mobility/backends/hash.rb
 - lib/mobility/backends/hash_valued.rb
 - lib/mobility/backends/hstore.rb
 - lib/mobility/backends/json.rb
@@ -204,20 +197,23 @@ files:
 - lib/mobility/backends/sequel/table.rb
 - lib/mobility/backends/serialized.rb
 - lib/mobility/backends/table.rb
-- lib/mobility/configuration.rb
-- lib/mobility/fallbacks.rb
-- lib/mobility/interface.rb
-- lib/mobility/loaded.rb
+- lib/mobility/pluggable.rb
+- lib/mobility/plugin.rb
 - lib/mobility/plugins.rb
 - lib/mobility/plugins/active_model.rb
+- lib/mobility/plugins/active_model/cache.rb
 - lib/mobility/plugins/active_model/dirty.rb
 - lib/mobility/plugins/active_record.rb
-- lib/mobility/plugins/active_record/attribute_methods.rb
+- lib/mobility/plugins/active_record/backend.rb
+- lib/mobility/plugins/active_record/cache.rb
 - 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/attribute_methods.rb
+- lib/mobility/plugins/attributes.rb
+- lib/mobility/plugins/backend.rb
+- lib/mobility/plugins/backend_reader.rb
 - lib/mobility/plugins/cache.rb
-- lib/mobility/plugins/cache/translation_cacher.rb
 - lib/mobility/plugins/default.rb
 - lib/mobility/plugins/dirty.rb
 - lib/mobility/plugins/fallbacks.rb
@@ -225,11 +221,13 @@ files:
 - lib/mobility/plugins/locale_accessors.rb
 - lib/mobility/plugins/presence.rb
 - lib/mobility/plugins/query.rb
+- lib/mobility/plugins/reader.rb
 - lib/mobility/plugins/sequel.rb
+- lib/mobility/plugins/sequel/backend.rb
+- lib/mobility/plugins/sequel/cache.rb
 - lib/mobility/plugins/sequel/dirty.rb
 - lib/mobility/plugins/sequel/query.rb
-- lib/mobility/sequel.rb
-- lib/mobility/sequel/backend_resetter.rb
+- lib/mobility/plugins/writer.rb
 - lib/mobility/sequel/column_changes.rb
 - lib/mobility/sequel/hash_initializer.rb
 - lib/mobility/sequel/model_translation.rb
@@ -237,7 +235,7 @@ files:
 - lib/mobility/sequel/string_translation.rb
 - lib/mobility/sequel/text_translation.rb
 - lib/mobility/sequel/translation.rb
-- lib/mobility/translates.rb
+- lib/mobility/translations.rb
 - lib/mobility/util.rb
 - lib/mobility/version.rb
 - lib/rails/generators/mobility/active_record_migration_compatibility.rb
@@ -257,8 +255,11 @@ files:
 homepage: https://github.com/shioyama/mobility
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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:
 rdoc_options: []
 require_paths:
 - lib
@@ -266,15 +267,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.7
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Pluggable Ruby translation framework
 test_files: []