mobility 1.2.9 → 1.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a2836c1681d1832331e807e58fa61956426ddc3cc730c15e6b3d6ebac2fce40
-  data.tar.gz: 61c798b73769f7d73bb5a3a97b3a1a27ac8884a186df89aeb5ceef0ecb92b692
+  metadata.gz: 8a89e6682c14088be7f337e5a03c5b510a67dd7a93ee88024f3686f9bfc4694e
+  data.tar.gz: c5a99fc2000e05d2d3ccc3ff9d6dd00357dc3b5ace57d7c92782b2601bd32e51
 SHA512:
-  metadata.gz: e8693fb2b5d997a1d7029413aee5c5f064eeafbef6f8a10ad2c947bd545fff72e238f6d57ebaae8761d5948e036446d310f7ce9da3c047a7577818919dfd7908
-  data.tar.gz: e980cc7d53a32c517c04994105540fd9635aae5899d35cecb1544a36ef052619adb0647b58ec666902402e8ad642c85aa576f0301d3708211e83b5f3d0e6d95b
+  metadata.gz: f60e92ede85fc444d4151a14c833a13ced95c1e2f073fafa024aa967de01810e5b2b6ccfc4365c5d338679d1899573ec2921453ce44dcdc9736fde749ad650ed
+  data.tar.gz: 21319dd41e1025a82545a08da30fcafd38d5bc61c86bdcfe2b017b195d670a9a503fbff8101a7897b99fe32e3c0bf19666bd0c86f06887fb697a8bce132b6253

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Mobility Changelog
 
+## 1.3
+
+### 1.3.0.rc1
+
+This version includes potentially breaking chnages for jsonb and hstore
+backends. See PRs below for details.
+
+- Fix ActiveRecord JSONB blank values
+  ([#536](https://github.com/shioyama/mobility/pull/536))
+- Support primary keys other then :id on model classes
+  ([#542](https://github.com/shioyama/mobility/pull/542))
+- Clean up and refactor container backend
+  ([#543](https://github.com/shioyama/mobility/pull/543)),
+  thanks [doits](https://github.com/doits)!
+- Update fallthrough_accessor regex to allow for ISO 639-2 codes
+  ([#580](https://github.com/shioyama/mobility/pull/580))
+  thanks [phil-allcock](https://github.com/phil-allcock)!
+
 ## 1.2
 
 ### 1.2.9
@@ -11,7 +29,8 @@
 - Fix issues with subclassing, such as when using AR STI,
   fixes [#566](https://github.com/shioyama/mobility/issues/566)
   ([#568](https://github.com/shioyama/mobility/pull/568))
-- Handle attribute_method_matchers rename (part of #560)
+- Handle `attribute_method_matchers` rename (part of
+  [#560](https://github.com/shioyama/mobility/pull/560))
 
 ### 1.2.7
 - Do not query same attribute more than once, fixes

data/Gemfile.lock

@@ -1,27 +1,17 @@
 PATH
   remote: .
   specs:
-    mobility (1.2.8)
+    mobility (1.3.0.rc1)
       i18n (>= 0.6.10, < 2)
       request_store (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3)
-      activesupport (= 7.0.3)
-    activerecord (7.0.3)
-      activemodel (= 7.0.3)
-      activesupport (= 7.0.3)
-    activesupport (7.0.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
     benchmark-ips (2.10.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     database_cleaner (1.99.0)
     diff-lcs (1.5.0)
     ffi (1.15.5)
@@ -40,26 +30,24 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    minitest (5.16.1)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pg (1.3.5)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    rack (2.2.3.1)
+    rack (3.0.7)
     rake (12.3.3)
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
@@ -81,8 +69,6 @@ GEM
     rspec-support (3.11.0)
     shellany (0.0.1)
     thor (1.2.1)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
@@ -91,16 +77,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 7.0.0)
   benchmark-ips
   database_cleaner (~> 1.5, >= 1.5.3)
   guard-rspec
   mobility!
-  pg
   pry-byebug
   rake (~> 12, >= 12.2.1)
   rspec (~> 3.0)
   yard (~> 0.9.0)
 
 BUNDLED WITH
-   2.1.4
+   2.4.10

data/README.md

@@ -55,7 +55,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mobility', '~> 1.2.9'
+gem 'mobility', '~> 1.3.0.rc1'
 ```
 
 ### ActiveRecord (Rails)

data/lib/mobility/backends/active_record/container.rb

@@ -22,7 +22,11 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
       # @param [Hash] options
       # @return [String,Integer,Boolean] Value of translation
       def read(locale, _ = nil)
-        model_translations(locale)[attribute]
+        locale_translations = model_translations(locale)
+
+        return unless locale_translations
+
+        locale_translations[attribute.to_s]
       end
 
       # @note Translation may be a string, integer, boolean, hash or array
@@ -33,7 +37,7 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
       # @return [String,Integer,Boolean] Updated value
       def write(locale, value, _ = nil)
         set_attribute_translation(locale, value)
-        model_translations(locale)[attribute]
+        read(locale)
       end
       # @!endgroup
 
@@ -42,8 +46,7 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
         # @option options [Symbol] column_name (:translations) Name of column on which to store translations
         # @raise [InvalidColumnType] if the type of the container column is not json or jsonb
         def configure(options)
-          options[:column_name] ||= :translations
-          options[:column_name] = options[:column_name].to_sym
+          options[:column_name] = options[:column_name]&.to_sym || :translations
         end
         # @!endgroup
 
@@ -78,14 +81,12 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
 
       # @!macro backend_iterator
       def each_locale
-        model[column_name].each do |l, v|
-          yield l.to_sym if v.present?
+        model[column_name].each_key do |l|
+          yield l.to_sym
         end
       end
 
       setup do |_attributes, options|
-        store options[:column_name], coder: Coder
-
         # Fix for duping depth-2 jsonb column in AR < 5.0
         if ::ActiveRecord::VERSION::STRING < '5.0'
           column_name = options[:column_name]
@@ -107,32 +108,23 @@ Implements the {Mobility::Backends::Container} backend for ActiveRecord models.
       private
 
       def model_translations(locale)
-        model[column_name][locale] ||= {}
+        model[column_name][locale.to_s]
       end
 
       def set_attribute_translation(locale, value)
-        translations = model[column_name] || {}
-        translations[locale.to_s] ||= {}
-        translations[locale.to_s][attribute] = value
-        model[column_name] = translations
-      end
+        locale_translations = model_translations(locale)
 
-      class Coder
-        def self.dump(obj)
-          if obj.is_a? ::Hash
-            obj.inject({}) do |translations, (locale, value)|
-              value.each do |k, v|
-                (translations[locale] ||= {})[k] = v if v.present?
-              end
-              translations
-            end
+        if locale_translations
+          if value.nil?
+            locale_translations.delete(attribute.to_s)
+
+            # delete empty locale hash if last attribute was just deleted
+            model[column_name].delete(locale.to_s) if locale_translations.empty?
           else
-            raise ArgumentError, "Attribute is supposed to be a Hash, but was a #{obj.class}. -- #{obj.inspect}"
+            locale_translations[attribute.to_s] = value
           end
-        end
-
-        def self.load(obj)
-          obj
+        elsif !value.nil?
+          model[column_name][locale.to_s] = { attribute.to_s => value }
         end
       end
 

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

@@ -138,7 +138,7 @@ Implements the {Mobility::Backends::KeyValue} backend for ActiveRecord models.
                          on(t[key_column].eq(key).
                             and(t[:locale].eq(locale).
                                 and(t[:"#{belongs_to}_type"].eq(model_class.base_class.name).
-                                    and(t[:"#{belongs_to}_id"].eq(m[:id]))))).join_sources)
+                                    and(t[:"#{belongs_to}_id"].eq(m[model_class.primary_key] || m[:id]))))).join_sources)
         end
 
         def already_joined?(relation, name, locale, join_type)

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

@@ -15,34 +15,25 @@ Internal class used by ActiveRecord backends backed by a Postgres data type
         include ActiveRecord
         include HashValued
 
-        # @!macro backend_iterator
-        def each_locale
-          super { |l| yield l.to_sym }
+        def read(locale, _options = nil)
+          translations[locale.to_s]
         end
 
-        def translations
-          model.read_attribute(column_name)
+        def write(locale, value, _options = nil)
+          if value.nil?
+            translations.delete(locale.to_s)
+          else
+            translations[locale.to_s] = value
+          end
         end
 
-        setup do |attributes, options = {}|
-          attributes.each { |attribute| store (options[:column_affix] % attribute), coder: Coder }
+        # @!macro backend_iterator
+        def each_locale
+          super { |l| yield l.to_sym }
         end
 
-        class Coder
-          def self.dump(obj)
-            if obj.is_a? ::Hash
-              obj.inject({}) do |translations, (locale, value)|
-                translations[locale] = value unless value.nil?
-                translations
-              end
-            else
-              raise ArgumentError, "Attribute is supposed to be a Hash, but was a #{obj.class}. -- #{obj.inspect}"
-            end
-          end
-
-          def self.load(obj)
-            obj
-          end
+        def translations
+          model[column_name]
         end
       end
       private_constant :PgHash

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

@@ -145,7 +145,7 @@ columns to that table.
           m = model_class.arel_table
           t = model_class.const_get(subclass_name).arel_table.alias(table_alias(locale))
           relation.joins(m.join(t, join_type).
-                         on(t[foreign_key].eq(m[:id]).
+                         on(t[foreign_key].eq(m[model_class.primary_key] || m[:id]).
                             and(t[:locale].eq(locale))).join_sources)
         end
 

data/lib/mobility/plugins/backend.rb

@@ -45,7 +45,7 @@ Defines:
         klass.extend ClassMethods
 
         if backend
-          @backend_class = backend.build_subclass(klass, backend_options)
+          @backend_class = backend.build_subclass(klass, **backend_options)
 
           backend_class.setup_model(klass, names)
 

data/lib/mobility/plugins/fallthrough_accessors.rb

@@ -36,7 +36,7 @@ model class is generated.
       private
 
       def define_fallthrough_accessors(*names)
-        method_name_regex = /\A(#{names.join('|')})_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
+        method_name_regex = /\A(#{names.join('|')})_([a-z]{2,3}(_[a-z]{2})?)(=?|\??)\z/.freeze
 
         define_method :method_missing do |method_name, *args, &block|
           if method_name =~ method_name_regex

data/lib/mobility/version.rb

@@ -7,9 +7,9 @@ module Mobility
 
   module VERSION
     MAJOR = 1
-    MINOR = 2
-    TINY = 9
-    PRE = nil
+    MINOR = 3
+    TINY = 0
+    PRE = "rc1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

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

@@ -58,6 +58,19 @@ Mobility.configure do
     # Or uncomment this line to include but disable by default, and only enable
     # per model by passing +dirty: true+ to +translates+.
     # dirty false
+    
+    # Column Fallback
+    #
+    # Uncomment line below to fallback to original column. You can pass
+    # +column_fallback: true+ to +translates+ to return original column on
+    # default locale, or pass +column_fallback: [:en, :de]+ to +translates+
+    # to return original column for those locales or pass
+    # +column_fallback: ->(locale) { ... }+ to +translates to evaluate which
+    # locales to return original column for.
+    # column_fallback
+    #
+    # Or uncomment this line to enable column fallback with a global default.
+    # column_fallback true
 
     # Fallbacks
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobility
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.3.0.rc1
 platform: ruby
 authors:
 - Chris Salzberg
@@ -10,31 +10,32 @@ bindir: exe
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhjaHJp
-  cy9EQz1kZWppbWF0YS9EQz1jb20wHhcNMjIwMzAyMDMyMTA5WhcNMjMwMzAyMDMy
-  MTA5WjAjMSEwHwYDVQQDDBhjaHJpcy9EQz1kZWppbWF0YS9EQz1jb20wggGiMA0G
-  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDURCKbt5oY0sCp4kYK1u5SLzVHg6Q1
-  2LejeQvUGpR3gulWqrq/507XRxE/9FSpLfgo3cGGYio1/gg2Yp7pBI4ZNEz8d2Vg
-  6caWLHYtHYF0/jlo177UspEF1bt3lCCmaA/ZyQpvoLi76Jf6VCBjepMqhLjeBSsA
-  xUqSdgNT8lzduOzdYk/GWf2Trvyz72IN6rY7hSwJ/U4R2DusRNTbKC55iyu0MyqI
-  Nks33les0xQERucqes1YzSEnpott/GUQ/fFWV1Qx7M1hMnqbQIm493BueR6X95a2
-  B7/aqY7LUVVmn9p65NMBJhbbP/pbAcLYV0C+y1Jy9NaVQTpWmJXVKBpYwlAzOJOQ
-  +b/7MBzT5Zzudkq9OlA5rZJB0hFo/Bm38MOCTSTk1/RT+zmoOyb4bx/h400L4ZUt
-  bRGON33BZ99gPiYdGfd3Pc/7FooteJASjKIO4Hman2ELRIdu6Bq+fIkTdJBcruS/
-  XL6xoRitCG7CX0IqmMKuLiKA/J0amAikHGsCAwEAAaN3MHUwCQYDVR0TBAIwADAL
-  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFMNUGAhS68egZT6DOfJwrfIdCtT/MB0GA1Ud
-  EQQWMBSBEmNocmlzQGRlamltYXRhLmNvbTAdBgNVHRIEFjAUgRJjaHJpc0BkZWpp
-  bWF0YS5jb20wDQYJKoZIhvcNAQELBQADggGBAHJPxoU7brN6goci9iclRYUq1Prs
-  51E87VRywUDysHpaHJoGRTqRJsQxi5aGZ9pIbiXGj9WJKKnrhiv5cM5fWtAsz564
-  Ro+Zyx6UVt/2z9rcfYrnXtmC9wh+5/0UqAeoan9RiSd8lscQZ9pEY0E3cmzJRHSU
-  t8kwB2ipVkFO17mdTVgc3C2ZbWRq80eTzkELDBb+8xO0Cskyh4sGMTOKfHs2RWcJ
-  217Qeg0F9w0RcqwnORe5zmPihY9zswCPh0IUaJa1pNY+MLTff9LE/qTl3WVTgrif
-  HsSSnstQYPSLJ3hSP/cu1aOmdXlJiim//XlDQ9DNp4KWje3UW3DMRdTwjW5wPmUq
-  VA9Ij7DUPaZzUpy1NZEigf1GshvslOnvN5bgol1YFR46jpfZVlgt0K5XBQVNvp/A
-  QHgocnSksU5GOM+G2UhjVycbTamd+bCxjWAZTEDZNafFt5CmnfK1D1UTIblR/ci9
-  fUDdW+GhxhobB8N1mtDRlhELoxLLjx7mSvJ3Wg==
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MQ4wDAYDVQQDDAVjaHJp
+  czEYMBYGCgmSJomT8ixkARkWCGRlamltYXRhMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTIzMDMyODA3MTQzNVoXDTI0MDMyNzA3MTQzNVowPzEOMAwGA1UEAwwFY2hy
+  aXMxGDAWBgoJkiaJk/IsZAEZFghkZWppbWF0YTETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAJI6uJ3SQZs7gaYR4nFb
+  yKG+ZHDMoAvrYHPp5hb3ssueoniFtfV1SOh2QOm3AfdA4XIiUco1NAepYkp+zEIT
+  sCUKWkYe8uOwvpdTBrO6JbEfFw0/2ewkCWreN/hfFjOXqZIieJXEHeScrzbU0w/6
+  /oa3rsiN91ED1qaQqRU7K9pPuhuOnKrZSzdTDpbwbBn4jK2j2BQ2/yRlX6FObOWa
+  4gpyFpr0jU0rpk38UOiHS9uDN7Zi+uagAulgHHkzfYaNPjCswIdobpzLiT9C0stQ
+  EYI4cc51dAhoVR4FYP+J0xXn9t39fZ5+843krkOHOcPJxfT1wXGI/guKoqHETzoV
+  Tjc1sIgjWqOyBKAafAOvz1+5lltt2WO3HtBS8/56HUlP6JGt33cQwXqMkCJFo3PO
+  on4XH3YFH5Qc9d27RWjAzPZChKT0uiWudVkWxtWBJLCaJPtqrrA/PMWm+G7Vuioo
+  m+XtpehDzW18iPY1tIh0gW5dZQ49oD9phdjJyBWwXdQHbQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUQfErg7vOK5dNHaiq3mnsnUbr
+  1g4wHQYDVR0RBBYwFIESY2hyaXNAZGVqaW1hdGEuY29tMB0GA1UdEgQWMBSBEmNo
+  cmlzQGRlamltYXRhLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAbOb7AfkztyaGZfbc
+  aS3UyLCtMAyDqvBL0mG3lNTEpGgqYXA0XH/zWcg5Ehj1dd3zSYwg/4Pj8xZNQZm+
+  kgHVMuNww7jO5npdKfO5jpKqBRifk5DFiG0GfI0j3F1TTTmXmqC7EmBGW5tF0pR1
+  nStAwt6Gip/6f0pY39iq3xV71tQ9CUA6Mm3UWDTS0sFqQTGGhlOssXUeUebBbINV
+  O4iRiOQfNE9kTVNN8cJqnAig8TgBTGuHkIFXnEwI7FHV6AOi5YEdtQVczT+5Flvv
+  cLGJnX0OPeuhEDhu0qjpHtITTCULlENZJQ84n9Og3zHHGEqJ693Zs9Q3NUHu9OPX
+  UxjefiDKMZyQoluoOqFbQeNF0wUxbZ++hxkg8FEHzCsEDNtFKbf3LdQ8GMkNofml
+  QnAXcxRDe1ne9jJyVo8hEgxLTG60CK2v46NPXc8FG6TTrp3GWX7G8HzaU2/Z2WAk
+  SQ1li+pvoD9RLbDgJxzXm5YqF799qRUYoP/85TXkGYip7dYM
   -----END CERTIFICATE-----
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -254,11 +255,11 @@ metadata:
   rubygems_mfa_required: 'true'
 post_install_message: |2
 
-  Warning: Mobility v1.0 includes backwards-incompatible changes (mostly around configuration).
+  Warning: Mobility v1.3.x includes potentially backwards-incompatible changes
+  for jsonb/hstore backends.
 
-  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
+  Please see:
+  - https://github.com/shioyama/mobility/issues/535
 rdoc_options: []
 require_paths:
 - lib
@@ -269,11 +270,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       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.1.2
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Pluggable Ruby translation framework