Scope config option to isolate translations (#140)

* Improve CI

- Add Rails 8 to test matrix
- Add excludes for incompatable Ruby/Rails combinations
- Fix sqlite3 dependencies for older Rails versions

* Add scope config option

Allow the entire backend to use translations only from a subset of
the translation records.

Author: vipera

.github/workflows/test.yml

@@ -36,35 +36,41 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        ruby: [2.5, 2.6, 2.7, '3.0', 3.1, 3.2, 'head']
-        rails: [4, 5, 6, 7, 'head']
+        ruby: [2.5, 2.6, 2.7, '3.0', 3.1, 3.2, 3.3, 'head']
+        rails: [4, 5, 6, 7, 8, 'head']
         exclude:
-          - ruby: 2.5
-            rails: 7
-          - ruby: 2.5
-            rails: head
-          - ruby: 2.6
-            rails: 7
-          - ruby: 2.6
-            rails: head
-          - ruby: 2.7
-            rails: 4
-          - ruby: '3.0'
-            rails: 4
-          - ruby: '3.0'
-            rails: 5
-          - ruby: 3.1
-            rails: 4
-          - ruby: 3.1
-            rails: 5
-          - ruby: 3.2
-            rails: 4
-          - ruby: 3.2
-            rails: 5
-          - ruby: head
-            rails: 4
-          - ruby: head
-            rails: 5
+          - { 'ruby': '2.5', 'rails': '7' }
+          - { 'ruby': '2.5', 'rails': '8' }
+          - { 'ruby': '2.5', 'rails': 'head' }
+
+          - { 'ruby': '2.6', 'rails': '7' }
+          - { 'ruby': '2.6', 'rails': '8' }
+          - { 'ruby': '2.6', 'rails': 'head' }
+
+          - { 'ruby': '2.7', 'rails': '4' }
+          - { 'ruby': '2.7', 'rails': '8' }
+          - { 'ruby': '2.7', 'rails': 'head' }
+
+          - { 'ruby': '3.0', 'rails': '4' }
+          - { 'ruby': '3.0', 'rails': '5' }
+          - { 'ruby': '3.0', 'rails': '8' }
+          - { 'ruby': '3.0', 'rails': 'head' }
+
+          - { 'ruby': '3.1', 'rails': '4' }
+          - { 'ruby': '3.1', 'rails': '5' }
+          - { 'ruby': '3.1', 'rails': '8' }
+          - { 'ruby': '3.1', 'rails': 'head' }
+
+          - { 'ruby': '3.2', 'rails': '4' }
+          - { 'ruby': '3.2', 'rails': '5' }
+
+          - { 'ruby': '3.3', 'rails': '4' }
+          - { 'ruby': '3.3', 'rails': '5' }
+
+          - { 'ruby': 'head', 'rails': '4' }
+          - { 'ruby': 'head', 'rails': '5' }
+          - { 'ruby': 'head', 'rails': '6' }
+          - { 'ruby': 'head', 'rails': '7' }
     name: 'Ruby: ${{ matrix.ruby }}, Rails: ${{ matrix.rails }}'
     runs-on: ubuntu-latest
     env:

Appraisals

@@ -3,21 +3,28 @@
 appraise 'rails-4' do
   gem 'activerecord', '~> 4.2.0'
   gem 'mysql2', '~> 0.4.10'
-  gem 'sqlite3', '~> 1.3.13'
   gem 'pg', '~> 0.18.0'
+  gem 'sqlite3', '~> 1.3.13'
 end
 
 appraise 'rails-5' do
   gem 'activerecord', '~> 5.2.0'
+  gem 'sqlite3', '~> 1.3.13'
   gem 'psych', '~> 3.1'
 end
 
 appraise 'rails-6' do
   gem 'activerecord', '~> 6.1.0'
+  gem 'sqlite3',  '~> 1.4.4'
 end
 
 appraise 'rails-7' do
   gem 'activerecord', '~> 7.0.0'
+  gem 'sqlite3',  '~> 1.4.4'
+end
+
+appraise 'rails-8' do
+  gem 'activerecord', '~> 8.0.0'
 end
 
 appraise 'rails-head' do

README.md

@@ -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.

gemfiles/rails_5.gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 gem "activerecord", "~> 5.2.0"
 gem "mysql2"
 gem "pg"
-gem "sqlite3"
+gem "sqlite3", "~> 1.3.13"
 gem "psych", "~> 3.1"
 
 gemspec path: "../"

gemfiles/rails_6.gemfile

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 gem "activerecord", "~> 6.1.0"
 gem "mysql2"
 gem "pg"
-gem "sqlite3"
+gem "sqlite3", "~> 1.4.4"
 
 gemspec path: "../"

gemfiles/rails_7.gemfile

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 gem "activerecord", "~> 7.0.0"
 gem "mysql2"
 gem "pg"
-gem "sqlite3"
+gem "sqlite3", "~> 1.4.4"
 
 gemspec path: "../"

gemfiles/rails_8.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 8.0.0"
+gem "mysql2"
+gem "pg"
+gem "sqlite3"
+
+gemspec path: "../"

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

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

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