fnando-rspec-hpricot-matchers 0.0.2

data/README.markdown

@@ -0,0 +1,117 @@
+Rspec Hpricot Matchers
+======================
+
+This is a <http://github.com/pd/rspec_hpricot_matchers> "switch back to hpricot" port.
+
+Install
+-------
+
+On Ruby projects:
+
+    require "rubygems"
+    require "spec"
+    require "rspec-hpricot-matchers"
+    
+    Spec::Runner.configure do |config|
+      config.include(HpricotSpec::Matchers)
+    end
+
+On Rails projects:
+
+    # using as plugin
+    script/plugin install git://github.com/fnando/rspec-hpricot-matchers.git
+    
+    # using as gem
+    # on config/environments/test.rb
+    config.gem "fnando-rspec-hpricot-matchers", 
+      :lib => "rspec-hpricot-matchers",
+      :source => "http://gems.github.com"
+    
+    # then on spec/spec_helper.rb
+    Spec::Runner.configure do |config|
+      config.include HpricotSpec::Matchers
+    end
+
+FAQ
+---
+
+### Why switching back to Hpricot?
+
+I personally don't use Nokogiri, so it makes no sense to install it just for testing.
+
+### What kind of selectors can I use?
+
+Check it out the [Hpricot wiki](http://wiki.github.com/why/hpricot/supported-css-selectors) for supported selectors.
+
+
+Usage:
+------
+
+HTML content:
+
+    html = <<-HTML
+    <ul>
+        <li>Item 1</li>
+        <li>
+            <a href="http://simplesideias.com.br" rel="external">
+                Simples Ideias
+            </a>
+        </li>
+    </ul>
+    HTML
+
+    html.should have_tag("li", :count => 2)
+    html.should have_tag("ul > li", :minimum => :1)
+    html.should have_tag("ul > li", :maximum => :2)
+    html.should have_tag("a[@rel='external']", /Simples Ideias/)
+
+XML content:
+
+    xml = <<-XML
+    <?xml version="1.0" encoding="UTF-8"?>
+    <content>
+        <item type="html">
+            <a href="http://simplesideias.com.br">
+                Simples Ideias
+            </a>
+        </item>
+        <item type="text"><![CDATA[Some text]]></item>
+    </content>
+    XML
+    
+    xml.should have_node("item", :count => 2)
+    xml.should have_node("content > item", /Some text/, :count => 1)
+    
+Running Rpec Hpricot Matchers tests
+-----------------------------------
+
+    rake spec
+
+MAINTAINER
+----------
+
+* Nando Vieira (<http://simplesideias.com.br>)
+
+LICENSE:
+--------
+
+(The MIT License)
+
+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/Rakefile

@@ -0,0 +1,34 @@
+require "rake"
+require "jeweler"
+require "spec/rake/spectask"
+
+RELEASE_VERSION = "0.0.2" 
+
+JEWEL = Jeweler::Tasks.new do |gem|
+  gem.name = "rspec-hpricot-matchers"
+  gem.version = RELEASE_VERSION
+  gem.summary = "Replace have_tag to enable advanced selectors using Hpricot"
+  gem.description = <<-TXT
+A http://github.com/pd/rspec_hpricot_matchers 'switch back to hpricot' port
+TXT
+  
+  gem.authors = ["Nando Vieira"]
+  gem.email = "fnando.vieira@gmail.com"
+  gem.homepage = "http://github.com/fnando/rspec-hpricot-matchers"
+  
+  gem.has_rdoc = false
+  gem.files = %w(Rakefile rspec-hpricot-matchers.gemspec VERSION README.markdown) + Dir["{lib,templates}/**/*"]
+	
+	gem.add_dependency "hpricot"
+end
+
+desc "Generate gemspec, build and install the gem"
+task :package do
+  File.open("VERSION", "w+") {|f| f << RELEASE_VERSION }
+  
+  Rake::Task["gemspec"].invoke
+  Rake::Task["build"].invoke
+  Rake::Task["install"].invoke
+end
+
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ["-c", "-f s"] }

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/rspec-hpricot-matchers.rb

@@ -0,0 +1,16 @@
+require "rubygems"
+require "spec"
+require "hpricot"
+
+module Hpricot
+  class Elem
+    alias body inner_html
+  end
+end
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require "rspec-hpricot-matchers/base"
+require "rspec-hpricot-matchers/have_tag"
+require "rspec-hpricot-matchers/have_node"
+require "rspec-hpricot-matchers/matchers"

data/lib/rspec-hpricot-matchers/base.rb

@@ -0,0 +1,109 @@
+module HpricotSpec
+  class Base
+    attr_reader :options
+    attr_reader :selector
+    attr_reader :actual
+    attr_reader :actual_count
+    attr_reader :doc
+    
+    def initialize(selector, inner_text_or_options, options={}, &block)
+      @selector = selector
+      
+      if Hash === inner_text_or_options
+        @options = inner_text_or_options
+      else
+        @options = options
+        options[:text] = inner_text_or_options
+      end
+    end
+    
+    def matches?(_actual, &block)
+      @actual = _actual
+      @doc = doc_for(actual)
+
+      matches = doc.search(selector)
+      
+      if matches.empty?
+        return options[:count] == 0
+      end
+
+      if options[:text]
+        matches = filter_on_inner_text(matches)
+      end
+
+      if block
+        matches = filter_on_nested_expectations(matches, block)
+      end
+
+      @actual_count = matches.size
+      
+      return false if not acceptable_count?(actual_count)
+
+      !matches.empty?
+    end
+    
+    def failure_message
+      explanation = actual_count ? "but found #{actual_count}" : "but did not"
+      "expected\n#{doc.to_s}\nto have #{failure_count_phrase} #{failure_selector_phrase}, #{explanation}"
+    end
+
+    def negative_failure_message
+      explanation = actual_count ? "but found #{actual_count}" : "but did"
+      "expected\n#{doc.to_s}\nnot to have #{failure_count_phrase} #{failure_selector_phrase}, #{explanation}"
+    end
+    
+    private
+      def filter_on_inner_text(elements)
+        elements.select do |el|
+          next(el.inner_text =~ options[:text]) if options[:text].is_a?(Regexp)
+          el.inner_text == options[:text]
+        end
+      end
+
+      def filter_on_nested_expectations(elements, block)
+        elements.select do |el|
+          begin
+            block.call(el)
+          rescue Spec::Expectations::ExpectationNotMetError
+            false
+          else
+            true
+          end
+        end
+      end
+
+      def acceptable_count?(count)
+        if options[:count]
+          return false unless options[:count] === count
+        end
+        
+        if options[:minimum]
+          return false unless count >= options[:minimum]
+        end
+        
+        if options[:maximum]
+          return false unless count <= options[:maximum]
+        end
+        
+        true
+      end
+
+      def failure_count_phrase
+        if options[:count]
+          "#{options[:count]} elements matching"
+        elsif options[:minimum] || options[:maximum]
+          count_explanations = []
+          count_explanations << "at least #{options[:minimum]}" if options[:minimum]
+          count_explanations << "at most #{options[:maximum]}"  if options[:maximum]
+          "#{count_explanations.join(' and ')} elements matching"
+        else
+          "an element matching"
+        end
+      end
+
+      def failure_selector_phrase
+        phrase = selector.inspect
+        phrase << (options[:text] ? " with inner text #{options[:text].inspect}" : "")
+      end
+  end
+end

data/lib/rspec-hpricot-matchers/have_node.rb

@@ -0,0 +1,16 @@
+module HpricotSpec
+  class HaveNode < Base
+    private
+      def doc_for(input)
+        if String === input
+          Hpricot.XML(input)
+        elsif input.respond_to?(:body)
+          Hpricot.XML(input.body.to_s)
+        elsif Hpricot::Elem === input
+          input
+        else
+          Hpricot.XML(input.to_s)
+        end
+      end
+  end
+end

data/lib/rspec-hpricot-matchers/have_tag.rb

@@ -0,0 +1,16 @@
+module HpricotSpec
+  class HaveTag < Base
+    private
+      def doc_for(input)
+        if String === input
+          Hpricot(input)
+        elsif input.respond_to?(:body)
+          Hpricot(input.body.to_s)
+        elsif Hpricot::Elem === input
+          input
+        else
+          Hpricot(input.to_s)
+        end
+      end
+  end
+end

data/lib/rspec-hpricot-matchers/matchers.rb

@@ -0,0 +1,11 @@
+module HpricotSpec
+  module Matchers
+    def have_tag(selector, inner_text_or_options=nil, options={}, &block)
+      HaveTag.new(selector, inner_text_or_options, options, &block)
+    end
+
+    def have_node(selector, inner_text_or_options=nil, options={}, &block)
+      HaveNode.new(selector, inner_text_or_options, options, &block)
+    end
+  end
+end

data/rspec-hpricot-matchers.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rspec-hpricot-matchers}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nando Vieira"]
+  s.date = %q{2009-08-11}
+  s.description = %q{A http://github.com/pd/rspec_hpricot_matchers 'switch back to hpricot' port}
+  s.email = %q{fnando.vieira@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/rspec-hpricot-matchers.rb",
+     "lib/rspec-hpricot-matchers/base.rb",
+     "lib/rspec-hpricot-matchers/have_node.rb",
+     "lib/rspec-hpricot-matchers/have_tag.rb",
+     "lib/rspec-hpricot-matchers/matchers.rb",
+     "rspec-hpricot-matchers.gemspec"
+  ]
+  s.homepage = %q{http://github.com/fnando/rspec-hpricot-matchers}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Replace have_tag to enable advanced selectors using Hpricot}
+  s.test_files = [
+    "spec/rspec-hpricot-matchers/have_tag_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
+    else
+      s.add_dependency(%q<hpricot>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, [">= 0"])
+  end
+end

data/spec/rspec-hpricot-matchers/have_tag_spec.rb

@@ -0,0 +1,251 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe "have_tag" do
+  attr_reader :html
+  
+  before(:each) do
+    @html = "<ul><li>An egregiously long string</li></ul>"
+  end
+  
+  it "should match against strings" do
+    html.should have_tag("li")
+  end
+  
+  it "should match against Hpricot::Elem" do
+    doc = Hpricot(html)
+    doc.search("li").should have_tag("li")
+  end
+  
+  it "should match against Hpricot::Document" do
+    doc = Hpricot(html)
+    doc.should have_tag("li")
+  end
+  
+  it "should match against the response of body method" do
+    OpenStruct.new(:body => html).should have_tag("li")
+  end
+  
+  it "should match against the response of to_s method" do
+    [html].should have_tag("li")
+  end
+  
+  it "should not match when the target does not have the selected element" do
+    html.should_not have_tag("dd")
+  end
+  
+  it "should match against the inner text of the selected element" do
+    html.should have_tag("li", "An egregiously long string")
+  end
+  
+  it "should match negatively against the inner text" do
+    html.should_not have_tag("li", "Some other string entirely")
+  end
+  
+  it "should match against a Regexp describing the inner text" do
+    html.should have_tag("li", /GREG/i)
+  end
+  
+  it "should match negatively against a Regexp describing the inner text" do
+    html.should_not have_tag("li", /GREG/)
+  end
+  
+  it "should include the body in the failure message" do
+    lambda {
+      html.should have_tag("abbr")
+    }.should raise_error(SpecFailed, /#{Regexp.escape(html)}/)
+  end
+  
+  it "should include the selector in the failure message" do
+    lambda {
+      html.should have_tag("abbr")
+    }.should raise_error(SpecFailed, /"abbr"/)
+  end
+  
+  it "should include the expected inner text if provided" do
+    lambda {
+      html.should have_tag("li", /something else/)
+    }.should raise_error(SpecFailed, %r{/something else/})
+  end
+  
+  describe "inner expectations" do
+    it "should fail when the outer selector fails" do
+      lambda {
+        html.should have_tag("dl") do |dl|
+          dl.should have_tag("li")
+        end
+      }.should raise_error(SpecFailed)
+    end
+    
+    it "should match the inner expectations against the elements matched by the outer selector" do
+      html.should have_tag("ul") do |ul|
+        ul.should have_tag("li")
+      end
+    end
+    
+    it "should support negated inner expectations" do
+      html.should have_tag("ul") do |ul|
+        ul.should_not have_tag("dd")
+      end
+    end
+    
+    it "should treat multiple nested have_tag() expectations as a logical AND" do
+      html.should have_tag("ul") do |ul|
+        ul.should have_tag("li")
+        ul.should_not have_tag("dd")
+      end
+    end
+    
+    it "should only match against a single element at a time when nesting expectations (see RSpec LH#316)" do
+      html = <<-EOHTML
+        <ul>
+          <li>
+            <a href="1">1</a>
+          </li>
+          <li>
+            <a href="2">2</a>
+            <span>Hello</span>
+          </li>
+        </ul>
+      EOHTML
+
+      html.should have_tag("li", :count => 1) do |li|
+        li.should have_tag("a")
+        li.should have_tag("span")
+      end
+
+      html.should have_tag("li", :count => 1) do |li|
+        li.should have_tag("a")
+        li.should_not have_tag("span")
+      end
+
+      html.should have_tag("li", :count => 2) do |li|
+        li.should have_tag("a")
+      end
+    end
+    
+    it "should yield elements which respond to #body" do
+      html = <<-EOHTML
+        <ul>
+          <li>
+            <a href="1">1</a>
+          </li>
+          <li>
+            <a href="2">2</a>
+            <span>Hello</span>
+          </li>
+        </ul>
+      EOHTML
+      
+      html.should have_tag("ul") do |ul|
+        ul.should respond_to(:body)
+      end
+    end
+    
+    it "should supports arbitrary expectations within the block" do
+      html = %q{<span class="sha1">cbc0bd52f99fe19304bccad383694e92b8ee2c71</span>}
+      html.should have_tag("span.sha1") do |span|
+        span.inner_text.length.should == 40
+      end
+      
+      html.should_not have_tag("span.sha1") do |span|
+        span.inner_text.length.should == 41
+      end
+    end
+  end
+  
+  describe "with counts" do
+    before(:each) do
+      @html = <<-EOHTML
+        <ul>
+          <li>Foo</li>
+          <li>Bar</li>
+          <li>Foo again</li>
+          <li><a href="/baz">With inner elements</a></li>
+        </ul>
+      EOHTML
+    end
+    
+    it "should treat an integer :count as expecting exactly n matched elements" do
+      html.should have_tag("li", :count => 4)
+      html.should_not have_tag("li", :count => 3)
+      html.should_not have_tag("li", :count => 5)
+    end
+    
+    it "should treat a range :count as expecting between x and y matched elements" do
+      html.should have_tag("li", :count => 1..5)
+      html.should_not have_tag("li", :count => 2..3)
+    end
+    
+    it "should treat a :count of zero as if a negative match were expected" do
+      html.should have_tag("dd", :count => 0)
+    end
+    
+    it "should treat :minimum as expecting at least n matched elements" do
+      (0..4).each { |n| html.should have_tag("li", :minimum => n) }
+      html.should_not have_tag("li", :minimum => 5)
+    end
+    
+    it "should treat :maximum as expecting at most n matched elements" do
+      html.should_not have_tag("li", :maximum => 3)
+      html.should have_tag("li", :maximum => 4)
+      html.should have_tag("li", :maximum => 5)
+    end
+    
+    it "should support matching of content while specifying a count" do
+      html.should have_tag("li", /foo/i, :count => 2)
+    end
+    
+    it "should work when the have_tag is nested" do
+      html.should have_tag("ul") do |ul|
+        ul.should have_tag("li", :minimum => 2)
+        ul.should have_tag("li", /foo/i, :count => 2)
+      end
+    end
+    
+    it "should include the actual number of elements matched in the failure message" do
+      lambda {
+        html.should have_tag("li", :count => 3)
+      }.should raise_error(SpecFailed, /found 4/)
+      
+      lambda {
+        html.should have_tag("li", :count => 5)
+      }.should raise_error(SpecFailed, /found 4/)
+    end
+    
+    it "should include the actual number of elements matched in the negative failure message" do
+      lambda {
+        html.should_not have_tag("li", :count => 4)
+      }.should raise_error(SpecFailed, /found 4/)
+    end
+    
+    it "should include the expected number of elements in the failure message" do
+      lambda {
+        html.should have_tag("li", :count => 2)
+      }.should raise_error(SpecFailed, /to have 2 elements matching/)
+    end
+    
+    it "should include the expected number of elements in the negative failure message" do
+      lambda {
+        html.should_not have_tag("li", :count => 4)
+      }.should raise_error(SpecFailed, /to have 4 elements matching/)
+    end
+    
+    it "should describe the :minimum case using 'at least ...'" do
+      lambda {
+        html.should have_tag("li", :minimum => 80)
+      }.should raise_error(SpecFailed, /to have at least 80 elements matching/)
+    end
+    
+    it "should describe the :maximum case using 'at most ...'" do
+      lambda {
+        html.should have_tag("li", :maximum => 2)
+      }.should raise_error(SpecFailed, /to have at most 2 elements matching/)
+    end
+    
+    it "should describe the :minimum and :maximum case using 'at least ... and at most ...'" do
+      lambda {
+        html.should have_tag("li", :minimum => 8, :maximum => 30)
+      }.should raise_error(SpecFailed, /to have at least 8 and at most 30 elements matching/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + "/../lib/rspec-hpricot-matchers"
+require "ostruct"
+  
+Spec::Runner.configure do |config|
+  config.include(HpricotSpec::Matchers)
+end
+
+unless defined?(SpecFailed)
+  SpecFailed = Spec::Expectations::ExpectationNotMetError
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: fnando-rspec-hpricot-matchers
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A http://github.com/pd/rspec_hpricot_matchers 'switch back to hpricot' port
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- lib/rspec-hpricot-matchers.rb
+- lib/rspec-hpricot-matchers/base.rb
+- lib/rspec-hpricot-matchers/have_node.rb
+- lib/rspec-hpricot-matchers/have_tag.rb
+- lib/rspec-hpricot-matchers/matchers.rb
+- rspec-hpricot-matchers.gemspec
+has_rdoc: false
+homepage: http://github.com/fnando/rspec-hpricot-matchers
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 2
+summary: Replace have_tag to enable advanced selectors using Hpricot
+test_files: 
+- spec/rspec-hpricot-matchers/have_tag_spec.rb
+- spec/spec_helper.rb