riess 0.0.8

data/examples/Getting_started_example.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+#gem 'riess'
+require_gem 'riess' # for older gem version
+
+
+ie = InternetExplorer.new
+
+ie.open("http://wiki.riess-automation.com")
+ie.verifyElementText(:search => 'h1[text=~"Welcome"]', :value => 'Welcome to RIESS Wiki')
+ie.click(:search => 'a[text=="Pages"]')
+ie.verifyElementPresent(:id => 'header')
+ie.verifyElementPresent(:name => 'q')
+ie.enterText(:name => 'q', :value => 'RIESS')
+ie.submitForm(:search => 'form')
+ie.verifyElementText(:search => 'h1[text=$"results"]', :value => 'Search results')
+ie.click(:search => 'a[text=="Home"]')
+ie.close

data/lib/actions.rb

@@ -0,0 +1,53 @@
+module RIESS
+
+  class InternetExplorer 
+  
+    def open(url)
+      @ie.navigate url
+    end
+    
+    def close
+      @ie.quit
+    end
+    
+    def enterText(params)
+      html_object(params,:enterText).set_text
+    end
+    
+    def enterTextValue(params)
+      html_object(params,:enterTextValue).set_text_value
+    end
+    
+    def selectOption(params)
+      html_object(params,:selectOption).set_text_value
+    end
+    
+    def selectMultipleOptions(params)
+      html_object(params,:selectMultipleOptions).set_multiple_options
+    end
+    
+    def click(params)
+      html_object(params,:click).click
+    end
+    
+    def simulateKeyPress(params)
+      html_object(params,:simulateKeyPress).simulate_key_press
+    end
+    
+    def submitForm(params)
+      html_object(params,:submitForm).submit_form
+    end
+    
+    def fireEvent(params)
+      html_object(params,:fireEvent).fire_event
+    end
+
+#    
+#    def run_dialog(dialog,command)
+#      dialog_thread = Thread.new { require dialog.to_s }
+#      execute_this_command = command
+#      dialog_thread.join
+#    end
+    
+  end
+end

data/lib/checks.rb

@@ -0,0 +1,39 @@
+module RIESS
+  
+  class InternetExplorer 
+        
+    def verifyElementText(params)
+      html_object(params,:verifyElementText).verify_element_inner_text
+    end
+    
+    def verifyElementHtml(params)
+      html_object(params, :verifyElementHtml).verify_element_inner_html
+    end
+    
+    def verifyElementValue(params)
+      html_object(params,:verifyElementValue).verify_element_value
+    end
+    
+    def verifyElementChecked(params)
+      html_object(params,:verifyElementChecked).verify_element_checked
+    end 
+    
+    def verifyElementNotChecked(params)
+      html_object(params,:verifyElementNotChecked).verify_element_not_checked
+    end 
+    
+    def verifyElementSource(params)
+      html_object(params,:verifyElementSource).verify_element_source
+    end 
+    
+    def verifyElementPresent(params)
+      html_object(params,:verifyElementPresent).verify_element_present
+    end
+    
+    def verifyElementNotPresent(params)
+      html_object(params,:verifyElementNotPresent).verify_element_not_present
+    end
+        
+  end
+  
+end

data/lib/exceptions.rb

@@ -0,0 +1,12 @@
+module RIESS
+  
+  class ElementNotFound < Exception
+  end
+  
+  class ValueNotFound < Exception
+  end
+  
+  class UnexpectedError < Exception
+  end
+  
+end

data/lib/finders.rb

@@ -0,0 +1,129 @@
+module RIESS
+  
+  class LocatorStrategy
+    
+    attr_reader :locator
+    
+    def initialize
+      @locator = {
+        :id => :find_element_by_id,
+        :name => :find_element_by_name,
+        :search => :find_element_by_search,
+        :search_path => :find_element_by_search_path
+      }
+    end
+    
+  end
+  
+  
+   
+  class ElementFinder
+    
+    READYSTATE_UNINITIALIZED = 0
+    READYSTATE_LOADING = 1 
+    READYSTATE_LOADED = 2 
+    READYSTATE_INTERACTIVE = 3
+    READYSTATE_COMPLETE = 4
+    
+    
+    def initialize(ie_object,parameter)
+      @ie_object = ie_object
+      @locator_type = parameter.locator_type
+      @locator_value = parameter.locator_value
+    end
+    
+    def find_element
+      wait_for_page_load
+      send(LocatorStrategy.new.locator[@locator_type])
+    end
+        
+    def wait_for_page_load
+      while @ie_object.readyState < READYSTATE_COMPLETE || @ie_object.Busy || @ie_object.document.readyState != "complete"
+        sleep 0.01
+      end
+    end
+    
+    def find_element_by_id
+      if has_frames?
+        find_element_in_frames('id')   
+      else
+        finder = @ie_object.find_by_id(@locator_value)
+      end
+    end
+  
+    def find_element_by_name
+      if has_frames?
+        find_element_in_frames('name')   
+      else
+        finder = @ie_object.find_by_name(@locator_value)
+      end
+    end
+    
+    def find_element_by_search
+      if has_frames?
+        find_element_in_frames('search')   
+      else
+        finder = @ie_object.search(@locator_value).first
+      end
+    end
+    
+    def find_element_by_search_path
+      if has_frames?
+        find_search_by_frames   
+      else
+        finder = @ie_object.search_path(@locator_value).first
+      end  
+    end
+  
+    private
+    
+    def find_search_by_frames
+      index = find_index_from_path
+      finder = @ie_object.document.frames[index].search_path(@locator_value).first
+    end
+
+    def find_index_from_path
+      result = '0'
+      if @locator_value.split(">").first.match(/^frame(\d+)\s*/)
+        index = $1.to_s
+        result = index
+        alter_path_if_first_element_is_frame
+      end
+      result
+    end
+  
+    def alter_path_if_first_element_is_frame
+      split_array = @locator_value.split(">")
+      # remove frame string from path
+      split_array.shift
+      # remove space from front of first element
+      first_element = split_array.first
+      stripped = first_element.sub(/^\s/,'')
+      split_array.shift
+      split_array.unshift stripped
+      @locator_value = split_array.join(">")
+    end
+
+    def find_element_in_frames(command)
+      number_of_frames = @ie_object.document.frames.length.to_i
+      result_array = []
+      number_of_frames.times{|index|
+        if command == 'id'
+          finder = @ie_object.document.frames[index.to_s].find_by_id(@locator_value)
+        elsif command == 'name'
+          finder = @ie_object.document.frames[index.to_s].find_by_name(@locator_value)
+        elsif command == 'search'
+          finder = @ie_object.document.frames[index.to_s].search(@locator_value).first
+        end
+          result_array <<  finder unless finder.nil?
+        }
+      result_array.empty? ? nil : result_array.first
+    end
+
+    def has_frames?
+      @ie_object.document.frames.length > 1
+    end
+    
+  end
+  
+end

data/lib/helpers.rb

@@ -0,0 +1,115 @@
+module RIESS
+  
+  class Parameter
+    
+    attr_reader :locator_type, :locator_value, :value, :regex
+     
+    def initialize(params)
+      @params = params
+      set_locator_type
+      set_locator_value
+      set_value
+      set_regex
+    end
+     
+    def set_locator_type
+      if @params.keys.include? :id
+        locator_type = :id
+      elsif @params.keys.include? :name
+        locator_type = :name
+      elsif @params.keys.include? :text
+        locator_type = :text
+      elsif @params.keys.include? :search
+        locator_type = :search
+      elsif @params.keys.include? :search_path
+        locator_type = :search_path
+      end
+       @locator_type = locator_type
+    end   
+        
+    def set_locator_value
+      @locator_value = @params[@locator_type]
+    end
+    
+    def set_value
+      @value = @params[:value]
+    end
+    
+    def set_regex
+      if @params.keys.include? :regex
+        regex = @params[:regex]
+      else
+        regex = false
+      end
+      @regex = regex
+    end
+    
+    def parameters
+      @params
+    end
+  end
+  
+  class InternetExplorer
+
+    MAX_ELEMENT_FIND_TIME = 1
+        
+    def html_object(params,method)
+      Log.debug "interface.command\nCommand: #{method} \nParameters: #{params.inspect}\n"
+      element_find_time_start = Time.now
+      parameter = Parameter.new(params)
+
+      element = nil
+      while element.nil? && element_find_time_start + MAX_ELEMENT_FIND_TIME > Time.now      
+          element = ElementFinder.new(@ie, parameter).find_element
+      end
+
+      if element.nil?
+        handle_reporting_if_element_nil(method,parameter) 
+        Missing.new(set_return_value(method))
+      else
+        html_object_factory = HTMLObjectFactory.new(@ie,element,parameter,@reporter)
+        html_object_factory.get_object
+      end
+      
+    end
+    
+    private
+    def handle_reporting_if_element_nil(method,parameter)
+      if method == :verifyElementPresent
+        @reporter.record_results(:verifyElementPresent, true, false, false)
+      elsif method == :verifyElementNotPresent
+        @reporter.record_results(:verifyElementNotPresent, true, true, true)
+      else
+        @reporter.locator_not_found(parameter)
+      end
+    end
+    
+    def set_return_value(method)
+      method == :verifyElementNotPresent
+    end
+  end
+end
+
+# For method name reflection
+module Kernel
+private
+   def this_method
+     caller[0] =~ /`([^']*)'/ and $1
+   end
+   
+   def this_block_name
+     caller[0].split[-1].match(/\w+/).to_s
+   end
+end
+
+# To allow error handling on the html_objects
+class Missing
+   
+   def initialize(return_value)
+     @return_value = return_value
+   end
+   
+   def method_missing(args)
+     @return_value
+   end
+end

data/lib/html_action_modules.rb

@@ -0,0 +1,88 @@
+
+module Actions
+  
+  def click
+    execute(this_method){
+      @element.click
+    }
+  end
+  
+  def submit_form
+    execute(this_method){
+      @element.submit
+    }
+ end
+ 
+  def fire_event
+    execute(this_method){
+      @element.fireEvent @value
+    }
+  end
+
+  def simulate_key_press
+    execute(this_method){
+      @event.keyCode = @value.to_i
+      @element.focus
+      @element.fireEvent('onKeyDown',@event)
+      @element.fireEvent('onKeyPress',@event)
+      @element.fireEvent('onKeyUp',@event)
+    }
+  end
+ 
+  def set_text_value
+    execute(this_method){
+      @element.value = @value
+    }
+  end
+
+  def set_text
+    execute(this_method){
+      #TODO -- raise error here if @value (supplied value) is greater than @element.maxLength
+      #TODO -- raise error if the element is disabled or read only
+      #TODO -- report warning message if element is not visible
+    
+      begin
+        max_length = @element.maxLength
+      rescue
+        max_length = false
+      end
+  
+      @element.value = ''
+      @value.scan(/./).each do |character|
+        if max_length
+          enter_text character unless @element.value.length + 1 > max_length
+        else
+          enter_text character
+        end
+      end
+    }
+  end
+  
+  def set_multiple_options
+    execute(this_method){
+      if @element.getAttribute('multiple')
+        valid_options = []
+        @element.options.each{|option|
+          option.selected = @value.include? option.innerHTML 
+          valid_options << option.innerHTML
+        }
+        @value.each{|value|
+          if not valid_options.include? value
+            raise ValueNotFound, "Multiple select option not found with #{value}"
+          end
+        }
+      end
+    }
+  end
+
+  private
+  def enter_text(character)
+    execute(this_method){
+      @element.value = @element.value.to_s + character
+      @element.fireEvent("onKeyDown")
+      @element.fireEvent("onKeyPress")
+      @element.fireEvent("onKeyUp") 
+    }
+  end
+
+end