mobility 0.8.8 → 1.0.0.alpha

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
 
-  # 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
+  config.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,41 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - Chris Salzberg
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MQ4wDAYDVQQDDAVjaHJp
-  czEYMBYGCgmSJomT8ixkARkWCGRlamltYXRhMRMwEQYKCZImiZPyLGQBGRYDY29t
-  MB4XDTE5MDkxNzIxNTE0NFoXDTIwMDkxNjIxNTE0NFowPzEOMAwGA1UEAwwFY2hy
-  aXMxGDAWBgoJkiaJk/IsZAEZFghkZWppbWF0YTETMBEGCgmSJomT8ixkARkWA2Nv
-  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAJmJoeQUuRZn95UFlmyx
-  7tz1Gus86VxP3HL4JFygrXKibPPR3lWTKT5hEce0Tq4Uz3XbtR/6HDVROl6F6o+D
-  TMRWDWpCt8rmO15I9qk3/qO+QKeCGq4Ip8f+ngNmltxrIm1QCrfWcDRyXbxC6pVS
-  nPnzmzvEKecBcarFejoEFVaYyAg/dr+mYSBuw4OAyihjiZiyrJiSZFaNwTPF/Cgl
-  /Fg4owJgLBJnIjQECgS36/bS/FwbqhjKn0zC+uFQ5Ge5d+1f9a1VUh4pWLFtDhsM
-  A+WaC9tDDkP5hdwBRNtC/GzRVhcETLbTGfuva9WI4AEb+bKaXT3mnQCPWTMXy2r9
-  Gb3xsI5q4Z6V2SUy3EufX0ECqInYo+KuWI2LofJtINU+jXK2HflO92TtoZlq0wyj
-  FI/Ncj7LVGYoJOc+FS9X67Bslwtggy4qAdarGCucjGEhSaPY1WKjisfR4FMD+F2s
-  B8ecdtdQ1WrUPMaSqt0bKmb05XkXUuEPgQ8OFSnqqI/djQIDAQABo3cwdTAJBgNV
-  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUx6G+Mil2q/PCdUmStPcxKekY
-  2rowHQYDVR0RBBYwFIESY2hyaXNAZGVqaW1hdGEuY29tMB0GA1UdEgQWMBSBEmNo
-  cmlzQGRlamltYXRhLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAb6QN+TfzNfYu5FiY
-  M9UkremeV22FFCvdMUa3rYfHXEi+4B6hVAZ1SFuGnFg4hs55zGMAbn3U1TVxPpTh
-  ayCWP90Q3QQnuErBYd8a2kZQQst3JiM1SqzBP1sl0A2GgPxJnZ/86hxGX779kJEK
-  xaaUIfFpOZmCi8lU3PQPXo7VS8xQD1/mjDNJQ3siYHj1D2M2XTTBiN/Pmn13g/OL
-  iGNjSIVjF5vnyabdfN19bkMIP9SUSrRAJrUSBR83yeuHkMQVcIU2KqxCH6tFauyL
-  XF6FOrEM/w0DX76aDqvrJDngawLQdvLSxjDXGiw53RS1Y6ZoTSmiGNNlRqXAfMSY
-  rtbaaRGru2JGceCASdGGE4EBJCpAjSYtk1I4x+6rTaMd4Tnfl6zrHfTlASLpfxfL
-  cbyauX5dx2EyKhuidQ7l3jDOcpFUDWeaqqZllz/0i2LFBILAlYRy82zaspW5k6g3
-  YL4OF4e7t6EeQyBoILL36f8LpD9odUTRdNruhmuEtoQ+kchZ
+  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhjaHJp
+  cy9EQz1kZWppbXN0YS9EQz1jb20wHhcNMjAwMjExMDEwMjM1WhcNMjEwMjEwMDEw
+  MjM1WjAjMSEwHwYDVQQDDBhjaHJpcy9EQz1kZWppbXN0YS9EQz1jb20wggGiMA0G
+  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC99crJF+gE4WQnN7S4xdacGpZWg7hZ
+  UlXPXM1vX4HVaw8essO6eNGafYqKRQKf3WDW4uM6kqPd4OZTfahGhocVtVScJYGi
+  5SRuw9rrJeFlojUkCSqy47on7t858OebbD28eo71sZLTclGmza6UpjiLZqy0AL4P
+  9dkK2j9pQJ3jYTNYteq7P6A109ExSGWbaRvkAKU+vTMJsK5MW2bWullsOGHrZiPW
+  7PXAaU33X29ddLu/zj/4qe83GVvnrprjw5RRgoQgP0Umw8zKG50XB7nS3TAUiaRz
+  oD+eKgOIeZpPRwemINf0VsP1L+/FnUS6BkzVCOV9MWhUbrkdxCHLrSB8JL4ooXXR
+  N/J4KlR5xpv6b+z+i2lScfkrH7r9RF4ZtpiDQzyCxvuIZOQTzUneUSzMIk9BaEN2
+  5S19cDUjW5fi75npJ+YnrUN83Ta3sa/Pp4dnUqiBK7WHBDnHMN6j7iASoAjKVTgM
+  8F/xjk4qgxA7vjv2obj2zv65CknnQprLCpMCAwEAAaN3MHUwCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFOO4919GTuKTQA2Klo2QO3jGlbJTMB0GA1Ud
+  EQQWMBSBEmNocmlzQGRlamltc3RhLmNvbTAdBgNVHRIEFjAUgRJjaHJpc0BkZWpp
+  bXN0YS5jb20wDQYJKoZIhvcNAQELBQADggGBADfIFBldH77wyUv2RZ1kwvuvRvpL
+  RNFdQlCbuVSn3abRAmc9rIsh80syhjWjYnml3guf+g2tYB1rU3NeTFRVupdvcUWJ
+  T6mITUeDHpNoxF6KAp3zSsdoBoEHdOBNH7Jpxp+L3a2LZ0k6fW12xEafmymOD3fp
+  BmIrE2Vr9aUec2Sk4fbKEYqsxhmXx+o8kKU7tnxVYMv4cX5X3yo45FA7Rh2JQuub
+  MBT+NALoYFaSTHWIr/4tAolWVt8NNGUKEokaFjjf5gAGM6piq6ohTHl5dCtcEPX1
+  klHOa2pIFwuUAWoVCpZa9XzRV5qz+mUrU70DF9dX6Cotv/sKOIxiGvQLnwzlSQWH
+  iXMqkM6Y5FSwViOQy4U2egDDSTB5a16iAnN7/qzqex6SYTsQdSmyc0mWCb9rkIoF
+  gSQml7TqcC6dZRsZRwYqzD9kUwdAJoCqno2CBUKs2l0yQAjFT36lRrVJznb7uWwa
+  xpPFnsrtyaZW6Dty8TSG3qzmeGpmpIotA8x1VA==
   -----END CERTIFICATE-----
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2020-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -157,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
@@ -187,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
@@ -205,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
@@ -226,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
@@ -238,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
@@ -258,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
@@ -267,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.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Pluggable Ruby translation framework
 test_files: []

data/lib/mobility/active_model.rb

@@ -1,4 +0,0 @@
-module Mobility
-  module ActiveModel
-  end
-end

data/lib/mobility/active_model/backend_resetter.rb

@@ -1,26 +0,0 @@
-module Mobility
-  module ActiveModel
-=begin
-
-Backend resetter for ActiveModel models. Adds hook to reset backend when
-+changes_applied+ or +clear_changes_information+ methods are called on model.
-
-=end
-    class BackendResetter < Mobility::BackendResetter
-
-      # (see Mobility::BackendResetter#initialize)
-      def initialize(attribute_names, &block)
-        super
-
-        model_reset_method = @model_reset_method
-
-        %i[changes_applied clear_changes_information].each do |method|
-          define_method method do
-            super()
-            instance_eval(&model_reset_method)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mobility/active_record.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-require "mobility/arel"
-
-module Mobility
-=begin
-
-Module loading ActiveRecord-specific classes for Mobility models.
-
-=end
-  module ActiveRecord
-    require "mobility/active_record/uniqueness_validator"
-
-    def self.included(model_class)
-      model_class.class_eval do
-        unless const_defined?(:UniquenessValidator)
-          const_set(:UniquenessValidator,
-                    Class.new(::Mobility::ActiveRecord::UniquenessValidator))
-        end
-        delegate :translated_attribute_names, to: :class
-      end
-    end
-  end
-end

data/lib/mobility/active_record/backend_resetter.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-require "mobility/active_model/backend_resetter"
-
-module Mobility
-  module ActiveRecord
-=begin
-
-Backend resetter for ActiveRecord models. Adds hook on +reload+ event to
-{Mobility::ActiveModel::BackendResetter}.
-
-=end
-    class BackendResetter < Mobility::ActiveModel::BackendResetter
-
-      # (see Mobility::BackendResetter#initialize)
-      def initialize(attribute_names, &block)
-        super
-
-        model_reset_method = @model_reset_method
-
-        define_method :reload do |*args|
-          super(*args).tap { instance_eval(&model_reset_method) }
-        end
-      end
-    end
-  end
-end