yaml-validator 0.0.1

data/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    yaml-validator (0.0.1)
+      rake
+      rspec
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  yaml-validator!

data/README.md

@@ -0,0 +1,40 @@
+YAML Validator
+==============
+
+Validates .yml locale files for Ruby on Rails projects.
+
+What does it validate?
+----------------------
+
+Given the following file tree:
+
+```
+config/
+  locales/
+    en.yml
+    he.yml
+    nl.yml
+    fr.yml
+    ...
+```
+
+Run the following command:
+
+```bash
+yaml-validator config/locales
+
+or 
+
+cd config/locales
+yaml-validator
+```
+
+it will validate the files (in reference to en.yml) and show the following types of errors:
+
+```
+he.yml: parent_key.key1 doesn't exist in en.yml
+fr.yml: found character that cannot start any token while scanning for the next token at line 19 column 14
+nl.yml: parent_key.key1: missing variable 'var_with_typo' (available options var_without_type)
+
+```
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/yaml-validator

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/yaml-validator'
+
+def main
+  root_path = '.'
+  root_path = ARGV[0] if ARGV.length > 0
+  
+  puts "Validating #{root_path}"
+  errors = YamlValidator.new(root_path).validate()
+  puts errors
+  puts "\nfound #{errors.length} errors"
+end
+
+main()

data/lib/yaml-validator.rb

@@ -0,0 +1,98 @@
+require 'yaml'
+require 'yaml-validator/version'
+
+class YamlValidator
+  
+  def initialize(root_path)
+    @root_path = root_path
+  end
+  
+  def en_with_vars
+    @en ||= YAML.load_file(File.join(@root_path, 'en.yml'))['en']
+    @en_with_vars ||= get_all_variables(@en)
+  end
+  
+  def validate()
+    yml_files = File.join(@root_path, '*.yml')
+    errors = []
+    Dir[yml_files].each do |filename|
+      errors.concat validate_yaml(filename)
+    end
+    errors
+  end
+  
+  def validate_yaml(filepath)
+    filename = File.basename(filepath)
+    
+    begin
+      yaml_object = YAML.load_file(filepath)
+    rescue Psych::SyntaxError => e
+      return [e.message.sub(/^\([^)]+\)/, filename)]
+    end
+    yaml_object = yaml_object[yaml_object.keys[0]]
+    errors = validate_yaml_object('', yaml_object)
+    
+    errors.map { |err| "#{filename}: #{err}" }
+  end
+  
+  def validate_yaml_object(full_key, yaml_object)
+    errors = []
+    yaml_object.each do |key, value|
+      full_subkey = (full_key.empty?) ? key : "#{full_key}.#{key}"
+      if value.is_a? String
+        errors.concat validate_item(full_subkey, value)
+      else
+        errors.concat validate_yaml_object(full_subkey, value)
+      end
+    end
+    errors
+  end
+  
+  def validate_item(full_key, value)
+    real_vars = get_key_en_vars(full_key)
+    if real_vars.nil?
+      return ["#{full_key} doesn't exist in en.yml"]
+    end
+
+    used_vars = identify_variables(value)
+
+    errors = []
+    used_vars.each do |var|
+      unless real_vars.include? var
+        errors << "#{full_key}: missing variable '#{var}' (available options: #{real_vars.join(', ')})"
+      end
+    end
+    errors
+  end
+  
+  def get_key_en_vars(full_key)
+    position = en_with_vars
+    full_key.split('.').each do |key|
+      return nil if position.is_a? Array
+      return nil if position.nil?
+      position = position[key]
+    end
+    if position.is_a? Array
+      position
+    else
+      nil
+    end
+  end
+  
+  def get_all_variables(yaml_object)
+    with_vars = {}
+    yaml_object.each do |key, value|
+      if value.is_a? String
+        with_vars[key] = identify_variables(value)
+      else
+        with_vars[key] = get_all_variables(value)
+      end
+    end
+    with_vars
+  end
+  
+  def identify_variables(string)
+    string.scan(/%{([^}]+)}/).map { |v| v[0] }
+  end
+end
+

data/lib/yaml-validator/version.rb

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

data/spec/fixtures/inconsistent_types/en.yml

@@ -0,0 +1,6 @@
+en:
+  parent1:
+    key1: "Hello, %{name}, this is %{day_of_week}"
+  parent2:
+    key2:
+      subkey: 'bla bla'

data/spec/fixtures/inconsistent_types/he.yml

@@ -0,0 +1,9 @@
+he:
+  parent1:
+    key1:
+      subkey1: 'bla bla'
+  parent2:
+    key2: 'bla bla bla'
+  key3: 'bla1'
+  parent3:
+    key4: 'bla2'

data/spec/fixtures/invalid_yml/invalid.yml

@@ -0,0 +1 @@
+key: %{var}

data/spec/fixtures/wrong_variables/en.yml

@@ -0,0 +1,3 @@
+en:
+  parent1:
+    key1: "Hello, %{name}, this is %{day_of_week}"

data/spec/fixtures/wrong_variables/he.yml

@@ -0,0 +1,3 @@
+he:
+  parent1:
+    key1: "Hello, %{name1}, this is %{day_of_week1}"

data/spec/yaml-validator_spec.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+
+require_relative '../lib/yaml-validator'
+
+describe YamlValidator do
+  
+  describe "#validate" do
+    
+    describe "wrong_variables scenario" do
+      it "returns two errors" do
+        validator = YamlValidator.new('spec/fixtures/wrong_variables')
+        errors = validator.validate()
+        errors.should == [
+          "he.yml: parent1.key1: missing variable 'name1' (available options: name, day_of_week)",
+          "he.yml: parent1.key1: missing variable 'day_of_week1' (available options: name, day_of_week)"
+        ]
+      end
+    end
+    
+    describe "inconsistent_types scenario" do
+      it "returns inconsistent type error" do
+        validator = YamlValidator.new('spec/fixtures/inconsistent_types')
+        errors = validator.validate()
+        errors.should == [
+          "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"
+        ]
+      end
+    end
+    
+    describe "invalid yaml files" do
+      it "returns invalid yaml error" do
+        validator = YamlValidator.new('spec/fixtures/invalid_yml')
+        errors = validator.validate()
+        errors.should == [
+          "invalid.yml: found character that cannot start any token " + 
+            "while scanning for the next token at line 1 column 6"
+        ]
+      end
+    end
+
+  end
+  
+  describe "#validate_yaml" do
+    it "returns two errors" do
+      validator = YamlValidator.new('spec/fixtures/wrong_variables')
+      errors = validator.validate_yaml('spec/fixtures/wrong_variables/he.yml')
+      errors == [
+        "he.yml: parent1.key1: missing variable 'name1' (available options: name, day_of_week)",
+        "he.yml: parent1.key1: missing variable 'day_of_week1' (available options: name, day_of_week)"
+      ]
+    end
+  end
+  
+  
+  describe "#validate_item" do
+    describe "for 'parent1.key1' = 'hello %{name1}, %{day_of_week1}'" do
+      it "returns two errors" do
+        validator = YamlValidator.new('spec/fixtures/wrong_variables')
+        errors = validator.validate_item('parent1.key1', 'hello %{name1}, %{day_of_week1}')
+        errors.should == [
+          "parent1.key1: missing variable 'name1' (available options: name, day_of_week)",
+          "parent1.key1: missing variable 'day_of_week1' (available options: name, day_of_week)"
+        ]
+      end
+    end
+  end
+  
+  describe "#get_key_en_vars" do
+    describe "for 'parent1'" do
+      it "returns nil" do
+        validator = YamlValidator.new('spec/fixtures/wrong_variables')
+        validator.get_key_en_vars('parent1').should be_nil
+      end
+    end
+    
+    describe "for 'parent1.key1'" do
+      it "returns ['name', 'day_of_week']" do
+        validator = YamlValidator.new('spec/fixtures/wrong_variables')
+        validator.get_key_en_vars('parent1.key1').should == ['name', 'day_of_week']
+      end
+    end
+    
+    describe "for 'parent1.nonexisting_key'" do
+      it "returns nil" do
+        validator = YamlValidator.new('spec/fixtures/wrong_variables')
+        validator.get_key_en_vars('parent1.nonexisting_key').should == nil
+      end
+    end
+    describe "for 'parent1.nonexisting_parent.key1'" do
+      it "returns nil" do
+        validator = YamlValidator.new('spec/fixtures/wrong_variables')
+        validator.get_key_en_vars('parent1.nonexisting_parent.key1').should == nil
+      end
+    end
+    describe "for 'parent1.key1.nonexisting_subkey'" do
+      it "returns nil" do
+        validator = YamlValidator.new('spec/fixtures/wrong_variables')
+        validator.get_key_en_vars('parent1.key1.nonexisting_subkey').should == nil
+      end
+    end
+  end
+  
+  describe "#get_all_variables" do
+    subject { YamlValidator.new(nil) }
+    describe "for { parent1: { key1: 'hello %{name}' } }" do
+      it "returns { parent1: { key1: ['name'] } }" do
+        input = { :parent1 => { :key1 => "hello %{name}" } }
+        subject.get_all_variables(input).should == { :parent1 => { :key1 => ['name'] } }
+      end
+    end
+    describe "for { parent1: { parent2: { key1: 'hello %{name}' } } }" do
+      it "returns { parent1: { parent2: { key1: ['name'] } } }" do
+        input = { :parent1 => { :parent2 => { :key1 => "hello %{name}" } } }
+        subject.get_all_variables(input).should ==
+          { :parent1 => { :parent2 => { :key1 => ['name'] } } }
+      end
+    end
+  end
+  
+  describe "#identify_variables" do
+    subject { YamlValidator.new(nil) }
+    describe "for 'Hello, hi'" do
+      it "returns []" do
+        subject.identify_variables('Hello, hi').should == []
+      end
+    end
+    describe "for 'Hello, %{name}, this is %{day_of_week}" do
+      it "returns ['name', 'day_of_week']" do
+        string = 'Hello, %{name}, this is %{day_of_week}'
+        subject.identify_variables(string).should == %w{name day_of_week}
+      end
+    end
+  end
+
+end

data/yaml-validator.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaml-validator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "yaml-validator"
+  gem.version       = YamlValidator::VERSION
+  gem.authors       = ["David Elentok"]
+  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.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency('rake')
+  gem.add_dependency('rspec')
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: yaml-validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Elentok
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+executables:
+- yaml-validator
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/yaml-validator
+- lib/yaml-validator.rb
+- lib/yaml-validator/version.rb
+- spec/fixtures/inconsistent_types/en.yml
+- spec/fixtures/inconsistent_types/he.yml
+- spec/fixtures/invalid_yml/invalid.yml
+- spec/fixtures/wrong_variables/en.yml
+- spec/fixtures/wrong_variables/he.yml
+- spec/yaml-validator_spec.rb
+- yaml-validator.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'
+      segments:
+      - 0
+      hash: 1983922220360573853
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1983922220360573853
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+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/invalid.yml
+- spec/fixtures/wrong_variables/en.yml
+- spec/fixtures/wrong_variables/he.yml
+- spec/yaml-validator_spec.rb