vocab 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.0.5
+
+  * Print warning messages if there is a leading BOM character in Rails yml files
+
 # 0.0.4
 
   * Delete leftover cruft from tmp dir used in `vocab extract rails`

data/lib/vocab/validator/android.rb

@@ -18,6 +18,11 @@ module Vocab
         return Dir.glob( "#{@locales_dir}/values-*/strings.xml" )
       end
 
+      # Override this method to do custom validation on the android xml string file
+      def pre_validate( path )
+        return true
+      end
+
     end
   end
 end

data/lib/vocab/validator/base.rb

@@ -9,6 +9,7 @@ module Vocab
         files = files_to_validate
         Vocab.ui.say( "#{files.size} file(s) to validate in #{@locales_dir}" )
         files.each do |path|
+          ok &&= pre_validate( path )
           validation = validate_file( path )
           print( path, validation )
           ok &&= validation[ :missing ] && validation[ :missing ].empty?
@@ -41,6 +42,11 @@ module Vocab
         return result
       end
 
+      # Override in subclass
+      def pre_validate( path )
+        return true
+      end
+
     end
   end
 end

data/lib/vocab/validator/rails.rb

@@ -18,6 +18,18 @@ module Vocab
         return Dir.glob( "#{@locales_dir}/**/*.yml" ).reject { |path| File.basename( path ) == 'en.yml' }
       end
 
+      def pre_validate( path )
+        bom_regex = "\xEF\xBB\xBF".force_encoding("UTF-8")
+        File.open( path ) do |file|
+          content = file.read.force_encoding( "UTF-8" )
+          if content.match( bom_regex )
+            Vocab.ui.warn( "Found a leading BOM character in #{path}" )
+            return false
+          end
+          return true
+        end
+      end
+
     protected
 
       def flattened_keys( path )

data/lib/vocab/version.rb

@@ -1,3 +1,3 @@
 module Vocab
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/data/rails/locales/bom.yml

@@ -0,0 +1 @@
+bom:

data/spec/validator/base_spec.rb

@@ -2,16 +2,16 @@ require "spec_helper"
 
 describe "Vocab::Validator::Base" do
   
-  before( :each ) do
-    @files = [ 'foo', 'bar' ]
-    @good = { :missing => [], :extra => [] }
-    @bad = { :missing => [ 'bad' ], :extra => [] }
-    
-    @validator = Vocab::Validator::Base.new
-    @validator.should_receive( :files_to_validate ).and_return( @files )
-  end
-  
   describe "validate" do
+
+    before( :each ) do
+      @files = [ 'foo', 'bar' ]
+      @good = { :missing => [], :extra => [] }
+      @bad = { :missing => [ 'bad' ], :extra => [] }
+
+      @validator = Vocab::Validator::Base.new
+      @validator.should_receive( :files_to_validate ).and_return( @files )
+    end
     
     it "returns true if no files have missing keys" do
       @validator.should_receive( :validate_file ).exactly( @files.size ).times.and_return( @good )
@@ -22,6 +22,12 @@ describe "Vocab::Validator::Base" do
       @validator.should_receive( :validate_file ).exactly( @files.size ).times.and_return( @bad )
       @validator.validate.should be_false  
     end
+
+    it "returns false if the pre_validate fails" do
+      @validator.should_receive( :validate_file ).exactly( @files.size ).times.and_return( @good )
+      @validator.should_receive( :pre_validate ).and_return( false )
+      @validator.validate.should be_false
+    end
     
   end
 

data/spec/validator/rails_spec.rb

@@ -7,6 +7,20 @@ describe "Vocab::Validator::Rails" do
     @validator = Vocab::Validator::Rails.new( @locales_dir )
   end
 
+  describe 'pre_validate' do
+
+    it "complains about yml files with leading BOM characters" do
+      File.open( "#{@locales_dir}/bom.yml", "w+" ) { |f| f.write( "\xEF\xBB\xBF".force_encoding("UTF-8") ) }
+      File.open( "#{@locales_dir}/bom.yml", "a" ) { |f| f.write( "bom:" ) }
+
+      bom_regex = "\xEF\xBB\xBF".force_encoding("UTF-8")
+      File.open( "#{@locales_dir}/bom.yml" ) { |f| f.read }.force_encoding( "UTF-8" ).match( bom_regex ).should be_true
+
+      @validator.pre_validate( "#{@locales_dir}/bom.yml" ).should be_false
+    end
+
+  end
+
   describe 'validate_file' do
 
     before( :each ) do
@@ -30,9 +44,14 @@ describe "Vocab::Validator::Rails" do
   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 )
+      expected = ["#{@locales_dir}/bom.yml",
+                  "#{@locales_dir}/es.yml",
+                  "#{@locales_dir}/models/product/es.yml"]
+
+      actual = @validator.files_to_validate
+
+      actual.size.should eql( expected.size )
+      expected.each { |path| actual.should include( path ) }
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vocab
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000Z
+date: 2012-06-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2157186620 !ruby/object:Gem::Requirement
+  requirement: &2152005120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157186620
+  version_requirements: *2152005120
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2157186180 !ruby/object:Gem::Requirement
+  requirement: &2152004380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157186180
+  version_requirements: *2152004380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157185540 !ruby/object:Gem::Requirement
+  requirement: &2151940680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2157185540
+  version_requirements: *2151940680
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2157185000 !ruby/object:Gem::Requirement
+  requirement: &2151931540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157185000
+  version_requirements: *2151931540
 description: Export strings that need to be translated and integrate the completed
   translations
 email:
@@ -102,6 +102,7 @@ files:
 - spec/data/android/translations/values-es/es-string-file.xml
 - spec/data/android/write.xml
 - spec/data/android/write_plurals.xml
+- spec/data/rails/locales/bom.yml
 - spec/data/rails/locales/en.yml
 - spec/data/rails/locales/es.yml
 - spec/data/rails/locales/models/product/en.yml
@@ -161,6 +162,7 @@ test_files:
 - spec/data/android/translations/values-es/es-string-file.xml
 - spec/data/android/write.xml
 - spec/data/android/write_plurals.xml
+- spec/data/rails/locales/bom.yml
 - spec/data/rails/locales/en.yml
 - spec/data/rails/locales/es.yml
 - spec/data/rails/locales/models/product/en.yml