dbrady-tourbus 0.0.9 → 0.1.1

data/README.rdoc

@@ -7,7 +7,7 @@ Flexible and scalable website testing tool.
 * David Brady -- david.brady@leadmediapartners.com
 * Tim Harper -- tim.harper@leadmediapartners.com
 * James Britt -- james@neurogami.com
-* JTZemp -- jt.zemp@leadmediapartners.com
+* JT Zemp -- jtzemp@gmail.com
 
 
 == General Info
@@ -20,6 +20,10 @@ testing tool. The difference is that TourBus also scales concurrently,
 and you can perform hundreds of complicated regression tests
 simultaneously in order to thoroughly load test your website.
 
+It uses Webrat::Mechanize to run the browsing session, so you get the
+load testing you want, and all the sweetness of Webrat to write your
+tests in.
+
 == Motivation
 
 I started writing TourBus because I needed flexibility and scalability
@@ -41,12 +45,12 @@ better name, these are called Tours.
 * Make a folder called tours and put a file in it called simple.rb. In
   it write:
 
-  class Simple < Tour
-    def test_homepage
-      open_page "http://#{@host}/"
-      assert_page_body_contains "My Home Page"
-    end
-  end
+      class Simple < Tour
+        def test_homepage
+          visit "http://#{@host}/"
+          assert_contain "My Home Page"
+        end
+      end
 
 * Files in ./tours should have classes that match their names. E.g.
   "class BigHairyTest < Tour" belongs in ./tours/big_hairy_test.rb
@@ -79,7 +83,7 @@ of the methods in Simple three times.
 
 * You can specify multiple tours.
 
-  tourbus -c 2 -n 3 simple1 simple2 simple3
+    tourbus -c 2 -n 3 simple1 simple2 simple3
 
 * If you don't specify a tour, all tours in ./tours will be run.
 
@@ -87,7 +91,7 @@ of the methods in Simple three times.
 
 * You can run tours and filter given tests.
 
-  tourbus -c 2 -n 3 simple -t test_login,test_logout
+    tourbus -c 2 -n 3 simple -t test_login,test_logout
 
 Note that if you specify multiple tours and filter tests, the filtered
 tests will be run on all tours specified. If you do not specify a
@@ -178,7 +182,9 @@ duplications, oversights, and kludges.
 * I'd like to remove WebSickle and replace it with Webrat. There is a
   webrat branch on the main fork (http://github.com/dbrady/tourbus)
   that is 90% complete. Once that's done we can start massaging the
-  API to be a little more friendly.
+  API to be a little more friendly. [done (but now that it is, it 
+  needs a refactoring--Tour should probably inherit from 
+  Webrat::Mechanize, not delegate to it.)]
 
 == Credits
 

data/examples/contact_app/README.rdoc

@@ -75,60 +75,54 @@ particular order.
 
 Right. Let's look test_home first, because it's simpler:
 
-  def test_home
-    open_site_page "/"
-    click_link :text => /Enter Contact/
-    assert_page_uri_matches "/contacts"
-  end
+    def test_home
+      visit "/"
+      assert_contain "If you click this"
 
-+open_site_page+ is defined in Tour.rb, it opens the given path on the
+      click_link "Enter Contact"
+      assert_match /\/contacts/, current_page.url
+    end
+
++visit+ is a webrat method that you can call inside of your tours. It opens the given path on the
 host that tourbus is testing.
 
++assert_contain+ is also a webrat method that confirms the given string is on the page.
+
 +click_link+ does what you'd expect. It takes a hash that identifies
-the link to click. In this case I chose to identify the link with a
-regexp describing its text label. +click_link+ will raise an exception
+the link to click. +click_link+ will raise an exception
 if it cannot find the link to click.
 
-+assert_page_uri_matches+ will raise an exception unless the uri
-matches the given string or regexp. If I had passed in a regexp, it
-would have passed if the regexp matched. *Note:* Strings only match at
-the /end/ of the uri; simple containment is not enough. Passing
-"/contacts" works the same as passing %r{/contacts$}.
-
-Clear as mud? "/contacts" would match
-http://localhost:4567/users/42/contacts but not
-http://localhost:4567/contacts/42.
++assert_match+ comes from Test::Unit which is used internally to webrat. It will raise an exception unless the uri
+matches the given regexp.
 
+So you should be able to use any Webrat locator or matcher, and any of the Test::Unit assertions.
 
 === test_contacts
 
 Okay, let's actually submit a form.
 
-  def test_contacts
-    open_site_page "contacts"
-    submit_form(
-                :identified_by => { :action => %r{/contacts} },
-                :values => {
-                  'first_name' => "Joe",
-                  'last_name' => "Tester"
-                }
-                )
-    assert_page_uri_matches "/contacts"
-    assert_page_body_contains "Tester, Joe"
-  end
+    def test_contacts
+      visit "/contacts"
+  
+      fill_in "first_name", :with => "Joe"
+      fill_in "last_name", :with => "Tester"
+      click_button 
+  
+      assert_contain "Tester, Joe"
+    end
 
 test_contacts starts by going directly to the contacts app. Note that
-the leading "/" is optional.
+the leading "/" isn't optional.
+
++fill_in+ is a Webrat method that will look for form fields based on ids, label text, and other things. 
+It's matchers are pretty good. Check out Webrat's documentation for more info. In the examples above, 
+we're finding the fields for the first name and last name and putting in "Joe" and "Tester" respectively.
++fill_in+ asserts that the fields actually exist and will raise an exception if they don't.
 
-+submit_form+ does what its name implies. It finds the correct form to
-submit by matching the action to a regexp, then it sets the form
-values and submits the form. *Note:* Like +click_link+, +submit_form+
-contains some implicit assertions. It actually reads the form looking
-for the named inputs and will raise an exception if any are missing.
-This means you cannot use submit_form to do a blind post to a
-webserver.
++click_button+ does what its name implies. It finds the correct form to
+submit Webrat is smart like that. *Note:* Like +click_link+, +click_button+
+contains some implicit assertions and will raise an exception if the button doesn't exist.
 
-+assert_page_uri_matches+ we've already seen;
-+assert_page_body_contains+ searches the page body for the given text
-or regexp.
++assert_contain+ we've already seen.
 
+Good luck, and happy touring!

data/examples/contact_app/contact_app.rb

@@ -9,7 +9,7 @@ require 'rubygems'
 require 'sinatra'
 
 get '/' do
-  '<a href="/contacts">Enter Contact</a>'
+  %{If you click this, I'll take you to a page where you can enter your contact info: <a href="/contacts">Enter Contact</a>}
 end 
 
 get '/contacts' do
@@ -23,7 +23,7 @@ get '/contacts' do
     <form action="/contacts" method="POST">
       <p><label for="first_name"><b>First Name:</b></label> <input name="first_name" size="30"></p>
       <p><label for="last_name"><b>Last Name:</b></label> <input name="last_name" size="30"></p>
-      <input type="submit">
+      <input type="submit" value="Submit">
     </form>
   </body>
 </html>

data/examples/contact_app/tours/simple.rb

@@ -1,20 +1,19 @@
 class Simple < Tour
   def test_home
-    open_site_page "/"
-    click_link :text => /Enter Contact/
-    assert_page_uri_matches "/contacts"
+    visit "/"
+    assert_contain "If you click this"
+
+    click_link "Enter Contact"
+    assert_match /\/contacts/, current_page.url
   end
 
   def test_contacts
-    open_site_page "contacts"
-    submit_form(
-                :identified_by => { :action => %r{/contacts} },
-                :values => {
-                  'first_name' => "Joe",
-                  'last_name' => "Tester"
-                }
-                )
-    assert_page_uri_matches "/contacts"
-    assert_page_body_contains "Tester, Joe"
+    visit "/contacts"
+    
+    fill_in "first_name", :with => "Joe"
+    fill_in "last_name", :with => "Tester"
+    click_button 
+    
+    assert_contain "Tester, Joe"
   end
 end

data/examples/contact_app/tours/tourbus.yml

@@ -1,2 +1,2 @@
 ---
-host:   localhost
+host:   http://localhost:4567

data/lib/common.rb

@@ -16,7 +16,6 @@ require 'activesupport'
 
 require 'monitor'
 require 'faker'
-require 'web-sickle/init'
 require 'tour_bus'
 require 'runner'
 require 'tour'

data/lib/runner.rb

@@ -1,6 +1,9 @@
 require 'monitor'
 require 'common'
 
+# The common base class for all exceptions raised by Webrat.
+class WebratError < StandardError ; end
+
 class Runner
   attr_reader :host, :tours, :number, :runner_type, :runner_id
   
@@ -31,7 +34,7 @@ class Runner
             tests += 1
             tour.run_test test
             passes += 1
-          rescue TourBusException, WebsickleException => e
+          rescue TourBusException, WebratError => e
             log("********** FAILURE IN RUN! **********")
             log e.message
             e.backtrace.each do |trace|

data/lib/tour.rb

@@ -1,5 +1,9 @@
+require 'forwardable'
 require 'monitor'
 require 'common'
+require 'webrat'
+require 'webrat/mechanize'
+require 'test/unit/assertions'
 
 # A tour is essentially a test suite file. A Tour subclass
 # encapsulates a set of tests that can be done, and may contain helper
@@ -8,12 +12,68 @@ require 'common'
 # that area and create test_ methods for each type of test to be done.
 
 class Tour
-  include WebSickle
-  attr_reader :host, :tours, :number, :tour_type, :tour_id
-
+  extend Forwardable
+  include Webrat::Matchers
+  include Webrat::SaveAndOpenPage
+  include Test::Unit::Assertions
+  
+  attr_reader :host, :tours, :number, :tour_type, :tour_id, :webrat_session
+  
+  # delegate goodness to webrat
+  [
+  :fill_in, 
+  :fills_in, 
+  :set_hidden_field, 
+  :submit_form, 
+  :check, 
+  :checks, 
+  :uncheck, 
+  :unchecks, 
+  :choose, 
+  :chooses, 
+  :current_page,
+  :select, 
+  :selects, 
+  :select_datetime, 
+  :selects_datetime, 
+  :select_date, 
+  :selects_date, 
+  :select_time, 
+  :selects_time, 
+  :attach_file, 
+  :attaches_file, 
+  :click_area, 
+  :clicks_area, 
+  :click_link, 
+  :clicks_link, 
+  :click_button, 
+  :clicks_button, 
+  :field_labeled, 
+  :field_by_xpath, 
+  :field_with_id, 
+  :select_option, 
+  :automate, 
+  :basic_auth, 
+  :check_for_infinite_redirects, 
+  :click_link_within, 
+  :dom, 
+  :header, 
+  :http_accept, 
+  :infinite_redirect_limit_exceeded?, 
+  :internal_redirect?, 
+  :redirected_to, 
+  :reload, 
+  :response_body,
+  :simulate, 
+  :visit, 
+  :within, 
+  :xml_content_type?].each {|m| def_delegators(:webrat_session, m) }
+  
   def initialize(host, tours, number, tour_id)
     @host, @tours, @number, @tour_id = host, tours, number, tour_id
     @tour_type = self.send(:class).to_s
+    @webrat_session = Webrat::MechanizeSession.new
+    visit @host if @host
   end
   
   # before_tour runs once per tour, before any tests get run
@@ -28,6 +88,10 @@ class Tour
   def teardown
   end
   
+  def wait(time)
+    sleep time.to_i
+  end
+  
   # Lists tours in tours folder. If a string is given, filters the
   # list by that string. If an array of filter strings is given,
   # returns items that match ANY filter string in the array.
@@ -68,77 +132,16 @@ class Tour
     send @test
     teardown
   end
-    
+  
   protected
-
-  def log(message)
-    puts "#{Time.now.strftime('%F %H:%M:%S')} Tour ##{@tour_id}: (#{@test}) #{message}"
-  end
-
-  # given "portal", opens "http://#{@host}/portal". Leading slash is
-  # optional. "/portal" and "portal" are the same.
-  def open_site_page(path)
-    path = path.sub %r{^/}, ""
-    open_page "http://#{@host}/#{path}"
-  end
   
-  def dump_form
-    log "Dumping Forms:"
-    page.forms.each do |form|
-      puts "Form: #{form.name}"
-      puts '-' * 20
-      (form.fields + form.radiobuttons + form.checkboxes + form.file_uploads).each do |field|
-        puts "  #{field.name}"
-      end
-    end
+  def session
+    @session ||= Webrat::MechanizeSession.new
   end
   
-  # True if uri ends with the string given. If a regex is given, it is
-  # matched instead.
-  # 
-  # TODO: Refactor me--these were separated out back when Websickle
-  # was a shared submodule and we couldn't pollute it. Now that it's
-  # frozen these probably belong there.
-  def assert_page_uri_matches(uri)
-    case uri
-    when String:
-        raise WebsickleException, "Expected page uri to match String '#{uri}' but did not. It was #{page.uri}" unless page.uri.to_s[-uri.size..-1] == uri
-    when Regexp:
-        raise WebsickleException, "Expected page uri to match Regexp '#{uri}' but did not. It was #{page.uri}" unless page.uri.to_s =~ uri
-    end
-    log "Page URI ok (#{page.uri} matches: #{uri})"
+  def log(message)
+    puts "#{Time.now.strftime('%F %H:%M:%S')} Tour ##{@tour_id}: (#{@test}) #{message}"
   end
   
-  # True if page contains (or matches) the given string (or regexp)
-  # 
-  # TODO: Refactor me--these were separated out back when Websickle
-  # was a shared submodule and we couldn't pollute it. Now that it's
-  # frozen these probably belong there.
-  def assert_page_body_contains(pattern)
-    case pattern
-    when String:
-        raise WebsickleException, "Expected page body to contain String '#{pattern}' but did not. It was #{page.body}" unless page.body.to_s.index(pattern)
-    when Regexp:
-        raise WebsickleException, "Expected page body to match Regexp '#{pattern}' but did not. It was #{page.body}" unless page.body.to_s =~ pattern
-    end
-    log "Page body ok (matches #{pattern})"
-  end
-
-
-
-  # True if page does not contain (or match) the given string (or regexp)
-  # 
-  # TODO: Refactor me--these were separated out back when Websickle
-  # was a shared submodule and we couldn't pollute it. Now that it's
-  # frozen these probably belong there.
-  def assert_page_body_does_not_contain(pattern)
-    case pattern
-    when String:
-        raise WebsickleException, "Expected page body to not contain String '#{pattern}' but it did. It was #{page.body}" if page.body.to_s.index(pattern)
-    when Regexp:
-        raise WebsickleException, "Expected page body to not match Regexp '#{pattern}' but it did. It was #{page.body}" if  page.body.to_s =~ pattern
-    end
-    log "Page body ok (does not match #{pattern})"
-  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dbrady-tourbus
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
+  version: 0.1.1
 platform: ruby
 authors: 
 - David Brady
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -07:00
+date: 2009-07-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: webrat
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: TourBus, a web stress-testing tool that combines complex 'tour' definitions with scalable concurrent testing
 email: github@shinybit.com
 executables: 
@@ -76,21 +86,11 @@ files:
 - lib/tour.rb
 - lib/tour_bus.rb
 - lib/tour_watch.rb
-- lib/web-sickle/init.rb
-- lib/web-sickle/lib/assertions.rb
-- lib/web-sickle/lib/hash_proxy.rb
-- lib/web-sickle/lib/helpers/asp_net.rb
-- lib/web-sickle/lib/helpers/table_reader.rb
-- lib/web-sickle/lib/make_nokigiri_output_useful.rb
-- lib/web-sickle/lib/web_sickle.rb
-- lib/web-sickle/spec/lib/helpers/table_reader_spec.rb
-- lib/web-sickle/spec/spec_helper.rb
-- lib/web-sickle/spec/spec_helpers/mechanize_mock_helper.rb
-- lib/web-sickle/spec/web_sickle_spec.rb
 - README.rdoc
 - MIT-LICENSE
 has_rdoc: true
 homepage: http://github.com/dbrady/tourbus/
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: TourBus web stress-testing tool

data/lib/web-sickle/init.rb

@@ -1,17 +0,0 @@
-require 'rubygems'
-gem 'mechanize', ">= 0.7.6"
-gem "hpricot", ">= 0.6"
-$: << File.join(File.dirname(__FILE__), 'lib')
-
-require 'hpricot'
-require 'mechanize'
-
-WWW::Mechanize.html_parser = Hpricot
-
-require 'web_sickle'
-require "assertions"
-require "hash_proxy"
-require "helpers/asp_net"
-require "helpers/table_reader"
-
-Hpricot.buffer_size = 524288

data/lib/web-sickle/lib/assertions.rb

@@ -1,51 +0,0 @@
-class WebSickleAssertionException < Exception; end
-
-module WebSickle::Assertions
-  def assert_equals(expected, actual, message = nil)
-    unless(expected == actual)
-      report_error <<-EOF
-Error: Expected 
-#{expected.inspect}, but got
-#{actual.inspect}
-#{message}
-EOF
-    end
-  end
-
-  def assert_select(selector, message)
-    assert_select_in(@page, selector, message)
-  end
-
-  def assert_no_select(selector, message)
-    assert_no_select_in(@page, selector, message)
-  end
-
-  def assert_select_in(content, selector, message)
-    report_error("Error: Expected selector #{selector.inspect} to find a page element, but didn't. #{message}") if (content / selector).blank?
-  end
-
-  def assert_no_select_in(content, selector, message)
-    report_error("Error: Expected selector #{selector.inspect} to not find a page element, but did. #{message}") unless (content / selector).blank?
-  end
-
-  def assert_contains(left, right, message = nil)
-    (right.is_a?(Array) ? right : [right]).each do | item |
-      report_error("Error: Expected #{left.inspect} to contain #{right.inspect}, but didn't. #{message}") unless left.include?(item)
-    end
-  end
-
-  def assert(passes, message = nil)
-    report_error("Error: expected true, got false.  #{message}") unless passes
-  end
-
-  def assert_link_text(link, text)
-    case text
-    when String
-      assert_equals(link.text, text)
-    when Regexp
-      assert(link.text.match(text))
-    else
-      raise ArgumentError, "Don't know how to assert an object like #{text.inspect} - expected: Regexp or String"
-    end
-  end
-end

data/lib/web-sickle/lib/hash_proxy.rb

@@ -1,9 +0,0 @@
-class HashProxy
-  def initialize(options = {})
-    @set = options[:set]
-    @get = options[:get]
-  end
-
-  def [](key); @get && @get.call(key); end
-  def []=(key, value); @set && @set.call(key, value); end
-end

data/lib/web-sickle/lib/helpers/asp_net.rb

@@ -1,16 +0,0 @@
-module WebSickle::Helpers
-module AspNet
-  def asp_net_do_postback(options)
-    target_element = case
-      when options[:button]
-        find_button(options[:button])
-      when options[:field]
-        find_field(options[:field])
-      else
-        nil
-      end
-    @form.fields << WWW::Mechanize::Form::Field.new("__EVENTTARGET", target_element ? target_element.name : "") if target_element
-    submit_form_button
-  end
-end
-end

data/lib/web-sickle/lib/helpers/table_reader.rb

@@ -1,39 +0,0 @@
-module WebSickle::Helpers
-class TableReader
-  attr_reader :headers, :options, :body_rows, :header_row, :extra_rows
-  
-  def initialize(element, p_options = {})
-    @options = {
-      :row_selectors => [" > tr", "thead > tr", "tbody > tr"],
-      :header_selector => " > th",
-      :header_proc => lambda { |th| th.inner_text.gsub(/[\n\s]+/, ' ').strip },
-      :body_selector => " > td",
-      :body_proc => lambda { |header, td| td.inner_text.strip },
-      :header_offset => 0,
-      :body_offset => 1
-    }.merge(p_options)
-    @options[:body_range] ||= options[:body_offset]..-1
-    raw_rows = options[:row_selectors].map{|row_selector| element / row_selector}.compact.flatten
-    
-    @header_row = raw_rows[options[:header_offset]]
-    @body_rows = raw_rows[options[:body_range]]
-    @extra_rows = (options[:body_range].last+1)==0 ? [] : raw_rows[(options[:body_range].last+1)..-1]
-    
-    @headers = (@header_row / options[:header_selector]).map(&options[:header_proc])
-  end
-  
-  def rows
-    @rows ||= @body_rows.map do |row|
-      hash = {}
-      data_array = (headers).zip(row / options[:body_selector]).each do |column_name, td|
-        hash[column_name] = options[:body_proc].call(column_name, td)
-      end
-      hash
-    end
-  end
-  
-  def array_to_hash(data, column_names)
-    column_names.inject({}) {|h,column_name| h[column_name] = data[column_names.index(column_name)]; h }
-  end
-end
-end

data/lib/web-sickle/lib/make_nokigiri_output_useful.rb

@@ -1,15 +0,0 @@
-# Nokogiri::XML::Element.class_eval do
-#   def inspect(indent = "")
-#     breaker = "\n#{indent}"
-#     if children.length == 0
-#       %(#{indent}<#{name}#{breaker}  #{attributes.map {|k,v| k + '=' + v.inspect} * "#{breaker}  "}/>)
-#     else
-#       %(#{indent}<#{name} #{attributes.map {|k,v| k + '=' + v.inspect} * " "}>\n#{children.map {|c| c.inspect(indent + '  ') rescue c.class} * "\n"}#{breaker}</#{name}>)
-#     end
-#   end
-# end
-# Nokogiri::XML::Text.class_eval do
-#   def inspect(indent = "")
-#     "#{indent}#{text.inspect}"
-#   end
-# end

data/lib/web-sickle/lib/web_sickle.rb

@@ -1,227 +0,0 @@
-class WebsickleException < Exception; end
-
-module WebSickle
-  # form_value is used to interface with the current select form
-  attr_reader :form_value
-  attr_accessor :page
-  
-  def initialize(options = {})
-    @page = nil
-    @form_value = HashProxy.new(
-      :set => lambda { |identifier, value| set_form_value(identifier, value)}, 
-      :get => lambda { |identifier| get_form_value(identifier)}
-    )
-  end
-  
-  def click_link(link)
-    set_page(agent.click(find_link(link)))
-  end
-  
-  def submit_form(options = {})
-    options[:button] = :first unless options.has_key?(:button)
-    options[:identified_by] ||= :first
-    select_form(options[:identified_by])
-    set_form_values(options[:values]) if options[:values]
-    submit_form_button(options[:button])
-  end
-
-  # select the current form
-  def select_form(identifier = {})
-    identifier = make_identifier(identifier, [:name, :action, :method])
-    @form = find_in_collection(@page.forms, identifier)
-    unless @form
-      valid_forms = @page.forms.map {|f| "name: #{f.name}, method: #{f.method}, action: #{f.action}"} * "\n"
-      report_error("Couldn't find form on page at #{@page.uri} with attributes #{identifier.inspect}. Valid forms on this page are: \n#{valid_forms}")
-    end
-    @form
-  end
-  
-  # submits the current form
-  def submit_form_button(button_criteria = nil, options = {})
-    button = 
-      case button_criteria
-      when nil
-        nil
-      else
-        find_button(button_criteria)
-      end
-    set_page(agent.submit(@form, button))
-  end
-
-  # sets the given path to the current page, then opens it using our agent
-  def open_page(path, parameters = [], referer = nil)
-    set_page(agent.get(path, parameters, referer))
-  end
-
-  # uses Hpricot style css selectors to find the elements in the current +page+.
-  # Uses Hpricot#/ (or Hpricot#search)
-  def select_element(match)
-    select_element_in(@page, match)
-  end
-  
-  # uses Hpricot style css selectors to find the element in the given container.  Works with html pages, and file pages that happen to have xml-like content.
-  # throws error if can't find a match
-  def select_element_in(contents, match)
-    result = (contents.respond_to?(:/) ? contents : Hpricot(contents.body)) / match
-    if result.blank?
-      report_error("Tried to find element matching #{match}, but couldn't")
-    else
-      result
-    end
-  end
-
-  # uses Hpricot style css selectors to find the element.  Works with html pages, and file pages that happen to have xml-like content.
-  # throws error if can't find a match
-  # Uses Hpricot#at
-  def detect_element(match)
-    result = (@page.respond_to?(:at) ? @page : Hpricot(@page.body)).at(match)
-    if result.blank?
-      report_error("Tried to find element matching #{match}, but couldn't")
-    else
-      result
-    end
-  end
-  
-  protected
-    # our friendly mechinze agent
-    def agent
-      @agent ||= new_mechanize_agent
-    end
-    
-    def make_identifier(identifier, valid_keys = nil, default_key = :name)
-      identifier = {default_key => identifier} unless identifier.is_a?(Hash) || identifier.is_a?(Symbol)
-      identifier.assert_valid_keys(valid_keys) if identifier.is_a?(Hash) && valid_keys
-      identifier
-    end
-  
-    def find_field(identifier)
-      if @form.nil?
-        report_error("No form is selected when trying to find field by #{identifier.inspect}")
-        return
-      end
-      identifier = make_identifier(identifier, [:name, :value])
-      find_in_collection(@form.radiobuttons + @form.fields + @form.checkboxes + @form.file_uploads, identifier) ||
-        report_error("Tried to find field identified by #{identifier.inspect}, but failed.\nForm fields are: #{(@form.radiobuttons + @form.fields + @form.checkboxes + @form.file_uploads).map{|f| f.name} * ", \n  "}") 
-    end
-    
-    def find_link(identifier)
-      identifier = make_identifier(identifier, [:href, :text], :text)
-      find_in_collection(page.links, identifier) ||
-        report_error("Tried to find link identified by #{identifier.inspect}, but failed.\nValid links are: #{page.links.map{|f| f.inspect} * ", \n  "}")
-    end
-  
-    # finds a button by parameters.  Throws error if not able to find.
-    # example:
-    # find_button("btnSubmit") - finds a button named "btnSubmit"
-    # find_button(:name => "btnSubmit")
-    # find_button(:name => "btnSubmit", :value => /Lucky/) - finds a button named btnSubmit with a value matching /Lucky/
-    def find_button(identifier)
-      identifier = make_identifier(identifier, [:value, :name])
-      find_in_collection(@form.buttons, identifier) ||
-        report_error("Tried to find button identified by #{identifier.inspect}, but failed.  Buttons on selected form are: #{@form.buttons.map{|f| f.name} * ','}")
-    end
-  
-    # the magic method that powers find_button, find_field.  Does not throw an error if not found
-    def find_in_collection(collection, identifier, via = :find)
-      return collection.first if identifier == :first
-      find_all_in_collection(collection, identifier, :find)
-    end
-    
-    def find_all_in_collection(collection, identifier, via = :select)
-      return [collection.first] if identifier == :first
-      collection.send(via) do |item|
-        identifier.all? { |k, criteria| is_a_match?(criteria, item.send(k)) }
-      end
-    end
-
-    # sets a form-field's value by identifier.  Throw's error if field does not exist
-    def set_form_value(identifier, value)
-      field = find_field(identifier)
-      case field
-      when WWW::Mechanize::Form::CheckBox
-        field.checked = value
-      when WWW::Mechanize::Form::RadioButton
-        radio_collection = find_all_in_collection(@form.radiobuttons, :name => field.name)
-        radio_collection.each { |f|; f.checked = false }
-        finder = (value.is_a?(Hash) || value.is_a?(Symbol)) ? value : {:value => value}
-        find_in_collection(radio_collection, finder).checked = true
-      when WWW::Mechanize::Form::SelectList
-        if value.is_a?(Hash) || value.is_a?(Symbol)
-          field.value = find_in_collection(field.options, value).value
-        else
-          field.value = value
-        end
-      else
-        field.value = value
-      end
-    end
-  
-    def set_form_values(set_pairs = {})
-      flattened_value_hash(set_pairs).each do |identifier, value|
-        set_form_value(identifier, value)
-      end
-    end
-    
-    def flattened_value_hash(hash, parents = [])
-      new_hash = {}
-      hash.each do |key, value|
-        if value.is_a?(Hash) && value.keys.first.is_a?(String)
-          new_hash.update(flattened_value_hash(value, [key] + parents))
-        else
-          parents.each { |parent| key = "#{parent}[#{key}]"}
-          new_hash[key] = value
-        end
-      end
-      new_hash
-    end
-
-    # sets a form-field's value by identifier.  Throw's error if field does not exist
-    def get_form_value(identifier)
-      field = find_field(identifier)
-      case field
-      when WWW::Mechanize::Form::CheckBox
-        field.checked
-      else
-        field.value
-      end
-    end
-    
-    def format_error(msg)
-      error = "Error encountered: #{msg}."
-      begin
-        error << "\n\nPage URL:#{@page.uri.to_s}" if @page
-      rescue
-      end
-      error
-    end
-
-    def report_error(msg)
-      raise WebsickleException, format_error(msg)
-      nil
-    end
-    
-  private
-    def set_page(p)
-      @form = nil
-      @page = p
-    end
-
-    def is_a_match?(criteria, value)
-      case criteria
-      when Regexp
-        criteria.match(value)
-      when String
-        criteria == value
-      when Array
-        criteria.include?(value)
-      else
-        criteria.to_s == value.to_s
-      end
-    end
-  
-    def new_mechanize_agent
-      a = WWW::Mechanize.new
-      a.read_timeout = 600 # 10 minutes
-      a
-    end
-end

data/lib/web-sickle/spec/lib/helpers/table_reader_spec.rb

@@ -1,137 +0,0 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-
-describe WebSickle::Helpers::TableReader do
-  describe "Simple example" do
-    before(:each) do
-      @content = <<-EOF
-        <table>
-          <tr>
-            <th>Name</th>
-            <th>Age</th>
-          </tr>
-          <tr>
-            <td>Googly</td>
-            <td>2</td>
-          </tr>
-        </table>    
-      EOF
-      h = Hpricot(@content)
-      @table = WebSickle::Helpers::TableReader.new(h / "table")
-    end
-  
-    it "should extract headers" do
-      @table.headers.should == ["Name", "Age"]
-    end
-  
-    it "should extract rows" do
-      @table.rows.should == [
-        {"Name" => "Googly", "Age" => "2"}
-      ]
-    end
-  end
-  
-  
-  
-  describe "Targetted example" do
-    before(:each) do
-      @content = <<-EOF
-        <table>
-          <thead>
-            <tr>
-              <td colspan='2'>----</td>
-            </tr>
-            <tr>
-              <th><b>Name</b></th>
-              <th><b>Age</b></th>
-            </tr>
-          </thead>
-          <tbody>  
-            <tr>
-              <td>Googly</td>
-              <td>2</td>
-            </tr>
-            <tr>
-              <td>Bear</td>
-              <td>3</td>
-            </tr>
-            <tr>
-              <td colspan='2'>Totals!</td>
-            </tr>
-            <tr>
-              <td>---</td>
-              <td>5</td>
-            </tr>
-          </tbody>
-        </table>    
-      EOF
-      h = Hpricot(@content)
-      @table = WebSickle::Helpers::TableReader.new(h / " > table",
-        :header_selector => " > th > b",
-        :header_offset => 1,
-        :body_range => 2..-3
-      )
-    end
-    
-    it "should extract the column headers" do
-      @table.headers.should == ["Name", "Age"]
-    end
-    
-    it "should extract the row data for the specified range" do
-      @table.rows.should == [
-        {"Name" => "Googly", "Age" => "2"},
-        {"Name" => "Bear", "Age" => "3"},
-      ]
-    end
-    
-    it "should allow you to check extra rows to assert you didn't chop off too much" do
-      (@table.extra_rows.first / "td").inner_text.should == "Totals!"
-    end
-  end
-  
-  
-  
-  describe "when using procs to extract data" do
-    before(:each) do
-      @content = <<-EOF
-        <table>
-          <tr>
-            <th>Name</th>
-            <th>Age</th>
-          </tr>
-          <tr>
-            <td>Googly</td>
-            <td>2</td>
-          </tr>
-          <tr>
-            <td>Bear</td>
-            <td>3</td>
-          </tr>
-        </table>    
-      EOF
-      h = Hpricot(@content)
-      @table = WebSickle::Helpers::TableReader.new(h / " > table",
-        :header_proc => lambda {|th| th.inner_text.downcase.to_sym},
-        :body_proc => lambda {|col_name, td| 
-          value = td.inner_text
-          case col_name
-          when :name
-            value.upcase
-          when :age
-            value.to_i
-          end
-        }
-      )
-    end
-    
-    it "should use the header proc to extract column headers" do
-      @table.headers.should == [:name, :age]
-    end
-    
-    it "should use the body proc to format the data" do
-      @table.rows.should == [
-        {:name => "GOOGLY", :age => 2},
-        {:name => "BEAR", :age => 3}
-      ]
-    end
-  end
-end

data/lib/web-sickle/spec/spec_helper.rb

@@ -1,7 +0,0 @@
-require File.dirname(__FILE__) + '/../init.rb'
-require 'rubygems'
-require 'hpricot'
-require 'test/unit'
-require 'spec'
-require 'active_support'
-require File.dirname(__FILE__) + '/spec_helpers/mechanize_mock_helper.rb'

data/lib/web-sickle/spec/spec_helpers/mechanize_mock_helper.rb

@@ -1,12 +0,0 @@
-module MechanizeMockHelper
-  def fixture_file(filename)
-    File.read("#{File.dirname(__FILE__)}/../fixtures/#{filename}")
-  end
-  
-  def mechanize_page(path_to_data, options = {})
-    options[:uri] ||= URI.parse("http://url.com/#{path_to_data}")
-    options[:response] ||= {'content-type' => 'text/html'}
-  
-    WWW::Mechanize::Page.new(options[:uri], options[:response], fixture_file("/#{path_to_data}"))
-  end
-end

data/lib/web-sickle/spec/web_sickle_spec.rb

@@ -1,50 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-class WebSickleHelper
-  include WebSickle
-end
-
-describe WebSickle do
-  include MechanizeMockHelper
-  
-  before(:all) do
-    WebSickleHelper.protected_instance_methods.each do |method|
-      WebSickleHelper.send(:public, method)
-    end
-  end
-  
-  before(:each) do
-    @helper = WebSickleHelper.new
-  end
-  
-  it "should flatten a value hash" do
-    @helper.flattened_value_hash("contact" => {"first_name" => "bob"}).should == {"contact[first_name]" => "bob"}
-  end
-  
-  describe "clicking links" do
-    before(:each) do
-      @helper.stub!(:page).and_return(mechanize_page("linkies.html"))
-    end
-    
-    it "should click a link by matching the link text" do
-      @helper.agent.should_receive(:click) do |link|
-        link.text.should include("one")
-      end
-      @helper.click_link(:text => /one/)
-    end
-    
-    it "should click a link by matching the link href" do
-      @helper.agent.should_receive(:click) do |link|
-        link.href.should include("/two")
-      end
-      @helper.click_link(:href => %r{/two})
-    end
-    
-    it "should default matching the link text" do
-      @helper.agent.should_receive(:click) do |link|
-        link.text.should include("Link number one")
-      end
-      @helper.click_link("Link number one")
-    end
-  end
-end