webrat 0.2.0 → 0.3.0

data/History.txt

@@ -1,3 +1,65 @@
+== 0.3.0 / 2008-11-07
+
+* Major enhancements
+
+  * Added Merb support (Gwyn Morfey, Jeremy Burks, Rob Kaufman, Yehuda Katz)
+  * Added experimental Selenium support (Luke Melia)
+  * Add have_selector, have_xpath, have_tag and contain matchers from Merb
+  * Switch from Hpricot to Nokogiri for XML parsing (thanks, Aaron Patterson)
+  
+* Minor enhancements
+
+  * Added #within for manipulating the current page within a selector scope
+  * Add support for file fields via #attaches_file method (Rails only at the moment) (Kyle Hargraves)
+  * Add support for simulating SSL requests (Luke Melia)
+  * Added #basic_auth(user, pass) to support HTTP Basic Auth (Aslak Hellesøy)
+  * Added support for Sinatra and Rack (Aslak Hellesøy)
+  * Rename visits to visit, fills_in to fill_in, etc.
+  * Add #field_labeled for looking up form fields by label (David Chelimsky)
+  * Add #field_named and #field_with_id locators
+  * Don't depend on hoe anymore
+  * Return responses after sending requests
+  * Allow clicking links and buttons by a regular expression in Selenium (Luke Melia)
+  * Allow clicking links by a regular expression
+  * Add #http_accept for including MIME type HTTP "Accept" headers (Ryan Briones)
+  * Add #header to support inclusion of custom HTTP headers (Ryan Briones)
+  * Consider response codes 200-499 as successful enough to not raise a Webrat error (David Leal)
+  * Add Webrat.root method for cross-framework support (Krzysztof Zylawy)
+  * Add support for clicking areas of an image map (Alex Lang)
+  * Support relative links, including href="?foo=bar" (Kyle Hargraves)
+  * Separated Rails-specific code from the Webrat core to make it easier to use Webrat with other environments
+  * Alias visits as visit, clicks_link as click_link, etc. for better readability
+  * Raise error when trying to interact with a disabled form element (Luke Melia)
+  * Don't send disabled form elements to the server (Nicholas A. Evans)
+  * Display response body when the page load is not successful (David Leal)
+  * CGI escape form field values (Miha Filej)
+  * Add support for redirect_to :back by sending HTTP_REFERER headers (Hendrik Volkmer)
+  * Expose current DOM (as an Hpricot object) as #current_dom
+  * Add support for disabling JavaScript when clicking a link to enable testing of both JS
+    and non-JS implementations (Luke Melia and Bryan Helmkamp)
+  * Support &nbsp's as spaces in matching link text (Luke Melia)
+  * Support button elements (Nick Sieger)
+  * Support matching select options by regexp (Kyle Hargraves)
+  * save_and_open_page rewrites css and image references to provide a friendlier debugging experience (Luke Melia)
+  * Added support for matching alt attributes in fields (primarly for clicks_button) (Aaron Quint)
+  * Support '&' in submitted values (Kyle Hargraves)
+  * Support clicking links by title (Dan Barry)
+  * Added missing spec for clicking image buttons (Tim Harper)
+  * Switched tests to specs, and from Mocha to RSpec's mocking library
+  * Add support to click_button for IDs (Gwyn Morfey)
+  * Miscellaneous core refactorings (Jan Suchal)
+  
+* Bug fixes
+
+  * Fix initialization of WWW::Mechanize (Derek Kastner)
+  * Don't open blank pages in the browser (Kyle Hargraves)
+  * Support radio buttons with multiple labels (Dan Barry)
+  * Fix load order bug on some platforms (Ismael Celis)
+  * Fix bug with empty select list option (Kyle Hargraves)
+  * Fix regression of not sending default values in password fields
+  * Don't explode if encountering inputs with no type attribute (assume text)
+  * Fix bug where choosing a radio button in a series with a default submitted the incorrect field value (Luke Melia)
+  
 == 0.2.0 / 2008-04-04
 
 * 4 Major enhancements
@@ -6,29 +68,29 @@
   * Add radio button support via #chooses method
   * Add basic support for Rails-generated JavaScript link tags
   * Add support for checkboxes (Patches from Kyle Hargraves and Jarkko Laine)
-  * Add support for textarea fields (Patch from Sacha Schlegel)
+  * Add support for textarea fields (Sacha Schlegel)
   
 * 8 Minor enhancements
   
-  * Added reloads method to reload the page (Patch from Kamal Fariz Mahyuddi)
-  * Prevent making a request if clicking on local anchor link (Patch from Kamal Fariz Mahyuddi)
+  * Added reloads method to reload the page (Kamal Fariz Mahyuddi)
+  * Prevent making a request if clicking on local anchor link (Kamal Fariz Mahyuddi)
   * Added clicks_link_within(selector, link_text), allowing restricting link search 
-  to within a given css selector (Path from Luke Melia)
-  * Allow specifying the input name/label when doing a select (Patch from David Chelimsky)
-  * Raise a specific exception if the developer tries to manipulate form elements before loading a page (Patch from James Deville)
-  * Add support for alternate POST, PUT and DELETE link clicking (Patch from Kyle Hargraves)
-  * Change clicks_link to find the shortest matching link (Patch from Luke Melia)
+  to within a given css selector (Luke Melia)
+  * Allow specifying the input name/label when doing a select (David Chelimsky)
+  * Raise a specific exception if the developer tries to manipulate form elements before loading a page (James Deville)
+  * Add support for alternate POST, PUT and DELETE link clicking (Kyle Hargraves)
+  * Change clicks_link to find the shortest matching link (Luke Melia)
   * Improve matching for labels in potentially ambiguous cases
   
 * 7 Bug fixes
 
-  * Fix incorrect serializing of collection inputs, i.e. name contains [] (Patch from Kamal Fariz Mahyuddi)
-  * Serialize empty text field values just like browsers (Patch from Kamal Fariz Mahyuddi)
-  * Quick fix to avoid @dom not initialized warnings (Patch from Kamal Fariz Mahyuddi)
-  * Docfix: bad reference to #select method in README (Patch from Luke Melia)
+  * Fix incorrect serializing of collection inputs, i.e. name contains [] (Kamal Fariz Mahyuddi)
+  * Serialize empty text field values just like browsers (Kamal Fariz Mahyuddi)
+  * Quick fix to avoid @dom not initialized warnings (Kamal Fariz Mahyuddi)
+  * Docfix: bad reference to #select method in README (Luke Melia)
   * Ensure Rails-style checkboxes work properly (checkboxes followed by a hidden input with the same name)
-  * Fix Edge Rails (a.k.a. 2.0 RC) compatibility (Patch from David Chelimsky)
-  * Support param hashes nested more than one level (Patch from David Chelimsky)
+  * Fix Edge Rails (a.k.a. 2.0 RC) compatibility (David Chelimsky)
+  * Support param hashes nested more than one level (David Chelimsky)
 
 == 0.1.0 / 2007-11-28
 

data/README.txt

@@ -1,14 +1,12 @@
-= Webrat - Ruby Acceptance Testing for Web applications
+=== Webrat
 
-  http://rubyforge.org/projects/webrat
-  http://github.com/brynary/webrat
+- [Code on GitHub](http://github.com/brynary/webrat)
+- [Tickets on Lighthouse](http://webrat.lighthouseapp.com/)
 
-* mailto:bryan@brynary.com
-* mailto:seth@mojodna.net
+=== Description
 
-== DESCRIPTION:
-
-Webrat lets you quickly write robust and thorough acceptance tests for a Ruby
+Webrat (_Ruby Acceptance Testing for Web applications_)
+lets you quickly write robust and thorough acceptance tests for a Ruby
 web application. By leveraging the DOM, it can run tests similarly to an
 in-browser testing solution without the associated performance hit (and
 browser dependency). The result is tests that are less fragile and more
@@ -19,20 +17,20 @@ Selenium, the primary consideration should be how much JavaScript the
 application uses. In-browser testing is currently the only way to test JS, and
 that may make it a requirement for your project. If JavaScript is not central
 to your application, Webrat is a simpler, effective solution that will let you
-run your tests much faster and more frequently. (Benchmarks forthcoming.)
+run your tests much faster and more frequently.
 
-Initial development was sponsored by EastMedia (http://www.eastmedia.com).
+Initial development was sponsored by [EastMedia](http://www.eastmedia.com).
 
-== SYNOPSIS:
+=== Synopsis
 
-  def test_sign_up
-    visits "/"
-    clicks_link "Sign up"
-    fills_in "Email", :with => "good@example.com"
-    selects "Free account"
-    clicks_button "Register"
-    ...
-  end
+    def test_sign_up
+      visit "/"
+      click_link "Sign up"
+      fill_in "Email", :with => "good@example.com"
+      select "Free account"
+      click_button "Register"
+      ...
+    end
   
 Behind the scenes, this will perform the following work:
 
@@ -50,37 +48,43 @@ Behind the scenes, this will perform the following work:
 Take special note of the things _not_ specified in that test, that might cause
 tests to break unnecessarily as your application evolves:
 
-* The input field IDs or names (e.g. "user_email" or "user[email]"), which
+- The input field IDs or names (e.g. "user_email" or "user[email]"), which
   could change if you rename a model
-* The ID of the form element (Webrat can do a good job of guessing, even if
+- The ID of the form element (Webrat can do a good job of guessing, even if
   there are multiple forms on the page.)
-* The URLs of links followed
-* The URL the form submission should be sent to, which could change if you
+- The URLs of links followed
+- The URL the form submission should be sent to, which could change if you
   adjust your routes or controllers
-* The HTTP method for the login request
+- The HTTP method for the login request
+
+A test written with Webrat can handle these changes to these without any modifications.
+
+=== Merb
+To avoid losing sessions, you need this in environments/test.rb:
 
-A test written with Webrat can handle these changes smoothly.
+Merb::Config.use do |c|
+  c[:session_store] = 'memory' 
+end  
 
-== REQUIREMENTS:
+=== Install
 
-* Rails >= 1.2.6
-* Hpricot >= 0.6
-* Rails integration tests in Test::Unit _or_
-* RSpec stories (using an RSpec version >= revision 2997)
+To install the latest release:
 
-== INSTALL:
+    sudo gem install webrat
 
 In your stories/helper.rb:
   
-  require "webrat"
+    require "webrat"
   
 You could also unpack the gem into vendor/plugins.
 
-== HISTORY:
+=== Authors
 
-See CHANGELOG in this directory.
+- Maintained by [Bryan Helmkamp](mailto:bryan@brynary.com)
+- Original code written by [Seth Fitzsimmons](mailto:seth@mojodna.net)
+- Many other contributors. See attributions in History.txt
 
-== LICENSE:
+=== License
 
 Copyright (c) 2007 Bryan Helmkamp, Seth Fitzsimmons.
-See MIT-LICENSE in this directory.
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -1,27 +1,89 @@
 require 'rubygems'
-require 'hoe'
+require "rake/gempackagetask"
+require 'rake/rdoctask'
+require "rake/clean"
+require 'spec'
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
 require './lib/webrat.rb'
 
-Hoe.new('webrat', Webrat::VERSION) do |p|
-  p.rubyforge_name = 'webrat'
-  p.summary = 'Ruby Acceptance Testing for Web applications'
-  
-  p.developer "Bryan Helmkamp",   "bryan@brynary.com"
-  p.developer "Seth Fitzsimmons", "seth@mojodna.net"
-  
-  # require "rubygems"; require "ruby-debug"; Debugger.start; debugger
-  
-  p.description = p.paragraphs_of('README.txt', 4..6).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 1).first.split("\n").first.strip
-  p.changes = p.paragraphs_of('History.txt', 0..3).join("\n\n")
-
-  p.extra_deps << ["hpricot", ">= 0.6"]
-  
-  p.remote_rdoc_dir = '' # Release to root
-  p.test_globs = ['test/**/*_test.rb']
+##############################################################################
+# Package && release
+##############################################################################
+spec = Gem::Specification.new do |s|
+  s.name         = "webrat"
+  s.version      = Webrat::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.author       = "Bryan Helmkamp"
+  s.email        = "bryan" + "@" + "brynary.com"
+  s.homepage     = "http://github.com/brynary/webrat"
+  s.summary      = "Webrat. Ruby Acceptance Testing for Web applications"
+  s.bindir       = "bin"
+  s.description  = s.summary
+  s.require_path = "lib"
+  s.files        = %w(History.txt init.rb install.rb MIT-LICENSE.txt README.txt Rakefile TODO.txt) + Dir["lib/**/*"]
+
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.txt MIT-LICENSE.txt)
+
+  # Dependencies
+  s.add_dependency "nokogiri", ">= 1.0.3"
+end
+
+Rake::GemPackageTask.new(spec) do |package|
+  package.gem_spec = spec
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+  puts spec.to_ruby
 end
 
+CLEAN.include ["pkg", "*.gem", "doc", "ri", "coverage"]
+
 desc "Upload rdoc to brynary.com"
 task :publish_rdoc => :docs do
   sh "scp -r doc/ brynary.com:/apps/uploads/webrat"
+end
+
+desc "Run API and Core specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run all specs in spec directory with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = lambda do
+    IO.readlines(File.dirname(__FILE__) + "/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+  end
+end
+
+RCov::VerifyTask.new(:verify_rcov => :rcov) do |t|
+  t.threshold = 96.2 # Make sure you have rcov 0.7 or higher!
+end
+
+task :default do
+  Rake::Task["verify_rcov"].invoke
+end
+
+desc 'Install the package as a gem.'
+task :install_gem => [:clean, :package] do
+  gem = Dir['pkg/*.gem'].first
+  sh "sudo gem install --local #{gem}"
+end
+
+Rake::RDocTask.new(:docs) do |rd|
+  rd.main = "README.txt"
+  rd.rdoc_dir = 'doc'
+  files = spec.files.grep(/^(lib|bin|ext)|txt$/)
+  files -= ["TODO.txt"]
+  files -= files.grep(/\.js$/)
+  rd.rdoc_files = files.uniq
+  title = "webrat-#{Webrat::VERSION} Documentation"
+  rd.options << "-t #{title}"
 end

data/TODO.txt

@@ -1,4 +1,10 @@
-Full support for multiple forms on a page
-Track the current form based on the location of the last manipulated input, use this as a default for clicks_button
+Run tests in separate processes to eliminate constant-level dependencies
+Add rake tasks for selenium runs
+Add tests for selenium
+Add tests for locator strategies
+Use Webrat::Methods for Rails integration
+Get file uploads workign with merb
+Fix #within scoping for forms that exist outside the scope
 Make current_url work with redirections
-Support for a hash mapping page names to page URLs
+Track the current form based on the location of the last manipulated input, use this as a default for click_button
+Verify SSL support in Rails and Merb

data/init.rb

@@ -1,3 +1,3 @@
-if RAILS_ENV == "test"
+if RAILS_ENV == "test" || RAILS_ENV == "selenium"
   require File.join(File.dirname(__FILE__), "lib", "webrat")
 end

data/lib/webrat.rb

@@ -1,6 +1,31 @@
-require File.join(File.dirname(__FILE__), "webrat", "rails_extensions")
-require File.join(File.dirname(__FILE__), "webrat", "session")
+require "rubygems"
 
-class Webrat
-  VERSION = '0.2.0'
-end
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Webrat
+  VERSION = '0.3.0'
+  
+  def self.root #:nodoc:
+    defined?(RAILS_ROOT) ? RAILS_ROOT : Merb.root
+  end
+end
+
+# We need Nokogiri's CSS to XPath support, even if using REXML
+require "nokogiri/css"
+
+# Require nokogiri and fall back on rexml
+begin
+  require "nokogiri"
+  require "webrat/core/nokogiri"
+rescue LoadError => e
+  require "rexml/document"
+  warn("Standard REXML library is slow. Please consider installing nokogiri.\nUse \"sudo gem install nokogiri\"")
+end
+
+require "webrat/core"
+
+# TODO: This is probably not a good idea.
+# Probably better for webrat users to require "webrat/rails" etc. directly
+if defined?(RAILS_ENV)
+  require "webrat/rails"
+end

data/lib/webrat/core.rb

@@ -0,0 +1,12 @@
+require "webrat/core/nokogiri"
+require "webrat/core/logging"
+require "webrat/core/flunk"
+require "webrat/core/form"
+require "webrat/core/scope"
+require "webrat/core/link"
+require "webrat/core/area"
+require "webrat/core/label"
+require "webrat/core/select_option"
+require "webrat/core/session"
+require "webrat/core/methods"
+require "webrat/core/matchers"

data/lib/webrat/core/area.rb

@@ -0,0 +1,44 @@
+module Webrat
+  class Area #:nodoc:
+    
+    def initialize(session, element)
+      @session  = session
+      @element  = element
+    end
+    
+    def click(method = nil, options = {})
+      @session.request_page(absolute_href, :get, {})
+    end
+    
+    def matches_text?(id_or_title)
+      matcher = /#{Regexp.escape(id_or_title.to_s)}/i
+      title =~ matcher || id =~ matcher
+    end
+    
+    protected
+    
+    def href
+      @element["href"]
+    end
+    
+    def title
+      @element["title"]
+    end
+    
+    def id
+      @element["id"]
+    end
+   
+   
+    def absolute_href
+      if href =~ /^\?/
+        "#{@session.current_url}#{href}"
+      elsif href !~ %r{^https?://[\w|.]+(/.*)} && (href !~ /^\//)
+        "#{@session.current_url}/#{href}"
+      else
+        href
+      end
+    end
+    
+  end
+end