wrapybara 0.1.0

data/lib/wrapybara/elements/text_area.rb

@@ -0,0 +1,22 @@
+module Wrapybara
+	class TextArea
+		include Element
+		include FillableField
+		
+		def initialize(identifier, scope = default_scope, how = default_how)
+			@identifier = identifier
+			@how = how
+			@scope = scope
+			xpath = XPath::HTML.send(:locate_field, XPath.descendant(:textarea), identifier)
+			@element = get_element(xpath, scope)
+		end
+		
+		def should_exist
+			super "Expected a text area #{self.element_identifier} to exist"
+		end
+
+		def should_not_exist
+			super "Did not expect a text area #{self.element_identifier}' to exist"
+		end
+	end
+end

data/lib/wrapybara/elements/text_field.rb

@@ -0,0 +1,22 @@
+module Wrapybara
+	class TextField
+		include Element
+		include FillableField
+		
+		def initialize(identifier, scope = default_scope, how = default_how)
+			@identifier = identifier
+			@how = how
+			@scope = scope
+			xpath = XPath::HTML.send(:locate_field, XPath.descendant(:input)[XPath.attr(:type).equals('text')], identifier)
+			@element = get_element(xpath, scope)
+		end
+		
+		def should_exist
+			super "Expected a text field #{self.element_identifier} to exist"
+		end
+
+		def should_not_exist
+			super "Did not expect a text field #{self.element_identifier}' to exist"
+		end
+	end
+end

data/lib/wrapybara/ext/focus_tracking.js

@@ -0,0 +1,68 @@
+/*
+	This script facilitates tracking whether or not an element has focus. It is not an ideal solution,
+	but it does work across browsers and test environments. The need for such a solution was prompted
+	by HtmlUnit not supporting document.activeElement, which all major browsers now support. HtmlUnit
+	being the underlying technology used by Akephalos (in Cucumber via Capybara), this was a problem.
+	
+	Focus Tracking can be used by calling FocusTracking.initialize once the dom is loaded and then by
+	calling $(element_id).has_focus().
+	
+	This script is currently dependent on Prototype, but could be easily adapted for any JavaScript library.
+*/
+
+var FocusTracking = {};
+
+FocusTracking.attribute = 'has-focus';
+FocusTracking.auto_focus_class_name = 'auto-focus';
+
+FocusTracking.focusable_elements = function ()
+{
+	return $$('input[type=text], input[type=password], input[type=submit], input[type=button], input[type=checkbox], input[type=radio], textarea, button, select');
+}
+
+FocusTracking.initialize = function ()
+{
+	var elements = FocusTracking.focusable_elements();
+	elements.each(
+		function (element)
+		{
+			if (element.readAttribute(FocusTracking.attribute) == null)
+			{
+				// if the element already has the focus tracking pieces, leave it alone...only initialize it if
+				// it isn't there so we don't miss saving some changes.
+				Object.extend(element, FocusTracking.Element);
+				element.writeAttribute(FocusTracking.attribute, 'false');
+				element.observe('focus', element.got_focus);
+				element.observe('blur', element.lost_focus);
+			}
+		}
+	);
+}
+
+FocusTracking.auto_focus = function (class_name)
+{
+	class_name = class_name == undefined || class_name == null ? FocusTracking.auto_focus_class_name : class_name;
+	var elements = $$('.' + class_name);
+	if (elements.length > 0)
+	{
+		element = elements.first();
+		element.activate();
+	} 
+}
+
+FocusTracking.Element = {};
+
+FocusTracking.Element.has_focus = function ()
+{
+	return this.readAttribute(FocusTracking.attribute) == 'true';
+}
+
+FocusTracking.Element.got_focus = function ()
+{
+	this.writeAttribute(FocusTracking.attribute, 'true');
+}
+
+FocusTracking.Element.lost_focus = function ()
+{
+	this.writeAttribute(FocusTracking.attribute, 'false');
+}

data/lib/wrapybara/ext/focus_tracking.rb

@@ -0,0 +1,45 @@
+# This module is, admittedly, something of a hack. In order to reliably (across browsers and testing libraries) test for
+# an element having focus, I resorted to adding some JavaScript event handling to read/write an attribute on focus/blur.
+# Not pretty, but HtmlUnit, which Akephalos uses, did not recognize document.activeElement, so I had to roll my own
+# solution. To make it easier for you to use this module, the corresponding JavaScript is included in focus_tracking.js.
+# See it for usage notes.
+
+# To use Wrapybara's focus handling capabilities, require wrapybara/ext/focus_handling in some file that gets loaded (I use
+# support/extras.rb so I don't pollute env.rb) and then optionally set Wrapybara.focus_attribute to whatever the element
+# attribute will be. As you can see below, Wrapybara checks the value of the attribute against what you say it should be
+# when the element has focus.
+
+module Wrapybara
+	def self.focus_attribute=(attribute)
+		@focus_attribute = attribute
+	end
+	
+	def self.focus_attribute
+		@focus_attribute || 'has-focus'
+	end
+	
+	def self.focus_value=(value)
+		@focus_value = value
+	end
+	
+	def self.focus_value
+		@focus_value || 'true'
+	end
+	
+	module Element
+		def focused?
+			self.should_exist
+			element[Wrapybara.focus_attribute] == Wrapybara.focus_value
+		end
+		
+		def should_be_focused
+			message = "Expected element #{self.element_identifier} to be focused"
+			raise UnmetExpectation, message unless self.focused?
+		end
+		
+		def should_not_be_focused
+			message = "Did not expect element #{self.element_identifier} to be focused"
+			raise UnmetExpectation, message if self.focused?
+		end
+	end
+end

data/lib/wrapybara/methods.rb

@@ -0,0 +1,57 @@
+# add this directory to the load path if it's not already included
+this_dir = File.expand_path(File.dirname(__FILE__))
+$: << this_dir unless $:.include?(this_dir)
+
+module Wrapybara
+	class UnmetExpectation < Exception; end
+
+	def host
+		Capybara.app_host
+	end
+
+	def current_path
+		Capybara.current_path
+	end
+	
+	def current_url
+		Capybara.current_url
+	end
+	
+	def current_path_is?(path)
+		path = path.gsub('/', '\/').gsub('?', '\?')
+		(current_url || current_path) =~ /#{path}/
+	end
+
+	def current_path_should_be(path)
+		raise UnmetExpectation, "Expected the current path to be '#{path}'" unless current_path_is?(path)
+	end
+
+	def current_path_should_not_be(path)
+		raise UnmetExpectation, "Did not expect the current path to be '#{path}'" if current_path_is?(path)
+	end
+end
+
+require 'xpath'
+require 'element'
+require 'elements/attribute'
+require 'elements/button'
+require 'elements/checkbox'
+require 'elements/content'
+require 'elements/form'
+require 'elements/image'
+require 'elements/label'
+require 'elements/link'
+require 'elements/file_field'
+require 'elements/fillable_field'
+require 'elements/option'
+require 'elements/password_field'
+require 'elements/radio_button'
+require 'elements/select'
+require 'elements/table'
+require 'elements/table_body'
+require 'elements/table_cell'
+require 'elements/table_head'
+require 'elements/text_area'
+require 'elements/text_field'
+
+World(Wrapybara)

data/lib/wrapybara/steps.rb

@@ -0,0 +1,139 @@
+Given /^(?:I )?debug$/ do
+	require 'ruby-debug'
+	debugger
+	puts "\n\nDEBUGGER\n\n"
+end
+
+Given /^(?:I )?reload(?: the page)?$/ do
+	visit current_path
+end
+
+Given /^(?:I )?display "([^"]+)"$/ do |something|
+	puts "\n\n#{something}\n\n"
+end
+
+Given /^(?:I )?wait(?: (?:for )?(\d+) seconds)?$/ do |seconds|
+	seconds ||= '2'
+	sleep(seconds.to_i)
+end
+
+Given /^there (should|should not) be a[n]? (.+) (labeled|identified by|for|titled) "([^"]+)"(?: (?:in|within) "([^"]+)")?$/ do |expectation, element, how, identifier, scope|
+	element.gsub!(' ', '_')
+	expectation.gsub!(' ', '_')
+	"Wrapybara::#{element.camelize}".constantize.new(identifier, scope, how).send("#{expectation}_exist")
+end
+
+Given /^the table (labeled|identified by) "([^"]+)"(?: (?:in|within) "([^"]+)")? (should|should not) have column[s]?(?: "([^"]+)")?$/ do |how, identifier, scope, expectation, column, table|
+	columns = column ? [column] : (table.hashes.collect { |row| row['label'] || '' })
+	Wrapybara::Table.new(identifier, scope, how).send("#{expectation}_have_columns", columns)
+end
+
+Given /^the select (labeled|identified by) "([^"]+)"(?: (?:in|within) "([^"]+)")? (should|should not) have option[s]?(?: "([^"]+)")?(?: (selected))?$/ do |how, identifier, scope, expectation, option, selected, table|
+	options = option ? [option] : (table.hashes.collect { |row| row['label'] || '' })
+	expectation.gsub!(' ', '_')
+	if selected
+		options.each do |option|
+			Wrapybara::Select.new(identifier, scope, how).option(option).send("#{expectation}_be_selected")
+		end
+	else
+		Wrapybara::Select.new(identifier, scope, how).send("#{expectation}_have_options", options)
+	end
+end
+
+# In this step, the label capture must use an * to accept empty strings, ie, selecting the blank option typically at the top of the options
+Given /^(?:I )?(choose|select|deselect) "([^"]*)" from the select (labeled|identified by) "([^"]+)"?(?: (?:in|within) "([^"]+)")?$/ do |action, option, how, identifier, scope|
+	Wrapybara::Select.new(identifier, scope, how).send(action.to_sym, option)
+end
+
+Given /^the select (labeled|identified by) "([^"]+)"?(?: (?:in|within) "([^"]+)")? (should|should not) have "([^"]*)" selected$/ do |how, identifier, scope, expectation, option|
+	expectation.gsub!(' ', '_')
+	Wrapybara::Select.new(identifier, scope, how).option(option).send("#{expectation}_be_selected")
+end
+
+Given /^the (.+) (labeled|identified by|titled) "([^"]+)"(?: (?:in|within) "([^"]+)")? (should|should not) be (.+)$/ do |element, how, identifier, scope, expectation, state|
+	element.gsub!(' ', '_')
+	expectation.gsub!(' ', '_')
+	"Wrapybara::#{element.camelize}".constantize.new(identifier, scope, how).send("#{expectation}_be_#{state}")
+end
+
+Given /^the (.+) (labeled|identified by|titled) "([^"]+)"(?: (?:in|within) "([^"]+)")? (should|should not) have attribute "([^"]+)" with value "([^"]+)"$/ do |element, how, identifier, scope, expectation, attribute, value|
+	element.gsub!(' ', '_')
+	expectation.gsub!(' ', '_')
+	"Wrapybara::#{element.camelize}".constantize.new(identifier, scope, how).send("#{expectation}_have_attribute", attribute, value)
+end
+
+Given /^(?:I )?(check|uncheck) the (checkbox|radio button) (labeled|identified by) "([^"]+)"(?: (?:in|within) "([^"]+)")?$/ do |action, element, how, identifier, scope|
+	element.gsub!(' ', '_')
+	"Wrapybara::#{element.camelize}".constantize.new(identifier, scope, how).send(action)
+end
+
+# In this step, the label capture must use an * to accept empty strings, so we can clear the field
+Given /^(?:I )?fill in the (text field|password field|text area) (labeled|identified by) "([^"]+)"(?: (?:in|within) "([^"]+)")? with "([^"]*)"$/ do |element, how, identifier, scope, content|
+	content ||= ''
+	element.gsub!(' ', '_')
+	"Wrapybara::#{element.camelize}".constantize.new(identifier, scope, how).fill_in(content)
+end
+
+Given /^(?:I )?click the (button|link) (labeled|identified by|titled) "([^"]+)"(?: (?:in|within) "([^"]+)")?$/ do |element, how, identifier, scope|
+	"Wrapybara::#{element.capitalize}".constantize.new(identifier, scope, how).click
+end
+
+# for finding unlabeled links
+Given /^there (should|should not) be a link to "([^"]+)"(?: (?:in|within) "([^"]+)")?$/ do |expectation, destination, scope|
+	expectation.gsub!(' ', '_')
+	Wrapybara::Link.new(destination, scope, 'to').send("#{expectation}_exist")
+end
+
+Given /^there (should|should not) be a link to the "([^"]+)" page(?: (?:in|within) "([^"]+)")?$/ do |expectation, destination, scope|
+	expectation.gsub!(' ', '_')
+	destination = path_to(destination)
+	Wrapybara::Link.new(destination, scope, 'to').send("#{expectation}_exist")
+end
+
+# for clicking unlabeled links
+Given /^(?:I )?click the link to the "([^"]+)" page(?: (?:in|within) "([^"]+)")?$/ do |destination, scope|
+	destination = path_to(destination)
+	Wrapybara::Link.new(destination, scope, 'to').click
+end
+
+# for clicking table column headers (as in sortable columns)
+Given /^(?:I )?click column "([^"]+)" of the table (labeled|identified by) "([^"]+)"(?: (?:in|within) "([^"]+)")?$/ do |column, how, table, scope|
+	Wrapybara::Table.new(table, scope, how).click_column(column)
+end
+
+# content
+Given /^(?:I )?(should|should not) see "([^"]+)"(?: within "([^"]+)")?$/ do |expectation, content, scope|
+	expectation.gsub!(' ', '_')
+	Wrapybara::Content.new(content, scope).send("#{expectation}_exist")
+end
+
+Given /^"([^"]+)"(?: within "([^"]+)")? (should|should not) be visible$/ do |content, scope, expectation|
+	expectation.gsub!(' ', '_')
+	Wrapybara::Content.new(content, scope).send("#{expectation}_be_visible")
+end
+
+# for clicking things like headers that have expandable detail below them
+Given /^I click the text "([^"]+)"(?: within "([^"]+)")?$/ do |content, scope|
+	Wrapybara::Content.new(content, scope).click
+end
+
+# fillable fields (text field, password field, text area)
+Given /^the (.+) (labeled|identified by) "([^"]+)"(?: (?:in|within) "([^"]+)")? (should|should not) have content "([^"]+)"$/ do |element, how, identifier, scope, expectation, content|
+	element.gsub!(' ', '_')
+	expectation.gsub!(' ', '_')
+	"Wrapybara::#{element.camelize}".constantize.new(identifier, scope, how).send("#{expectation}_have_content", content)
+end
+
+# table content
+Given /^(head|body)?\s?row (\d+) column (\d+) of the table (labeled|identified by) "([^"]+)"(?: (?:in|within) "([^"]+)")? (should|should not) have content "([^"]+)"$/ do |element, row, column, how, identifier, scope, expectation, content|
+	element ||= 'body'
+	expectation.gsub!(' ', '_')
+	Wrapybara::Table.new(identifier, scope, how).send(element).cell(row, column).send("#{expectation}_have_content", content)
+end
+
+# other elements in table cells
+Given /^(head|body)?\s?row (\d+) column (\d+) of the table (labeled|identified by) "([^"]+)"(?: (?:in|within) "([^"]+)")? (should|should not) contain a[n]? (.+) (labeled|identified by) "([^"]+)"$/ do |element, row, column, how, identifier, scope, expectation, child_element, child_how, child_identifier|
+	element ||= 'body'
+	expectation.gsub!(' ', '_')
+	Wrapybara::Table.new(identifier, scope, how).send(element).cell(row, column).send("#{expectation}_contain", child_element, child_identifier, child_how)
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: wrapybara
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Phillip Koebbe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-20 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Wrapybara creates objects that are based on Capybara.
+email: phillipkoebbe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- lib/wrapybara.rb
+- lib/wrapybara/element.rb
+- lib/wrapybara/elements/attribute.rb
+- lib/wrapybara/elements/button.rb
+- lib/wrapybara/elements/checkbox.rb
+- lib/wrapybara/elements/content.rb
+- lib/wrapybara/elements/file_field.rb
+- lib/wrapybara/elements/fillable_field.rb
+- lib/wrapybara/elements/form.rb
+- lib/wrapybara/elements/image.rb
+- lib/wrapybara/elements/label.rb
+- lib/wrapybara/elements/link.rb
+- lib/wrapybara/elements/option.rb
+- lib/wrapybara/elements/password_field.rb
+- lib/wrapybara/elements/radio_button.rb
+- lib/wrapybara/elements/select.rb
+- lib/wrapybara/elements/table.rb
+- lib/wrapybara/elements/table_body.rb
+- lib/wrapybara/elements/table_cell.rb
+- lib/wrapybara/elements/table_head.rb
+- lib/wrapybara/elements/text_area.rb
+- lib/wrapybara/elements/text_field.rb
+- lib/wrapybara/ext/focus_tracking.js
+- lib/wrapybara/ext/focus_tracking.rb
+- lib/wrapybara/methods.rb
+- lib/wrapybara/steps.rb
+- LICENSE.txt
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/phillipkoebbe/wrapybara
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An object wrapper around Capybara.
+test_files: []
+