nokogiri-diff 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "nokogiri-diff Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,8 @@
+### 0.1.0 / 2010-11-29
+
+* Initial release:
+  * Performs a breadth-first comparison between children nodes.
+  * Compares XML/HTML Elements, Attributes, Text nodes and DTD nodes.
+  * Allows calculating differences between documents, or just enumerating
+    the added or removed nodes.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Hal Brodigan
+
+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,74 @@
+# nokogiri-diff
+
+* [Source](http://github.com/postmodern/nokogiri-diff)
+* [Issues](http://github.com/postmodern/nokogiri-diff/issues)
+* [Documentation](http://rubydoc.info/gems/nokogiri-diff/frames)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+nokogiri-diff adds the ability to calculate the differences (added or
+removed nodes) between two XML/HTML documents.
+
+## Features
+
+* Performs a breadth-first comparison between children nodes.
+* Compares XML/HTML Elements, Attributes, Text nodes and DTD nodes.
+* Allows calculating differences between documents, or just enumerating the
+  added or removed nodes.
+
+## Examples
+
+Enumerate over the the differences between two HTML documents:
+
+    require 'nokogiri/diff'
+
+    doc1 = Nokogiri::HTML('<div><p>one</p> two </div>')
+    doc2 = Nokogiri::HTML('<div><p id="1">one</p> <p>three</p></div>')
+
+    doc1.diff(doc2) do |change,node|
+      puts "#{change} #{node.to_html}".ljust(30) + node.parent.path
+    end
+
+    #   <div>
+    # <p>one</p> two </div> /
+    #   <p>one</p>                  /div
+    # -  two                        /div
+    # +                             /div
+    # + <p>three</p>                /div
+    # +  id="1"                     /div/p[1]
+    #   one                         /div/p
+
+Only find the added nodes:
+
+    doc1.diff(doc2, :added => true) do |change,node|
+      puts node.to_html.ljust(30) + node.parent.path
+    end
+
+    #                               /div
+    # <p>three</p>                  /div
+    #  id="1"                       /div/p[1]
+
+Only find the removed nodes:
+
+    doc1.diff(doc2, :removed => true) do |change,node|
+      puts node.to_html.ljust(30) + node.parent.path
+    end
+
+    #  two                          /div
+
+## Requirements
+
+* [ruby](http://www.ruby-lang.org/) >= 1.8.7
+* [tdiff](http://github.com/postmodern/tdiff) ~> 0.3.2
+* [nokogiri](http://nokogiri.rubyforge.org/) ~> 1.4.1
+
+## Install
+
+    $ gem install nokogiri-diff
+
+## Copyright
+
+Copyright (c) 2010 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.3.0'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.2.0'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.6.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/gemspec.yml

@@ -0,0 +1,23 @@
+name: nokogiri-diff
+version: 0.1.0
+summary: Calculate the differences between two XML/HTML documents.
+description:
+  Nokogiri::Diff adds the ability to calculate the differences (added
+  or removed nodes) between two XML/HTML documents.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/nokogiri-diff
+has_yard: true
+
+required_ruby_version: >= 1.8.7
+
+dependencies:
+  tdiff: ~> 0.3.2
+  nokogiri: ~> 1.4.1
+
+development_dependencies:
+  ore-tasks: ~> 0.3.0
+  rspec: ~> 2.2.0
+  yard: ~> 0.6.0

data/lib/nokogiri/diff.rb

@@ -0,0 +1 @@
+require 'nokogiri/diff/xml'

data/lib/nokogiri/diff/xml.rb

@@ -0,0 +1,2 @@
+require 'nokogiri/diff/xml/node'
+require 'nokogiri/diff/xml/document'

data/lib/nokogiri/diff/xml/document.rb

@@ -0,0 +1,25 @@
+require 'nokogiri/diff/xml/node'
+
+class Nokogiri::XML::Document < Nokogiri::XML::Node
+
+  #
+  # Overrides `tdiff` to only compare the child nodes of the document.
+  #
+  def tdiff(tree,&block)
+    return enum_for(:tdiff,tree) unless block
+
+    tdiff_recursive(tree,&block)
+    return self
+  end
+
+  #
+  # Overrides `tdiff_unordered` to only compare the child nodes of the document.
+  #
+  def tdiff_unordered(tree,&block)
+    return enum_for(:tdiff_unordered,tree) unless block
+
+    tdiff_recursive_unordered(tree,&block)
+    return self
+  end
+
+end

data/lib/nokogiri/diff/xml/node.rb

@@ -0,0 +1,98 @@
+require 'nokogiri'
+require 'tdiff'
+
+class Nokogiri::XML::Node
+
+  include TDiff
+  include TDiff::Unordered
+
+  #
+  # Compares two XML/HTML nodes.
+  #
+  # @param [Nokogiri::XML::Node] node1
+  #
+  # @param [Nokogiri::XML::Node] node2
+  #
+  # @return [Boolean]
+  #   Specifies whether the two nodes are equal.
+  #
+  def tdiff_equal(node)
+    if (self.class == node.class)
+      case node
+      when Nokogiri::XML::Attr
+        (self.name == node.name && self.value == node.value)
+      when Nokogiri::XML::Element, Nokogiri::XML::DTD
+        self.name == node.name
+      when Nokogiri::XML::Text
+        self.text == node.text
+      else
+        false
+      end
+    else
+      false
+    end
+  end
+
+  #
+  # Enumerates over the children of a XML/HTML node.
+  #
+  # @param [Nokogiri::XML::Node] node
+  # 
+  # @yield [child]
+  #   The given block will be passed every child of the node.
+  #
+  # @yieldparam [Nokogiri::XML::Node] node
+  #   A child node.
+  #
+  def tdiff_each_child(node,&block)
+    if node.kind_of?(Nokogiri::XML::Element)
+      node.attribute_nodes.each(&block)
+    end
+
+    node.children.each(&block)
+  end
+
+  #
+  # Finds the differences between the node and another node.
+  #
+  # @param [Nokogiri::XML::Node] other
+  #   The other node to compare against.
+  #
+  # @param [Hash] options
+  #   Additional options for filtering changes.
+  #
+  # @option options [Boolean] :added
+  #   Yield nodes that were added.
+  #
+  # @option options [Boolean] :removed
+  #   Yield nodes that were removed.
+  #
+  # @yield [change, node]
+  #   The given block will be passed each changed node.
+  #
+  # @yieldparam [' ', '-', '+'] change
+  #   Indicates whether the node stayed the same, was removed or added.
+  #
+  # @yieldparam [Nokogiri::XML::Node] node
+  #   The changed node.
+  #
+  # @return [Enumerator]
+  #   If no block was given, an Enumerator object will be returned.
+  #
+  def diff(other,options={},&block)
+    return enum_for(:diff,other,options) unless block
+
+    if (options[:added] || options[:removed])
+      tdiff_unordered(other) do |change,node|
+        if (change == '+' && options[:added])
+          yield change, node
+        elsif (change == '-' && options[:removed])
+          yield change, node
+        end
+      end
+    else
+      tdiff(other,&block)
+    end
+  end
+
+end

data/nokogiri-diff.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'nokogiri-diff.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore-core` to install Ore."
+end

data/spec/diff_spec.rb

@@ -0,0 +1,284 @@
+require 'spec_helper'
+require 'nokogiri/diff'
+
+describe "nokogiri/diff" do
+  let(:contents) { '<div><p>one</p></div>' }
+  let(:doc) { Nokogiri::XML(contents) }
+
+  let(:added_text) { Nokogiri::XML('<div><p>one</p>two</div>') }
+  let(:added_element) { Nokogiri::XML('<div><p>one</p><p>two</p></div>') }
+  let(:added_attr) { Nokogiri::XML('<div><p id="1">one</p></div>') }
+
+  let(:changed_text) { Nokogiri::XML('<div><p>two</p></div>') }
+  let(:changed_element) { Nokogiri::XML('<div><span>one</span></div>') }
+  let(:changed_attr_name) { Nokogiri::XML('<div><p i="1">one</p></div>') }
+  let(:changed_attr_value) { Nokogiri::XML('<div><p id="2">one</p></div>') }
+
+  let(:removed_text) { Nokogiri::XML('<div><p></p>two</div>') }
+  let(:removed_element) { Nokogiri::XML('<div></div>') }
+  let(:removed_attr) { Nokogiri::XML('<div><p>one</p></div>') }
+
+  it "should add #diff to Nokogiri::XML::Docuemnt" do
+    doc.should respond_to(:diff)
+  end
+
+  it "should add #diff to Nokogiri::XML::Element" do
+    added_element.at('div').should respond_to(:diff)
+  end
+
+  it "should add #diff to Nokogiri::XML::Text" do
+    added_text.at('p/text()').should respond_to(:diff)
+  end
+
+  it "should add #diff to Nokogiri::XML::Attr" do
+    added_attr.at('p/@id').should respond_to(:diff)
+  end
+
+  it "should not compare the Document objects" do
+    change = doc.diff(doc).first
+
+    change[0].should == ' '
+    change[1].should == doc.root
+  end
+
+  it "should determine when two different documents are identical" do
+    doc.diff(Nokogiri::XML(contents)).all? { |change,node|
+      change == ' '
+    }.should == true
+  end
+
+  it "should search down within Nokogiri::XML::Document objects" do
+    doc.diff(changed_text).any? { |change,node|
+      change != ' '
+    }.should == true
+  end
+
+  it "should determine when text nodes are added" do
+    changes = doc.at('div').diff(added_text.at('div')).to_a
+
+    changes.length.should == 4
+
+    changes[0][0].should == ' '
+    changes[0][1].should == doc.at('div')
+
+    changes[1][0].should == ' '
+    changes[1][1].should == doc.at('//p')
+
+    changes[2][0].should == '+'
+    changes[2][1].should == added_text.at('//div/text()')
+
+    changes[3][0].should == ' '
+    changes[3][1].should == doc.at('//p/text()')
+  end
+
+  it "should determine when elements are added" do
+    changes = doc.at('div').diff(added_element.at('div')).to_a
+
+    changes.length.should == 5
+
+    changes[0][0].should == ' '
+    changes[0][1].should == doc.at('div')
+
+    changes[1][0].should == '+'
+    changes[1][1].should == added_element.at('//p[1]')
+
+    changes[2][0].should == ' '
+    changes[2][1].should == doc.at('//p')
+
+    changes[3][0].should == '-'
+    changes[3][1].should == doc.at('//p/text()')
+
+    changes[4][0].should == '+'
+    changes[4][1].should == added_element.at('//p[2]/text()')
+  end
+
+  it "should determine when attributes are added" do
+    changes = doc.at('p').diff(added_attr.at('p')).to_a
+
+    changes.length.should == 3
+
+    changes[0][0].should == ' '
+    changes[0][1].should == doc.at('p')
+
+    changes[1][0].should == '+'
+    changes[1][1].should == added_attr.at('//p/@id')
+
+    changes[2][0].should == ' '
+    changes[2][1].should == doc.at('//p/text()')
+  end
+
+  it "should determine when text nodes differ" do
+    changes = doc.at('p').diff(changed_text.at('p')).to_a
+
+    changes.length.should == 3
+
+    changes[0][0].should == ' '
+    changes[0][1].should == doc.at('p')
+
+    changes[1][0].should == '-'
+    changes[1][1].should == doc.at('//p/text()')
+
+    changes[2][0].should == '+'
+    changes[2][1].should == changed_text.at('//p/text()')
+  end
+
+  it "should determine when element names differ" do
+    changes = doc.at('div').diff(changed_element.at('div')).to_a
+
+    changes.length.should == 3
+
+    changes[0][0].should == ' '
+    changes[0][1].should == doc.at('div')
+
+    changes[1][0].should == '-'
+    changes[1][1].should == doc.at('p')
+
+    changes[2][0].should == '+'
+    changes[2][1].should == changed_element.at('span')
+  end
+
+  it "should determine when attribute names differ" do
+    changes = added_attr.at('p').diff(changed_attr_name.at('p')).to_a
+
+    changes.length.should == 4
+
+    changes[0][0].should == ' '
+    changes[0][1].should == added_attr.at('p')
+
+    changes[1][0].should == '-'
+    changes[1][1].should == added_attr.at('//p/@id')
+
+    changes[2][0].should == '+'
+    changes[2][1].should == changed_attr_name.at('//p/@i')
+
+    changes[3][0].should == ' '
+    changes[3][1].should == added_attr.at('//p/text()')
+  end
+
+  it "should determine when attribute values differ" do
+    changes = added_attr.at('p').diff(changed_attr_value.at('p')).to_a
+
+    changes.length.should == 4
+
+    changes[0][0].should == ' '
+    changes[0][1].should == added_attr.at('p')
+
+    changes[1][0].should == '-'
+    changes[1][1].should == added_attr.at('//p/@id')
+
+    changes[2][0].should == '+'
+    changes[2][1].should == changed_attr_value.at('//p/@id')
+
+    changes[3][0].should == ' '
+    changes[3][1].should == added_attr.at('//p/text()')
+  end
+
+  it "should determine when text nodes are removed" do
+    changes = added_text.at('div').diff(removed_text.at('div')).to_a
+
+    changes.length.should == 4
+
+    changes[0][0].should == ' '
+    changes[0][1].should == added_text.at('div')
+
+    changes[1][0].should == ' '
+    changes[1][1].should == added_text.at('p')
+
+    changes[2][0].should == ' '
+    changes[2][1].should == added_text.at('//div/text()')
+
+    changes[3][0].should == '-'
+    changes[3][1].should == added_text.at('//p/text()')
+  end
+
+  it "should determine when elements are removed" do
+    changes = added_element.at('div').diff(removed_element.at('div')).to_a
+
+    changes.length.should == 3
+
+    changes[0][0].should == ' '
+    changes[0][1].should == added_element.at('div')
+
+    changes[1][0].should == '-'
+    changes[1][1].should == added_element.at('//p[1]')
+
+    changes[2][0].should == '-'
+    changes[2][1].should == added_element.at('//p[2]')
+  end
+
+  it "should determine when attributes are removed" do
+    changes = added_attr.at('div').diff(removed_attr.at('div')).to_a
+
+    changes.length.should == 4
+
+    changes[0][0].should == ' '
+    changes[0][1].should == added_attr.at('div')
+
+    changes[1][0].should == ' '
+    changes[1][1].should == added_attr.at('p')
+
+    changes[2][0].should == '-'
+    changes[2][1].should == added_attr.at('//p/@id')
+
+    changes[3][0].should == ' '
+    changes[3][1].should == added_attr.at('//p/text()')
+  end
+
+  context ":added" do
+    it "should determine only when text nodes are added" do
+      changes = doc.at('div').diff(added_text.at('div'), :added => true).to_a
+
+      changes.length.should == 1
+
+      changes[0][0].should == '+'
+      changes[0][1].should == added_text.at('//div/text()')
+    end
+
+    it "should determine only when elements are added" do
+      changes = doc.at('div').diff(added_element.at('div'), :added => true).to_a
+
+      changes.length.should == 1
+
+      changes[0][0].should == '+'
+      changes[0][1].should == added_element.at('//div/p[2]')
+    end
+
+    it "should determine only when attributes are added" do
+      changes = doc.at('div').diff(added_attr.at('div'), :added => true).to_a
+
+      changes.length.should == 1
+
+      changes[0][0].should == '+'
+      changes[0][1].should == added_attr.at('//p/@id')
+    end
+  end
+
+  context ":removed" do
+    it "should determine only when text nodes are removed" do
+      changes = doc.at('div').diff(removed_text.at('div'), :removed => true).to_a
+
+      changes.length.should == 1
+
+      changes[0][0].should == '-'
+      changes[0][1].should == doc.at('//p/text()')
+    end
+
+    it "should determine only when elements are removed" do
+      changes = doc.at('div').diff(removed_element.at('div'), :removed => true).to_a
+
+      changes.length.should == 1
+
+      changes[0][0].should == '-'
+      changes[0][1].should == doc.at('//div/p')
+    end
+
+    it "should determine only when attributes are removed" do
+      changes = added_attr.at('div').diff(removed_attr.at('div'), :removed => true).to_a
+
+      changes.length.should == 1
+
+      changes[0][0].should == '-'
+      changes[0][1].should == added_attr.at('//p/@id')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+gem 'rspec', '~> 2.2.0'
+require 'rspec'

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: nokogiri-diff
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-29 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tdiff
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id005
+description: Nokogiri::Diff adds the ability to calculate the differences (added or removed nodes) between two XML/HTML documents.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- ChangeLog.md
+- LICENSE.txt
+files: 
+- .document
+- .rspec
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/nokogiri/diff.rb
+- lib/nokogiri/diff/xml.rb
+- lib/nokogiri/diff/xml/document.rb
+- lib/nokogiri/diff/xml/node.rb
+- nokogiri-diff.gemspec
+- spec/diff_spec.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/nokogiri-diff
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: nokogiri-diff
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Calculate the differences between two XML/HTML documents.
+test_files: 
+- spec/diff_spec.rb