spp_nokogiri_ext 0.0.4

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+

data/.rvmrc

@@ -0,0 +1 @@
+rvm use `./rubyversion` > /dev/null

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://gems.devint.lpo'
+source "http://rubygems.org/"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    spp_nokogiri_ext (0.0.4)
+      activesupport
+      nokogiri
+
+GEM
+  remote: http://gems.devint.lpo/
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    nokogiri (1.5.2)
+    nokogiri-diff (0.1.1)
+      nokogiri (~> 1.5)
+      tdiff (~> 0.3.2)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    tdiff (0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nokogiri-diff
+  rake
+  rspec
+  spp_nokogiri_ext!

data/Rakefile

@@ -0,0 +1,10 @@
+load 'lib/tasks/gem.rake'
+require 'rspec/core/rake_task'
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end

data/build

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+if [ -a $HOME/.bashrc ]; then
+  source $HOME/.bashrc
+fi
+if [ -a /etc/profile.d/rvm.sh ]; then
+  source /etc/profile.d/rvm.sh
+fi
+set -e
+LOCATION=`dirname $0`
+rvm `$LOCATION/rubyversion` do ruby ./build.rb $@

data/build.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+#!/usr/bin/env ruby
+Dir.chdir(File.dirname(__FILE__))
+puts `gem install bundler` unless `gem list`.match /bundler/
+system('bundle install --path $HOME/.bundle')
+require 'rubygems'
+require 'bundler/setup'
+
+rake_args = ARGV.empty? ? [] : ARGV
+exec(*(%w{bundle exec rake} + rake_args))

data/lib/spp_nokogiri_ext/dom_matcher.rb

@@ -0,0 +1,77 @@
+# encoding: UTF-8
+
+require 'nokogiri'
+require 'nokogiri/diff'
+
+
+if defined?(RSpec) && defined?(RSpec::Matchers)
+  RSpec::Matchers
+else
+  Spec::Matchers
+end.define :match_the_dom_of do |expected_xml_string|
+
+  def describe(string)
+    string ? string.to_s.gsub('"', "'").strip.inspect : 'NIL'
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that #{describe(actual)} would not match the dom of #{describe(expected)}"
+  end
+
+  failure_message_for_should do |actual|
+    actual = actual.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::NO_DECLARATION) if actual.is_a? Nokogiri::XML::Document
+    <<-MESSAGE
+
+expected:
+#{describe(expected.first.squish) }
+
+to equal:
+#{describe(actual.squish) }
+
+diff:
+#{pretty_diff(expected.first, actual)}
+  (compared using Hash.from_xml.eql?)
+  MESSAGE
+  end
+
+  failure_message_for_should_not do |actual|
+    <<-MESSAGE
+
+expected:
+#{describe(expected.squish) }
+
+not to equal actual:
+#{describe(actual.squish) }
+
+diff:
+#{pretty_diff(expected.first, actual)}
+  (compared using Hash.from_xml.eql?)
+  MESSAGE
+  end
+
+  match do |actual_xml_string|
+    expected_hash = Hash.from_xml(hacky_canonicalise(expected_xml_string))
+    actual_hash = Hash.from_xml(hacky_canonicalise(actual_xml_string))
+    (expected_hash == actual_hash)
+  end
+
+  def hacky_canonicalise(xml_string)
+    xml_string.to_s.gsub('  ', '').gsub("\n", '')
+  end
+
+  def pretty_diff(expected_xml_string, actual_xml_string)
+    expected_doc = Nokogiri::XML.parse(hacky_canonicalise(expected_xml_string))
+    actual_doc = Nokogiri::XML.parse(hacky_canonicalise(actual_xml_string))
+    diff = ''
+
+    expected_doc.diff(actual_doc, :added => true) do |change, node|
+      diff << "+ #{node.to_html.ljust(80) + node.parent.path}\n"
+    end
+
+    expected_doc.diff(actual_doc, :removed => true) do |change, node|
+      diff << "- #{node.to_html.ljust(80) + node.parent.path}\n"
+    end
+
+    diff
+  end
+end

data/lib/spp_nokogiri_ext/spec_helpers.rb

@@ -0,0 +1,2 @@
+require 'spp_nokogiri_ext/dom_matcher'
+require 'spp_nokogiri_ext/xml_matcher'

data/lib/spp_nokogiri_ext/xml_matcher.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+
+if defined?(RSpec) && defined?(RSpec::Matchers)
+  RSpec::Matchers
+else
+  Spec::Matchers
+end.define :match_xml do |expected_xml|
+
+  failure_message_for_should do |actual|
+    <<-MESSAGE
+
+expected first, but got second:
+#{expected}
+
+actual:
+#{actual}
+  MESSAGE
+  end
+
+  failure_message_for_should_not do |actual|
+    <<-MESSAGE
+
+expected actual not to equal expected:
+#{expected}
+
+actual:
+#{actual}
+  MESSAGE
+  end
+
+  match do |actual_xml|
+    begin
+      expected_hash = Hash.from_xml(expected_xml.to_s.gsub('  ', '').gsub("\n", ''))
+      actual_hash = Hash.from_xml(actual_xml.to_s.gsub('  ', '').gsub("\n", ''))
+    rescue NoMethodError, REXML::ParseException => e # Hash.from_xml uses rexml, yech
+      puts "failed XML parse: #{e.name}"
+      # Returns false immediately.
+      next false
+    end
+
+    unless expected_hash == actual_hash
+      puts "Expected: " + expected_hash.inspect
+      puts "Actual: " + actual_hash.inspect
+    end
+
+    (expected_hash == actual_hash)
+  end
+end

data/lib/spp_nokogiri_ext.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+require 'nokogiri'
+module Nokogiri
+  def self.strict_xml(string)
+    Nokogiri::XML(string, nil, nil, Nokogiri::XML::ParseOptions::STRICT)
+  end
+end

data/lib/tasks/gem.rake

@@ -0,0 +1,18 @@
+require 'lib/version'
+namespace "gem" do
+
+  desc "Build a gem ready to push to gems.devint.lpo"
+  task "package" do
+    sh "gem build spp_nokogiri_ext.gemspec"
+  end
+
+  desc "Push the current version of the gem to gems.devint.lpo"
+  task "push_to_devint" do
+    sh "scp spp_nokogiri_ext-#{SppNokogiriExt::VERSION}.gem gems.devint.lpo:/lp/gem-repo/gems"
+    sh "ssh gems.devint.lpo 'gem generate_index -d /lp/gem-repo'"
+  end
+
+  desc "Build the current version & push it to gems.devint.lpo"
+  task "build_and_push" => ['gem:package', 'gem:push_to_devint']
+
+end

data/lib/version.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+module SppNokogiriExt
+  VERSION = '0.0.4'
+end

data/rubyversion

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+RUBY=ree
+
+if [ -a ~/.babushka/deps/ree_version ]; then
+  RUBY=`cat ~/.babushka/deps/ree_version`
+fi
+echo $RUBY

data/spec/matchers/dom_matcher_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe 'DOM matcher' do
+
+  it 'correctly identifies identical DOMs' do
+    '<foo><bar>baz</bar></foo>'.should match_the_dom_of '<foo><bar>baz</bar></foo>'
+  end
+
+  it 'correctly identifies different DOMs' do
+    '<foo><bar>baz</bar></foo>'.should_not match_the_dom_of '<foo><qux>baz</qux>quo</foo>'
+  end
+
+  # DB: this may be existing behaviour but I believe it's wrong; I don't think they _are_ equivalent
+  it 'treats whitespace between tags as equivalent to an empty closed tag' do
+    '<foo>  </foo>'.should match_the_dom_of '<foo />'
+  end
+
+  it 'raises an exception when the expected XML is invalid' do
+    lambda { '<foo>'.should match_the_dom_of '<foo />'}.should raise_exception
+  end
+
+  it 'raises an exception when the actual XML is invalid' do
+    lambda { '<foo />'.should match_the_dom_of '<foo>'}.should raise_exception
+  end
+
+  describe 'prints a pretty diff when the match' do
+    before do
+      @pretty_failure = <<-PRETTY
+
+expected:
+"<foo><qux>baz</qux>quo</foo>"
+
+to equal:
+"<foo><bar>baz</bar></foo>"
+
+diff:
++ <bar>baz</bar>                                                                  /foo
+- <qux>baz</qux>                                                                  /foo
+- quo                                                                             /foo
+
+  (compared using Hash.from_xml.eql?)
+  PRETTY
+    end
+
+    it 'fails for two strings' do
+      expectation = lambda { '<foo><bar>baz</bar></foo>'.should match_the_dom_of '<foo><qux>baz</qux>quo</foo>'}
+      output_for_failing_expectation(expectation).should == @pretty_failure
+    end
+
+    it 'fails for a Nokogiri doc and a string' do
+      expectation = lambda { Nokogiri::XML('<foo><bar>baz</bar></foo>').should match_the_dom_of '<foo><qux>baz</qux>quo</foo>'}
+      output_for_failing_expectation(expectation).should == @pretty_failure
+    end
+  end
+
+  def output_for_failing_expectation(expectation)
+    begin
+      expectation.call
+    rescue RSpec::Expectations::ExpectationNotMetError => e
+      return e.to_s
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'spp_nokogiri_ext/spec_helpers'
+require 'active_support/all'

data/spp_nokogiri_ext.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  # Metadata
+  s.name        = "spp_nokogiri_ext"
+  s.version     = SppNokogiriExt::VERSION
+  s.authors     = ["Daniel Heath"]
+  s.email       = ["daniel.heath@lonelyplanet.com.au"]
+  s.homepage    = ""
+  s.summary     = %q{Extensions to Nokogiri used across SPP programs}
+  s.description = %q{Extensions to Nokogiri used across SPP programs}
+
+  # Manifest
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "nokogiri"
+#  s.add_runtime_dependency "nokogiri-diff" # This currently requires that an up-to-date version of rubygems be installed (our app servers need updating - see INC478208)
+  s.add_development_dependency "nokogiri-diff" # TODO Remove this once INC478208 is resolved.
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: spp_nokogiri_ext
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Daniel Heath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  name: nokogiri-diff
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id005
+  prerelease: false
+description: Extensions to Nokogiri used across SPP programs
+email: 
+- daniel.heath@lonelyplanet.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- build
+- build.rb
+- lib/spp_nokogiri_ext.rb
+- lib/spp_nokogiri_ext/dom_matcher.rb
+- lib/spp_nokogiri_ext/spec_helpers.rb
+- lib/spp_nokogiri_ext/xml_matcher.rb
+- lib/tasks/gem.rake
+- lib/version.rb
+- rubyversion
+- spec/matchers/dom_matcher_spec.rb
+- spec/spec_helper.rb
+- spp_nokogiri_ext.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 
+      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.8.24
+signing_key: 
+specification_version: 3
+summary: Extensions to Nokogiri used across SPP programs
+test_files: 
+- spec/matchers/dom_matcher_spec.rb
+- spec/spec_helper.rb