vocab 0.0.1

data/spec/translator/rails_spec.rb

@@ -0,0 +1,155 @@
+require "spec_helper"
+
+describe 'Vocab::Translator::Rails' do
+
+  describe 'load_dir' do
+
+    before( :each ) do
+      @translator = Vocab::Translator::Rails.new
+      @translator.load_dir( "#{vocab_root}/spec/data/rails/locales" )
+    end
+
+    it 'loads translations from a directory of yml files' do
+
+      actual = @translator.translations
+      expected = { :marketing=>{ :banner=>"This product is so good" },
+                   :models   =>{ :product=>{ :id_125=>{ :description=>"Green with megawatts",
+                                                        :name       =>"Lazer" },
+                                             :id_55 =>{ :description=>"A new nested description",
+                                                        :name       =>"a new nested name" },
+                                             :id_36 =>{ :description=>"Polarized and lazer resistant",
+                                                        :name       =>"This nested value has changed" } } },
+                   :menu     =>{ :second=>"Second menu item",
+                                 :first=>"First menu item" },
+                   :dashboard=>{ :chart  =>"This value has changed",
+                                 :details=>"This key/value has been added" },
+                   :not_in_es=>"This key not in spanish" }
+      actual.should eql( expected )
+    end
+
+  end
+
+  describe 'load_file' do
+
+    before( :each ) do
+      @file = "#{vocab_root}/spec/tmp/en.yml"
+      @data = { :foo => :bar }
+      @yml_hash = { :en => @data }
+      File.open( @file, "w+" ) { |f| f.write( @yml_hash.to_yaml ) }
+    end
+
+    it 'loads translations from a yml file' do
+      translator = Vocab::Translator::Rails.new
+      translator.load_file( @file )
+      translator.translations.should == @data
+    end
+
+    it 'sets the language based on the file loaded' do
+      @file = "#{vocab_root}/spec/data/rails/locales/en.yml"
+      translator = Vocab::Translator::Rails.new
+      translator.load_file( @file )
+      translator.locale.should eql( :en )
+
+      @file = "#{vocab_root}/spec/data/rails/locales/es.yml"
+      translator = Vocab::Translator::Rails.new
+      translator.load_file( @file )
+      translator.locale.should eql( :es )
+    end
+
+  end
+
+  describe 'translations' do
+
+    before( :each ) do
+      @file_1 = "#{vocab_root}/spec/tmp/en.yml"
+      @data_1 = { :en => { :foo => :bar } }
+      File.open( @file_1, "w+" ) { |f| f.write( @data_1.to_yaml ) }
+
+      @file_2 = "#{vocab_root}/spec/tmp/en2.yml"
+      @data_2 = { :en => { :yee => :hah } }
+      File.open( @file_2, "w+" ) { |f| f.write( @data_2.to_yaml ) }
+    end
+
+    it 'caches the translations to protect against someone swapping I18n.load_path' do
+      translator_1 = Vocab::Translator::Rails.new
+      translator_1.load_file( @file_1 )
+      data_1 = translator_1.translations
+
+      # Implicitly changes the I18n.load_path
+      translator_2 = Vocab::Translator::Rails.new
+      translator_2.load_file( @file_2 )
+
+      translator_1.translations.should eql( data_1 )
+    end
+
+    it 'returns nil languages without a translation' do
+      translator = Vocab::Translator::Rails.new
+      translator.translations.should eql( nil )
+    end
+
+  end
+
+  describe 'flattened_translations' do
+
+    it 'returns the translations with flattened keys in english' do
+      translator = Vocab::Translator::Rails.new
+      translator.load_dir( "#{vocab_root}/spec/data/rails/locales" )
+      actual = translator.flattened_translations
+      expected = { :"dashboard.details"                =>"This key/value has been added",
+                   :"models.product.id_125.name"       =>"Lazer",
+                   :"models.product.id_55.name"        =>"a new nested name",
+                   :"models.product.id_36.name"        =>"This nested value has changed",
+                   :"menu.second"                      =>"Second menu item",
+                   :"dashboard.chart"                  =>"This value has changed",
+                   :"menu.first"                       =>"First menu item",
+                   :"marketing.banner"                 =>"This product is so good",
+                   :"models.product.id_125.description"=>"Green with megawatts",
+                   :"models.product.id_55.description" =>"A new nested description",
+                   :"models.product.id_36.description" =>"Polarized and lazer resistant",
+                   :"not_in_es"                        =>"This key not in spanish" }
+      actual.should == expected
+    end
+
+    it 'returns the translations with flattened keys in other languages' do
+      translator = Vocab::Translator::Rails.new( :es )
+      translator.load_dir( "#{vocab_root}/spec/data/rails/locales" )
+      actual = translator.flattened_translations
+      expected = { :"models.product.id_125.name"       =>"Lazero",
+                   :"marketing.banner"                 =>"hola",
+                   :"models.product.id_55.name"        =>"Muy bonita",
+                   :"models.product.id_125.description"=>"Verde",
+                   :"models.product.id_36.name"        =>"No Lazero",
+                   :"models.product.id_55.description" =>"Azul",
+                   :"models.product.id_36.description" =>"Negro",
+                   :"dashboard.chart"                  =>"Es muy bonita",
+                   :"dashboard.details"                =>"grande" }
+      actual.should == expected
+    end
+
+  end
+
+  describe 'store' do
+
+    it 'stores translation' do
+      @key = 'foo.bar'
+      @value = 'baz'
+      translator = Vocab::Translator::Rails.new
+      translator.store( @key, @value )
+      translator.flattened_translations[ @key.to_sym ].should eql( @value )
+    end
+
+  end
+
+  describe 'fetch' do
+
+    it 'fetch a translation' do
+      @key = 'foo.bar'
+      @value = 'baz'
+      translator = Vocab::Translator::Rails.new
+      translator.store( @key, @value )
+      translator.fetch( @key ).should eql( @value )
+    end
+
+  end
+
+end

data/spec/ui_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe "UI" do
+
+  describe 'warn' do
+
+    it 'prepends a warning message to output' do
+      message = "there is a problem"
+      Vocab.ui.should_receive( :say ).with( "Warning: #{message}" )
+      Vocab.ui.warn( message )
+    end
+
+  end
+
+end

data/spec/validator/android_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe "Vocab::Validator::Android" do
+
+  before( :each ) do
+    @locales_dir = "#{vocab_root}/spec/data/android/locales"
+    @validator = Vocab::Validator::Android.new( @locales_dir )
+  end
+
+  describe 'validate_file' do
+
+    before( :each ) do
+      @path = "#{vocab_root}/spec/data/android/locales/values-es/strings.xml"
+    end
+
+    it 'returns a hash containing the missing keys' do
+      result = @validator.validate_file( @path )
+      result[ :missing ].should eql( [ "cancel", "delete", "not_in_es" ] )
+    end
+
+    it 'returns a hash containing the extra keys' do
+      @validator.should_receive( :english_keys ).and_return( [ 'foo' ] )
+      @validator.should_receive( :other_keys ).and_return( [ 'foo', 'extra', 'stuff' ] )
+      result = @validator.validate_file( @path )
+      result[ :extra ].should eql( [ 'extra', 'stuff' ] )
+    end
+
+  end
+
+  describe 'files_to_validate' do
+
+    it 'returns the locale files to validate' do
+      files = [ "#{@locales_dir}/values-es/strings.xml" ]
+      @validator.files_to_validate.should eql( files )
+    end
+
+  end
+
+  describe 'validate' do
+
+    it 'validates android locales files' do
+      files = @validator.files_to_validate
+      files.each { |file| @validator.should_receive( :validate_file ).with( file ) }
+      @validator.should_receive( :print ).exactly( files.size ).times
+      @validator.validate
+    end
+
+    it 'prints without exception' do
+      @validator.validate
+    end
+
+  end
+
+end

data/spec/validator/base_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe "Vocab::Validator::Base" do
+
+end

data/spec/validator/rails_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+describe "Vocab::Validator::Rails" do
+
+  before( :each ) do
+    @locales_dir = "#{vocab_root}/spec/data/rails/locales"
+    @validator = Vocab::Validator::Rails.new( @locales_dir )
+  end
+
+  describe 'validate_file' do
+
+    before( :each ) do
+      @path = "#{vocab_root}/spec/data/rails/locales/es.yml"
+    end
+
+    it 'returns a hash containing the missing keys' do
+      result = @validator.validate_file( @path )
+      result[ :missing ].should =~ [ "menu.first", "menu.second", "not_in_es" ]
+    end
+
+    it 'returns a hash containing the extra keys' do
+      @validator.should_receive( :english_keys ).and_return( [ 'foo' ] )
+      @validator.should_receive( :other_keys ).and_return( [ 'foo', 'extra', 'stuff' ] )
+      result = @validator.validate_file( @path )
+      result[ :extra ].should eql( [ 'extra', 'stuff' ] )
+    end
+
+  end
+
+  describe 'files_to_validate' do
+
+    it 'returns the locale files to validate' do
+      files = ["#{@locales_dir}/es.yml",
+               "#{@locales_dir}/models/product/es.yml"]
+      @validator.files_to_validate.should eql( files )
+    end
+
+  end
+
+  describe 'validate' do
+
+    it 'validates android locales files' do
+      files = @validator.files_to_validate
+      files.each { |file| @validator.should_receive( :validate_file ).with( file ) }
+      @validator.should_receive( :print ).exactly( files.size ).times
+      @validator.validate
+    end
+
+    it 'prints without exception' do
+      @validator.validate
+    end
+
+  end
+
+  describe 'other_keys' do
+
+    before( :each ) do
+      @file = "#{@locales_dir}/es.yml"
+      @validator = Vocab::Validator::Rails.new( @locales_dir )
+    end
+
+    it 'returns the flattened keys from the file' do
+      keys = ["dashboard.chart", "dashboard.details", "marketing.banner"]
+      @validator.other_keys( @file ).should =~ keys
+    end
+
+  end
+
+  describe 'english_keys' do
+
+    before( :each ) do
+      @file = "#{@locales_dir}/es.yml"
+      @validator = Vocab::Validator::Rails.new( @locales_dir )
+    end
+
+    it 'returns the flattened keys from english equivalent file' do
+      keys = ["dashboard.chart", "dashboard.details", "marketing.banner", "menu.first", "menu.second", "not_in_es"]
+      @validator.english_keys( @file ).should =~ keys
+    end
+
+  end
+
+end

data/spec/vocab_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe "Vocab" do
+
+  describe 'root' do
+
+    it 'returns the root of the gem' do
+      Vocab.root.should == File.expand_path( Dir.pwd )
+    end
+
+  end
+
+end

data/vocab.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "vocab/version"
+
+Gem::Specification.new do |s|
+  s.name        = "vocab"
+  s.version     = Vocab::VERSION
+  s.authors     = ["Jeff LaBarge"]
+  s.email       = ["jefflabarge@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Automate management of i18n locale files}
+  s.description = %q{Export strings that need to be translated and integrate the completed translations}
+  s.rubyforge_project = "vocab"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.bindir        = 'bin'
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_dependency "i18n"
+  s.add_dependency "nokogiri"
+  s.add_development_dependency "rspec", "~> 2.7.0"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: vocab
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeff LaBarge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2152213440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152213440
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2152210940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152210940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152205700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152205700
+description: Export strings that need to be translated and integrate the completed
+  translations
+email:
+- jefflabarge@gmail.com
+executables:
+- vocab
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/vocab
+- lib/vocab.rb
+- lib/vocab/application.rb
+- lib/vocab/extractor.rb
+- lib/vocab/extractor/android.rb
+- lib/vocab/extractor/base.rb
+- lib/vocab/extractor/rails.rb
+- lib/vocab/merger.rb
+- lib/vocab/merger/android.rb
+- lib/vocab/merger/base.rb
+- lib/vocab/merger/rails.rb
+- lib/vocab/settings.rb
+- lib/vocab/translator.rb
+- lib/vocab/translator/android.rb
+- lib/vocab/translator/base.rb
+- lib/vocab/translator/rails.rb
+- lib/vocab/ui.rb
+- lib/vocab/validator.rb
+- lib/vocab/validator/android.rb
+- lib/vocab/validator/base.rb
+- lib/vocab/validator/rails.rb
+- lib/vocab/version.rb
+- spec/application_spec.rb
+- spec/data/android/current.xml
+- spec/data/android/locales/values-es/strings.xml
+- spec/data/android/locales/values-large-hdpi/dimens.xml
+- spec/data/android/locales/values-large-hdpi/styles.xml
+- spec/data/android/locales/values/strings.xml
+- spec/data/android/previous.xml
+- spec/data/android/translations/values-es/es-string-file.xml
+- spec/data/android/write.xml
+- spec/data/rails/locales/en.yml
+- spec/data/rails/locales/es.yml
+- spec/data/rails/locales/models/product/en.yml
+- spec/data/rails/locales/models/product/es.yml
+- spec/data/rails/translations/cn.yml
+- spec/data/rails/translations/es.yml
+- spec/extractor/android_spec.rb
+- spec/extractor/base_spec.rb
+- spec/extractor/rails_spec.rb
+- spec/merger/android_spec.rb
+- spec/merger/base_spec.rb
+- spec/merger/rails_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers.rb
+- spec/support/shared.rb
+- spec/tmp/.gitkeep
+- spec/translator/android_spec.rb
+- spec/translator/rails_spec.rb
+- spec/ui_spec.rb
+- spec/validator/android_spec.rb
+- spec/validator/base_spec.rb
+- spec/validator/rails_spec.rb
+- spec/vocab_spec.rb
+- vocab.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: vocab
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Automate management of i18n locale files
+test_files:
+- spec/application_spec.rb
+- spec/data/android/current.xml
+- spec/data/android/locales/values-es/strings.xml
+- spec/data/android/locales/values-large-hdpi/dimens.xml
+- spec/data/android/locales/values-large-hdpi/styles.xml
+- spec/data/android/locales/values/strings.xml
+- spec/data/android/previous.xml
+- spec/data/android/translations/values-es/es-string-file.xml
+- spec/data/android/write.xml
+- spec/data/rails/locales/en.yml
+- spec/data/rails/locales/es.yml
+- spec/data/rails/locales/models/product/en.yml
+- spec/data/rails/locales/models/product/es.yml
+- spec/data/rails/translations/cn.yml
+- spec/data/rails/translations/es.yml
+- spec/extractor/android_spec.rb
+- spec/extractor/base_spec.rb
+- spec/extractor/rails_spec.rb
+- spec/merger/android_spec.rb
+- spec/merger/base_spec.rb
+- spec/merger/rails_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers.rb
+- spec/support/shared.rb
+- spec/tmp/.gitkeep
+- spec/translator/android_spec.rb
+- spec/translator/rails_spec.rb
+- spec/ui_spec.rb
+- spec/validator/android_spec.rb
+- spec/validator/base_spec.rb
+- spec/validator/rails_spec.rb
+- spec/vocab_spec.rb