i18n-active_record 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 934e01acf036e3a1c8eb23f5f8f96c55e84d462a31a10183c12389e8466e233d
-  data.tar.gz: a0c8301e9e0c5eaac6badf2dfdeca19b581296eaa0e0a15464a13fbc6796087f
+  metadata.gz: a0bb9a3f4087d304d5ee5fdc38b8df8e31147a412c618fed9c82f1363db579be
+  data.tar.gz: b77a32f97c5d1785084a5c8332ff7e8909ce81ec6d3724ec664650540c72451d
 SHA512:
-  metadata.gz: 0702e26d0b3a600ff2d28db7473e9a34311f18a099a0009ec6bccec5382d5c4bcc9042b33653a214c377c332db0d902adb64103e05a98c1371d6d19ccb3c0297
-  data.tar.gz: f2dd449433f4b88763c5952831feff25956c727aa4ff086c2ae130709bfd968ef36f61bf7b2af9065681ac7132e7e7c3a05c13b268e5c1c3e282285cd1787c6b
+  metadata.gz: 46eb68288d4b64db1760235e72fd73a3a03e7e06d19b9f699ed4b160a423dfde3333fe92f9556fd65ed2d3f1e5d8e1e14d5ffebcfa7d7251fd37632bc3b36f44
+  data.tar.gz: 7f1ace5489592b78a2e0dab66564837025a21cb0a2b10dbaf3999a4ea128c0c983ba8f952b867236d71554226553b2c119ad32a232cf3a96c29f62200b29b9c9

data/README.md

@@ -89,11 +89,26 @@ end
 
 You can now use `I18n.t('Your String')` to lookup translations in the database.
 
-## Missing Translations
+## Custom translation model
+
+By default, the gem relies on [the built-in translation model](https://github.com/svenfuchs/i18n-active_record/blob/master/lib/i18n/backend/active_record/translation.rb).  
+However, to extend the default functionality, the translation model can be customized:
+
+```ruby
+class MyTranslation < I18n::Backend::ActiveRecord::Translation
+  def value=(val)
+    super("custom #{val}")
+  end
+end
 
-### Usage
+I18n::Backend::ActiveRecord.configure do |config|
+  config.translation_model = MyTranslation
+end
+```
+
+## Missing Translations
 
-In order to make the `I18n::Backend::ActiveRecord::Missing` module working correctly pluralization rules should be configured properly.
+To make the `I18n::Backend::ActiveRecord::Missing` module working correctly pluralization rules should be configured properly.
 The `i18n.plural.keys` translation key should be present in any of the backends.
 See https://github.com/svenfuchs/i18n-active_record/blob/master/lib/i18n/backend/active_record/missing.rb for more information.
 
@@ -115,7 +130,7 @@ The `interpolations` field is otherwise unused since the "value" in `Translation
 
 ## Examples
 
-* http://collectiveidea.com/blog/archives/2016/05/31/beyond-yml-files-dynamic-translations/
+* http://collectiveidea.com/blog/archives/2016/05/31/beyond-yml-files-dynamic-translations/ ([use `before_action`](https://github.com/svenfuchs/i18n-active_record/issues/138) for Rails 5.1+)
 
 ## Contributing
 

data/lib/i18n/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module ActiveRecord
-    VERSION = '1.1.0'
+    VERSION = '1.3.0'
   end
 end

data/lib/i18n/backend/active_record/configuration.rb

@@ -4,11 +4,12 @@ module I18n
   module Backend
     class ActiveRecord
       class Configuration
-        attr_accessor :cleanup_with_destroy, :cache_translations
+        attr_accessor :cleanup_with_destroy, :cache_translations, :translation_model
 
         def initialize
           @cleanup_with_destroy = false
           @cache_translations = false
+          @translation_model = I18n::Backend::ActiveRecord::Translation
         end
       end
     end

data/lib/i18n/backend/active_record/missing.rb

@@ -36,13 +36,14 @@ module I18n
     class ActiveRecord
       module Missing
         include Flatten
+        include TranslationModel
 
         def store_default_translations(locale, key, options = {})
           count, scope, _, separator = options.values_at(:count, :scope, :default, :separator)
           separator ||= I18n.default_separator
           key = normalize_flat_keys(locale, key, scope, separator)
 
-          return if ActiveRecord::Translation.locale(locale).lookup(key).exists?
+          return if translation_model.locale(locale).lookup(key).exists?
 
           interpolations = options.keys - I18n::RESERVED_KEYS
           keys = count ? I18n.t('i18n.plural.keys', locale: locale).map { |k| [key, k].join(FLATTEN_SEPARATOR) } : [key]
@@ -50,7 +51,7 @@ module I18n
         end
 
         def store_default_translation(locale, key, interpolations)
-          translation = ActiveRecord::Translation.new locale: locale.to_s, key: key
+          translation = translation_model.new locale: locale.to_s, key: key
           translation.interpolations = interpolations
           translation.save
         end

data/lib/i18n/backend/active_record/store_procs.rb

@@ -23,6 +23,8 @@ module I18n
   module Backend
     class ActiveRecord
       module StoreProcs
+        extend TranslationModel
+
         def value=(val)
           case val
           when Proc
@@ -33,7 +35,7 @@ module I18n
           end
         end
 
-        Translation.send(:include, self) if method(:to_s).respond_to?(:to_ruby)
+        translation_model.send(:include, self) if method(:to_s).respond_to?(:to_ruby)
       end
     end
   end

data/lib/i18n/backend/active_record/translation.rb

@@ -53,8 +53,14 @@ module I18n
 
         self.table_name = 'translations'
 
-        serialize :value
-        serialize :interpolations, Array
+        if ::ActiveRecord.version >= Gem::Version.new('7.1.0.alpha')
+          serialize :value, coder: YAML
+          serialize :interpolations, coder: YAML, type: Array
+        else
+          serialize :value
+          serialize :interpolations, Array
+        end
+
         after_commit :invalidate_translations_cache
 
         class << self
@@ -79,7 +85,7 @@ module I18n
             Translation.select('DISTINCT locale').to_a.map { |t| t.locale.to_sym }
           end
 
-          def to_hash
+          def to_h
             Translation.all.each.with_object({}) do |t, memo|
               locale_hash = (memo[t.locale.to_sym] ||= {})
               keys = t.key.split('.')

data/lib/i18n/backend/active_record.rb

@@ -25,12 +25,21 @@ module I18n
         reload!
       end
 
+      module TranslationModel
+        private
+
+        def translation_model
+          I18n::Backend::ActiveRecord.config.translation_model
+        end
+      end
+
       module Implementation
         include Base
         include Flatten
+        include TranslationModel
 
         def available_locales
-          Translation.available_locales
+          translation_model.available_locales
         rescue ::ActiveRecord::StatementInvalid
           []
         end
@@ -39,7 +48,7 @@ module I18n
           escape = options.fetch(:escape, true)
 
           flatten_translations(locale, data, escape, false).each do |key, value|
-            translation = Translation.locale(locale).lookup(expand_keys(key))
+            translation = translation_model.locale(locale).lookup(expand_keys(key))
 
             if self.class.config.cleanup_with_destroy
               translation.destroy_all
@@ -47,7 +56,7 @@ module I18n
               translation.delete_all
             end
 
-            Translation.create(locale: locale.to_s, key: key.to_s, value: value)
+            translation_model.create(locale: locale.to_s, key: key.to_s, value: value)
           end
 
           reload! if self.class.config.cache_translations
@@ -64,7 +73,7 @@ module I18n
         end
 
         def init_translations
-          @translations = Translation.to_hash
+          @translations = translation_model.to_h
         end
 
         def translations(do_init: false)
@@ -86,9 +95,9 @@ module I18n
           end
 
           result = if key == ''
-            Translation.locale(locale).all
+            translation_model.locale(locale).all
           else
-            Translation.locale(locale).lookup(key)
+            translation_model.locale(locale).lookup(key)
           end
 
           if result.empty?

data/test/active_record_test.rb

@@ -123,7 +123,7 @@ class I18nBackendActiveRecordTest < I18n::TestCase
       I18n.t('.') # Fixes test flakiness by loading available locales
       I18n::Backend::ActiveRecord::Translation.destroy_all
 
-      assert_equal 'translation missing: en.no key', I18n.t('.')
+      assert_match(/[Tt]ranslation missing: en\.no key/, I18n.t('.'))
     end
 
     test 'intially unitinitialized' do
@@ -172,4 +172,23 @@ class I18nBackendActiveRecordTest < I18n::TestCase
       I18n.t('foo')
     end
   end
+
+  class WithCustomTranslationModel < I18nBackendActiveRecordTest
+    class CustomTranslation < I18n::Backend::ActiveRecord::Translation
+      def value=(val)
+        super("custom #{val}")
+      end
+    end
+
+    def setup
+      super
+
+      I18n::Backend::ActiveRecord.config.translation_model = CustomTranslation
+    end
+
+    test 'use a custom model' do
+      store_translations(:en, foo: 'foo')
+      assert_equal I18n.t(:foo), 'custom foo'
+    end
+  end
 end

data/test/test_helper.rb

@@ -10,35 +10,35 @@ require 'i18n/tests'
 
 begin
   require 'active_record'
-  ::ActiveRecord::Base.connection
+  ActiveRecord::Base.connection
 rescue LoadError => e
   puts "can't use ActiveRecord backend because: #{e.message}"
-rescue ::ActiveRecord::ConnectionNotEstablished
+rescue ActiveRecord::ConnectionNotEstablished
   require 'i18n/backend/active_record'
 
-  case ENV['DB']
+  case ENV.fetch('DB', nil)
   when 'postgres'
-    ::ActiveRecord::Base.establish_connection(
+    ActiveRecord::Base.establish_connection(
       adapter: 'postgresql',
       database: 'i18n_unittest',
-      username: ENV['PG_USER'] || 'postgres',
-      password: ENV['PG_PASSWORD'] || 'postgres',
+      username: ENV.fetch('PG_USER', 'postgres'),
+      password: ENV.fetch('PG_PASSWORD', 'postgres'),
       host: 'localhost'
     )
   when 'mysql'
-    ::ActiveRecord::Base.establish_connection(
+    ActiveRecord::Base.establish_connection(
       adapter: 'mysql2',
       database: 'i18n_unittest',
-      username: ENV['MYSQL_USER'] || 'root',
-      password: ENV['MYSQL_PASSWORD'] || '',
+      username: ENV.fetch('MYSQL_USER', 'root'),
+      password: ENV.fetch('MYSQL_PASSWORD', ''),
       host: '127.0.0.1'
     )
   else
-    ::ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+    ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
   end
 
-  ::ActiveRecord::Migration.verbose = false
-  ::ActiveRecord::Schema.define(version: 1) do
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Schema.define(version: 1) do
     create_table :translations, force: true do |t|
       t.string :locale
       t.string :key
@@ -48,6 +48,12 @@ rescue ::ActiveRecord::ConnectionNotEstablished
     end
     add_index :translations, %i[locale key], unique: true
   end
+
+  if ActiveRecord::Base.respond_to?(:yaml_column_permitted_classes=)
+    ActiveRecord::Base.yaml_column_permitted_classes = [Symbol]
+  elsif ActiveRecord.respond_to?(:yaml_column_permitted_classes=)
+    ActiveRecord.yaml_column_permitted_classes = [Symbol]
+  end
 end
 
 TEST_CASE = defined?(Minitest::Test) ? Minitest::Test : MiniTest::Unit::TestCase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-active_record
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -150,7 +150,8 @@ files:
 homepage: http://github.com/svenfuchs/i18n-active_record
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: I18n ActiveRecord backend