mechanical-cuke 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Joseph A. Ilacqua, Jr
+
+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.textile

@@ -0,0 +1,119 @@
+h1. mechanical-cuke
+
+mechanical-cuke re-implements the Cucumber step definitions provided
+by cucumber-rails in web_steps.rb in Mechanize.  This allows Cucumber
+features to be written for any site by running the tests over HTTP.
+
+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 basis auth).  Capybara drives
+tests over HTTP using browsers, excellent for testing Javascript, but
+slow for test that only involve HTML.
+
+h2. Usage
+
+Add:
+
+  require 'mechanical-cuke'
+
+to features/support/env.rb
+
+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)
+    case page_name
+
+becomes
+
+bc. def path_to(page_name)
+   'http://localhost:3000' +
+    case page_name
+
+h2. Steps Provided
+
+bc. Given am on path
+When I go to path
+
+GET the page at _path_ and sets it to the current page for follow steps.
+
+bc. When I press "button"
+
+Press button with label "_button_".  If the button is in a form
+
+bc. When I follow "link"
+
+Click the link with text "_link_".
+
+bc. When I fill in "field" with "value"
+When I fill in "value" for "field"
+
+Fill in the text field, password field, or text area _field_ with
+_value_.  _field_ can be the id or name of the field, or the text
+within the label for the field.
+
+bc. When I fill in the following:
+
+Takes a table of fields and values of the form:
+
+bc. When I fill in the following:
+     | Account Number | 5002       |
+     | Expiry date    | 2009-11-01 |
+     | Note           | Nice guy   |
+ 
+
+bc. When I select "value" from "field"
+
+Selects the option with _value_ from select list _field_.  _field_ can
+be the id or name of the field, or the text within the label for the
+field.
+
+bc. When I check "field"
+When I uncheck "field"
+
+Check or uncheck "_field_".  PENDING
+
+bc. When I choose "field"
+
+Checks radio button _field_.  _field_ can be the id or the text within
+the label for the field; the field name would be ambiguous.
+
+When I attach the file "path" to "field"
+
+Attach the file in _path_ to the file field _field_.  PENDING
+
+bc. Then I should see "text"
+Then I should see /regexp/
+
+The body of the page should contain _text_ or _regexp_.
+
+bc. Then I should not see "text"
+Then I should not see /regexp/
+
+The body of the page should *not* contain _text_ or _regexp_.
+
+bc. Then the "field" field should contain "value"
+Then the "field" field should not contain "value"
+
+The value _field_ should be (or not be) _value_.  PENDING
+
+bc. Then the "_field_" checkbox should be checked
+Then the "_field_" checkbox not should be checked
+
+The checkbox _field_ should be (or not be) checked.  PENDING
+
+bc. Then I should be on _path_
+
+The path/uri of the current page should be _path_.
+
+bc. Then show me the page
+
+Save the current page and open in the default browser.
+
+h2. Authors
+
+Spike Ilacqua
+

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mechanical-cuke"
+    gem.summary = %Q{A Mechanize driver for Cucumber}
+    gem.description = %Q{A Mechanize driver for Cucumber.  Provides step definitions for driving web applications using Mechanize.}
+    gem.email = "spike@indra.com"
+    gem.homepage = "http://github.com/spikex/mechanical-cuke"
+    gem.authors = ["Spike Ilacqua"]
+    gem.add_runtime_dependency 'mechanize', '>= 1.0.0'
+    gem.add_runtime_dependency "cucumber", ">= 0.8.5"
+    gem.add_development_dependency "open4", ">= 0.9.6"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:cucumber)
+
+  task :cucumber => :check_dependencies
+rescue LoadError
+  task :cucumber do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :cucumber
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mechanical-cuke #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/features/support/env.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+
+require 'mechanical-cuke'
+
+require 'test/unit/assertions'
+
+require 'open4'
+
+World(Test::Unit::Assertions)
+
+Before do
+  @server ||= {}
+  server_app = File.dirname(__FILE__) + '/../../test/fixtures/server/server.rb'
+  @server[:pid], @server[:stdin], @server[:stdout], @server[:stderr] =
+    Open4::popen4 server_app
+  status = @server[:stdout].readline
+  raise "Server startup failed" if status !~ /Sinatra.* has taken the stage on/ 
+end
+
+After do
+  if @server[:pid]
+    Process.kill('HUP', @server[:pid])
+  end
+end

data/features/support/mocha.rb

@@ -0,0 +1,17 @@
+require 'mocha'
+require 'launchy'
+
+World(Mocha::API)
+ 
+Before('@mock_launchy') do
+  Launchy::Browser.expects(:run).returns(true)
+  # TODO: Mock saving file...
+end
+ 
+After('@mock_launchy') do
+  begin
+    mocha_verify
+  ensure
+    mocha_teardown
+  end
+end

data/features/support/paths.rb

@@ -0,0 +1,19 @@
+module NavigationHelpers
+  def path_to(page_name)
+    
+    'http://localhost:4567' +
+
+    case page_name
+    
+    when /the index page/
+      '/'
+    when /the form page/
+      '/form'
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/features/web_steps.feature

@@ -0,0 +1,54 @@
+Feature: Using Mechanize
+  In order to test web sites over HTTP
+  I want to be able to interacted with sites using Mechanize
+
+  Scenario: Navigation Steps
+    Given I am on the index page
+    Then I should be on the index page
+    When I go to the index page
+    Then I should be on the index page
+    When I follow "Form Link"
+    Then I should be on the form page
+
+  Scenario: Should See Steps
+    Given I am on the index page
+    Then I should see "Hello World!"
+    And I should see /Hel+o.World./
+    But I should not see "Oogy Boogy!"
+    And I should not see /[Oo]+gy Bo+gy/
+
+  Scenario: Form Steps
+    Given I am on the form page
+    When I fill in "Field by Label" with "Label Field"
+    And I fill in "Name Field" for "field_by_name"
+    And I fill in "field_by_id_id" with "ID Field"
+    And I fill in "Text Area by Label" with "Text Area Text"
+    And I fill in "Password by Label" with "Password Text"
+    And I select "Option Two" from "Select by Name"
+    And I choose "Radio Button One" 
+    And I press "Submit"
+    Then I should see "Label Field"
+    And I should see "Name Field"
+    And I should see "Option Two"
+    And I should see "Text Area Text"
+    And I should see "Password Text"
+    And I should see "Radio Button One Chosen"
+    But I should not see "Option One"
+    And I should not see "Radio Button Two Chosen"
+
+  Scenario: Form Table Steps
+    Given I am on the form page
+    When I fill in the following:
+    | Field by Label | Labeled |
+    | field_by_name  | Named |
+    | field_by_id_id | ID-ed |
+    And I press "Submit"
+    Then I should see "Labeled"
+    And I should see "Named"
+    And I should see "ID-ed"
+
+@mock_launchy
+  Scenario: Navigation Steps
+    Given I am on the index page
+    Then show me the page
+

data/lib/mechanical-cuke/save_and_open.rb

@@ -0,0 +1,22 @@
+require 'pathname'
+
+def save_page(page)
+  return nil unless File.directory?(directory = save_pages_dir)
+  filename = "#{directory}/mechanize-#{Time.now.to_i}.html"
+  page.save_as(filename)
+  filename
+end
+
+def open_in_browser(path) # :nodoc
+  require "launchy"
+  Launchy::Browser.run(path)
+rescue LoadError
+  warn "Sorry, you need to install launchy to open pages: `gem install launchy`"
+end
+  
+private
+
+def save_pages_dir
+  tmp_dir = Pathname.new(Dir.pwd).join("tmp")
+  tmp_dir.exist? ? tmp_dir : Dir.pwd
+end

data/lib/mechanical-cuke/web_steps.rb

@@ -0,0 +1,95 @@
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  get path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  get path_to(page_name)
+end
+
+When /^(?:|I )press "([^\"]*)"$/ do |name|
+  button = form.submits.find{|f| f.name == name}
+  form.click_button(button)
+end
+
+When /^(?:|I )follow "([^\"]*)"$/ do |link|
+  current_page.link_with(:text => link).click
+end
+
+When /^(?:|I )fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value|
+  f = find_field(field)
+  raise "Can't find field \"#{field}\"" if f.nil?
+  f.value = value
+end
+
+When /^(?:|I )fill in "([^\"]*)" for "([^\"]*)"$/ do |value, field|
+  f = find_field(field)
+  raise "Can't find field \"#{field}\"" if f.nil?
+  f.value = value
+end
+
+When /^(?:|I )fill in the following:$/ do | fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
+  f = find_field(field)
+  raise "Can't find field \"#{field}\"" if f.nil?
+  f.option_with(:value => value).select
+end
+
+When /^(?:|I )choose "([^\"]*)"$/ do |field|
+  r = find_radiobutton(field)
+  raise "Can't find radio button \"#{field}\"" if r.nil?
+  r.check
+end
+
+Then /^(?:|I )should see "([^\"]*)"$/ do |text|
+  if defined?(Spec::Rails::Matchers)
+    response.should contain(text)
+  else
+    assert current_page.body.include?(text)
+  end
+end
+
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  if defined?(Spec::Rails::Matchers)
+    page.should have_xpath('//*', :text => regexp)
+  else
+    assert_match regexp, current_page.body
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  if defined?(Spec::Rails::Matchers)
+    page.should have_not_xpath('//*', :text => regexp)
+  else
+    assert_no_match regexp, current_page.body
+  end
+end
+
+But /^(?:|I )should not see "([^\"]*)"$/ do |text|
+  if defined?(Spec::Rails::Matchers)
+    response.should_not contain(text)
+  else
+    assert !current_page.body.include?(text)
+  end
+end
+
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = current_page.uri.to_s
+  if defined?(Spec::Rails::Matchers)
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^show me the page$/ do
+  filename = save_page(current_page)
+  open_in_browser(filename) unless filename.nil?
+end

data/lib/mechanical-cuke.rb

@@ -0,0 +1,66 @@
+require 'mechanize'
+require 'mechanical-cuke/web_steps'
+require 'mechanical-cuke/save_and_open'
+
+module MechanicalCuke
+  class << self
+    attr_accessor :save_and_open_page_path
+    def configure
+      yield self
+    end
+# TODO: try def get blah blah
+  end
+end
+
+World do
+  session = Mechanize.new
+end
+
+private
+
+def form
+  current_page.forms.first
+end
+
+def find_by_id(id)
+  node = current_page.search("##{id}")
+  node.first
+end
+
+def find_by_label(field)
+  label = current_page.labels.find { |l| l.text == field }
+  !label.nil? ? label.for.first : nil
+end
+    
+def find_field(field)
+  # Search by id
+  if (node = find_by_id(field))
+    return form.field_with(:node => node)
+  end
+  
+  # Then by name
+  if (f = form.field_with(:name => field))
+    return f
+  end
+
+  # And finally by label
+  if (node = find_by_label(field))
+    return form.field_with(:node => node)
+  end
+
+  return nil
+end
+
+def find_radiobutton(field)
+  # Search by id
+  if (node = find_by_id(field))
+    return form.radiobutton_with(:node => node.first)
+  end
+  
+  # And by label
+  if (node = find_by_label(field))
+    return form.radiobutton_with(:node => node)
+  end
+
+  return nil
+end

data/test/fixtures/server/server.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'sinatra'
+require 'erb'
+
+disable :logging
+STDOUT.sync = true
+
+get '/' do
+  erb :index
+end
+
+get '/form' do
+  erb :form
+end
+
+post '/form' do
+  erb :form_output
+end

data/test/fixtures/server/views/form.erb

@@ -0,0 +1,51 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <title>Form</title>
+  </head>
+  <body>
+    <form id="form_id" name="form_name" action="" method="POST">
+      <p>
+	<label for="field_by_label_id">Field by Label</label>
+	<input type="text" id="field_by_label_id" name="field_by_label">
+      </p>
+      <p>
+	<label for="field_by_name_id">Field by Name</label>
+	<input type="text" id="field_by_name_id" name="field_by_name">
+      </p>
+      <p>
+	<label for="field_by_id_id">Field by ID</label>
+	<input type="text" id="field_by_id_id" name="field_by_id">
+      </p>
+      <p>
+	<label for="password_by_label_id">Password by Label</label>
+	<input type="password" id="password_by_label_id" name="password_by_label">
+      </p>
+      <p>
+	<label for="text_area_by_label_id">Text Area by Label</label>
+	<input type="text" id="text_area_by_label_id" name="text_area_by_label">
+      </p>
+      <p>
+	<label for="select_by_name_id">Select by Name</label>
+	<select id="select_by_name_id" name="select_by_name">
+	  <option></option>
+	  <option>Option One</option>
+	  <option>Option Two</option>
+	  <option>Option Three</option>
+	</select>
+      </p>
+      <p>
+	<label>Radio Button by Name</label>
+	<label for="radio_button_one_id">Radio Button One</label>
+	<input type="radio" id="radio_button_one_id"
+	       name="radio_button" value="Radio Button One Chosen">
+	<label for="radio_button_two_id">Radio Button Two</label>
+	<input type="radio" id="radio_button_two_id" name="radio_button" value="Radio Button Two Chosen" checked>
+      </p>
+
+      <p>
+	<input type="submit" value="Submit">
+      </p>
+    </form>
+  </body>
+</html>

data/test/fixtures/server/views/form_output.erb

@@ -0,0 +1,36 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <title>Form Output</title>
+  </head>
+  <body>
+    <p>
+      <label>Field by Label</label>
+      <%= params[:field_by_label] %>
+    </p>
+    <p>
+      <label>Field by Name</label>
+      <%= params[:field_by_name] %>
+    </p>
+    <p>
+      <label>Field by ID</label>
+      <%= params[:field_by_id] %>
+    </p>
+    <p>
+      <label>Password by Label</label>
+      <%= params[:password_by_label] %>
+    </p>
+    <p>
+      <label>Text Area by Label</label>
+      <%= params[:text_area_by_label] %>
+    </p>
+    <p>
+      <label>Select by Name</label>
+      <%= params[:select_by_name] %>
+    </p>
+    <p>
+      <label>Radio Button by Name</label>
+      <%= params[:radio_button] %>
+    </p>
+  </body>
+</html>

data/test/fixtures/server/views/index.erb

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+  </head>
+  <title></title>
+</head>
+<body>
+  <p>Hello World!</p>
+  <p>
+    <a href="/form">Form Link</a>
+  </p>
+</body>
+</html>
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: mechanical-cuke
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Spike Ilacqua
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-18 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
+description: A Mechanize driver for Cucumber.  Provides step definitions for driving web applications using Mechanize.
+email: spike@indra.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- features/step_definitions/mechanical-cuke_steps.rb
+- features/support/env.rb
+- features/support/mocha.rb
+- features/support/paths.rb
+- features/web_steps.feature
+- lib/mechanical-cuke.rb
+- lib/mechanical-cuke/save_and_open.rb
+- lib/mechanical-cuke/web_steps.rb
+- test/fixtures/server/server.rb
+- test/fixtures/server/views/form.erb
+- test/fixtures/server/views/form_output.erb
+- test/fixtures/server/views/index.erb
+has_rdoc: true
+homepage: http://github.com/spikex/mechanical-cuke
+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: A Mechanize driver for Cucumber
+test_files: 
+- test/fixtures/server/server.rb