ready_for_i18n 0.2.7 → 0.2.8

data/README.textile

@@ -0,0 +1,57 @@
+h1. ready_for_i18n
+
+Ready_for_i18n is handy tool helping you in the first step of getting your local Rails project ready for I18N.
+
+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 three extractors are available:
+
+|Extractor|From|To|
+|HtmlTextExtractor|@<b>Hello</b>@|@<b><%=t(:text_hello)%></b>@|
+|HtmlAttrExtractor|@<input type="submit" value="Back"/>@|@<input type="submit" value="<%=t(:label_back)"/>@|
+|ErbHelperExtractor|@link_to('Login'...)@|@link_to (t(:login))@|
+
+
+Introduction Blog at: "Get your application ready for I18N":http://zigzag.github.com/2009/12/17/get-your-local-rails-application-ready-for-i18n.html
+
+h2. Installation:
+
+bq. gem install ready_for_i18n
+
+Hosed at "http://www.gemcutter.org/gems/ready_for_i18n":http://www.gemcutter.org/gems/ready_for_i18n
+
+h2. Basic Command Line Usage:
+
+bq. @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.
+If the target path is missing, then ready_for_i18n will do a Dry run and only generate the locale file.
+
+A locale file will be output to STDOUT, which you can redirect to file like
+
+bq. @ready_for_i18n <path_to_ERB_source_files> [target path] > /temp/en.yml@
+  
+Using the following options:
+
+|&nbsp;&nbsp;|@--locale [LOCALE]@|@Generating for the specified locale (default locale 'en')@|
+|&nbsp;&nbsp;|@--ext [EXTENSION]@|@The file extension name of your views(default '.html.erb')@|
+
+h2. 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.
+
+h2. Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Copyright
+
+Copyright (c) 2009 zigzag. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.7
+0.2.8

data/bin/ready_for_i18n

@@ -11,11 +11,13 @@ 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.
  
 Basic Command Line Usage:
-  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'.
+  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.
+#  If the target path is missing, then ready_for_i18n will do a Dry run and only generate 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:
  
 HELP
@@ -34,6 +36,10 @@ opts = OptionParser.new do |opts|
   opts.on("--ext [EXTENSION]", "The file extension name of your views(default '.html.erb')") do |extension|
     options['extension'] = extension unless extension.nil?
   end
+  
+  opts.on("--dot","Generate a structured dictionary file and support `Lazy` Lookup of Rails > 2.3 ") do |dot|
+    options['dot'] = true
+  end
 
 end
  

data/lib/erb_helper_extractor.rb

@@ -2,7 +2,7 @@ module ReadyForI18N
   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
+    include ReadyForI18N::ExtractorBase
     
     protected 
     def values_in_line(line)
@@ -15,7 +15,7 @@ module ReadyForI18N
       s.strip[1..-2]
     end
     def replace_line(line,e)
-      line.gsub!(e,"t(:#{to_key(e)})")
+      line.gsub!(e,t_method(e))
     end
     def key_prefix
       'label'

data/lib/{base_extractor.rb → extractor_base.rb}

@@ -1,8 +1,14 @@
 require 'stringio'
 
 module ReadyForI18N
-  module BaseExtractor
+  module ExtractorBase
     VALUE_PATTERN = /\w+/
+    def self.use_dot(on_off)
+      @use_dot = on_off
+    end
+    def self.use_dot?
+      @use_dot
+    end
     def extract(input)
       buffer = StringIO.new
       input.each do |line|
@@ -25,5 +31,9 @@ module ReadyForI18N
     def can_replace?(e)
       e.scan(VALUE_PATTERN).length > 0
     end
+    def t_method(val,wrap=false)
+      m = ExtractorBase.use_dot? ? "t('.#{to_key(val)}')" : "t(:#{to_key(val)})"
+      wrap ? "<%=#{m}%>" : m
+    end
   end
 end

data/lib/html_attr_extractor.rb

@@ -22,5 +22,8 @@ module ReadyForI18N
     def key_prefix
       'label'
     end
+    def replace_line(line,e)
+      line.sub!(e,t_method(e,true))
+    end
   end
 end

data/lib/html_text_extractor.rb

@@ -1,10 +1,10 @@
 module ReadyForI18N
   class HtmlTextExtractor
     SKIP_TAGS = [[/<script/i,/<\/script>/i],[/<%/,/%>/],[/<style/i,/\/style>/i]]
-    SKIP_INLINE_TAG = [/<%(.*?)%>/,/<(.*?)>/,/<%(.*)$/,/^(.*)%>/,/&nbsp;/,/&raquo;/]
+    SKIP_INLINE_TAG = [/<%(.*?)%>/,/<(.*?)>/,/<(.*)$/,/^(.*)>/,/&nbsp;/]
     SEPERATOR = '_@@@_'
 
-    include ReadyForI18N::BaseExtractor
+    include ReadyForI18N::ExtractorBase
     
     protected 
     def values_in_line(line)
@@ -28,7 +28,14 @@ module ReadyForI18N
       s.strip
     end
     def replace_line(line,e)
-      line.gsub!(e,"<%=t(:#{to_key(e)})%>")
+      repeat = line.scan(e).size
+      replaced = t_method(e,true)
+      return line if repeat == 0
+      return line.sub!(e,replaced) if repeat == 1
+      if repeat > 1
+        line.gsub!(/>\s*#{e}\s*</,">#{replaced}<")
+        line.gsub!(/>\s*#{e}/,">#{replaced}")
+      end
     end
     def key_prefix
       'text'

data/lib/i18n_generator.rb

@@ -1,6 +1,8 @@
 module ReadyForI18N
   class I18nGenerator
     EXTRACTORS = [ErbHelperExtractor,HtmlTextExtractor,HtmlAttrExtractor]
+    PATH_PATTERN = /\/views\/(.*)/
+    
     def self.excute(opt)
       @src_path = opt['source']
       @target_path = opt['destination']
@@ -9,10 +11,14 @@ module ReadyForI18N
       end
       @locale = opt['locale']
       @ext = opt['extension'] || '.html.erb'
+      
+      ReadyForI18N::ExtractorBase.use_dot(true) if opt['dot']
+      
       dict = ReadyForI18N::LocaleDictionary.new(@locale)
       Dir.glob(File.join(@src_path,"**#{File::SEPARATOR}*#{@ext}")).each do |f|
+        path = f.match(PATH_PATTERN)[1].gsub(/#{@ext}$/,'').split '/' if opt['dot'] && f =~ PATH_PATTERN
         result = EXTRACTORS.inject(File.read(f)) do |buffer,extractor|
-          extractor.new.extract(buffer){|k,v| dict[k] = v}
+          extractor.new.extract(buffer){|k,v| dict.push(k,v,path)}
         end
         write_target_file(f,result) if @target_path
       end

data/lib/locale_dictionary.rb

@@ -4,12 +4,28 @@ module ReadyForI18N
       @locale = locale || 'en'
       @hash = {}
     end
-    def []=(key,value)
-      @hash[key] = value
+    def push(key,value,path = nil)
+      h = @hash
+      path.each{|p| h[p] ||= {}; h = h[p] } if path
+      h[key] = value
     end
     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}" }
+      write_out_hash(out,@hash,1)
+    end
+    
+    private 
+    def write_out_hash(out,hash,intent)
+      hash.keys.sort{|a,b|a.to_s<=>b.to_s}.each do |k|
+        key_with_indent = "#{'  '*intent}#{k}:"
+        val = hash[k]
+        if (val.is_a? Hash)
+          out.puts(key_with_indent)
+          write_out_hash(out, val, intent + 1) 
+        else
+          out.puts("#{key_with_indent} #{val.dump}" )
+        end
+      end
     end
   end
 end

data/lib/ready_for_i18n.rb

@@ -1,4 +1,4 @@
-require 'base_extractor'
+require 'extractor_base'
 require 'html_text_extractor'
 require 'html_attr_extractor'
 require 'erb_helper_extractor'

data/ready_for_i18n.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ready_for_i18n}
-  s.version = "0.2.7"
+  s.version = "0.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["zigzag"]
-  s.date = %q{2009-12-21}
+  s.date = %q{2009-12-25}
   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)
@@ -18,18 +18,18 @@ Gem::Specification.new do |s|
   s.executables = ["ready_for_i18n"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.textile"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.textile",
      "Rakefile",
      "VERSION",
      "bin/ready_for_i18n",
-     "lib/base_extractor.rb",
      "lib/erb_helper_extractor.rb",
+     "lib/extractor_base.rb",
      "lib/html_attr_extractor.rb",
      "lib/html_text_extractor.rb",
      "lib/i18n_generator.rb",
@@ -42,8 +42,8 @@ Gem::Specification.new do |s|
      "test/output/en.yml",
      "test/output/label.html.erb",
      "test/output/text.html.erb",
-     "test/test_base_extractor.rb",
      "test/test_erb_helper_extractor.rb",
+     "test/test_extractor_base.rb",
      "test/test_html_attr_extractor.rb",
      "test/test_html_text_extractor.rb",
      "test/test_locale_dictionary.rb"
@@ -55,8 +55,8 @@ Gem::Specification.new do |s|
   s.summary = %q{ready_for_i18n is a tool helping for the very first step of transfering your local Rails project to an i18n one.}
   s.test_files = [
     "test/helper.rb",
-     "test/test_base_extractor.rb",
      "test/test_erb_helper_extractor.rb",
+     "test/test_extractor_base.rb",
      "test/test_html_attr_extractor.rb",
      "test/test_html_text_extractor.rb",
      "test/test_locale_dictionary.rb"

data/test/fixtures/index.html.erb

@@ -1,3 +1,6 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
 <table width="100%">
   <tr>
     <td valign="top">
@@ -78,6 +81,8 @@
   </tr>
 </table>
 
+<button id="select_right_all" onclick="SelectBox.move_all('from', 'to');return false;">select all &raquo;</button><br><br>
+
 <%= link_to "export",
  url_for(:controller => 'api/rules', :action => 'index', :language => @profile.language, :profile => @profile.name,
       :plugins => @plugins.join(','),
@@ -87,3 +92,4 @@
 
 <%= link_to_remote 'Add Event', {:url => { :controller => 'events', :action => "new", :rid => params['rid'] },
      :update => "event_form"}, {:class => 'action'} %>
+

data/test/output/label.html.erb

@@ -1,3 +1,6 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
 <table width="100%">
   <tr>
     <td valign="top">
@@ -78,6 +81,8 @@
   </tr>
 </table>
 
+<button id="select_right_all" onclick="SelectBox.move_all('from', 'to');return false;">select all &raquo;</button><br><br>
+
 <%= link_to t(:label_export),
  url_for(:controller => 'api/rules', :action => 'index', :language => @profile.language, :profile => @profile.name,
       :plugins => @plugins.join(','),
@@ -87,3 +92,4 @@
 
 <%= link_to_remote t(:label_add_event), {:url => { :controller => 'events', :action => "new", :rid => params['rid'] },
      :update => "event_form"}, {:class => 'action'} %>
+

data/test/test_erb_helper_extractor.rb

@@ -18,6 +18,7 @@ class TestErbHelperExtractor < Test::Unit::TestCase
     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")
+      assert(!File.read(target).include?("<%=t(:label_#{e})%>"), "should Not found t method wrapped.")
     end
   end
   

data/test/test_extractor_base.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class TestExtractorBase < Test::Unit::TestCase
+  should "find a proper key for a given text/label" do
+    c = Object.new
+    def c.key_prefix; nil;end
+    def c.to_value(s); s ;end
+    c.extend ReadyForI18N::ExtractorBase
+    assert_equal('confirm_password', c.to_key('Confirm password:'))
+  end
+
+  should "work fine with prefix" do
+    c = Object.new
+    def c.key_prefix; 'label' ;end
+    def c.to_value(s); s ;end
+    c.extend ReadyForI18N::ExtractorBase
+    assert_equal('label_login', c.to_key('Login:'))
+  end
+  
+  should "t_method should use symbol when no use dot" do
+    ReadyForI18N::ExtractorBase.use_dot(false)
+    c = Object.new
+    def c.key_prefix; 'label' ;end
+    def c.to_value(s); s ;end
+    c.extend ReadyForI18N::ExtractorBase
+    assert_equal("t(:label_login)", c.t_method('Login:'))
+    assert_equal("<%=t(:label_login)%>", c.t_method('Login:',true))
+  end
+
+  should "t_method should start with a dot when use dot" do
+    ReadyForI18N::ExtractorBase.use_dot(true)
+    c = Object.new
+    def c.key_prefix; 'label' ;end
+    def c.to_value(s); s ;end
+    c.extend ReadyForI18N::ExtractorBase
+    assert_equal("t('.label_login')", c.t_method('Login:'))
+    assert_equal("<%=t('.label_login')%>", c.t_method('Login:',true))
+  end
+
+end

data/test/test_html_text_extractor.rb

@@ -3,7 +3,7 @@ require 'helper'
 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:'
+    expected = %w{Users Login Name Groups Operations Login: Name: Password: Export} << 'Confirm password:' << 'select all &raquo;'
     result = []
     ReadyForI18N::HtmlTextExtractor.new.extract(File.read(f)){|k,v| result << v}
     assert_same_elements(expected,result)
@@ -17,4 +17,13 @@ class TestHtmlTextExtractor < Test::Unit::TestCase
     end
   end
   
+  should "replace the text only needed" do
+    input = "<span id='Replace Me'>Replace Me</span>"
+    output = ReadyForI18N::HtmlTextExtractor.new.extract input
+    assert_equal("<span id='Replace Me'><%=t(:text_replace_me)%></span>", output)
+
+    input = "<span id='Replace Me'>Replace Me"
+    output = ReadyForI18N::HtmlTextExtractor.new.extract input
+    assert_equal("<span id='Replace Me'><%=t(:text_replace_me)%>", output)
+  end
 end

data/test/test_locale_dictionary.rb

@@ -1,14 +1,15 @@
 require 'helper'
+require 'stringio'
 
 class TestLocaleDictionary < Test::Unit::TestCase
   should "save the result hash to yaml file" do
     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.push 'login_key','Login:'
+    dict.push 'label','OK'
+    dict.push 'text','Please Confirm:'
+    dict.push 'with_quote','It is my "Label"'
     File.open(locale_file,'w+') {|f| dict.write_to f}
     
     result = YAML.load_file locale_file
@@ -18,8 +19,18 @@ class TestLocaleDictionary < Test::Unit::TestCase
   
   should "output to STDOUT when write to is nil" do
     dict = ReadyForI18N::LocaleDictionary.new
-    dict['label'] = 'OK'
-    dict.write_to STDOUT
+    dict.push 'label','OK'
+    out = StringIO.new
+    dict.write_to out
+    assert_equal("en:\n  label: \"OK\"\n", out.string)
+  end
+  
+  should "should intent output when path is given" do 
+    dict = ReadyForI18N::LocaleDictionary.new
+    dict.push 'label','OK',['my_view']
+    out = StringIO.new
+    dict.write_to out
+    assert_equal("en:\n  my_view:\n    label: \"OK\"\n", out.string)
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ready_for_i18n
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - zigzag
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-21 00:00:00 +08:00
+date: 2009-12-25 00:00:00 +08:00
 default_executable: ready_for_i18n
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,17 +30,17 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.textile
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - bin/ready_for_i18n
-- lib/base_extractor.rb
 - lib/erb_helper_extractor.rb
+- lib/extractor_base.rb
 - lib/html_attr_extractor.rb
 - lib/html_text_extractor.rb
 - lib/i18n_generator.rb
@@ -53,8 +53,8 @@ files:
 - test/output/en.yml
 - test/output/label.html.erb
 - test/output/text.html.erb
-- test/test_base_extractor.rb
 - test/test_erb_helper_extractor.rb
+- test/test_extractor_base.rb
 - test/test_html_attr_extractor.rb
 - test/test_html_text_extractor.rb
 - test/test_locale_dictionary.rb
@@ -88,8 +88,8 @@ specification_version: 3
 summary: ready_for_i18n is a tool helping for the very first step of transfering your local Rails project to an i18n one.
 test_files: 
 - test/helper.rb
-- test/test_base_extractor.rb
 - test/test_erb_helper_extractor.rb
+- test/test_extractor_base.rb
 - test/test_html_attr_extractor.rb
 - test/test_html_text_extractor.rb
 - test/test_locale_dictionary.rb

data/README.rdoc

@@ -1,51 +0,0 @@
-= ready_for_i18n
-
-Ready_for_i18n is handy tool helping you in the first step of getting your local Rails project ready for I18N.
-
-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 three extractors are available:
-
-  * 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
-
-Hosed at http://www.gemcutter.org/gems/ready_for_i18n
-
-== Basic Command Line Usage:
-  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.
-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.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 zigzag. See LICENSE for details.

data/test/test_base_extractor.rb

@@ -1,20 +0,0 @@
-require 'helper'
-
-class TestBaseExtractor < Test::Unit::TestCase
-  should "find a proper key for a given text/label" do
-    c = Object.new
-    def c.key_prefix; nil;end
-    def c.to_value(s); s ;end
-    c.extend ReadyForI18N::BaseExtractor
-    assert_equal('confirm_password', c.to_key('Confirm password:'))
-  end
-
-  should "work fine with prefix" do
-    c = Object.new
-    def c.key_prefix; 'label' ;end
-    def c.to_value(s); s ;end
-    c.extend ReadyForI18N::BaseExtractor
-    assert_equal('label_login', c.to_key('Login:'))
-  end
-
-end