mechanical-cuke 0.4.3 → 0.5.0

data/README.textile

@@ -2,18 +2,25 @@ h1. Mechanical Cuke
 
 mechanical-cuke re-implements the Cucumber step definitions provided by cucumber-rails' web_steps.rb in Mechanize.  This allows Cucumber features to be written for any site by running the tests over HTTP.
 
+mechanical-cuke also provides a driver for Capybara with enough support to run the cucumber-rails web_steps.rb.  This allows you use Mechanize in conjunction with Capybara other drivers (handy if you need to do some Javascript testing).
+
 h2. Rational
 
 Webrat and Capybara both can drive tests over HTML.  However, Webrat's Mechanize support is limited (doesn't work with multipart forms, can't submit empty form fields, no support for basic auth).  Capybara drives tests over HTTP using browsers, excellent for testing Javascript, but slow for test that only involve HTML.
 
 h2. Usage
 
-Add:
+To use the standalone version of Mechanical Cuke add:
 
-  require 'mechanical-cuke'
+bc. require 'mechanical-cuke'
 
 to features/support/env.rb
 
+To use Mechanical Cuke with Capybara add:
+
+bc. require 'mechanical-cuke/capybara'
+Capybara.default_driver = :mechanical_cuke
+
 In features/support/paths.rb you will need to make sure you are returning the full URL.  The simplest way to do this is to add 'URL' + before the case statement in the path_to function e.g.:
 
 bc. def path_to(page_name)
@@ -25,7 +32,7 @@ bc. def path_to(page_name)
    'http://localhost:3000' +
     case page_name
 
-h2. Steps Provided
+h2. Steps Provided by the Standalone Version
 
 bc. Given am on path
 When I go to path
@@ -116,6 +123,8 @@ bc. When I press "Submit" within "#login_form"
 
 Make Rspec support actually work.
 
+Make Capybara driver complete.
+
 h2. Author
 
 Spike Ilacqua

data/Rakefile

@@ -17,6 +17,7 @@ begin
     gem.add_development_dependency "cucumber-rails", ">= 0.2.4"
     gem.add_development_dependency "mocha", ">= 0.9.8"
     gem.add_development_dependency "sinatra", ">= 1.0"
+    gem.add_development_dependency "capybara", "0.3.9"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -54,6 +55,15 @@ begin
   Cucumber::Rake::Task.new(:wip, 'Run features that are in progress') do |t| 
     t.cucumber_opts = "--tags @wip:3 --wip features"
   end
+
+  Cucumber::Rake::Task.new(:capybara, 'Run features against Capybara') do |t| 
+    t.cucumber_opts = "CAPYBARA=yes"
+  end
+
+  Cucumber::Rake::Task.new('capybara:wip', 'Run features @wip against Capybara') do |t| 
+    t.cucumber_opts = "CAPYBARA=yes --tags @wip:3 --wip features"
+  end
+
 rescue LoadError
   task :cucumber do
     abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.5.0

data/features/step_definitions/basic_auth_steps.rb

@@ -3,7 +3,13 @@ Given /^I have no basic auth credentials$/ do
 end
 
 Then /^I should not be able to access (.+)$/ do |page_name|
-  assert_raise(Mechanize::ResponseCodeError) { get path_to(page_name) }   
+  assert_raise(Mechanize::ResponseCodeError) do
+    if respond_to? :visit
+      visit path_to(page_name)
+    else
+      get path_to(page_name)
+    end
+  end
 end
 
 Given /^I have basic auth credentials "([^\"]*)"$/ do |credentials|

data/features/step_definitions/capybara-web_steps.rb

@@ -0,0 +1,213 @@
+if ENV['CAPYBARA']
+
+  module WithinHelpers
+    def with_scope(locator)
+      locator ? within(locator) { yield } : yield
+    end
+  end
+  World(WithinHelpers)
+
+  Given /^(?:|I )am on (.+)$/ do |page_name|
+    visit path_to(page_name)
+  end
+
+  When /^(?:|I )go to (.+)$/ do |page_name|
+    visit path_to(page_name)
+  end
+
+  When /^(?:|I )press "([^"]*)"(?: within "([^"]*)")?$/ do |button, selector|
+    with_scope(selector) do
+      click_button(button)
+    end
+  end
+
+  When /^(?:|I )follow "([^\"]*)"(?: within "([^\"]*)")?$/ do |link, selector|
+    with_scope(selector) do
+      click_link(link)
+    end
+  end
+
+  When /^(?:|I )fill in "([^\"]*)" with "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, value, selector|
+    with_scope(selector) do
+      fill_in(field, :with => value)
+    end
+  end
+
+  When /^(?:|I )fill in "([^\"]*)" for "([^\"]*)"(?: within "([^\"]*)")?$/ do |value, field, selector|
+    with_scope(selector) do
+      fill_in(field, :with => value)
+    end
+  end
+
+  # Use this to fill in an entire form with data from a table. Example:
+  #
+  #   When I fill in the following:
+  #     | Account Number | 5002       |
+  #     | Expiry date    | 2009-11-01 |
+  #     | Note           | Nice guy   |
+  #     | Wants Email?   |            |
+  #
+  # TODO: Add support for checkbox, select og option
+  # based on naming conventions.
+  #
+  When /^(?:|I )fill in the following(?: within "([^\"]*)")?:$/ do |selector, fields|
+    with_scope(selector) do
+      fields.rows_hash.each do |name, value|
+        When %{I fill in "#{name}" with "#{value}"}
+      end
+    end
+  end
+
+  When /^(?:|I )select "([^\"]*)" from "([^\"]*)"(?: within "([^\"]*)")?$/ do |value, field, selector|
+    with_scope(selector) do
+      select(value, :from => field)
+    end
+  end
+
+  When /^(?:|I )check "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+    with_scope(selector) do
+      check(field)
+    end
+  end
+
+  When /^(?:|I )uncheck "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+    with_scope(selector) do
+      uncheck(field)
+    end
+  end
+
+  When /^(?:|I )choose "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+    with_scope(selector) do
+      choose(field)
+    end
+  end
+
+  When /^(?:|I )attach the file "([^\"]*)" to "([^\"]*)"(?: within "([^\"]*)")?$/ do |path, field, selector|
+    with_scope(selector) do
+      attach_file(field, path)
+    end
+  end
+
+  Then /^(?:|I )should see JSON:$/ do |expected_json|
+    require 'json'
+    expected = JSON.pretty_generate(JSON.parse(expected_json))
+    actual   = JSON.pretty_generate(JSON.parse(response.body))
+    expected.should == actual
+  end
+
+  Then /^(?:|I )should see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, selector|
+    with_scope(selector) do
+      if page.respond_to? :should
+        page.should have_content(text)
+      else
+        assert page.has_content?(text)
+      end
+    end
+  end
+
+  Then /^(?:|I )should see \/([^\/]*)\/(?: within "([^\"]*)")?$/ do |regexp, selector|
+    regexp = Regexp.new(regexp)
+    with_scope(selector) do
+      if page.respond_to? :should
+        page.should have_xpath('//*', :text => regexp)
+      else
+        assert page.has_xpath?('//*', :text => regexp)
+      end
+    end
+  end
+
+  Then /^(?:|I )should not see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, selector|
+    with_scope(selector) do
+      if page.respond_to? :should
+        page.should have_no_content(text)
+      else
+        assert page.has_no_content?(text)
+      end
+    end
+  end
+
+  Then /^(?:|I )should not see \/([^\/]*)\/(?: within "([^\"]*)")?$/ do |regexp, selector|
+    regexp = Regexp.new(regexp)
+    with_scope(selector) do
+      if page.respond_to? :should
+        page.should have_no_xpath('//*', :text => regexp)
+      else
+        assert page.has_no_xpath?('//*', :text => regexp)
+      end
+    end
+  end
+
+  Then /^the "([^\"]*)" field(?: within "([^\"]*)")? should contain "([^\"]*)"$/ do |field, selector, value|
+    with_scope(selector) do
+      field = find_field(field)
+      field_value = (field.tag_name == 'textarea') ? field.text : field.value
+      if field_value.respond_to? :should
+        field_value.should =~ /#{value}/
+      else
+        assert_match(/#{value}/, field_value)
+      end
+    end
+  end
+
+  Then /^the "([^\"]*)" field(?: within "([^\"]*)")? should not contain "([^\"]*)"$/ do |field, selector, value|
+    with_scope(selector) do
+      field = find_field(field)
+      field_value = (field.tag_name == 'textarea') ? field.text : field.value
+      if field_value.respond_to? :should_not
+        field_value.should_not =~ /#{value}/
+      else
+        assert_no_match(/#{value}/, field_value)
+      end
+    end
+  end
+
+  Then /^the "([^\"]*)" checkbox(?: within "([^\"]*)")? should be checked$/ do |label, selector|
+    with_scope(selector) do
+      field_checked = find_field(label)['checked']
+      if field_checked.respond_to? :should
+        field_checked.should be_true
+      else
+        assert field_checked
+      end
+    end
+  end
+
+  Then /^the "([^\"]*)" checkbox(?: within "([^\"]*)")? should not be checked$/ do |label, selector|
+    with_scope(selector) do
+      field_checked = find_field(label)['checked']
+      if field_checked.respond_to? :should
+        field_checked.should be_false
+      else
+        assert !field_checked
+      end
+    end
+  end
+  
+  Then /^(?:|I )should be on (.+)$/ do |page_name|
+    # current_path = URI.parse(current_url).path # FIX ME
+    current_path = current_url
+    if current_path.respond_to? :should
+      current_path.should == path_to(page_name)
+    else
+      assert_equal path_to(page_name), current_path
+    end
+  end
+
+  Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+    query = URI.parse(current_url).query
+    actual_params = query ? CGI.parse(query) : {}
+    expected_params = {}
+    expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')} 
+    
+    if actual_params.respond_to? :should
+      actual_params.should == expected_params
+    else
+      assert_equal expected_params, actual_params
+    end
+  end
+
+  Then /^show me the page$/ do
+    save_and_open_page
+  end
+
+end

data/features/step_definitions/missing_field_steps.rb

@@ -1,24 +1,26 @@
+require 'capybara'
+
 When /^I (?:fill in|select|choose|check|press) a nonexistent (.+) an error should be raised$/ do |type|
 
   case type
   when "text field" then
-    assert_raise(RuntimeError) do
+    assert_raise(RuntimeError,Capybara::ElementNotFound) do
       When %{I fill in "nonexistent" with "anything"}
     end
   when "select field" then
-    assert_raise(RuntimeError) do
+    assert_raise(RuntimeError,Capybara::ElementNotFound) do
       When %{I select "anything" from "nonexistent"}
     end
   when "radio button" then
-    assert_raise(RuntimeError) do
+    assert_raise(RuntimeError,Capybara::ElementNotFound) do
       When %{I choose "nonexistent"}
     end
   when "checkbox" then
-    assert_raise(RuntimeError) do
+    assert_raise(RuntimeError,Capybara::ElementNotFound) do
       When %{I check "nonexistent"}
     end
   when "button" then
-    assert_raise(RuntimeError) do
+    assert_raise(RuntimeError,Capybara::ElementNotFound) do
       When %{I press "nonexistent"}
     end
   else assert false
@@ -26,33 +28,33 @@ When /^I (?:fill in|select|choose|check|press) a nonexistent (.+) an error shoul
 end
 
 When /^I follow a nonexistent link an error should be raised$/ do 
-  assert_raise(RuntimeError) do
+  assert_raise(RuntimeError,Capybara::ElementNotFound) do
     When %{I follow "nonexistent"}
   end
 end
 
 When /^I select a missing option from an existing select an error should be raised$/ do
-  assert_raise(RuntimeError) do
+  assert_raise(RuntimeError,Capybara::OptionNotFound) do
     When %{I select "nonexistent" from "Exists"}
   end
 end
 
 When /^I test the value of a nonexistent field contains an error should be raised$/ do
-  assert_raise(RuntimeError) do
+  assert_raise(RuntimeError,NoMethodError) do
     When %{the "nonexistent" field should contain "Anything"}
   end
 
-  assert_raise(RuntimeError) do
+  assert_raise(RuntimeError,NoMethodError) do
     When %{the "nonexistent" field should not contain "Anything"}
   end
 end
 
 When /^I test state of a nonexistent checkbox contains an error should be raised$/ do
-  assert_raise(RuntimeError) do
+  assert_raise(RuntimeError,NoMethodError) do
     When %{the "nonexistent" checkbox should be checked}
   end
 
-  assert_raise(RuntimeError) do
+  assert_raise(RuntimeError,NoMethodError) do
     When %{the "nonexistent" checkbox should not be checked}
   end
 end

data/features/support/env.rb

@@ -1,11 +1,17 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'open4'
 
-require 'mechanical-cuke'
+if ENV['CAPYBARA']
+  require 'capybara/cucumber'
+  require 'mechanical-cuke/capybara'
+  Capybara.default_driver = :mechanical_cuke
+  Capybara.save_and_open_page_path = File.dirname(__FILE__) + '/../../tmp'
+else
+  require 'mechanical-cuke'
+end
 
 require 'test/unit/assertions'
 
-require 'open4'
-
 World(Test::Unit::Assertions)
 
 Before do

data/lib/mechanical-cuke.rb

@@ -1,5 +1,4 @@
 require 'mechanize'
-require 'mechanical-cuke/web_steps'
 require 'mechanical-cuke/save_and_open'
 
 module MechanicalCuke
@@ -26,18 +25,21 @@ module MechanicalCuke
     current_page.body
   end
 
+  def body
+    current_page.body
+  end
+
+  def form
+    current_page.forms.first
+  end
+
   def basic_auth(username,password)
     mechanize.basic_auth(username,password)
   end
 end
 
-World(MechanicalCuke)
-
 private
  
-def form
-  current_page.forms.first
-end
 
 def find_by_id(id)
   node = current_page.search("##{id}")
@@ -100,3 +102,8 @@ def find_checkbox(field)
 
   return nil
 end
+
+unless defined?(Capybara)
+  require 'mechanical-cuke/web_steps'
+  World(MechanicalCuke)
+end

data/lib/mechanical-cuke/basic_auth.rb

@@ -0,0 +1,7 @@
+module MechanicalCuke
+  module BasicAuth
+    def basic_auth(username,password)
+      page.driver.basic_auth(username, password)
+    end
+  end
+end

data/lib/mechanical-cuke/capybara.rb

@@ -0,0 +1,98 @@
+require 'mechanize'
+require 'capybara'
+require 'capybara/driver/base'
+require 'capybara/node'
+require 'mechanical-cuke'
+require 'mechanical-cuke/basic_auth'
+
+World(MechanicalCuke::BasicAuth)
+
+class Capybara::Driver::MechanicalCuke < Capybara::Driver::Base
+  include MechanicalCuke
+  class Node < Capybara::Node
+
+    def text
+      node.text
+    end
+
+    def [](name)
+      if name == :value
+        node.value
+      else
+        node.attribute(name.to_s)
+      end
+    end
+
+    def value
+      driver.form.field_with(:node => node).value
+    end
+
+    def set(value)
+      case self.node['type']
+      when 'radio'
+        radio = driver.form.radiobutton_with(:node => node)
+        if (value)
+          radio.check
+        else
+          radio.uncheck
+        end
+      when 'checkbox'
+        driver.form.checkbox_with(:node => node).checked = value
+      when 'file'
+        driver.form.file_upload_with(:node => node).file_name = value
+      else
+        driver.form.field_with(:node => node).value = value
+      end          
+    end
+
+    def select(option)
+      field = driver.form.field_with(:node => node)
+      if field_option = field.option_with(:value => option)
+        field_option.select
+      else
+        raise Capybara::OptionNotFound, "No such option '#{option}' in this select box. Available options: TODO" 
+      end
+    end
+
+    def click
+      if tag_name == 'a'
+        link = driver.current_page.link_with(:node => self.node)
+        link.click
+      elsif self.node['type'] == 'submit'
+        button = driver.form.button_with(:node => self.node)
+        driver.form.click_button(button)
+      else
+        nil
+      end
+    end
+
+    def tag_name
+      node.node_name
+    end
+  end
+
+  def visit(path)
+    get path
+  end
+
+  def body
+    current_page.body
+  end
+
+  alias_method :source, :body
+
+  def current_url
+    current_page.uri.to_s
+  end
+
+  def initialize(app)
+  end
+
+  def find(locator)
+    current_page.search(locator).map { |node| Node.new(self, node) }
+  end
+
+  def form
+    current_page.forms.first
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mechanical-cuke
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors: 
 - Spike Ilacqua
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-23 00:00:00 -06:00
+date: 2010-08-24 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,6 +82,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.3.9
+    version: 
 description: A Mechanize driver for Cucumber.  Provides step definitions for driving web applications using Mechanize.
 email: spike@indra.com
 executables: []
@@ -100,6 +110,7 @@ files:
 - VERSION
 - features/missing_fields.feature
 - features/step_definitions/basic_auth_steps.rb
+- features/step_definitions/capybara-web_steps.rb
 - features/step_definitions/mechanical-cuke_steps.rb
 - features/step_definitions/missing_field_steps.rb
 - features/step_definitions/table_steps.rb
@@ -109,6 +120,8 @@ files:
 - features/table_steps.feature
 - features/web_steps.feature
 - lib/mechanical-cuke.rb
+- lib/mechanical-cuke/basic_auth.rb
+- lib/mechanical-cuke/capybara.rb
 - lib/mechanical-cuke/save_and_open.rb
 - lib/mechanical-cuke/web_steps.rb
 - test/fixtures/hello.txt