i18n_generators 1.1.0 → 1.2.0

data/History.txt

@@ -1,3 +1,9 @@
+== 1.2.0
+
+* enhancements:
+  * Drop Rails 2 support
+  * Put alias to model name for non-collection reflection names (see: https://twitter.com/#!/znz/status/179109337581625344) (thanks to znz-san!)
+
 == 1.1.0
 
 * enhancements:

data/README.rdoc

@@ -1,6 +1,6 @@
 = I18n generators
 
-This gem plugin generates a set of locale files for Rails i18n feature. Supports Rails 3.1, 3.0.x, 2.3.x and 2.2.x.
+This gem plugin generates a set of locale files for Rails i18n feature. Supports Rails 4.0, 3.2.x, 3.1.x, 3.0.x, 2.3.x and 2.2.x.
 
 * http://github.com/amatsuda/i18n_generators
 * http://rubygems.org/gems/i18n_generators
@@ -44,23 +44,20 @@ Executes 1 and 2 at once.
 
 == REQUIREMENTS:
 
-* Ruby (>= 1.8.7)
-* Ruby on Rails (3.1 or 3.0 or 2.3 or 2.2)
+* Ruby 1.8.7, 1.9, 2.0
+* Ruby on Rails 4.0, 3.2, 3.1, 3.0
+* Ruby on Rails 2.3, 2.2 (supported by i18n_generators < 1.2)
 
 
 == INSTALL:
 
-* As a gem
-
-% gem install i18n_generators
-
-* With Bundler
+* Rails 3 (with Bundler)
 
 Add 'i18n_generators' to your Gemfile, then `bundle`. Restricting the group to :development would be a good idea, since the generator would probably be used only in development mode.
 
-* As a Rails plugin
+* Rails 2
 
-% rails plugin install git://github.com/amatsuda/i18n_generators.git
+Use 'i18n_generators' version '< 1.2'.
 
 
-Copyright (c) 2008 - 2011 Akira Matsuda, released under the MIT license
+Copyright (c) 2008 Akira Matsuda, released under the MIT license

data/Rakefile

@@ -1,2 +1,10 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/i18n_generators.gemspec

@@ -23,4 +23,8 @@ Gem::Specification.new do |s|
   s.licenses = ['MIT']
 
   s.add_runtime_dependency 'mechanize'
+  s.add_runtime_dependency 'rails', '>= 3.0.0'
+  s.add_development_dependency 'rails'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
 end

data/lib/generators/i18n/i18n_generator.rb

@@ -1,5 +1,5 @@
-require File.join(File.dirname(__FILE__), '../i18n_translation/i18n_translation_generator')
-require File.join(File.dirname(__FILE__), '../i18n_locale/i18n_locale_generator')
+require 'generators/i18n_translation/i18n_translation_generator'
+require 'generators/i18n_locale/i18n_locale_generator'
 
 class I18nGenerator < Rails::Generators::NamedBase
   def initialize(args, *options)

data/lib/generators/i18n_translation/i18n_translation_generator.rb

@@ -1,5 +1,5 @@
-require File.join(File.dirname(__FILE__), 'lib/yaml')
-require File.join(File.dirname(__FILE__), 'lib/translator')
+require 'generators/i18n_translation/lib/yaml'
+require 'generators/i18n_translation/lib/translator'
 
 class I18nTranslationGenerator < Rails::Generators::NamedBase
   # option: include_timestamps
@@ -12,12 +12,20 @@ class I18nTranslationGenerator < Rails::Generators::NamedBase
     I18n.locale = locale_name
     Rails.application.eager_load!
 
-    keys = aggregate_keys
-    translations = translate_all(keys)
+    # activerecord:models comes first
+    model_names_translations = order_hash translate_all(model_names_keys)
+    # activerecord:models:attributes comes next
+    attribute_names_translations = ActiveSupport::OrderedHash.new
+    attribute_names_translations.merge! translate_all(content_column_names_keys)
+    attribute_names_translations.merge! translate_all(collection_reflection_names_keys)
+    # refer to already translated model names
+    attribute_names_translations.merge! singular_reflection_names_references
+    # merge them all
+    translations = model_names_translations.deep_merge order_hash(attribute_names_translations)
 
     yaml = I27r::YamlDocument.load_yml_file "config/locales/translation_#{locale_name}.yml"
     each_value [], translations do |parents, value|
-      if value.is_a? String
+      if value.is_a?(String) || value.is_a?(Symbol)
         yaml[[locale_name.to_s] + parents] = value
       else
         value.each do |key, val|
@@ -32,8 +40,8 @@ class I18nTranslationGenerator < Rails::Generators::NamedBase
   end
 
   private
-  def aggregate_keys
-    models = ActiveRecord::Base.descendants.map do |m|
+  def models
+    @models ||= ActiveRecord::Base.descendants.map do |m|
       begin
         m if m.table_exists? && m.respond_to?(:content_columns)
       rescue => e
@@ -41,48 +49,54 @@ class I18nTranslationGenerator < Rails::Generators::NamedBase
         next
       end
     end.compact
+  end
+
+  def model_names_keys
+    models.map {|m| "activerecord.models.#{m.model_name.underscore}"}
+  end
 
-    translation_keys = []
-    translation_keys += models.map {|m| "activerecord.models.#{m.model_name.underscore}"}
-    models.each do |model|
-      cols = model.content_columns + model.reflect_on_all_associations
-      cols.delete_if {|c| %w[created_at updated_at].include? c.name} unless include_timestamps?
-      translation_keys += cols.map {|c| "activerecord.attributes.#{model.model_name.underscore}.#{c.name}"}
+  def content_column_names_keys
+    models.map {|m|
+      cols = m.content_columns.map {|c| c.name}
+      cols.delete_if {|c| %w[created_at updated_at].include? c} unless include_timestamps?
+      cols.map {|c| "activerecord.attributes.#{m.model_name.underscore}.#{c}"}
+    }.flatten
+  end
+
+  def singular_reflection_names_references
+    ret = {}
+    models.each do |m|
+      m.reflect_on_all_associations.select {|c| !c.collection?}.each do |c|
+        ret["activerecord.attributes.#{m.model_name.underscore}.#{c.name}"] = "activerecord.models.#{c.name}".to_sym
+      end
     end
-    translation_keys
+    ret
+  end
+
+  def collection_reflection_names_keys
+    models.map {|m|
+      m.reflect_on_all_associations.select {|c| c.collection?}.map {|c| "activerecord.attributes.#{m.model_name.underscore}.#{c.name}"}
+    }.flatten
+  end
+
+  def translator
+    @translator ||= I27r::Translator.new locale_name.sub(/\-.*/, '')
   end
 
   # receives an array of keys and returns :key => :translation hash
   def translate_all(keys)
-    translator = I27r::Translator.new locale_name.sub(/\-.*/, '')
-
-    ActiveSupport::OrderedHash.new.tap do |oh|
-      # fix the order first(for multi thread translating)
-      keys.each do |key|
-        if key.to_s.include? '.'
-          key_prefix, key_suffix = key.to_s.split('.')[0...-1], key.to_s.split('.')[-1]
-          key_prefix.inject(oh) {|h, k| h[k] ||= ActiveSupport::OrderedHash.new}[key_suffix] = nil
-        else
-          oh[key] = nil
-        end
-      end
-      threads = []
-      keys.each do |key|
-        threads << Thread.new do
-          Rails.logger.debug "translating #{key} ..."
-          Thread.pass
-          if key.to_s.include? '.'
-            key_prefix, key_suffix = key.to_s.split('.')[0...-1], key.to_s.split('.')[-1]
-            existing_translation = I18n.backend.send(:lookup, locale_name, key_suffix, key_prefix)
-            key_prefix.inject(oh) {|h, k| h[k]}[key_suffix] = existing_translation ? existing_translation : translator.translate(key_suffix)
-          else
-            existing_translation = I18n.backend.send(:lookup, locale_name, key)
-            oh[key] = existing_translation ? existing_translation : translator.translate(key)
-          end
-        end
+    ret, threads = {}, []
+    keys.each do |key|
+      threads << Thread.new do
+        Rails.logger.debug "translating #{key} ..."
+        Thread.pass
+        key_prefix, key_suffix = key.to_s.split('.')[0...-1], key.to_s.split('.')[-1]
+        existing_translation = I18n.backend.send(:lookup, locale_name, key_suffix, key_prefix)
+        ret[key] = existing_translation ? existing_translation : translator.translate(key_suffix)
       end
-      threads.each {|t| t.join}
     end
+    threads.each {|t| t.join}
+    ret
   end
 
   def locale_name
@@ -93,6 +107,20 @@ class I18nTranslationGenerator < Rails::Generators::NamedBase
     !!@include_timestamps
   end
 
+  # transform a Hash into a nested OrderedHash
+  def order_hash(hash)
+    ActiveSupport::OrderedHash.new.tap do |oh|
+      hash.sort_by {|k, _v| k}.each do |key, value|
+        if key.to_s.include? '.'
+          key_prefix, key_suffix = key.to_s.split('.')[0...-1], key.to_s.split('.')[-1]
+          key_prefix.inject(oh) {|h, k| h[k] ||= ActiveSupport::OrderedHash.new}[key_suffix] = value
+        else
+          oh[key] = value
+        end
+      end
+    end
+  end
+
   # iterate through all values
   def each_value(parents, src, &block)
     src.each do |k, v|

data/lib/generators/i18n_translation/lib/yaml.rb

@@ -1,7 +1,7 @@
 begin
   require 'psych'
 rescue LoadError
-  require File.join(File.dirname(__FILE__), 'yaml_waml')
+  require 'generators/i18n_translation/lib/yaml_waml'
 end
 
 module I27r
@@ -10,7 +10,7 @@ module I27r
     delegate :scan, :to => :@text
 
     def initialize(text, options = {})
-      @generated = !!options[:generated] || text.ends_with?('  #g')
+      @generated = !!options[:generated] || text.end_with?('  #g')
       @yaml = YAML.load text.to_s + ' '
       @text = text
     end
@@ -43,7 +43,7 @@ module I27r
     end
 
     def to_s
-      "#{@text}#{'  #g' if generated? && yaml? && !value.nil? && !@text.ends_with?('  #g')}"
+      "#{@text}#{'  #g' if generated? && yaml? && !value.nil? && !@text.end_with?('  #g')}"
     end
 
     private
@@ -127,7 +127,7 @@ module I27r
       previous_indent = ''
       ''.tap do |ret|
         @lines.each do |line|
-          ret << "\n" if add_blank_line && (line.indent < previous_indent) && !line.to_s.blank? && !ret.ends_with?("\n\n")
+          ret << "\n" if add_blank_line && (line.indent < previous_indent) && !line.to_s.blank? && !ret.end_with?("\n\n")
           previous_indent = line.indent
           ret << line.to_s << "\n"
         end

data/lib/i18n_generators/version.rb

@@ -1,3 +1,3 @@
 module I18nGenerators
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/i18n_locale_command_spec.rb

@@ -1,25 +1,26 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
-require File.join(File.dirname(__FILE__), '/../generators/i18n_locale/i18n_locale_command')
+require 'spec_helper'
+require 'generators/i18n_locale/i18n_locale_generator'
 
-describe I18nGenerator::Generator::Commands::Create do
-  before do
-    (@command = Object.new).extend I18nGenerator::Generator::Commands::Create 
-    @command.stub!(:locale_name).and_return('ja')
-  end
+describe I18nLocaleGenerator do
+  subject { I18nLocaleGenerator.new(['ja']) }
 
   describe 'add_locale_config' do
     describe 'when i18n.default_locale is configured in environment.rb' do
       before do
         @config = "
-Rails::Initializer.run do |config|
-  config.i18n.default_locale = :de
+module Tes
+  class Application < Rails::Application
+    config.i18n.default_locale = :de
+  end
 end"
       end
 
       it 'rewrites the existing default_locale to locale_name value' do
-        @command.send(:add_locale_config, @config).should == "
-Rails::Initializer.run do |config|
-  config.i18n.default_locale = 'ja'
+        subject.send(:add_locale_config, @config).should == "
+module Tes
+  class Application < Rails::Application
+    config.i18n.default_locale = 'ja'
+  end
 end"
       end
     end
@@ -27,15 +28,19 @@ end"
     describe 'when i18n.default_locale config is commented in environment.rb' do
       before do
         @config = "
-Rails::Initializer.run do |config|
-  # config.i18n.default_locale = :de
+module Tes
+  class Application < Rails::Application
+    # config.i18n.default_locale = :de
+  end
 end"
       end
 
       it 'uncomments the existing commented i18n config and sets locale_name value' do
-        @command.send(:add_locale_config, @config).should == "
-Rails::Initializer.run do |config|
-  config.i18n.default_locale = 'ja'
+        subject.send(:add_locale_config, @config).should == "
+module Tes
+  class Application < Rails::Application
+    config.i18n.default_locale = 'ja'
+  end
 end"
       end
     end
@@ -43,21 +48,24 @@ end"
     describe 'when i18n.default_locale is not written in environment.rb' do
       before do
         @config = "
-Rails::Initializer.run do |config|
-  something goes here.
-  bla bla bla...
+module Tes
+  class Application < Rails::Application
+    something goes here.
+    bla bla bla...
+  end
 end"
       end
 
       it 'adds the default_locale config inside the config block and sets locale_name value' do
-        @command.send(:add_locale_config, @config).should == "
-Rails::Initializer.run do |config|
-  config.i18n.default_locale = 'ja'
-  something goes here.
-  bla bla bla...
+        subject.send(:add_locale_config, @config).should == "
+module Tes
+  class Application < Rails::Application
+    config.i18n.default_locale = 'ja'
+    something goes here.
+    bla bla bla...
+  end
 end"
       end
     end
   end
 end
-

data/spec/i18n_translation_command_spec.rb

@@ -1,24 +1,20 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
-require File.join(File.dirname(__FILE__), '/../generators/i18n_translation/i18n_translation_command')
+require 'spec_helper'
+require 'generators/i18n_translation/i18n_translation_generator'
 
-describe I18nGenerator::Generator::Commands::Create do
-  before do
-    (@command = Object.new).extend I18nGenerator::Generator::Commands::Create
-    @command.stub!(:locale_name).and_return('ja')
-  end
+describe I18nTranslationGenerator do
+  subject { I18nTranslationGenerator.new(['ja']) }
 
   describe 'each_value' do
-    it 'iterates through each value' do
+    xit 'iterates through each value' do
       hash = ActiveSupport::OrderedHash.new
       hash[:parent1] = ActiveSupport::OrderedHash.new
       hash[:parent1][:child1] = 'child one'
       hash[:parent2] = ActiveSupport::OrderedHash.new
       hash[:parent2][:child2] = 'child two'
       hash[:parent2][:child3] = 'child three'
-      @command.__send__(:each_value, [], hash) do |parents, value|
+      subject.send(:each_value, [], hash) do |parents, value|
         p "#{parents.join('.')} #{value}"
       end
     end
   end
 end
-

data/spec/spec_helper.rb

@@ -1,9 +1,14 @@
-require 'active_support/all'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rails'
+require 'rails/generators'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+Rails.logger ||= Logger.new STDOUT
+
 RSpec.configure do |config|
   # config.mock_with :rr
   config.mock_with :rspec

data/spec/translator_spec.rb

@@ -1,46 +1,39 @@
+# coding: utf-8
 $KCODE = 'U'
 
-require File.join(File.dirname(__FILE__), 'spec_helper')
-require File.join(File.dirname(__FILE__), '../generators/i18n_translation/lib/translator')
-include I18nTranslationGeneratorModule
+require 'spec_helper'
+require 'generators/i18n_translation/lib/translator'
 
-describe Translator do
-  before(:each) do
-    @translator = Translator.new 'ja'
-  end
+describe I27r::Translator do
+  subject { I27r::Translator.new 'ja' }
 
   describe 'when successfully translated' do
     before do
-      res_200 = mock('res_200')
-      res_200.stub!(:read).and_return('{"responseData": {"translatedText":"こんにちは"}, "responseDetails": null, "responseStatus": 200}')
-      OpenURI.stub!(:open_uri).and_return(res_200)
+      subject.stub!(:_translate).and_return('こんにちは')
     end
 
     it 'returns translated text' do
-      @translator.translate('hello').should == 'こんにちは'
+      subject.translate('hello').should == 'こんにちは'
     end
   end
 
   describe 'when translation failed with error code' do
     before do
-      res_500 = mock('res_500')
-      res_500.stub!(:read).and_return('{"responseData": {"translatedText":"こんにちは？"}, "responseDetails": null, "responseStatus": 500}')
-      OpenURI.stub!(:open_uri).and_return(res_500)
+      subject.stub!(:_translate).and_return('')
     end
 
     it 'returns the original text' do
-      @translator.translate('hello').should == 'hello'
+      subject.translate('hello').should == 'hello'
     end
   end
 
   describe 'when translation raised an error' do
     before do
-      OpenURI.stub!(:open_uri).and_raise('ERROR!')
+      subject.stub!(:_translate).and_raise('ERROR!')
     end
 
     it 'returns the original text' do
-      @translator.translate('hello').should == 'hello'
+      subject.translate('hello').should == 'hello'
     end
   end
 end
-