i18n-active_record 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82f11d7fde969b3ef11eee86da2995a54d9f5c2c
-  data.tar.gz: fb23e1d54a386e6b856323cd1f222d9e0766b39d
+SHA256:
+  metadata.gz: d742b8d5877fc39c8855a29b4cd864732b750f3167567ced3dcd3bf2e9ad3d25
+  data.tar.gz: e6f0df2b6ff56a75568c44e11c7e19e6a5e161352308247e12afeb8ffd294522
 SHA512:
-  metadata.gz: b135f6d2c44c8e36c4856b60c287788d63b753dfe0991765062d4b416dfb587ef2b9e3e6ebae0b89fe9640017e4c57ecf78e6b566b4a871dbc5d14c1caea56fc
-  data.tar.gz: 49a3c2fc3b68f94298355a22ffe4547e3b8693ee2cf3f91faa2707e87bbfcc6e3ef259c25aab9363a8dfad0beec81627ebf06cfc543ea0f02fd7d78c63c33604
+  metadata.gz: 7fba006f4b5feb3d33cc9917a8c487d11b33e1bdfc64dff8e78e52f909393a0ee86b5a820b674f1b69ad28223459a336dba509fd1cf7f4a9eecbcf922ba4b86c
+  data.tar.gz: b8e8a9b39d0d531d0cea78034372f2ac46dedfe1a66269bd9aa72738dcc82544b307222aa603dd1037874a1609f9cb592f7349de4d879aca3c4a4f74f67736d4

data/README.md

@@ -0,0 +1,97 @@
+# I18n::Backend::ActiveRecord
+
+This repository contains the I18n ActiveRecord backend and support code that has been extracted from the "I18n": http://github.com/svenfuchs/i18n.
+It is fully compatible with Rails 3, 4, 5 and 6.
+
+## Installation
+
+For Bundler put the following in your Gemfile:
+
+```ruby
+gem 'i18n-active_record', require: 'i18n/active_record'
+```
+
+After updating your bundle, run the installer
+
+    $ rails g i18n:active_record:install
+
+It creates a migration:
+
+```ruby
+class CreateTranslations < ActiveRecord::Migration
+  def change
+    create_table :translations do |t|
+      t.string :locale
+      t.string :key
+      t.text :value
+      t.text :interpolations
+      t.boolean :is_proc, default: false
+
+      t.timestamps
+    end
+  end
+end
+```
+
+To specify table name use:
+
+    $ rails g i18n:active_record:install MyTranslation
+
+With the translation model you will be able to manage your translation, and add new translations or languages through
+it.
+
+By default the installer creates a new file in `config/initializers` named `i18n_active_record.rb` with the following content.
+
+```ruby
+require 'i18n/backend/active_record'
+
+Translation  = I18n::Backend::ActiveRecord::Translation
+
+if Translation.table_exists?
+  I18n.backend = I18n::Backend::ActiveRecord.new
+
+  I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Memoize)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
+
+  I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Simple.new, I18n.backend)
+end
+```
+
+To perform a simpler installation use:
+
+    $ rails g i18n:active_record:install --simple
+
+It generates:
+
+```ruby
+require 'i18n/backend/active_record'
+I18n.backend = I18n::Backend::ActiveRecord.new
+```
+
+You may also configure whether the ActiveRecord backend should use `destroy` or `delete` when cleaning up internally.
+
+```ruby
+I18n::Backend::ActiveRecord.configure do |config|
+  config.cleanup_with_destroy = true # defaults to false
+end
+```
+
+## Usage
+
+You can now use `I18n.t('Your String')` to lookup translations in the database.
+
+## Missing Translations -> Interpolations
+
+The `interpolations` field in the `translations` table is used by `I18n::Backend::ActiveRecord::Missing` to store the interpolations seen the first time this Translation was requested.  This will help translators understand what interpolations to expect, and thus to include when providing the translations.
+
+The `interpolations` field is otherwise unused since the "value" in `Translation#value` is actually used for interpolation during actual translations.
+
+## Examples
+
+* http://collectiveidea.com/blog/archives/2016/05/31/beyond-yml-files-dynamic-translations/
+
+## Maintainers
+
+* Sven Fuchs
+* Tim Masliuchenko

data/Rakefile

@@ -8,8 +8,9 @@ def execute(command)
 end
 
 def bundle_options
-  opt = ''
-  opt +=  "--gemfile #{ENV['BUNDLE_GEMFILE']}" if ENV['BUNDLE_GEMFILE']
+  return '' unless ENV['BUNDLE_GEMFILE']
+
+  "--gemfile #{ENV['BUNDLE_GEMFILE']}"
 end
 
 def each_database(&block)
@@ -33,8 +34,12 @@ namespace :bundle do
     execute "bundle install #{bundle_options}"
   end
 
+  task update: :env do
+    execute "bundle update #{bundle_options}"
+  end
+
   task :install_all do
-    [nil, '3', '4', '5', 'master'].each do |ar|
+    [nil, '3', '4', '5', '6', 'head'].each do |ar|
       opt = ar && "AR=#{ar}"
       execute "rake bundle:install #{opt}"
     end

data/lib/generators/i18n/active_record/install_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/active_record'
+
+module I18n
+  module ActiveRecord
+    module Generators
+      class  InstallGenerator < ::ActiveRecord::Generators::Base
+        desc "Installs i18n-active_record and generates the necessary migrations"
+
+        argument :name, type: :string, default: 'Translation'
+
+        class_option :simple, type: :boolean, default: false, desc: 'Perform the simple setup'
+
+        source_root File.expand_path('templates', __dir__)
+
+        def copy_initializer
+          tpl = "#{options[:simple] ? 'simple' : 'advanced'}_initializer.rb.erb"
+
+          template tpl, 'config/initializers/i18n_active_record.rb'
+        end
+
+        def create_migrations
+          migration_template 'migration.rb.erb', "db/migrate/create_#{table_name}.rb"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'i18n/backend/active_record'
+
+Translation = I18n::Backend::ActiveRecord::Translation
+
+if Translation.table_exists?
+  I18n.backend = I18n::Backend::ActiveRecord.new
+
+  I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Memoize)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
+
+  I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Simple.new, I18n.backend)
+end
+
+I18n::Backend::ActiveRecord.configure do |config|
+  # config.cleanup_with_destroy = true # defaults to false
+end

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

@@ -0,0 +1,13 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :<%= table_name %> do |t|
+      t.string :locale
+      t.string :key
+      t.text :value
+      t.text :interpolations
+      t.boolean :is_proc, default: false
+
+      t.timestamps
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+require 'i18n/backend/active_record'
+I18n.backend = I18n::Backend::ActiveRecord.new
+
+I18n::Backend::ActiveRecord.configure do |config|
+  # config.cleanup_with_destroy = true # defaults to false
+end

data/lib/i18n/active_record/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module ActiveRecord
-    VERSION = '0.2.1'
+    VERSION = '0.4.1'
   end
 end

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

@@ -75,6 +75,18 @@ module I18n
           def available_locales
             Translation.select('DISTINCT locale').to_a.map { |t| t.locale.to_sym }
           end
+
+          def to_hash
+            Translation.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)|
+                key = key_part.to_sym
+                iterator[key] = keys[index + 1] ? (iterator[key] || {}) : t.value
+                iterator[key]
+              end
+            end
+          end
         end
 
         def interpolates?(key)

data/lib/i18n/backend/active_record.rb

@@ -45,11 +45,36 @@ module I18n
           end
         end
 
+        def reload!
+          @translations = nil
+          self
+        end
+
+        def initialized?
+          !@translations.nil?
+        end
+
+        def init_translations
+          @translations = Translation.to_hash
+        end
+
+        def translations(do_init: false)
+          init_translations if do_init || !initialized?
+          @translations ||= {}
+        end
+
       protected
 
         def lookup(locale, key, scope = [], options = {})
           key = normalize_flat_keys(locale, key, scope, options[:separator])
-          result = if key == '.'
+          if key.first == '.'
+            key = key[1..-1]
+          end
+          if key.last == '.'
+            key = key[0..-2]
+          end
+
+          result = if key == ''
             Translation.locale(locale).all
           else
             Translation.locale(locale).lookup(key)
@@ -69,7 +94,7 @@ module I18n
 
         def build_translation_hash_by_key(lookup_key, translation)
           hash = {}
-          if lookup_key == '.'
+          if lookup_key == ''
             chop_range = 0..-1
           else
             chop_range = (lookup_key.size + FLATTEN_SEPARATOR.size)..-1

data/test/active_record_test.rb

@@ -94,10 +94,43 @@ class I18nBackendActiveRecordTest < I18n::TestCase
     assert_equal expected_hash, I18n.t('.')
   end
 
+  test "accessing keys with a trailing/leading period" do
+    expected_hash = { :bar => 'bar', :baz => 'baz' }
+    assert_equal expected_hash, I18n.t('foo')
+    assert_equal expected_hash, I18n.t('.foo')
+    assert_equal expected_hash, I18n.t('foo.')
+    assert_equal expected_hash, I18n.t('.foo.')
+    assert_equal expected_hash, I18n.t('.foo.')
+  end
+
   test "returning all keys via . when there are no keys" do
     I18n.t('.') # Fixes test flakiness by loading available locales
     I18n::Backend::ActiveRecord::Translation.destroy_all
 
     assert_equal "translation missing: en.no key", I18n.t('.')
   end
+
+  test "intially unitinitialized" do
+    refute I18n.backend.initialized?
+    I18n.backend.init_translations
+    assert I18n.backend.initialized?
+    I18n.backend.reload!
+    refute I18n.backend.initialized?
+    I18n.backend.init_translations
+    assert I18n.backend.initialized?
+  end
+
+  test "translations returns all translations" do
+    expected_hash = { :en => { :foo => { :bar => 'bar', :baz => 'baz' } } }
+    I18n.backend.init_translations
+    assert_equal expected_hash, I18n.backend.send(:translations)
+    assert I18n.backend.initialized?
+  end
+
+  test "translations initialized with do_init argument" do
+    expected_hash = { :en => { :foo => { :bar => 'bar', :baz => 'baz' } } }
+    refute I18n.backend.initialized?
+    assert_equal expected_hash, I18n.backend.send(:translations, { do_init: true })
+    assert I18n.backend.initialized?
+  end
 end

data/test/missing_test.rb

@@ -51,7 +51,7 @@ class I18nActiveRecordMissingTest < I18n::TestCase
 
   test "creates a stub when a custom separator is used" do
     I18n.t('foo|baz', :separator => '|')
-    I18n::Backend::ActiveRecord::Translation.locale(:en).lookup("foo.baz").first.update_attributes(:value => 'baz!')
+    I18n::Backend::ActiveRecord::Translation.locale(:en).lookup("foo.baz").first.update(:value => 'baz!')
     assert_equal 'baz!', I18n.t('foo|baz', :separator => '|')
   end
 
@@ -64,7 +64,7 @@ class I18nActiveRecordMissingTest < I18n::TestCase
   test "creates a stub when a custom separator is used and the key contains the flatten separator (a dot character)" do
     key = 'foo|baz.zab'
     I18n.t(key, :separator => '|')
-    I18n::Backend::ActiveRecord::Translation.locale(:en).lookup("foo.baz\001zab").first.update_attributes(:value => 'baz!')
+    I18n::Backend::ActiveRecord::Translation.locale(:en).lookup("foo.baz\001zab").first.update(:value => 'baz!')
     assert_equal 'baz!', I18n.t(key, :separator => '|')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-active_record
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Sven Fuchs
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -46,8 +46,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.textile
+- README.md
 - Rakefile
+- lib/generators/i18n/active_record/install_generator.rb
+- lib/generators/i18n/active_record/templates/advanced_initializer.rb.erb
+- lib/generators/i18n/active_record/templates/migration.rb.erb
+- lib/generators/i18n/active_record/templates/simple_initializer.rb.erb
 - lib/i18n/active_record.rb
 - lib/i18n/active_record/version.rb
 - lib/i18n/backend/active_record.rb
@@ -63,7 +67,7 @@ homepage: http://github.com/svenfuchs/i18n-active_record
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,9 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: "[none]"
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: I18n ActiveRecord backend
 test_files: []

data/README.textile

@@ -1,94 +0,0 @@
-h1. I18n::Backend::ActiveRecord
-
-!https://travis-ci.org/svenfuchs/i18n-active_record.svg?branch=master!:https://travis-ci.org/svenfuchs/i18n-active_record
-
-This repository contains the I18n ActiveRecord backend and support code that has been extracted from the "I18n":http://github.com/svenfuchs/i18n.
-It is fully compatible with Rails 3, 4 and 5
-
-h2. Installation
-
-For Bundler put the following in your Gemfile:
-
-<pre>
-  gem 'i18n-active_record', :require => 'i18n/active_record'
-</pre>
-
-Next create a active record model named @Translation@ with the Rails Generator.
-Your migration should look like this:
-
-<pre>
-  class CreateTranslations < ActiveRecord::Migration
-    def self.up
-      create_table :translations do |t|
-        t.string :locale
-        t.string :key
-        t.text   :value
-        t.text   :interpolations
-        t.boolean :is_proc, :default => false
-
-        t.timestamps
-      end
-    end
-
-    def self.down
-      drop_table :translations
-    end
-  end
-</pre>
-
-With this translation model you will be able to manage your translation, and add new translations or languages through
-it.
-
-To load @I18n::Backend::ActiveRecord@ into your Rails application, create a new file in *config/initializers* named *locale.rb*.
-
-A simple configuration for your locale.rb could look like this:
-
-<pre>
-  require 'i18n/backend/active_record'
-  I18n.backend = I18n::Backend::ActiveRecord.new
-</pre>
-
-A more advanced example (Thanks Moritz), which uses YAML files and ActiveRecord for lookups:
-
-<pre>
-  require 'i18n/backend/active_record'
-
-  Translation  = I18n::Backend::ActiveRecord::Translation
-
-  if Translation.table_exists?
-    I18n.backend = I18n::Backend::ActiveRecord.new
-
-    I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
-    I18n::Backend::Simple.send(:include, I18n::Backend::Memoize)
-    I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
-
-    I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Simple.new, I18n.backend)
-  end
-</pre>
-
-You may also configure whether the ActiveRecord backend should use @destroy@ or @delete@ when cleaning up internally.
-
-<pre>
-I18n::Backend::ActiveRecord.configure do |config|
-  config.cleanup_with_destroy = true # defaults to false
-end
-</pre>
-
-h2. Usage
-
-You can now use @I18n.t('Your String')@ to lookup translations in the database.
-
-h2. Missing Translations -> Interpolations
-
-The interpolations field in the Translations table is used by I18n::Backend::ActiveRecord::Missing to store the interpolations seen the first time this Translation was requested.  This will help translators understand what interpolations to expect, and thus to include when providing the translations.
-
-The interpolations field is otherwise unused since the "value" in Translation.value is actually used for interpolation during actual translations.
-
-h2. Examples
-
-* http://collectiveidea.com/blog/archives/2016/05/31/beyond-yml-files-dynamic-translations/
-
-h2. Maintainers
-
-* Sven Fuchs
-* Tim Maslyuchenko