yamldiff 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yamldiff.gemspec
+gemspec
+
+group :test do
+  gem 'mocha'
+  gem 'rspec'
+  gem 'fakefs', require: 'fakefs/safe'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jonathan R. Wallace
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Yamldiff
+
+Yamldiff prints out a list of missing keys for two yaml files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yamldiff'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yamldiff
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/yamldiff/version.rb

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

data/lib/yamldiff.rb

@@ -0,0 +1,59 @@
+require "yamldiff/version"
+
+class YamldiffError
+  attr_reader :key, :context
+  def initialize(key, context)
+    @key = key
+    @context = context
+  end
+end
+
+class YamldiffKeyError < YamldiffError; end
+class YamldiffKeyValueTypeError < YamldiffError; end
+class YamldiffKeyValueError < YamldiffError; end
+
+class Yamldiff
+  class << self
+    # Compare the two yaml files
+    def diff_yaml(first, second, errors_for = {})
+      primary               = YAML.load(File.open(first))
+      secondary             = YAML.load(File.open(second))
+      errors_for[secondary] = compare_hashes(first, second)
+    end
+
+    # Iterate through all keys in the first hash, checking each key for
+    #   1. existence
+    #   2. value class equivalence
+    #   3. value type equivalence
+    # in the second hash.
+    #
+    # Adapted from http://stackoverflow.com/a/6274367/91029
+    def compare_hashes(first, second, context = [])
+      errors = []
+
+      first.each do |key, value|
+        unless second.key?(key)
+          errors << YamldiffKeyError.new(key, context) # "Missing key : #{key} in path #{context.join(".")}"
+          next
+        end
+
+        value2 = second[key]
+        if (value.class != value2.class)
+          errors << YamldiffKeyValueTypeError.new(key, context) # "Key value type mismatch : #{key} in path #{context.join(".")}"
+          next
+        end
+
+        if value.is_a?(Hash)
+          errors << compare_hashes(value, second[key], (context << key))
+          next
+        end
+
+        if (value != value2)
+          errors << YamldiffKeyValueError.new(key, context) # "Key value mismatch : #{key} in path #{context.join(".")}"
+        end
+      end
+
+      errors.flatten
+    end
+  end
+end

data/spec/lib/yamldiff_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+ 
+describe Yamldiff do
+  describe ".compare_hashes" do
+    it "should be empty for equal hashes" do
+      subject.compare_hashes({ a: 1 }, { a: 1 }).should be_empty
+    end 
+ 
+    it "should be empty for nested hashes" do
+      first  = { a: { b: 2 } } 
+      second = { a: { b: 2 } } 
+      subject.compare_hashes(first, second).should be_empty
+    end 
+ 
+    it "should recognize when a key is missing" do
+      first  = { a: 1, b: 2 } 
+      second = { a: 1 } 
+      result = subject.compare_hashes(first, second).first
+ 
+      result.should be_an_instance_of(YamldiffKeyError)
+      result.key.should eql :b
+      result.context.should be_empty
+    end 
+ 
+    it "should recognize when two keys' values are of a different type" do
+      first  = { a:  1  }
+      second = { a: "1" }
+ 
+      result = subject.compare_hashes(first, second).first
+      result.should be_an_instance_of(YamldiffKeyValueTypeError)
+      result.key.should eql :a
+      result.context.should be_empty
+    end 
+ 
+    it "should recognize when two keys' values are not equal" do
+      first  = { a: { b: 2 } } 
+      second = { a: { b: 1 } } 
+ 
+      result = subject.compare_hashes(first, second).first
+      result.should be_an_instance_of(YamldiffKeyValueError)
+      result.key.should eql :b
+      result.context.should == [:a]
+    end 
+  end 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'yamldiff'
+require 'mocha'
+require 'fakefs/spec_helpers'
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+  c.include FakeFS::SpecHelpers, fakefs: true
+end

data/yamldiff.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yamldiff/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jonathan R. Wallace"]
+  gem.email         = ["jonathan.wallace@gmail.com"]
+  gem.description   = %q{Shows the difference yaml keys}
+  gem.summary       = %q{Yamldiff will tell you when and where you have differences between two yaml files.  It prints out a list of missing keys for the second file.}
+  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.name          = "yamldiff"
+  gem.require_paths = ["lib"]
+  gem.version       = Yamldiff::VERSION
+  gem.add_development_dependency 'fakefs'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: yamldiff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan R. Wallace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &70230341344320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70230341344320
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70230341343220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70230341343220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70230341342000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70230341342000
+description: Shows the difference yaml keys
+email:
+- jonathan.wallace@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yamldiff.rb
+- lib/yamldiff/version.rb
+- spec/lib/yamldiff_spec.rb
+- spec/spec_helper.rb
+- yamldiff.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: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Yamldiff will tell you when and where you have differences between two yaml
+  files.  It prints out a list of missing keys for the second file.
+test_files:
+- spec/lib/yamldiff_spec.rb
+- spec/spec_helper.rb