vocab 0.0.1

data/lib/vocab/translator/rails.rb

@@ -0,0 +1,67 @@
+# Warning: this object has some sharp edges because it is an unusual use of the i18n gem
+# For example:
+#   - we are calling private methods
+#   - instances share the I18n.load_path, which could lead to unexpected behavior
+
+module Vocab
+  module Translator
+    class Rails < Base
+
+      attr_accessor :locale
+
+      def initialize( locale = :en )
+        @backend = I18n::Backend::Simple.new
+        @locale = locale
+      end
+
+      def load_dir( dir )
+        I18n.load_path = Dir.glob( "#{dir}/**/*.{yml,rb}" )
+        load_translations
+      end
+
+      def load_file( file )
+        @locale = File.basename( file ).gsub( /\..*$/, '' ).to_sym
+        I18n.load_path = [ file ]
+        load_translations
+      end
+
+      def write_file( file )
+        yaml = { @locale => self.translations }.to_yaml
+        File.open( file, 'w+' ) { |f| f.write( yaml ) }
+      end
+
+      def translations( options = {} )
+        t = @backend.send(:translations)
+        trans = t[ @locale ]
+        return options[ :prefix ] == true ? { @locale => trans } : trans
+      end
+
+      def flattened_translations( options = {} )
+        return @backend.flatten_translations( @locale, translations( options ), true, false )
+      end
+
+      def store( key, value )
+        keys = I18n.normalize_keys( @locale, key, [], nil)
+        keys.shift # remove locale
+        data = keys.reverse.inject( value ) { |result, _key| { _key => result } }
+        @backend.store_translations( @locale, data )
+      end
+
+      def fetch( key )
+        return flattened_translations[ key.to_sym ]
+      end
+
+      def self.en_equivalent_path( path )
+        return "#{File.dirname( path )}/en.yml"
+      end
+
+    private
+
+      def load_translations
+        @backend.reload!
+        @backend.send( :init_translations )
+      end
+
+    end
+  end
+end

data/lib/vocab/translator.rb

@@ -0,0 +1,7 @@
+module Vocab
+  module Translator
+    autoload :Android, 'vocab/translator/android'
+    autoload :Base, 'vocab/translator/base'
+    autoload :Rails, 'vocab/translator/rails'
+  end
+end

data/lib/vocab/ui.rb

@@ -0,0 +1,19 @@
+module Vocab
+  class UI
+
+    attr_accessor :silent
+
+    def initialize()
+      @silent = false
+    end
+
+    def say( message )
+      puts message unless silent
+    end
+
+    def warn( message )
+      say( "Warning: #{message}" )
+    end
+
+  end
+end

data/lib/vocab/validator/android.rb

@@ -0,0 +1,23 @@
+module Vocab
+  module Validator
+    class Android < Base
+
+      def initialize( locales_dir = nil )
+        @locales_dir = locales_dir || 'res'
+      end
+
+      def other_keys( path )
+        return Vocab::Translator::Android.hash_from_xml( path ).keys
+      end
+
+      def english_keys( path = nil )
+        return Vocab::Translator::Android.english_keys( @locales_dir )
+      end
+
+      def files_to_validate
+        return Dir.glob( "#{@locales_dir}/values-*/strings.xml" )
+      end
+
+    end
+  end
+end

data/lib/vocab/validator/base.rb

@@ -0,0 +1,40 @@
+module Vocab
+  module Validator
+    class Base
+
+      def validate
+        files = files_to_validate
+        Vocab.ui.say( "#{files.size} file(s) to validate in #{@locales_dir}" )
+        files.each do |path|
+          validation = validate_file( path )
+          print( path, validation )
+        end
+      end
+
+      def print( path, validation )
+        Vocab.ui.say( "Validating: #{path}" )
+
+        unless validation[ :missing ].empty?
+          Vocab.ui.say( "  Missing keys:" )
+          validation[ :missing ].each { |missing| Vocab.ui.say( "    - #{missing}" ) }
+        end
+
+        unless validation[ :extra ].empty?
+          Vocab.ui.say( "  Extra keys:" )
+          validation[ :extra ].each { |extra| Vocab.ui.say( "    + #{extra}" ) }
+        end
+      end
+
+      def validate_file( path )
+        other = other_keys( path )
+        english = english_keys( path )
+
+        result = {}
+        result[ :missing ] = ( english - other ).sort
+        result[ :extra ] = ( other - english ).sort
+        return result
+      end
+
+    end
+  end
+end

data/lib/vocab/validator/rails.rb

@@ -0,0 +1,31 @@
+module Vocab
+  module Validator
+    class Rails < Base
+
+      def initialize( locales_dir = nil )
+        @locales_dir = locales_dir || 'config/locales'
+      end
+
+      def other_keys( path )
+        return flattened_keys( path )
+      end
+
+      def english_keys( path )
+        return flattened_keys( Vocab::Translator::Rails.en_equivalent_path( path ) )
+      end
+
+      def files_to_validate
+        return Dir.glob( "#{@locales_dir}/**/*.yml" ).reject { |path| File.basename( path ) == 'en.yml' }
+      end
+
+    protected
+
+      def flattened_keys( path )
+        translator = Vocab::Translator::Rails.new
+        translator.load_file( path )
+        return translator.flattened_translations.keys.collect { |key| key.to_s }
+      end
+
+    end
+  end
+end

data/lib/vocab/validator.rb

@@ -0,0 +1,7 @@
+module Vocab
+  module Validator
+    autoload :Android, 'vocab/validator/android'
+    autoload :Base,    'vocab/validator/base'
+    autoload :Rails,   'vocab/validator/rails'
+  end
+end

data/lib/vocab/version.rb

@@ -0,0 +1,3 @@
+module Vocab
+  VERSION = "0.0.1"
+end

data/lib/vocab.rb

@@ -0,0 +1,36 @@
+require 'fileutils'
+require 'i18n'
+require 'pathname'
+require 'nokogiri'
+
+require 'vocab/application'
+require 'vocab/extractor'
+require 'vocab/translator'
+require 'vocab/merger'
+require 'vocab/settings'
+require 'vocab/ui'
+require 'vocab/validator'
+require 'vocab/version'
+
+I18n::Backend::Simple.send( :include, I18n::Backend::Flatten )
+
+module Vocab
+
+  class << self
+    def settings
+      @settings ||= Settings.new( root )
+    end
+
+    def ui
+      @ui ||= UI.new
+    end
+
+    # Returns root directory where .vocab is located
+    # TODO: make this work in subdirectory under .vocab
+    def root
+      return File.expand_path( Dir.pwd )
+    end
+
+  end
+
+end

data/spec/application_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe "init" do
+
+  before( :each ) do
+    @tmpdir = File.join( vocab_root, "spec", "tmp" )
+    FileUtils.rm_rf( Dir.glob( "#{@tmpdir}/*" ) )
+    Dir.chdir( @tmpdir )
+  end
+
+  it "creates a .vocab file if one doesn't exist" do
+    Vocab.ui.should_receive( :say ).with( "Writing new .vocab file.  Check this file into your project repo" )
+    Vocab::Settings.create
+    path = "#{@tmpdir}/.vocab"
+    File.exists?( path ).should be_true
+    YAML.load_file( path ).should == { "last_translation" => `git rev-parse HEAD`.strip }
+    `git rm -f #{path}`
+  end
+
+end

data/spec/data/android/current.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="app_name">Kid Mode</string>
+    <string name="pd_app_name">Parent Dashboard</string>
+    <string name="app_current">current</string>
+    <string name="cancel">Cancel</string>
+    <string name="delete">Delete</string>
+</resources>

data/spec/data/android/locales/values/strings.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="app_name">Kid Mode</string>
+    <string name="pd_app_name">Parent Dashboard</string>
+    <!-- This is a comment -->
+    <string name="app_current">current</string>
+    <string name="cancel">Cancel</string>
+    <string name="delete">Delete</string>
+    <string name="not_in_es">This key not in spanish</string>
+</resources>

data/spec/data/android/locales/values-es/strings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="app_name">Modo Niños</string>
+    <string name="pd_app_name">el Panel para padres</string>
+    <string name="app_current">actual</string>
+</resources>

data/spec/data/android/locales/values-large-hdpi/dimens.xml

@@ -0,0 +1 @@
+This is just a decoy

data/spec/data/android/locales/values-large-hdpi/styles.xml

@@ -0,0 +1 @@
+This is just a decoy

data/spec/data/android/previous.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="app_name">Kid Mode</string>
+    <string name="pd_app_name">Parent Dashboard</string>
+    <string name="app_current">current</string>
+</resources>

data/spec/data/android/translations/values-es/es-string-file.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+  <string name="cancel">Cancelar</string>
+  <string name="delete">La funci&oacute;n Child Lock</string>
+  <string name="pd_app_name">el Panel para padres bien</string>
+  <string name="translator_cruft">Malo</string>
+</resources>

data/spec/data/android/write.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<resources>
+  <string name="app_name">Kid Mode</string>
+  <string name="delete">La funci&amp;#xF3;n Child Lock</string>
+  <string name="pd_app_name">Parent Dashboard</string>
+</resources>

data/spec/data/rails/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  marketing:
+    banner: This product is so good
+  dashboard:
+    chart: This value has changed
+    details: This key/value has been added
+  menu:
+    first: First menu item
+    second: Second menu item
+  not_in_es: This key not in spanish

data/spec/data/rails/locales/es.yml

@@ -0,0 +1,6 @@
+es:
+  marketing:
+    banner: hola
+  dashboard:
+    chart: Es muy bonita
+    details: grande

data/spec/data/rails/locales/models/product/en.yml

@@ -0,0 +1,13 @@
+--- 
+en: 
+  models: 
+    product:
+      id_125: 
+        description: Green with megawatts
+        name: Lazer
+      id_36: 
+        description: Polarized and lazer resistant
+        name: This nested value has changed
+      id_55:
+        description: A new nested description
+        name: a new nested name

data/spec/data/rails/locales/models/product/es.yml

@@ -0,0 +1,13 @@
+---
+es:
+  models:
+    product:
+      id_125:
+        description: Verde
+        name: Lazero
+      id_36:
+        description: Negro
+        name: No Lazero
+      id_55:
+        description: Azul
+        name: Muy bonita

data/spec/data/rails/translations/cn.yml

@@ -0,0 +1,21 @@
+cn:
+  marketing:
+    banner: 這改變了營銷信息
+  dashboard:
+    chart: 此值已更改
+    details: 此鍵 /值已添加
+  menu:
+    first: 第一個菜單項
+    second: 第二個菜單項
+  models:
+    product:
+      id_125:
+        description: 綠色與兆瓦
+        name: 休閒
+      id_36:
+        description: 極化和激光耐
+        name: 此嵌套值已更改
+      id_55:
+        description: 一個新的嵌套描述
+        name: 一個新的嵌套的名稱
+  translator_cruft: 這是不小心添加了一個翻譯

data/spec/data/rails/translations/es.yml

@@ -0,0 +1,12 @@
+es:
+  menu:
+    first: Uno
+    second: Dos
+  marketing:
+    banner: hola mi amigo
+  models:
+    product:
+      id_125:
+        description: mucho Verde
+        name: mucho Lazero
+  translator_cruft: estúpido

data/spec/extractor/android_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+
+describe "Vocab::Extractor::Android" do
+
+  before( :each ) do
+    @locale = "#{vocab_root}/spec/data/android/locales/values/strings.xml"
+  end
+
+  describe 'extract_current' do
+
+    it "extracts hash of current string translations" do
+      actual = Vocab::Extractor::Android.extract_current( @locale )
+      actual.should eql( { "app_name"   =>"Kid Mode",
+                           "delete"     =>"Delete",
+                           "cancel"     =>"Cancel",
+                           "app_current"=>"current",
+                           "pd_app_name"=>"Parent Dashboard",
+                           "not_in_es"  =>"This key not in spanish",} )
+    end
+
+  end
+
+  describe 'extract_previous' do
+
+    before( :each ) do
+      Dir.chdir( vocab_root )
+    end
+
+    before( :each ) do
+      @sha = '2302e5acb50a9b56d113c46805de5ae0c12d28c0'
+      Vocab.settings.stub!( :last_translation ).and_return( @sha )
+    end
+
+    it "extracts hash of previous string translations" do
+      actual = Vocab::Extractor::Android.extract_previous( @locale )
+      actual.should eql( { 'app_name'    => 'Kid Mode',
+                           'pd_app_name' => 'Parent Dashboard',
+                           'app_current' => 'current' } )
+    end
+
+  end
+
+  describe 'write_full' do
+
+    it 'writes the full translation to the correct xml file' do
+      hash = { 'foo' => 'bar' }
+      Vocab::Translator::Android.should_receive( :write ).
+              with( hash, "#{vocab_root}/strings.full.xml" )
+      Vocab::Extractor::Android.write_full( hash )
+    end
+
+  end
+
+  describe 'write_diff' do
+
+    it 'writes the diff translation to the correct xml file' do
+      hash = { 'foo' => 'bar' }
+      Vocab::Translator::Android.should_receive( :write ).
+              with( hash, "#{vocab_root}/strings.diff.xml" )
+      Vocab::Extractor::Android.write_diff( hash )
+    end
+
+  end
+
+  describe 'write' do
+
+    it 'writes the translation to a xml file' do
+      translation = { 'app_name' => 'Kid Mode',
+                      'pd_app_name' => 'Parent Dashboard',
+                      'delete' => "La función Child Lock" }
+      path = "#{vocab_root}/spec/tmp/strings.xml"
+      Vocab::Translator::Android.write( translation, path )
+      should_eql_file( File.open( path ) { |f| f.read },
+                       "spec/data/android/write.xml" )
+      File.delete( path )
+    end
+
+  end
+
+  describe 'examples' do
+
+    it 'returns file names for completed translations' do
+      dir = "#{vocab_root}/spec/data/android/locales"
+      actual = Vocab::Extractor::Android.examples( dir )
+      actual.should =~ [ "tmp/translations/values-es" ]
+    end
+
+    it 'uses the conventional android locales directory by default' do
+      Vocab::Translator::Android.should_receive( :locales ).with( "#{vocab_root}/res/values" ).and_return( [] )
+      Vocab::Extractor::Android.examples
+    end
+
+  end
+
+end

data/spec/extractor/base_spec.rb

@@ -0,0 +1,134 @@
+require "spec_helper"
+
+describe "Vocab::Extractor::Base" do
+
+  describe "diff" do
+
+    it "finds the new keys in the current hash" do
+      @current = { 1 => 2, 3 => 4 }
+      @previous = { 1 => 2 }
+      diff = Vocab::Extractor::Base.diff( @previous, @current )
+      diff.should == { 3 => 4 }
+    end
+
+    it "finds the updated keys in the current hash" do
+      @current = { 1 => 10 }
+      @previous = { 1 => 2 }
+      diff = Vocab::Extractor::Base.diff( @previous, @current )
+      diff.should == { 1 => 10 }
+    end
+
+    it "ignores updated keys that begin with 'debug_'" do
+      @current = { 'debug_foo' => 'bar' }
+      @previous = {}
+      diff = Vocab::Extractor::Base.diff( @previous, @current )
+      diff.should == {}
+    end
+
+    it "handles the hash format of the translations" do
+      @current =  { :"en.marketing.banner"=>"This product is so good",
+                    :"en.models.product.id_125.name"=>"This has been updated",
+                    :"en.models.product.id_126.name"=>"This is new"}
+      @previous = { :"en.marketing.banner"=>"This product is so good",
+                    :"en.models.product.id_125.name"=>"Lazer"}
+      diff = Vocab::Extractor::Base.diff( @previous, @current )
+      diff.should == { :"en.models.product.id_125.name"=>"This has been updated",
+                       :"en.models.product.id_126.name"=>"This is new"}
+    end
+
+  end
+
+  describe "extract" do
+
+    before( :each ) do
+      @diff_path = "#{vocab_root}/spec/tmp/en.yml"
+      @full_path = "#{vocab_root}/spec/tmp/en.yml"
+      File.delete( @diff_path ) if File.exists?( @diff_path )
+    end
+
+    it "extracts the strings that need to be translated into a yml file" do
+      current = { 1 => 5, 3 => 4 }
+      previous = { 1 => 2 }
+      Vocab::Extractor::Base.should_receive( :extract_current ).and_return( current )
+      Vocab::Extractor::Base.should_receive( :extract_previous ).and_return( previous )
+      Vocab::Extractor::Base.should_receive( :write_diff ).with( { 1 => 5, 3 => 4 }, @diff_path )
+      Vocab::Extractor::Base.should_receive( :write_full ).with( current, @full_path )
+      Vocab::Extractor::Base.should_receive( :mkdir_examples )
+      Vocab::Extractor::Base.extract( @diff_path, @full_path )
+    end
+
+  end
+
+  describe "previous_file" do
+
+    before( :each ) do
+      Dir.chdir( vocab_root )
+      @path = "spec/data/android/locales/strings.xml"
+    end
+
+    it "returns the contents of a file from a specific git version" do
+      contents = Vocab::Extractor::Base.previous_file( @path, 'a19f7c5c28c1158792a966c0d2153a04490dd35e' )
+      should_eql_file( contents, 'spec/data/android/previous.xml' )
+
+      contents = Vocab::Extractor::Base.previous_file( @path, '0533bcd9a304cd6e74d6a56959dbcabd57b2f1b9' )
+      should_eql_file( contents, 'spec/data/android/current.xml' )
+    end
+
+    it "returns the correct contents when a full path is specified" do
+      contents = Vocab::Extractor::Base.previous_file( "#{vocab_root}/#{@path}", 'a19f7c5c28c1158792a966c0d2153a04490dd35e' )
+      should_eql_file( contents, 'spec/data/android/previous.xml' )
+    end
+
+    it "returns the contents of a file when in a subdir of the git directory" do
+      Dir.chdir( "spec" )
+      @path = "data/android/locales/strings.xml"
+      contents = Vocab::Extractor::Base.previous_file( @path, 'a19f7c5c28c1158792a966c0d2153a04490dd35e' )
+      should_eql_file( contents, 'spec/data/android/previous.xml' )
+    end
+
+  end
+
+  describe 'git_root' do
+
+    it 'returns empty string if already at git root' do
+      Dir.chdir( vocab_root )
+      Vocab::Extractor::Base.git_root.should eql( vocab_root )
+    end
+
+    it 'returns path to git root if in subdir' do
+      Dir.chdir( "#{vocab_root}/spec/data" )
+      Vocab::Extractor::Base.git_root.should eql( vocab_root )
+      Dir.chdir( "#{vocab_root}" )
+    end
+
+  end
+
+  describe 'git_relative_path' do
+
+    it 'returns the path to the specified file relative to the git root dir' do
+      Dir.chdir( vocab_root )
+      path = "spec/data/android/locales/values/strings.xml"
+      Vocab::Extractor::Base.git_path( path ).should eql( path )
+    end
+
+    it 'returns the path to the specified file relative to the git root dir while in subdir' do
+      Dir.chdir( "#{vocab_root}/spec/data" )
+      path = "android/locales/values/strings.xml"
+      git_path = "spec/data/android/locales/values/strings.xml"
+      Vocab::Extractor::Base.git_path( path ).should eql( git_path )
+    end
+
+  end
+
+  describe 'mkdir_examples' do
+
+    it 'creates example directories for completed translations' do
+      examples = [ 'tmp/translations/values-zh', 'tmp/translations/values-zh-rCN' ]
+      examples.each { |example| FileUtils.should_receive( :mkdir_p ).with( example ) }
+      Vocab::Extractor::Base.should_receive( :examples ).and_return( examples )
+      Vocab::Extractor::Base.mkdir_examples
+    end
+
+  end
+
+end