rspec_tag_matchers 1.0.0

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.textile

@@ -0,0 +1,105 @@
+h1. RSPEC_TAG_MATCHER
+
+_Implementation of *have_tag()* RSpec matcher using *Nokogiri*._
+
+h2. Description
+
+An implementation of rspec_on_rails' @have_tag()@ matcher which does not depend on Rails' @assert_select()@. Using *Nokogiri* instead, the matcher is available to non-Rails projects, and enjoys the full flexibility of Nokogiri's advanced and blazing fast CSS and XPath selector support.
+
+h2. Installation
+
+*Gem:*
+
+<pre>sudo gem install rspec_tag_matchers --source http://gemcutter.org</pre>
+
+*Dependencies:*
+
+* "rspec":http://github.com/dchelimsky/rspec (stating the obvious)
+
+*Configuration*
+
+In @spec_helper.rb@:
+
+<pre>
+  require 'rspec_tag_matchers'
+  
+  Spec::Runner.configure do |config|
+    config.include(RspecTagMatchers)
+  end
+</pre>
+
+h2. Usage
+
+As its first argument, @have_tag()@ accepts any CSS or XPath selectors which are supported by *Nokogiri*.
+
+<pre>
+  body.should have_tag('form[@action*=session]')
+  body.should have_tag('ul > li + li')
+</pre>
+
+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@:
+
+<pre>
+  body.should have_tag('h1', 'Welcome')
+  body.should have_tag('p', /a very important blurb/i)
+</pre>
+  
+Expectations can be placed upon the number of matched elements by passing an options hash:
+
+<pre>
+  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)
+</pre>
+  
+The @:count@ key also accepts a @Range@, making the following equivalent:
+
+<pre>
+  body.should have_tag('tr', :count => 3..5)
+  body.should have_tag('tr', :minimum => 3, :maximum => 5)
+</pre>
+
+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:
+
+<pre>
+  body.should have_tag('thead') do |thead|
+    thead.should have_tag('th', :count => 5)
+  end
+</pre>
+  
+This also allows arbitrary expectations to be applied from within the block, such as:
+
+<pre>
+  body.should have_tag('dl dd.sha1') do |dd|
+    dd.inner_text.length.should == 40
+  end
+</pre>
+
+h2. Notes
+
+Currently, this implementation does not support substitution values as assert_select did (by way of @HTML::Selector@):
+
+*Note supported:*
+
+<pre>
+body.should have_tag('li[class=?]', dom_class)
+body.should have_tag('tr.person#?', /^person-\d+$/)
+</pre>
+
+I (Kyle Hargraves, original author) 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.
+
+h2. Origin
+
+This project was originally forked from:
+
+"http://github.com/cjohansen/validatious-on-rails":http://github.com/pd/rspec_hpricot_matchers
+
+h2. License
+
+*Original work:*
+
+Released under the MIT license.<br />
+Copyright (c) 2008 "Kyle Hargraves":http://github.com/pd

data/Rakefile

@@ -0,0 +1,74 @@
+# coding: utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  begin
+    gem 'rspec-rails', '>= 1.0.0'
+    require 'spec/rake/spectask'
+  rescue LoadError
+    puts "RSpec - or one of it's dependencies - is not available. Install it with: sudo gem install rspec-rails"
+  end
+end
+
+NAME = "rspec_tag_matchers"
+SUMMARY = %Q{Implementation of have_tag() RSpec matcher using Nokogiri.}
+DESCRIPTION = <<-END
+  rspec_tag_matchers provides an implementation of rspec_on_rails'
+  have_tag() matcher which does not depend on Rails' assert_select().
+  Using Nokogiri instead, the matcher is available to non-Rails projects,
+  and enjoys the full flexibility of Nokogiri's advanced and blazing fast 
+  CSS and XPath selector support. Forked from rspec_hpricot_matchers.
+END
+HOMEPAGE = "http://github.com/grimen/#{NAME}"
+AUTHOR = "Kyle Hargraves"
+EMAIL = "pd@krh.me"
+SUPPORT_FILES = %w(README.textile)
+
+begin
+  gem 'jeweler', '>= 1.0.0'
+  require 'jeweler'
+  
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = NAME
+    gemspec.summary = SUMMARY
+    gemspec.description = DESCRIPTION
+    gemspec.homepage = HOMEPAGE
+    gemspec.author = AUTHOR
+    gemspec.email = EMAIL
+    
+    gemspec.require_paths = %w{lib}
+    gemspec.files = SUPPORT_FILES << %w(MIT-LICENSE Rakefile) << Dir.glob(File.join(*%w[{generators,lib,test} ** *]).to_s)
+    gemspec.extra_rdoc_files = SUPPORT_FILES
+    
+    gemspec.add_dependency 'nokogiri', '>= 1.4.0'
+    gemspec.add_dependency 'rspec-rails', '>= 1.2.6'
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler - or one of it's dependencies - is not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+desc 'Default: Run specs.'
+task :default => :spec
+
+desc %Q{Generate documentation.}
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = NAME
+  rdoc.options << '--line-numbers' << '--inline-source' << '--charset=UTF-8'
+  rdoc.rdoc_files.include(SUPPORT_FILES)
+  rdoc.rdoc_files.include(File.join(*%w[lib ** *.rb]))
+end
+
+#if defined?(Spec)
+  desc 'Run specs.'
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['-c']
+  end
+#end

data/lib/rspec_tag_matchers.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+require 'rubygems'
+require 'nokogiri'
+
+require 'rspec_tag_matchers/have_tag'
+
+class Nokogiri::XML::Element
+  alias body inner_html
+end

data/lib/rspec_tag_matchers/have_tag.rb

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+module RspecTagMatchers
+  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::HTML(input.body)
+        else
+          Nokogiri::HTML(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_tag_matchers/have_tag_spec.rb

@@ -0,0 +1,241 @@
+# coding: utf-8
+require File.join(File.dirname(__FILE__), *%w[.. 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,11 @@
+# coding: utf-8
+$: << File.join(File.dirname(__FILE__), *%w[.. lib])
+require 'rspec_tag_matchers'
+
+Spec::Runner.configure do |config|
+  config.include(RspecTagMatchers)
+end
+
+unless defined?(SpecFailed)
+  SpecFailed = Spec::Expectations::ExpectationNotMetError
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: rspec_tag_matchers
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kyle Hargraves
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-22 00:00:00 +01: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.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.6
+    version: 
+description: "  rspec_tag_matchers provides an implementation of rspec_on_rails'\n  have_tag() matcher which does not depend on Rails' assert_select().\n  Using Nokogiri instead, the matcher is available to non-Rails projects,\n  and enjoys the full flexibility of Nokogiri's advanced and blazing fast \n  CSS and XPath selector support. Forked from rspec_hpricot_matchers.\n"
+email: pd@krh.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/rspec_tag_matchers.rb
+- lib/rspec_tag_matchers/have_tag.rb
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/rspec_tag_matchers.rb
+- lib/rspec_tag_matchers/have_tag.rb
+has_rdoc: true
+homepage: http://github.com/grimen/rspec_tag_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: 3
+summary: Implementation of have_tag() RSpec matcher using Nokogiri.
+test_files: 
+- spec/rspec_tag_matchers/have_tag_spec.rb
+- spec/spec_helper.rb