yaml-validator 0.0.1 → 0.1.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    yaml-validator (0.0.1)
+    yaml-validator (0.1.0)
+      colorize
       rake
       rspec
 
 GEM
   remote: http://rubygems.org/
   specs:
+    colorize (0.5.8)
     diff-lcs (1.1.3)
     rake (10.0.3)
     rspec (2.12.0)

data/README.md

@@ -1,6 +1,8 @@
 YAML Validator
 ==============
 
+[![Build Status](https://travis-ci.org/wazeHQ/yaml-validator.png?branch=master)](https://travis-ci.org/wazeHQ/yaml-validator)
+
 Validates .yml locale files for Ruby on Rails projects.
 
 What does it validate?

data/Rakefile

@@ -2,3 +2,5 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/bin/yaml-validator

@@ -1,15 +1,28 @@
 #!/usr/bin/env ruby
 
 require_relative '../lib/yaml-validator'
+require 'colorize'
 
 def main
+  show_missing = true
+  if ARGV.include? '--no-missing'
+    show_missing = false 
+    ARGV.delete '--no-missing'
+  end
+
   root_path = '.'
   root_path = ARGV[0] if ARGV.length > 0
   
-  puts "Validating #{root_path}"
-  errors = YamlValidator.new(root_path).validate()
+  puts "Validating #{root_path}...\n\n".colorize(:blue).underline
+  validator = YamlValidator.new(root_path, :show_missing => show_missing)
+  errors = validator.validate()
   puts errors
-  puts "\nfound #{errors.length} errors"
+  
+  if errors.length > 0
+    puts "\nfound #{errors.length} error(s)".colorize(:red).underline
+  else
+    puts "no errors".colorize(:green).underline
+  end
 end
 
 main()

data/lib/helpers.rb

@@ -0,0 +1,24 @@
+module Helpers
+  
+  def self.normalize_yaml(yaml)
+    return '' if yaml.nil?
+    return yaml if yaml.is_a? String
+    return yaml.to_s if yaml.is_a? Numeric
+    return yaml.to_s if !!yaml == yaml # if boolean
+    return ":#{yaml.to_s}" if yaml.is_a? Symbol
+    yaml = array_to_hash(yaml) if yaml.is_a? Array
+    
+    normalized = {}
+    yaml.each do |key, value|
+      normalized[key] = normalize_yaml(value)
+    end
+    normalized
+  end
+  
+  def self.array_to_hash(array)
+    hash = {}
+    array.each_with_index { |val, i| hash[i.to_s] = val }
+    hash
+  end
+  
+end

data/lib/yaml-validator.rb

@@ -1,21 +1,38 @@
 require 'yaml'
 require 'yaml-validator/version'
+require_relative './helpers'
 
 class YamlValidator
   
-  def initialize(root_path)
+  def initialize(root_path, options = {})
+    @options = options
+    @options[:show_missing] ||= true
     @root_path = root_path
   end
   
+  def en
+    return @en unless @en.nil?
+
+    fullpath = File.join(@root_path, 'en.yml')
+    return nil unless File.exists?(fullpath)
+
+    @en = YAML.load_file(fullpath)['en']
+    @en = Helpers.normalize_yaml(@en)
+  end
+  
   def en_with_vars
-    @en ||= YAML.load_file(File.join(@root_path, 'en.yml'))['en']
-    @en_with_vars ||= get_all_variables(@en)
+    return nil if en.nil?
+    @en_with_vars ||= get_all_variables(en)
   end
   
   def validate()
+    if en_with_vars.nil?
+      return ["no en.yml file in the directory (an en.yml file is required as reference)"]
+    end
     yml_files = File.join(@root_path, '*.yml')
     errors = []
     Dir[yml_files].each do |filename|
+      next if File.basename(filename) == 'en.yml'
       errors.concat validate_yaml(filename)
     end
     errors
@@ -29,14 +46,21 @@ class YamlValidator
     rescue Psych::SyntaxError => e
       return [e.message.sub(/^\([^)]+\)/, filename)]
     end
+    
     yaml_object = yaml_object[yaml_object.keys[0]]
+    yaml_object = Helpers.normalize_yaml(yaml_object)
     errors = validate_yaml_object('', yaml_object)
+    if @options[:show_missing]
+      errors.concat find_missing_translations(yaml_object)
+    end
     
     errors.map { |err| "#{filename}: #{err}" }
   end
   
   def validate_yaml_object(full_key, yaml_object)
+    return [] if yaml_object.nil?
     errors = []
+    
     yaml_object.each do |key, value|
       full_subkey = (full_key.empty?) ? key : "#{full_key}.#{key}"
       if value.is_a? String
@@ -48,6 +72,41 @@ class YamlValidator
     errors
   end
   
+  def find_missing_translations(yaml_object)
+    find_missing_translations_in_en_object('', en, yaml_object)
+  end
+  
+  def find_missing_translations_in_en_object(full_key, en_yaml_object, yaml_object)
+    return [] if en_yaml_object.nil?
+    errors = []
+    
+    en_yaml_object.each do |key, value|
+      full_subkey = (full_key.empty?) ? key : "#{full_key}.#{key}"
+      if value.is_a? String or value.is_a? Symbol
+        if self.class.find_key_in_yaml_object(full_subkey, yaml_object).nil?
+          errors << "missing translation for #{full_subkey} ('#{value}')"
+        end
+      else
+        errors.concat find_missing_translations_in_en_object(full_subkey, value, yaml_object)
+      end
+    end
+    errors
+  end
+  
+  def self.find_key_in_yaml_object(full_key, yaml_object)
+    position = yaml_object
+    full_key.split('.').each do |key|
+      return nil unless position.is_a? Hash
+      position = position[key]
+    end
+    
+    if position.is_a? String or position.is_a? Symbol
+      position
+    else
+      nil
+    end
+  end
+  
   def validate_item(full_key, value)
     real_vars = get_key_en_vars(full_key)
     if real_vars.nil?
@@ -80,10 +139,14 @@ class YamlValidator
   end
   
   def get_all_variables(yaml_object)
+    return {} if yaml_object.nil?
     with_vars = {}
+    
     yaml_object.each do |key, value|
       if value.is_a? String
         with_vars[key] = identify_variables(value)
+      elsif value.is_a? Symbol
+        with_vars[key] = {}
       else
         with_vars[key] = get_all_variables(value)
       end
@@ -94,5 +157,6 @@ class YamlValidator
   def identify_variables(string)
     string.scan(/%{([^}]+)}/).map { |v| v[0] }
   end
+  
 end
 

data/lib/yaml-validator/version.rb

@@ -1,3 +1,3 @@
 class YamlValidator
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/fixtures/invalid_yml/en.yml

@@ -0,0 +1,2 @@
+en:
+  key1: value1

data/spec/fixtures/missing_translations/en.yml

@@ -0,0 +1,12 @@
+en:
+  key1: 'value1'
+  parent1:
+    subkey1: 'value1'
+  key2: 'value2'
+  parent2:
+    key3: 'value3'
+  parent3:
+    - one
+    - :two
+    - three
+    -

data/spec/fixtures/missing_translations/he.yml

@@ -0,0 +1,7 @@
+he:
+  key1: 'value1'
+  parent1:
+    subkey1: 'value1'
+  parent3:
+    - 1
+    - heb two

data/spec/helpers_spec.rb

@@ -0,0 +1,53 @@
+require_relative '../lib/helpers'
+
+describe Helpers do
+  describe "#normalize_yaml" do
+    it "converts symbols to strings (with ':' prefix)" do
+      yaml = { 'key3' => :bob }
+
+      Helpers.normalize_yaml(yaml).should == {
+        'key3' => ':bob'
+      }
+    end
+
+    it "converts nil to ''" do
+      yaml = { 'key3' => nil }
+      Helpers.normalize_yaml(yaml).should == {
+        'key3' => ''
+      }
+    end
+    
+    it "converts numbers to string" do
+      yaml = { 'key3' => 123 }
+      Helpers.normalize_yaml(yaml).should == {
+        'key3' => '123'
+      }
+    end
+    
+    it "converts booleans to string" do
+      yaml = { 'key3' => true }
+      Helpers.normalize_yaml(yaml).should == {
+        'key3' => 'true'
+      }
+    end
+    
+    it "converts arrays to hashes" do
+      yaml = { 'key1' => 'value1',
+        'key2' => [ 'value2', nil, :bla ],
+        'parent1' => { 'key3' => [ :bob ] } }
+
+      Helpers.normalize_yaml(yaml).should == {
+        'key1' => 'value1',
+        'key2' => { '0' => 'value2', '1' => '', '2' => ':bla' },
+        'parent1' => { 'key3' => { '0' => ':bob' } }
+      }
+    end
+  end
+  
+  describe "#array_to_hash" do
+    it "returns hash with numeric indexes" do
+      Helpers.array_to_hash(['a','b']).should == { '0' => 'a', '1' => 'b' }
+    end
+  end
+
+end

data/spec/yaml-validator_spec.rb

@@ -6,6 +6,15 @@ describe YamlValidator do
   
   describe "#validate" do
     
+    describe "no en.yml file" do
+      it "returns 'no en.yml' error" do
+        validator = YamlValidator.new('spec/fixtures')
+        errors = validator.validate()
+        errors.should == 
+          ['no en.yml file in the directory (an en.yml file is required as reference)']
+      end
+    end
+    
     describe "wrong_variables scenario" do
       it "returns two errors" do
         validator = YamlValidator.new('spec/fixtures/wrong_variables')
@@ -25,7 +34,9 @@ describe YamlValidator do
           "he.yml: parent1.key1.subkey1 doesn't exist in en.yml",
           "he.yml: parent2.key2 doesn't exist in en.yml",
           "he.yml: key3 doesn't exist in en.yml",
-          "he.yml: parent3.key4 doesn't exist in en.yml"
+          "he.yml: parent3.key4 doesn't exist in en.yml",
+          "he.yml: missing translation for parent1.key1 ('Hello, %{name}, this is %{day_of_week}')",
+          "he.yml: missing translation for parent2.key2.subkey ('bla bla')"
         ]
       end
     end
@@ -40,6 +51,19 @@ describe YamlValidator do
         ]
       end
     end
+    
+    describe "missing translations" do
+      it "returns invalid yaml error" do
+        validator = YamlValidator.new('spec/fixtures/missing_translations')
+        errors = validator.validate()
+        errors.should == [
+          "he.yml: missing translation for key2 ('value2')",
+          "he.yml: missing translation for parent2.key3 ('value3')",
+          "he.yml: missing translation for parent3.2 ('three')",
+          "he.yml: missing translation for parent3.3 ('')",
+        ]
+      end
+    end
 
   end
   
@@ -134,5 +158,49 @@ describe YamlValidator do
       end
     end
   end
+  
+  describe "#find_missing_translations" do
+    it "returns the missing translation keys" do
+      validator = YamlValidator.new('spec/fixtures/missing_translations')
+      
+      yaml_object = YAML.load_file('spec/fixtures/missing_translations/he.yml')['he']
+      yaml_object = Helpers.normalize_yaml(yaml_object)
+      
+      errors = validator.find_missing_translations(yaml_object)
+      errors.should == [
+        "missing translation for key2 ('value2')",
+        "missing translation for parent2.key3 ('value3')",
+        "missing translation for parent3.2 ('three')",
+        "missing translation for parent3.3 ('')"
+      ]
+    end
+  end
+  
+  describe "#find_key_in_yaml_object" do
+    it "handles subkeys" do
+      yaml_object = { 'parent1' => { 'key1' => 'value1' } }
+      YamlValidator.find_key_in_yaml_object('parent1.key1', yaml_object).should == 'value1'
+    end
+    
+    it "handles root keys" do
+      yaml_object = { "key2" => 'value2' }
+      YamlValidator.find_key_in_yaml_object('key2', yaml_object).should == 'value2'
+    end
+    
+    it "returns nil when a root key doesn't exist" do
+      yaml_object = { "key2" => 'value2' }
+      YamlValidator.find_key_in_yaml_object('key1', yaml_object).should be_nil
+    end
+    
+    it "returns nil when a subkey doesn't exist" do
+      yaml_object = { "parent1" => { "key2" => 'value2' } }
+      YamlValidator.find_key_in_yaml_object('parent1.key1', yaml_object).should be_nil
+    end
+    
+    it "returns nil when a subkey is an object" do
+      yaml_object = { "parent1" => { "parent2" => { "key1" => 'value1' } } }
+      YamlValidator.find_key_in_yaml_object('parent1.key2', yaml_object).should be_nil
+    end
 
+  end
 end

data/yaml-validator.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["3david@gmail.com"]
   gem.description   = %q{YAML locales validator}
   gem.summary       = %q{Validates .yml locale files for Ruby on Rails projects}
-  gem.homepage      = ""
+  gem.homepage      = "http://github.com/wazeHQ/yaml-validator"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
   
   gem.add_dependency('rake')
   gem.add_dependency('rspec')
+  gem.add_dependency('colorize')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml-validator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: YAML locales validator
 email:
 - 3david@gmail.com
@@ -52,21 +68,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - bin/yaml-validator
+- lib/helpers.rb
 - lib/yaml-validator.rb
 - lib/yaml-validator/version.rb
+- pkg/yaml-validator-0.0.1.gem
 - spec/fixtures/inconsistent_types/en.yml
 - spec/fixtures/inconsistent_types/he.yml
+- spec/fixtures/invalid_yml/en.yml
 - spec/fixtures/invalid_yml/invalid.yml
+- spec/fixtures/missing_translations/en.yml
+- spec/fixtures/missing_translations/he.yml
 - spec/fixtures/wrong_variables/en.yml
 - spec/fixtures/wrong_variables/he.yml
+- spec/helpers_spec.rb
 - spec/yaml-validator_spec.rb
 - yaml-validator.gemspec
-homepage: ''
+homepage: http://github.com/wazeHQ/yaml-validator
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -80,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1983922220360573853
+      hash: 1734535970002030944
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -89,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1983922220360573853
+      hash: 1734535970002030944
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -99,7 +122,11 @@ summary: Validates .yml locale files for Ruby on Rails projects
 test_files:
 - spec/fixtures/inconsistent_types/en.yml
 - spec/fixtures/inconsistent_types/he.yml
+- spec/fixtures/invalid_yml/en.yml
 - spec/fixtures/invalid_yml/invalid.yml
+- spec/fixtures/missing_translations/en.yml
+- spec/fixtures/missing_translations/he.yml
 - spec/fixtures/wrong_variables/en.yml
 - spec/fixtures/wrong_variables/he.yml
+- spec/helpers_spec.rb
 - spec/yaml-validator_spec.rb