class TestCentricity::Table

Attributes

header_column[RW]
header_row[RW]
table_body[RW]
table_column[RW]
table_header[RW]
table_row[RW]
table_section[RW]
tree_collapse[RW]
tree_expand[RW]

Public Class Methods

new(name, parent, locator, context) click to toggle source
Calls superclass method TestCentricity::UIElement::new
# File lib/testcentricity/web_elements/table.rb, line 13
def initialize(name, parent, locator, context)
  super
  @type = :table

  table_spec = { :table_body    => 'tbody',
                 :table_section => nil,
                 :table_row     => 'tr',
                 :table_column  => 'td',
                 :table_header  => 'thead',
                 :header_row    => 'tr',
                 :header_column => 'th' }

  case @locator_type
  when :xpath
    table_spec[:tree_expand]   = "div/div[contains(@class, 'tree-plus treeclick')]"
    table_spec[:tree_collapse] = "div/div[contains(@class, 'tree-minus treeclick')]"
  when :css
    table_spec[:tree_expand]   = "div/div[class*='tree-plus treeclick']"
    table_spec[:tree_collapse] = "div/div[class*='tree-minus treeclick']"
  end
  define_table_elements(table_spec)
end

Public Instance Methods

click_header_column(column) click to toggle source

Click in the specified column header in a table object.

@param column [Integer] column number @example

list_table.click_header_column(3)
# File lib/testcentricity/web_elements/table.rb, line 466
def click_header_column(column)
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table header #{object_ref_message}" if column > column_count
  case @locator_type
  when :xpath
    set_alt_locator("#{@locator}//#{@table_header}/#{@header_row}/#{@header_column}[#{column}]")
  when :css
    set_alt_locator("#{@locator} #{@table_header} > #{@header_row} > #{@header_column}:nth-of-type(#{column})")
  end
  click if exists?
  clear_alt_locator
end
click_table_cell(row, column) click to toggle source

Click in the specified cell in a table object.

@param row [Integer] row number @param column [Integer] column number @example

list_table.click_table_cell(3, 5)
# File lib/testcentricity/web_elements/table.rb, line 151
def click_table_cell(row, column)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
  set_table_cell_locator(row, column)
  click
  clear_alt_locator
end
collapse_table_row(row, column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 541
def collapse_table_row(row, column)
  if is_table_row_expanded?(row, column)
    set_table_cell_locator(row, column)
    case @locator_type
    when :xpath
      set_alt_locator("#{@alt_locator}/#{@tree_collapse}")
    when :css
      set_alt_locator("#{@alt_locator} > #{@tree_collapse}")
    end
    click if exists?
    clear_alt_locator
  end
end
define_table_elements(element_spec) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 36
def define_table_elements(element_spec)
  element_spec.each do |element, value|
    case element
    when :table_body
      @table_body = value
    when :table_section
      @table_section = value
    when :table_row
      @table_row = value
    when :table_column
      @table_column = value
    when :table_header
      @table_header = value
    when :header_row
      @header_row = value
    when :header_column
      @header_column = value
    when :tree_expand
      @tree_expand = value
    when :tree_collapse
      @tree_collapse = value
    else
      raise "#{element} is not a recognized table element"
    end
  end
end
double_click_table_cell(row, column) click to toggle source

Double-click in the specified cell in a table object.

@param row [Integer] row number @param column [Integer] column number @example

list_table.double_click_table_cell(3, 5)
# File lib/testcentricity/web_elements/table.rb, line 168
def double_click_table_cell(row, column)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
  set_table_cell_locator(row, column)
  double_click
  clear_alt_locator
end
expand_all_table_rows(column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 555
def expand_all_table_rows(column)
  row_count = get_row_count
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
  row_count.downto(1) do |row|
    expand_table_row(row, column)
  end
end
expand_table_row(row, column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 527
def expand_table_row(row, column)
  unless is_table_row_expanded?(row, column)
    set_table_cell_locator(row, column)
    case @locator_type
    when :xpath
      set_alt_locator("#{@alt_locator}/#{@tree_expand}")
    when :css
      set_alt_locator("#{@alt_locator} > #{@tree_expand}")
    end
    click if exists?
    clear_alt_locator
  end
end
find_in_table_column(column, search_value) click to toggle source

Search for the specified text value in the specified column of the table object. Returns the number of the first row that contains the search value.

@param column [Integer] column nummber @param search_value [String] value to be searched for @return [Integer] row number of table cell that contains search value @example

playlist_table.find_in_table_column(1, 'Ashes to Ashes')
# File lib/testcentricity/web_elements/table.rb, line 425
def find_in_table_column(column, search_value)
  (1..get_row_count).each do |row|
    return row if get_table_cell(row, column) == search_value
  end
  nil
end
find_in_table_row(row, search_value) click to toggle source

Search for the specified text value in the specified row of the table object. Returns the number of the first column that contains the search value.

@param row [Integer] row nummber @param search_value [String] value to be searched for @return [Integer] column number of table cell that contains search value @example

bom_table.find_in_table_row(4, 'High-speed Framus bolts')
# File lib/testcentricity/web_elements/table.rb, line 409
def find_in_table_row(row, search_value)
  (1..get_column_count).each do |column|
    return column if get_table_cell(row, column) == search_value
  end
  nil
end
find_row_attribute(attrib, search_value) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 393
def find_row_attribute(attrib, search_value)
  (1..get_row_count).each do |row|
    return row if get_row_attribute(row, attrib) == search_value
  end
  nil
end
get_cell_attribute(row, column, attrib) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 364
def get_cell_attribute(row, column, attrib)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
  set_table_cell_locator(row, column)
  result = get_native_attribute(attrib)
  clear_alt_locator
  result
end
get_column_count() click to toggle source

Return number of columns in a table object.

@return [Integer] @example

num_columns = list_table.get_column_count
# File lib/testcentricity/web_elements/table.rb, line 93
def get_column_count
  row_count = get_row_count
  case @locator_type
  when :xpath
    if row_count == 0
      page.all(:xpath, "#{@locator}/#{@table_header}/#{@header_row}/#{@header_column}", :visible => :all).count
    else
      if @table_section.nil?
        row_count == 1 ?
            page.all(:xpath, "#{@locator}/#{@table_body}/#{@table_row}/#{@table_column}", :visible => :all).count :
            page.all(:xpath, "#{@locator}/#{@table_body}/#{@table_row}[2]/#{@table_column}", :visible => :all).count
      else
        row_count == 1 ?
            page.all(:xpath, "#{@locator}/#{@table_body}/#{@table_section}/#{@table_row}/#{@table_column}", :visible => :all).count :
            page.all(:xpath, "#{@locator}/#{@table_body}/#{@table_section}[2]/#{@table_row}/#{@table_column}", :visible => :all).count
      end
    end
  when :css
    if row_count == 0
      page.all(:css, "#{@locator} > #{@table_header} > #{@header_row} > #{@header_column}", :visible => :all).count
    else
      if @table_section.nil?
        row_count == 1 ?
            page.all(:css, "#{@locator} > #{@table_body} > #{@table_row} > #{@table_column}", :visible => :all).count :
            page.all(:css, "#{@locator} > #{@table_body} > #{@table_row}:nth-of-type(2) > #{@table_column}", :visible => :all).count
      else
        row_count == 1 ?
            page.all(:css, "#{@locator} > #{@table_body} > #{@table_section} > #{@table_row} > #{@table_column}", :visible => :all).count :
            page.all(:css, "#{@locator} > #{@table_body} > #{@table_section}:nth-of-type(2) > #{@table_row} > #{@table_column}", :visible => :all).count
      end
    end
  end
end
get_header_column(column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 479
def get_header_column(column)
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table header #{object_ref_message}" if column > column_count
  case @locator_type
  when :xpath
    set_alt_locator("#{@locator}//#{@table_header}/#{@header_row}/#{@header_column}[#{column}]")
  when :css
    set_alt_locator("#{@locator} #{@table_header} > #{@header_row} > #{@header_column}:nth-of-type(#{column})")
  end
  value = get_value(:all) if exists?(:all)
  clear_alt_locator
  value
end
get_header_columns() click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 493
def get_header_columns
  columns = []
  column_count = get_column_count
  (1..column_count).each do |column|
    case @locator_type
    when :xpath
      set_alt_locator("#{@locator}//#{@table_header}/#{@header_row}/#{@header_column}[#{column}]")
    when :css
      set_alt_locator("#{@locator} #{@table_header} > #{@header_row} > #{@header_column}:nth-of-type(#{column})")
    end
    columns.push(get_value(:all)) if exists?(:all)
  end
  clear_alt_locator
  columns
end
get_row_attribute(row, attrib) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 375
def get_row_attribute(row, attrib)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  case @locator_type
  when :xpath
    row > 1 ?
        set_alt_locator("#{@locator}/#{@table_body}/#{@table_row}[#{row}]") :
        set_alt_locator("#{@locator}/#{@table_body}/#{@table_row}")
  when :css
    row > 1 ?
        set_alt_locator("#{@locator} > #{@table_body} > #{@table_row}:nth-of-type(#{row})") :
        set_alt_locator("#{@locator} > #{@table_body} > #{@table_row}")
  end
  result = get_native_attribute(attrib)
  clear_alt_locator
  result
end
get_row_count() click to toggle source

Return number of rows in a table object.

@return [Integer] @example

num_rows = list_table.get_row_count
# File lib/testcentricity/web_elements/table.rb, line 69
def get_row_count
  wait_until_exists(5)
  case @locator_type
  when :xpath
    if @table_section.nil?
      page.all(:xpath, "#{@locator}/#{@table_body}/#{@table_row}", :visible => :all).count
    else
      page.all(:xpath, "#{@locator}/#{@table_body}/#{@table_section}", :visible => :all).count
    end
  when :css
    if @table_section.nil?
      page.all(:css, "#{@locator} > #{@table_body} > #{@table_row}", :visible => :all).count
    else
      page.all(:css, "#{@locator} > #{@table_body} > #{@table_section}", :visible => :all).count
    end
  end
end
get_row_data(row) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 253
def get_row_data(row)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  case @locator_type
  when :xpath
    row > 1 ?
        set_alt_locator("#{@locator}/#{@table_body}/#{@table_row}[#{row}]") :
        set_alt_locator("#{@locator}/#{@table_body}/#{@table_row}")
  when :css
    row > 1 ?
        set_alt_locator("#{@locator} > #{@table_body} > #{@table_row}:nth-of-type(#{row})") :
        set_alt_locator("#{@locator} > #{@table_body} > #{@table_row}")
  end
  value = get_value if exists?
  clear_alt_locator
  value
end
get_table_cell(row, column) click to toggle source

Return text contained in specified cell of a table object.

@param row [Integer] row number @param column [Integer] column number @return [String] value of table cell @example

list_table.get_table_cell(4, 5)
# File lib/testcentricity/web_elements/table.rb, line 309
def get_table_cell(row, column)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
  set_table_cell_locator(row, column)
  saved_locator = @alt_locator
  case @locator_type
  when :xpath
    set_alt_locator("#{saved_locator}//input")
    unless exists?
      set_alt_locator("#{saved_locator}//textarea")
      set_alt_locator(saved_locator) unless exists?
    end
  when :css
    set_alt_locator("#{saved_locator} input")
    unless exists?
      set_alt_locator("#{saved_locator} textarea")
      set_alt_locator(saved_locator) unless exists?
    end
  end
  if exists?
    value = get_value
  else
    puts "Could not find table cell at #{@alt_locator}"
    value = ''
  end
  clear_alt_locator
  value
end
get_table_cell_locator(row, column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 564
def get_table_cell_locator(row, column)
  case @locator_type
  when :xpath
    if @table_section.nil?
      row_spec = "#{@locator}/#{@table_body}/#{@table_row}"
      row_spec = "#{row_spec}[#{row}]"
    else
      row_spec = "#{@locator}/#{@table_body}/#{@table_section}"
      row_spec = "#{row_spec}[#{row}]/#{@table_row}[1]"
    end
    column_spec = "/#{@table_column}[#{column}]"
  when :css
    if @table_section.nil?
      row_spec = "#{@locator} > #{@table_body} > #{@table_row}"
      row_spec = "#{row_spec}:nth-of-type(#{row})"
    else
      row_spec = "#{@locator} > #{@table_body} > #{@table_section}"
      row_spec = "#{row_spec}:nth-of-type(#{row}) > #{@table_row}:nth-of-type(1)"
    end
    column_spec = " > #{@table_column}:nth-of-type(#{column})"
  end
  "#{row_spec}#{column_spec}"
end
get_table_column(column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 271
def get_table_column(column)
  rows = []
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
  row_count = get_row_count
  (1..row_count).each do |row|
    value = ''
    set_table_cell_locator(row, column)
    saved_locator = @alt_locator
    case @locator_type
    when :xpath
      set_alt_locator("#{saved_locator}//input")
      unless exists?
        set_alt_locator("#{saved_locator}//textarea")
        set_alt_locator(saved_locator) unless exists?
      end
    when :css
      set_alt_locator("#{saved_locator} input")
      unless exists?
        set_alt_locator("#{saved_locator} textarea")
        set_alt_locator(saved_locator) unless exists?
      end
    end
    value = get_value if exists?
    rows.push(value)
  end
  clear_alt_locator
  rows
end
get_table_row(row) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 223
def get_table_row(row)
  columns = []
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  column_count = get_column_count
  (1..column_count).each do |column|
    value = ''
    set_table_cell_locator(row, column)
    saved_locator = @alt_locator
    case @locator_type
    when :xpath
      set_alt_locator("#{saved_locator}//input")
      unless exists?
        set_alt_locator("#{saved_locator}//textarea")
        set_alt_locator(saved_locator) unless exists?
      end
    when :css
      set_alt_locator("#{saved_locator} input")
      unless exists?
        set_alt_locator("#{saved_locator} textarea")
        set_alt_locator(saved_locator) unless exists?
      end
    end
    value = get_value if exists?
    columns.push(value)
  end
  clear_alt_locator
  columns
end
hover_table_cell(row, column) click to toggle source

Hover over the specified cell in a table object.

@param row [Integer] row number @param column [Integer] column number @example

list_table.hover_table_cell(2, 6)
# File lib/testcentricity/web_elements/table.rb, line 134
def hover_table_cell(row, column)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
  set_table_cell_locator(row, column)
  hover
  clear_alt_locator
end
is_table_row_expanded?(row, column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 509
def is_table_row_expanded?(row, column)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  column_count = get_column_count
  raise "Column #{column} exceeds number of columns (#{column_count}) in table #{object_ref_message}" if column > column_count
  set_table_cell_locator(row, column)
  case @locator_type
  when :xpath
    set_alt_locator("#{@alt_locator}/#{@tree_expand}")
  when :css
    set_alt_locator("#{@alt_locator} > #{@tree_expand}")
  end
  expanded = true
  expanded = false if exists?
  clear_alt_locator
  expanded
end
populate_table_row(row, data) click to toggle source

Populate the specified row of this table object with the associated data from a Hash passed as an argument. Data values must be in the form of a String for textfield and select list controls. For checkbox and radio buttons, data must either be a Boolean or a String that evaluates to a Boolean value (Yes, No, 1, 0, true, false)

@param data [Hash] column numbers and associated data to be entered @example

data = { 1 => 'Dr.',
         2 => 'Evangeline',
         3 => 'Devereaux',
         4 => 'MD',
         5 => 'Family Practice'
       }
clinicians_table.populate_table_row(3, data)
# File lib/testcentricity/web_elements/table.rb, line 447
def populate_table_row(row, data)
  wait_until_exists(2)
  data.each do |column, data_param|
    unless data_param.blank?
      if data_param == '!DELETE'
        set_table_cell(row, column, '')
      else
        set_table_cell(row, column, data_param)
      end
    end
  end
end
set_table_cell(row, column, value) click to toggle source

Set the value of the specified cell in a table object.

@param row [Integer] row number @param column [Integer] column number @param value [String] text to set @example

list_table.set_table_cell(3, 1, 'Ontario')
# File lib/testcentricity/web_elements/table.rb, line 355
def set_table_cell(row, column, value)
  row_count = get_row_count
  raise "Row #{row} exceeds number of rows (#{row_count}) in table #{object_ref_message}" if row > row_count
  find_table_cell(row, column)
  find_table_cell(row, column) unless exists?
  set(value)
  clear_alt_locator
end
verify_table_cell(row, column, expected, enqueue = false) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 340
def verify_table_cell(row, column, expected, enqueue = false)
  actual = get_table_cell(row, column)
  enqueue ?
      ExceptionQueue.enqueue_assert_equal(expected.strip, actual.strip, "Expected table #{object_ref_message} row #{row}/column #{column}") :
      assert_equal(expected.strip, actual.strip, "Expected table #{object_ref_message} row #{row}/column #{column} to display '#{expected}' but found '#{actual}'")
end

Private Instance Methods

find_table_cell(row, column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 594
def find_table_cell(row, column)
  set_table_cell_locator(row, column)
  if exists?
    click
  else
    puts "Could not find table cell at #{@alt_locator}"
  end
  saved_locator = @alt_locator
  case @locator_type
  when :xpath
    set_alt_locator("#{saved_locator}//input")
    set_alt_locator("#{saved_locator}//textarea") unless exists?
  when :css
    set_alt_locator("#{saved_locator} input")
    set_alt_locator("#{saved_locator} textarea") unless exists?
  end
end
set_table_cell_locator(row, column) click to toggle source
# File lib/testcentricity/web_elements/table.rb, line 590
def set_table_cell_locator(row, column)
  set_alt_locator(get_table_cell_locator(row, column))
end