terminus_spec 0.5.0

data/lib/terminus_spec/locators.rb

@@ -0,0 +1,23 @@
+module TerminusSpec
+  module Locators
+    
+    # Returns a link object.
+    # @param [Hash] locator how the link can be found
+    def link_web_object(locator)
+      @platform.get_link_for(locator.clone)
+    end
+    
+    # Returns a text field object.
+    # @param [Hash] locator how the link can be found
+    def text_field_web_object(locator)
+      @platform.get_text_field_for(locator.clone)
+    end
+    
+    # Returns a button object.
+    # @param [Hash] locator how the button can be found
+    def button_web_object(locator)
+      @platform.get_button_for(locator.clone)
+    end
+    
+  end # module Locators
+end # module TerminusSpec

data/lib/terminus_spec/logger.rb

@@ -0,0 +1,7 @@
+module TerminusSpec
+  
+  def self.trace(message, level=2)
+    puts("*" * level + " #{message}") if ENV['TRACE'] == 'on'
+  end
+  
+end # module TerminusSpec

data/lib/terminus_spec/matchers.rb

@@ -0,0 +1,41 @@
+module TerminusSpec
+  module Matchers
+    
+    RSpec::Matchers.define :have_title do |text|
+      match do |the_page|
+        the_page =~ Regexp.new(text)
+      end
+      
+      failure_message_for_should do |actual|
+        "Expected that '#{text}' would be the title of the page; found '#{actual}' instead."
+      end
+      
+      failure_message_for_should_not do |actual|
+        "Expected that '#{text}' would not be the title of the page; it was, however."
+      end
+      
+      description do
+        "checking for a title of #{text}"
+      end
+    end
+    
+    RSpec::Matchers.define :contain do |text|
+      match do |the_page|
+        the_page =~ Regexp.new(text)
+      end
+      
+      failure_message_for_should do |actual|
+        "Expected that '#{text}' would be in the page content; it was not found."
+      end
+      
+      failure_message_for_should_not do |actual|
+        "Expected that '#{text}' would not be in the page content; it was, however."
+      end
+      
+      description do
+        "checking for #{text}"
+      end
+    end
+    
+  end # module Matchers
+end # module TerminusSpec

data/lib/terminus_spec/platform_selenium.rb

@@ -0,0 +1,18 @@
+module TerminusSpec
+  module Platforms
+    module SeleniumWebDriver
+      
+      def self.create_platform_object_for(browser)
+        require 'terminus_spec/platform_selenium/platform_object'
+        return SeleniumWebDriver::PlatformObject.new(browser)
+      end
+      
+      def self.works_for?(browser)
+        browser.is_a?(Selenium::WebDriver::Driver)
+      end
+      
+    end # module SeleniumWebDriver
+  end # module Platforms
+end # module TerminusSpec
+
+TerminusSpec::Platforms.associate(:selenium_webdriver, TerminusSpec::Platforms::SeleniumWebDriver)

data/lib/terminus_spec/platform_selenium/platform_object.rb

@@ -0,0 +1,214 @@
+module TerminusSpec
+  module Platforms
+    module SeleniumWebDriver
+      
+      class PlatformObject
+        
+        attr_reader :browser
+        
+        def initialize(browser)
+          @browser = browser
+        end
+        
+        # Platform method to navigate to a specified URL.
+        # See TerminusSpec#navigate_to
+        def navigate_to(url)
+          @browser.navigate.to url
+        end
+        
+        # Platform method to retrieve the title for the current page.
+        # See TerminusSpec#title
+        def title
+          @browser.title
+        end
+        
+        # Platform method to retrieve text from the current page.
+        # See TerminusSpec#text
+        def text
+          @browser.find_element(:tag_name, 'body').text
+        end
+        
+        # Platform method to retrieve the HTML markup for the current page.
+        # See TerminusSpec#html
+        def html
+          @browser.page_source
+        end
+        
+        # Platform method to get the current URL.
+        # See TerminusSpec#current_url
+        def current_url
+          @browser.current_url
+        end
+        
+        # Platform method to refresh the page.
+        # See TerminusSpec#refresh
+        def refresh
+          @browser.navigate.refresh
+        end
+        
+        # Platform method to go to the preceding page in history.
+        # See TerminusSpec#back
+        def back
+          @browser.navigate.back
+        end
+        
+        # Platform method to go to the succeeding page in history.
+        # See TerminusSpec#forward
+        def forward
+          @browser.navigate.forward
+        end
+        
+        # Platform method to clear the cookies from the browser.
+        # See TerminusSpec#clear_cookies
+        def clear_cookies
+          @browser.manage.delete_all_cookies
+        end
+        
+        # Platform method to save the current screenshot to a file.
+        # See TerminusSpec#save_screenshot
+        def save_screenshot(file_name)
+          @browser.save_screenshot(file_name)
+        end
+        
+        # Platform method to wait for a condition on a page to be true.
+        # See TerminusSpec#wait_until
+        def wait_until(timeout, message, &block)
+          wait = Selenium::WebDriver::Wait.new({:timeout=>timeout, :message=>message})
+          wait.until(&block)
+        end
+        
+        # Platform method to handle an alert popup message box.
+        # See TerminusSpec#alert
+        def will_alert(&block)
+          @browser.execute_script "window.alert = function(msg) { window.__lastWatirAlert = msg; }"
+          yield
+          value = @browser.execute_script "return window.__lastWatirAlert"
+          value
+        end
+        
+        # Platform method to handle an confirmation popup message box.
+        # See TerminusSpec#will_confirm
+        def will_confirm(response, &block)
+          @browser.execute_script "window.confirm = function(msg) { window.__lastWatirConfirm=msg; return #{!!response} }"
+          yield
+          value = @browser.execute_script "return window.__lastWatirConfirm"
+          value
+        end
+        
+        # Platform method to handle a prompt popup message box.
+        # See TerminusSpec#will_prompt
+        def will_prompt(response, &block)
+          @browser.execute_script "window.prompt = function(text, value) { window.__lastWatirPrompt = { message: text, default_value: value }; return #{response.to_json}; }"
+          yield
+          result = @browser.execute_script "return window.__lastWatirPrompt"
+          result && result.dup.each_key { |k| result[k.to_sym] = result.delete(k) }
+          result
+        end
+        
+        # Platform method to attach to a displayed window.
+        # See TerminusSpec#attach_to_window
+        def attach_to_window(identifier, &block)
+          value = identifier.values.first
+          key = identifier.keys.first
+          handles = @browser.window_handles
+          handles.each do |handle|
+            @browser.switch_to.window handle
+            if (key == :title and value == @browser.title) or (key == :url and value == @browser.current_url)
+              return @browser.switch_to.window handle, &block
+            end
+          end
+        end
+        
+        # Platform method to return a link object.
+        # Link objects are of type: TerminusSpec::WebObjects::Link
+        # See TerminusSpec::Generators#link
+        def get_link_for(locator)
+          key, value = get_platform_locator_for(locator, WebObjects::Link, 'a')
+          web_object = @browser.find_element(key, value)
+          WebObjects::Link.new(web_object, :platform => :selenium_webdriver)
+        end
+        
+        # Platform method to click a link object.
+        # See TerminusSpec::Generators#link
+        def click_link_for(locator)
+          key, value = get_platform_locator_for(locator, WebObjects::Link, 'a')
+          @browser.find_element(key, value).click
+        end
+        
+        # Platform method to return a text field object.
+        # Text field objects are of type: TerminusSpec::WebObjects::TextField
+        # See TerminusSpec::Generators#text_field
+        def get_text_field_for(locator)
+          key, value = get_platform_locator_for(locator, WebObjects::TextField, 'input', :type => 'text')
+          web_object = @browser.find_element(key, value)
+          WebObjects::TextField.new(web_object, :platform => :selenium_webdriver)
+        end
+        
+        # Platform method to get the value in a text field object.
+        # See TerminusSpec::Generators#text_field
+        def get_text_field_value_for(locator)
+          key, value = get_platform_locator_for(locator, WebObjects::TextField, 'input', :type => 'text')
+          value = @browser.find_element(key, value).attribute('value')
+          value
+        end
+        
+        # Platform method to set a value in a text field object.
+        # See TerminusSpec::Generators#text_field
+        def set_text_field_value_for(locator, text)
+          key, value = get_platform_locator_for(locator, WebObjects::TextField, 'input', :type => 'text')
+          @browser.find_element(key, value).clear
+          @browser.find_element(key, value).send_keys(text)
+        end
+        
+        # Platform method to return a button object.
+        # Button objects are of type: TerminusSpec::WebObjects::Button
+        # See TerminusSpec::Generators#button
+        def get_button_for(locator)
+          key, value = get_platform_locator_for(locator, WebObjects::Button, 'input', :type => 'submit')
+          web_object = @browser.find_element(key, value)
+          WebObjects::Button.new(web_object, :platform => :selenium_webdriver)
+        end
+        
+        # Platform method to click a button object.
+        # See TerminusSpec::Generators#button
+        def click_button_for(locator)
+          key, value = get_platform_locator_for(locator, WebObjects::Button, 'input', :type => 'submit')
+          @browser.find_element(key, value).click
+        end
+        
+        protected
+        
+        def get_platform_locator_for(locator, web_object, tag=nil, qualifier=nil)
+          locator = qualify_with_tagname_for locator, tag, qualifier if tag
+          key, value = web_object.have_selenium_find_object_with locator
+          return key, value
+        end
+        
+        def qualify_with_tagname_for(locator, tag, qualifier=nil)
+          return locator if locator.length < 2 and support_is_provided_for locator, tag, qualifier
+          locator[:tag_name] = tag
+          if qualifier
+            qualifier.each do |key, value|
+              locator[key] = value
+            end
+          end
+          locator
+        end
+        
+        def support_is_provided_for(locator, tag, qualifier)
+          return false if locator[:index]
+          return false if locator[:text] and tag == 'input' and qualifier[:type] == 'hidden'
+          return false if locator[:href] and tag == 'a'
+          return false if locator[:text] and ['div', 'span', 'td'].include? tag
+          return false if locator[:value] and tag == 'input' and qualifier[:type] == 'submit'
+          return false if locator[:value] and tag == 'input' and qualifier[:type] == 'radio'
+          true
+        end
+        
+      end # class PlatformObject
+      
+    end # module SeleniumWebDriver
+  end # module Platforms
+end # module TerminusSpec
+
+Dir["#{File.dirname(__FILE__)}/../web_objects/**/*.rb"].each { |file| require file }

data/lib/terminus_spec/platform_selenium/web_objects/all.rb

@@ -0,0 +1,98 @@
+module TerminusSpec
+  module Platforms
+    module SeleniumWebDriver
+      module WebObject
+        
+        def ==(other)
+          @web_object == other # other.element??
+        end
+        
+        def visible?
+          @web_object.displayed?
+        end
+        
+        def exists?
+          nil != @web_object
+        end
+        
+        def text
+          @web_object.text
+        end
+        
+        def value
+          @web_object.attribute('value')
+        end
+        
+        def tag_name
+          @web_object.tag_name
+        end
+        
+        def clear
+          @web_object.clear
+        end
+        
+        def right_click
+          @web_object.context_click
+        end
+        
+        # Send keystrokes to the object.
+        # @param [String, Symbol, Array]
+        # @examples
+        #  web_object.send_keys "test"    #=> value: 'foo'
+        #  web_object.send_keys "tet", :arrow_left, "s"    #=> value: 'test'
+        #  web_object.send_keys [:control, 'a'], :space    #=> value: ' '
+        # @see Selenium::WebDriver::Keys::KEYS
+        def send_keys(*args)
+          @web_object.send_keys(*args)
+        end
+        
+        # Waits until an object is present on the screen.
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        def when_present(timeout=5)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Object not present in #{timeout} seconds"})
+          wait.until do
+            self.exists?
+          end
+          self
+        end
+        
+        # Waits until an object is visible on the screen.
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        def when_visible(timeout=5)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Object not present in #{timeout} seconds"})
+          wait.until do
+            self.visible?
+          end
+          self
+        end
+        
+        # Waits until an object is not visible on the screen.
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        def when_not_visible(timeout=5)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => "Object not present in #{timeout} seconds"})
+          wait.until do
+            not self.visible?
+          end
+          self
+        end
+        
+        # Waits until a given returns true (and thus was executed).
+        # @param [Integer] (defaults to: 5) seconds to wait before timing out
+        # @param [String] the message to display if the event times out
+        # @param the block to execute when the event occurs
+        def wait_until(timeout=5, message=nil, &block)
+          wait = Object::Selenium::WebDriver::Wait.new({:timeout => timeout, :message => message})
+          wait.until(&block)
+        end
+        
+        # Get the value of a the given attribute of the object.
+        # @param [String] attribute name
+        # @return [String,nil] attribute value
+        def attribute(attribute_name)
+          @web_object.attribute attribute_name
+        end
+        
+      end # module WebObject
+    end # module SeleniumWebDriver
+  end # module Platforms
+end # module TerminusSpec

data/lib/terminus_spec/platform_selenium/web_objects/button.rb

@@ -0,0 +1,13 @@
+module TerminusSpec
+  module Platforms
+    module SeleniumWebDriver
+      module Button
+        
+        def text
+          raise "Returning text from a button element in Selenium is not possible."
+        end
+        
+      end # module Button
+    end # module SeleniumWebDriver
+  end # module Platforms
+end # module TerminusSpec

data/lib/terminus_spec/platform_selenium/web_objects/link.rb

@@ -0,0 +1,13 @@
+module TerminusSpec
+  module Platforms
+    module SeleniumWebDriver
+      module Link
+        
+        def value
+          raise "Returning value from a link element in Selenium is not possible."
+        end
+        
+      end # module Link
+    end # module SeleniumWebDriver
+  end # module Platforms
+end # module TerminusSpec

data/lib/terminus_spec/platform_selenium/web_objects/text_field.rb

@@ -0,0 +1,14 @@
+module TerminusSpec
+  module Platforms
+    module SeleniumWebDriver
+      module TextField
+        
+        def value=(this)
+          @web_object.clear
+          @web_object.send_keys(this)
+        end
+        
+      end # module TextField
+    end # module SeleniumWebDriver
+  end # module Platforms
+end # module TerminusSpec