kolach-melomel 0.6.4

data/lib/melomel/bridge/ui.rb

@@ -0,0 +1,155 @@
+# These add-on methods provide ease of use utility methods.
+module Melomel
+  class Bridge
+    # Blocks until Melomel.busy in the Flash virtual machine is false.
+    #
+    # Returns nothing.
+    def wait()
+      loop do 
+        break unless busy!
+        sleep 0.1
+      end
+    end
+    
+    # Checks if the Flash virtual machine is currently busy. See Melomel#busy
+    # in the Melomel asdocs for more information.
+    #
+    # Returns true if the Flash virtual machine is busy. Otherwise returns
+    # false.
+    def busy!
+      get_class!('Melomel').busy!
+    end
+    
+    # Finds a list of display objects matching a class and hash of properties.
+    #
+    # class_name - The type of objects to search for.
+    # root       - The object to start searching from. (Defaults to the stage).
+    # properties - A list of properties to match on each object.
+    #
+    # Example:
+    # 
+    #   bridge.find_all('mx.controls.Button', :label => 'Click me')
+    #   # => [<Melomel::ObjectProxy>, <Melomel::ObjectProxy>]
+    #
+    # Returns a list of display objects contained by root that match the
+    # properties and class specified.
+    def find_all(class_name, root={}, properties={})
+      # Merge hashes if no root is specified
+      if root.is_a?(Hash)
+        properties.merge!(root)
+        root = nil
+      end
+      
+      # Retrieve object
+      get_class('melomel.core.UI').findAll(class_name, root, properties)
+    end
+    
+    def find_all!(class_name, root={}, properties={})
+      objects = find_all(class_name, root, properties)
+      raise MelomelError.new("No objects found") if objects.empty?
+      return objects
+    end
+
+    # Finds the first display object matching a class and hash of properties.
+    #
+    # class_name - The type of object to search for.
+    # root       - The object to start searching from. (Defaults to the stage).
+    # properties - A list of properties to match on the object.
+    #
+    # Example:
+    # 
+    #   bridge.find('mx.controls.Button', :label => 'Click me')
+    #   # => <Melomel::ObjectProxy>
+    #
+    # Returns the first display object contained by root that matches the
+    # properties and class specified.
+    def find(class_name, root={}, properties={})
+      # Merge hashes if no root is specified
+      if root.is_a?(Hash)
+        properties.merge!(root)
+        root = nil
+      end
+      
+      # Retrieve object
+      get_class('melomel.core.UI').find(class_name, root, properties)
+    end
+
+    def find!(class_name, root={}, properties={})
+      object = find(class_name, root, properties)
+      raise MelomelError.new("No object found") if object.nil?
+      return object
+    end
+
+    # Finds a component based on the label of a nearby component. This works
+    # by first finding a Halo or Spark label component and then recursively
+    # searching the label's parent's children for a component of a given class.
+    #
+    # class_name - The type of object to search for.
+    # label_text - The label text to search for.
+    # root       - The object to start searching from. (Defaults to the stage).
+    # properties - A list of properties to match on the object.
+    #
+    # Example:
+    # 
+    #   bridge.find_labeled('mx.controls.TextInput', 'First Name')
+    #   # => <Melomel::ObjectProxy>
+    #
+    # Returns the first display object which is inside the parent of a given
+    # label.
+    def find_labeled(class_name, label_text, root={}, properties={})
+      # Merge hashes if no root is specified
+      if root.is_a?(Hash)
+        properties.merge!(root)
+        root = nil
+      end
+      
+      # Retrieve object
+      get_class('melomel.core.UI').findLabeled(class_name, label_text, root, properties)
+    end
+
+    def find_labeled!(class_name, label_text, root={}, properties={})
+      object = find_labeled(class_name, label_text, root, properties)
+      raise MelomelError.new("No object found") if object.nil?
+      return object
+    end
+
+
+    # Imitates a click on a component
+    def click(component, properties={})
+      get_class('melomel.core.UI').click(component, properties)
+    end
+
+    # Imitates a double click on a component
+    def double_click(component, properties={})
+      get_class('melomel.core.UI').doubleClick(component, properties)
+    end
+
+
+    # Imitates a key down on a component
+    def key_down(component, char, properties={})
+      get_class('melomel.core.UI').keyDown(component, char, properties)
+    end
+
+    # Imitates a key up on a component
+    def key_up(component, char, properties={})
+      get_class('melomel.core.UI').keyUp(component, char, properties)
+    end
+
+    # Imitates a key press on a component
+    def key_press(component, char, properties={})
+      get_class('melomel.core.UI').keyPress(component, char, properties)
+    end
+
+
+    # Generates a list of labels created by a data control or column based on a
+    # data set.
+    #
+    # component - The control or column which has an itemToLabel() method.
+    # data      - The data set to generate labels from.
+    #
+    # Returns a Ruby array of labels.
+    def items_to_labels!(component, data)
+      get_class('melomel.core.UI').itemsToLabels!(component, data)
+    end
+  end
+end

data/lib/melomel/cucumber.rb

@@ -0,0 +1,150 @@
+require 'cucumber'
+require 'melomel'
+Dir.glob(File.dirname(__FILE__) + '/cucumber/*', &method(:require))
+
+# This class holds utility methods for running Cucumber steps.
+module Melomel
+  class Cucumber
+    # A wrapper for Melomel actions that automatically waits until the Flash
+    # virtual machine is not busy before continuing.
+    #
+    # Returns nothing.
+    def self.run!
+      Melomel.wait()
+      yield
+    end
+
+    # Finds a component by id.
+    #
+    # class_name - The class or classes to match on.
+    # id         - The id of the component.
+    # root       - The root component to search from. Defaults to the stage.
+    # properties - Additional properties to search on.
+    #
+    # Returns a component matching the id and the additional properties.
+    def self.find_by_id!(class_name, id, root={}, properties={})
+      properties['id'] = id
+      Melomel.find!(class_name, root, properties)
+    end
+
+    # Finds a component by label. If the first character is a "#" then the
+    # component should be found by id. Otherwise it is found by label.
+    #
+    # class_name - The class or classes to match on.
+    # label      - The label of the component.
+    # root       - The root component to search from. Defaults to the stage.
+    # properties - Additional properties to search on.
+    #
+    # Returns a component matching the label and the additional properties.
+    def self.find_by_label!(class_name, label, root={}, properties={})
+      set_properties_key(properties, 'label', label)
+      Melomel.find!(class_name, root, properties)
+    end
+
+    # Finds a component that shares the same parent as a given label. If the
+    # first character is a "#" then the component should be found by id.
+    # Otherwise it is found by label.
+    #
+    # class_name - The class or classes to match on.
+    # label      - The label text.
+    # root       - The root component to search from. Defaults to the stage.
+    # properties - Additional properties to search on.
+    #
+    # Returns a component labeled by another component.
+    def self.find_labeled!(class_name, label, root={}, properties={})
+      if label.index('#') == 0
+        find_by_id!(class_name, label[1..-1], root, properties)
+      else
+        Melomel.find_labeled!(class_name, label, root, properties)
+      end
+    end
+
+    # Finds a component by title. If the first character is a "#" then the
+    # component should be found by id. Otherwise it is found by title.
+    #
+    # class_name - The class or classes to match on.
+    # title      - The title of the component.
+    # root       - The root component to search from. Defaults to the stage.
+    # properties - Additional properties to search on.
+    #
+    # Returns a component matching the title and the additional properties.
+    def self.find_by_title!(class_name, title, root={}, properties={})
+      set_properties_key(properties, 'title', title)
+      Melomel.find!(class_name, root, properties)
+    end
+
+    # Finds a component by text. If the first character is a "#" then the
+    # component should be found by id. Otherwise it is found by text.
+    #
+    # class_name - The class or classes to match on.
+    # text       - The text property of the component.
+    # root       - The root component to search from. Defaults to the stage.
+    # properties - Additional properties to search on.
+    #
+    # Returns a component matching the text and the additional properties.
+    def self.find_by_text!(class_name, text, root={}, properties={})
+      set_properties_key(properties, 'text', text)
+      Melomel.find!(class_name, root, properties)
+    end
+
+    # Sets the key in the properties hash. If the first character is "#" then
+    # the key is "id". Otherwise it is set to the value of "key".
+    #
+    # properties - The properties hash.
+    # key        - The name of the key to set.
+    # name       - The name of the component.
+    #
+    # Returns nothing.
+    def self.set_properties_key(properties, key, name)
+      if name.index('#') == 0
+        properties['id'] = name[1..-1]
+      else
+        properties[key] = name
+      end
+    end
+
+    # Retrieves grid data as a 2D array of rows of columns. The first row
+    # contains the grid's header.
+    #
+    # grid - The grid to generate the table from.
+    #
+    # Returns a 2D array of rows of columns of data.
+    def self.get_grid_data(grid)
+      # Retrieve as columns of rows
+      data = []
+      grid.columns.length.times do |i|
+        column_data = []
+        column = grid.columns[i]
+        labels = Melomel.items_to_labels!(column, grid.dataProvider)
+
+        # Add column header
+        column_data << column.headerText
+        
+        # Add label data
+        labels.length.times do |j|
+          column_data << labels[j]
+        end
+        
+        # Add column data to data set
+        data << column_data
+      end
+      
+      # Transpose and return
+      return data.transpose()
+    end
+    
+    # The same grid data but stripped of whitespce
+    def self.get_striped_grid_data(grid)  
+      data = get_grid_data(grid)
+      # Trim whitespace
+      data.each do |row| 
+        row.each do |cell| 
+          if cell != nil 
+            cell.strip!
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/melomel/cucumber/alert_steps.rb

@@ -0,0 +1,40 @@
+When /^I click the "([^"]*)" button on the alert$/ do |label|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('alert')
+    alert = Melomel.find!(classes)
+    button = Melomel::Cucumber.find_by_label!('mx.controls.Button', label, alert)
+    button.setFocus()
+    Melomel.click(button)
+  end
+end
+
+Then /^I should see an alert$/ do
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('alert')
+    Melomel.find!(classes)
+  end
+end
+
+Then /^I should see an alert with the title: "([^"]*)"$/ do |title|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('alert')
+    alert = Melomel.find!(classes)
+    alert.title.should == title
+  end
+end
+
+Then /^I should see an alert with the message: "([^"]*)"$/ do |message|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('alert')
+    alert = Melomel.find!(classes)
+    alert.text.should == message
+  end
+end
+
+Then /^I should see an alert with the following message:$/ do |message|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('alert')
+    alert = Melomel.find!(classes)
+    alert.text.should == message
+  end
+end

data/lib/melomel/cucumber/button_steps.rb

@@ -0,0 +1,17 @@
+When /^I click the "([^"]*)" (button|check box|radio button|tab)$/ do |name, type|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes(type)
+    button = Melomel::Cucumber.find_by_label!(classes, name)
+    button.setFocus()
+    Melomel.click(button)
+  end
+end
+
+Then /^I should see the "([^"]*)" (button|check box|radio button) (not )?selected$/ do |name, type, neg|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes(type)
+    button = Melomel::Cucumber.find_by_label!(classes, name)
+    button.setFocus()
+    button.selected.should == neg.nil?
+  end
+end

data/lib/melomel/cucumber/color_picker_steps.rb

@@ -0,0 +1,18 @@
+When /^I set the "([^"]*)" color picker to "#([0-9A-Fa-f]{6})"$/ do |name, color|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('color picker')
+    picker = Melomel::Cucumber.find_labeled!(classes, name)
+    picker.setFocus()
+    picker.selectedColor = color.hex
+  end
+end
+
+Then /^I should see the "([^"]*)" color picker set to "#([0-9A-Fa-f]{6})"$/ do |name, color|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('color picker')
+    picker = Melomel::Cucumber.find_labeled!(classes, name)
+    picker.setFocus()
+    sprintf('%06X', picker.selectedColor).should == color
+  end
+end
+

data/lib/melomel/cucumber/data_grid_steps.rb

@@ -0,0 +1,83 @@
+When /^I select "([^"]*)" on the "([^"]*)" data grid$/ do |value, name|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('data grid')
+    grid = Melomel::Cucumber.find_labeled!(classes, name)
+    grid.setFocus()
+
+    # Retrieve data and take off header row
+    data = Melomel::Cucumber.get_grid_data(grid)[1..-1]
+  
+    # Loop data and check for matches
+    index = nil
+    data.each_index do |i|
+      row = data[i]
+      row.each do |cell|
+        if cell.strip == value
+          index = i
+          break
+        end
+      end
+    
+      break unless index.nil?
+    end
+  
+    # If we couldn't find a matching cell then throw an error
+    raise "Cannot find '#{value}' on data grid" if index.nil?
+  
+    grid.selectedIndex = index
+  end
+end
+
+
+Then /^I should see "([^"]*)" selected on the "([^"]*)" data grid$/ do |value, name|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('data grid')
+    grid = Melomel::Cucumber.find_labeled!(classes, name)
+    grid.setFocus()
+
+    # Retrieve data and take off header row
+    data = Melomel::Cucumber.get_grid_data(grid)[1..-1]
+  
+    # Loop data and check for matches
+    index = nil
+    data.each_index do |i|
+      row = data[i]
+      row.each do |cell|
+        if cell.strip == value
+          index = i
+          break
+        end
+      end
+    
+      break unless index.nil?
+    end
+  
+    grid.selectedIndex.should == index
+  end
+end
+
+Then /^I should see the following data in the "([^"]*)" data grid:$/ do |name, table|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('data grid')
+    grid = Melomel::Cucumber.find_labeled!(classes, name)
+    grid.setFocus()
+
+    data = Melomel::Cucumber.get_striped_grid_data(grid)
+  
+    table.diff!(data)
+  end
+end
+
+
+Then /^I should see no data in the "([^"]*)" data grid$/ do |name|
+  Melomel::Cucumber.run! do
+    classes = Melomel::Flex.get_component_classes('data grid')
+    grid = Melomel::Cucumber.find_labeled!(classes, name)
+    grid.setFocus()
+
+    # Retrieve data and take off header row
+    data = Melomel::Cucumber.get_grid_data(grid)[1..-1]
+    
+    data.size.should == 0 
+  end
+end