suhyo 0.0.3 → 0.0.5

data/.document

@@ -1,5 +1,5 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -1,21 +1,21 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 jarrett
-
-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.
+Copyright (c) 2009 jarrett
+
+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/README.markdown

@@ -1,4 +1,4 @@
-Suhyo
-=====
-
+Suhyo
+=====
+
 Suhyo is an extension to RSpec and Webrat. It provides commonly-needed matchers for web applications. The matchers are documented with RDoc in their respective files in the `lib` directory.

data/Rakefile

@@ -1,46 +1,47 @@
-require 'rubygems'
-require 'rake'
-
-begin
-	require 'jeweler'
-	Jeweler::Tasks.new do |gem|
-		gem.name = "suhyo"
-		gem.summary = 'Matchers for web app specs'
-		gem.description = 'Matchers built on Webrat to address some common needs in web app testing'
-		gem.email = 'jarrett@uchicago.edu'
-		gem.homepage = 'http://github.com/jarrett/suhyo'
-		gem.authors = ['jarrett']
-		gem.add_dependency 'rspec', '>= 1.2.9'
-		gem.add_dependency 'webrat', '>= 0.7.0'
-		# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-	end
-	Jeweler::GemcutterTasks.new
-rescue LoadError
-	puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-	spec.libs << 'lib' << 'spec'
-	spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-	spec.libs << 'lib' << 'spec'
-	spec.pattern = 'spec/**/*_spec.rb'
-	spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-	version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-	rdoc.rdoc_dir = 'rdoc'
-	rdoc.title = "suhyo #{version}"
-	rdoc.rdoc_files.include('README*')
-	rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rubygems'
+require 'rake'
+
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gem|
+		gem.name = "suhyo"
+		gem.summary = 'Matchers for web app specs'
+		gem.description = 'Matchers built on Webrat to address some common needs in web app testing'
+		gem.email = 'jarrett@uchicago.edu'
+		gem.homepage = 'http://github.com/jarrett/suhyo'
+		gem.authors = ['jarrett']
+		gem.add_dependency 'rspec', '>= 1.2.9'
+		gem.add_dependency 'webrat', '>= 0.7.0'
+		gem.add_development_dependency 'cuke-test'
+		# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+	end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+	puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+	spec.libs << 'lib' << 'spec'
+	spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+	spec.libs << 'lib' << 'spec'
+	spec.pattern = 'spec/**/*_spec.rb'
+	spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+	version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+	rdoc.rdoc_dir = 'rdoc'
+	rdoc.title = "suhyo #{version}"
+	rdoc.rdoc_files.include('README*')
+	rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.5

data/lib/suhyo/controller_matchers.rb

@@ -1,38 +1,38 @@
-module Suhyo
-	module ControllerMatchers	
-		class DenyAccess
-			def matches?(response)
-				@response = response
-				@response.status.split(' ').first == '403' or (@response.redirect? and response.redirect_url == Suhyo.config.access_denied_url)
-			end
-			
-			def failure_message
-				if @response.redirect?
-					"expected response to deny access (403 or 302 to #{Suhyo.config.access_denied_url}). Status was #{@response.status} with redirect to #{@response.redirect_url}."
-				else
-					"expected response to deny access (403 or 302 to #{Suhyo.config.access_denied_url}). Status was #{@response.status}."
-				end
-			end
-			
-			def negative_failure_message
-				'expected response not to deny access'
-			end
-		end
-		
-		# Looks for either of two things:
-		#
-		# 1. HTTP status code 403 Forbidden
-		# 2. Redirect to a certain access denied URL.
-		#
-		# The access denied URL is determined by +Suhyo.config.access_denied_url+,
-		# which defaults to +http://test.host/login+.
-		#
-		# Usage:
-		#
-		#   get :some_restricted_action
-		#   response.should deny_access
-		def deny_access
-			DenyAccess.new
-		end
-	end
+module Suhyo
+	module ControllerMatchers	
+		class DenyAccess
+			def matches?(response)
+				@response = response
+				@response.status.split(' ').first == '403' or (@response.redirect? and response.redirect_url == Suhyo.config.access_denied_url)
+			end
+			
+			def failure_message
+				if @response.redirect?
+					"expected response to deny access (403 or 302 to #{Suhyo.config.access_denied_url}). Status was #{@response.status} with redirect to #{@response.redirect_url}."
+				else
+					"expected response to deny access (403 or 302 to #{Suhyo.config.access_denied_url}). Status was #{@response.status}."
+				end
+			end
+			
+			def negative_failure_message
+				'expected response not to deny access'
+			end
+		end
+		
+		# Looks for either of two things:
+		#
+		# 1. HTTP status code 403 Forbidden
+		# 2. Redirect to a certain access denied URL.
+		#
+		# The access denied URL is determined by +Suhyo.config.access_denied_url+,
+		# which defaults to +http://test.host/login+.
+		#
+		# Usage:
+		#
+		#   get :some_restricted_action
+		#   response.should deny_access
+		def deny_access
+			DenyAccess.new
+		end
+	end
 end

data/lib/suhyo/hash_matchers.rb

@@ -0,0 +1,27 @@
+module Suhyo::HashMatchers
+	class IncludeHash
+		def initialize(hash)
+			@hash = hash
+		end
+		
+		def matches?(target)
+			@target = target
+			@hash.each do |key, value|
+				return false unless target[key] == value
+			end
+			true
+		end
+		
+		def failure_message
+			"Expected hash to include #{@hash.inspect} but got #{@target.inspect}"
+		end
+		
+		def negative_failure_message
+			"Expected hash not to include #{@hash.inspect} but got #{@target.inspect}"
+		end
+	end
+	
+	def include_hash(hash)
+		IncludeHash.new(hash)
+	end
+end

data/lib/suhyo/view_matchers.rb

@@ -2,6 +2,15 @@ module Suhyo
 	module ViewMatchers
 		include Webrat::Matchers
 		
+		# A simple wrapper around +have_selector+. Usage:
+		#
+		#   response.should have_button(:text => 'Submit')
+		def have_button(options = {})
+			options[:type] = 'button'
+			options[:value] = options.delete(:text) if options.has_key?(:text)
+			have_selector('input', options)
+		end
+		
 		class HaveOrderedContent < ::Webrat::Matchers::HasContent
 			def initialize(content, options = {})
 				@content = content
@@ -36,26 +45,28 @@ module Suhyo
 			end
 			
 			def failure_message
-				"expected the following element's content to #{content_message}:\n#{squeeze_space(@element)} #{order_message}"
+				"expected the following element's content to #{content_message}#{order_message}:\n\n#{squeeze_space(@element)}"
 			end
 
 			def negative_failure_message
-				"expected the following element's content to not #{content_message}:\n#{squeeze_space(@element)} #{order_message}"
+				"expected the following element's content to not #{content_message}#{order_message}:\n\n#{squeeze_space(@element)}"
 			end
 			
 			def order_message
 				if @options.has_key?(:before)
-					str = "before #{@options[:before]}"
+					str = %Q{ before "#{@options[:before]}"}
 					if @other_content_index.nil?
-						str << " but #{@options[:before]} was not foudn"
+						str << %Q{ but "#{@options[:before]}" was not found}
 					end
+					return str
 				elsif @options.has_key?(:after)
-					str = "after #{@options[:after]}"
+					str = %Q{ after "#{@options[:after]}"}
 					if @other_content_index.nil?
-						str << " but #{@options[:after]} was not foudn"
+						str << %Q{ but "#{@options[:after]}" was not found}
 					end
+					return str
 				else
-					nil
+					return nil
 				end
 			end
 		end

data/lib/suhyo/webrat_steps.rb

@@ -0,0 +1,85 @@
+require 'webrat'
+require 'suhyo'
+
+World(Webrat::Matchers)
+
+include Suhyo::ViewMatchers
+include Suhyo::HashMatchers
+
+# The form class can be something like "user search," which will find form.user_search
+When /^I press "([^\"]*)" in the "([^\"]*)" form$/ do |button, form_class|
+	within '.' + form_class.downcase.gsub(' ', '_') do |scope|
+		scope.click_button(button)
+	end
+end
+
+Then /^I should see a link that says "([^\"]*)"$/ do |text|
+	response.should have_link(:text => text)
+end
+
+Then /^I should not see a link that says "([^\"]*)"$/ do |text|
+	response.should_not have_link(:text => text)
+end
+
+Then /^I should see a link to "([^\"]*)"$/ do |url|
+	response.should have_link(:url => url)
+end
+
+Then /^I should not see a link to "([^\"]*)"$/ do |url|
+	response.should_not have_link(:url => url)
+end
+
+Then /^I should see a button that says "([^\"]*)"$/ do |text|
+	response.should have_button(:text => text)
+end
+
+Then /^I should not see a button that says "([^\"]*)"$/ do |text|
+	response.should_not have_button(:text => text)
+end
+
+Then /^the page title should be "([^\"]*)"$/ do |title|
+	if Suhyo.config.site_title_ends_in
+		title = title + Suhyo.config.site_title_ends_in
+	end
+	response.should have_selector('title', :content => title)
+end
+
+Then /^I should see "([^\"]*)" before "([^\"]*)"$/ do |first, second|
+	response.should contain_in_order(first, :before => second)
+end
+
+Then /^I should see "([^\"]*)" after "([^\"]*)"$/ do |second, first|
+	response.should contain_in_order(second, :after => first)
+end
+
+module Suhyo
+	module ParseQueryHelper
+		def parse_query_string(str)
+			str.split('&').inject({}) do |hash, pair|
+				key, value = pair.split('=')
+				hash[key] = value
+				hash
+			end
+		end
+	end
+end
+
+World(::Suhyo::ParseQueryHelper)
+
+# "At" instead of "on" because "on" would create an ambiguous match
+
+Then /^I should be at (.+) with the query string "([^\"]*)"$/ do |page_name, query_string|
+	uri = URI.parse(current_url)
+	uri.path.should == path_to(page_name)
+	expected_query_hash = parse_query_string(query_string)
+	actual_query_hash = parse_query_string(uri.query)
+	actual_query_hash.should == expected_query_hash
+end
+
+Then /^I should be at (.+) with the query string including "([^\"]*)"$/ do |page_name, query_string|
+	uri = URI.parse(current_url)
+	uri.path.should == path_to(page_name)
+	expected_query_hash = parse_query_string(query_string)
+	actual_query_hash = parse_query_string(uri.query)
+	actual_query_hash.should include_hash(expected_query_hash)
+end

data/lib/suhyo.rb

@@ -5,4 +5,5 @@ $: << File.expand_path(File.dirname(__FILE__))
 
 require 'suhyo/view_matchers'
 require 'suhyo/controller_matchers'
+require 'suhyo/hash_matchers'
 require 'suhyo/config'

data/spec/features/README.txt

@@ -0,0 +1 @@
+The feature files in this directory are invoked from RSpec examples that hook into the Cucumber library. They are not meant to be run from the Cucumber executable.

data/spec/features/steps.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require File.expand_path(File.dirname(__FILE__) + '../../../lib/suhyo/webrat_steps.rb')
+
+module Suhyo
+	module WebratMocks
+		# Mock out some of the methods from Webrat
+		
+		def response
+			@mock_response
+		end
+		
+		def path_to(page_name)
+			'/path'
+		end
+		
+		def current_url
+			@mock_current_url
+		end
+	end
+end
+
+
+
+World(Suhyo::WebratMocks)
+
+Given /^the response is (.+)$/ do |str|
+	@mock_response = str
+end
+
+Given /^the current path is (.+)$/ do |str|
+	@mock_current_url = 'http://test.host/' + str
+end

data/spec/features/webrat.feature

@@ -0,0 +1,98 @@
+Feature: webrat
+  This feature file is used by RSpec to test Suhyo's library of step definitions.
+  
+  Scenario: link text expected, found
+    Given the response is <a href="http://example.com">Correct Text</a>
+    Then I should see a link that says "Correct Text"
+  
+  Scenario: link text expected, not found
+    Given the response is <a href="http://example.com">Wrong Text</a>
+    Then I should see a link that says "Correct Text"
+  
+  Scenario: link text not expected, not found
+    Given the response is <a href="http://example.com">Wrong Text</a>
+    Then I should not see a link that says "Correct Text"
+  
+  Scenario: link text not expected, found
+    Given the response is <a href="http://example.com">Correct Text</a>
+    Then I should not see a link that says "Correct Text"
+  
+  Scenario: link URL expected, found
+    Given the response is <a href="http://correct.com">Text</a>
+    Then I should see a link to "http://correct.com"
+  
+  Scenario: link URL expected, not found
+    Given the response is <a href="http://wrong.com">Text</a>
+    Then I should see a link to "http://correct.com"
+  
+  Scenario: link URL not expected, not found
+    Given the response is <a href="http://wrong.com">Text</a>
+    Then I should not see a link to "http://correct.com"
+  
+  Scenario: link URL not expected, found
+    Given the response is <a href="http://correct.com">Text</a>
+    Then I should not see a link to "http://correct.com"
+  
+  Scenario: button text expected, found
+    Given the response is <input type="button" value="Correct Text"/>
+    Then I should see a button that says "Correct Text"
+  
+  Scenario: button text expected, not found
+    Given the response is <input type="button" value="Wrong Text"/>
+    Then I should see a button that says "Correct Text"
+  
+  Scenario: button text not expected, not found
+    Given the response is <input type="button" value="Wrong Text"/>
+    Then I should not see a button that says "Correct Text"
+  
+  Scenario: button text not expected, found
+    Given the response is <input type="button" value="Correct Text"/>
+    Then I should not see a button that says "Correct Text"
+  
+  Scenario: page title correct
+    Given the response is <head><title>Correct Title</title></head>
+    Then the page title should be "Correct Title"
+  
+  Scenario: page title wrong
+    Given the response is <head><title>Wrong Title</title></head>
+    Then the page title should be "Correct Title"
+  
+  Scenario: content expected before, found before
+    Given the response is <p>First</p><p>Second</p>
+    Then I should see "First" before "Second"
+  
+  Scenario: content expected before, found after
+    Given the response is <p>Second</p><p>First</p>
+    Then I should see "First" before "Second"
+    
+  Scenario: content expected after, found after
+    Given the response is <p>First</p><p>Second</p>
+    Then I should see "Second" after "First"
+  
+  Scenario: content expected after, found before
+    Given the response is <p>Second</p><p>First</p>
+    Then I should see "Second" after "First"
+    
+  Scenario: query string expected, found
+    Given the current path is path?a=alpha&b=beta
+    Then I should be at a page with the query string "a=alpha&b=beta"
+    
+  Scenario: query string expected, not found
+    Given the current path is path?a=alpha
+    Then I should be at a page with the query string "a=alpha&b=beta"
+    
+  Scenario: query string expected, path wrong
+    Given the current path is wrong_path?a=alpha&b=beta
+    Then I should be at a page with the query string "a=alpha&b=beta"
+  
+  Scenario: partial query string expected, found
+    Given the current path is path?a=alpha&b=beta&z=omega
+    Then I should be at a page with the query string including "a=alpha&b=beta"
+  
+  Scenario: partial query string expected, not found
+    Given the current path is path?a=alpha&z=omega
+    Then I should be at a page with the query string including "a=alpha&b=beta"
+  
+  Scenario: partial query string expected, path wrong
+    Given the current path is wrong_path?a=alpha&b=beta&z=omega
+    Then I should be at a page with the query string including "a=alpha&b=beta"

data/spec/hash_matchers_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Suhyo::HashMatchers do
+	include Suhyo::HashMatchers
+	
+	describe '#include_hash' do
+		it 'matches if the target hash includes each pair in the expected hash' do
+			{:a => 1, :b => 2, :c => 3, :d => 4}.should include_hash(:a => 1, :c => 3)
+		end
+		
+		it 'does not match if the target hash is missing one of the pairs in the expected hash' do
+			{:a => 1, :b => 2, :c => 3, :d => 4}.should_not include_hash(:a => 2, :c => 3)
+		end
+	end
+end

data/spec/spec.opts

@@ -1 +1 @@
---color
+--color

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'suhyo'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'suhyo'
+require 'spec'
+require 'spec/autorun'
+require 'cuke-test'
+# Require the matchers
+Dir[File.expand_path(File.join(File.dirname(__FILE__), 'matchers', '**', '*.rb'))].each { |f| require f }
+
+Spec::Runner.configure do |config|
+	
+end