webrat 0.3.4 → 0.4.0

data/History.txt

@@ -1,44 +1,145 @@
+== 0.4.0 / 2009-01-18
+
+* _IMPORTANT_ Breaking change:
+
+  * Removed init.rb auto-require of webrat/rails
+  * Removed auto-require of webrat/rails when requiring webrat when RAILS_ENV is
+    defined
+
+  In your env.rb or test_helper.rb file, ensure you have something like:
+
+    require "webrat"
+
+    Webrat.configure do |config|
+      config.mode = :rails
+    end
+
+* Major enhancements
+
+  * Major improvements to Webrat::Selenium (Many contributors listed here)
+  * Add assert_* methods for using Webrat's matchers w/o RSpec (Mike Gaffney, Amos King)
+  * Added Webrat.configure method for Webrat configuration [#33] (Mike Gaffney)
+  * Added select_time, select_date, and select_datetime to API. [#36] (Ben Mabey)
+  * Use Hpricot and REXML when not parsing with Nokogiri (on JRuby, for example)
+
+* Minor enhancements
+
+  * Added Selenium grid configuration and support. (Amos King && Cornel Borcean)
+  * Support passing an ActiveRecord model to #within when in Rails mode [#68] (Luke Melia)
+  * Make assert_* matchers in rails mode increment the assertions count [#123] (Amos King)
+  * Added assert_* matchers to selenium matchers [#110] (Amos King)
+  * Added assert_contain, assert_not_contain [#86] (Mike Gaffney, Amos King)
+  * Add configuration options for the Selenium environment and port (Kieran Pilkington)
+  * Maximize the browser window after initializing Selenium (Luke Melia)
+  * Better inspect output for Webrat elements
+  * Sets the Webrat mode with Configuration#mode= in the config block [#85] (Mike Gaffney)
+  * Detect if the document is XML or HTML using the Content-Type when in Rails mode
+  * Expose #selenium method for direct access to Selenium client
+  * Check nokogiri gem version before requiring nokogiri
+  * Include the Selenium server jar file in the gem (Bryan Helmkamp, Ben Schwarz)
+  * Added key_down, key_up and fire_event to Selenium session (Fernando Garcia)
+  * Fix outputing README during Rails plugin install (Fernando Garcia)
+  * Strip newlines when matching label text (Miha Filej)
+  * Add simple support for accessing Webrat's matchers from RSpec by requiring
+    "webrat/rspec-rails" (David Chelimsky)
+  * Support save_and_open_page in Windows and Cygwin (Mike Gaffney)
+  * Added RadioField#checked? to indicated whether or not a radio button is checked
+    (Luke Melia)
+  * Add spec:jruby rake task for running Webrat's spec suite with JRuby
+  * Added field_by_xpath to locate a Webrat::Field using arbitrary XPath expressions
+  * Helpful error message for missing option values [#40] (Ben Mabey)
+  * Add set_hidden_field method (Noah Davis, Bryan Helmkamp)
+  * Add submit_form method for submitting a form by ID (Noah Davis, Bryan Helmkamp)
+  * Switch to using Nokogiri.parse for simple XML/XHTML autodetection [#66]
+  * Removed Webrat.root method, which seemed to be unused
+  * Added automatic starting and stopping of the Selenium server and a Mongrel Rails
+    app server when using webrat/selenium
+  * Switch to using selenium-client gem and vendor selenium-server.jar (Luke Melia)
+  * Added gemspec so the gem builds on GitHub now
+  * Deprecate old style methods (fills_in is deprecated in favor of fill_in, etc.)
+  * Improvements to the README and RDoc (Bryan Helmkamp, Mike Gaffney)
+  * Allow clicking links by id and id regexp (Mike Gaffney)
+  * Raise Webrat::DisabledFieldError when attempting to manipulate a disabled field
+  * Raise Webrat::NotFoundErrors when an element is not found
+  * Raise Webrat::PageLoadError when a failure occurs so that application exceptions
+    can be more accurately tested (Ryan Briones)
+  * Helpful error message for missing option in select box. [#40] (Ben Mabey)
+  * Extracted save_and_open page to make it usable in Selenium mode (Luke Melia)
+  * Added save_and_open_screengrab for Selenium mode (Luke Melia)
+
+* Bug fixes
+  
+  * field_labeled should disregard labels without matching fields (Kyle Hargraves)
+  * Fixed bug where Scope was creating a new DOM rather than re-using the existing DOM.
+    [#105] (Zach Dennis)
+  * Support Rails > v2.2 by using ActionController::RequestParser for param parsing [#107]
+    (Marcello Nuccio)
+  * Raise a Webrat::NotFoundError if the scope passed to #within doesn't exist [#90]
+  * Match against link _text_ which decodes character references.
+    Useful for multibyte languages like Japanese (moronatural@gmail.com)
+  * Fix params hash generation for Mechanize when Merb is not defined [#62]
+  * Expose some Webrat methods that were missing from the Webrat::Methods module
+    (Low Chin Chau)
+  * Allow mechanize session to pass through basic auth (Ryan Briones)
+  * Improvements to the Mechanize support (Jeremy Burks)
+  * Fix following fully qualified local links (Lawrence Pit)
+  * Fixed bug where Webrat would lose complex parameters (like foo[bar[baz]][])
+    in Merb due to not correctly merging Mashes. (Drew Colthorp)
+  * Extend Rails' ActionController::IntegrationTest instead of
+    ActionController::Integration::Session (Fixes using Webrat's #select method and
+    avoids usage of method_missing)
+  * Ensure that Webrat::MechanizeSession.request_page always uses an absolute
+    URL. (Graham Ashton)
+  * Strip anchor tags from URIs before passing to Rails integration session
+    (Noah Davis)
+  * Treat text and regexp when matching Selenium buttons (Ross Kaffenberger)
+  * Allow SeleniumSession's click_button to be called without an argument without
+    blowing up (Luke Melia)
+
 == 0.3.4 / 2008-12-29
 
 * 1 Minor enhancement
 
   * Fix compatibility with Nokogiri 1.1.0 on JRuby
-  
+
 * 1 Bug fix
 
   * Correct version for Nokogiri dependency in gem
-  
+
 == 0.3.3 / 2008-12-28
 
 * 1 Minor enhancement
 
   * Fix compatibility with Nokogiri 1.1.0 on MRI
-  
+
 == 0.3.2 / 2008-11-08
 
 * 1 Minor enhancement
 
-  * Fixes behavior or have_tag when a block is passed. It passes the matched node(s) to the block for further specs again. (Carl Lerche)
-  
+  * Fixes behavior or have_tag when a block is passed. It passes the matched node(s)
+    to the block for further specs again. (Carl Lerche)
+
 == 0.3.1 / 2008-11-07
 
 * 1 Minor enhancement
 
-  * Use @_webrat_session instance variable instead of @session for Merb integration to avoid collisions
+  * Use @_webrat_session instance variable instead of @session for Merb integration
+    to avoid collisions
 
 == 0.3.0 / 2008-11-07
 
-* Major enhancements
+* 4 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
+
+* 37 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 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)
@@ -51,33 +152,37 @@
   * 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)
+  * Consider response codes 200-499 as successful enough to not raise a Webrat error
+    (David Leal)
   * 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
+  * 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)
+  * 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)
+  * 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)
+  * 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
+
+* 8 Bug fixes
 
   * Fix initialization of WWW::Mechanize (Derek Kastner)
   * Don't open blank pages in the browser (Kyle Hargraves)
@@ -86,8 +191,9 @@
   * 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)
-  
+  * 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
@@ -97,31 +203,35 @@
   * 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 (Sacha Schlegel)
-  
+
 * 8 Minor enhancements
-  
+
   * 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 (Luke Melia)
+  * Added clicks_link_within(selector, link_text), allowing restricting link search
+    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)
+  * 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 [] (Kamal Fariz Mahyuddi)
+  * 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)
+  * 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 (David Chelimsky)
   * Support param hashes nested more than one level (David Chelimsky)
 
 == 0.1.0 / 2007-11-28
 
 * 1 major enhancement
+
   * Birthday!
 

data/README.rdoc

@@ -0,0 +1,85 @@
+= Webrat - Ruby Acceptance Testing for Web applications
+
+- http://gitrdoc.com/brynary/webrat
+- http://groups.google.com/group/webrat
+- http://webrat.lighthouseapp.com/
+- http://github.com/brynary/webrat
+- #webrat on Freenode
+
+== Description
+
+Webrat lets you quickly write expressive and robust acceptance tests for a Ruby
+web application. 
+
+== Features
+
+* Browser Simulator for expressive, high level acceptance testing without the
+  performance hit and browser dependency of Selenium or Watir (See Webrat::Session)
+* Use the same API for Browser Simulator and real Selenium tests using
+  Webrat::Selenium when necessary (eg. for testing AJAX interactions)
+* Supports multiple Ruby web frameworks: Rails, Merb and Sinatra
+* Supports popular test frameworks: RSpec, Cucumber, Test::Unit and Shoulda
+* Webrat::Matchers API for verifying rendered HTML using CSS, XPath, etc.
+
+== Example
+
+  class SignupTest < ActionController::IntegrationTest
+  
+    def test_trial_account_sign_up
+      visit home_path
+      click_link "Sign up"
+      fill_in "Email", :with => "good@example.com"
+      select "Free account"
+      click_button "Register"
+    end
+    
+  end
+  
+Behind the scenes, Webrat will ensure:
+
+* If a link, form field or button is missing, the test will fail.
+* If a URL is invalid, the test will fail.
+* If a page load or form submission is unsuccessful, the test will fail.
+
+== Installing Nokogiri
+
+Users of Debian Linux (e.g. Ubuntu) need to run:
+
+  sudo apt-get install libxslt1-dev libxml2-dev.
+
+Otherwise the Nokogiri gem, which Webrat depends on, won't install properly.
+
+== Install for Rails
+
+To install the latest release as a gem:
+
+  sudo gem install webrat
+  
+To install the latest code as a plugin: (_Note:_ This may be less stable than using a released version)
+
+  script/plugin install git://github.com/brynary/webrat.git
+
+In your test_helper.rb or env.rb (for Cucumber) add:
+
+  require "webrat"
+  
+  Webrat.configure do |config|
+    config.mode = :rails
+  end
+  
+== Install with Merb
+
+Merb 1.0 has built-in, seamless Webrat support. Just start using
+methods from Webrat::Session in your specs.
+
+== Authors
+
+- Maintained by {Bryan Helmkamp}[mailto:bryan@brynary.com]
+- Original code written by {Seth Fitzsimmons}[mailto:seth@mojodna.net]
+- Initial development was sponsored by EastMedia[http://www.eastmedia.com]
+- Many other contributors. See attributions in History.txt
+
+== License
+
+Copyright (c) 2007-2008 Bryan Helmkamp, Seth Fitzsimmons.
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -1,11 +1,11 @@
-require 'rubygems'
+# require 'rubygems'
 require "rake/gempackagetask"
 require 'rake/rdoctask'
 require "rake/clean"
 require 'spec'
 require 'spec/rake/spectask'
 require 'spec/rake/verify_rcov'
-require './lib/webrat.rb'
+require File.expand_path('./lib/webrat.rb')
 
 ##############################################################################
 # Package && release
@@ -21,14 +21,16 @@ spec = Gem::Specification.new do |s|
   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/**/*"]
+  s.files        = %w(History.txt install.rb MIT-LICENSE.txt README.rdoc Rakefile) + Dir["lib/**/*"] + Dir["vendor/**/*"]
 
   # rdoc
   s.has_rdoc         = true
-  s.extra_rdoc_files = %w(README.txt MIT-LICENSE.txt)
+  s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
 
   # Dependencies
   s.add_dependency "nokogiri", ">= 1.1.0"
+
+  s.rubyforge_project = "webrat"
 end
 
 Rake::GemPackageTask.new(spec) do |package|
@@ -50,13 +52,13 @@ 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']
+  t.spec_files = FileList['spec/public/**/*_spec.rb'] + FileList['spec/private/**/*_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.spec_files = FileList['spec/public/**/*_spec.rb'] + FileList['spec/private/**/*_spec.rb']
   t.rcov = true
   t.rcov_opts = lambda do
     IO.readlines(File.dirname(__FILE__) + "/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
@@ -67,23 +69,71 @@ 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}"
+  gem_filename = Dir['pkg/*.gem'].first
+  sh "sudo gem install --local #{gem_filename}"
 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
+desc "Delete generated RDoc"
+task :clobber_docs do
+  FileUtils.rm_rf("doc")
+end
+
+desc "Generate RDoc"
+task :docs => :clobber_docs do
+  system "hanna --title 'Webrat #{Webrat::VERSION} API Documentation'"
+end
+
+desc "Run specs using jruby"
+task "spec:jruby" do
+  system "jruby -S rake spec"
+end
+
+desc "Run each spec in isolation to test for dependency issues"
+task :spec_deps do
+  Dir["spec/**/*_spec.rb"].each do |test|
+    if !system("spec #{test} &> /dev/null")
+      puts "Dependency Issues: #{test}"
+    end
+  end
+end
+
+task :prepare do
+  system "ln -s ../../../../.. ./spec/integration/rails/vendor/plugins/webrat"
+end
+
+namespace :spec do
+  desc "Run the integration specs"
+  task :integration => ["integration:rails", "integration:merb", "integration:sinatra"]
+
+  namespace :integration do
+    desc "Run the Rails integration specs"
+    task :rails do
+      Dir.chdir "spec/integration/rails" do
+        result = system "rake test:integration"
+        raise "Rails integration tests failed" unless result
+      end
+    end
+
+    desc "Run the Merb integration specs"
+    task :merb do
+      Dir.chdir "spec/integration/merb" do
+        result = system "rake spec"
+        raise "Merb integration tests failed" unless result
+      end
+    end
+
+    desc "Run the Sinatra integration specs"
+    task :sinatra do
+      Dir.chdir "spec/integration/sinatra" do
+        result = system "rake test"
+        raise "Sinatra tntegration tests failed" unless result
+      end
+    end
+  end
+end
+
+task :default => :spec
+
+task :precommit => ["spec", "spec:jruby", "spec:integration"]