idiom 0.0.5 → 0.0.6

data/History.txt

@@ -1,3 +1,12 @@
+== 0.0.6 (in Git)
+  * minor enhancements
+    * some internal refactoring
+    * added destination option to command-line interface
+
+== 0.0.5.1 2010-01-22
+  * bug fixes
+    * correct command-line file
+
 == 0.0.5 2010-01-22
   * major enhancements
     * command-line file doesn't require parameters

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "idiom"
-    gem.summary = %Q{Translate strings in Google Translate}
+    gem.summary = %Q{Translate all your application's international keys in Google Translate}
     gem.description = %Q{Takes a set of keys in Yaml format and translates them through Google Translate.}
     gem.email = "progressions@gmail.com"
     gem.homepage = "http://github.com/progressions/idiom"
@@ -49,7 +49,7 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "translator #{version}"
+  rdoc.title = "idiom #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/bin/idiom

@@ -5,4 +5,12 @@ $LOAD_PATH.unshift(idiom_dir) unless $LOAD_PATH.include?(idiom_dir)
 
 require 'idiom'
 
-Idiom::Base.translate(:source => ARGV[0])
+options = {}
+
+options[:source] = ARGV[0] || "./"
+
+if ARGV[1]
+  options[:destination] = ARGV[1]
+end
+
+Idiom::Base.translate(options)

data/idiom.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{idiom}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Coleman"]
-  s.date = %q{2010-01-22}
+  s.date = %q{2010-01-30}
   s.default_executable = %q{idiom}
   s.description = %q{Takes a set of keys in Yaml format and translates them through Google Translate.}
   s.email = %q{progressions@gmail.com}
@@ -30,6 +30,9 @@ Gem::Specification.new do |s|
      "bin/idiom",
      "idiom.gemspec",
      "lib/idiom.rb",
+     "lib/idiom/base.rb",
+     "lib/idiom/yaml.rb",
+     "lib/idiom/yrb.rb",
      "spec/idiom_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
@@ -39,7 +42,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Translate strings in Google Translate}
+  s.summary = %q{Translate all your application's international keys in Google Translate}
   s.test_files = [
     "spec/idiom_spec.rb",
      "spec/spec_helper.rb",

data/lib/idiom.rb

@@ -1,364 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
 require 'rubygems'
 require 'active_support'
 require 'rtranslate'
 require 'timer'
 require 'yrb'
-require 'yaml'
-
-module Idiom #:nodoc:
-  # Finds English language translation keys which have not been translated 
-  # and translates them through Google Translate.
-  #
-  class Base
-    # Mapping of the way I18n country codes with the Google Translate codes.
-    #
-    # The key is the I18n representation, and the value is the code Google Translate would expect.
-    #
-    LOCALES = {
-      "de-DE" => "de",
-      "en-MY" => "en",
-      "en-SG" => "en",
-      "es-MX" => "es",
-      "it-IT" => "it",
-      "vi-VN" => "vi",
-      "zh-Hant-TW" => "zh-TW",
-      "en-AA" => "en",
-      "en-NZ" => "en",
-      "en-US" => "en",
-      "fr-FR" => "fr",
-      "ko-KR" => "ko",
-      "zh-Hans-CN" => "zh-CN",
-      "en-AU" => "en",
-      "en-PH" => "en",
-      "es-ES" => "es",
-      "id-ID" => "id",
-      "pt-BR" => "PORTUGUESE",
-      "zh-Hant-HK" => "zh-CN",
-    }
-
-    # Original filename to translate.
-    #
-    attr_accessor :source
-    
-    # Destination directory to output the translated files to.
-    #
-    attr_accessor :destination
-    
-    # Write the translated strings into a directory for each language?
-    #
-    attr_accessor :use_dirs
-    
-    # Array of languages to translate into.
-    #
-    attr_accessor :languages
-    
-    class << self
-      
-      def translate(options={})
-        @source = options[:source]
-        @destination = options[:destination]
-        @use_dirs = options[:use_dirs]
-        Timer.new.time do
-          Dir[@source].each do |path|
-            $stdout.puts "Processing #{path}"
-            if path =~ /\.yml$/i
-              Idiom::Yaml.new({:source => path}.merge(options)).generate
-            end
-            if path =~ /\.pres$/i
-              Idiom::Yrb.new({:source => path}.merge(options)).generate
-            end
-          end
-        end
-      end
-      
-    end
-    
-    def initialize(options={})
-      @source = File.expand_path(options[:source])
-      @overwrite = options[:overwrite]
-      @languages = options[:languages]
-      
-      @base_source = @source.gsub(/_en-US/, "")
-      
-      # base directory of the source file
-      #
-      @source_dir = File.dirname(@source)
-      
-      # if they specify the :use_dirs option, use that
-      # if not, detect whether the source path uses directories for each language
-      #
-      if options.has_key?(:use_dirs)
-        @use_dirs = options[:use_dirs]
-      else
-        @use_dirs = @source_dir =~ /\/en-US$/
-      end
-      
-      if @use_dirs
-        @source_dir = File.dirname(@source).gsub(/\/en-US$/, "")
-      end
-      @destination = options[:destination] || @source_dir
-    end
-    
-    def generate
-      copy_lines_to_all_locales
-    end
-    
-    def locales
-      @languages || LOCALES.keys
-    end
-    
-    def use_directories?
-      use_dirs
-    end
-    
-    def destination_path(lang)
-      output_path = File.basename(@base_source).split(".").first
-      if use_directories?
-        "#{destination}/#{lang}/#{output_path}_#{lang}.#{extension}"
-      else
-        "#{destination}/#{output_path}_#{lang}.#{extension}"
-      end
-    end
-    
-    def non_us_locales
-      @non_us_locales ||= locales.select do |lang|
-        lang != "en-US"
-      end
-    end
-
-    def copy_lines_to_all_locales
-      non_us_locales.each do |lang|
-        code = LOCALES[lang]
-        destination = ensure_destination_path_exists(lang)
-        new_content = each_line do |line|
-          copy_and_translate_line(line, lang)
-        end
-        write_content(destination, new_content)
-        clear_all_keys
-      end
-    end
-    
-    def ensure_destination_path_exists(lang)
-      dest = destination_path(lang)
-      dir = File.dirname(dest)
-      FileUtils.mkdir_p(dir)
-      
-      dest
-    end
-    
-    def write_content(destination, content)
-      unless content.blank?
-        $stdout.puts "Writing to #{destination}"
-        $stdout.puts content
-        $stdout.puts
-        File.open(destination, "a") do |f|
-          f.puts
-          f.puts new_translation_message
-          f.puts content
-        end
-      end        
-    end
-    
-    def new_translation_message
-      now = Time.now
-      
-      date = now.day
-      month = now.month
-      year = now.year
-      
-      timestamp = "#{month}/#{date}/#{year}"
-      output = []
-      output << "# "
-      output << "# Keys translated automatically on #{timestamp}."
-      output << "# "
-      
-      output.join("\n")
-    end
-    
-    def each_line
-      output = []
-      @lines ||= File.readlines(source)
-      
-      @lines.each do |line|
-        new_line = yield line
-        output << new_line
-      end
-      output.compact.join("\n")
-    end
-    
-    def parse(p)
-      raise "Define in child"
-    end
-    
-    def all_keys(lang)
-      unless @all_keys
-        @all_keys = {}
-        Dir[destination_file_or_directory(lang)].each do |path|
-          if File.exists?(path)
-            keys = parse(path)
-            @all_keys = @all_keys.merge(keys)
-          end
-        end
-      end
-      @all_keys
-    end
-    
-    def destination_file_or_directory(lang)
-      if use_directories?
-        dir = File.dirname(destination_path(lang))
-        "#{dir}/*.#{extension}"
-      else
-        destination_path(lang)
-      end
-    end
-    
-    def clear_all_keys
-      @all_keys = nil
-    end
-  
-    def copy_and_translate_line(line, lang)
-      line = line.split("\n").first
-      if comment?(line) || line.blank?
-        nil
-      else
-        translate_new_key(line, lang)
-      end
-    end
-    
-    def key_is_new?(k, lang)
-      k && !all_keys(lang).has_key?(k)
-    end
-    
-    def translate_new_key(line, lang)
-      k, v = key_and_value_from_line(line)
-      if @overwrite || key_is_new?(k, lang)
-        format(k, translate(v, lang))
-      else
-        nil
-      end        
-    end
-    
-    def translate(value, lang)
-      code = LOCALES[lang]
-      value = pre_process(value, lang)
-      translation = Translate.t(value, "ENGLISH", code)
-      post_process(translation, lang)
-    end
-    
-    def pre_process(value, lang)
-      vars = []
-      index = 0
-      while value =~ /(\{\d+\})/
-        vars << $1
-        value.sub!(/(\{\d+\})/, "[#{index}]")
-        index += 1
-      end
-      
-      if lang !~ /^en/ && value != value.downcase
-        value = value.capitalize
-      end
-      
-      value
-    end
-    
-    def post_process(value, lang)
-       if lang =~ /zh/
-        value.gsub!("<strong>", "")
-        value.gsub!("</strong>", "")
-      end
-
-      value.gsub!(/^#{194.chr}#{160.chr}/, "")
-
-      value.gsub!(" ]", "]")
-      value.gsub!("«", "\"")
-      value.gsub!("»", "\"")
-      value.gsub!(/\"\.$/, ".\"")
-      value.gsub!(/\\ \"/, "\\\"")
-      value.gsub!(/<\/ /, "<\/")
-      value.gsub!(/(“|”)/, "\"")
-      value.gsub!("<strong> ", "<strong>")
-      value.gsub!(" </strong>", "</strong>")
-      value.gsub!("&quot;", "\"")
-      value.gsub!("&#39;", "\"")
-      value.gsub!("&gt; ", ">")
-      
-      value.gsub!("\"", "'")
-      value.gsub!(" \"O", " \\\"O")
-
-      while value =~ /\[(\d)\]/
-        index = $1.to_i
-        value.sub!(/\[#{index}\]/, "{#{index}}")
-      end
-  
-      value.gsub!(/\((0)\)/, "{0}")
-      value.gsub!(/\((1)\)/, "{1}")
-      value.gsub!(/\((2)\)/, "{2}")
-      value.gsub!("（0）", "{0}")
 
-      value.strip
-    end
-    
-    def format(key, value)
-      raise "Define in child"
-    end
-    
-    def key_and_value_from_line(line)
-      raise "Define in child"
-    end
-  
-    def comment?(line)
-      line =~ /^[\s]*#/
-    end    
-  end
-  
-  # Usage: 
-  #   Translator::Yaml.new().copy
-  #
-  class Yaml < Base
-    def extension
-      "yml"
-    end
-    
-    def parse(path)
-      YAML.load_file(path)
-    end
-    
-    def format(key, value)
-      "#{key}: #{value}"
-    end
-    
-    def key_and_value_from_line(line)
-      if line =~ /^([^\:]+):(.*)/
-        return $1, $2.strip
-      else
-        return nil, nil
-      end
-    end
-  end
-  
-  # Usage: 
-  #   Translator::Yrb.new(:source => "./translations/en-US.pres", :destination => "./translations",
-  #   :use_dirs => false).translate
-  #
-  class Yrb < Base
-    def extension
-      "pres"
-    end
-    
-    def parse(p)
-      YRB.load_file(p)
-    end
-    
-    def format(key, value)
-      "#{key}=#{value}"
-    end
-    
-    def key_and_value_from_line(line)
-      if line =~ /^([^\=]+)=(.+)/
-        return $1, $2
-      else
-        return nil, nil
-      end
-    end
-  end
-end
+require 'idiom/base'
+require 'idiom/yrb'
+require 'idiom/yaml'

data/lib/idiom/base.rb

@@ -0,0 +1,339 @@
+module Idiom #:nodoc:
+  # Finds English language translation keys which have not been translated 
+  # and translates them through Google Translate.
+  #
+  module Directories #:nodoc:
+    def use_directories?
+      use_dirs
+    end
+    
+    def destination_path(lang)
+      output_path = File.basename(@base_source).split(".").first
+      if use_directories?
+        "#{destination}/#{lang}/#{output_path}_#{lang}.#{extension}"
+      else
+        "#{destination}/#{output_path}_#{lang}.#{extension}"
+      end
+    end
+    
+    def ensure_destination_path_exists(lang)
+      dest = destination_path(lang)
+      dir = File.dirname(dest)
+      FileUtils.mkdir_p(dir)
+      
+      dest
+    end
+    
+    def destination_file_or_directory(lang)
+      if use_directories?
+        dir = File.dirname(destination_path(lang))
+        "#{dir}/*.#{extension}"
+      else
+        destination_path(lang)
+      end
+    end    
+  end
+  
+  module Locales #:nodoc:
+    # Mapping of the way I18n country codes with the Google Translate codes.
+    #
+    # The key is the I18n representation, and the value is the code Google Translate would expect.
+    #
+    LOCALES = {
+      "de-DE" => "de",
+      "en-MY" => "en",
+      "en-SG" => "en",
+      "es-MX" => "es",
+      "it-IT" => "it",
+      "vi-VN" => "vi",
+      "zh-Hant-TW" => "zh-TW",
+      "en-AA" => "en",
+      "en-NZ" => "en",
+      "en-US" => "en",
+      "fr-FR" => "fr",
+      "ko-KR" => "ko",
+      "zh-Hans-CN" => "zh-CN",
+      "en-AU" => "en",
+      "en-PH" => "en",
+      "es-ES" => "es",
+      "id-ID" => "id",
+      "pt-BR" => "PORTUGUESE",
+      "zh-Hant-HK" => "zh-CN",
+    }
+    
+    # locales
+    
+    def non_us_locales
+      @non_us_locales ||= locales.select do |lang|
+        lang != "en-US"
+      end
+    end
+
+    def locales
+      @languages || LOCALES.keys
+    end
+  end
+  
+  module Processing #:nodoc:
+    def pre_process(value, lang)
+      vars = []
+      index = 0
+      while value =~ /(\{\d+\})/
+        vars << $1
+        value.sub!(/(\{\d+\})/, "[#{index}]")
+        index += 1
+      end
+      
+      if lang !~ /^en/ && value != value.downcase
+        value = value.capitalize
+      end
+      
+      value
+    end
+    
+    def post_process(value, lang)
+       if lang =~ /zh/
+        value.gsub!("<strong>", "")
+        value.gsub!("</strong>", "")
+      end
+
+      value.gsub!(/^#{194.chr}#{160.chr}/, "")
+
+      value.gsub!(" ]", "]")
+      value.gsub!("«", "\"")
+      value.gsub!("»", "\"")
+      value.gsub!(/\"\.$/, ".\"")
+      value.gsub!(/\\ \"/, "\\\"")
+      value.gsub!(/<\/ /, "<\/")
+      value.gsub!(/(“|”)/, "\"")
+      value.gsub!("<strong> ", "<strong>")
+      value.gsub!(" </strong>", "</strong>")
+      value.gsub!("&quot;", "\"")
+      value.gsub!("&#39;", "\"")
+      value.gsub!("&gt; ", ">")
+      
+      value.gsub!("\"", "'")
+      value.gsub!(" \"O", " \\\"O")
+
+      while value =~ /\[(\d)\]/
+        index = $1.to_i
+        value.sub!(/\[#{index}\]/, "{#{index}}")
+      end
+  
+      value.gsub!(/\((0)\)/, "{0}")
+      value.gsub!(/\((1)\)/, "{1}")
+      value.gsub!(/\((2)\)/, "{2}")
+      value.gsub!("（0）", "{0}")
+
+      value.strip
+    end    
+  end
+  
+  module ClassMethods #:nodoc:
+    def translate(options={})
+      options.stringify_keys!
+      
+      @source = options["source"]
+      @destination = options["destination"]
+      @use_dirs = options["use_dirs"]
+      
+      Timer.new.time do
+        find_and_translate_all(options)
+      end
+    end
+    
+    def source_files
+      if @source =~ /\.(yml|pres)$/
+        source_files = Dir[@source]
+      else
+        dir = File.expand_path(@source)
+        source_files = Dir["#{dir}/**/*_en-US.pres"] + Dir["#{dir}/**/*_en-US.yml"]
+        source_files.flatten!
+      end        
+    end
+    
+    def find_and_translate_all(options={})
+      options.stringify_keys!
+      
+      source_files.each do |path|
+        $stdout.puts "Processing #{path}"
+        translate_file(path, options)
+      end        
+    end
+    
+    def translate_file(path, options={})
+      options.stringify_keys!
+      if path =~ /\.yml$/i
+        Idiom::Yaml.new(options.merge({"source" => path})).generate
+      end
+      if path =~ /\.pres$/i
+        Idiom::Yrb.new(options.merge({"source" => path})).generate
+      end        
+    end
+  end
+  
+  class Base
+    extend Idiom::ClassMethods
+    include Idiom::Directories
+    include Idiom::Locales
+    include Idiom::Processing
+
+    # Original filename to translate.
+    #
+    attr_accessor :source
+    
+    # Destination directory to output the translated files to.
+    #
+    attr_accessor :destination
+    
+    # Write the translated strings into a directory for each language?
+    #
+    attr_accessor :use_dirs
+    
+    # Array of languages to translate into.
+    #
+    attr_accessor :languages
+        
+    def initialize(options={})
+      options.stringify_keys!
+      
+      @source = File.expand_path(options["source"])
+      @overwrite = options["overwrite"]
+      @languages = options["languages"]
+      
+      @base_source = @source.gsub(/_en-US/, "")
+      
+      # base directory of the source file
+      #
+      @source_dir = File.dirname(@source)
+      
+      # if they specify the :use_dirs option, use that
+      # if not, detect whether the source path uses directories for each language
+      #
+      if options.has_key?("use_dirs")
+        @use_dirs = options["use_dirs"]
+      else
+        @use_dirs = @source_dir =~ /\/en-US$/
+      end
+      
+      if @use_dirs
+        @source_dir = File.dirname(@source).gsub(/\/en-US$/, "")
+      end
+      @destination = options["destination"] || @source_dir
+    end
+    
+    def generate
+      non_us_locales.each do |lang|
+        code = LOCALES[lang]
+        destination = ensure_destination_path_exists(lang)
+        new_content = each_line do |line|
+          copy_and_translate_line(line, lang)
+        end
+        write_content(destination, new_content)
+        clear_all_keys
+      end
+    end
+    
+    def new_translation_message
+      now = Time.now
+      
+      date = now.day
+      month = now.month
+      year = now.year
+      
+      timestamp = "#{month}/#{date}/#{year}"
+      output = []
+      output << "# "
+      output << "# Keys translated automatically on #{timestamp}."
+      output << "# "
+      
+      output.join("\n")
+    end
+    
+    def each_line
+      output = []
+      @lines ||= File.readlines(source)
+      
+      @lines.each do |line|
+        new_line = yield line
+        output << new_line
+      end
+      output.compact.join("\n")
+    end
+    
+    def parse(p)
+      raise "Define in child"
+    end
+    
+    def all_keys(lang)
+      unless @all_keys
+        @all_keys = {}
+        Dir[destination_file_or_directory(lang)].each do |path|
+          if File.exists?(path)
+            keys = parse(path)
+            @all_keys = @all_keys.merge(keys)
+          end
+        end
+      end
+      @all_keys
+    end
+    
+    def clear_all_keys
+      @all_keys = nil
+    end
+    
+    def write_content(destination, content)
+      unless content.blank?
+        $stdout.puts "Writing to #{destination}"
+        $stdout.puts content
+        $stdout.puts
+        File.open(destination, "a") do |f|
+          f.puts
+          f.puts new_translation_message
+          f.puts content
+        end
+      end        
+    end
+  
+    def copy_and_translate_line(line, lang)
+      line = line.split("\n").first
+      if comment?(line) || line.blank?
+        nil
+      else
+        translate_new_key(line, lang)
+      end
+    end
+    
+    def key_is_new?(k, lang)
+      k && !all_keys(lang).has_key?(k)
+    end
+    
+    def translate_new_key(line, lang)
+      k, v = key_and_value_from_line(line)
+      if @overwrite || key_is_new?(k, lang)
+        format(k, translate(v, lang))
+      else
+        nil
+      end        
+    end
+    
+    def translate(value, lang)
+      code = LOCALES[lang]
+      value = pre_process(value, lang)
+      translation = Translate.t(value, "ENGLISH", code)
+      post_process(translation, lang)
+    end
+    
+    def format(key, value)
+      raise "Define in child"
+    end
+    
+    def key_and_value_from_line(line)
+      raise "Define in child"
+    end
+  
+    def comment?(line)
+      line =~ /^[\s]*#/
+    end    
+  end
+end

data/lib/idiom/yaml.rb

@@ -0,0 +1,28 @@
+require 'idiom/base'
+
+module Idiom #:nodoc:
+  # Usage: 
+  #   Translator::Yaml.new().copy
+  #
+  class Yaml < Base
+    def extension
+      "yml"
+    end
+    
+    def parse(path)
+      YAML.load_file(path)
+    end
+    
+    def format(key, value)
+      "#{key}: #{value}"
+    end
+    
+    def key_and_value_from_line(line)
+      if line =~ /^([^\:]+):(.*)/
+        return $1, $2.strip
+      else
+        return nil, nil
+      end
+    end
+  end
+end

data/lib/idiom/yrb.rb

@@ -0,0 +1,29 @@
+require 'idiom/base'
+
+module Idiom #:nodoc
+  # Usage: 
+  #   Translator::Yrb.new(:source => "./translations/en-US.pres", :destination => "./translations",
+  #   :use_dirs => false).translate
+  #
+  class Yrb < Base
+    def extension
+      "pres"
+    end
+    
+    def parse(p)
+      YRB.load_file(p)
+    end
+    
+    def format(key, value)
+      "#{key}=#{value}"
+    end
+    
+    def key_and_value_from_line(line)
+      if line =~ /^([^\=]+)=(.+)/
+        return $1, $2
+      else
+        return nil, nil
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: idiom
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Jeff Coleman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-22 00:00:00 -06:00
+date: 2010-01-30 00:00:00 -06:00
 default_executable: idiom
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +73,9 @@ files:
 - bin/idiom
 - idiom.gemspec
 - lib/idiom.rb
+- lib/idiom/base.rb
+- lib/idiom/yaml.rb
+- lib/idiom/yrb.rb
 - spec/idiom_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -104,7 +107,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Translate strings in Google Translate
+summary: Translate all your application's international keys in Google Translate
 test_files: 
 - spec/idiom_spec.rb
 - spec/spec_helper.rb