babelphish 0.1.7 → 0.2.0

data/README.rdoc

@@ -14,15 +14,43 @@ Translate the en.yml file into all supported languages:
 Translate the en.yml file into all supported languages and overwrite other yml files:
   babelphish -y ./my/locales/en.yml -o
 
-== INSTALL:
+=== Using in your application
+Babelphish can be used to translate content programmatically within your application.  Use it thus:
+
+Translate content into a single language:
+  from = 'en'
+  to = 'es'
+  translation = Babelphish::Translator.translate('hello world', to, from)
 
-ya2yaml should be automatically install, but in case they aren't:
+Translate content into all supported languages at once.  This will return a hash table with the locale as keys (ie 'en', 'es', etc).
+  translations = Babelphish::Translator.multiple_translate('hello world', Babelphish::GoogleTranslate::LANGUAGES, self.locale)
+  
+Here's a more extensive example
+  # Translate title and body using Google
+  def translate()
+    translate_from_locale = 'en'
+    title_translations = Babelphish::Translator.multiple_translate(self.title, Babelphish::GoogleTranslate::LANGUAGES, translate_from_locale)
+    body_translations = Babelphish::Translator.multiple_translate(self.body, Babelphish::GoogleTranslate::LANGUAGES, translate_from_locale)
+    
+    Babelphish::GoogleTranslate::LANGUAGES.each do |language|
+      self.content_translations.create!(:title => title_translations[language], 
+                                        :body => body_translations[language],
+                                        :locale => language)
+      end
+    end
+  end
 
-ya2yaml is required to properly write utf8 yaml files.  Install it first.
+== INSTALL:
+
+ya2yaml should be automatically installed when you install babelphish, but is isn't:
 
 * sudo gem install ya2yaml  
 * sudo gem install babelphish
 
+== Related Blog Posts
+http://www.justinball.com/2009/05/19/babelphish-yml-translation-made-simple/comment-page-1/
+
+
 == LICENSE:
 
 (The MIT License)

data/bin/babelphish

@@ -6,14 +6,18 @@ require 'babelphish'
 task = :babelphish
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: babelphish [options]"
-  opts.on('-y', '--yaml yml', "Required.  Path to the yml file to be translated") { |yml| ENV['yml'] = yml }
+  opts.banner = "Usage: babelphish [options] "
+  opts.on('-y', '--yaml yml', "Path to the yml file to be translated") { |yml| ENV['yml'] = yml }
+  opts.on('-h', '--html html', "Path to the directory containing erb files to be translated") { |html| ENV['html'] = html }
+  opts.on('-l', '--language language', "Required if using 'html' option.  This specifies the source language for the html or erb files") { |language| ENV['language'] = language }
   opts.on('-o', '--overwrite', "Overwrite existing translations(default 'false')") { ENV['overwrite'] = 'yes' }
   opts.on('-t', '--translate_to to', "Only translate from the source file to a specific language (ie -t es will only translate to Spanish)") { |to| ENV['translate_to'] = to }
 end.parse!
 
-if Babelphish.load_tasks
-  Rake::Task[task].invoke
-else
-  STDERR.puts "Can't find Rakefile. Are we in a Rails folder?"
-end
+Babelphish.load_tasks
+
+# if Babelphish.load_tasks
+#   Rake::Task[task].invoke
+# else
+#   STDERR.puts "Can't find Rakefile. Are we in a Rails folder?"
+# end

data/lib/babelphish.rb

@@ -29,11 +29,13 @@ end
 require File.dirname(__FILE__) + '/../lib/babelphish/translator'
 require File.dirname(__FILE__) + '/../lib/babelphish/languages'
 require File.dirname(__FILE__) + '/../lib/babelphish/exceptions'
+require File.dirname(__FILE__) + '/../lib/babelphish/yml_translator'
+require File.dirname(__FILE__) + '/../lib/babelphish/html_translator'
 
 $KCODE = 'UTF8'
   
 module Babelphish
-  VERSION = '0.1.7'
+  VERSION = '0.2.0'
   GOOGLE_AJAX_URL = "http://ajax.googleapis.com/ajax/services/language/"
   MAX_RETRIES = 3
   

data/lib/babelphish/translator.rb

@@ -2,128 +2,9 @@ module Babelphish
   module Translator
 
     class << self
-      
-      def translate_yaml(yml, overwrite = false, translate_to = nil)
-        @yml = yml
-        language = File.basename(yml, ".yml")
-        if !Babelphish::GoogleTranslate::LANGUAGES.include?(language)
-          STDERR.puts "#{language} is not one of the available languages.  Please choose a standard localized yml file.  i.e. en.yml."
-          return
-        end
-        if translate_to
-          puts "Translating #{language} to #{translate_to}"
-          translate_and_write_yml(yml, translate_to, language, overwrite)
-          puts "Finished translating #{language} to #{translate_to}"
-        else
-          # Babelphish::GoogleTranslate::LANGUAGES.each do |to|
-          #   puts "Translating #{language} to #{to}"
-          #   translate_and_write_yml(yml, to, language, overwrite)
-          #   puts "Finished translating #{language} to #{to}"
-          # end
-          tos = Babelphish::GoogleTranslate::LANGUAGES
-          translate_and_write_many_yml(yml, tos, language, overwrite)
-        end
-      end
-
-      def translate_and_write_many_yml(yml, tos, from, overwrite)
-        return unless File.exist?(yml)
-        source = YAML.load_file(yml)
-        translated_source = YAML.load_file(yml)
-        translate_many_keys(translated_source, tos, from)
-        # At this point translated_source contains a translation for every language.  Cut it apart into individual hashes
-        tos.each do |to|
-          next if to == from # don't want to overwrite the source file
-          extracted_translation = {}
-          extract_translation(source, translated_source, extracted_translation, to)
-          # change the top level key from the source language to the destination language
-          translated_filename = File.join(File.dirname(yml), "#{to}.yml")
-          return if File.exist?(translated_filename) && !overwrite
-          extracted_translation[to] = extracted_translation[from]
-          extracted_translation.delete(from)
-          File.open(translated_filename, 'w') { |f| f.write(extracted_translation.ya2yaml) }
-        end
-      end
-
-      def extract_translation(source, translated_source, extracted, language)
-        source.each_key do |key|
-          if source[key].is_a?(Hash)
-            extracted[key] = {}
-            extract_translation(source[key], translated_source[key], extracted[key], language)
-          else
-            extracted[key] = translated_source[key][language]
-          end
-        end
-      end
-          
-      def translate_many_keys(translate_hash, tos, from)
-        translate_hash.each_key do |key|
-          if translate_hash[key].is_a?(Hash)
-            translate_many_keys(translate_hash[key], tos, from)
-          else
-            if key == false
-              puts "Key #{key} was evaluated as false.  Check your yml file and be sure it does not include values like no: No"
-            elsif key == true
-              puts "Key #{key} was evaluated as true.  Check your yml file and be sure it does not include values like yes: Yes"
-            elsif !translate_hash[key].nil?
-              # pull out all the string substitutions so that google doesn't translate those
-              pattern = /\{\{.+\}\}/
-              holder = '{{---}}'
-              replacements = translate_hash[key].scan(pattern)
-              translate_hash[key].gsub!(pattern, holder)
-              translations = multiple_translate(translate_hash[key], tos, from)
-              translations.each_key do |locale|
-                replacements.each do |r|
-                  translations[locale].sub!(holder, r)
-                end
-              end
-              translate_hash[key] = translations
-            else
-              puts "Key #{key} contains no data"
-            end
-          end
-        end
-      end
-      
-      def translate_and_write_yml(yml, to, from, overwrite)
-        return if to == from
-        return unless File.exist?(yml)
-        translated_filename = File.join(File.dirname(yml), "#{to}.yml")
-        return if File.exist?(translated_filename) && !overwrite
-        source = YAML.load_file(yml)
-        translate_keys(source, to, from)
-        # change the top level key from the source language to the destination language
-        source[to] = source[from]
-        source.delete(from)
-        File.open(translated_filename, 'w') { |f| f.write(source.ya2yaml) }
-      end
-
-      def translate_keys(translate_hash, to, from)
-        translate_hash.each_key do |key|
-          if translate_hash[key].is_a?(Hash)
-            translate_keys(translate_hash[key], to, from)
-          else
-            if key == false
-              puts "Key #{key} was evaluated as false.  Check your yml file and be sure to escape values like no with 'no'.  ie 'no': 'No'"
-            elsif key == true
-              puts "Key #{key} was evaluated as true.  Check your yml file and be sure to escape values like yes with 'yes'. ie 'yes': 'Yes'"
-            elsif !translate_hash[key].nil?
-              # pull out all the string substitutions so that google doesn't translate those
-              pattern = /\{\{.+\}\}/
-              holder = '{{---}}'
-              replacements = translate_hash[key].scan(pattern)
-              translate_hash[key].gsub!(pattern, holder)
-              translate_hash[key] = translate(translate_hash[key], to, from)
-              replacements.each do |r|
-                translate_hash[key].sub!(holder, r)
-              end
-            else
-              puts "Key #{key} contains no data"
-            end
-          end
-        end
-      end
 
       # from: http://ruby.geraldbauer.ca/google-translation-api.html
+      # translate text from 'from' to 'to'
       def translate(text, to, from = 'en', tries = 0)
 
         return if to == from
@@ -145,16 +26,12 @@ module Babelphish
             # Try again a few more times
             translate(text, to, from, tries+=1)
           else
-            puts "A problem occured while translating from #{from} to #{to}. "
-            puts "#{json['responseDetails']} "
-            puts "To retry only this translation try: 'babelphish -o -y #{@yml} -t #{to}' to retry the translation.  Response: #{response}" if defined?(@yml)
-            raise Exceptions::GoogleResponseError, "#{json['responseDetails']}"
+            raise Exceptions::GoogleResponseError, "A problem occured while translating from #{from} to #{to}.  #{json['responseDetails']}"
           end
         end
       end
 
       # translate from the 'from' language into all available languages
-
       # multiple strings and multiple languages
       #
       # http://ajax.googleapis.com/ajax/services/language/translate?v=1.0&q=hello%20world&langpair=en|it&q=goodbye&langpair=en|fr
@@ -198,7 +75,7 @@ module Babelphish
             # Try again a few more times
             multiple_translate(text, tos, from, tries+=1)
           else
-            puts "A problem occured while translating. Response: #{response}"
+            raise Exceptions::GoogleResponseError, "A problem occured while translating.  #{response}"
           end
         end
       end

data/lib/tasks/babelphish.rake

@@ -3,13 +3,21 @@ task :babelphish do
   require 'babelphish/translator'
   options={}
   yml = ENV['yml']
+  html = ENV['html']
+  language = ENV['language']
   overwrite = ENV['overwrite'] == 'yes'
   translate_to = ENV['translate_to'] || nil
   
   if yml
-    Babelphish::Translator.translate_yaml(yml, overwrite, translate_to)
+    Babelphish::YmlTranslator.translate(yml, overwrite, translate_to)
+  elsif html
+    if language.blank?
+      STDERR.puts "No source language specified when using 'html' option.  Defaulting to 'en'"
+      language = 'en'
+    end
+    Babelphish::HtmlTranslator.translate(html, Babelphish::GoogleTranslate::LANGUAGES, language, overwrite)
   else
-    STDERR.puts "Please specify the directory where your files live. i.e. babelphish -d ./my/locales"
+    STDERR.puts "Please specify the directory where your files live. i.e. babelphish -y ./my/locales  or babelphish -h ./some/directory/with/erb_or_html/files"
   end
   
 end

data/test/test_babelphish.rb

@@ -36,30 +36,4 @@ class TestBabelphish < Test::Unit::TestCase
     assert_equal Babelphish::Translator.supported_languages, Babelphish::GoogleTranslate::LANGUAGES
   end
   
-  def test_single_yml_translation
-    overwrite = true
-    translate_to = 'es'
-    yml = File.join(File.dirname(__FILE__), 'translations', 'en.yml')
-    Babelphish::Translator.translate_yaml(yml, overwrite, translate_to)
-    translated_yml = File.join(File.dirname(__FILE__), 'translations', "#{translate_to}.yml")
-    translation = YAML.load_file(translated_yml)
-    assert translation['es']
-    assert translation['es']['babelphish']
-    assert_equal "Este es un nivel más bajo", translation['es']['babelphish']['more']['test_more']
-    assert_equal "Esto es una prueba de cadenas", translation['es']['babelphish']['test']
-    assert_equal "Esta es una cadena con la incorporación {{insert}}", translation['es']['babelphish']['test_embedded']
-  end
-  
-  def test_multiple_yml_translation
-    overwrite = true
-    yml = File.join(File.dirname(__FILE__), 'translations', 'en.yml')
-    Babelphish::Translator.translate_yaml(yml, overwrite)
-    Babelphish::GoogleTranslate::LANGUAGES.each do |to|
-      translated_yml = File.join(File.dirname(__FILE__), 'translations', "#{to}.yml")
-      translation = YAML.load_file(translated_yml)
-      assert translation[to]
-      assert translation[to]['babelphish']['test_embedded'].include?("{{insert}}")
-    end
-  end
-  
 end

data/test/test_html_translator.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestHtmlTranslator < Test::Unit::TestCase
+
+  def test_html_translation
+    overwrite = true
+    translate_from = 'en'
+    directory = File.join(File.dirname(__FILE__), 'html_translations')
+    Babelphish::HtmlTranslator.translate(directory, Babelphish::GoogleTranslate::LANGUAGES, translate_from, overwrite)
+    Babelphish::GoogleTranslate::LANGUAGES.each do |to|
+      if to != translate_from
+        # This will make sure the file was created
+        translated_html = File.join(File.dirname(__FILE__), 'html_translations', "test.#{to}.html.erb")
+        text = IO.read(translated_html)
+        # Make sure the translation didn't remove code
+        assert text.include?("<%= 'Some ruby code' %>")
+        assert text.include?('<%= "test something else #{variable}" %>')
+      end
+    end
+  end
+  
+end

data/test/test_yml_translator.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestYmlTranslator < Test::Unit::TestCase
+  
+  def test_single_yml_translation
+    overwrite = true
+    translate_to = 'es'
+    yml = File.join(File.dirname(__FILE__), 'translations', 'en.yml')
+    Babelphish::YmlTranslator.translate(yml, overwrite, translate_to)
+    translated_yml = File.join(File.dirname(__FILE__), 'translations', "#{translate_to}.yml")
+    translation = YAML.load_file(translated_yml)
+    assert translation['es']
+    assert translation['es']['babelphish']
+    assert_equal "Este es un nivel más bajo", translation['es']['babelphish']['more']['test_more']
+    assert_equal "Esto es una prueba de cadenas", translation['es']['babelphish']['test']
+    assert_equal "Esta es una cadena con la incorporación {{insert}}", translation['es']['babelphish']['test_embedded']
+  end
+  
+  def test_multiple_yml_translation
+    overwrite = true
+    yml = File.join(File.dirname(__FILE__), 'translations', 'en.yml')
+    Babelphish::YmlTranslator.translate(yml, overwrite)
+    Babelphish::GoogleTranslate::LANGUAGES.each do |to|
+      translated_yml = File.join(File.dirname(__FILE__), 'translations', "#{to}.yml")
+      translation = YAML.load_file(translated_yml)
+      assert translation[to]
+      assert translation[to]['babelphish']['test_embedded'].include?("{{insert}}")
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: babelphish
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors: 
 - Justin Ball
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-04 00:00:00 -06:00
+date: 2009-07-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,3 +102,5 @@ summary: Translate with Google like a fule => 'fool'
 test_files: 
 - test/test_babelphish.rb
 - test/test_helper.rb
+- test/test_html_translator.rb
+- test/test_yml_translator.rb