test_xml 0.0.1

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+task :default => ['test:units', :spec]
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.test_files = FileList['test/**/test_*.rb']
+    t.libs << "test"
+    t.verbose = true
+  end
+end
+
+
+Spec::Rake::SpecTask.new do |t|
+    t.libs << "spec"
+    t.verbose = true
+end

data/lib/test_xml.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'nokogiri'
+
+module TestXml
+  VERSION = '0.0.1'
+end
+
+require File.dirname(__FILE__) + '/../lib/test_xml/matchers'
+require File.dirname(__FILE__) + '/../lib/test_xml/nokogiri/node'
+require File.dirname(__FILE__) + '/../lib/test_xml/nokogiri'

data/lib/test_xml/matchers.rb

@@ -0,0 +1,21 @@
+module TestXml
+  module Matchers
+    class XmlMatcher
+      attr_reader :subject, :pattern, :compare_value
+      def initialize(subject, pattern, compare_value)
+        @subject = Nokogiri::XML::Document.parse(subject)
+        @pattern = Nokogiri::XML::Document.parse(pattern)
+        @compare_value = compare_value
+      end
+
+      def match?
+        subject.match?(pattern, compare_value)
+      end
+    end
+
+    def match_xml?(subject, pattern, compare_value = false)
+      matcher = XmlMatcher.new(subject, pattern, compare_value)
+      matcher.match?
+    end
+  end
+end

data/lib/test_xml/nokogiri.rb

@@ -0,0 +1,3 @@
+class Nokogiri::XML::Node
+  include TestXml::NokogiriExt::Node
+end

data/lib/test_xml/nokogiri/node.rb

@@ -0,0 +1,35 @@
+module TestXml
+  module NokogiriExt
+    module Node
+      def match?(element, compare_value = false)
+        if compare_value && element.text_element?
+          equal_text?(element)
+        else
+          contains_elements_of?(element) &&
+          !element.elements.find {|el| not at(el.name).match?(el, compare_value) }
+        end
+      end
+
+      def elements
+        children.collect {|node| node if node.element? }.delete_if {|node| node.nil?}
+      end
+
+      def text_element?
+        children.size == 1 && children.first.text?
+      end
+
+      private
+      def equal_text?(element)
+        content == element.content
+      end
+
+      def contains_elements_of?(element)
+        element.elements.find {|el| not contains?(el)}.nil?
+      end
+
+      def contains?(element)
+        children.find {|node| node.element? && node.name == element.name }
+      end
+    end
+  end
+end

data/lib/test_xml/spec.rb

@@ -0,0 +1,42 @@
+module TestXml
+  module Spec
+    class MatchXml
+      include TestXml::Matchers
+
+      def initialize(expected, compare_values = false)
+        @expected = expected
+        @compare_values = compare_values
+      end
+
+      def matches?(actual)
+        @actual = actual
+        match_xml?(@actual, @expected, @compare_values)
+      end
+
+      def failure_message_for_should
+        "expected\n#{@actual} to match#{structure_message}\n#{@expected}"
+      end
+
+      def failure_message_for_should_not
+        "expected\n#{@actual} not to match#{structure_message}\n#{@expected}"
+      end
+
+      private
+      def structure_message
+        " structure" unless @compare_values
+      end
+    end
+
+    def match_xml(expected)
+      MatchXml.new(expected, true)
+    end
+
+    def match_xml_structure(expected)
+      MatchXml.new(expected, false)
+    end
+  end
+end
+
+class Spec::Example::ExampleGroup
+  include TestXml::Spec
+end

data/lib/test_xml/test_unit.rb

@@ -0,0 +1,48 @@
+module TestXml
+  module TestUnit
+    include TestXml::Matchers
+
+    def assert_match_xml(xml, message = "")
+      pattern = yield
+      full_message = build_message(message, <<-EOT, xml, pattern)
+        The following xml:
+        ?
+        does not match with:
+        ?
+      EOT
+      assert_block(full_message) do
+        match_xml?(xml, yield, true)
+      end
+    end
+
+    def assert_match_xml_structure(xml, message = "")
+      pattern = yield
+      full_message = build_message(message, <<-EOT, xml, pattern)
+        The following xml:
+        ?
+        does not match with structure of:
+        ?
+      EOT
+      assert_block(full_message) do
+        match_xml?(xml, yield)
+      end
+    end
+
+    def assert_not_match_xml(xml, message = "")
+      pattern = yield
+      full_message = build_message(message, <<-EOT, xml, pattern)
+        The following xml:
+        ?
+        matches with:
+        ?
+      EOT
+      assert_block(full_message) do
+        !match_xml?(xml, yield, true)
+      end
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  include TestXml::TestUnit
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/test_xml'
+require File.dirname(__FILE__) + '/../lib/test_xml/spec'

data/spec/test_xml/spec_spec.rb

@@ -0,0 +1,47 @@
+require 'spec/spec_helper'
+
+describe "xml" do
+  before(:each) do
+    @xml = <<-XML
+      <root>
+        <one>1</one>
+        <two>2</two>
+      </root>
+    XML
+  end
+
+  it "should match_xml" do
+    @xml.should match_xml(<<-XML)
+      <root>
+        <one>1</one>
+        <two>2</two>
+      </root>
+    XML
+  end
+
+  it "should not match_xml" do
+    @xml.should_not match_xml(<<-XML)
+      <root>
+        <one>2</one>
+      </root>
+    XML
+  end
+
+  it "should match_xml_structure" do
+    @xml.should match_xml_structure(<<-XML)
+      <root>
+        <one>2</one>
+        <two>1</two>
+      </root>
+    XML
+  end
+
+  it "should not match_xml_structure" do
+    @xml.should_not match_xml_structure(<<-XML)
+      <root>
+        <one>2</one>
+        <three>1</three>
+      </root>
+    XML
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+
+require File.dirname(__FILE__) + '/../lib/test_xml'
+require File.dirname(__FILE__) + '/../lib/test_xml/test_unit'

data/test/test_xml/nokogiri/test_node.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+
+class TestNode < Test::Unit::TestCase
+  def test_elements
+    assert doc.elements.size == 1
+    assert doc.at('root').elements.size == 2
+  end
+
+  def test_text_element
+    assert doc(<<-XML).at('root').text_element?
+      <root>
+        hello
+      </root>
+    XML
+  end
+
+  def test_match_of_elements_without_comparing_values
+    subject = doc(<<-XML)
+      <root>
+        <one>1</one>
+        <two>
+          <three>3</three>
+        </two>
+      </root>
+    XML
+
+    pattern = doc(<<-XML)
+      <root>
+        <two><three/></two>
+        <one>2</one>
+      </root>
+    XML
+
+    assert subject.match?(pattern)
+  end
+
+  def test_no_match_of_elements_without_comparing_values
+    subject = doc(<<-XML)
+      <root>
+        <one>1</one>
+        <two/>
+      </root>
+    XML
+
+    pattern = doc(<<-XML)
+      <root>
+        <four/>
+        <five>5</five>
+      </root>
+    XML
+
+    assert !subject.match?(pattern)
+  end
+
+  def test_match_with_values
+    subject = doc(<<-XML)
+      <root>
+        <one>1</one>
+        <two><three>3</three></two>
+      </root>
+    XML
+
+    pattern = doc(<<-XML)
+      <root>
+        <two><three>3</three></two>
+        <one>1</one>
+      </root>
+    XML
+
+    assert subject.match?(pattern, true)
+  end
+
+  def test_no_match_with_values
+    subject = doc(<<-XML)
+      <root>
+        <one>1</one>
+      </root>
+    XML
+
+    not_matched_pattern = doc(<<-XML)
+      <root>
+        <one>2</one>
+      </root>
+    XML
+
+    assert !subject.match?(not_matched_pattern, true)
+  end
+
+  def test_element_contains_another_element
+    element = create_element('<one/>')
+
+    assert !doc.send(:contains?,element)
+    assert doc.at('root').send(:contains?,element)
+  end
+  
+  def test_element_contains_elements
+    assert doc.root.send(:contains_elements_of?, doc.root)
+    assert !doc.root.send(:contains_elements_of?, doc('<root><test_element/></root>'))
+  end
+
+  private
+
+  def create_element(xml)
+    Nokogiri::XML::Document.parse(xml).root
+  end
+
+  def doc(xml = nil)
+    xml ||= <<-XML
+      <root>
+        <one>1</one>
+        <two>2</two>
+      </root>
+    XML
+    Nokogiri::XML::Document.parse(xml)
+  end
+end

data/test/test_xml/test_matchers.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class TestMatchers < Test::Unit::TestCase
+  include TestXml::Matchers
+
+  def test_match
+    actual = <<-XML
+      <root>
+        <one>
+          <two>2</two>
+        </one>
+      </root>
+    XML
+
+    assert  match_xml?(actual, '<root><one><two/></one></root>')
+    assert !match_xml?(actual, '<root><two/></root>')
+  end
+
+  def test_match_with_values
+    actual = <<-XML
+      <root>
+        <one>1</one>
+        <two>2</two>
+      </root>
+    XML
+
+    assert  match_xml?(actual, '<root><one>1</one></root>', true)
+    assert !match_xml?(actual, '<root><one>2</one></root>', true)
+  end
+end

data/test/test_xml/test_test_unit.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class TestTestUnit < Test::Unit::TestCase
+  def test_assert_match_xml
+    xml = <<-XML
+      <root>
+        <one>1</one>
+      </root>
+    XML
+
+    assert_match_xml(xml) do
+      <<-XML
+        <root>
+          <one>1</one>
+        </root>
+      XML
+    end
+  end
+
+  def test_assert_match_xml_structure
+    xml = <<-XML
+      <root>
+        <one>1</one>
+        <two>
+          <three>3</three>
+        </two>
+      </root>
+    XML
+
+    assert_match_xml_structure(xml) do
+      <<-XML
+        <root>
+          <one>2</one>
+          <two><three/></two>
+        </root>
+      XML
+    end
+  end
+
+  def test_assert_not_match_xml
+    xml = <<-XML
+      <root>
+        <one>1</one>
+      </root>
+    XML
+
+    assert_not_match_xml(xml) do
+      <<-XML
+        <root>
+          <one>2</one>
+        </root>
+      XML
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: test_xml
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pavel Gabriel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.2
+    version: 
+description: test_xml allows you to test xml (match stucture and values) with Test::Unit or RSpec
+email: alovak@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/test_xml/matchers.rb
+- lib/test_xml/nokogiri/node.rb
+- lib/test_xml/nokogiri.rb
+- lib/test_xml/spec.rb
+- lib/test_xml/test_unit.rb
+- lib/test_xml.rb
+- test/test_helper.rb
+- test/test_xml/nokogiri/test_node.rb
+- test/test_xml/test_matchers.rb
+- test/test_xml/test_test_unit.rb
+- spec/spec_helper.rb
+- spec/test_xml/spec_spec.rb
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/alovak/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: test_xml allows you to test xml with Test::Unit or RSpec
+test_files: []
+