ready_for_i18n 0.2.6 → 0.2.7

data/README.rdoc

@@ -5,10 +5,13 @@ Ready_for_i18n is handy tool helping you in the first step of getting your local
 It will automatically extract hard-coded text from your ERB view file,
 then choose a proper key and replace them with the I18n.translate method.
 
-Currently two extractors are available:
+Currently three extractors are available:
 
-  * TextExtractor will scan all HTML text nodes in you view files, like <b>Hello</b> then replace it with <%=t(:text_hello)%>.
-  * LabelExtractor will scan all the text in helper methods like link_to('Login'...) and replace with link_to (t(:login)).
+  * HtmlTextExtractor will scan all HTML text nodes in you view files, like <b>Hello</b> then replace it with <b><%=t(:text_hello)%></b>.
+  * HtmlAttrExtractor will scan all visible HTML attribute in you view files, like <input type="submit" value="Back"> then replace it with <input type="submit" value="<%=t(:label_back)">.
+  * ErbHelperExtractor will scan all the text in helper methods like link_to('Login'...) and replace with link_to (t(:login)).
+
+Introduction Blog at: http://zigzag.github.com/2009/12/17/get-your-local-rails-application-ready-for-i18n.html
 
 == Installation:
   gem install ready_for_i18n
@@ -16,15 +19,23 @@ Currently two extractors are available:
 Hosed at http://www.gemcutter.org/gems/ready_for_i18n
 
 == Basic Command Line Usage:
-  ready_for_i18n <path to ERB source files> <target path> 
+  ready_for_i18n <path to ERB source files> [target path]
 
-Your erb files in source path will be transformed(i18n_ready)
-and copy to target file path,together with a locale file 'en.yml'.
+Your erb files in source path will be transformed(i18n_ready) and copy to target file path.
+If target path is missing, then ready_for_i18n will do a Dry run and only generated the locale file.
 
+A locale file will be output to STDOUT,which you can redirect to file like
+  ready_for_i18n <path to ERB source files> [target path] > /temp/en.yml
+  
 Using the following options:
   --locale [LOCALE]            Generating for the specified locale (default locale 'en')
   --ext [EXTENSION]            The file extension name of your views(default '.html.erb')
 
+== Warning
+* This tool is used based on the most "conventional" way of HTML and ERB. But I can not guarantee all the text will be extracted correctly.Create an issue in this github project page if you found some thing miss.
+
+* Only tested when the local language is English. Other languages support is in the TODO list.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.7

data/bin/ready_for_i18n

@@ -42,6 +42,8 @@ opts.parse!
  
 # Get source and destintation from command line
 case ARGV.size
+  when 1
+    options['source']      = ARGV[0]
   when 2
     options['source']      = ARGV[0]
     options['destination'] = ARGV[1]
@@ -50,21 +52,5 @@ case ARGV.size
     exit(1)
 end
  
-def excute(src_path,target_path,locale,extension)
-  ext = extension || '.html.erb'
-  dict = ReadyForI18N::LocaleDictionary.new(locale)
-  Dir.glob(File.join(src_path,"**#{File::SEPARATOR}*#{ext}")).each do |f|
-    full_target_path = File.dirname(f).gsub(src_path,target_path)
-    FileUtils.makedirs full_target_path
-    target_file = File.join(full_target_path,File.basename(f))
-    ReadyForI18N::LabelExtractor.new(f,target_file).extract{|k,v| dict[k] = v}
-    ReadyForI18N::TextExtractor.new(target_file,target_file).extract{|k,v| dict[k] = v}
-    puts "i18n ready: #{target_file}"
-  end
-  locale_file = dict.write_to target_path
-  puts "------------------------------------------------------------------------------"
-  puts "Locale file: #{locale_file}"
-end
-
 # Run the i18n generating
-excute(options['source'],options['destination'],options['locale'],options['extension'])
+ReadyForI18N::I18nGenerator.excute(options)

data/lib/base_extractor.rb

@@ -1,14 +1,11 @@
+require 'stringio'
+
 module ReadyForI18N
   module BaseExtractor
     VALUE_PATTERN = /\w+/
-    def initialize(erb_source, erb_target = nil)
-      @erb_source = erb_source
-      @erb_target = erb_target
-    end
-
-    def extract
-      buffer = ''
-      File.open(@erb_source).each do |line|
+    def extract(input)
+      buffer = StringIO.new
+      input.each do |line|
         unless skip_line?(line)
           values_in_line(line).each do |e|
             if can_replace?(e)
@@ -19,7 +16,7 @@ module ReadyForI18N
         end
         buffer << line
       end
-      File.open(@erb_target,'w+') {|f| f << buffer} if @erb_target
+      buffer.string
     end
     def to_key(s)
       result = to_value(s).scan(/\w+/).join('_').downcase

data/lib/{label_extractor.rb → erb_helper_extractor.rb}

@@ -1,5 +1,5 @@
 module ReadyForI18N
-  class LabelExtractor
+  class ErbHelperExtractor
     LABEL_IN_HELPER_PATTERN =  %w{label_tag link_to field_set_tag submit_tag button_to}.map{|h| /#{h}[\s\w_]*('|")([\w ]*)(\1)/ }
 
     include ReadyForI18N::BaseExtractor

data/lib/html_attr_extractor.rb

@@ -0,0 +1,26 @@
+module ReadyForI18N
+  class HtmlAttrExtractor < HtmlTextExtractor
+    LABEL_TAG_ATTR_PATTERN = [[/<img(.*)(\/>|<\/img>)/i,/alt=["'](.*?)["']/i],
+                              [/<img(.*)(\/>|<\/img>)/i,/title=["'](.*?)["']/i],
+                              [/<input(.*)\s*type\s*=\s*["']submit["']/i,/value\s*=\s*["'](.*?)["']/i],
+                              [/<input\s*type\s*=\s*["']submit["'](.*)/i,/value\s*=\s*["'](.*?)["']/i],
+                              [/<input(.*)\s*type\s*=\s*["']button["']/i,/value\s*=\s*["'](.*?)["']/i],
+                              [/<input\s*type\s*=\s*["']button["'](.*)/i,/value\s*=\s*["'](.*?)["']/i]]
+    SKIP_PATTERN = /<%(.*)%>/
+    protected 
+    def values_in_line(line)
+      values = []
+      LABEL_TAG_ATTR_PATTERN.each do |p|
+        attrs = line.match(p[0])[1] if line =~ p[0]
+        if attrs =~ p[1] 
+          value = attrs.match(p[1])[1]
+          values << value unless value =~ SKIP_PATTERN
+        end
+      end
+      values
+    end
+    def key_prefix
+      'label'
+    end
+  end
+end

data/lib/{text_extractor.rb → html_text_extractor.rb}

@@ -1,5 +1,5 @@
 module ReadyForI18N
-  class TextExtractor
+  class HtmlTextExtractor
     SKIP_TAGS = [[/<script/i,/<\/script>/i],[/<%/,/%>/],[/<style/i,/\/style>/i]]
     SKIP_INLINE_TAG = [/<%(.*?)%>/,/<(.*?)>/,/<%(.*)$/,/^(.*)%>/,/&nbsp;/,/&raquo;/]
     SEPERATOR = '_@@@_'

data/lib/i18n_generator.rb

@@ -0,0 +1,29 @@
+module ReadyForI18N
+  class I18nGenerator
+    EXTRACTORS = [ErbHelperExtractor,HtmlTextExtractor,HtmlAttrExtractor]
+    def self.excute(opt)
+      @src_path = opt['source']
+      @target_path = opt['destination']
+      if @target_path && (!@target_path.end_with? File::SEPARATOR)
+        @target_path = "#{@target_path}#{File::SEPARATOR}"  
+      end
+      @locale = opt['locale']
+      @ext = opt['extension'] || '.html.erb'
+      dict = ReadyForI18N::LocaleDictionary.new(@locale)
+      Dir.glob(File.join(@src_path,"**#{File::SEPARATOR}*#{@ext}")).each do |f|
+        result = EXTRACTORS.inject(File.read(f)) do |buffer,extractor|
+          extractor.new.extract(buffer){|k,v| dict[k] = v}
+        end
+        write_target_file(f,result) if @target_path
+      end
+      dict.write_to STDOUT
+    end
+  private
+    def self.write_target_file(source_file_name,content)
+      full_target_path = File.dirname(source_file_name).gsub(@src_path,@target_path)
+      FileUtils.makedirs full_target_path
+      target_file = File.join(full_target_path,File.basename(source_file_name))
+      File.open(target_file,'w+'){|f| f << content}
+    end
+  end
+end

data/lib/locale_dictionary.rb

@@ -7,15 +7,9 @@ module ReadyForI18N
     def []=(key,value)
       @hash[key] = value
     end
-
-    def write_to(path)
-      file = File.join(path,"#{@locale}.yml")
-      File.open(file,'w+') do |f|
-        f.puts "#{@locale}:"
-        @hash.keys.sort{|a,b|a.to_s<=>b.to_s}.each { |k| f.puts "  #{k}: #{@hash[k].dump}" }
-      end
-      file
+    def write_to(out)
+      out.puts "#{@locale}:"
+      @hash.keys.sort{|a,b|a.to_s<=>b.to_s}.each { |k| out.puts "  #{k}: #{@hash[k].dump}" }
     end
-    
   end
 end

data/lib/ready_for_i18n.rb

@@ -1,4 +1,6 @@
 require 'base_extractor'
-require 'text_extractor'
-require 'label_extractor'
-require 'locale_dictionary'
+require 'html_text_extractor'
+require 'html_attr_extractor'
+require 'erb_helper_extractor'
+require 'locale_dictionary'
+require 'i18n_generator'

data/ready_for_i18n.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ready_for_i18n}
-  s.version = "0.2.6"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["zigzag"]
-  s.date = %q{2009-12-17}
+  s.date = %q{2009-12-21}
   s.default_executable = %q{ready_for_i18n}
   s.description = %q{      ready_for_i18n will help you extract visible hard-coded text from your ERB view files,
       then choose a proper key and replace them with the I18n.translate method like t(:login)
@@ -29,20 +29,24 @@ Gem::Specification.new do |s|
      "VERSION",
      "bin/ready_for_i18n",
      "lib/base_extractor.rb",
-     "lib/label_extractor.rb",
+     "lib/erb_helper_extractor.rb",
+     "lib/html_attr_extractor.rb",
+     "lib/html_text_extractor.rb",
+     "lib/i18n_generator.rb",
      "lib/locale_dictionary.rb",
      "lib/ready_for_i18n.rb",
-     "lib/text_extractor.rb",
      "ready_for_i18n.gemspec",
+     "test/fixtures/html_attr.html.erb",
      "test/fixtures/index.html.erb",
      "test/helper.rb",
      "test/output/en.yml",
      "test/output/label.html.erb",
      "test/output/text.html.erb",
      "test/test_base_extractor.rb",
-     "test/test_label_extractor.rb",
-     "test/test_locale_dictionary.rb",
-     "test/test_text_extrator.rb"
+     "test/test_erb_helper_extractor.rb",
+     "test/test_html_attr_extractor.rb",
+     "test/test_html_text_extractor.rb",
+     "test/test_locale_dictionary.rb"
   ]
   s.homepage = %q{http://github.com/zigzag/ready_for_i18n}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -52,9 +56,10 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/test_base_extractor.rb",
-     "test/test_label_extractor.rb",
-     "test/test_locale_dictionary.rb",
-     "test/test_text_extrator.rb"
+     "test/test_erb_helper_extractor.rb",
+     "test/test_html_attr_extractor.rb",
+     "test/test_html_text_extractor.rb",
+     "test/test_locale_dictionary.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/fixtures/html_attr.html.erb

@@ -0,0 +1,7 @@
+<img src="<%= ApplicationController.root_context -%>/images/print.gif" alt="Print" />
+<IMG src="<%= ApplicationController.root_context -%>/images/priority/<%= rule_measure.rule_priority -%>.gif" title="Measure"></IMG>
+<input id="saveBtn"    value="Save" onclick="SelectBox.select_all('to');submit();return false;" type="submit">
+<input type="submit" value="Compare on chart" />
+<input type="button" name="button_copy" id="copy_<%= u profile.key %>" value="copy" onClick='var name=prompt("Name for the new profile"); if (name!=null) {$("copy_<%= profile.id %>").value=name; submit();} else {return false;}'>
+<input type="hidden" value="Should not extract">
+<input type="text" value="<%= should ignore me %>">

data/test/{test_label_extractor.rb → test_erb_helper_extractor.rb}

@@ -1,10 +1,10 @@
 require 'helper'
 
-class TestLabelExtractor < Test::Unit::TestCase
+class TestErbHelperExtractor < Test::Unit::TestCase
   should "extract the label that need i18n from the erb view file" do
     f = File.join(File.dirname(__FILE__),'fixtures','index.html.erb')
     result = []
-    ReadyForI18N::LabelExtractor.new(f).extract{|k,v| result << v}
+    ReadyForI18N::ErbHelperExtractor.new.extract(File.read(f)){|k,v| result << v}
     expected = %w{edit delete select export cancel} << "Add Event"
     assert_same_elements(expected,result)
   end
@@ -12,7 +12,9 @@ class TestLabelExtractor < Test::Unit::TestCase
   should "replace the label in helper with t method" do
     source = File.join(File.dirname(__FILE__),'fixtures','index.html.erb')
     target = File.join(File.dirname(__FILE__),'output','label.html.erb')
-    ReadyForI18N::LabelExtractor.new(source,target).extract
+    output = nil
+    File.open(source){|f| output = ReadyForI18N::ErbHelperExtractor.new.extract(f)}
+    File.open(target,'w+'){|f| f << output}
     expected = %w{edit delete select export cancel add_event}
     expected.each do |e|
       assert(File.read(target).include?("t(:label_#{e})"), "should found t method with symbol")

data/test/test_html_attr_extractor.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestHtmlAttrExtractor < Test::Unit::TestCase
+  should "extract the Some Attribute that need i18n from the HTML file" do
+    f = File.join(File.dirname(__FILE__),'fixtures','html_attr.html.erb')
+    expected = %w{Print Measure Save copy} << 'Compare on chart'
+    result = []
+    ReadyForI18N::HtmlAttrExtractor.new.extract(File.read(f)){|k,v| result << v}
+    assert_same_elements(expected,result)
+  end
+  
+  should "replace the attribut in html with t method" do
+    source = File.join(File.dirname(__FILE__),'fixtures','html_attr.html.erb')
+    output = ReadyForI18N::HtmlAttrExtractor.new.extract(File.read(source))
+    %w{Print Measure Save copy}.each do |e|
+      assert(output.include?("<%=t(:label_#{e.downcase.gsub(':','')})%>"), "should found t method with symbol")
+    end
+  end
+  
+end

data/test/{test_text_extrator.rb → test_html_text_extractor.rb}

@@ -1,20 +1,19 @@
 require 'helper'
 
-class TestTextExtractor < Test::Unit::TestCase
+class TestHtmlTextExtractor < Test::Unit::TestCase
   should "extract the text that need i18n from the erb view file" do
     f = File.join(File.dirname(__FILE__),'fixtures','index.html.erb')
     expected = %w{Users Login Name Groups Operations Login: Name: Password: Export} << 'Confirm password:'
     result = []
-    ReadyForI18N::TextExtractor.new(f).extract{|k,v| result << v}
+    ReadyForI18N::HtmlTextExtractor.new.extract(File.read(f)){|k,v| result << v}
     assert_same_elements(expected,result)
   end
   
   should "replace the text in helper with t method" do
     source = File.join(File.dirname(__FILE__),'fixtures','index.html.erb')
-    target = File.join(File.dirname(__FILE__),'output','text.html.erb')
-    ReadyForI18N::TextExtractor.new(source,target).extract
+    output = ReadyForI18N::HtmlTextExtractor.new.extract(File.read(source))
     %w{Users Login Name Groups Operations Login: Name: Password: Export}.each do |e|
-      assert(File.read(target).include?("<%=t(:text_#{e.downcase.gsub(':','')})%>"), "should found t method with symbol")
+      assert(output.include?("<%=t(:text_#{e.downcase.gsub(':','')})%>"), "should found t method with symbol")
     end
   end
   

data/test/test_locale_dictionary.rb

@@ -2,17 +2,24 @@ require 'helper'
 
 class TestLocaleDictionary < Test::Unit::TestCase
   should "save the result hash to yaml file" do
-    target_path = File.join(File.dirname(__FILE__),'output')
+    locale_file = File.join(File.dirname(__FILE__),'output','en.yml')
+    
     dict = ReadyForI18N::LocaleDictionary.new
     dict['login_key'] = 'Login:'
     dict['label'] = 'OK'
     dict['text'] = 'Please Confirm:'
     dict['with_quote'] = 'It is my "Label"'
-    dict.write_to target_path
+    File.open(locale_file,'w+') {|f| dict.write_to f}
     
-    result = YAML.load_file File.join(target_path,'en.yml')
+    result = YAML.load_file locale_file
     assert_equal('Login:', result['en']['login_key'])
     assert_equal("It is my \"Label\"", result['en']['with_quote'])
   end
   
+  should "output to STDOUT when write to is nil" do
+    dict = ReadyForI18N::LocaleDictionary.new
+    dict['label'] = 'OK'
+    dict.write_to STDOUT
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ready_for_i18n
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors: 
 - zigzag
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-17 00:00:00 +08:00
+date: 2009-12-21 00:00:00 +08:00
 default_executable: ready_for_i18n
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,20 +40,24 @@ files:
 - VERSION
 - bin/ready_for_i18n
 - lib/base_extractor.rb
-- lib/label_extractor.rb
+- lib/erb_helper_extractor.rb
+- lib/html_attr_extractor.rb
+- lib/html_text_extractor.rb
+- lib/i18n_generator.rb
 - lib/locale_dictionary.rb
 - lib/ready_for_i18n.rb
-- lib/text_extractor.rb
 - ready_for_i18n.gemspec
+- test/fixtures/html_attr.html.erb
 - test/fixtures/index.html.erb
 - test/helper.rb
 - test/output/en.yml
 - test/output/label.html.erb
 - test/output/text.html.erb
 - test/test_base_extractor.rb
-- test/test_label_extractor.rb
+- test/test_erb_helper_extractor.rb
+- test/test_html_attr_extractor.rb
+- test/test_html_text_extractor.rb
 - test/test_locale_dictionary.rb
-- test/test_text_extrator.rb
 has_rdoc: true
 homepage: http://github.com/zigzag/ready_for_i18n
 licenses: []
@@ -85,6 +89,7 @@ summary: ready_for_i18n is a tool helping for the very first step of transfering
 test_files: 
 - test/helper.rb
 - test/test_base_extractor.rb
-- test/test_label_extractor.rb
+- test/test_erb_helper_extractor.rb
+- test/test_html_attr_extractor.rb
+- test/test_html_text_extractor.rb
 - test/test_locale_dictionary.rb
-- test/test_text_extrator.rb