deltoid 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+gem 'nokogiri', '~> 1.4'
+
+group :development do
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 1.5'
+  gem 'rspec', '~> 2.1'
+  gem 'unindentable'
+end
+
+# gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.3.1)
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    unindentable (0.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 1.5)
+  nokogiri (~> 1.4)
+  rspec (~> 2.1)
+  unindentable

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 David James
+
+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,17 @@
+# Deltoid
+
+Deltoid finds differences between HTML files.
+
+## Contributing to deltoid
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature or bug fix branch.
+* Commit and push until you are happy with your contribution.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2010 David James. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification
+  # (See http://docs.rubygems.org/read/chapter/20 for more options)
+  gem.name = "deltoid"
+  gem.homepage = "http://github.com/djsun/deltoid"
+  gem.license = "MIT"
+  gem.summary = %Q{Deltoid finds differences between two or more HTML documents.}
+  gem.description = %Q{Deltoid diffs HTML documents using a relatively simple N-way algorithm. It reports deltas as an array of hashes, where each hash contains :content, :xpath, and :index keys.}
+  gem.email = "davidcjames@gmail.com"
+  gem.authors = ["David James"]
+
+  gem.add_runtime_dependency 'nokogiri', '~> 1.4'
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'jeweler', '~> 1.5'
+  gem.add_development_dependency 'rspec', '~> 2.1'
+  gem.add_development_dependency 'unindentable'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = "-c -fd" # color, documentation format
+end
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/deltoid.rb

@@ -0,0 +1,154 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'set'
+require 'nokogiri'
+
+class Deltoid
+  def initialize(strings)
+    @strings = strings
+    @parsed = @strings.map { |s| self.class.parse(s) }
+  end
+
+  # Find the differences between the documents.
+  def delta
+    deltas = self.class.delta_documents(@parsed)
+    self.class.friendly_deltas(deltas, @parsed)
+  end
+
+  def self.friendly_deltas(deltas, root_nodes)
+    deltas.map do |delta|
+      root = delta.ancestors.last
+      {
+        :index   => root_nodes.find_index(root),
+        :content => delta.content,
+        :xpath   => delta.path,
+      }
+    end
+  end
+
+  # Returns an array of nodes that are different between +documents+.
+  def self.delta_documents(documents)
+    roots = documents.map { |document| document.root }
+    delta_nodes(roots)
+  end
+
+  # Returns an array of nodes that are different between +nodes+.
+  #
+  # Idea: could this be rewritten as a special case of delta_nodes_group?
+  def self.delta_nodes(nodes)
+    deltas = []
+    deltas.concat(nodes) unless match?(nodes)
+    deltas.concat(delta_children_nodes(nodes))
+  end
+
+  # Returns an array of nodes that are different between +nodes+.
+  def self.delta_children_nodes(nodes)
+    children = nodes.map { |node| node.children.select { |k| k.element? } }
+    delta_nodes_group(children)
+  end
+
+  def self.delta_nodes_group(nodes_group)
+    matches_group = find_matches_group(nodes_group)
+    deltas = find_deltas(nodes_group, matches_group)
+    matches_group.each do |matches|
+      deltas.concat(delta_children_nodes(matches))
+    end
+    deltas
+  end
+
+  # Parameters:
+  #   +all_nodes_group+ is an array of an array of nodes, with the same
+  #   length as the number of documents being diffed.
+  # Returns:
+  #   an array of array of nodes that match each other
+  def self.find_matches_group(all_nodes_group)
+    first_nodes = all_nodes_group.first
+    remaining_nodes_group = all_nodes_group.drop(1)
+    matches_group = []
+    first_nodes.each do |node|
+      matches = find_matches_in(node, remaining_nodes_group)
+      matches_group << matches unless matches.empty?
+    end
+    matches_group
+  end
+
+  # If +node+ can be found in each of +remaining_nodes_group+, return an
+  # array of each matching node. Otherwise, return [].
+  #
+  # Parameters:
+  #   +nodes_group+ is an array of an array of nodes, with the same length
+  #   as the number of documents being diffed.
+  # Returns:
+  #   An array containing each matched node; otherwise [].
+  def self.find_matches_in(node, remaining_nodes_group)
+    matches = [node]
+    remaining_nodes_group.each do |nodes_group|
+      match = find_match(node, nodes_group)
+      if match
+        matches << match
+      else
+        matches = []
+        break
+      end
+    end
+    matches
+  end
+
+  # If +the_node+ matches a node in +node_group+, return the latter node.
+  # Otherwise, return nil.
+  #
+  # Note: stops after finding the first match.
+  def self.find_match(the_node, nodes)
+    nodes.each do |node|
+      return node if match?([the_node, node])
+    end
+    nil
+  end
+
+  # Figure out the deltas (differences) based on:
+  #   +nodes_group+ (an array of array of nodes)
+  #   +matches_group+ (an array of array of nodes)
+  def self.find_deltas(nodes_group, matches_group)
+    nodes_group.flatten - matches_group.flatten
+  end
+
+  # Do the +nodes+ match?
+  def self.match?(nodes)
+    names = nodes.map { |node| node.name }.uniq
+    names.length == 1 && attributes_match?(nodes) && content_match?(nodes)
+  end
+
+  # Do the attributes of the +nodes+ match?
+  def self.attributes_match?(nodes)
+    attributes = nodes.map { |node| attributes(node) }.uniq
+    attributes.length == 1
+  end
+
+  # Does the content of the +nodes+ match? (Note: only applies to nodes whose
+  # children are all text nodes.)
+  def self.content_match?(nodes)
+    return true if nodes.any? { |node| !all_children_are_text?(node) }
+    content = nodes.map { |node| node.content }.uniq
+    content.length == 1
+  end
+
+  def self.attributes(node)
+    map = {}
+    node.attributes.values.each do |attribute|
+      name, value = attribute.name, attribute.value
+      map[name] = value
+    end
+    map
+  end
+
+  # (Internal API)
+  def self.all_children_are_text?(node)
+    node.children.all? { |x| x.text? }
+  end
+
+  # (Internal API)
+  def self.parse(item)
+    Nokogiri::HTML::Document.parse(item)
+  end
+
+end

data/spec/1_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe '3 identical documents' do
+  include Unindentable
+
+  def template
+    unindent <<-END
+      <p class="intro">Introduction...</p>
+      <ul class="list">
+        <li>A</li>
+        <li>B</li>
+        <li>C</li>
+      </ul>
+      <p class="summary">Summary...</p>
+    END
+  end
+
+  before do
+    docs = [template, template, template]
+    @deltoid = Deltoid.new(docs)
+  end
+
+  it 'delta should be correct' do
+    @deltoid.delta.should == []
+  end
+
+end

data/spec/2_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe '3 documents, 3 <li>, 1 different <li>' do
+  include Unindentable
+
+  def template(x)
+    unindent <<-END
+      <html>
+        <body>
+          <p class="begin">Begin</p>
+          <ul class="list">
+            <li>A</li>
+            <li>B</li>
+            <li>#{x}</li>
+          </ul>
+          <p class="end">End</p>
+        </body>
+      </html>
+    END
+  end
+
+  before do
+    docs = [template('X'), template('Y'), template('Z')]
+    @deltoid = Deltoid.new(docs)
+  end
+
+  it 'delta should be correct' do
+    actual = @deltoid.delta
+    actual.length.should == 3
+    actual.should include({
+      :index   => 0,
+      :content => 'X',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+    actual.should include({
+      :index   => 1,
+      :content => 'Y',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+    actual.should include({
+      :index   => 2,
+      :content => 'Z',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+  end
+
+end

data/spec/3_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe '3 documents, id attribute, 3 <li>' do
+  include Unindentable
+
+  def template(x)
+    unindent <<-END
+      <html>
+        <body>
+          <p class="begin" id="begin_0">Begin</p>
+          <ul class="list">
+            <li>A</li>
+            <li>B</li>
+            <li>#{x}</li>
+          </ul>
+          <p class="end">End</p>
+        </body>
+      </html>
+    END
+  end
+
+  before do
+    docs = [template('X'), template('Y'), template('Z')]
+    @deltoid = Deltoid.new(docs)
+  end
+
+  it 'delta should be correct' do
+    actual = @deltoid.delta
+    actual.length.should == 3
+    actual.should include({
+      :index   => 0,
+      :content => 'X',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+    actual.should include({
+      :index   => 1,
+      :content => 'Y',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+    actual.should include({
+      :index   => 2,
+      :content => 'Z',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+  end
+
+end

data/spec/4_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe '3 documents, 4 <li>' do
+  include Unindentable
+
+  def template(x)
+    unindent <<-END
+      <html>
+        <body>
+          <p class="begin">Begin</p>
+          <ul class="list">
+            <li>A</li>
+            <li>B</li>
+            <li>#{x}</li>
+            <li>D</</il>
+          </ul>
+          <p class="end">End</p>
+        </body>
+      </html>
+    END
+  end
+
+  before do
+    docs = [template('X'), template('Y'), template('Z')]
+    @deltoid = Deltoid.new(docs)
+  end
+
+  it 'delta should be correct' do
+    actual = @deltoid.delta
+    actual.length.should == 3
+    actual.should include({
+      :index   => 0,
+      :content => 'X',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+    actual.should include({
+      :index   => 1,
+      :content => 'Y',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+    actual.should include({
+      :index   => 2,
+      :content => 'Z',
+      :xpath   => '/html/body/ul/li[3]',
+    })
+  end
+
+end

data/spec/5_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe '3 documents, 3 <li>, 1 different class' do
+  include Unindentable
+
+  def template(x = nil)
+    unindent <<-END
+      <html>
+        <body>
+          <p>Begin</p>
+          <ul class="list">
+            <li>A</li>
+            <li#{x ? " #{x}" : ""}>B</li>
+            <li>C</li>
+          </ul>
+          <p>End</p>
+        </body>
+      </html>
+    END
+  end
+
+  before do
+    docs = [template, template("class='special'"), template]
+    @deltoid = Deltoid.new(docs)
+  end
+
+  it 'delta should be correct' do
+    actual = @deltoid.delta
+    actual.length.should == 3
+    actual.should include({
+      :index   => 0,
+      :content => 'B',
+      :xpath   => '/html/body/ul/li[2]',
+    })
+    actual.should include({
+      :index   => 1,
+      :content => 'B',
+      :xpath   => '/html/body/ul/li[2]',
+    })
+    actual.should include({
+      :index   => 2,
+      :content => 'B',
+      :xpath   => '/html/body/ul/li[2]',
+    })
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../../lib/deltoid', __FILE__)
+require 'rspec'
+require 'unindentable'

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification 
+name: deltoid
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David James
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: nokogiri
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: unindentable
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: nokogiri
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: unindentable
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id010
+description: Deltoid diffs HTML documents using a relatively simple N-way algorithm. It reports deltas as an array of hashes, where each hash contains :content, :xpath, and :index keys.
+email: davidcjames@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/deltoid.rb
+- spec/1_spec.rb
+- spec/2_spec.rb
+- spec/3_spec.rb
+- spec/4_spec.rb
+- spec/5_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/djsun/deltoid
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Deltoid finds differences between two or more HTML documents.
+test_files: 
+- spec/1_spec.rb
+- spec/2_spec.rb
+- spec/3_spec.rb
+- spec/4_spec.rb
+- spec/5_spec.rb
+- spec/spec_helper.rb