wrapybara 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Phillip Koebbe
+
+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.rdoc

@@ -0,0 +1,19 @@
+= wrapybara
+
+Description goes here.
+
+== Contributing to wrapybara
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Phillip Koebbe. See LICENSE.txt for
+further details.
+

data/lib/wrapybara.rb

@@ -0,0 +1,2 @@
+require 'wrapybara/steps'
+require 'wrapybara/methods'

data/lib/wrapybara/element.rb

@@ -0,0 +1,150 @@
+module Wrapybara
+	module Element
+		def get_element(xpath, scope)
+			if scope
+				# if scope starts with '/html', let's assume (for now) that it's already an xpath
+				unless scope =~ /^\/html/
+					# if there are multiple scopes (ie, "div1 div2 para1"), the following makes 
+					# xpath look like "id('div1')/*[@id='div2']/*[@id='para1']"
+
+					scope = scope.split(' ')
+					id = scope.shift
+					scope = "id('#{id}')" + scope.inject('') { |output, s| output += "//*[@id='#{s}']" }
+				end
+
+				# xpath might come in like //something, and since we would be looking for an element
+				# in the scope of another element, we need to make sure we aren't looking at the whole
+				# document by adding the dot at the beginning
+				xpath = ".#{xpath}" if xpath[0..1] == '//'
+				Capybara.find(scope).find(xpath) rescue nil
+			else
+				Capybara.find(xpath) rescue nil
+			end
+		end
+		
+		def element
+			@element
+		end
+		
+		def path
+			element.path
+		end
+		
+		def style
+			element[:style] || ''
+		end
+
+		def click
+			element.click
+		end
+		
+		def exists?
+			!@element.nil?
+		end
+
+		def should_exist(message = nil)
+			message ||= "Expected element #{self.element_identifier} to exist"
+			raise UnmetExpectation, message unless self.exists?
+		end
+
+		def should_not_exist(message = nil)
+			message ||= "Did not expect element #{self.element_identifier} to exist"
+			raise UnmetExpectation, message if self.exists?
+		end
+		
+		def should_have_attribute(attribute, value = nil)
+			the_attribute = Attribute.new(self, attribute)
+			the_attribute.should_exist
+			the_attribute.value.should_be value if value
+		end
+		
+		def should_not_have_attribute(attribute, value = nil)
+			the_attribute = Attribute.new(self, attribute)
+			if value
+				the_attribute.should_exist
+				the_attribute.value.should_not_be value
+			else
+				the_attribute.should_not_exist
+			end
+		end
+		
+		def enabled?
+			!disabled?
+		end
+		
+		def disabled?
+			self.should_exist
+			['true', 'disabled'].include?(@element[:disabled])
+		end
+		
+		def should_be_enabled
+			message = "Expected element #{self.element_identifier} to be enabled"
+			raise UnmetExpectation, message unless self.enabled?
+		end
+		
+		def should_not_be_enabled
+			message = "Did not expect element #{self.element_identifier} to be enabled"
+			raise UnmetExpectation, message if self.enabled?
+		end
+		
+		def should_be_disabled
+			message = "Expected element #{self.element_identifier} to be disabled"
+			raise UnmetExpectation, message unless self.disabled?
+		end
+		
+		def should_not_be_disabled
+			message = "Did not expect element #{self.element_identifier} to be disabled"
+			raise UnmetExpectation, message if self.disabled?
+		end
+		
+		def visible?
+			self.should_exist
+			
+			# determining visibility of something is challenging, to say the least. this approach is to start with the subject element
+			# and check its style attribute for display: none or visibility: hidden. if neither is found, work backward up the
+			# object hierarchy checking each parent.
+			
+			return false if self.style.downcase.gsub(' ', '') =~ /(display:none|visibility:hidden)/
+
+			parent = get_element(self.path + '/..', nil)
+			while parent && parent.path != '/html'
+				style = parent[:style] || ''
+				return false if style.downcase.gsub(' ', '') =~ /(display:none|visibility:hidden)/
+				parent = get_element(parent.path + '/..', nil)
+			end
+			
+			return true
+		end
+		
+		def should_be_visible
+			message = "Expected content #{self.element_identifier} to be visible"
+			raise UnmetExpectation, message unless self.visible?
+		end
+		
+		def should_not_be_visible
+			message = "Did not expect content #{self.element_identifier} to be visible"
+			raise UnmetExpectation, message if self.visible?
+		end
+		
+		def within(scope)
+			scope ? " within '#{scope}'" : ''
+		end
+		
+		def element_identifier
+			"#{@how} '#{@identifier}'#{self.within(@scope)}"
+		end
+		
+		def parent_identifier
+			return '' unless @parent
+			"#{@parent.how} '#{@parent.identifier}'#{self.within(@parent.scope)}"
+		end
+		
+		def default_scope
+			nil
+		end
+		
+		def default_how
+			'labeled'
+		end
+	end
+end

data/lib/wrapybara/elements/attribute.rb

@@ -0,0 +1,32 @@
+module Wrapybara
+	class Attribute
+		include Element
+		
+		def initialize(parent, attribute)
+			@parent = parent
+			@attribute = attribute
+		end
+		
+		def value
+			self
+		end
+		
+		def should_exist
+			raise UnmetExpectation, "Expected element #{self.parent_identifier} to have attribute '#{@attribute}'" if @parent.element[@attribute].nil?
+		end
+		
+		def should_not_exist
+			raise UnmetExpectation, "Did not expect element #{self.parent_identifier} to have attribute '#{@attribute}'" unless @parent.element[@attribute].nil?
+		end
+		
+		def should_be(value)
+			message = "Expected element #{self.parent_identifier} to have attribute '#{@attribute}' with value '#{value}'"
+			raise UnmetExpectation, message unless @parent.element[@attribute] == value
+		end
+		
+		def should_not_be(value)
+			message = "Did not expect element #{self.parent_identifier} to have attribute '#{@attribute}' with value '#{value}'"
+			raise UnmetExpectation, message if @parent.element[@attribute] == value
+		end
+	end
+end

data/lib/wrapybara/elements/button.rb

@@ -0,0 +1,27 @@
+module Wrapybara
+	class Button
+		include Element
+		
+		def initialize(identifier, scope = default_scope, how = default_how)
+			@identifier = identifier
+			@how = how
+			@scope = scope
+			xpath = XPath::HTML.button(identifier)
+			@element = get_element(xpath, scope)
+		end
+		
+		def should_exist
+			super "Expected a button #{self.element_identifier} to exist"
+		end
+
+		def should_not_exist
+			super "Did not expect a button #{self.element_identifier}' to exist"
+		end
+
+		def click
+			self.should_exist
+			# Capybara method
+			@element.click
+		end
+	end
+end

data/lib/wrapybara/elements/checkbox.rb

@@ -0,0 +1,49 @@
+module Wrapybara
+	class Checkbox
+		include Element
+		
+		def initialize(identifier, scope = default_scope, how = default_how)
+			@identifier = identifier
+			@how = how
+			@scope = scope
+			xpath = XPath::HTML.checkbox(identifier)
+			@element = get_element(xpath, scope)
+		end
+		
+		def should_exist
+			super "Expected a checkbox #{self.element_identifier} to exist"
+		end
+
+		def should_not_exist
+			super "Did not expect a checkbox #{self.element_identifier}' to exist"
+		end
+
+		def set(state)
+			self.should_exist
+			# Capybara method
+			@element.set(state)
+		end
+		
+		def check
+			self.set(true)
+		end
+		
+		def uncheck
+			self.set(false)
+		end
+		
+		def checked?
+			self.should_exist
+			# Capybara method
+			@element.checked?
+		end
+
+		def should_be_checked
+			raise UnmetExpectation, "Expected a checkbox #{self.element_identifier} to be checked" unless self.checked?
+		end
+
+		def should_not_be_checked
+			raise UnmetExpectation, "Did not expect a checkbox #{self.element_identifier} to be checked" if self.checked?
+		end
+	end
+end

data/lib/wrapybara/elements/content.rb

@@ -0,0 +1,33 @@
+module Wrapybara
+	class Content
+		include Element
+		
+		def initialize(identifier, scope = default_scope)
+			@identifier = identifier
+			@scope = scope
+			#xpath = XPath::HTML.content(identifier)
+			# the %{} string notation is used so double quotes can offset identifier, allowing identifier to contain single quotes/apostrophes.
+			# also important to note is that this xpath requires text to be contained in something (div, p, span). any text just floating around
+			# on the page will show up with a path of //html, which is not terribly useful later on.
+			xpath = %{//*[contains(text(), "#{identifier}")]}
+			@element = get_element(xpath, scope)
+		end
+
+		def click
+			self.should_be_visible
+			super
+		end
+		
+		def should_exist
+			super "Expected content #{self.element_identifier} to exist"
+		end
+
+		def should_not_exist
+			super "Did not expect content #{self.element_identifier} to exist"
+		end
+
+		def element_identifier
+			"'#{@identifier}'#{self.within(@scope)}"
+		end
+	end
+end

data/lib/wrapybara/elements/file_field.rb

@@ -0,0 +1,27 @@
+module Wrapybara
+	class FileField
+		include Element
+		
+		def initialize(identifier, scope = default_scope, how = default_how)
+			@identifier = identifier
+			@how = how
+			@scope = scope
+			xpath = XPath::HTML.file_field(identifier)
+			@element = get_element(xpath, scope)
+		end
+		
+		def attach_file(path)
+			self.should_exist
+			# Capybara method
+			@element.set(path)
+		end
+		
+		def should_exist
+			super "Expected a file field #{self.element_identifier} to exist"
+		end
+
+		def should_not_exist
+			super "Did not expect a file field #{self.element_identifier}' to exist"
+		end
+	end
+end

data/lib/wrapybara/elements/fillable_field.rb

@@ -0,0 +1,46 @@
+module Wrapybara
+	module FillableField
+		def fill_in(value)
+			self.should_exist
+			# Capybara method
+			@element.set(value)
+		end
+
+		def value
+			self.should_exist
+			(@element.value || '').strip
+		end
+		
+		def empty?
+			self.value == ''
+		end
+
+		def should_be_empty
+			raise UnmetExpectation, "Expected text field #{self.element_identifier} to be empty" unless self.empty?
+		end
+
+		def should_not_be_empty
+			raise UnmetExpectation, "Did not expect text field #{self.element_identifier} to be empty" if self.empty?
+		end
+
+		def has_content?(content)
+			self.value =~ /#{content}/
+		end
+
+		def should_have_content(content)
+			if content.blank?
+				self.should_be_empty
+			else
+				raise UnmetExpectation, "Expected text field #{self.element_identifier} to have content '#{content}'" unless self.has_content?(content)
+			end
+		end
+
+		def should_not_have_content(content)
+			if content.blank?
+				self.should_not_be_empty
+			else
+				raise UnmetExpectation, "Did not expect text field #{self.element_identifier} to have content '#{content}'" if self.has_content?(content)
+			end
+		end
+	end
+end

data/lib/wrapybara/elements/form.rb

@@ -0,0 +1,21 @@
+module Wrapybara
+	class Form
+		include Element
+		
+		def initialize(identifier, scope = default_scope, how = default_how)
+			@identifier = identifier
+			@how = how
+			@scope = scope
+			xpath = "id('#{identifier}') | id(//label[contains(normalize-space(string(.)), '#{identifier}')]/@for)"
+			@element = get_element(xpath, scope)
+		end
+		
+		def should_exist
+			super "Expected a form #{self.element_identifier} to exist"
+		end
+
+		def should_not_exist
+			super "Did not expect a form #{self.element_identifier}' to exist"
+		end
+	end
+end

data/lib/wrapybara/elements/image.rb

@@ -0,0 +1,23 @@
+module Wrapybara
+	class Image
+		include Element
+		
+		attr_reader :element, :identifier, :how, :scope
+		
+		def initialize(identifier, scope = default_scope, how = default_how)
+			@identifier = identifier
+			@how = how
+			@scope = scope
+			xpath = "//img[@src='#{identifier}' or @id='#{identifier}' or @title='#{identifier}' or @alt='#{identifier}']"
+			@element = get_element(xpath, scope)
+		end
+		
+		def should_exist
+			super "Expected an image #{self.element_identifier} to exist"
+		end
+
+		def should_not_exist
+			super "Did not expect an image #{self.element_identifier}' to exist"
+		end
+	end
+end