lebowski 0.1.0

data/lib/lebowski/foundation/mixins/user_actions.rb

@@ -0,0 +1,302 @@
+module Lebowski
+  module Foundation
+    module Mixins
+
+      #
+      # Mixin containing a set of commonly performed user actions. Mix this into any
+      # class that is able to perform these set of actions. 
+      #
+      module UserActions
+        include PositionedElement
+        include KeyCheck
+        include StallSupport
+        
+        def mouse_move()
+          @driver.sc_mouse_move action_target, *action_locator_args
+          stall :mouse_move
+        end
+        
+        def mouse_move_at(x, y)
+          @driver.sc_mouse_move_at action_target, x, y, *action_locator_args
+          stall :mouse_move          
+        end
+        
+        def mouse_up_at(x, y)
+          @driver.sc_mouse_up_at action_target, x, y, *action_locator_args
+          stall :mouse_up
+        end
+        
+        def mouse_down_at(x, y)
+          @driver.sc_mouse_down_at action_target, x, y, *action_locator_args
+          stall :mouse_down
+        end
+        
+        #
+        # Used to perform a mouse up on this view in the remote application
+        #
+        def mouse_up()
+          @driver.sc_mouse_up action_target, *action_locator_args
+          stall :mouse_up
+        end
+        
+        #
+        # Used to perform a mouse down on this view in the remote application
+        #
+        def mouse_down()
+          @driver.sc_mouse_down action_target, *action_locator_args
+          stall :mouse_down
+        end
+        
+        #
+        # Used to perform a single click on this view in the remote application
+        #
+        def click()
+          mouse_down
+          mouse_up
+          stall :click
+        end
+        
+        def click_at(x, y)
+          mouse_down_at x, y
+          mouse_up_at x, y
+          stall :click
+        end
+        
+        #
+        # Used to perform a single basic click on this view in the remote application
+        #
+        def basic_click()
+          @driver.sc_basic_click action_target, *action_locator_args
+          stall :click
+        end
+        
+        #
+        # Used to perform a double click on this view in the remote application
+        #
+        def double_click()
+          @driver.sc_double_click action_target, *action_locator_args
+          stall :double_click
+        end
+
+        #
+        # Used to perform a mouse up with right button on this view in the remote application
+        #
+        def right_mouse_up()
+          @driver.sc_right_mouse_up action_target, *action_locator_args
+          stall :right_mouse_up
+        end
+        
+        #
+        # Used to perform a mouse down with right button on this view in the remote application
+        #
+        def right_mouse_down()
+          @driver.sc_right_mouse_down action_target, *action_locator_args
+          stall :right_mouse_down
+        end
+        
+        def right_mouse_up_at(x, y)
+          @driver.sc_right_mouse_up_at action_target, x, y, *action_locator_args
+          stall :right_mouse_up
+        end
+        
+        def right_mouse_down_at(x, y)
+          @driver.sc_right_mouse_down_at action_target, x, y, *action_locator_args
+          stall :right_mouse_down
+        end
+        
+        #
+        # Used to perform a single right click on this view in the remote application
+        #
+        def right_click()
+          right_mouse_down_at 0, 0
+          right_mouse_up_at 0, 0
+          stall :right_click
+        end
+        
+        def right_click_at(x, y)
+          right_mouse_down_at x, y
+          right_mouse_up_at x, y
+          stall :right_click
+        end
+        
+        #
+        # Used to perform a key down on this view in the remote application
+        #
+        # You can either type a printable character or a function key. If you want to type a printable
+        # character then the 'key' parameter just has to be a string, such as 'a'. If you want to type
+        # a function key such as F1, then the 'key' parameter must be the corresponding symbol. 
+        #
+        # Example:
+        #
+        #   view.key_down 'a'       # key down for printable character 'a'
+        #   view.key_down :delete   # key down for function key delete
+        #   view.key_down :meta_key # key down for the meta key
+        #
+        def key_down(key)
+          focus
+          @driver.sc_key_down action_target, key, *action_locator_args
+          stall :key_down
+        end
+
+        #
+        # Used to perform a key up on this view in the remote application
+        #
+        # You can either type a printable character or a function key. If you want to type a printable
+        # character then the 'key' parameter just has to be a string, such as 'a'. If you want to type
+        # a function key such as F1, then the 'key' parameter must be the corresponding symbol. 
+        #
+        # Example:
+        #
+        #   view.key_up 'a'       # key up for printable character 'a'
+        #   view.key_up :delete   # key up for function key delete
+        #   view.key_up :meta_key # key up for the meta key
+        #
+        def key_up(key)
+          focus
+          @driver.sc_key_up action_target, key, *action_locator_args
+          stall :key_up
+        end
+
+        #
+        # Used to type a key on this view in the remote application. This will cause a key down followed
+        # by a key up
+        #
+        # You can either type a printable character or a function key. If you want to type a printable
+        # character then the 'key' parameter just has to be a string, such as 'a'. If you want to type
+        # a function key such as F1, then the 'key' parameter must be the corresponding symbol. 
+        #
+        # Example:
+        #
+        #   view.type_key 'a'      # type printable character 'a'
+        #   view.type_key :delete  # type function key delete
+        #
+        def type_key(key)
+          focus
+          @driver.sc_type_key action_target, key, *action_locator_args
+          stall :type_key
+        end 
+        
+        def type(text)
+          focus
+          @driver.sc_type action_target, text, *action_locator_args
+          stall :type_key
+        end
+        
+        def focus()
+          @driver.sc_focus action_target, *action_locator_args
+        end
+        
+        def drag(x, y, relative_to=nil)
+          if (not x.kind_of? Integer) or (not y.kind_of? Integer)
+            raise ArgumentError.new "Must supply valid x-y coordinates: x = #{x}, y = #{y}" 
+          end
+          
+          relative_to = relative_to.kind_of?(Hash) ? relative_to[:relative_to] : relative_to
+          
+          self.scroll_to_visible
+          mouse_down_at 0, 0
+          mouse_move_at 0, 0
+          relative_to.scroll_to_visible if relative_to.kind_of?(PositionedElement)
+          
+          rel_x = 0
+          rel_y = 0     
+          
+          if not relative_to.nil?
+            position = self.position
+            rel_x = rel_x + position.x * -1
+            rel_y = rel_y + position.y * -1
+            if relative_to.kind_of? PositionedElement
+              position = relative_to.position
+              rel_x = rel_x + position.x
+              rel_y = rel_y + position.y
+            elsif relative_to == :window
+            else
+              raise ArgumentError.new "relative to source must be a positioned element: #{relative_to.class}"
+            end
+          end
+          
+          rel_x = rel_x + x
+          rel_y = rel_y + y
+          
+          mouse_move_at rel_x, rel_y
+          mouse_up_at rel_x, rel_y
+          
+          stall :drag 
+        end
+        
+        def drag_to(source, offset_x=nil, offset_y=nil)
+          if not (source.kind_of? PositionedElement or source == :window)
+            raise ArgumentError.new "source must be an positioned element: #{source.class}"
+          end
+          
+          offset_x = offset_x.nil? ? 0 : offset_x
+          offset_y = offset_y.nil? ? 0 : offset_y
+          
+          drag offset_x, offset_y, source
+        end
+        
+        def drag_on_to(source)
+          drag_to source, 1, 1
+        end
+        
+        def drag_before(item)
+          assert_item_has_collection_item_view_support(item, 'item')
+          return if not item.can_drag_before?
+          item.apply_drag_before self
+        end
+        
+        def drag_after(item)
+          assert_item_has_collection_item_view_support(item, 'item')
+          return if not item.can_drag_after?
+          item.apply_drag_after self
+        end
+        
+        def drag_to_start_of(view)
+          assert_is_collection_view(view, 'view');
+          return if not view.can_drag_to_start_of?
+          view.apply_drag_to_start_of self
+        end
+        
+        def drag_to_end_of(view)
+          assert_is_collection_view(view, 'view');
+          return if not view.can_drag_to_end_of?
+          view.apply_drag_to_end_of self
+        end    
+      
+      protected
+        
+        #
+        # Override this to supply the target, which can either be one of the following:
+        #
+        #   :view
+        #   :core_query_element
+        #
+        def action_target()
+          
+        end
+        
+        #
+        # Override this to supply the arguments to generate the locator
+        #
+        def action_locator_args()
+          
+        end
+        
+      private
+      
+        def assert_is_collection_view(value, name)
+          if not value.kind_of? Lebowski::Foundation::Views::CollectionView
+            raise ArgumentInvalidTypeError.new name, value, Lebowski::Foundation::Views::CollectionView
+          end
+        end
+
+        def assert_item_has_collection_item_view_support(value, name)
+          if not value.respond_to? :has_collection_item_view_support
+            raise ArgumentError.new "#{name} must have collection item view support (#{CollectionItemViewSupport})"
+          end
+        end
+      
+      end
+    end
+  end
+end

data/lib/lebowski/foundation/mixins/wait_actions.rb

@@ -0,0 +1,44 @@
+module Lebowski
+  module Foundation
+    
+    module Mixins
+  
+      #
+      # Mixin provides actions to wait on something. By waiting no further action
+      # will be taken until a condition has been met or a timeout has been reached.
+      #
+      module WaitActions
+        include Lebowski::Foundation
+      
+        DEFAULT_TIMEOUT = 10 # seconds
+        
+        def wait_until(timeout=nil, &block)
+          timeout = timeout.nil? ? DEFAULT_TIMEOUT : timeout
+          
+          if not timeout.kind_of? Integer or timeout <= 0
+            raise ArgumentError.new "Must supply a valid timeout that is greater than 0"
+          end
+          
+          if not block_given?
+            raise ArgumentError.new "Must supply a block"
+          end
+        
+          start_time = Time.now
+          current_time = Time.now
+        
+          while (current_time - start_time) < timeout
+            result = yield self
+            return if (result == true)
+            sleep 0.5
+            current_time = Time.now
+          end
+          
+          raise TimeoutError.new "Timed out after #{timeout} seconds"
+          
+        end
+
+      end
+      
+    end
+  end
+end

data/lib/lebowski/foundation/object_array.rb

@@ -0,0 +1,305 @@
+# ==========================================================================
+# Project:   Lebowski Framework - The SproutCore Test Automation Framework
+# License:   Licensed under MIT license (see License.txt)
+# ==========================================================================
+
+module Lebowski
+  module Foundation
+   
+    #
+    # Represents an array of proxied objects. Use this for any proxy object that has a property
+    # that is an array of objects within the browser. Provides a set of common functionality to 
+    # check and access proxied objects within the array.
+    #
+    # Many of the methods for the class accept a filter as input. The filter can either be a 
+    # type of SproutCore object or a hash made of properties with values that must be matched.
+    # For instance, let's say that you want to find all the objects that are of the type
+    # 'SC.Foo'. You would do the following:
+    #
+    #   found = obj.object_array.find_all('SC.Foo')
+    #
+    # Only those objects in the array that are of type SC.Foo will be returned. As another
+    # example, we want to find all the objects in the array that have a property called 
+    # "foo" have a matching value of "bar". You would do the following:
+    #
+    #   found = obj.object_array.find_all({ :foo => 'bar' })
+    #
+    # Only those objects that have the property foo with value 'bar' will be returned. Instead
+    # of just a string value, you can also provided a regular expression, like so:
+    #
+    #   found = obj.object_array.find_all({ :foo => /bar/i })
+    #
+    # You are not limited to just one key-value pair; you can have as many as you like:
+    #
+    #   found = object.object_array.find_all({ :foo => /bar/i, :title => 'hello' })
+    #
+    # Only objects that satisfy all of the filter's conditions will be returned.
+    #
+    class ObjectArray
+      include Lebowski::Foundation
+      
+      def initialize(parent, array_rel_path, array_length_property_name=nil, *params)
+        init_validate_parent parent
+        
+        @parent = parent
+        @array_rel_path = array_rel_path
+        @array_length_property_name = array_length_property_name.nil? ? 'length' : array_length_property_name
+        @driver = parent.driver
+        @prefilter = {}
+        
+        if not params.empty?
+          if params[0].kind_of?(Hash) and params[0].has_key?(:prefilter) 
+            @prefilter = params[0][:prefilter] 
+          else
+            @prefilter = params[0]
+          end
+        end
+        
+      end
+      
+      def prefilter()
+        return @prefilter.clone
+      end
+      
+      def filter(filter)
+        merged_filter = merge_filter_with_prefilter(filter)
+        return create_filtered_object_array(@parent, @array_rel_path, @array_length_property_name, merged_filter)
+      end
+      
+      def find_indexes(filter=nil)
+        raise ArgumentError.new "No filter was supplied" if (filter.nil? and @prefilter.empty?)
+        
+        if filter.nil?
+          filter = {}
+        elsif filter.kind_of? String
+          filter = { :sc_type => filter }
+        elsif filter.kind_of?(Class) and filter.ancestors.member?(SCObject)
+          filter = { :sc_type => filter.represented_sc_class }
+        elsif filter.kind_of?(Hash)
+          if filter.has_key? :sc_type
+            type = filter[:sc_type]
+            if type.kind_of?(Class) and type.ancestors.member?(SCObject)
+              filter[:sc_type] = type.represented_sc_class
+            end
+          end
+        else
+          raise ArgumentInvalidTypeError.new "filter", filter, 'class < SCObject', String, Hash
+        end
+        
+        filter = merge_filter_with_prefilter(filter)
+        
+        processed_filter = find_indexes_process_filter(filter)
+        raise StandardError.new "process filter can not be nil" if processed_filter.nil?
+        
+        if not processed_filter.empty?
+          sc_path = @parent.abs_path_with(@array_rel_path)
+          indexes = @driver.get_sc_object_array_index_lookup(sc_path, processed_filter)
+          return indexes if indexes.empty?
+        else
+          val = unfiltered_count
+          return [] if val <= 0 
+          indexes = (0..(val - 1))
+        end
+        
+        processed_indexes = find_indexes_process_indexes(indexes)
+        raise StandardError.new "process indexes can not be nil" if processed_indexes.nil?
+        
+        return processed_indexes  
+        
+      end
+      
+      #
+      # Returns the number of child views this view has
+      #
+      def count(filter=nil, &block)
+        if @prefilter.empty? and filter.nil? and (not block_given?)
+          return unfiltered_count
+        elsif not block_given?
+          return find_indexes(filter).length
+        end
+        
+        counter = 0
+        each filter do |view, index|
+          result = yield view, index
+          counter = counter.next if (result == true)
+        end
+        return counter
+      end
+
+      def [](index, expected_type=nil)
+        error = ArgumentError.new "index is out of bounds: #{index}" 
+        
+        if (not index.kind_of? Integer) or index < 0
+          raise error
+        end
+        
+        if @prefilter.empty?
+          raise error if (index >= count)
+          return create_object(index, expected_type)
+        else
+          indexes = find_indexes
+          raise error if (index >= indexes.length)
+          return create_object(indexes[index], expected_type)
+        end
+      end
+      
+      def first(expected_type=nil)
+        return self[0, expected_type]
+      end
+      
+      def last(expected_type=nil)
+        return self[count - 1, expected_type]
+      end
+
+      def each(filter=nil, &block)
+        raise ArgumentError.new "block is required" if (not block_given?)
+
+        indexes = []
+        if @prefilter.empty? and filter.nil?
+          value = count
+          return if (value == 0)
+          indexes = (0..(value - 1))        
+          
+          indexes.each do |index| 
+            yield create_object(index), index  
+          end
+        else
+          indexes = find_indexes(filter)
+          return if indexes.empty?
+          
+          (0..(indexes.length - 1)).each do |i|
+            yield create_object(indexes[i]), i  
+          end
+        end
+      end
+      
+      alias_method :each_with_index, :each
+
+      def find_all(filter=nil, &block)
+        if filter.nil? and (not block_given?)
+          raise ArugmentError.new "Must provide at least a filter or a block"
+        end
+        
+        collected = []
+        each filter do |view, index|
+          if block_given?
+            result = yield view, index
+            collected << result if not result.nil?
+          else
+            collected << view
+          end
+        end
+        return collected
+      end
+      
+      def find_first(filter, expected_type=nil)
+        if filter.nil?
+          raise ArgumentError.new "filter can not be nil"
+        end
+        
+        indexes = find_indexes(filter)
+        return nil if indexes.empty?
+        return create_object(indexes[0], expected_type)
+      end
+      
+      def find_last(filter, expected_type=nil)
+        if filter.nil?
+          raise ArgumentError.new "filter can not be nil"
+        end
+        
+        indexes = find_indexes(filter)
+        return nil if indexes.empty?
+        return create_object(indexes[indexes.length - 1], expected_type)
+      end
+      
+      def index_of(obj)
+        return -1 if (not obj.kind_of? ProxyObject)
+        indexes = find_indexes({ :sc_guid => obj.sc_guid })
+        return indexes.empty? ? -1 : indexes[0]
+      end
+      
+      def member?(obj)
+        return (index_of(obj) >= 0)
+      end
+
+      def all?(filter=nil, &block)
+        return (count(filter, &block) == count)
+      end
+
+      def any?(filter=nil, &block)
+        return (count(filter, &block) > 0)
+      end
+      
+      alias_method :some?, :any?
+
+      def none?(filter=nil, &block)
+        return (count(filter, &block) == 0)
+      end
+
+      def one?(filter=nil, &block)
+        return (count(filter, &block) == 1)
+      end
+      
+      def empty?()
+        return (count == 0)
+      end
+      
+    protected
+    
+      def create_object(index, expected_type=nil)
+        rel_path = "#{@array_rel_path}.#{index}"
+        return @parent[rel_path, expected_type]
+      end
+      
+      def create_filtered_object_array(parent, array_rel_path, array_length_property_name, prefilter)
+        klass = self.class
+        return klass.new parent, array_rel_path, array_length_property_name, prefilter
+      end
+      
+      def init_validate_parent(parent)
+        if not parent.kind_of? ProxyObject
+          raise ArgumentInvalidTypeError.new "parent", parent, ProxyObject
+        end
+      end
+      
+      def find_indexes_process_filter(filter)
+        return filter
+      end
+      
+      def find_indexes_process_indexes(indexes)
+        return indexes
+      end
+      
+    private
+    
+      def unfiltered_count()
+        return @parent["#{@array_rel_path}.#{@array_length_property_name}"]
+      end
+      
+      def merge_filter_with_prefilter(filter)
+        
+        if filter.kind_of? String
+          filter = { :sc_type => filter }
+        elsif filter.kind_of?(Class) and filter.ancestors.member?(SCObject)
+          filter = { :sc_type => filter.represented_sc_class }
+        elsif not filter.kind_of?(Hash)
+          raise ArgumentInvalidTypeError.new "filter", filter, Hash
+        end
+        
+        merged_filter = {}
+        
+        @prefilter.each do |key, value|
+          merged_filter[key] = value
+        end
+        
+        filter.each do |key, value|
+          merged_filter[key] = value if (not merged_filter.has_key? key)
+        end
+        
+        return merged_filter
+      end
+      
+    end
+       
+  end
+end