rspec_w3c_matchers 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+.redcar
+doc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rspec_w3c_matcher.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,103 @@
+= RspecW3cMatchers
+
+Wiki[http://wiki.github.com/takaltoo/rspec_w3c_matchers] | RDocs[http://rdoc.info/projects/takaltoo/rspec_w3c_matchers]
+
+RspecW3cMatchers provides custom matchers for detecting validation errors reported by 
+{w3c validator service}[http://validator.w3.org]. The {w3c_validator gem}[https://github.com/alexdunae/w3c_validators] by
+{alexdunae}[https://github.com/alexdunae]. The matchers return detailed information regarding errors or warnings that are 
+returned by the w3c validator.
+
+== Installation
+
+In <b>Rails 3</b>, add this to your Gemfile:
+    gem "flickrmocks"
+
+Alternatively, you can install it as a plugin:
+    rails plugin install git://github.com/takaltoo/rspec_w3c_matchers.git
+
+== Getting Started
+RspecW3cMatchers API helpers expect the FlickRaw.api_key to be initialized before they are called:
+    FlickRaw.api_key = your_flickr_api_key
+
+== Including the matchers in Rspec or Cucumber
+In <b>RSPEC 2.0</b> tests you can place the following in your spec_helper.rb file inside the config block
+    config.include(RspecW3cMatchers::InstanceMethods)
+    
+In <b>Cucumber</b> you can place the following in any step definition file that uses the helpers: 
+    include RspecW3cMatchers::InstanceMethods
+    
+== Commonly used matchers
+Matchers to detect that page is free from errors or warnings:
+    have_no_w3c_errors_in(page) 
+    have_no_w3c_errors_in(page)    
+
+Matchers to detect that page has specified number of errors or warnings:
+    have_specified_number_of_w3c_errors_in(page,number)
+    have_specified_number_of_w3c_errors_in(page,number)
+
+You can find a complete list of the matchers by looking at the RspecW3cMatchers::InstanceMethods in
+RDOCS[http://rdoc.info/projects/takaltoo/rspec_w3c_matchers]
+
+== Sample usage of matchers
+A sample RSPEC test that ensures the page has no w3c warnings or errors is given below (assuming body contains the 
+html for the page):
+      w3c = W3CValidators::MarkupValidator.new
+      response = w3c.validate_text(body)    
+      response.should have_no_w3c_errors_in(body)
+      response.should have_no_w3c_warnings_in(body)
+      
+== Generating a response object from W3C validator
+
+A w3c response is can be checked using various matchers. You can generate a w3c response using
+the w3c_validator gem:
+    w3c = W3CValidators::MarkupValidator.new
+    response = w3c.validate_text(body)
+
+Once you have the response you can compare it against a matcher. NOTE: the variable body contains the html for the page. 
+If you are using Capybara[https://github.com/jnicklas/capybara] 
+and Cucumber[https://github.com/aslakhellesoy/cucumber] you can simply
+access the text by passing in 'page.body'.
+
+A sample step file for cucumber (that is used with capybara) is given below:
+    include RspecW3cMatchers::InstanceMethods
+    
+    Then /^the page should have valid html$/ do 
+      w3c = W3CValidators::MarkupValidator.new
+      response = w3c.validate_text(page.body)    
+      response.should have_no_w3c_errors_in(page.body)
+      response.should have_no_w3c_warnings_in(page.body)
+    end 
+
+== Additional Docs
+
+* {RDOCs}[http://rdoc.info/projects/takaltoo/rspec_w3c_matchers]    
+* Run the specs manually once you have checked out the repository:
+   rspec spec -f d
+
+		
+== Questions or Problems?
+
+If you have any issues with RspecW3cMatchers which you cannot find the solution to in the documentation,
+please add an issue on GitHub[http://github.com/takaltoo/rspec_w3c_matchers/issues] or fork the project 
+and send a pull request. 
+
+To get the specs running you should call +bundle+ and then +rake+.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I do not break it 
+  in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself 
+  I can ignore when I pull)
+* Send me a pull request. 
+
+== License
+
+RspecW3cMatchers is released under the MIT license.
+
+== Copyright
+
+Copyright (c) 2010 Takaltoo

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler'
+require 'tasks/fixtures'
+Bundler::GemHelper.install_tasks

data/lib/rspec_w3c_matchers.rb

@@ -0,0 +1,8 @@
+require 'w3c_validators'
+[
+  'rspec_w3c_matchers/version.rb',  
+  'rspec_w3c_matchers/notices.rb',
+  'rspec_w3c_matchers/matchers.rb'
+].each do |file|
+  require File.expand_path(File.dirname(__FILE__)) + '/' + file
+end

data/lib/rspec_w3c_matchers/matchers.rb

@@ -0,0 +1,87 @@
+module RspecW3cMatchers
+  # Contains RSPEC 2.0 instance methods. To use the matchers in RSPEC 2.0,
+  # include this module inside your RSPEC config block inside of spec_helper.rb
+  # 
+  # Rspec.configure do |config|
+  #   config.include(RspecW3cMatchers::InstanceMethods)
+  # end
+  #
+  # To use matchers in Cucumber steps, simply include this module inside any 
+  # step definitions:
+  #
+  # include RspecW3cMatchers::InstanceMethods
+  module InstanceMethods  
+    # matcher for detecting zero errors
+    def have_no_w3c_errors_in(page)
+      RspecW3cMatchers::Notices.new(page,:==,0,:errors)
+    end
+    
+    # matcher for detecting zero warnings
+    def have_no_w3c_warnings_in(page)
+      RspecW3cMatchers::Notices.new(page,:==,0,:warnings)
+    end
+    
+    # matcher for detecting >0 errors 
+    def have_w3c_errors_in(page)
+      RspecW3cMatchers::Notices.new(page,:>,0,:errors)
+    end
+    
+    # matcher for detecting >0 errors
+    def have_w3c_warnings_in(page)
+      RspecW3cMatchers::Notices.new(page,:>,0,:warnings)
+    end
+    
+    
+    # matcher for detecting expected number of errors
+    def have_specified_number_of_w3c_errors_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:==,number,:errors)
+    end
+    
+    # matcher for detecting expected number of warnings
+    def have_specified_number_of_w3c_warnings_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:==,number,:warnings)
+    end
+    
+    # matcher for detecing > specified number of errors
+    def have_more_than_specified_number_of_errors_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:>,number,:errors)
+    end
+
+    # matcher for detecing > specified number of warnings
+    def have_more_than_specified_number_of_warnings_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:>,number,:warnings)
+    end
+    
+    # matcher for detecing >= specified number of errors
+    def have_greater_than_or_equal_to_specified_number_of_errors_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:>=,number,:errors)
+    end
+
+    # matcher for detecing >= specified number of warnings
+    def have_greater_than_or_equal_to_specified_number_of_warnings_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:>=,number,:warnings)
+    end
+    
+    # matcher for detecing < specified number of errors
+    def have_less_than_specified_number_of_errors_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:<,number,:errors)
+    end
+
+    # matcher for detecing < specified number of warnings
+    def have_less_than_specified_number_of_warnings_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:<,number,:warnings)
+    end
+    
+    # matcher for detecing <= specified number of errors
+    def have_less_than_or_equal_to_specified_number_of_errors_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:<=,number,:errors)
+    end
+
+    # matcher for detecing <= specified number of warnings
+    def have_less_than_or_equal_to_specified_number_of_warnings_in(page,number)
+      RspecW3cMatchers::Notices.new(page,:<=,number,:warnings)
+    end
+    
+  end
+
+end

data/lib/rspec_w3c_matchers/notices.rb

@@ -0,0 +1,130 @@
+module RspecW3cMatchers
+  # Low level matcher that is used as a base for the high level matchers.
+  # You should not need to use this class directly. Look at the definitions in 
+  # RspecW3cMatchers::InstanceMethods for a complete list of available matchers.
+  #
+  # The arguments to Notice are as follows:
+  #
+  #   page: text containing the html that is being validated
+  #   comparator: comparison to be performed, can be :==,:<,:>,:<=,:>=. The number of errors 
+  #             or warnings in the response is compared against the msg_count using this operator.
+  #   msg_count: expected number of notices
+  #   type: message type, either :errors or :warnings
+  #
+  # To create a matcher that checks whether a response has more than 2 warnings you would use the 
+  # declaration:
+  #   
+  #   RspecW3cMatchers::Notices.new(page,:>,2,:warnings)
+  #
+  # To create a matcher that checks to make sure a response has exactly 1 error you would use the 
+  # declaration:
+  #
+  #   RspecW3cMatchers::Notices.new(page,:==,1,:errors)
+  #
+  class Notices
+    def initialize(page,comparator,msg_count,type)
+      @page = page
+      @msg_count = msg_count
+      self.comparator = comparator
+      self.type = type
+    end
+
+    # Used by the should() and should_not() methods to determine whether the expectation passes or fails.
+    def matches?(response)
+      @response = response      
+      notices.length.send(@comparator,@msg_count)
+    end
+    
+    # The failure message used when should() is used and the matches?() method returns false.
+    def failure_message_for_should          
+      ["Expected #{comparison}#{@msg_count} W3C validation #{type} but received #{notices.length} #{type}",
+        summary        
+      ].join("\n")
+    end
+    
+    # The failure message used when should_not() is used and the matches?() method returns true.    
+    def failure_message_for_should_not      
+      ["Did not expect #{comparison}#{@msg_count} W3C validation #{type} but received #{notices.length} #{type}",
+        summary        
+      ].join("\n")
+    end
+
+    # description that is returned when none is provided
+    def description
+      "should receive #{comparison}#{@msg_count} W3C validation #{type} in #{uri}"
+    end
+
+    private
+    def notices      
+      @response.send(@type.to_s)
+    end
+    
+    def summary
+      (
+        ["Checked by: %s" % @response.checked_by,
+          "Document type: %s" % @response.doctype,
+          "Character set: %s" % @response.charset,
+          "\n#{@type.capitalize}: %s\n" % [notices.length]
+        ].join("\n") + 
+        messages
+      )
+    end
+
+    def messages
+      notices.map do |message|
+        ["Type: %s" % message.type,
+        "Location: line '%s' column '%s'" %[message.line,message.col],
+        "URI: %s" % uri,
+        "Message: %s" % message.message,
+        "Source (line #{message.line}): \n%s\n" % extract_source(message.line)].join("\n")
+      end.join("\n"*2)
+    end
+            
+    def extract_source(line)      
+      body.split("\n")[line.to_i-1]
+    end
+    
+    def uri
+      @page.respond_to?(:current_path) ? @page.current_path : '(Unknown, input probably came from text)'
+    end
+    
+    def body
+      @page.respond_to?(:body) ? @page.body : @page.to_s
+    end
+    
+    def type
+      @msg_count == 1 ? @type.to_s[0..-2] : @type.to_s
+    end
+    
+    def comparison
+      case @comparator
+      when :== then
+        ''
+      when :<= then
+        'less than or equal to '
+      when :>= then
+        'greater than or equal to '
+      when :< then
+        'less than '
+      when :> then
+        'greater than '
+      else
+        ''
+      end
+    end
+    
+    def comparator=(value)
+      raise ArgumentError unless [:==,:<=,:>=,:<,:>].include?(value)
+      @comparator = value
+    end
+    
+    def type=(value)
+      raise ArgumentError unless [:errors,:warnings].include?(value)
+      @type = value
+    end
+       
+  end
+  
+end
+
+

data/lib/rspec_w3c_matchers/version.rb

@@ -0,0 +1,8 @@
+module RspecW3cMatchers
+  VERSION = "0.0.2"
+  
+  # return the gem version
+  def self.version
+    VERSION
+  end
+end

data/rspec_w3c_matchers.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rspec_w3c_matchers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rspec_w3c_matchers"
+  s.version     = RspecW3cMatchers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Takaltoo"]
+  s.email       = ["pouya@lavabit.com"]
+  s.homepage    = "http://rubygems.org/gems/rspec_w3c_matchers"
+  s.summary     = %q{Rspec 2.0 matchers that detect and report detailed error and warning
+                     responses from w3c_validators GEM.}
+  s.description = %q{ add description}
+
+  s.rubyforge_project = "rspec_w3c_matchers"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency(%q<w3c_validators>, [">= 1.1.1"])    
+  s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+  
+
+end

data/spec/base/matchers_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe APP do      
+  let(:klass) {APP}
+  let(:matcher) {klass}
+  let(:clean_page){ SampleResponses::Valid.html}
+  let(:clean_response){ SampleResponses.load(:valid)}   
+  
+  context "Errors" do    
+    let(:type){:errors}        
+    let(:dirty_page){SampleResponses::Error.html}
+    let(:dirty_response){SampleResponses.load(:error)}
+    
+    it_should_behave_like "w3c notices matcher for have no"   
+    it_should_behave_like "w3c notices matcher for have more than zero"  
+    it_should_behave_like "w3c notices matcher for have specified"   
+    it_should_behave_like "w3c notices matcher for have more than" 
+    it_should_behave_like "w3c notices matcher for have greater than or equal to" 
+    it_should_behave_like "w3c notices matcher for have less than"  
+    it_should_behave_like "w3c notices matcher for have less than or equal to"  
+  end  
+  
+  context "Warnings" do
+    let(:type){:warnings}    
+    let(:dirty_page){SampleResponses::Warning.html}
+    let(:dirty_response){SampleResponses.load(:warning)}
+    
+    it_should_behave_like "w3c notices matcher for have no"   
+    it_should_behave_like "w3c notices matcher for have more than zero"  
+    it_should_behave_like "w3c notices matcher for have specified"   
+    it_should_behave_like "w3c notices matcher for have more than" 
+    it_should_behave_like "w3c notices matcher for have greater than or equal to" 
+    it_should_behave_like "w3c notices matcher for have less than"  
+    it_should_behave_like "w3c notices matcher for have less than or equal to"  
+  end
+end

data/spec/base/notices_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe APP::Notices do
+  let(:klass) {APP::Notices}
+  let(:notices) {klass}
+  let(:validator){W3CValidators::MarkupValidator}
+  
+  let(:clean_page){ SampleResponses::Valid.html}
+  let(:clean_response){ SampleResponses.load(:valid)}
+  
+  context "Errors" do 
+    let(:type){:errors}    
+    let(:dirty_page){ SampleResponses::Error.html}
+    let(:dirty_response){ SampleResponses.load(:error)}
+    
+    it_should_behave_like "w3c matcher for :== operator"   
+    it_should_behave_like "w3c matcher for :> operator"
+    it_should_behave_like "w3c matcher for :< operator"
+    it_should_behave_like "w3c matcher for :<= operator"
+    it_should_behave_like "w3c matcher for :>= operator"
+    it_should_behave_like "w3c matcher with detailed notice reporting"
+    it_should_behave_like "w3c matcher with description when none provided"
+  end  
+  
+  context "Warnings" do
+    let(:type){:warnings}
+    let(:dirty_page){ SampleResponses::Warning.html}
+    let(:dirty_response){ SampleResponses.load(:warning)}
+    
+    it_should_behave_like "w3c matcher for :== operator"   
+    it_should_behave_like "w3c matcher for :> operator"
+    it_should_behave_like "w3c matcher for :< operator"
+    it_should_behave_like "w3c matcher for :<= operator"
+    it_should_behave_like "w3c matcher for :>= operator"
+    it_should_behave_like "w3c matcher with detailed notice reporting"
+    it_should_behave_like "w3c matcher with description when none provided"    
+  end
+end

data/spec/base/version_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe APP do
+  let(:klass){APP}  
+  context "class methods" do
+    it "should have VERSION constant" do
+      klass.constants.include?(:VERSION).should be true
+    end
+    specify {klass.should respond_to(:version)}
+    context "version" do
+      it "should return the VERSION constant" do
+        klass.version.should == klass::VERSION
+      end
+    end
+  end
+end

data/spec/responses/error.rb

@@ -0,0 +1,27 @@
+module SampleResponses
+  
+  module Error
+    def self.html
+    %q(
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <meta charset="utf-8">
+          <title>Two Error</title>
+        </head>
+        <body>
+          <h1>Page with a Two Errors</h1>
+          <p>Hello world</p>
+          <usr_nav></usr_nav>
+          <boo_boo></boo_boo>
+        </body>
+      </html>
+      )
+    end
+    
+    def self.response
+      SampeResponses.load(:error)
+    end
+  end
+
+end

data/spec/responses/responses.rb

@@ -0,0 +1,40 @@
+[ 
+  'error',
+  'warning',    
+  'valid'
+].each do |file|
+  require File.expand_path(File.dirname(__FILE__)) + '/' + file
+end
+
+
+
+module SampleResponses
+
+  def self.load(name)    
+    file = File.open(self.file(name),'r')
+    data = Marshal.load(file)
+    file.close
+    return data
+  end
+  
+  def self.warning
+    SampleResponses::Warning
+  end
+  def self.error
+    SampleResponses::Error
+  end
+  def self.valid    
+    SampleResponses::Valid
+  end
+  
+  private
+  
+  def self.path
+    File.expand_path(File.dirname(__FILE__) + '/../' + 'fixtures/') 
+  end
+  
+  def self.file(name)
+    self.path + '/' + name.to_s + ".marshal"
+  end
+  
+end

data/spec/responses/valid.rb

@@ -0,0 +1,25 @@
+module SampleResponses
+  
+  module Valid
+    def self.html
+      %q(
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <meta charset="utf-8">
+          <title>Clean Page</title>
+        </head>
+        <body>
+          <h1>This is a clean page</h1>
+          <p>Hello world</p>
+        </body>
+    </html>
+    )
+    end
+    
+    def self.response
+      SampeResponses.load(:valid)
+    end
+  end
+
+end

data/spec/responses/warning.rb

@@ -0,0 +1,26 @@
+module SampleResponses
+  
+  module Warning
+  
+    def self.html
+      %q(
+      <!DOCTYPE html5>
+      <html>
+        <head>
+          <title>Single Warning</title>
+        </head>
+        <body>
+          <h1>Page with a Single Warning</h1>
+          <p>Hello world</p>
+          <br/>
+        </body>
+      </html>
+      )
+    end
+    
+    def self.response
+      SampeResponses.load(:warning)
+    end
+  end
+
+end

data/spec/shared_examples/matchers.rb

@@ -0,0 +1,80 @@
+shared_examples_for "w3c notices matcher for have no" do
+  let(:method){"have_no_w3c_#{type}_in".to_sym}
+  
+  it "should return true with valid page" do    
+    self.send(method,clean_page).matches?(clean_response).should be true
+  end
+  it "should return false for invalid page" do
+    self.send(method,dirty_page).matches?(dirty_response).should be false
+  end
+end
+
+shared_examples_for "w3c notices matcher for have more than zero" do
+  let(:method){"have_w3c_#{type}_in"}
+  
+  it "should return true for invalid page" do    
+    self.send(method,dirty_page).matches?(dirty_response).should be true
+  end
+  it "should return false for valid page" do
+    self.send(method,clean_page).matches?(clean_response).should be false
+  end
+end
+
+shared_examples_for "w3c notices matcher for have specified" do
+  let(:method){"have_specified_number_of_w3c_#{type}_in"}
+  
+  it "should return true when 2 notices expected and page contains 2 notices" do
+    self.send(method,dirty_page,2).matches?(dirty_response).should be true
+  end
+  it "should return false when 3 notices expected and page contains 2 notices" do
+    self.send(method,dirty_page,3).matches?(dirty_response).should be false
+  end
+end
+
+shared_examples_for "w3c notices matcher for have more than"  do
+  let(:method){"have_more_than_specified_number_of_#{type}_in"}
+  
+  it "should return true when 1 notice expected and page contains 2 notices" do    
+    self.send(method,dirty_page,1).matches?(dirty_response).should be true
+  end
+  it "should return false when 2 notices expected and page contains 2 notices" do
+    self.send(method,dirty_page,2).matches?(dirty_response).should be false
+  end 
+end
+
+shared_examples_for "w3c notices matcher for have greater than or equal to"  do
+  let(:method){"have_greater_than_or_equal_to_specified_number_of_#{type}_in"}
+  
+  it "should return true when 1 notice expected and page contains 2 notices" do    
+    self.send(method,dirty_page,1).matches?(dirty_response).should be true
+  end
+  it "should return true when 2 notices expected and page contains 2 notices" do
+    self.send(method,dirty_page,2).matches?(dirty_response).should be true
+  end 
+  it "should return false when 3 notices expected and page contains 2 notices" do
+    self.send(method,dirty_page,3).matches?(dirty_response).should be false
+  end 
+end
+
+shared_examples_for "w3c notices matcher for have less than" do
+  let(:method){"have_less_than_specified_number_of_#{type}_in"}
+  it "should return true when 3 notice expected and page returns 2 notices" do
+    self.send(method,dirty_page,3).matches?(dirty_response).should be true
+  end
+  it "should return false when 2 notices expected and page returns 2 notices" do
+    self.send(method,dirty_page,2).matches?(dirty_response).should be false
+  end
+end
+
+shared_examples_for "w3c notices matcher for have less than or equal to" do
+  let(:method){"have_less_than_or_equal_to_specified_number_of_#{type}_in"}  
+  it "should return true when 2 notices expected and page returns 2 notices" do
+    self.send(method,dirty_page,2).matches?(dirty_response).should be true
+  end
+  it "should return true when 2 notices expected and page returns 1 notice" do
+    self.send(method,dirty_page,2).matches?(dirty_response).should be true
+  end
+  it "should return false when 1 notice expected and page returns 2 notices" do
+    self.send(method,dirty_page,1).matches?(dirty_response).should be false
+  end
+end

data/spec/shared_examples/notice_matcher.rb

@@ -0,0 +1,150 @@
+shared_examples_for "w3c matcher for :== operator" do  
+  it "returns true when response contains 0 notices and 0 expected" do     
+    klass.new(clean_page,:==,0,type).matches?(clean_response).should be true
+  end
+  it "returns true when response contains 2 notices and 2 expected" do    
+    klass.new(dirty_page,:==,2,type).matches?(dirty_response).should be true
+  end   
+  it "returns false when response contains 0 notices and 2 expected" do                
+    klass.new(dirty_page,:==,2,type).matches?(clean_response).should be false
+  end  
+  it "returns false when response contains 2 notices and 0 expected" do                
+    klass.new(dirty_page,:==,0,type).matches?(dirty_response).should be false
+  end  
+end
+
+
+shared_examples_for "w3c matcher for :> operator" do  
+  it "returns true when response contains 2 notices and >1 expected" do             
+    klass.new(dirty_page,:>,1,type).matches?(dirty_response).should be true
+  end   
+  it "returns false when response contains 2 notices and >2 expected" do             
+    klass.new(dirty_page,:>,2,type).matches?(dirty_response).should be false
+  end  
+end
+
+
+shared_examples_for "w3c matcher for :< operator" do    
+  it "returns true when response contains 0 notices and <2 expected" do             
+    klass.new(clean_page,:<,2,type).matches?(clean_response).should be true
+  end  
+  it "returns false when response contains 2 notices and <2 expected" do             
+    klass.new(dirty_page,:<,2,type).matches?(dirty_response).should be false
+  end   
+end
+
+shared_examples_for "w3c matcher for :<= operator" do    
+  it "returns true when response contains 2 notices and <=2 expected" do             
+    klass.new(dirty_page,:<=,2,type).matches?(dirty_response).should be true
+  end  
+  it "returns true when response contains 2 notices and <=1 expected" do             
+    klass.new(dirty_page,:<=,1,type).matches?(dirty_response).should be false
+  end   
+end
+
+shared_examples_for "w3c matcher for :>= operator" do    
+  it "returns true when response contains 2 notices and >=2 expected" do             
+    klass.new(dirty_page,:>=,2,type).matches?(dirty_response).should be true
+  end  
+  it "returns true when response contains 0 notices and >=2 expected" do             
+    klass.new(clean_page,:>=,2,type).matches?(clean_response).should be false
+  end   
+end
+
+shared_examples_for "w3c matcher with description when none provided"   do
+  let(:regexp){Regexp.new("^should receive 0 W3C validation #{type} in")}
+  it "returns proper description" do
+    matcher = klass.new(dirty_page,:==,0,type)
+    matcher.matches?(dirty_response)
+    regexp.match(matcher.description).should_not be_nil  
+  end
+end
+
+shared_examples_for "w3c matcher with detailed notice reporting" do      
+  let(:regexp_should_header){Regexp.new("Expected (?<expected>\\d+) W3C validation #{type.to_s}? but received (?<actual>\\d+) #{type.to_s}?")}
+  let(:regexp_should_not_header){Regexp.new("Did not expect (?<expected>\\d+) W3C validation #{type.to_s}? but received (?<actual>\\d+) #{type.to_s}?")}
+  
+  context ":failure_message_for_should" do
+    before(:each) do
+      @matcher = klass.new(dirty_page,:==,0,type)
+      @matcher.matches?(dirty_response)
+      @matcher
+    end
+    
+    let(:msg){@matcher.failure_message_for_should.split("\n")}
+        
+    it "returns proper header" do          
+      num_matches(msg, regexp_should_header).should be 1     
+    end
+    it_behaves_like "w3c detailed notices"
+  end
+  
+  context ":failure_message_for_should_not" do
+    before(:each) do
+      @matcher = klass.new(dirty_page,:==,2,type)
+      @matcher.matches?(dirty_response)
+      @matcher
+    end
+    
+    let(:matcher){@matcher}
+    let(:msg){@matcher.failure_message_for_should_not.split("\n")}
+    
+    it "returns proper header" do      
+      num_matches(msg,regexp_should_not_header).should be 1
+    end
+    it_behaves_like "w3c detailed notices"
+  end
+  
+  def num_matches(array,regexp)
+    array.map do |string| 
+      string =~ regexp
+    end.keep_if do |value| value == 0 end.length
+  end
+  
+  def num_notices(array)
+    array.map do |string|
+      matches = /#{type.to_s.capitalize}s?: (\d+)/.match(string)
+      matches.nil? ? nil : matches[1].to_i
+    end.keep_if do |value| !value.nil? end.first
+  end
+  
+  def expected_notices(array)
+    abc = array.map do |string|
+      
+      if (matches = regexp_should_header.match(string)) || (matches = regexp_should_not_header.match(string))
+        matches['expected'].to_i        
+      else
+        nil
+      end      
+    end.keep_if do |value| !value.nil? end.first      
+  end
+end
+
+shared_examples_for "w3c detailed notices" do
+  it "returns proper validator string" do    
+    num_matches(msg,/^\s*Checked by: \S+/).should be 1
+  end    
+  it "returns proper character set" do
+    num_matches(msg,/^\s*Character set: \S+/).should be 1
+  end
+  it "returns proper number of notices" do          
+    num_matches(msg,/^\s*#{type.to_s.capitalize}s?: \S+/).should be 1
+  end
+  it "returns Type declaration for every notice" do
+    num_matches(msg,/^\s*Type: #{type}?/).should be num_notices(msg)
+  end
+  it "returns Location declaration for every notice" do
+    num_matches(msg,/^\s*Location: line \S+ column \S+/).should be num_notices(msg)
+  end
+  it "returns URI declaration for every notice" do
+    num_matches(msg,/^\s*URI: .*/).should be num_notices(msg)
+  end
+  it "returns Message declaration for every notice" do
+    num_matches(msg,/^\s*Message: .*/).should be num_notices(msg)
+  end
+  it "returns expected number of Source declarations" do    
+    num_matches(msg,/^\s*Source \(line \d*\): .*/).should be num_notices(msg)
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rspec'
+require 'rspec_w3c_matchers'
+
+require 'shared_examples/notice_matcher'
+require 'shared_examples/matchers'
+require 'responses/responses'
+
+Rspec.configure do |config|
+  #  c.mock_with :mocha
+  APP = RspecW3cMatchers
+  
+  # include the matchers
+  config.include(APP::InstanceMethods)
+end
+

data/tasks/fixtures.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/rspec_w3c_matchers')
+require File.expand_path(File.dirname(__FILE__) + '/../spec/responses/responses')
+require 'fileutils'
+
+
+# used for providing fixtures to users of the gem
+namespace :fixtures do
+  desc 'generate all fixtures for USERS of the GEM'
+  task :all => [:valid,:error,:warning]
+  
+  desc 'generate fixture sample valid response'
+  task :valid => :repository do       
+    dump W3CValidators::MarkupValidator.new.validate_text(response.valid.html),:valid
+  end
+  
+  desc 'generate fixture sample error response'
+  task :error => :repository do   
+    dump W3CValidators::MarkupValidator.new.validate_text(response.error.html),:error
+  end  
+
+  desc 'generate fixture sample error response'
+  task :warning => :repository do       
+    dump W3CValidators::MarkupValidator.new.validate_text(response.warning.html),:warning
+  end    
+  
+  desc 'removing all fixture files'
+  task :clean do
+    files = Dir.glob "#{repo_dir}*.marshal"
+    if files.empty?
+      puts 'nothing to remove'
+    else
+      puts "removing files #{files}"
+      FileUtils.rm files
+    end
+  end
+
+  desc 'create directory for Fixtures'
+  task :repository do
+    repo = repo_dir
+    unless File.exists? repo
+      puts "generating directory #{repo}"
+      FileUtils.mkdir_p repo
+    end
+  end
+
+
+  # helper methods for configuration
+  def config_dir
+    File.expand_path(File.dirname(__FILE__) + '/../')
+  end
+
+  def repo_dir
+    config_dir + '/spec/fixtures/'
+  end
+
+  def dump(data,fname)
+    puts "generating file #{fname}"
+    file = File.open(repo_dir + fname.to_s + '.marshal','w')
+    file.write(Marshal.dump(data))
+    file.close
+  end
+  
+  def response
+    SampleResponses
+  end
+  
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: rspec_w3c_matchers
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Takaltoo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: w3c_validators
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id002
+description: " add description"
+email: 
+- pouya@lavabit.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/rspec_w3c_matchers.rb
+- lib/rspec_w3c_matchers/matchers.rb
+- lib/rspec_w3c_matchers/notices.rb
+- lib/rspec_w3c_matchers/version.rb
+- rspec_w3c_matchers.gemspec
+- spec/base/matchers_spec.rb
+- spec/base/notices_spec.rb
+- spec/base/version_spec.rb
+- spec/fixtures/error.marshal
+- spec/fixtures/valid.marshal
+- spec/fixtures/warning.marshal
+- spec/responses/error.rb
+- spec/responses/responses.rb
+- spec/responses/valid.rb
+- spec/responses/warning.rb
+- spec/shared_examples/matchers.rb
+- spec/shared_examples/notice_matcher.rb
+- spec/spec_helper.rb
+- tasks/.fixtures.rb.swp
+- tasks/fixtures.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/rspec_w3c_matchers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rspec_w3c_matchers
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rspec 2.0 matchers that detect and report detailed error and warning responses from w3c_validators GEM.
+test_files: []
+