mechwarrior 0.0.1

data/README.md

@@ -0,0 +1,52 @@
+Mechwarrior
+===========
+
+A Mechanize based Capybara driver, designed to get round the rack-test limitation of not being able to visit external (i.e. not the app your testing) websites.
+
+Installation
+------------
+
+1. `gem install 'mechwarrior'`
+
+2. `require 'mechwarrior/cucumber'` in cucumbers env.rb
+
+3. Tag your steps with either @mechanize or @external
+
+Dependencies
+------------
+    capybara ">= 1.0.0"
+    mechanize "~> 2.0.0"
+
+
+Licence
+---------
+
+Copyright (c) 2011, Chris Lowder, http://github.com/clowder
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+  
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+  
+* Neither the name of http://github.com/clowder nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+  
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/capybara/mechanize/driver.rb

@@ -0,0 +1,118 @@
+require 'mechanize'
+
+class Capybara::Mechanize::Driver < Capybara::Driver::Base
+  attr_reader :app, :rack_server, :options
+
+  def initialize(app, options={})
+    raise ArgumentError, "Mechanize requires a rack application, but none was given" unless app
+    
+    @app         = app
+    @options     = options
+    @rack_server = Capybara::Server.new(@app)
+    @rack_server.boot if Capybara.run_server
+  end
+
+  def browser
+    unless @browser
+      @browser = Mechanize.new
+      @browser.follow_meta_refresh
+    end
+    @browser
+  end
+
+  def visit(path)
+    browser.get(url(path))
+  end
+
+  def follow(_method, path, attributes={})
+    return if is_javascript_hashy_path?(path)
+
+    absolute_url = make_absolute_url(path)
+
+    if _method == :get
+      browser.get(absolute_url, [], self.current_url)
+    else
+      browser.send(_method, absolute_url, attributes)
+    end
+  end
+
+  def submit(form_node, button_node)
+    form   = Capybara::Mechanize::Form.new(form_node, browser)
+    button = Mechanize::Form::Button.new(button_node)
+
+    form.action = form.action || self.current_url
+
+    browser.submit(form, button)
+  end
+
+  def current_url
+    current_page? ? current_page.uri.to_s : ''
+  end
+
+  def response_headers
+    current_page? ? current_page.header : {}
+  end
+
+  def status_code
+    current_page? ? current_page.code.to_i : nil
+  end
+
+  def find(selector)
+    dom.search(selector).map { |node| Capybara::Mechanize::Node.new(self, node) }
+  end
+
+  def source
+    current_page? ? current_page.body : ''
+  end
+  alias :body :source
+
+  def dom
+    current_page? ? current_page.root : Nokogiri::HTML(nil)
+  end
+
+  def reset!
+    @browser = nil
+  end
+
+  private
+
+  def url(path)
+    rack_server.url(path)
+  end
+
+  def current_page
+    browser.current_page
+  end
+
+  def current_page?
+    !browser.current_page.nil?
+  end
+
+  def current_page_is_external?
+    current_page.uri.host != (Capybara.app_host || rack_server.host)
+  end
+
+  def request_path
+    browser.current_page.uri.path
+  end
+
+  def make_absolute_url(path)
+    return path unless URI.parse(path).relative?
+
+    path = "#{ request_path }#{ path }" if is_query_string?(path)
+
+    if current_page? && current_page_is_external?
+      current_page.uri.merge(path).to_s
+    else
+      url(path)
+    end
+  end
+  
+  def is_query_string?(path)
+    path.start_with?('?')
+  end
+
+  def is_javascript_hashy_path?(path)
+    path.gsub(/^#{request_path}/, '').start_with?('#')
+  end
+end

data/lib/capybara/mechanize/form.rb

@@ -0,0 +1,43 @@
+require 'mechanize'
+
+class Capybara::Mechanize::Form < Mechanize::Form
+  
+  def initialize(node, mech=nil, page=nil)
+    super(strip_disabled_nodes(node), mech, page)
+    normalize_uploads
+  end
+  
+  private
+  
+  def strip_disabled_nodes(form_node)
+    stripped_form_node = form_node.clone
+    stripped_form_node.search('*[disabled=disabled]').remove
+    stripped_form_node
+  end
+  
+  def normalize_uploads
+    if self.enctype.downcase =~ /^multipart\/form-data/
+      assign_files_to_uploads
+    else
+      create_dummy_fields
+    end
+  end
+  
+  def assign_files_to_uploads
+    self.file_uploads.each do |upload|
+      file_path = upload.node["value"]
+      upload.file_name = file_path if !file_path.nil? && file_path != ''
+    end 
+  end
+  
+  def create_dummy_fields
+    self.file_uploads.each do |upload|
+      file_path = upload.node["value"]
+      
+      if !file_path.nil? && file_path != ''        
+        new_field = Mechanize::Form::Field.new(upload.node, File.basename(file_path))
+        self.fields << new_field
+      end
+    end 
+  end
+end

data/lib/capybara/mechanize/node.rb

@@ -0,0 +1,100 @@
+class Capybara::Mechanize::Node < Capybara::Driver::Node
+  def text
+    native.text
+  end
+
+  def [](name)
+    string_node[name]
+  end
+
+  def value
+    string_node.value
+  end
+
+  def set(value)
+    if tag_name == 'input' and type == 'radio'
+      other_radios_xpath = XPath.generate { |x| x.anywhere(:input)[x.attr(:name).equals(self[:name])] }.to_s
+      driver.dom.xpath(other_radios_xpath).each { |node| node.remove_attribute("checked") }
+      native['checked'] = 'checked'
+    elsif tag_name == 'input' and type == 'checkbox'
+      if value && !native['checked']
+        native['checked'] = 'checked'
+      elsif !value && native['checked']
+        native.remove_attribute('checked')
+      end
+    elsif tag_name == 'input'
+      if (type == 'text' || type == 'password') && self[:maxlength]
+        value = value[0...self[:maxlength].to_i]
+      end
+      native['value'] = value.to_s
+    elsif tag_name == "textarea"
+      native.content = value.to_s
+    end
+  end
+
+  def select_option
+    if select_node['multiple'] != 'multiple'
+      select_node.find(".//option[@selected]").each { |node| node.native.remove_attribute("selected") }
+    end
+    native["selected"] = 'selected'
+  end
+
+  def unselect_option
+    if select_node['multiple'] != 'multiple'
+      raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box."
+    end
+    native.remove_attribute('selected')
+  end
+
+  def click
+    if tag_name == 'a'
+      method = self["data-method"] || :get
+      driver.follow(method, self[:href].to_s)
+    elsif (tag_name == 'input' && %w(submit image).include?(type)) || ((tag_name == 'button') && type.nil? || type == "submit")
+      driver.submit(form, self)
+    end
+  end
+
+  def tag_name
+    native.node_name
+  end
+
+  def visible?
+    string_node.visible?
+  end
+
+  def checked?
+    string_node.checked?
+  end
+
+  def selected?
+    string_node.selected?
+  end
+
+  def path
+    native.path
+  end
+
+  def find(locator)
+    native.xpath(locator).map { |n| self.class.new(driver, n) }
+  end
+
+private
+
+  def string_node
+    @string_node ||= Capybara::Node::Simple.new(native)
+  end
+
+  # a reference to the select node if this is an option node
+  def select_node
+    find('./ancestor::select').first
+  end
+
+  def type
+    native[:type]
+  end
+
+  def form
+    native.ancestors('form').first
+  end
+end

data/lib/capybara/mechanize.rb

@@ -0,0 +1,13 @@
+require 'capybara'
+
+module Capybara
+  module Mechanize
+    autoload :Driver,  'capybara/mechanize/driver'
+    autoload :Node,    'capybara/mechanize/node'
+    autoload :Form,    'capybara/mechanize/form'
+  end
+end
+
+Capybara.register_driver :mechanize do |app|
+  Capybara::Mechanize::Driver.new(app)
+end

data/lib/mechwarrior/cucumber.rb

@@ -0,0 +1,5 @@
+require 'mechwarrior'
+
+Before '@external' do
+  Capybara.current_driver = :mechanize
+end

data/lib/mechwarrior/version.rb

@@ -0,0 +1,3 @@
+module Mechwarrior
+  VERSION = '0.0.1'
+end

data/lib/mechwarrior.rb

@@ -0,0 +1,5 @@
+require 'capybara/mechanize'
+
+module Mechwarrior
+  autoload :VERSION, 'mechwarrior/version'
+end

data/spec/mechanize_driver_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Capybara::Mechanize::Driver do
+  before do
+    @driver = TestSessions::Mechanize.driver
+  end
+
+  it "should throw an error when no rack app is given" do
+    running do
+      Capybara::Mechanize::Driver.new(nil)
+    end.should raise_error(ArgumentError)
+  end
+
+  it_should_behave_like "driver"
+  it_should_behave_like "driver with header support"
+  it_should_behave_like "driver with status code support"
+  it_should_behave_like "driver with cookies support"
+
+end

data/spec/mechanize_session_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Capybara::Session do
+  context 'with Mechanize driver' do
+    before do
+      @session = TestSessions::Mechanize
+    end
+
+    describe '#driver' do
+      it "should be a Mechanize driver" do
+        @session.driver.should be_an_instance_of(Capybara::Mechanize::Driver)
+      end
+    end
+
+    describe '#mode' do
+      it "should remember the mode" do
+        @session.mode.should == :mechanize
+      end
+    end
+
+    describe '#click_link' do
+      it "should use data-method if available" do
+        @session.visit "/with_html"
+        @session.click_link "A link with data-method"
+        @session.body.should include('The requested object was deleted')
+      end
+    end
+
+    it_should_behave_like "session"
+    it_should_behave_like "session without javascript support"
+    it_should_behave_like "session with headers support"
+    it_should_behave_like "session with status code support"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'rubygems'
+require "bundler/setup"
+
+require 'rspec'
+require 'mechwarrior'
+
+RSpec.configure do |config|
+  config.before do
+    Capybara.configure do |config|
+      config.default_selector = :xpath
+    end
+  end
+end
+
+require 'capybara/spec/driver'
+require 'capybara/spec/session'
+
+alias :running :lambda
+
+Capybara.default_wait_time = 0 # less timeout so tests run faster
+
+module TestSessions
+  Mechanize = Capybara::Session.new(:mechanize, TestApp)
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: mechwarrior
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Lowder
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-25 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: launchy
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.5
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.8
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: fuubar
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.10"
+  type: :development
+  version_requirements: *id008
+description: A Mechanize based Capybara driver.
+email: 
+- clowder@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/capybara/mechanize/driver.rb
+- lib/capybara/mechanize/form.rb
+- lib/capybara/mechanize/node.rb
+- lib/capybara/mechanize.rb
+- lib/mechwarrior/cucumber.rb
+- lib/mechwarrior/version.rb
+- lib/mechwarrior.rb
+- spec/mechanize_driver_spec.rb
+- spec/mechanize_session_spec.rb
+- spec/spec_helper.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/clowder/mechwarrior
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A Mechanize based Capybara driver, designed to get round the rack-test limitation of not being able to visit external (i.e. not the app your testing) websites.
+test_files: []
+