i18n-active_record 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41a58e172e0e92291488fed6cf32df0733b630a1
-  data.tar.gz: 2faedc974053410c6a6b3d1d047e844e505f2e7f
+  metadata.gz: 6e3b0e3d5e5bfff8a2405a2aea617cf46a3b3b84
+  data.tar.gz: 80efc0144976cfc26a73bf2c75a627a6ee7d8ddc
 SHA512:
-  metadata.gz: ffec88d68503d22c9ddf403f69240bdc57a30e7a27f21f7dcc37d3fafb9a302da95aa96ad30eec20c9e638bdb7708001afcf43eac5b55bd5adaad274b160b851
-  data.tar.gz: f1bb77a80450ae7252e539d7d1146eef06c92a30f5f072c5b59dc871a0d7e90aefdbd3a1b7a9710cd4b9cbb340afdb03596bdbd8396fc2a8c63c5c46c133a64b
+  metadata.gz: a36a02163e4c98ec21995a567ee48a5bc27c9701590ae317d9e1d5deeefc7481b8190c36fce62a1314f42bdd174bb2561ebe1d64e043f9db3cb859e015840715
+  data.tar.gz: af48a542fc5d59c5c11e6885f994f60a0729253c48cd10a6a08fa7961c3f3c26f1a41eb65a9d06f8f713eed1bcb5d3169ce867f9227ff1efe39a63a008552548

data/README.textile

@@ -1,15 +1,16 @@
 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',
-      :git => 'git://github.com/svenfuchs/i18n-active_record.git',
-      :require => 'i18n/active_record'
+  gem 'i18n-active_record', :require => 'i18n/active_record'
 </pre>
 
 Next create a active record model named @Translation@ with the Rails Generator.
@@ -51,14 +52,13 @@ A more advanced example (Thanks Moritz), which uses YAML files and ActiveRecord
 
 <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::ActiveRecord.send(:include, I18n::Backend::Flatten)
     I18n::Backend::Simple.send(:include, I18n::Backend::Memoize)
     I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
 
@@ -66,12 +66,23 @@ A more advanced example (Thanks Moritz), which uses YAML files and ActiveRecord
   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. Maintainers
+h2. Examples
 
-* Sven Fuchs
+* http://collectiveidea.com/blog/archives/2016/05/31/beyond-yml-files-dynamic-translations/
 
+h2. Maintainers
 
+* Sven Fuchs
+* Tim Maslyuchenko

data/Rakefile

@@ -7,27 +7,42 @@ def execute(command)
   system command
 end
 
+def bundle_options
+  opt = ''
+  opt +=  "--gemfile #{ENV['BUNDLE_GEMFILE']}" if ENV['BUNDLE_GEMFILE']
+end
+
+def each_database(&block)
+  ['sqlite', 'postgres', 'mysql'].each &block
+end
+
 namespace :bundle do
   task :env do
-    db = ENV['DB'].to_s
-    db = 'sqlite' if db == ''
     ar = ENV['AR'].to_s
 
-    next if db == 'sqlite' && ar.empty?
+    next if ar.empty?
 
-    gemfile = 'gemfiles/Gemfile'
-    gemfile += ".rails_#{ar}" unless ar.empty?
-    gemfile += ".#{db}" unless db.empty?
+    gemfile = "gemfiles/Gemfile.rails_#{ar}"
     raise "Cannot find gemfile at #{gemfile}" unless File.exist?(gemfile)
 
     ENV['BUNDLE_GEMFILE'] = gemfile
+    puts "Using gemfile: #{gemfile}"
   end
 
   task install: :env do
-    opt = ''
-    opt +=  "--gemfile #{ENV['BUNDLE_GEMFILE']}" if ENV['BUNDLE_GEMFILE']
-    execute "bundle install #{opt}"
+    execute "bundle install #{bundle_options}"
   end
+
+  task :install_all do
+    [nil, '3', '4', 'master'].each do |ar|
+      opt = ar && "AR=#{ar}"
+      execute "rake bundle:install #{opt}"
+    end
+  end
+end
+
+task :test do
+  each_database { |db| execute "rake #{db}:test" }
 end
 
 Rake::TestTask.new :_test do |t|
@@ -36,8 +51,11 @@ Rake::TestTask.new :_test do |t|
   t.verbose = false
 end
 
-task test: 'bundle:env' do
-  Rake::Task['_test'].execute
+each_database do |db|
+  namespace db do
+    task(:env) { ENV['DB'] = db }
+    task test: ['env', 'bundle:env', '_test']
+  end
 end
 
 task default: :test

data/lib/i18n/active_record/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module ActiveRecord
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/i18n/backend/active_record.rb

@@ -4,9 +4,20 @@ require 'i18n/backend/active_record/translation'
 module I18n
   module Backend
     class ActiveRecord
-      autoload :Missing,     'i18n/backend/active_record/missing'
-      autoload :StoreProcs,  'i18n/backend/active_record/store_procs'
-      autoload :Translation, 'i18n/backend/active_record/translation'
+      autoload :Missing,       'i18n/backend/active_record/missing'
+      autoload :StoreProcs,    'i18n/backend/active_record/store_procs'
+      autoload :Translation,   'i18n/backend/active_record/translation'
+      autoload :Configuration, 'i18n/backend/active_record/configuration'
+
+      class << self
+        def configure
+          yield(config) if block_given?
+        end
+
+        def config
+          @config ||= Configuration.new
+        end
+      end
 
       module Implementation
         include Base, Flatten
@@ -22,7 +33,14 @@ module I18n
         def store_translations(locale, data, options = {})
           escape = options.fetch(:escape, true)
           flatten_translations(locale, data, escape, false).each do |key, value|
-            Translation.locale(locale).lookup(expand_keys(key)).delete_all
+            translation = Translation.locale(locale).lookup(expand_keys(key))
+
+            if ActiveRecord.config.cleanup_with_destroy
+              translation.destroy_all
+            else
+              translation.delete_all
+            end
+
             Translation.create(:locale => locale.to_s, :key => key.to_s, :value => value)
           end
         end
@@ -59,4 +77,3 @@ module I18n
     end
   end
 end
-

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

@@ -0,0 +1,13 @@
+module I18n
+  module Backend
+    class ActiveRecord
+      class Configuration
+        attr_accessor :cleanup_with_destroy
+
+        def initialize
+          @cleanup_with_destroy = false
+        end
+      end
+    end
+  end
+end

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

@@ -49,6 +49,8 @@ module I18n
         TRUTHY_CHAR = "\001"
         FALSY_CHAR = "\002"
 
+        self.logger = nil
+
         self.table_name = 'translations'
 
         serialize :value

data/test/active_record_test.rb

@@ -8,6 +8,7 @@ class I18nBackendActiveRecordTest < I18n::TestCase
 
   def teardown
     I18n::Backend::ActiveRecord::Translation.destroy_all
+    I18n::Backend::ActiveRecord.instance_variable_set :@config, I18n::Backend::ActiveRecord::Configuration.new
     super
   end
 
@@ -48,4 +49,31 @@ class I18nBackendActiveRecordTest < I18n::TestCase
   test "expand_keys" do
     assert_equal %w(foo foo.bar foo.bar.baz), I18n.backend.send(:expand_keys, :'foo.bar.baz')
   end
+
+  test "available_locales returns uniq locales" do
+    I18n::Backend::ActiveRecord::Translation.delete_all
+    I18n.backend.store_translations(:en, :foo => { :bar => 'bar' })
+    I18n.backend.store_translations(:en, :foo => { :baz => 'baz' })
+    I18n.backend.store_translations(:de, :foo1 => 'foo')
+    I18n.backend.store_translations(:de, :foo2 => 'foo')
+    I18n.backend.store_translations(:uk, :foo3 => 'foo')
+
+    available_locales = I18n::Backend::ActiveRecord::Translation.available_locales
+    assert_equal 3, available_locales.size
+    assert_includes available_locales, :en
+    assert_includes available_locales, :de
+    assert_includes available_locales, :uk
+  end
+
+  test "the default configuration has cleanup_with_destroy == false" do
+    refute I18n::Backend::ActiveRecord.config.cleanup_with_destroy
+  end
+
+  test "the configuration supports cleanup_with_destroy being set" do
+    I18n::Backend::ActiveRecord.configure do |config|
+      config.cleanup_with_destroy = true
+    end
+
+    assert I18n::Backend::ActiveRecord.config.cleanup_with_destroy
+  end
 end

data/test/test_helper.rb

@@ -8,8 +8,6 @@ require 'test_declarative'
 require 'i18n/active_record'
 require 'i18n/tests'
 
-gemfile = ENV['BUNDLE_GEMFILE'] || 'Gemfile'
-
 begin
   require 'active_record'
   ::ActiveRecord::Base.connection
@@ -17,9 +15,11 @@ rescue LoadError => e
   puts "can't use ActiveRecord backend because: #{e.message}"
 rescue ::ActiveRecord::ConnectionNotEstablished
   require 'i18n/backend/active_record'
-  if gemfile.end_with? 'postgres'
-    ::ActiveRecord::Base.establish_connection adapter: 'postgresql', database: 'i18n_unittest', username: 'i18n', password: '', host: 'localhost'
-  elsif gemfile.end_with? 'mysql'
+  case ENV['DB']
+  when 'postgres'
+    ::ActiveRecord::Base.establish_connection adapter: 'postgresql', database: 'i18n_unittest', username: ENV['PG_USER'] || 'i18n', password: '', host: 'localhost'
+  when 'mysql'
+    ::ActiveRecord::Base.establish_connection adapter: 'mysql', database: 'i18n_unittest', username: 'root', password: '', host: 'localhost'
   else
     ::ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
   end
@@ -48,6 +48,15 @@ class TEST_CASE
 end
 
 class I18n::TestCase < TEST_CASE
+  def setup
+    I18n.enforce_available_locales = false
+    I18n.available_locales = []
+    I18n.locale = :en
+    I18n.default_locale = :en
+    I18n.load_path = []
+    super
+  end
+
   def teardown
     I18n.enforce_available_locales = false
     I18n.available_locales = []
@@ -55,15 +64,14 @@ class I18n::TestCase < TEST_CASE
     I18n.default_locale = :en
     I18n.load_path = []
     I18n.backend = nil
+    super
   end
 
   def translations
     I18n.backend.instance_variable_get(:@translations)
   end
 
-  def store_translations(*args)
-    data   = args.pop
-    locale = args.pop || :en
+  def store_translations(locale, data)
     I18n.backend.store_translations(locale, data)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-active_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -51,6 +51,7 @@ files:
 - lib/i18n/active_record.rb
 - lib/i18n/active_record/version.rb
 - lib/i18n/backend/active_record.rb
+- lib/i18n/backend/active_record/configuration.rb
 - lib/i18n/backend/active_record/missing.rb
 - lib/i18n/backend/active_record/store_procs.rb
 - lib/i18n/backend/active_record/translation.rb