amatsuda-i18n_generators 0.2.0 → 0.3.0

data/README.rdoc

@@ -7,39 +7,65 @@ This gem plugin generates a set of locale files for Rails 2.2 i18n feature.
 
 == FEATURES
 
-This gem/plugin provides following three script/generate commands.
+This gem/plugin provides following four script/generate commands.
 
-=== 1. Generate Locale Files for ActiveRecord/ActiveSupport/ActionPack
+=== 1. Generate I18n Scaffold
 
-% ./script/generate i18n_locales ja (de-AT, pt-BR, etc.)
+% ./script/generate i18n_scaffold ja (de-AT, pt-BR, etc.)
 
-This will generate following locale files.
+Generates I18n aware scaffold.
 
-    config/initializers/i18n_config.rb
-    config/locales/action_view_ja.yml
-    config/locales/active_record_ja.yml
-    config/locales/active_support_ja.yml
+=== 2. Generate Locale Files for ActiveRecord/ActiveSupport/ActionPack
 
-Basically, all the generated .yml files in config/locale directory are copied from en-US.yml files bundled inside Rails framework, and each attribute value is one-to-one localized/translated into the specified locale/language.
-Also, the generated config file adds the generated .yml files to the I18n load_path, and sets the application default locale to the specified locale.
+% ./script/generate i18n_locale ja (de-AT, pt-BR, etc.)
 
-=== 2. Generate Models/Attributes Translation Yaml File For All Models
+or
 
-% ./script/generate i18n_models ja (de-AT, pt-BR, etc.)
+% ./script/generate i18n --locale ja (de-AT, pt-BR, etc.)
+
+* A. If The Locale File Exists In Rails-I18n Repository
+
+Firstly, the generator checks here.
+http://github.com/svenfuchs/rails-i18n/tree/master/rails/locale
+If the spacified .yml file exists in the repository, the generator downloads and puts the file into your config/locales directory.
+Then the generater sets the application default locale to the specified locale.
+
+This will generate following locale file.
+
+    config/locales/ja.yml
+
+* B. Else
+
+The generator copies the en.yml file (bundled inside Rails framework) into config/locales directory, and one-to-one localizes/translates each attribute value into the specified locale/language.
+Then the generater sets the application default locale to the specified locale.
+
+This will generate following locale file.
+
+    config/locales/ja.yml
+
+=== 3. Generate Translation YAML File For All Models/Attributes and views/**/*.erb
+
+% ./script/generate i18n_translation ja (de-AT, pt-BR, etc.)
+
+or
+
+% ./script/generate i18n --translation ja (de-AT, pt-BR, etc.)
 
 This will generate following YAML file.
 
-    config/locales/models_ja.yml
+    config/locales/translation_ja.yml
 
-This file contains definitions of all the AR model names and attributes in your app/models directory, so that you don't have to write the YAML skeleton manually or by copy/paste.
+The generator scans your app/models directory, and generates a YAML file with all the AR model names and attributes so that you don't have to write the YAML skeleton manually or by copy/paste.
+In addition, the generator scans all the *.erb files in your app/views/** directory, and picks all the keys for I18n.translate, then adds them to the YAML file.
 In addition, the generator tries to translate each of them into the specified language.
 The generator doesn't overwrite the existing value so that you can rerun the generator again and again just like Annotate Model plugin.
 
-=== 3. Generate All
+=== 4. Generate All
 
 % ./script/generate i18n ja (de-AT, pt-BR, etc.)
 
-Generates all the i18n_locales and i18n_models files at once.
+Executes 2 and 3 at once.
+
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -5,18 +5,19 @@ require 'rake/rdoctask'
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test the i18n_generator plugin.'
+desc 'Test the i18n_generators plugin.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
-desc 'Generate documentation for the i18n_generator plugin.'
+desc 'Generate documentation for the i18n_generators plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'I18nGenerator'
+  rdoc.title    = 'I18nGenerators'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('generators/**/*.rb')
 end
+

data/generators/i18n/i18n_generator.rb

@@ -4,9 +4,15 @@ require 'rails_generator/commands'
 require 'gettext'
 
 class I18nGenerator < Rails::Generator::NamedBase
-  attr_reader :locale_name, :cldr, :translator, :generate_models_only, :generate_locales_only
+  attr_reader :locale_name, :cldr, :translator, :generate_translation_only, :generate_locale_only
 
   def initialize(runtime_args, runtime_options = {})
+    if options[:scaffold]
+      #TODO invoke scaffold generator
+      puts 'please use generate i18n_scaffold command'
+      exit
+    end
+
     super
     unless name =~ /^[a-zA-Z]{2}([-_][a-zA-Z]{2})?$/
       puts 'ERROR: Wrong locale format. Please input in ?? or ??-?? format.'
@@ -16,10 +22,10 @@ class I18nGenerator < Rails::Generator::NamedBase
     GetText.bindtextdomain 'rails'
     GetText.locale = @locale_name
 
-    unless self.generate_models_only
+    unless options[:generate_translation_only]
       @cldr = CldrDocument.new @locale_name
     end
-    unless self.generate_locales_only
+    unless options[:generate_locale_only]
       lang = @locale_name.sub(/-.*$/, '')
       @translator = Translator.new lang
     end
@@ -28,7 +34,7 @@ class I18nGenerator < Rails::Generator::NamedBase
   def manifest
     record do |m|
       m.directory 'config/locales'
-      unless self.generate_models_only
+      unless options[:generate_translation_only]
         m.generate_configuration
         if defined_in_rails_i18n_repository?
           m.fetch_from_rails_i18n_repository
@@ -38,12 +44,22 @@ class I18nGenerator < Rails::Generator::NamedBase
           m.action_view_yaml
         end
       end
-      unless self.generate_locales_only
-        m.models_yaml
+      unless options[:generate_locale_only]
+        m.translation_yaml
       end
     end
   end
 
+  protected
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on('--translation',
+           'Generate translations for all models with their attributes and all translation keys in the view files.') {|v| options[:generate_translation_only] = v}
+    opt.on('--locale',
+           'Generate locale files.') {|v| options[:generate_locale_only] = v}
+  end
+
   private
   def defined_in_rails_i18n_repository?
     begin
@@ -54,7 +70,7 @@ class I18nGenerator < Rails::Generator::NamedBase
   end
 end
 
-require File.join(File.dirname(__FILE__), '../i18n_locales/i18n_locales_command')
-require File.join(File.dirname(__FILE__), '../i18n_models/i18n_models_command')
+require File.join(File.dirname(__FILE__), '../i18n_locale/i18n_locale_command')
+require File.join(File.dirname(__FILE__), '../i18n_translation/i18n_translation_command')
 Rails::Generator::Commands::Create.send :include, I18nGenerator::Generator::Commands::Create
 

data/generators/i18n/templates/{models.yml → translation.yml}

@@ -13,4 +13,7 @@
 <%     end -%>
 <%   end -%>
 <% end -%>
+<% translations.each do |key, value| -%>
+  <%= "#{key}: #{value}" %>
+<% end -%>
 

data/generators/{i18n_locales/i18n_locales_command.rb → i18n_locale/i18n_locale_command.rb}

@@ -4,7 +4,7 @@ require 'rails_generator/commands'
 require 'gettext'
 require File.join(File.dirname(__FILE__), 'lib/yaml')
 require File.join(File.dirname(__FILE__), 'lib/cldr')
-include I18nLocalesGeneratorModule
+include I18nLocaleGeneratorModule
 
 module I18nGenerator::Generator
   module Commands #:nodoc:
@@ -104,7 +104,7 @@ module I18nGenerator::Generator
         original_yml = I18n.load_path.detect {|lp| lp =~ /\/lib\/#{filename_base}\/locale\/(en|en-US)\.yml$/}
         doc = YamlDocument.new(original_yml, locale_name)
         yield doc
-        file('i18n:base.yml', "config/locales/#{filename_base}_#{locale_name}.yml") do |f|
+        file('i18n:base.yml', "config/locale/#{filename_base}_#{locale_name}.yml") do |f|
           doc.to_s
         end
       end

data/generators/{i18n_models/i18n_models_generator.rb → i18n_locale/i18n_locale_generator.rb}

@@ -1,9 +1,9 @@
 require File.join(File.dirname(__FILE__), '../i18n/i18n_generator')
 
-class I18nModelsGenerator < I18nGenerator
+class I18nLocaleGenerator < I18nGenerator
   def initialize(runtime_args, runtime_options = {})
-    @generate_models_only = true
     super
+    options[:generate_locale_only] = true
   end
 end
 

data/generators/{i18n_locales → i18n_locale}/lib/cldr.rb

@@ -2,7 +2,7 @@ $KCODE = 'U'
 
 require 'open-uri'
 
-module I18nLocalesGeneratorModule
+module I18nLocaleGeneratorModule
   class CldrDocument
     def initialize(locale_name)
       @locale_name = locale_name

data/generators/{i18n_locales → i18n_locale}/lib/yaml.rb

@@ -1,6 +1,6 @@
 require 'yaml'
 
-module I18nLocalesGeneratorModule
+module I18nLocaleGeneratorModule
   class YamlDocument
     def initialize(yml_path, locale_name)
       @locale_name, @nodes = locale_name, []

data/generators/{i18n_models/i18n_models_command.rb → i18n_translation/i18n_translation_command.rb}

@@ -1,12 +1,14 @@
 require 'rails_generator'
 require 'rails_generator/commands'
 require File.join(File.dirname(__FILE__), 'lib/translator')
-include I18nModelsGeneratorModule
+require File.join(File.dirname(__FILE__), 'lib/recording_backend')
+require File.join(File.dirname(__FILE__), 'lib/erb_executer')
+include I18nTranslationGeneratorModule
 
 module I18nGenerator::Generator
   module Commands #:nodoc:
     module Create
-      def models_yaml
+      def translation_yaml
         I18n.locale = locale_name
         models = model_filenames.map do |model_name|
           model = begin
@@ -38,7 +40,16 @@ END
           end
           model
         end.compact
-        generate_yaml(locale_name, models)
+        # pick all translated keywords from view files
+        I18n.backend = RecordingBackend.new
+
+        Dir["#{RAILS_ROOT}/app/views/**/*.erb"].each do |f|
+          ErbExecuter.new.exec_erb f
+        end
+        keys_in_view = I18n.backend.keys
+        keys_in_view -= models.map {|m| m.english_name.to_sym}
+        keys_in_view -= models.inject([]) {|a, m| a + m.content_columns.map {|c| "#{m.english_name}.#{c.name}".to_sym}}
+        generate_yaml(locale_name, models, keys_in_view.inject({}) {|h, k| h[k] = translator.translate(k); h})
       end
 
       private
@@ -48,8 +59,8 @@ END
         end
       end
 
-      def generate_yaml(locale_name, models)
-        template 'i18n:models.yml', "config/locales/models_#{locale_name}.yml", :assigns => {:locale_name => locale_name, :models => models}
+      def generate_yaml(locale_name, models, translations)
+        template 'i18n:translation.yml', "config/locales/translation_#{locale_name}.yml", :assigns => {:locale_name => locale_name, :models => models, :translations => translations}
       end
     end
   end

data/generators/{i18n_locales/i18n_locales_generator.rb → i18n_translation/i18n_translation_generator.rb}

@@ -1,9 +1,9 @@
 require File.join(File.dirname(__FILE__), '../i18n/i18n_generator')
 
-class I18nLocalesGenerator < I18nGenerator
+class I18nTranslationGenerator < I18nGenerator
   def initialize(runtime_args, runtime_options = {})
-    @generate_locales_only = true
     super
+    options[:generate_translation_only] = true
   end
 end
 

data/generators/i18n_translation/lib/erb_executer.rb

@@ -0,0 +1,30 @@
+require "#{File.dirname(__FILE__)}/through_ryoku"
+
+module I18nTranslationGeneratorModule
+  class ErbExecuter
+    def exec_erb(filename)
+      begin
+#         ERB.new(File.read(f)).result
+        (m = Module.new).module_eval <<-EOS
+          class Executer
+            extend ERB::DefMethod
+            include ActionView::Helpers::TranslationHelper
+            include ThroughRyoku
+            nil.class_eval do
+              def method_missing(method, *args, &block); nil; end
+            end
+            def_erb_method 'execute', '#{filename}'
+          end
+        EOS
+        m.const_get('Executer').new.execute { }
+        nil.class_eval do
+          undef :method_missing
+        end
+      rescue => e
+        p e
+        # do nothing
+      end
+    end
+  end
+end
+

data/generators/i18n_translation/lib/recording_backend.rb

@@ -0,0 +1,15 @@
+module I18nTranslationGeneratorModule
+  class RecordingBackend
+    attr_reader :keys
+
+    def initialize
+      @keys = []
+    end
+
+    def translate(locale, key, options = {})
+      @keys << key.to_sym
+    end
+    alias :t :translate
+  end
+end
+

data/generators/i18n_translation/lib/through_ryoku.rb

@@ -0,0 +1,6 @@
+module ThroughRyoku
+  def method_missing(method, *args, &block)
+    nil
+  end
+end
+

data/generators/{i18n_models → i18n_translation}/lib/translator.rb

@@ -1,6 +1,6 @@
 require 'open-uri'
 
-module I18nModelsGeneratorModule
+module I18nTranslationGeneratorModule
   class Translator
     def initialize(lang)
       @lang, @cache = lang, {}

data/spec/cldr_spec.rb

@@ -1,7 +1,7 @@
 $KCODE = 'U'
 
-require File.join(File.dirname(__FILE__), '../generators/i18n_locales/lib/cldr')
-include I18nLocalesGeneratorModule
+require File.join(File.dirname(__FILE__), '../generators/i18n_locale/lib/cldr')
+include I18nLocaleGeneratorModule
 
 describe CldrDocument do
   before do

data/spec/{i18n_locales_command_spec.rb → i18n_locale_command_spec.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '/../generators/i18n_locales/i18n_locales_command')
+require File.join(File.dirname(__FILE__), '/../generators/i18n_locale/i18n_locale_command')
 
 describe I18nGenerator::Generator::Commands::Create do
   before do

data/spec/translator_spec.rb

@@ -1,7 +1,7 @@
 $KCODE = 'U'
 
-require File.join(File.dirname(__FILE__), '../generators/i18n_models/lib/translator')
-include I18nModelsGeneratorModule
+require File.join(File.dirname(__FILE__), '../generators/i18n_translation/lib/translator')
+include I18nTranslationGeneratorModule
 
 describe Translator do
   before(:each) do

data/spec/yaml_spec.rb

@@ -1,5 +1,5 @@
-require File.join(File.dirname(__FILE__), '/../generators/i18n_locales/lib/yaml')
-include I18nLocalesGeneratorModule
+require File.join(File.dirname(__FILE__), '/../generators/i18n_locale/lib/yaml')
+include I18nLocaleGeneratorModule
 
 describe 'Yaml' do
   before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: amatsuda-i18n_generators
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Akira Matsuda
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-29 00:00:00 -08:00
+date: 2008-12-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,15 +35,14 @@ files:
 - Rakefile
 - generators/i18n/USAGE
 - generators/i18n/i18n_generator.rb
-- generators/i18n_locales/USAGE
-- generators/i18n_locales/i18n_locales_command.rb
-- generators/i18n_locales/i18n_locales_generator.rb
-- generators/i18n_locales/lib/cldr.rb
-- generators/i18n_locales/lib/yaml.rb
-- generators/i18n_models/USAGE
-- generators/i18n_models/i18n_models_command.rb
-- generators/i18n_models/i18n_models_generator.rb
-- generators/i18n_models/lib/translator.rb
+- generators/i18n/templates/base.yml
+- generators/i18n/templates/i18n_config.rb
+- generators/i18n/templates/translation.yml
+- generators/i18n_locale/USAGE
+- generators/i18n_locale/i18n_locale_command.rb
+- generators/i18n_locale/i18n_locale_generator.rb
+- generators/i18n_locale/lib/cldr.rb
+- generators/i18n_locale/lib/yaml.rb
 - generators/i18n_scaffold/i18n_scaffold_generator.rb
 - generators/i18n_scaffold/templates/controller.rb
 - generators/i18n_scaffold/templates/functional_test.rb
@@ -55,13 +54,17 @@ files:
 - generators/i18n_scaffold/templates/view_index.html.erb
 - generators/i18n_scaffold/templates/view_new.html.erb
 - generators/i18n_scaffold/templates/view_show.html.erb
-- generators/i18n/templates/base.yml
-- generators/i18n/templates/i18n_config.rb
-- generators/i18n/templates/models.yml
+- generators/i18n_translation/USAGE
+- generators/i18n_translation/i18n_translation_command.rb
+- generators/i18n_translation/i18n_translation_generator.rb
+- generators/i18n_translation/lib/erb_executer.rb
+- generators/i18n_translation/lib/recording_backend.rb
+- generators/i18n_translation/lib/through_ryoku.rb
+- generators/i18n_translation/lib/translator.rb
 - spec/cldr_spec.rb
 - spec/data/cldr/ja.html
 - spec/data/yml/active_record/en-US.yml
-- spec/i18n_locales_command_spec.rb
+- spec/i18n_locale_command_spec.rb
 - spec/translator_spec.rb
 - spec/yaml_spec.rb
 has_rdoc: false