rspec2-rails-views-matchers 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+html

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    rspec2-rails-views-matchers (0.0.1)
+      nokogiri (~> 1.4.4)
+      rspec (>= 2.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    nokogiri (1.4.4)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec2-rails-views-matchers!

data/README.rdoc

@@ -0,0 +1,24 @@
+= Why?
+
+* you need to test some complex views
+* and you want to use rspec2
+* and assert\_select seems is something strange to you
+* rspec-rails[https://github.com/rspec/rspec-rails] for some reason does not provide instruments for testing views
+* you need user-firendly output in error messages
+
+== Install
+
+add to your Gemfile(in group :test :) ):
+
+  gem 'rspec2-rails-views-matchers'
+
+== Usage
+
+descriptive code:
+
+  rendered.should have_tag('form',:with => {:action => user_path, :method => 'post'}) {
+    with_tag "input", :with => { :name => "user[email]", :type => 'email' }
+    with_tag "input", :with => { :name => "user[password]", :type => 'password'}
+    with_tag "input", :with => { :name => "user[password_confirmation]", :type => 'password' }
+    with_tag "input#special_submit"
+  }

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new
+
+Rake::RDocTask.new(:rdoc) do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.options << "--all"
+end

data/lib/rspec/rails/views/matchers.rb

@@ -0,0 +1 @@
+require 'rspec/rails/views/matchers/have_tag'

data/lib/rspec/rails/views/matchers/have_tag.rb

@@ -0,0 +1,117 @@
+require 'nokogiri'
+
+module RSpec
+  module Matchers
+
+    class NokogiriMatcher#:nodoc:
+      attr_reader :failure_message
+      attr_reader :parent_scope, :current_scope
+
+      def initialize tag, options={}, &block
+        @tag, @options, @block = tag, options, block
+
+	if attrs = @options.delete(:with)
+	  html_attrs_string=''
+	  attrs.each_pair { |k,v| html_attrs_string << %Q{[#{k.to_s}='#{v.to_s}']} }
+	  @tag << html_attrs_string
+	end
+
+	# TODO add min and max processing
+	@options[:minimum] ||= @options.delete(:min)
+	@options[:maximum] ||= @options.delete(:max)
+      end
+
+      def matches?(document)
+
+	case document
+	when String
+	  @parent_scope = @current_scope = Nokogiri::HTML(document).css(@tag)
+	  @document = document
+	else
+	  @parent_scope = document.current_scope
+	  @current_scope = document.parent_scope.css(@tag)
+	  @document = @parent_scope.to_html
+	end
+
+	if tag_presents? and count_right? and content_right?
+	  @current_scope = @parent_scope
+	  @block.call if @block
+	  true
+	else
+	  false
+	end
+      end
+
+      private
+
+      def tag_presents?
+	if @current_scope.first
+	  @count = @current_scope.count
+	  true
+	else
+	  @failure_message = %Q{expected following:\n#{@document}\nto have at least 1 element matching "#{@tag}", found 0.}
+	  false
+	end
+      end
+
+      def count_right?
+	case @options[:count]
+	when Integer
+	  @count == @options[:count] || (@failure_message=%Q{expected following:\n#{@document}\nto have #{@options[:count]} element(s) matching "#{@tag}", found #{@count}.}; false)
+	when Range
+	  @options[:count].member?(@count) || (@failure_message=%Q{expected following:\n#{@document}\nto have at least #{@options[:count].min} and at most #{@options[:count].max} element(s) matching "#{@tag}", found #{@count}.}; false)
+	when nil
+	  if @options[:maximum]
+	    @count <= @options[:maximum] || (@failure_message=%Q{expected following:\n#{@document}\nto have at most #{@options[:maximum]} element(s) matching "#{@tag}", found #{@count}.}; false)
+	  elsif @options[:minimum]
+	    @count >= @options[:minimum] || (@failure_message=%Q{expected following:\n#{@document}\nto have at least #{@options[:minimum]} element(s) matching "#{@tag}", found #{@count}.}; false)
+	  else
+	    true
+	  end
+	else
+	  @failure_message = 'wrong count specified'
+	  return false
+	end
+      end
+
+      def content_right?
+	return true unless @options[:text]
+
+	case text=@options[:text]
+	when Regexp
+	  if @current_scope.any? {|node| node.content =~ text }
+	    true
+	  else
+	    @failure_message=%Q{#{text.inspect} regexp expected within "#{@tag}" in following template:\n#{@document}}
+	    false
+	  end
+	else
+	  if @current_scope.any? {|node| node.content == text }
+	    true
+	  else
+	    @failure_message=%Q{"#{text}" expected within "#{@tag}" in following template:\n#{@document}}
+	    false
+	  end
+	end
+      end
+    end
+
+    # :call-seq:
+    #   rendered.should have_tag(tag,options={},&block)
+    #   rendered.should have_tag(tag,options={},&block) { with_tag(other_tag) }
+    #   string.should have_tag(tag,options={},&block)
+    #
+    def have_tag tag,options={}, &block
+      @__current_scope_for_nokogiri_matcher = NokogiriMatcher.new(tag, options, &block)
+    end
+
+    def with_tag tag, options={}, &block
+      @__current_scope_for_nokogiri_matcher.should have_tag(tag, options, &block)
+    end
+
+    def without_tag tag, options={}, &block
+      @__current_scope_for_nokogiri_matcher.should_not have_tag(tag, options, &block)
+    end
+
+  end
+end

data/lib/rspec/rails/views/matchers/version.rb

@@ -0,0 +1,9 @@
+module RSpec#:nodoc:
+  module Rails#:nodoc:
+    module Views#:nodoc:
+      module Matchers#:nodoc:
+        VERSION = "0.0.1"
+      end
+    end
+  end
+end

data/lib/rspec2-rails-views-matchers.rb

@@ -0,0 +1 @@
+require 'rspec/rails/views/matchers'

data/rspec2-rails-views-matchers.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rspec/rails/views/matchers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rspec2-rails-views-matchers"
+  s.version     = RSpec::Rails::Views::Matchers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["kucaahbe"]
+  s.email       = ["kucaahbe@ukr.net"]
+  s.homepage    = ""
+  s.summary     = %q{collection of rspec2 views matchers for rails}
+  s.description = s.summary
+
+  s.rubyforge_project = "rspec2-rails-views-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_dependency 'rspec', '>= 2.0.0'
+  s.add_dependency 'nokogiri', '~> 1.4.4'
+end

data/spec/matchers/have_tag_spec.rb

@@ -0,0 +1,246 @@
+require 'spec_helper'
+
+describe 'have_tag' do
+
+  it "should have message for should_not"
+  it "should have #description method"
+
+  context "through css selector" do
+
+    before :each do
+      render_html <<HTML
+<div>
+  some content
+  <div id="div">some other div</div>
+  <p class="paragraph">la<strong>lala</strong></p>
+</div>
+<form id="some_form">
+  <input id="search" type="text" />
+  <input type="submit" value="Save" />
+</form>
+HTML
+    end
+
+    it "should find tags" do
+      rendered.should have_tag('div')
+      rendered.should have_tag('div#div')
+      rendered.should have_tag('p.paragraph')
+      rendered.should have_tag('div p strong')
+    end
+
+    it "should not find tags" do
+      rendered.should_not have_tag('span')
+      rendered.should_not have_tag('span#id')
+      rendered.should_not have_tag('span#class')
+      rendered.should_not have_tag('div div span')
+    end
+
+    it "should not find tags and display appropriate message" do
+      expect { rendered.should have_tag('span') }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have at least 1 element matching "span", found 0.}
+      )
+      expect { rendered.should have_tag('span#some_id') }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have at least 1 element matching "span#some_id", found 0.}
+      )
+      expect { rendered.should have_tag('span.some_class') }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have at least 1 element matching "span.some_class", found 0.}
+      )
+    end
+
+    context "with additional HTML attributes(:with option)" do
+
+      it "should find tags" do
+	rendered.should have_tag('input#search',:with => {:type => "text"})
+	rendered.should have_tag('input',:with => {:type => "submit", :value => "Save"})
+      end
+
+      it "should not find tags" do
+	rendered.should_not have_tag('input#search',:with => {:type => "some_other_type"})
+      end
+
+      it "should not find tags and display appropriate message" do
+	expect { rendered.should have_tag('input#search',:with => {:type => "some_other_type"}) }.should raise_spec_error(
+	  %Q{expected following:\n#{rendered}\nto have at least 1 element matching "input#search[type='some_other_type']", found 0.}
+	)
+      end
+
+    end
+
+  end
+
+  context "by count" do
+
+    before :each do
+      render_html <<HTML
+<p>tag one</p>
+<p>tag two</p>
+<p>tag three</p>
+HTML
+    end
+
+    it "should find tags" do
+      rendered.should have_tag('p', :count    => 3)
+      rendered.should have_tag('p', :count => 2..3)
+    end
+
+    it "should find tags when :minimum specified" do
+      rendered.should have_tag('p', :min      => 3)
+      rendered.should have_tag('p', :minimum  => 2)
+    end
+
+    it "should find tags when :maximum specified" do
+      rendered.should have_tag('p', :max      => 4)
+      rendered.should have_tag('p', :maximum  => 3)
+    end
+
+    it "should not find tags(with :count, :minimum or :maximum specified)" do
+      rendered.should_not have_tag('p', :count   => 10)
+      rendered.should_not have_tag('p', :count => 4..8)
+      rendered.should_not have_tag('p', :min     => 11)
+      rendered.should_not have_tag('p', :minimum => 10)
+      rendered.should_not have_tag('p', :max     => 2)
+      rendered.should_not have_tag('p', :maximum => 2)
+    end
+
+    it "should not find tags and display appropriate message(with :count)" do
+      expect { rendered.should have_tag('p', :count => 10) }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have 10 element(s) matching "p", found 3.}
+	)
+
+      expect { rendered.should have_tag('p', :count => 4..8) }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have at least 4 and at most 8 element(s) matching "p", found 3.}
+	)
+    end
+
+    it "should not find tags and display appropriate message(with :minimum)" do
+      expect { rendered.should have_tag('p', :min => 100) }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have at least 100 element(s) matching "p", found 3.}
+	)
+      expect { rendered.should have_tag('p', :minimum => 100) }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have at least 100 element(s) matching "p", found 3.}
+	)
+    end
+
+    it "should not find tags and display appropriate message(with :maximum)" do
+      expect { rendered.should have_tag('p', :max => 2) }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have at most 2 element(s) matching "p", found 3.}
+	)
+      expect { rendered.should have_tag('p', :maximum => 2) }.should raise_spec_error(
+	%Q{expected following:\n#{rendered}\nto have at most 2 element(s) matching "p", found 3.}
+	)
+    end
+
+    it "should raise error when wrong params specified" do
+      pending(:TODO)
+      wrong_params_error_msg_1 = 'TODO1'
+      expect { rendered.should have_tag('div', :count => 2, :minimum => 1 ) }.should raise_error(wrong_params_error_msg_1)
+      expect { rendered.should have_tag('div', :count => 2, :min => 1 )     }.should raise_error(wrong_params_error_msg_1)
+      expect { rendered.should have_tag('div', :count => 2, :maximum => 1 ) }.should raise_error(wrong_params_error_msg_1)
+      expect { rendered.should have_tag('div', :count => 2, :max => 1 )     }.should raise_error(wrong_params_error_msg_1)
+
+      wrong_params_error_msg_2 = 'TODO2'
+      expect { rendered.should have_tag('div', :minimum => 2, :maximum => 1 ) }.should raise_error(wrong_params_error_msg_2)
+
+      [ 4..1, -2..6, 'a'..'z', 3..-9 ].each do |range|
+	expect { rendered.should have_tag('div', :count => range ) }.should raise_error("Your :count range(#{range.to_s}) has no sence!")
+      end
+    end
+
+  end
+
+  context "with content specified" do
+
+    before :each do
+      render_html <<HTML
+<div>sample text</div>
+<p>one </p>
+<p> two</p>
+<p> three </p>
+HTML
+    end
+
+    it "should find tags" do
+      rendered.should have_tag('div', :text => 'sample text')
+      rendered.should have_tag('p',   :text => 'one '       )
+      rendered.should have_tag('div', :text => /SAMPLE/i    )
+    end
+
+    it "should not find tags" do
+      rendered.should_not have_tag('p',      :text => 'text does not present')
+      rendered.should_not have_tag('strong', :text => 'text does not present')
+      rendered.should_not have_tag('p',      :text => /text does not present/)
+      rendered.should_not have_tag('strong', :text => /text does not present/)
+    end
+
+    it "should not find tags and display appropriate message" do
+      # TODO make diffable,maybe...
+      expect { rendered.should have_tag('div', :text => 'SAMPLE text') }.should raise_spec_error(
+	%Q{"SAMPLE text" expected within "div" in following template:\n#{rendered}}
+	)
+      expect { rendered.should have_tag('div', :text => /SAMPLE tekzt/i) }.should raise_spec_error(
+	%Q{/SAMPLE tekzt/i regexp expected within "div" in following template:\n#{rendered}}
+	)
+    end
+
+  end
+
+  context "nested matching:" do
+    before :each do
+      @ordered_list =<<OL
+    <ol class="menu">
+      <li>list item 1</li>
+      <li>list item 2</li>
+      <li>list item 3</li>
+    </ol>
+OL
+      render_html <<HTML
+<html>
+  <body>
+#{@ordered_list}
+  </body>
+</html>
+HTML
+    end
+
+    it "should find tags" do
+      rendered.should have_tag('ol') {
+	with_tag('li', :text  => 'list item 1')
+	with_tag('li', :text  => 'list item 2')
+	with_tag('li', :text  => 'list item 3')
+	with_tag('li', :count => 3)
+	with_tag('li', :count => 2..3)
+	with_tag('li', :min   => 2)
+	with_tag('li', :max   => 6)
+      }
+    end
+
+    it "should not find tags" do
+      rendered.should have_tag('ol') {
+	without_tag('div')
+	without_tag('li', :count => 2)
+	without_tag('li', :count => 4..8)
+	without_tag('li', :min => 100)
+	without_tag('li', :max => 2)
+	without_tag('li', :text => 'blabla')
+	without_tag('li', :text => /list item (?!\d)/)
+      }
+    end
+
+    it "should not find tags and display appropriate message" do
+      ordered_list_regexp = @ordered_list.gsub(/(\n?\s{2,}|\n\s?)/,'\n*\s*')
+      expect {
+	rendered.should have_tag('ol') { with_tag('li'); with_tag('div') }
+      }.should raise_spec_error(/expected following:#{ordered_list_regexp}to have at least 1 element matching "div", found 0/)
+
+      expect {
+	rendered.should have_tag('ol') { with_tag('li'); with_tag('li', :count => 10) }
+      }.should raise_spec_error(/expected following:#{ordered_list_regexp}to have 10 element\(s\) matching "li", found 3/)
+
+      expect {
+	rendered.should have_tag('ol') { with_tag('li'); with_tag('li', :text => /SAMPLE text/i) }
+      }.should raise_spec_error(/\/SAMPLE text\/i regexp expected within "li" in following template:#{ordered_list_regexp}/)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rspec/rails/views/matchers'
+
+# Requires supporting files with custom matchers and macros, etc,
+# # in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+module RenderedHelper
+  def render_html html
+    @rendered = html
+  end
+
+  def rendered
+    @rendered
+  end
+end
+
+RSpec.configure do |config|
+  config.include RenderedHelper
+end

data/spec/support/spec_error.rb

@@ -0,0 +1,3 @@
+def raise_spec_error msg
+  raise_error RSpec::Expectations::ExpectationNotMetError, msg
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: rspec2-rails-views-matchers
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- kucaahbe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id002
+description: collection of rspec2 views matchers for rails
+email: 
+- kucaahbe@ukr.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/rspec/rails/views/matchers.rb
+- lib/rspec/rails/views/matchers/have_tag.rb
+- lib/rspec/rails/views/matchers/version.rb
+- lib/rspec2-rails-views-matchers.rb
+- rspec2-rails-views-matchers.gemspec
+- spec/matchers/have_tag_spec.rb
+- spec/spec_helper.rb
+- spec/support/spec_error.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rspec2-rails-views-matchers
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: collection of rspec2 views matchers for rails
+test_files: []
+