pd-rspec_hpricot_matchers 1.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+*.iml
+*.ipr
+*.iws

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Kyle Hargraves
+
+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 PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL 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

@@ -0,0 +1,88 @@
+= rspec_hpricot_matchers
+
+An implementation of have_tag(), as in rspec_on_rails, but sitting atop
+Hpricot rather than merely wrapping assert_select().
+
+
+== Installation
+
+To use rspec_hpricot_matchers in your project, install the gem, and
+add the following to your spec_helper.rb file:
+
+  require 'rspec_hpricot_matchers'
+  Spec::Runner.configure do |config|
+    config.include(RspecHpricotMatchers)
+  end
+
+Similarly, to make the matchers available to stories, you can add the
+following to your stories/helper.rb file:
+
+  require 'rspec_hpricot_matchers'
+  include RspecHpricotMatchers
+
+
+== Usage
+
+As its first argument, have_tag() accepts any CSS or XPath selectors
+which are supported by Hpricot.
+
+    body.should have_tag('form[@action*=session]')
+    body.should have_tag('ul > li + li')
+
+Expectations can be placed upon the inner text of the matched element
+by providing another argument, which should be either a String or a
+Regexp:
+
+    body.should have_tag('h1', 'Welcome')
+    body.should have_tag('p', /a very important blurb/i)
+
+Expectations can be placed upon the number of matched elements by
+passing an options hash:
+
+    body.should have_tag('abbr', :count => 1)   # exactly one
+    body.should have_tag('dt',   :minimum => 4) # at least 4
+    body.should have_tag('dd',   :maximum => 4) # at most 4
+    body.should have_tag('a.outgoing', /rspec/i, :count => 2)
+
+The :count key also accepts a Range, making the following equivalent:
+
+    body.should have_tag('tr',   :count => 3..5)
+    body.should have_tag('tr',   :minimum => 3,
+                                 :maximum => 5)
+
+
+The usage of with_tag(), however, is no longer supported. Instead, a
+block passed to have_tag() will have each matched element successively
+yielded to it. If none of the blocks return without raising an
+ExpectationNotMetError, the outer have_tag() is treated as having failed:
+
+    body.should have_tag('thead') do |thead|
+      thead.should have_tag('th', :count => 5)
+    end
+
+This also allows arbitrary expectations to be applied from within
+the block, such as:
+
+    body.should have_tag('dl dd.sha1') do |dd|
+      dd.inner_text.length.should == 40
+    end
+
+
+== Notes
+
+Currently, this implementation does not support substitution values
+as assert_select did (by way of HTML::Selector):
+
+    # Not yet supported:
+    body.should have_tag('li[class=?]', dom_class)
+    body.should have_tag('tr.person#?', /^person-\d+$/)
+
+I personally rarely use these, and Hpricot's advanced selectors make
+them mostly useless, as far as I can tell, so I am unlikely to
+implement them myself.
+
+This have_tag() further differs from the assert_select-based
+implementation in that the nested have_tag() calls must *all* pass
+on a single selected element in order to be true. This was a source
+of confusion in RSpec ticket #316. There is a spec covering this
+case if you need an example.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'spec/rake/spectask'
+
+task :default => :spec
+Spec::Rake::SpecTask.new
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'rspec_hpricot_matchers'
+    gemspec.author = 'Kyle Hargraves'
+    gemspec.email = 'pd@krh.me'
+    gemspec.summary = "Implementation of have_tag() rspec matcher using Hpricot"
+    gemspec.description = <<-END
+      rspec_hpricot_matchers provides an implementation of rspec_on_rails'
+      have_tag() matcher which does not depend on Rails' assert_select.
+      Using Hpricot instead, the matcher is available to non-Rails projects,
+      and enjoys the full flexibility of Hpricot's advanced CSS and XPath
+      selector support.
+    END
+
+    # Really, I don't care about rubyforge. Maybe I'll get this
+    # working some day.
+    # gemspec.rubyforge_project = 'rspec-hpricot'
+  end
+rescue LoadError
+  puts "Jeweler unavailable, packaging tasks can not be run. Install it, thanks."
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/lib/rspec_hpricot_matchers.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'nokogiri'
+
+require 'rspec_hpricot_matchers/have_tag'
+
+class Nokogiri::XML::Element
+  alias body to_s
+end

data/lib/rspec_hpricot_matchers/have_tag.rb

@@ -0,0 +1,112 @@
+module RspecHpricotMatchers
+  class HaveTag
+    def initialize(selector, inner_text_or_options, options, &block)
+      @selector = selector
+      if Hash === inner_text_or_options
+        @inner_text = nil
+        @options = inner_text_or_options
+      else
+        @inner_text = inner_text_or_options
+        @options = options
+      end
+    end
+
+    def matches?(actual, &block)
+      @actual = actual
+      @hdoc = hdoc_for(@actual)
+
+      matched_elements = @hdoc.search(@selector)
+      if matched_elements.empty?
+        return @options[:count] == 0
+      end
+
+      if @inner_text
+        matched_elements = filter_on_inner_text(matched_elements)
+      end
+
+      if block
+        matched_elements = filter_on_nested_expectations(matched_elements, block)
+      end
+
+      @actual_count = matched_elements.length
+      return false if not acceptable_count?(@actual_count)
+
+      !matched_elements.empty?
+    end
+
+    def failure_message
+      explanation = @actual_count ? "but found #{@actual_count}" : "but did not"
+      "expected\n#{@hdoc.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#{@hdoc.to_s}\nnot to have #{failure_count_phrase} #{failure_selector_phrase}, #{explanation}"
+    end
+
+    private
+      def hdoc_for(input)
+        if Nokogiri::XML::Document === input
+          input
+        elsif input.respond_to?(:body)
+          Nokogiri.parse(input.body)
+        else
+          Nokogiri.parse(input.to_s)
+        end
+      end
+
+      def filter_on_inner_text(elements)
+        elements.select do |el|
+          next(el.inner_text =~ @inner_text) if @inner_text.is_a?(Regexp)
+          el.inner_text == @inner_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?(actual_count)
+        if @options[:count]
+          return false unless @options[:count] === actual_count
+        end
+        if @options[:minimum]
+          return false unless actual_count >= @options[:minimum]
+        end
+        if @options[:maximum]
+          return false unless actual_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 << (@inner_text ? " with inner text #{@inner_text.inspect}" : "")
+      end
+  end
+
+  def have_tag(selector, inner_text_or_options = nil, options = {}, &block)
+    HaveTag.new(selector, inner_text_or_options, options, &block)
+  end
+end

data/spec/rspec_hpricot_matchers/have_tag_spec.rb

@@ -0,0 +1,240 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'have_tag' do
+  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 nokogiri documents" do
+    hdoc = Nokogiri::HTML(@html)
+    hdoc.should have_tag('li')
+  end
+
+  it "should use the response of #body if the target responds to it" do
+    response = Object.new
+    class << response
+      def body
+        "<ul><li>An egregiously long string</li></ul>"
+      end
+    end
+    response.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
+end
+
+describe 'have_tag inner expectations' do
+  before(:each) do
+    @html = "<ul><li>An egregiously long string</li></ul>"
+  end
+
+  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.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
+
+  it "should include a description of the inner expectation in the failure message" do
+    pending "No idea how to implement this."
+  end
+end
+
+describe 'have_tag 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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$: << File.dirname(__FILE__) + '/../lib'
+require 'rspec_hpricot_matchers'
+
+Spec::Runner.configure do |config|
+  config.include(RspecHpricotMatchers)
+end
+
+unless defined?(SpecFailed)
+  SpecFailed = Spec::Expectations::ExpectationNotMetError
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: pd-rspec_hpricot_matchers
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Kyle Hargraves
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: rspec_hpricot_matchers provides an implementation of rspec_on_rails' have_tag() matcher which does not depend on Rails' assert_select. Using Hpricot instead, the matcher is available to non-Rails projects, and enjoys the full flexibility of Hpricot's advanced CSS and XPath selector support.
+email: pd@krh.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/rspec_hpricot_matchers.rb
+- lib/rspec_hpricot_matchers/have_tag.rb
+- spec/rspec_hpricot_matchers/have_tag_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Implementation of have_tag() rspec matcher using Hpricot
+test_files: 
+- spec/rspec_hpricot_matchers/have_tag_spec.rb
+- spec/spec_helper.rb