automation_object 0.0.4 → 0.5.0

data/lib/automation_object/driver/element.rb

@@ -1,242 +1,83 @@
-#Thread Safe Execution Purposes
+require_relative 'base'
+require_relative 'driver'
+
 module AutomationObject
   module Driver
-    class Element
-      @@throttle_methods = {
-          'click' => 2, #Slow down, browser given back before navigation is finished
-          #'location_once_scrolled_into_view' => 0.5 #Appeared where Firefox was failing, add a little more time
-      }
-      @@minimum_speed = 0 #0.01
-
-      @@scroll_into_view_methods = [:click, :tap, :hover, :send_keys]
-
-      def self.throttle_methods
-        @@throttle_methods
-      end
-
-      def self.throttle_methods=(value)
-        @@throttle_methods = value
-      end
-
-      def self.minimum_speed
-        @@minimum_speed
-      end
-
-      def self.minimum_speed=(value)
-        @@minimum_speed = value
-      end
-
-      def initialize(driver_object, element_object)
-        @driver_object = driver_object
-        @element_object = element_object
-      end
-
-      def respond_to?(method_symbol, include_private = false)
-        return true if super
-        return @element_object.respond_to?(method_symbol, include_private)
-      end
-
-      def method_missing(method_symbol, *arguments, &block)
-        if @@scroll_into_view_methods.include?(method_symbol)
-          self.scroll_into_view
-        end
-
-        @driver_object.mutex_object.synchronize do
-          start_time = Time.new.to_f
-          element_object_return = @element_object.send(method_symbol, *arguments, &block)
-
-          self.throttle_speed(method_symbol, start_time)
-
-          total_time_taken = (Time.new.to_f-start_time)
-          AutomationObject::Logger::add_driver_element_message(total_time_taken, caller_locations, method_symbol, *arguments, &block)
-
-          return element_object_return
-        end
-      end
-
-      def throttle_speed(method_symbol, start_time)
-        method_string = method_symbol.to_s
-
-        throttle_time_minimum = @@minimum_speed
-        if @@throttle_methods.is_a?(Hash)
-          if @@throttle_methods.has_key?(method_string)
-            throttle_time_minimum = @@throttle_methods[method_string].to_f
-          end
-        end
-
-        time_difference = Time.new.to_f - start_time
-
-        if time_difference < throttle_time_minimum
-          sleep((throttle_time_minimum-time_difference))
-        end
-      end
-
-      def collides_with_element?(second_element_object, collision_tolerance = false)
-        box_one = self.get_box_coordinates
-        box_two = second_element_object.get_box_coordinates
-
-        collision_tolerance = 0 unless collision_tolerance.is_a?(Numeric)
-
-        if box_one[:x2] > box_two[:x1] and box_one[:x1] < box_two[:x2] and box_one[:y2] > box_two[:y1] and box_one[:y1] < box_two[:y2]
-          if box_one[:x2] > (box_two[:x1] + collision_tolerance) and (box_one[:x1] + collision_tolerance) < box_two[:x2] and
-              box_one[:y2] > (box_two[:y1] + collision_tolerance) and (box_one[:y1] + collision_tolerance) < box_two[:y2]
-            return true
-          else
-            return false
-          end
-        else
-          return false
-        end
-      end
-
-      def get_box_coordinates
-        element_location = self.location
-        element_size = self.size
-
-        box_coordinates = Hash.new
-        box_coordinates[:x1] = element_location.x.to_f
-        box_coordinates[:y1] = element_location.y.to_f
-        box_coordinates[:x2] = element_location.x.to_f + element_size.width.to_f
-        box_coordinates[:y2] = element_location.y.to_f + element_size.height.to_f
-
-        return box_coordinates
-      end
-
-      def attribute(key, value = false)
-        @driver_object.mutex_object.synchronize do
-          return @element_object.attribute(key) unless value
-        end
-
-        script = "return arguments[0].#{key} = '#{value}'"
-        @driver_object.execute_script(script, @element_object)
-
-        @driver_object.mutex_object.synchronize do
-          return @element_object.attribute(key)
-        end
-      end
-
-      def switch_to_iframe
-        @driver_object.switch_to.frame(self.get_iframe_switch_value)
-      end
-
-      def get_iframe_switch_value
-        iframe_switch_value = self.attribute('id')
-        if iframe_switch_value.length == 0
-          iframe_switch_value = self.attribute('name')
-        end
-
-        unless iframe_switch_value
-          iframe_switch_value = self.attribute('name', SecureRandom.hex(16))
-        end
-
-        return iframe_switch_value
-      end
-
-      def get_element_center
-        element_location = self.location
-        element_size = self.size
-
-        center = Hash.new
-        center[:x] = (element_location.x.to_f + element_size.width.to_f/2).to_f
-        center[:y] = (element_location.y.to_f + element_size.height.to_f/2).to_f
-
-        return center
+    class Element < Base
+      # Set or Get attribute
+      # @param key [String] key of element
+      # @param value [String, nil] set value or leave blank
+      # @return [String, nil]
+      def attribute(key, value = nil)
+        self.adapter.attribute(key, value)
       end
 
-      def x
-        return self.location.x
+      # @return [String] id of element
+      def id
+        self.adapter.id
       end
 
-      def y
-        return self.location.y
+      # @return [String] href of element
+      def href
+        self.adapter.href
       end
 
-      def width
-        return self.size.width
+      # Text of element
+      # @return [String, nil]
+      def text
+        self.adapter.text
       end
 
-      def height
-        return self.size.height
+      # Type into an element
+      # @return [void]
+      def send_keys(string)
+        self.adapter.send_keys(string)
       end
 
-      def hover
-        self.scroll_into_view
-        @driver_object.action.move_to(@element_object).perform
+      # Clear the element field
+      # @return [void]
+      def clear
+        self.adapter.clear
       end
 
+      # @return [Boolean]
       def visible?
-        return self.displayed?
+        self.adapter.visible?
       end
 
+      # @return [Boolean]
       def invisible?
-        return self.displayed? ? false : true
+        self.adapter.invisible?
       end
 
-      def id
-        return self.attribute('id').to_s
+      # Get the location
+      # @return [Point]
+      def location
+        self.adapter.location
       end
 
-      def href
-        return self.attribute('href').to_s
+      # Get the size of an element
+      # @return [Dimension]
+      def size
+        self.adapter.size
       end
 
-      def content
-        return self.attribute('content').to_s
+      # Perform a submit action on an element
+      # @return [void]
+      def submit
+        self.adapter.submit
       end
 
+      # Scroll the element into view
+      # @return [void]
       def scroll_into_view
-        return self.scroll_to_view
+        self.adapter.scroll_into_view
       end
 
-      def scroll_to_view
-        self.location_once_scrolled_into_view
-
-        if @driver_object.is_mobile?
-          return unless @driver_object.is_browser?
-
-          element_center = self.get_element_center
-          window_height = @driver_object.execute_script('return window.innerHeight;').to_f
-          current_y_position = @driver_object.execute_script('var doc = document.documentElement; return (window.pageYOffset || doc.scrollTop)  - (doc.clientTop || 0);').to_f
-
-          if element_center[:y] < (window_height/2)
-            ideal_y_position = (current_y_position + element_center[:y] - (window_height.to_f / 2.0)).abs
-          else
-            ideal_y_position = (current_y_position - element_center[:y] + (window_height.to_f / 2.0)).abs
-          end
-
-          @driver_object.execute_script("window.scroll(#{element_center[:x].to_f},#{ideal_y_position});")
-          #Just in case in close to the top or bottom bounds of the window
-          element_location = self.location_once_scrolled_into_view
-
-          if element_location[:y] < 0
-            current_y_position = @driver_object.execute_script('var doc = document.documentElement; return (window.pageYOffset || doc.scrollTop)  - (doc.clientTop || 0);').to_f
-            scroll_y_position = current_y_position + element_location[:y]
-            @driver_object.execute_script("window.scroll(#{element_location[:x].to_f},#{scroll_y_position});")
-          end
-        else
-          element_location = self.location
-
-          window_height = @driver_object.execute_script('return window.innerHeight;').to_f
-          current_scroll_position = @driver_object.execute_script('var doc = document.documentElement; return (window.pageYOffset || doc.scrollTop)  - (doc.clientTop || 0);').to_f
-
-          middle_y_bounds = current_scroll_position + window_height/2
-
-          if middle_y_bounds > element_location.y
-            #Add
-            y_difference = middle_y_bounds - element_location.y
-            scroll_y_position = current_scroll_position - y_difference
-          else
-            #Subtract
-            y_difference = element_location.y - middle_y_bounds
-            scroll_y_position = current_scroll_position + y_difference
-          end
-
-          #Get the element to halfway
-          scroll_x_position = element_location.x.to_f
-
-          javascript_string = "return window.scroll(#{scroll_x_position}, #{scroll_y_position});"
-          @driver_object.execute_script(javascript_string)
-        end
+      # Perform a click action on the element
+      # @return [void]
+      def click
+        self.adapter.click
       end
     end
   end

data/lib/automation_object/driver/helpers/selenium_driver_helper.rb

@@ -0,0 +1,41 @@
+module AutomationObject
+  module Driver
+    #Helper module for Selenium based drivers
+    #for use by SeleniumAdapter::Driver and AppiumAdapter::Driver
+    module SeleniumDriverHelper
+      # @return [Float] inner window height
+      def inner_window_height
+        @subject.execute_script('return window.innerHeight;').to_f
+      end
+
+      # @return [Hash] x,y scroll position
+      def scroll_position
+        position = OpenStruct.new
+
+        position.x = @subject.execute_script('var doc = document.documentElement; return (window.pageXOffset || doc.scrollLeft) - (doc.clientLeft || 0);').to_f
+        position.y = @subject.execute_script('var doc = document.documentElement; return (window.pageYOffset || doc.scrollTop) - (doc.clientTop || 0);').to_f
+
+        return position
+      end
+
+      def scroll_position=(position)
+        @subject.execute_script("window.scroll(#{position[:x]},#{position[:y]});")
+      end
+
+      # @param window_dimension [Hash] :width, :height of window
+      def window_size=(window_dimension)
+        @subject.manage.window.resize_to(window_dimension[:width], window_dimension[:height])
+      end
+
+      # @return [Hash] :width, :height of window
+      def window_size
+        @subject.manage.window.size
+      end
+
+      #Maximize the current window
+      def maximize_window
+        @subject.manage.window.maximize
+      end
+    end
+  end
+end

data/lib/automation_object/driver/helpers/selenium_element_helper.rb

@@ -0,0 +1,138 @@
+module AutomationObject
+  module Driver
+    #Helper module for Selenium based elements
+    #for use by SeleniumAdapter::Element and AppiumAdapter::Element
+    module SeleniumElementHelper
+      # @return [Numeric] x position of element
+      def x
+        @subject.location.x
+      end
+
+      # @return [Numeric] y position of element
+      def y
+        @subject.location.y
+      end
+
+      # @return [Numeric] width of element
+      def width
+        @subject.size.width
+      end
+
+      # @return [Numeric] height of element
+      def height
+        @subject.size.height
+      end
+
+      # @return [Boolean] element visible
+      def visible?
+        @subject.displayed?
+      end
+
+      # @return [Boolean] element invisible
+      def invisible?
+        @subject.displayed? ? false : true
+      end
+
+      # @return [String] id of element
+      def id
+        @subject.attribute('id').to_s
+      end
+
+      # @return [String] href of element
+      def href
+        @subject.attribute('href').to_s
+      end
+
+      # @return [Boolean] content of element
+      def content
+        @subject.attribute('content').to_s
+      end
+
+      # @param key [String] attribute key to get or set
+      # @param value [Object] optional value to set the key as
+      # @return [Object] value of attribute
+      def attribute(key, value = false)
+        if value
+          script = "return arguments[0].#{key} = '#{value}'"
+          @driver.execute_script(script, @subject)
+        end
+
+        @subject.attribute(key)
+      end
+
+      # @return [Hash] :x, :y coordinates
+      def element_center
+        element_location = @subject.location
+        element_size = @subject.size
+
+        center = OpenStruct.new
+        center.x = (element_location.x.to_f + element_size.width.to_f/2).to_f
+        center.y = (element_location.y.to_f + element_size.height.to_f/2).to_f
+
+        return center
+      end
+
+      # @return [Hash] :x1, :x2, :y1, :y2 coordinates of a box
+      def box_coordinates
+        element_location = @subject.location
+        element_size = @subject.size
+
+        box_coordinates = OpenStruct.new
+        box_coordinates.x1 = element_location.x.to_f
+        box_coordinates.y1 = element_location.y.to_f
+        box_coordinates.x2 = element_location.x.to_f + element_size.width.to_f
+        box_coordinates.y2 = element_location.y.to_f + element_size.height.to_f
+
+        return box_coordinates
+      end
+
+      # @param second_element_object [Object] element to compare to
+      # @param collision_tolerance [Numeric] pixel tolerance of collisions
+      # @return [Boolean] element collides with other
+      def collides_with_element?(second_element_object, collision_tolerance = false)
+        box_one = self.box_coordinates
+        box_two = second_element_object.box_coordinates
+
+        collision_tolerance = 0 unless collision_tolerance.is_a?(Numeric)
+
+        if box_one.x2 > box_two.x1 and box_one.x1 < box_two.x2 and box_one.y2 > box_two.y1 and box_one.y1 < box_two.y2
+          if box_one.x2 > (box_two.x1 + collision_tolerance) and (box_one.x1 + collision_tolerance) < box_two.x2 and
+              box_one.y2 > (box_two.y1 + collision_tolerance) and (box_one.y1 + collision_tolerance) < box_two.y2
+            return true
+          else
+            return false
+          end
+        else
+          return false
+        end
+      end
+
+      #Hover over element
+      def hover
+        self.scroll_into_view
+        @driver.action.move_to(@subject).perform
+      end
+
+      #Helper method to switch to this element's iframe
+      def switch_to_iframe
+        @driver.switch_to.frame(self.iframe_switch_value)
+      end
+
+      #Helper method for getting the value to switch to
+      #If value doesn't exist then create one
+      # @return [String] iframe value to switch to
+      def iframe_switch_value
+        iframe_switch_value = self.attribute('id')
+        if iframe_switch_value.length == 0
+          iframe_switch_value = self.attribute('name')
+        end
+
+        unless iframe_switch_value
+          iframe_switch_value = self.attribute('name', SecureRandom.hex(16))
+        end
+
+        return iframe_switch_value
+      end
+    end
+  end
+end