test_xml 0.1.6 → 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 170f3a3dbcbac8bf470d5502cf240c9c1b24313b
+  data.tar.gz: 3532c7033ca564336d94d06e3b1fd5ed5637ee56
+SHA512:
+  metadata.gz: 935649d551777890cdfe7406ae93012785768da1746e6d0b2b4da2d8b6445d78b15ec69afffb137d5f28a2c0907ba42080aee04b7522025ce3bb0ef5734fed97
+  data.tar.gz: 85bf8823b75aa6701ccc5eabf11c27e37ed8014d667ceb9b34ab594cbe28786338c4406c0a455d5a4190fbc0e55a70622e218057f971659d7e29999ac42c8fc2

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 0.1.7 (Unreleased)
+
+* Add diff output to xml_equal
+* Add support for RSpec 3
+* Fix order of expected result and actual result for RSpec
+
 # 0.1.6
 
 * Fix dependencies so that Minitest doesn't rely on Test::Unit anymore. If you having trouble, update to minitest > 4.0.0 :)
@@ -12,4 +18,4 @@
 
 # 0.1.3
 
-* Adding support for `MiniTest::Spec` matchers.
+* Adding support for `MiniTest::Spec` matchers.

data/README.rdoc

@@ -1,16 +1,15 @@
 = TestXml
 
-
-== DESCRIPTION:
+== DESCRIPTION
 
 TestXml is a small extension for testing XML/HTML. Extending RSpec and TestUnit it makes asserting and comparing XML snippets easy, and is especially helpful for testing RESTful web services and their XML representations.
 
 
-== FEATURES:
+== FEATURES
 
-* runs with RSpec2, Test::Unit, MiniTest and Cucumber
-* Ruby 1.8 and 1.9
-* test XML structure and content
+* Runs with RSpec 2 or 3, Test::Unit, MiniTest and Cucumber
+* Ruby >= 1.8
+* Test XML structure and content
 
 
 == INSTALL
@@ -18,7 +17,7 @@ TestXml is a small extension for testing XML/HTML. Extending RSpec and TestUnit
   gem install test_xml
 
 
-== EXAMPLES:
+== EXAMPLES
 
 === Test::Unit and MiniTest
 
@@ -101,6 +100,41 @@ In your steps file e.g. features/step_definitions/xml_steps.rb add this step:
     response.body.should equal_xml(xml)
   end
 
+== ASSERTIONS
+
+=== XML is Equal
+
+Elements, attributes and text nodes are all the same
+
+=== XML Contains
+
+The XML contains the given structure. Checks ancestral relationships, elements, attributes and text nodes <b>starting from and including the root node</b>.
+
+For example, given this XML:
+
+  <a>
+    <b><c>Cee</c></b>
+    <d>Dee</b>
+  </a>
+
+This will fail: 
+
+  <b><c>Cee</c></b>
+
+as +b+ is not the root node. The check must be written as: 
+
+  <a>
+    <b><c>Cee</c></b>
+  </a>
+
+=== XML Structure is Equal
+
+Like XML is equal, but ignores attributes and text nodes
+
+=== XML Structure Contains
+
+Like XML contains, but ignores attributes and text nodes
+
 == REQUIREMENTS
 
 * nokogiri

data/lib/test_xml/assertions.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'diffy'
 
 module TestXml
   class AssertionConfig < OpenStruct
@@ -19,37 +20,48 @@ module TestXml
     AssertionConfig.new(
       :name       => :xml_contain,
       :matcher    => :contain_xml,
-      :message_for_should     => lambda { |a,b| "the xml:\n#{a}\nshould contain xml:\n#{b}" },
-      :message_for_should_not => lambda { |a,b| "the xml:\n#{a}\nshould not contain xml:\n#{b} but it does" }
+      :message    => lambda { |expect, actual| "the xml:\n#{actual}\nshould contain xml:\n#{expect}" },
+      :message_when_negated => lambda { |expect, actual| "the xml:\n#{actual}\nshould not contain xml:\n#{expect} but it does" }
     ),
     AssertionConfig.new(
       :name       => :xml_structure_contain,
       :matcher    => :contain_xml_structure,
-      :message_for_should     => lambda { |a,b| "the xml:\n#{a}\nshould match xml structure:\n#{b}" },
-      :message_for_should_not => lambda { |a,b| "the xml:\n#{a}\nshould not match xml structure:\n#{b} but it does" }
+      :message    => lambda { |expect, actual| "the xml:\n#{actual}\nshould match xml structure:\n#{expect}" },
+      :message_when_negated => lambda { |expect, actual| "the xml:\n#{actual}\nshould not match xml structure:\n#{expect} but it does" }
     ),
     AssertionConfig.new(
       :name       => :xml_equal,
       :matcher    => :equal_xml,
-      :message_for_should     => lambda { |a,b| "the xml:\n#{a}\nshould exactly match xml:\n#{b}" },
-      :message_for_should_not => lambda { |a,b| "the xml:\n#{a}\nshould not exactly match xml:\n#{b} but it does" }
+      :message    => lambda { |expect, actual| sprintf "the xml:\n%s\nshould exactly match xml:\n%s\n\nDiff:\n%s", actual, expect, diff(expect, actual) },
+      :message_when_negated => lambda { |expect, actual| "the xml:\n#{actual}\nshould not exactly match xml:\n#{expect} but it does" }
     ),
     AssertionConfig.new(
       :name       => :xml_structure_equal,
       :matcher    => :equal_xml_structure,
-      :message_for_should     => lambda { |a,b| "the xml:\n#{a}\nshould exactly match xml structure:\n#{b}" },
-      :message_for_should_not => lambda { |a,b| "the xml:\n#{a}\nshould not exactly match xml structure:\n#{b} but it does" }
+      :message    => lambda { |expect, actual| "the xml:\n#{actual}\nshould exactly match xml structure:\n#{expect}" },
+      :message_when_negated => lambda { |expect, actual| "the xml:\n#{actual}\nshould not exactly match xml structure:\n#{expect} but it does" }
     )
   ]
 
+  def self.diff(expect, actual)
+    doc_actual = Nokogiri::XML.parse(actual, &:noblanks)
+    doc_expect = Nokogiri::XML.parse(expect, &:noblanks)
+
+    diff = Diffy::Diff.new(doc_expect.to_xml, doc_actual.to_xml, :context => 3, :include_diff_info => true).to_a
+    return "" if diff.empty?
+
+    # Skip diff headers, they're useless since they refer to tempfiles
+    diff[2..-1].join("")
+  end
+
   module Assertions
     ASSERTIONS.each do |cfg|
       define_method(cfg.assert_name) do |a, b|
-        correct_assert(MatcherMethods.send(cfg.name, a, b), cfg.message_for_should.call(a, b))
+        correct_assert(MatcherMethods.send(cfg.name, a, b), cfg.message.call(a, b))
       end
 
       define_method(cfg.assert_not_name) do |a, b|
-        correct_assert(! MatcherMethods.send(cfg.name, a, b), cfg.message_for_should_not.call(a, b))
+        correct_assert(! MatcherMethods.send(cfg.name, a, b), cfg.message_when_negated.call(a, b))
       end
     end
 
@@ -64,4 +76,4 @@ module TestXml
       end
     end
   end
-end
+end

data/lib/test_xml/spec.rb

@@ -7,12 +7,15 @@ TestXml::ASSERTIONS.each do |cfg|
       TestXml::MatcherMethods.send(cfg.name, actual, expected)
     end
 
-    failure_message_for_should do |actual|
-      cfg.message_for_should.call(expected, actual)
+    # RSpec 2 and 3 use different methods
+    # to access failure messages.
+    if RSpec::Expectations::Version::STRING[0] == "2"
+      failure_message_for_should { |actual| cfg.message.call(expected, actual) }
+      failure_message_for_should_not { |actual| cfg.message_when_negated.call(expected, actual) }
+    else
+      failure_message { |actual| cfg.message.call(expected, actual) }
+      failure_message_when_negated { |actual| cfg.message_when_negated.call(expected, actual) }
     end
 
-    failure_message_for_should_not do |actual|
-      cfg.message_for_should_not.call(expected, actual)
-    end
   end
-end
+end

data/lib/test_xml/version.rb

@@ -1,3 +1,3 @@
 module TestXml
-  VERSION = '0.1.6'
+  VERSION = "0.1.7"
 end

data/test/test_unit/test_assertions.rb

@@ -5,7 +5,7 @@ class TestAssertions < Test::Unit::TestCase
     begin
       assert_xml_contain("<root><one>1</one><one>2</one></root>", "<root><one>3</one></root>")
     rescue Exception => e
-      assert_match %r{the xml:\n<root><one>1</one><one>2</one></root>\nshould contain xml:\n<root><one>3</one></root>}, e.message
+      assert_match %r{the xml:\n<root><one>3</one></root>\nshould contain xml:\n<root><one>1</one><one>2</one></root>}, e.message
     end
   end
 

data/test_xml.gemspec

@@ -20,9 +20,10 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   
   s.rubygems_version	= "1.3.5"
+  s.add_dependency("diffy",          ["~> 3.0"])
   s.add_dependency("nokogiri",       [">= 1.3.2"])
   
   s.add_development_dependency("rake")
   s.add_development_dependency("rdoc")
-  s.add_development_dependency("rspec-core", ["~> 2.2"])
+  s.add_development_dependency("rspec-core", [">= 2.2"])
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test_xml
 version: !ruby/object:Gem::Version
-  version: 0.1.6
-  prerelease: 
+  version: 0.1.7
 platform: ruby
 authors:
 - Pavel Gabriel
@@ -10,74 +9,80 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
-description: ! 'Test your XML with Test::Unit, MiniTest, RSpec, or Cucumber using
-  handy assertions like #assert_xml_equal or #assert_xml_structure_contain.'
+description: 'Test your XML with Test::Unit, MiniTest, RSpec, or Cucumber using handy
+  assertions like #assert_xml_equal or #assert_xml_structure_contain.'
 email:
 - alovak@gmail.com
 - apotonick@gmail.com
@@ -86,7 +91,7 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- .gitignore
+- ".gitignore"
 - CHANGES.md
 - Gemfile
 - README.rdoc
@@ -111,28 +116,35 @@ files:
 - test_xml.gemspec
 homepage: http://github.com/alovak/test_xml
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.rdoc
 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.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Test your XML with Test::Unit, MiniTest, RSpec, or Cucumber.
-test_files: []
+test_files:
+- spec/matchers/contain_xml_spec.rb
+- spec/matchers/contain_xml_structure_spec.rb
+- spec/matchers/equal_xml_spec.rb
+- spec/matchers/equal_xml_structure_spec.rb
+- spec/spec_helper.rb
+- test/nokogiri/test_node.rb
+- test/test_helper.rb
+- test/test_unit/test_assertions.rb