vocab 0.0.1

data/spec/extractor/rails_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+
+describe "Vocab::Extractor::Rails" do
+
+  describe 'write_full' do
+
+    it 'writes the full en translation to a file' do
+      translation = { :en => { :full => 'translation' } }
+      path = "#{vocab_root}/spec/tmp/en.full.yml"
+      Vocab::Extractor::Rails.write_full( translation, path )
+      YAML.load_file( path ).should eql( translation )
+      File.delete( path )
+    end
+
+  end
+
+  describe 'hasherize' do
+
+    it 'writes the diff in standard rails locale yaml format' do
+      flattened = { :"en.video_mail.kid.approve"     => "To let %{kid} start sending video mail",
+                    :"en.models.subject.id_125.name" => "Recording Data Stuff" }
+      hash = Vocab::Extractor::Rails.hasherize( flattened )
+      expected = { :en=> { :models => { :subject => { :id_125=> { :name => "Recording Data Stuff" } } },
+                           :video_mail=> { :kid=>{ :approve=>"To let %{kid} start sending video mail" } } } }
+      hash.should == expected
+    end
+
+  end
+
+  describe "previous" do
+
+    before( :each ) do
+      @last_translation = '5ab8cf4d081d7ba1d5f020118dd00c3ea2d0437a'
+      @locales_root = "spec/data/rails/locales"
+      Vocab.settings.stub!( :last_translation ).and_return( @last_translation )
+      Dir.chdir( vocab_root )
+    end
+
+    it "creates a hash of the english translation strings from the last translation" do
+      actual = Vocab::Extractor::Rails.extract_previous( @locales_root )
+      expected = { :"en.models.product.id_36.description" =>"Polarized and lazer resistant",
+                   :"en.marketing.banner"                 =>"This product is so good",
+                   :"en.models.product.id_36.name"        =>"This nested value has changed",
+                   :"en.menu.first"                       =>"First menu item",
+                   :"en.models.product.id_55.description" =>"A new nested description",
+                   :"en.models.product.id_125.description"=>"Green with megawatts",
+                   :"en.dashboard.chart"                  =>"This value has changed",
+                   :"en.models.product.id_55.name"        =>"a new nested name",
+                   :"en.models.product.id_125.name"       =>"Lazer",
+                   :"en.dashboard.details"                =>"This key/value has been added" }
+      actual.should eql( expected )
+    end
+
+    it 'creates a tmp folder if one does not exist' do
+      dir = "#{vocab_root}/tmp/last_translation"
+      FileUtils.rm_rf( "#{vocab_root}/tmp/last_translation" )
+      Vocab::Extractor::Rails.extract_previous( @locales_root )
+      File.exists?( dir ).should be_true
+    end
+
+  end
+
+  describe "current" do
+
+    before( :each ) do
+      Dir.chdir( vocab_root )
+      @locales_root = "spec/data/rails/locales"
+    end
+
+    it "creates a hash of the english translation strings currently in the config" do
+      actual = Vocab::Extractor::Rails.extract_current( @locales_root )
+      expected = { :"en.menu.second"                      =>"Second menu item",
+                   :"en.models.product.id_36.description" =>"Polarized and lazer resistant",
+                   :"en.marketing.banner"                 =>"This product is so good",
+                   :"en.models.product.id_36.name"        =>"This nested value has changed",
+                   :"en.menu.first"                       =>"First menu item",
+                   :"en.models.product.id_55.description" =>"A new nested description",
+                   :"en.models.product.id_125.description"=>"Green with megawatts",
+                   :"en.dashboard.chart"                  =>"This value has changed",
+                   :"en.models.product.id_55.name"        =>"a new nested name",
+                   :"en.models.product.id_125.name"       =>"Lazer",
+                   :"en.dashboard.details"                =>"This key/value has been added",
+                   :"en.not_in_es"                        =>"This key not in spanish" }
+      actual.should eql( expected )
+    end
+
+  end
+
+  describe "extract" do
+
+    before( :each ) do
+      @diff_path = "#{vocab_root}/spec/tmp/en.yml"
+      @full_path = "#{vocab_root}/spec/tmp/en.full.yml"
+    end
+
+    it "extracts the strings that need to be translated into a yml file" do
+      Vocab::Extractor::Rails.should_receive( :extract_current ).and_return( { :en => { 1 => 5, 3 => 4 } } )
+      Vocab::Extractor::Rails.should_receive( :extract_previous ).and_return( { :en => { 1 => 2 } } )
+      Vocab::Extractor::Rails.extract( @diff_path, @full_path )
+      YAML.load_file( @diff_path ).should == { :en => { 1 => 5, 3 => 4 } }
+
+      File.delete( @diff_path ) if File.exists?( @diff_path )
+      File.delete( @full_path ) if File.exists?( @full_path )
+    end
+
+  end
+
+  describe "examples" do
+
+    it 'returns the directory to put the yml files' do
+      Vocab::Extractor::Rails.examples.should eql( [ "#{vocab_root}/tmp/translations" ] )
+    end
+
+  end
+
+end

data/spec/merger/android_spec.rb

@@ -0,0 +1,138 @@
+# encoding: UTF-8
+
+require "spec_helper"
+
+describe "Vocab::Merger::Android" do
+
+  before( :each ) do
+    @update_dir = "#{vocab_root}/spec/data/android/translations"
+    @merge_dir = clear_merge_dir
+    FileUtils.cp_r( "#{vocab_root}/spec/data/android/locales/.", @merge_dir )
+  end
+
+  it 'defaults to reasonable android paths' do
+    merger = Vocab::Merger::Android.new
+    merger.locales_dir.should eql( 'res' )
+    merger.updates_dir.should eql( 'tmp/translations' )
+  end
+
+  it 'allows custom android paths' do
+    locales_dir = 'custom/locales/dir'
+    updates_dir = 'custom/updates/dir'
+    merger = Vocab::Merger::Android.new( locales_dir, updates_dir )
+    merger.locales_dir.should eql( locales_dir )
+    merger.updates_dir.should eql( updates_dir )
+  end
+
+  describe "merge" do
+
+    before( :each ) do
+      Vocab.settings.should_receive( :update_translation )
+      @merger = Vocab::Merger::Android.new( @merge_dir, @update_dir )
+      @merger.merge
+    end
+
+    it 'merges non-english translations' do
+      @merged = Vocab::Translator::Android.hash_from_xml( "#{@merge_dir}/values-es/strings.xml" )
+      @merged['app_name'].should eql( 'Modo Niños' )
+      @merged['pd_app_name'].should eql( 'el Panel para padres bien' )
+      @merged['delete'].should eql( "La función Child Lock" )
+    end
+
+  end
+
+  describe 'merge_file' do
+
+    before( :each ) do
+      @file = "#{@merge_dir}/values-es/strings.xml"
+      @merger = Vocab::Merger::Android.new( @merge_dir, @update_dir )
+      @merger.merge_file( @file )
+      @merged = Vocab::Translator::Android.hash_from_xml( @file )
+    end
+
+    it "merges updated android translations" do
+      @merged['pd_app_name'].should eql( 'el Panel para padres bien' )
+    end
+
+    it "integrates new android translations" do
+      @merged['cancel'].should eql( 'Cancelar' )
+    end
+
+    it "properly encodes html entities" do
+      @merged['delete'].should eql( "La función Child Lock" )
+    end
+
+    it "ignores key accidentally introduced by the translators into android translations" do
+      @merged['translator_cruft'].should be( nil )
+    end
+
+    it "retains unchanged android translations" do
+      @merged['app_name'].should eql( 'Modo Niños' )
+    end
+
+    it 'does not include keys where there is no translation' do
+      @merged['not_in_es'].should be( nil )
+    end
+
+  end
+
+  describe 'english_keys' do
+
+    it 'fetches the english keys' do
+      merger = Vocab::Merger::Android.new( @merge_dir )
+      keys = ["app_name", "delete", "cancel", "app_current", "not_in_es", "pd_app_name"]
+      merger.english_keys.should =~ keys
+    end
+
+  end
+
+  describe 'current_for_locale' do
+
+    it 'returns hash of the current translations that match a locale file' do
+      merger = Vocab::Merger::Android.new( @merge_dir )
+      expected = { "app_name"   =>"Modo Niños",
+                   "app_current"=>"actual",
+                   "pd_app_name"=>"el Panel para padres"}
+      merger.current_for_locale( "#{@merge_dir}/values-es/strings.xml" ).should == expected
+    end
+
+  end
+
+  describe 'updates' do
+
+    it 'returns hash of the updates that match a locale file' do
+      merger = Vocab::Merger::Android.new( @merge_dir, @update_dir )
+      expected = { 'cancel'           => 'Cancelar',
+                   'delete'           => "La función Child Lock",
+                   'pd_app_name'      => 'el Panel para padres bien',
+                   'translator_cruft' => 'Malo' }
+      merger.updates_for_locale( "#{@merge_dir}/values-es/strings.xml" ).should == expected
+    end
+
+  end
+
+  describe 'translation_locales' do
+
+    it 'returns the locales in the android updates directory' do
+      merger = Vocab::Merger::Android.new( @merge_dir, @update_dir )
+      locales = [ 'es' ]
+      Vocab::Translator::Android.should_receive( :locales ).with( @update_dir, false ).and_return( locales )
+      merger.translation_locales.should eql( locales )
+    end
+
+  end
+
+  describe 'files_to_merge' do
+
+    before ( :each ) do
+      @merger = Vocab::Merger::Android.new( @merge_dir, @update_dir )
+    end
+
+    it 'returns an array of files for translation' do
+      expected = ["#{@merge_dir}/values-es/strings.xml"]
+      @merger.files_to_merge.sort.should eql( expected )
+    end
+
+  end
+
+end

data/spec/merger/base_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe "Vocab::Extractor::Base" do
+
+  describe 'merge' do
+
+    before( :each ) do
+      @merger = Vocab::Merger::Base.new
+      @merger.should_receive( :update_settings )
+    end
+
+    it 'merges a list of files' do
+      files = [ 'es.yml', 'zh.yml' ]
+      @merger.should_receive( :files_to_merge ).and_return( files )
+      files.each do |file|
+        @merger.should_receive( :merge_file ).with( file )
+        Vocab.ui.should_receive( :say ).with( "Merging file: #{file}" )
+      end
+      @merger.merge
+    end
+
+  end
+
+end

data/spec/merger/rails_spec.rb

@@ -0,0 +1,183 @@
+# encoding: UTF-8
+
+require "spec_helper"
+require "fileutils"
+
+describe "Vocab::Merger::Rails" do
+
+  def init_merge_dir
+    @merge_dir = clear_merge_dir
+    FileUtils.cp_r( "#{vocab_root}/spec/data/rails/locales/.", @merge_dir )
+    return @merge_dir
+  end
+
+  it 'defaults to reasonable paths' do
+    merger = Vocab::Merger::Rails.new
+    merger.locales_dir.should eql( 'config/locales' )
+    merger.updates_dir.should eql( 'tmp/translations' )
+  end
+
+  it 'allows custom paths' do
+    locales_dir = 'custom/locales/dir'
+    updates_dir = 'custom/updates/dir'
+    merger = Vocab::Merger::Rails.new( locales_dir, updates_dir )
+    merger.locales_dir.should eql( locales_dir )
+    merger.updates_dir.should eql( updates_dir )
+  end
+
+  describe "merge_file" do
+
+    before( :each ) do
+      init_merge_dir
+      @file = "#{@merge_dir}/es.yml"
+      @update_dir = "#{vocab_root}/spec/data/rails/translations"
+
+      @merger = Vocab::Merger::Rails.new( @merge_dir, @update_dir )
+      @merger.merge_file( @file )
+      @merged = YAML.load_file( @file )
+    end
+
+    it "merges updated translations" do
+      @merged[:es][:marketing][:banner].should eql( 'hola mi amigo' )
+    end
+
+    it "ignores key accidentally introduced by the translators" do
+      @merged[:es][:translator_cruft].should be( nil )
+    end
+
+    it "retains unchanged translations" do
+      @merged[:es][:dashboard][:chart].should eql( 'Es muy bonita' )
+    end
+
+    it "does not include translations from nested files" do
+      @merged[:es][:models].should eql( nil )
+    end
+
+    it "does not include translations from other languages" do
+      @merged[:es][:marketing][:banner].should_not eql( '這改變了營銷信息' )
+    end
+
+    it 'does not include keys where there is no translation in yml' do
+      @merged[:es].keys.should_not include( :not_in_es )
+    end
+
+  end
+
+  describe "create_file" do
+
+    before( :each ) do
+      init_merge_dir
+      @file = "#{@merge_dir}/cn.yml"
+      @update_dir = "#{vocab_root}/spec/data/rails/translations"
+    end
+
+    it "creates a file for missing translations" do
+      File.exists?( @file ).should be_false
+      @merger = Vocab::Merger::Rails.new( @merge_dir, @update_dir )
+      @merger.merge_file( @file )
+      File.exists?( @file ).should be_true
+
+      @merged = YAML.load_file( @file )
+      @merged[:cn][:marketing][:banner].should eql( '這改變了營銷信息' )
+      @merged[:cn][:translator_cruft].should eql( nil )
+    end
+
+  end
+
+  describe "merge" do
+
+    before( :each ) do
+      init_merge_dir
+      @update_dir = "#{vocab_root}/spec/data/rails/translations"
+      Vocab.settings.should_receive( :update_translation )
+      @merger = Vocab::Merger::Rails.new( @merge_dir, @update_dir )
+      @merger.merge
+    end
+
+    it 'merges nested files' do
+      @merged = YAML.load_file( "#{@merge_dir}/models/product/es.yml" )
+      @merged[:es][:models][:product][:id_125][:description].should eql( 'mucho Verde' )
+      @merged[:es][:models][:product][:id_125][:name].should eql( 'mucho Lazero' )
+      @merged[:es][:models][:product][:id_55][:description].should eql( 'Azul' )
+      @merged[:es][:models][:product][:id_55][:name].should eql( 'Muy bonita' )
+    end
+
+    it 'merges non-english translations' do
+      @merged = YAML.load_file( "#{@merge_dir}/es.yml" )
+      @merged[:es][:marketing][:banner].should eql( 'hola mi amigo' )
+      @merged[:es][:dashboard][:chart].should eql( 'Es muy bonita' )
+      @merged[:es][:menu][:first].should eql( 'Uno' )
+    end
+
+  end
+
+  describe "keys_for_file" do
+
+    it "returns the keys that should be in a file" do
+      path = "#{vocab_root}/spec/data/rails/locales/es.yml"
+      actual = Vocab::Merger::Rails.keys_for_file( path )
+      expected = [:"dashboard.details", :"menu.first", :"dashboard.chart", :"menu.second", :"marketing.banner", :"not_in_es"]
+      actual.each { |key| expected.should include( key ) }
+      actual.size.should eql( expected.size )
+    end
+
+  end
+
+  describe "translatable?" do
+
+    before( :each ) do
+      @merger = Vocab::Merger::Rails.new
+    end
+
+    it "doesn't translate english files because that should be the reference language anyway" do
+      @merger.translatable?( "#{vocab_root}/spec/data/rails/locales/es.yml" ).should be_true
+      @merger.translatable?( "#{vocab_root}/spec/data/rails/locales/en.yml" ).should be_false
+    end
+
+    it "ignores files that don't have matching filename and contents" do
+      spanish_file = "#{vocab_root}/spec/tmp/es.yml"
+      english_file = Vocab::Translator::Rails.en_equivalent_path( spanish_file )
+      english_contents = { :en => { :english => 'stuff here' } }
+      File.open( spanish_file, 'w+' ) { |file| file.write( english_contents.to_yaml ) }
+      File.open( english_file, 'w+' ) { |file| file.write( english_contents.to_yaml ) }
+      Vocab.ui.should_receive( :warn ).with( "File extension does not match file contents in #{spanish_file}" )
+      @merger.translatable?( spanish_file ).should be_false
+      File.delete( spanish_file ) if File.exists?( spanish_file )
+      File.delete( english_file ) if File.exists?( english_file )
+    end
+
+  end
+
+  describe 'translation_locales' do
+
+    before ( :each ) do
+      @updates_dir = "#{vocab_root}/spec/data/rails/translations"
+      @merger = Vocab::Merger::Rails.new
+      @merger.updates_dir = @updates_dir
+    end
+
+    it 'returns a list of locales in the translations' do
+      @merger.translation_locales.sort.should eql( [ 'cn', 'es' ] )
+    end
+
+  end
+
+  describe 'files_to_merge' do
+
+    before ( :each ) do
+      @locales_dir = "#{vocab_root}/spec/data/rails/locales"
+      @updates_dir = "#{vocab_root}/spec/data/rails/translations"
+      @merger = Vocab::Merger::Rails.new( @locales_dir, @updates_dir )
+    end
+
+    it 'returns an array of files for translation' do
+      expected = ["#{@locales_dir}/cn.yml",
+                  "#{@locales_dir}/es.yml",
+                  "#{@locales_dir}/models/product/cn.yml",
+                  "#{@locales_dir}/models/product/es.yml"]
+      @merger.files_to_merge.sort.should eql( expected )
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require "vocab"
+require "support/matchers"
+require "support/shared"
+
+Vocab.ui.silent = true
+
+RSpec.configure do |config|
+  config.include Vocab::Spec::Matchers
+end
+
+def vocab_root
+  return File.expand_path( '../..', __FILE__ )
+end
+
+def should_eql_file( actual, path )
+  @tmp = File.open( "#{vocab_root}/#{path}.tmp","wb") { |io| io.write actual }
+  @expected = File.open("#{vocab_root}/#{path}","rb") {|io| io.read }
+  actual.chomp.strip.should eql( @expected.chomp.strip )
+end

data/spec/support/matchers.rb

@@ -0,0 +1,13 @@
+module Vocab
+  module Spec
+    module Matchers
+      #def be_awesome
+      #  RSpec::Matchers::Matcher.new :be_awesome do
+      #    match do |actual|
+      #      actual.should == "awesome"
+      #    end
+      #  end
+      #end
+    end
+  end
+end

data/spec/support/shared.rb

@@ -0,0 +1,6 @@
+def clear_merge_dir
+  merge_dir = "#{vocab_root}/spec/tmp/merge"
+  FileUtils.rm_rf( merge_dir ) if File.exists?( merge_dir )
+  FileUtils.mkdir_p( merge_dir )
+  return merge_dir
+end

data/spec/translator/android_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe 'Vocab::Translator::Android' do
+
+  describe 'english_keys' do
+
+    it 'returns the english keys for a locales dir' do
+      locales_dir = "#{vocab_root}/spec/data/android/locales"
+      expected = ["app_name", "delete", "cancel", "app_current", "not_in_es", "pd_app_name"]
+      Vocab::Translator::Android.english_keys( locales_dir ).should =~ expected
+    end
+
+  end
+
+  describe 'locales' do
+
+    it 'returns the locales in the android updates directory' do
+      dir = "#{vocab_root}/spec/data/android/translations"
+      Vocab::Translator::Android.locales( dir, false ).should eql( [ 'es' ] )
+    end
+
+  end
+
+end