awetestlib 0.1.13-x86-mingw32 → 0.1.14-x86-mingw32

data/lib/awetestlib/regression/legacy.rb

@@ -1,42 +1,10 @@
 module Awetestlib
   module Regression
+    # Backward compatible methods and alias to support earlier versions of the Awetest DSL.
+    # These are deprecated in favor of the corresponding methods in the module name under which they are grouped.
+    # Work in Progress
     module Legacy
 
-      #--
-      ##def open_log
-      #  start = Time.now.to_f.to_s
-      #
-      #  logTS = Time.at(@myRun.launched.to_f).strftime("%Y%m%d%H%M%S")
-      #  xls = @myAppEnv.xls_name.gsub('.xls', '') + '_' if  @myAppEnv.xls_name.length > 0
-      #  @logFileSpec = "#{@myRoot}/#{logdir}/#{@myName}_#{@targetBrowser.abbrev}_#{xls}#{logTS}.log"
-      #  init_logger(@logFileSpec, @myName)
-      #
-      #                                                  #    message_tolog( self.inspect )
-      #  message_to_log("#{@myName} launched at [#{@myRun.launched.to_f.to_s}][#{@myScript.id}][#{@myRun.id}][#{@myChild.id}]")
-      #  debug_to_log("pid: #{$$}")
-      #  message_to_log("#{@myName} begin at [#{start}]")
-      #  message_to_log("#{@myName} environment [#{@myAppEnv.name}]")
-      #  message_to_log("#{@myName} xls_name [#{@myAppEnv.xls_name}]") if  @myAppEnv.xls_name.length > 0
-      #  message_to_log("#{@myName} rootDir [#{@myRoot}]")
-      #  message_to_log("#{@myName} Target Browser [#{@targetBrowser.name}]")
-      #  mark_testlevel(@myParent.name, @myParent.level) # Module
-      #  mark_testlevel(@myChild.name, @myChild.level) # SubModule
-      #
-      #end
-      #++
-
-      #def find_me(where, how, what)
-      #  me = where.element(how, what)
-      #  puts me.inspect
-      #rescue
-      #  error_to_log("#{where.inspect} doesn't seem to respond to element() #{$!}")
-      #end
-
-    #  def click_me(element)
-    #    element.click
-    #  rescue
-    #    error_to_log("#{element.inspect} doesn't seem to respond to click() #{$!}")
-    #  end
 
 
     end

data/lib/awetestlib/regression/page_data.rb

@@ -1,7 +1,11 @@
 module Awetestlib
   module Regression
+    # Methods for capture and manipulation of data contained in
+    # text, values, and/or states of spans, text fields, radios, checkboxes, and select_lists.
     module PageData
 
+      # @!group Core
+
 =begin rdoc
 :category: Page Data
 :tags: data, DOM, page
@@ -36,7 +40,7 @@ No positive validations are reported but failure is rescued and reported.
       end
 
       def compare_page_data(before, after, how, desc = '')
-        [:text, :textarea, :select_list, :span, :checkbox, :radio].each do |type|
+        [:text, :textarea, :select_list, :span, :hidden, :checkbox, :radio].each do |type|
           before[how][type].each_key do |what|
             msg = "#{desc} #{type} #{how}=#{what}: Expected '#{before[how][type][what]}'."
             if after[how][type][what] == before[how][type][what]
@@ -144,45 +148,42 @@ No positive validations are reported but failure is rescued and reported.
       end
 
       def get_textfield_value(browser, how, what, desc = '')
-        msg = "Return value in textfield #{how}='#{what}'"
-        msg << " #{desc}" if desc.length > 0
+        msg = build_message("Return value in textfield #{how}='#{what}'", desc)
         tf = browser.text_field(how, what)
-        if validate(browser, @myName, __LINE__)
-          if tf
-            debug_to_log("#{tf.inspect}")
-            vlu = tf.value
-            passed_to_log("#{msg} Value='#{vlu}'")
-            vlu
-          else
-            failed_to_log("#{msg}")
-          end
+        if tf
+          debug_to_log("#{tf.inspect}")
+          vlu = tf.value
+          passed_to_log("#{msg} Value='#{vlu}'")
+          vlu
+        else
+          failed_to_log("#{msg}")
         end
       rescue
         failed_to_log("Unable to #{msg}: '#{$!}'")
       end
 
-      def get_textfield_value_by_name(browser, strg, desc = '')
-        get_textfield_value(browser, :name, strg, desc)
-      end
-
-      def get_textfield_value_by_id(browser, strg)
-        get_textfield_value(browser, :id, strg)
-      end
-
       def get_element_text(browser, element, how, what, desc = '')
-        msg = "Return text in #{element} #{how}='#{what}'"
-        msg << " #{desc}" if desc.length > 0
+        msg = build_message("Return text in #{element} #{how}='#{what}'", desc)
         text = browser.element(how, what).text
-        if validate(browser, @myName, __LINE__)
-          passed_to_log("#{msg} text='#{text}'")
-          text
-        end
+        passed_to_log("#{msg} text='#{text}'")
+        text
       rescue
         failed_to_log("Unable to #{msg}: '#{$!}'")
       end
 
+      # @!endgroup Core
+
+      # @!group Legacy (Backward compatible usage)
+
+      def get_textfield_value_by_name(browser, strg, desc = '')
+        get_textfield_value(browser, :name, strg, desc)
+      end
 
+      def get_textfield_value_by_id(browser, strg)
+        get_textfield_value(browser, :id, strg)
+      end
 
+      # @!endgroup Legacy
 
     end
   end

data/lib/awetestlib/regression/runner.rb

@@ -6,6 +6,7 @@ require 'awetestlib/regression/tables'
 require 'awetestlib/regression/page_data'
 require 'awetestlib/regression/drag_and_drop'
 require 'awetestlib/regression/utilities'
+require 'awetestlib/regression/legacy'
 require 'awetestlib/logging'
 require 'awetestlib/regression/validations'
 require 'awetestlib/html_report'
@@ -20,6 +21,7 @@ module Awetestlib
 
     # order matters here
       include Awetestlib::Logging
+      include Awetestlib::Regression::Utilities
       include Awetestlib::Regression::Browser
       include Awetestlib::Regression::Find
       include Awetestlib::Regression::UserInput
@@ -27,8 +29,8 @@ module Awetestlib
       include Awetestlib::Regression::Tables
       include Awetestlib::Regression::PageData
       include Awetestlib::Regression::DragAndDrop
-      include Awetestlib::Regression::Utilities
       include Awetestlib::Regression::Validations
+      include Awetestlib::Regression::Legacy
 
       ::DEBUG   = 0
       ::INFO    = 1

data/lib/awetestlib/regression/tables.rb

@@ -1,7 +1,12 @@
 module Awetestlib
   module Regression
+    # Methods for handling Tables, Rows, and Cells
+    # Rdoc work in progress
     module Tables
 
+
+      # Groups: Columns, Rows, Sorting
+
       def get_index_for_column_head(panel, table_index, strg, desc = '')
         table = panel.tables[table_index]
         get_column_index(table, strg, desc, true)
@@ -241,6 +246,32 @@ module Awetestlib
         text
       end
 
+      # Return a hash containing a cross reference of the header names and indexes (columns) for the specified table.
+      # @example
+      #   (need example and usage)
+      # @param [Watir::Table] table A reference to the table.
+      # @param [Fixnum] header_index The index of the row containing the header names.
+      # @return [Hash] Two level hash of hashes. Internal hashes are 'name' which allows look-up of a column index
+      # by the header name, and 'index' which allows look-up of the name by the column index.
+      def get_table_headers(table, header_index = 1)
+        headers          = Hash.new
+        headers['index'] = Hash.new
+        headers['name']  = Hash.new
+        count            = 1
+        table[header_index].each do |cell|
+          if cell.text.length > 0
+            name                    = cell.text.gsub(/\s+/, ' ')
+            headers['index'][count] = name
+            headers['name'][name]   = count
+          end
+          count += 1
+        end
+        #debug_to_log("#{__method__}: headers:\n#{headers.to_yaml}")
+        headers
+      rescue
+        failed_to_log("Unable to get content headers. '#{$!}'")
+      end
+
       def count_rows_with_string(container, table_index, strg)
         hit = 0
         container.tables[table_index].each do |row|
@@ -510,6 +541,32 @@ module Awetestlib
         sleep_for(1)
       end
 
+      def text_in_table?(browser, how, what, expected, desc = '')
+        msg = build_message("Table :#{how}=>#{what} contains '#{expected}.", desc)
+        if browser.table(how, what).text =~ expected
+          passed_to_log(msg)
+          true
+        else
+          failed_to_log(msg)
+        end
+      rescue
+        failed_to_log("Unable to verify that #{msg}': '#{$!}'")
+      end
+
+      def text_in_table_row_with_text?(table, text, target, desc = '')
+        #TODO This needs clarification, renaming
+        msg   = build_message("Table :id=>#{table.id} row with text '#{text} also contains '#{target}.", desc)
+        index = get_index_of_row_with_text(table, text)
+        if table[index].text =~ target
+          passed_to_log(msg)
+          true
+        else
+          failed_to_log(msg)
+        end
+      end
+
+      alias verify_text_in_table_with_text text_in_table_row_with_text?
+
     end
   end
 end