suhyo 0.0.1

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +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.

data/README.markdown

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,46 @@
+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

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/suhyo/config.rb

@@ -0,0 +1,22 @@
+require 'ostruct'
+
+module Suhyo
+	# Get/set Suhyo's config values. This method can be used in several ways:
+	#
+	# 1. To get config values:
+	#   puts Suhyo.config.access_denied_url
+	# 2. To set config values:
+	#   Suhyo.config.access_denied_url = 'http://test.host/login'
+	# 3. To set config values in block form:
+	#   Suhyo.config do |config|
+	#     config.access_denied_url = 'http://test.host/login'
+	#   end
+	def self.config
+		@config ||= OpenStruct.new
+		# Set defaults here
+		@config.access_denied_url ||= 'http://test.host/login'
+		# End of defaults
+		yield @config if block_given?
+		@config
+	end
+end

data/lib/suhyo/controller_matchers.rb

@@ -0,0 +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
+end

data/lib/suhyo/view_matchers.rb

@@ -0,0 +1,155 @@
+module Suhyo
+	module ViewMatchers
+		include Webrat::Matchers
+		
+		class HaveOrderedContent < ::Webrat::Matchers::HasContent
+			def initialize(content, options = {})
+				@content = content
+				@options = options
+			end
+			
+			def matches?(stringlike)
+				@document = Webrat::XML.document(stringlike)
+				@element = @document.inner_text
+				compacted = @element.gsub(/\s+/, ' ')
+				if index = compacted.index(@content)
+					if @options.has_key?(:before)
+						@other_content_index = compacted.index(options[:before])
+						index < @other_content_index
+					elsif @options.has_key?(:after)
+						@other_content_index = compacted.index(options[:after])
+						index > @other_content_index
+					else
+						true
+					end
+				else
+					nil
+				end
+			end
+			
+			def failure_message
+				"expected the following element's content to #{content_message}:\n#{squeeze_space(@element)} #{order_message}"
+			end
+
+			def negative_failure_message
+				"expected the following element's content to not #{content_message}:\n#{squeeze_space(@element)} #{order_message}"
+			end
+			
+			def order_message
+				if @options.has_key?(:before)
+					str = "before #{options[:before]}"
+					if @other_content_index.nil?
+						str << " but #{options[:before]} was not foudn"
+					end
+				elsif @options.has_key?(:after)
+					str = "after #{options[:after]}"
+					if @other_content_index.nil?
+						str << " but #{options[:after]} was not foudn"
+					end
+				else
+					nil
+				end
+			end
+		end
+		
+		# Like Webrat's +contain+ matcher, except it checks that one bit of text comes before or after another.
+		# Useful for testing sort order, for example. 
+		def contain_in_order(content, options = {})
+			HaveOrderedContent.new(content, options)
+		end
+		
+		# A simple wrapper around +have_selector+. Usage:
+		#
+		#   response.should have_link(:url => people_url, :text => 'People', :ancestors => 'div#main')
+		#
+		# The above example would match the following:
+		#
+		#   <div id="main">
+		#     <a href="http://test.host/people">People</a>
+		#   </div>
+		#
+		# Options other than +:url+, +:text+, and +ancestors+ will be passed through
+		# to +have_selector+.
+		def have_link(options = {})
+			options[:href] = options.delete(:url) if options.has_key?(:url)
+			options[:content] = options.delete(:text) if options.has_key?(:text)
+			if ancestors = options.delete(:ancestors)
+				selector = ancestors + ' a'
+			else
+				selector = 'a'
+			end
+			have_selector(selector, options)
+		end
+		
+		class HaveRestfulForm < ::Webrat::Matchers::HaveSelector
+			def initialize(method, options = {}, &block)
+				@options = options
+				@method = method.to_s.downcase
+				# browser_method is the method the browser actually uses, either GET or POST
+				@browser_method = (method == 'get') ? 'get' : 'post'
+				if ancestors = options.delete(:ancestors)
+					@expected = ancestors + ' form'
+				else
+					@expected = 'form'
+				end
+				@options.merge!(:method => @browser_method)
+				@block = block
+			end
+			
+			def matches(stringlike)
+				# Cache it, because we're going to use it again in matches_hidden_field?
+				@matches ||= super(stringlike)
+			end
+			
+			def matches?(stringlike, &block)
+				super(stringlike, &block) and matches_hidden_field?(stringlike)
+			end
+			
+			def matches_hidden_field?(stringlike)
+				form = matches(stringlike)
+				case @method
+				when 'get', 'post'
+					!::Webrat::Matchers::HaveSelector.new('input', :name => '_method').matches?(form)
+				when 'put'
+					::Webrat::Matchers::HaveSelector.new('input', :name => '_method', :value => 'put').matches?(form)
+				when 'delete'
+					::Webrat::Matchers::HaveSelector.new('input', :name => '_method', :value => 'delete').matches?(form)
+				end
+			end
+			
+			# Messages
+			
+			def failure_message
+				"expected following output to contain a #{@method.upcase} form#{attributes_message}:\n\n#{@document}"
+			end
+
+			def negative_failure_message
+				"expected following output to omit a #{@method.upcase} form#{attributes_message}:\n\n#{@document}"
+			end
+			
+			def attributes_message
+				attrs = @options.dup
+				attrs.delete(:method)
+				attrs.empty? ? nil : ' with attributes ' + attrs.inspect
+			end
+		end
+		
+		# Wrapper around +have_selector+. Checks for a Rails-style form with the given HTTP method.
+		# You can also specify the +action+ and any other other attributes in the +options+ hash. Usage:
+		#
+		#   response.should have_restful_form('put', :action => person_path(42), :class => 'edit_person', :ancestors => 'div#main')
+		#
+		# The above example would match the following:
+		#
+		#   <div id="main">
+		#     <form method="post" action="/people/42">
+		#       <input type="hidden" name="_method" value="put"/>
+		#     </form>
+		#   </div>
+		#
+		# Options other than +ancestors+ will be passed through to +have_selector+.
+		def have_restful_form(method, options = {})
+			HaveRestfulForm.new(method, options)
+		end
+	end
+end

data/lib/suhyo.rb

@@ -0,0 +1,8 @@
+require 'webrat'
+require 'cucumber'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'suhyo/view_matchers'
+require 'suhyo/controller_matchers'
+require 'suhyo/config'

data/spec/controller_matchers_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Suhyo::ViewMatchers do
+	include Suhyo::ControllerMatchers
+	
+	describe '#deny_access' do
+		before :all do
+			Suhyo.config.access_denied_url = 'http://test.host/access_denied'
+		end
+		
+		before :each do
+			@response = mock(:status => '200 OK', :redirect? => false, :redirect_url => nil)
+		end
+		
+		it 'matches 403' do
+			@response.stub(:status => '403 Forbidden')
+			@response.should deny_access
+		end
+		
+		it 'matches a 302 redirect to the access denied URL' do
+			@response.stub(:redirect? => true, :status_code => '302 Found', :redirect_url => 'http://test.host/access_denied')
+			@response.should deny_access
+		end
+		
+		((
+			(100..102).to_a +
+			(200..207).to_a +
+			(400..450).to_a + 
+			(500..530).to_a
+		) - [403]).each do |code|
+			it "does not match #{code}" do
+				@response.stub(:status => code.to_s + ' Code Description')
+				@response.should_not deny_access
+			end
+		end
+		
+		it 'does not match a 302 redirect to anything other than the access denied URL' do
+			@response.stub(:redirect? => true, :status => '302 Found', :redirect_url => 'http://test.host/private')
+			@response.should_not deny_access
+		end
+	end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$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

data/spec/view_matchers_spec.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Suhyo::ViewMatchers do
+	include Suhyo::ViewMatchers
+	
+	describe '#have_link' do
+		it 'matches with no options' do
+			'<a href="http://example.com">Foo</a>'.should have_link
+		end
+		
+		it 'matches the text' do
+			'<a href="http://example.com">Foo</a>'.should have_link(:text => 'Foo')
+		end
+		
+		it 'matches the URL' do
+			'<a href="http://example.com">Foo</a>'.should have_link(:url => 'http://example.com')
+		end
+		
+		it 'matches the ancestors' do
+			'<div id="main"><a href="http://example.com">Foo</a></div>'.should have_link(:ancestors => 'div#main')
+		end
+		
+		it 'does not match when there is no link' do
+			'<div><p>Foo</p></div>'.should_not have_link
+		end
+		
+		it 'does not match when the text is wrong' do
+			'<a href="http://example.com">Foo</a>'.should_not have_link(:text => 'Bar')
+		end
+		
+		it 'does not match when the URL is wrong' do
+			'<a href="http://example.com">Foo</a>'.should_not have_link(:url => 'http://google.com')
+		end
+		
+		it 'does not match when the ancestors are wrong' do
+			'<a href="http://example.com">Foo</a>'.should_not have_link(:ancestors => 'div#main')
+		end
+	end
+	
+	describe '#have_restful_form' do
+		def restful_form(method)
+			case method
+			when 'get'
+				browser_method = 'get'
+				hidden_field = nil
+			when 'post'
+				browser_method = 'post'
+				hidden_field = nil
+			when 'put'
+				browser_method = 'post'
+				hidden_field = '<input type="hidden" name="_method" value="put"/>'
+			when 'delete'
+				browser_method = 'post'
+				hidden_field = '<input type="hidden" name="_method" value="delete"/>'
+			end
+			%Q{<form method="#{browser_method}">#{hidden_field}</form>}
+		end
+		
+		%w(get post put delete).each do |expected_method|
+			it "matches a #{expected_method.upcase} form" do
+				restful_form(expected_method).should have_restful_form(expected_method)
+			end
+			
+			(%w(get post put delete) - [expected_method]).each do |actual_method|
+				it "does not match #{expected_method.upcase} when the method is #{actual_method.upcase}" do
+					restful_form(actual_method).should_not have_restful_form(expected_method)
+				end
+			end
+		end
+		
+		it 'matches the ancestors' do
+			('<div id="main">' + restful_form('get') + '</div>').should have_restful_form('get', :ancestors => 'div#main')
+		end
+		
+		it 'does not match if the ancestors are wrong' do
+			restful_form('get').should_not have_restful_form('get', :ancestors => 'div#main')
+		end
+		
+		it 'matches arbitrary attributes' do
+			'<form action="http://example.com" method="get"></form>'.should have_restful_form('get', :action => 'http://example.com')
+			'<form action="http://example.com" method="get"></form>'.should_not have_restful_form('get', :action => 'http://google.com')
+		end
+	end
+end

data/suhyo.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{suhyo}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jarrett"]
+  s.date = %q{2010-03-11}
+  s.description = %q{Matchers built on Webrat to address some common needs in web app testing}
+  s.email = %q{jarrett@uchicago.edu}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/suhyo.rb",
+     "lib/suhyo/config.rb",
+     "lib/suhyo/controller_matchers.rb",
+     "lib/suhyo/view_matchers.rb",
+     "spec/controller_matchers_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/view_matchers_spec.rb",
+     "suhyo.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jarrett/suhyo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Matchers for web app specs}
+  s.test_files = [
+    "spec/controller_matchers_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/view_matchers_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<webrat>, [">= 0.7.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<webrat>, [">= 0.7.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<webrat>, [">= 0.7.0"])
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: suhyo
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- jarrett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: webrat
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+    version: 
+description: Matchers built on Webrat to address some common needs in web app testing
+email: jarrett@uchicago.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/suhyo.rb
+- lib/suhyo/config.rb
+- lib/suhyo/controller_matchers.rb
+- lib/suhyo/view_matchers.rb
+- spec/controller_matchers_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/view_matchers_spec.rb
+- suhyo.gemspec
+has_rdoc: true
+homepage: http://github.com/jarrett/suhyo
+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: Matchers for web app specs
+test_files: 
+- spec/controller_matchers_spec.rb
+- spec/spec_helper.rb
+- spec/view_matchers_spec.rb