terminus_spec 0.5.0

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+.bundle/*
+Gemfile.lock
+pkg/*
+chromedriver.log
+results.html
+
+# subversion
+.svn/*
+
+# scov/rcov generated
+coverage/*
+
+# komodo
+*.komodoproject
+.komodotools/*
+
+# rubymine
+.idea/*
+
+# linux swap files
+*.swp
+*.swo
+
+# mac file finder
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_install_on_use_flag=1
+rvm --create use ruby-1.9.2@terminus_spec

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+    - 1.9.2
+
+notifications:
+    recipients:
+        - jeffnyman@gmail.com

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Adding rake so travis-ci will build and run tests properly.
+gem 'rake'
+
+# Specify your gem's dependencies in terminus_spec.gemspec
+gemspec

data/HISTORY.md

@@ -0,0 +1,54 @@
+Change Log and History
+======================
+
+## Version 0.1.0 / 2011-11-11
+
+Alpha phase. TermniusSpec can be bundled up as a gem.
+
+* Browser-Level Actions Supported:
+  * title
+  * text
+  * html
+  * current url
+  * refresh
+  * back
+  * forward
+  * clear cookies
+  * save screenshot
+  * navigate to
+  * will alert (handles alert message boxes)
+  * will prompt (handles prompt message boxes)
+  * will confirm (handles confirmation message boxes)
+  * attach to window
+
+* Web Objects Supported:
+  * links
+  * text fields
+  * buttons
+
+* Timing Elements Supported:
+  * wait until
+  * when present
+  * when exists
+  * when visible
+  * when not visible
+  
+
+## Version 0.0.4 / 2011-11-10
+
+Getting ready for an alpha phase. The basic structure of platform objects, web objects, generators, and locators has been put in place. RSpec tests are running. Cucumber framework was put in place and found to be working. Sample application has been updated to allow for more specific testing and the Cucumber framework is being started over.
+
+
+## Version 0.0.3 / 2011-11-08
+
+Generated the framework that will allow TerminusSpec to be tested both via RSpec and Cucumber. The Cucumber testing has been designed to match the structure of how exectuable specifications will be used with Terminus as an application. The PlatformObject concept was put in place.
+
+
+## Version 0.0.2 / 2011-11-07
+
+Added a test application as part of the framework. This included adding in a sample test project. This will not only show how Cucumber should be used with Terminus but also give a way to test the application at a system level.
+
+
+## Version 0.0.1 / 2011-11-07
+
+Initial creation of the gem framework.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jeff Nyman
+
+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.md

@@ -0,0 +1,13 @@
+# TerminusSpec [![Build Status](https://secure.travis-ci.org/jnyman/terminus_spec.png)](http://travis-ci.org/jnyman/terminus_spec)
+
+This gem is designed to provide a testing framework for creating executable test specifications.
+
+
+## Credits
+
+Thanks to Jeff Morgan (http://www.cheezyworld.com/) for his page-object gem and Alister Scott (http://watirmelon.com) for his watir-page-helper gem. I learned a lot from analyzing their code and working to craft my own solution around theirs. Rather than fork their projects, my changes were systemic enough to warrant creating a new project.
+
+
+## Copyright
+
+Copyright (c) 2011 Jeff Nyman. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+server_process = nil
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :spec
+
+task :start_server do
+  root = Dir.pwd
+  Dir.chdir(Dir.pwd + '/specs/app/')
+  server_process = IO.popen('ruby server.rb')
+  Dir.chdir(root)
+end
+
+task :stop_server do
+  IO.popen("taskkill /pid #{server_process.pid} /f /t > NUL 2>&1")
+end
+
+namespace :specs do
+  
+  Cucumber::Rake::Task.new(:watir_webdriver, "Run specs with Watir") do |config|
+    config.profile = 'watir'
+  end
+  
+  Cucumber::Rake::Task.new(:selenium_webdriver, "Run specs with Selenium") do |config|
+    config.profile = 'selenium'
+  end
+  
+  desc 'Run all Cucumber specs'
+  task :all => [:watir_webdriver, :selenium_webdriver]
+  task :watir => [:start_server, :watir_webdriver, :stop_server]
+  task :selenium => [:start_server, :selenium_webdriver, :stop_server]
+end
+
+desc 'Run all RSpec and Cucumber tests'
+task :test => ['spec', 'specs:all']
+
+task :default => :spec

data/cucumber.yml

@@ -0,0 +1,6 @@
+default: DRIVER=watir BROWSER=firefox -r specs/engine/borg.rb -r specs specs
+
+watir: DRIVER=watir BROWSER=firefox --no-source --color --format pretty --tags ~@selenium -r specs/engine/borg.rb -r specs specs
+selenium: DRIVER=selenium BROWSER=firefox --no-source --color --format pretty --tags ~@watir -r specs/engine/borg.rb -r specs specs
+
+# --format html -o results.html

data/lib/terminus_spec.rb

@@ -0,0 +1,200 @@
+require 'terminus_spec/version'
+require 'terminus_spec/logger'
+require 'terminus_spec/matchers'
+require 'terminus_spec/platforms'
+require 'terminus_spec/generators'
+require 'terminus_spec/locators'
+
+module TerminusSpec
+  include Matchers
+  include Platforms
+  include Locators
+  
+  # @return [Watir::Browser] the platform browser
+  # @return [Selenium::WebDriver::Driver] the platform browser
+  attr_reader :browser
+  
+  # @return [TerminusSpec::Platforms::WatirWebDriver::PlatformObject] the platform object
+  # @return [TerminusSpec::Platforms::SeleniumWebDriver::PlatformObject] the platform object
+  attr_reader :platform
+  
+  # This makes sure that any page classes that include TerminusSpec will be
+  # given access to the generator methods based on web objects that are
+  # declared in the page class.
+  def self.included(caller)
+    caller.extend TerminusSpec::Generators
+  end
+  
+  # Creates a platform object.
+  # @param [Watir::Browser or Selenium::WebDriver::Driver] the platform browser to use
+  def initialize(browser, visit=nil)
+    @browser = browser
+    establish_platform_driver_for browser
+    setup_page if respond_to?(:setup_page)
+    goto if visit && respond_to?(:goto)
+  end
+  
+  # Navigate to the specified URL. The URL can be specified as a domain
+  # address or as a file-based link.
+  # @param [String] the full URL to navigate to
+  def navigate_to(url)
+    @platform.navigate_to url
+  end
+  
+  # Returns the text of the current page.
+  def text
+    @platform.text
+  end
+  
+  # Returns the title of the current page as displayed in the browser.
+  def title
+    @platform.title
+  end
+  
+  # Returns the html of the current page
+  def html
+    @platform.html
+  end
+  
+  # Returns the current page URL.
+  def current_url
+    @platform.current_url
+  end
+  
+  # Refreshes the current page.
+  def refresh
+    @platform.refresh
+  end
+  
+  # Goes back to the preceding page in history.
+  def back
+    @platform.back
+  end
+  
+  # Goes forward to the succeeding page in history.
+  def forward
+    @platform.forward
+  end
+  
+  # Clears the cookies from the browser.
+  def clear_cookies
+    @platform.clear_cookies
+  end
+  
+  # Saves the current screenshot to a provided URL. The file
+  # will be saved as a PNG file.
+  def save_screenshot(file_name)
+    @platform.save_screenshot file_name
+  end
+  
+  # Waits until a condition is found to be true or a timeout occurs.
+  #
+  # @param [Numeric] the amount of time to wait for the condition to return true.
+  # @param [String] the message to include with the error if the timeout duration is exceeded.
+  # @param block the logic to execute.
+  #
+  # @example
+  #   page.wait_until(3, 'Record Saved message was not found.') do
+  #     page.text.should match(/^Record Saved$/)
+  #   end
+  def wait_until(timeout=15, message=nil, &block)
+    @platform.wait_until(timeout, message, &block)
+  end
+  
+  # Captures the execution of an alert popup.
+  #
+  # @param block the action that will cause the alert to display
+  # @return [String] the message that was contained in the alert
+  #
+  # @example
+  #   message = page.will_alert do
+  #     page.submit
+  #   end
+  def will_alert(&block)
+    @platform.will_alert(&block)
+  end
+  
+  # Captures the execution of a confirmation popup.
+  #
+  # @param [bool] what response you want to return back from the confirmation popup
+  # @param block the action that will cause the confirmation to display
+  # @return [String] the message that was prompted in the confirmation
+  #
+  # @example
+  #   message = page.will_confirm(true) do
+  #     page.submit
+  #   end
+  def will_confirm(response, &block)
+    @platform.will_confirm(response, &block)
+  end
+  
+  # Captures the execution of a prompt popup.
+  #
+  # @param [string] the user entered value that is returned from the prompt
+  # @param block the action that will cause the prompt to display
+  # @return [Hash] A has containing two keys. :message contains the prompt message and
+  # :default_value contains the default value for the prompt if provided
+  #
+  # @example
+  #   message = page.will_prompt("Question") do
+  #     page.submit
+  #   end
+  def will_prompt(response, &block)
+    @platform.will_prompt(response, &block)
+  end
+  
+  # Attaches to a displayed window. The window can be located using either the
+  # title attribute of the window or a direct URL. The URL does not have to be
+  # the entire URL; it can just be a page name (like index.html). Since
+  # attaching to a window can be problematic due to race conditions, a second
+  # try will be attempted if any exceptions occur.
+  #
+  # @param [Hash] either :title or :url of the window.
+  # @param block any code that should be executed before actions taken on the
+  # window that is being attached to
+  #
+  # @example
+  #   page.attach_to_window(:title => "Display Results")
+  #   page.attach_to_window(:url => results.html)
+  def attach_to_window(identifier, &block)
+    begin
+      @platform.attach_to_window(identifier, &block)
+    rescue
+      sleep 2
+      @platform.attach_to_window(identifier, &block)
+    end
+  end
+  
+  # Captures the execution of a model dialog opens that dialog as a window.
+  # The new window can then be attached to.
+  #
+  # @param block the action that will cause the modal dialog
+  #
+  # @example
+  #   page.will_be_modal do
+  #     page.submit
+  #   end
+  def will_be_modal(&block)
+    script =
+    %Q{
+      window.showModalDialog = function(sURL, vArguments, sFeatures) {
+        window.dialogArguments = vArguments;
+        modalWin = window.open(sURL, 'modal', sFeatures);
+        return modalWin;
+      }
+    }
+    browser.execute_script script
+    yield if block_given?
+  end
+  
+  private
+  
+  def establish_platform_driver_for(browser)
+    @platform = platform_for browser, TerminusSpec::Platforms.list
+  end
+  
+  def process_block(&block)
+    block.arity == 1 ? block.call(self) : self.instance_eval(&block)
+  end
+  
+end

data/lib/terminus_spec/factory.rb

@@ -0,0 +1,27 @@
+module TerminusSpec
+  module Factory
+    
+    # This is the method that visits a page object after it has been created.
+    #
+    # @param [PageClass] a class that has included the TerminusSpec module
+    # @param [block] an optional set of logic to be called on the page object
+    # @return [PageObject] a page object
+    def visit(page_class, &block)
+      on page_class, true, &block
+    end
+    
+    # This is the method that creates a page object.
+    #
+    # @param [PageClass] a class that has included the TerminusSpec module
+    # @param [Boolean] a boolean indicating if the page should be visited after
+    # it is created
+    # @param [block] an optional set of logic to be called on the page object
+    # @return [PageObject] a page object
+    def on(page_class, visit=false, &block)
+      @page = page_class.new(@browser, visit)
+      block.call @page if block
+      @page
+    end
+    
+  end # module Factory
+end # module TerminusSpec

data/lib/terminus_spec/generators.rb

@@ -0,0 +1,80 @@
+module TerminusSpec
+  module Generators
+    
+    # Allows you to specify a direct URL as part of a page object.
+    # @param [String] the url for the page.
+    def url_is(url)
+      define_method("goto") do
+        @platform.navigate_to url
+      end
+    end
+    
+    # Create methods to do the following:
+    #   Select a link object.
+    #   Return a link object.
+    # @param [String] identifier how a link will be referred to
+    # @param [Hash] locator how a link will be recognized
+    # @param optional block to be invoked when object method is called
+    def link(identifier, locator=nil, &block)
+      define_method(identifier) do
+        return @platform.click_link_for locator.clone unless block_given?
+        self.send("#{identifier}_object").click
+      end
+      
+      define_method("#{identifier}_object") do
+        return process_block(&block) if block_given?
+        @platform.get_link_for locator.clone
+      end
+      
+      alias_method "#{identifier}_link".to_sym, "#{identifier}_object".to_sym
+    end
+    
+    # Creates methods to do the following:
+    #   Enter text into a text field object
+    #   Get the text that is in a text field object
+    #   Return a text field object.
+    # @param [String] name how a text field will be referred to
+    # @param [Hash] identifier how a text field will be recognized
+    # @param optional block to be invoked when object method is called
+    def text_field(identifier, locator=nil, &block)
+      define_method(identifier) do
+        return @platform.get_text_field_value_for locator.clone unless block_given?
+        self.send("#{identifier}_object").value
+      end
+      
+      define_method("#{identifier}=") do |value|
+        return @platform.set_text_field_value_for(locator.clone, value) unless block_given?
+        self.send("{identifier}_object").value = value
+      end
+      
+      define_method("#{identifier}_object") do
+        return process_block(&block) if block_given?
+        @platform.get_text_field_for locator.clone
+      end
+      
+      alias_method "#{identifier}_text_field".to_sym, "#{identifier}_object".to_sym
+    end
+    
+    
+    # Creates methods to do the following:
+    #   Click a button object.
+    #   Return a button object.
+    # @param [String] name how a button will be referred to
+    # @param [Hash] identifier how a button will be recognized
+    # @param optional block to be invoked when object method is called
+    def button(identifier, locator=nil, &block)
+      define_method(identifier) do
+        return @platform.click_button_for locator.clone unless block_given?
+        self.send("#{identifer}_object").click
+      end
+      
+      define_method("#{identifier}_object") do
+        return process_block(&block) if block_given?
+        @platform.get_button_for locator.clone
+      end
+      
+      alias_method "#{identifier}_button".to_sym, "#{identifier}_object".to_sym
+    end
+    
+  end # module Generators
+end # module TerminusSpec