i18n-active_record 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0bb9a3f4087d304d5ee5fdc38b8df8e31147a412c618fed9c82f1363db579be
-  data.tar.gz: b77a32f97c5d1785084a5c8332ff7e8909ce81ec6d3724ec664650540c72451d
+  metadata.gz: a6895e3f4b2c615221ac6a44bba495f6a6557e76fe5815fe604005e3e9d455d0
+  data.tar.gz: febd2054212ebeec7624de340aebc0c9f86ae4ec509f55751f97459adef82bf9
 SHA512:
-  metadata.gz: 46eb68288d4b64db1760235e72fd73a3a03e7e06d19b9f699ed4b160a423dfde3333fe92f9556fd65ed2d3f1e5d8e1e14d5ffebcfa7d7251fd37632bc3b36f44
-  data.tar.gz: 7f1ace5489592b78a2e0dab66564837025a21cb0a2b10dbaf3999a4ea128c0c983ba8f952b867236d71554226553b2c119ad32a232cf3a96c29f62200b29b9c9
+  metadata.gz: 3fbd83d43d6158a23eb0573a598c87c23986912403496761d60b9e72950d06ff0897e6e911bb2f3d1073ab0066e17d7aa02c0f288e6b2f43bacad3f306f31625
+  data.tar.gz: b51858da9da92d578fe190a185e45df9779e34dfb07c5b8daf097059edf18394c83fbbb1f2add6ac72b59e8ff19342f1ba3190bb72bee322a4430e25decce5ae

data/README.md

@@ -1,7 +1,7 @@
 # I18n::Backend::ActiveRecord [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop) [![Tests Status](https://github.com/svenfuchs/i18n-active_record/actions/workflows/test.yml/badge.svg)](https://github.com/svenfuchs/i18n-active_record/actions) [![Linter Status](https://github.com/svenfuchs/i18n-active_record/actions/workflows/linter.yml/badge.svg)](https://github.com/svenfuchs/i18n-active_record/actions)
 
 This repository contains the I18n ActiveRecord backend and support code that has been extracted from the `I18n` gem: http://github.com/svenfuchs/i18n.
-It is fully compatible with Rails 4, 5 and 6.
+It is fully compatible with Rails 4+.
 
 ## Installation
 
@@ -85,6 +85,16 @@ I18n::Backend::ActiveRecord.configure do |config|
 end
 ```
 
+The ActiveRecord backend can be configured to use a `scope` to isolate sets of translations. That way, two applications
+using the backend with the same database table can use translation data independently of one another.
+If configured with a scope, all data used will be limited to records with that particular scope identifier:
+
+```ruby
+I18n::Backend::ActiveRecord.configure do |config|
+  config.scope = 'app1' # defaults to nil, disabling scope
+end
+```
+
 ## Usage
 
 You can now use `I18n.t('Your String')` to lookup translations in the database.

data/lib/generators/i18n/active_record/templates/advanced_initializer.rb.erb

@@ -15,4 +15,5 @@ end
 I18n::Backend::ActiveRecord.configure do |config|
   # config.cache_translations = true # defaults to false
   # config.cleanup_with_destroy = true # defaults to false
+  # config.scope = 'app_scope' # defaults to nil, won't be used
 end

data/lib/generators/i18n/active_record/templates/migration.rb.erb

@@ -1,6 +1,7 @@
 class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     create_table :<%= table_name %> do |t|
+      t.string :scope
       t.string :locale
       t.string :key
       t.text :value

data/lib/generators/i18n/active_record/templates/simple_initializer.rb.erb

@@ -4,4 +4,5 @@ I18n.backend = I18n::Backend::ActiveRecord.new
 I18n::Backend::ActiveRecord.configure do |config|
   # config.cache_translations = true # defaults to false
   # config.cleanup_with_destroy = true # defaults to false
+  # config.scope = 'app_scope' # defaults to nil, won't be used
 end

data/lib/i18n/active_record/version.rb

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

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

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

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

@@ -61,13 +61,24 @@ module I18n
           serialize :interpolations, Array
         end
 
+        before_validation :set_scope
         after_commit :invalidate_translations_cache
 
+        default_scope { scoped }
+
         class << self
           def locale(locale)
             where(locale: locale.to_s)
           end
 
+          def scoped
+            if (record_scope = ActiveRecord.config.scope)
+              where(scope: record_scope)
+            else
+              all
+            end
+          end
+
           def lookup(keys, *separator)
             column_name = connection.quote_column_name('key')
             keys = Array(keys).map!(&:to_s)
@@ -82,11 +93,11 @@ module I18n
           end
 
           def available_locales
-            Translation.select('DISTINCT locale').to_a.map { |t| t.locale.to_sym }
+            select('DISTINCT locale').to_a.map { |t| t.locale.to_sym }
           end
 
           def to_h
-            Translation.all.each.with_object({}) do |t, memo|
+            all.each.with_object({}) do |t, memo|
               locale_hash = (memo[t.locale.to_sym] ||= {})
               keys = t.key.split('.')
               keys.each.with_index.inject(locale_hash) do |iterator, (key_part, index)|
@@ -129,6 +140,12 @@ module I18n
         def invalidate_translations_cache
           I18n.backend.reload! if I18n::Backend::ActiveRecord.config.cache_translations
         end
+
+        private
+
+        def set_scope
+          self.scope ||= ActiveRecord.config.scope if ActiveRecord.config.scope
+        end
       end
     end
   end

data/test/active_record_test.rb

@@ -191,4 +191,35 @@ class I18nBackendActiveRecordTest < I18n::TestCase
       assert_equal I18n.t(:foo), 'custom foo'
     end
   end
+
+  class ScopeTest < I18nBackendActiveRecordTest
+    def setup
+      super
+
+      I18n::Backend::ActiveRecord.config.scope = 'scope1'
+    end
+
+    test 'scope config option divides translations into isolated sets' do
+      store_translations(:en, foo: 'foo1')
+      assert_equal('foo1', I18n.t(:foo))
+
+      I18n::Backend::ActiveRecord.config.scope = 'scope2'
+      store_translations(:en, foo: 'foo2')
+      assert_equal('foo2', I18n.t(:foo))
+
+      I18n::Backend::ActiveRecord.config.scope = 'scope1'
+      assert_equal('foo1', I18n.t(:foo))
+    end
+
+    test 'scope config of nil disables scope' do
+      store_translations(:en, bar1: 'bar1')
+
+      I18n::Backend::ActiveRecord.config.scope = 'scope2'
+      store_translations(:en, bar2: 'bar2')
+
+      I18n::Backend::ActiveRecord.config.scope = nil
+      assert_equal('bar1', I18n.t(:bar1))
+      assert_equal('bar2', I18n.t(:bar2))
+    end
+  end
 end

data/test/test_helper.rb

@@ -40,13 +40,14 @@ rescue ActiveRecord::ConnectionNotEstablished
   ActiveRecord::Migration.verbose = false
   ActiveRecord::Schema.define(version: 1) do
     create_table :translations, force: true do |t|
+      t.string :scope
       t.string :locale
       t.string :key
       t.text :value
       t.text :interpolations
       t.boolean :is_proc, default: false
     end
-    add_index :translations, %i[locale key], unique: true
+    add_index :translations, %i[scope locale key], unique: true
   end
 
   if ActiveRecord::Base.respond_to?(:yaml_column_permitted_classes=)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-active_record
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n