diffxml 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f2b2a509890a18db793e9eaa3d277b78cdfc932
+  data.tar.gz: 681b21647b958bf7e0a9ac6877a2a8f4f18310fe
+SHA512:
+  metadata.gz: d78f7f7650b321ce3dea3c274056851284d1831c76eb82efab2ab18c060335d0a9c32f2d40ba44a1fd5d4e85ba0d0cacd2db400f07998abcc9c038d821a2b4aa
+  data.tar.gz: 94823728ebedca927fed381d44853dbbecd27686c83cc4eb24ea7e28964c3b11f78618338d8e1f38fdb25693c5de953361f89029295b9e3dabe09addf41062d5

data/.gitignore

@@ -0,0 +1,48 @@
+*.gem
+*.rbc
+/.idea
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in diffxml.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jake
+
+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,40 @@
+# diff-xml [![Gem Version](https://badge.fury.io/rb/diffxml.svg)](https://rubygems.org/gems/diffxml)
+
+Inspired by the equivalent-xml gem, I wanted a way to get the differences between the two xmls, instead of just checking to see that there were differences, this is an alternative method I came up with, and I will add as I work on it, as it is still in its infancy.
+
+## Disclaimer
+
+This is an alternate method to a project I was working on, as such, there are no promises that it is the most efficient way to find the differences.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'diffxml'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install diffxml
+
+## Usage
+
+Pass two xml documents to the gem using 
+```ruby
+DiffXML.compareXML(doc1, doc2)
+```
+the returned value will be an array with the XPaths of all nodes that were not matched.
+
+## To Do
+Plans to return the values of both nodes that are at the XPath in the array, as well as the XPath location are in the works.
+General upkeep and a more rigorous test set are also planned.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pbubnar/diff-xml.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/diffxml.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "diffxml"
+  spec.version       = '0.1.1'
+  spec.authors       = ["Jake Bubnar"]
+  spec.email         = ["jake@pjbapps.com"]
+  spec.licenses       = ["MIT"]
+  spec.summary       = 'A simple xml comparison tool to get a list of diffs between two files passed to it'
+  spec.description   = 'Goes through each child to find the XPaths of each final child, and compares them to the path in the second file'
+  spec.homepage      = 'https://github.com/pbubnar/diffxml'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.test_files = ['rspec/diffXML_spec.rb']
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rspec", "~>3.4", ">= 3.4.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6", ">= 1.6.7.2"
+end

data/lib/diffXML/diffxml.rb

@@ -0,0 +1,39 @@
+require 'Nokogiri'
+
+module DiffXML
+  @xpathArray = []
+  def self.compareXML(doc1, doc2)
+    if doc1.class == Nokogiri::XML::Document
+      collectXPaths(doc1.root)
+    else
+      collectXPaths(doc1)
+    end
+    @xpathArray.delete_if {|element| compareToPath(element,doc1, doc2)}
+  end
+
+  def self.getPath(node, path = nil)
+    if node.parent.name.eql? 'document'
+      return path
+    else
+      getPath(node.parent, "#{node.parent.name}/#{path}")
+    end
+  end
+
+  def self.compareToPath(path, doc1, doc2)
+    doc2.search(path, doc1.collect_namespaces).to_s == doc1.search(path, doc1.collect_namespaces).to_s
+  end
+
+  def self.collectXPaths(doc)
+    doc.element_children.each do |child|
+      if child.element_children.empty?
+        @xpathArray.push(getPath(child,child.name)) unless child.content.empty?
+      else
+        collectXPaths(child)
+      end
+    end
+  end
+
+  def self.getXPathArray
+    @xpathArray
+  end
+end

data/rspec/diffXML_spec.rb

@@ -0,0 +1,39 @@
+require 'nokogiri'
+require 'rspec'
+require 'rspec/matchers'
+require_relative '../lib/diffXML/diffxml'
+
+describe DiffXML do
+  xml1 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second><third>
+                        <firstthird><finalChild>asdf</finalChild></firstthird></third><fourth></fourth></doc>")
+  xml2 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second><third>
+                        <firstthird><finalChild>asdf</finalChild></firstthird></third><fourth></fourth></doc>")
+  xml3 = Nokogiri::XML("<doc xmlns='foo:bar'><first>foo  bar baz</first><second>things</second><third>
+                        <firstthird><finalChild>asfd</finalChild></firstthird></third><fourth></fourth></doc>")
+
+
+  it 'should return an XPath for a given node' do
+    node = xml1.element_children[0].element_children[2].element_children[0].element_children[0]
+    expect(DiffXML.getPath(node, node.name)).to eql '/doc/third/firstthird/finalChild'
+  end
+
+  it 'should Collect all XPaths of the children into an array' do
+   DiffXML.collectXPaths(xml1)
+   expect(DiffXML.getXPathArray.size).to be 3
+   expect(DiffXML.getXPathArray).to eql %w[/doc/first /doc/second /doc/third/firstthird/finalChild]
+  end
+
+  it 'should retrieve and compare a node from a second document using a Path' do
+    expect(DiffXML.compareToPath('doc/first',xml1,xml2)).to eql true
+  end
+
+  it 'should go through 2 XMLs removing XPaths from the array as they are found' do
+    expect(DiffXML.compareXML(xml1,xml2).size).to be 0
+  end
+
+  it 'should return the differences in the event of a non match' do
+    expect(DiffXML.compareXML(xml1,xml3).size).to be 1
+    expect(DiffXML.getXPathArray[0].to_s).to eql 'doc/third/firstthird/finalChild'
+  end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: diffxml
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jake Bubnar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7.2
+description: Goes through each child to find the XPaths of each final child, and compares
+  them to the path in the second file
+email:
+- jake@pjbapps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- diffxml.gemspec
+- lib/diffXML/diffxml.rb
+- rspec/diffXML_spec.rb
+homepage: https://github.com/pbubnar/diffxml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A simple xml comparison tool to get a list of diffs between two files passed
+  to it
+test_files:
+- rspec/diffXML_spec.rb