automation_object 0.6.0 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c6397d7cf9b93c229e3184d39b5c97a674fe1b1
-  data.tar.gz: dd8e110716616306e04f0c6b31130473b98ababc
+  metadata.gz: cb439ab990fae3fa652a146ce651524dfebc2e48
+  data.tar.gz: 258df7188016240e3e41a3879af8b6554e06afa2
 SHA512:
-  metadata.gz: 17a499eb9a9d18f29a0a44ba088a3a15d53f6fae349fb3a6c53615ef5f3e0eb0ee7feecd2bd8bb4c7874130f9a354f133ffe34f06dd8a6fbf0a4cb000d7f6bf5
-  data.tar.gz: deb26da5fc8ee5e6f473f3333303c3e3e8880f78e101aded3cee357559963bda93ee8ab24cdcaeba6462fc6d6931cda95fef199d1bf22081d43f95af9d625706
+  metadata.gz: 49e8cfc6f45c6baaa6cda9cdd4b27b8184af332791c69309411fcb391389b767e5cd9d55d068b09a9c1fd948b69188a6075400648e31b10b130004149637846b
+  data.tar.gz: 821123032d2a696c7cf12b7b1a15e8d700adecde0259f63db9c828fcd4c64237bb1fbc714a32c26b1b27e4e1f22205d633d9c0599c2a2ab657198cd42e155db4

data/lib/automation_object/blue_print/hash_adapter/hook_action.rb

@@ -21,7 +21,7 @@ module AutomationObject
         validates :change_to_previous_screen, instance_of: TrueClass
         validates :close_modal, instance_of: TrueClass
         validates :close_screen, instance_of: TrueClass
-        validates :possible_screen_changes, instance_of: String, screen_presence_of: true
+        validates :possible_screen_changes, instance_of: Array, screen_presence_of: true
         validates :reset_screen, instance_of: TrueClass
         validates :show_modal, instance_of: String, modal_presence_of: true
         validates :sleep, instance_of: Numeric

data/lib/automation_object/driver/appium_adapter/driver.rb

@@ -17,6 +17,9 @@ module AutomationObject
       class Driver < AutomationObject::Proxy::Proxy
         include AutomationObject::Driver::CommonSelenium::Driver
 
+        DOCUMENT_COMPLETE_LOOPS = 5
+        DOCUMENT_COMPLETE_SLEEP = 0.2
+
         # @param driver [Appium::Driver] Appium Driver
         def initialize(driver)
           @subject = driver
@@ -138,7 +141,20 @@ module AutomationObject
         # @return [Boolean] document is complete
         def document_complete?
           return true unless browser? # Skip for non-browser Appium sessions
-          @subject.execute_script('return document.readyState;') == 'complete'
+
+          # Loop through a few times to double check correctness
+          DOCUMENT_COMPLETE_LOOPS.times do
+            sleep(DOCUMENT_COMPLETE_SLEEP)
+            return false unless @subject.execute_script('return document.readyState;') == 'complete'
+          end
+
+          true
+        end
+
+        # Close current window
+        # @return [void]
+        def close
+          @subject.close
         end
 
         # @return [void]

data/lib/automation_object/driver/driver.rb

@@ -86,6 +86,12 @@ module AutomationObject
         adapter.browser?
       end
 
+      # Close current window
+      # @return [void]
+      def close
+        adapter.close
+      end
+
       # Window Handles
       # @return [Array<String>] array of window handle ids
       def window_handles
@@ -101,7 +107,7 @@ module AutomationObject
       # Set current window handle to, will switch windows
       # @param handle_value [String] window handle value
       def window_handle=(handle_value)
-        adapter.window_handle(handle_value)
+        adapter.window_handle = handle_value
       end
 
       # Run script in browser to check if document in JS is complete

data/lib/automation_object/driver/nokogiri_adapter/driver.rb

@@ -30,6 +30,12 @@ module AutomationObject
           find_element(:xpath, '//title').text
         end
 
+        # Close current window
+        # @return [void]
+        def close
+          session.close
+        end
+
         def back
           session.back
         end

data/lib/automation_object/driver/selenium_adapter/driver.rb

@@ -15,6 +15,9 @@ module AutomationObject
       class Driver < AutomationObject::Proxy::Proxy
         include AutomationObject::Driver::CommonSelenium::Driver
 
+        DOCUMENT_COMPLETE_LOOPS = 5
+        DOCUMENT_COMPLETE_SLEEP = 0.2
+
         # @param driver [Selenium::WebDriver::Driver] Selenium Web Driver
         def initialize(driver)
           @subject = driver
@@ -117,10 +120,22 @@ module AutomationObject
           @subject.switch_to.window(handle_value)
         end
 
+        # Close current window
+        # @return [void]
+        def close
+          @subject.close
+        end
+
         # Run script in browser to check if document in JS is complete
         # @return [Boolean] document is complete
         def document_complete?
-          @subject.execute_script('return document.readyState;') == 'complete'
+          # Loop through a few times to double check correctness
+          DOCUMENT_COMPLETE_LOOPS.times do
+            sleep(DOCUMENT_COMPLETE_SLEEP)
+            return false unless @subject.execute_script('return document.readyState;') == 'complete'
+          end
+
+          true
         end
 
         # Destroy the driver

data/lib/automation_object/dsl/_base.rb

@@ -19,6 +19,10 @@ module AutomationObject
         super ostruct_hash
       end
 
+      def to_s
+        inspect
+      end
+
       # @param _indent [Integer]
       # @return [String]
       def inspect(_indent = 5)
@@ -36,9 +40,8 @@ module AutomationObject
       # @param indent [Integer]
       # @return [String]
       def formatted_name(key, indent)
-        # TODO: finish
-        # color = self[key].alive? ? :green : :blue
-        "\n#{' ' * indent} #{key}:".colorize(:green)
+        color = self[key].active? ? :green : :blue
+        "\n#{' ' * indent} #{key}:".colorize(color)
       end
 
       # @param value [Object]

data/lib/automation_object/dsl/_proxy.rb

@@ -8,8 +8,8 @@ module AutomationObject
     # Prevents inspection from picking up internal methods
     class Proxy < AutomationObject::Proxy::Proxy
       # @param subject_class [AutomationObject::Dsl::CompositeBase, nil]
-      # @param blue_prints [AutomationObject::BluePrint::Composite::CompositeBase]
-      # @param state [AutomationObject::State::Session]
+      # @param blue_prints [AutomationObject::BluePrint::Composite::Base]
+      # @param state [AutomationObject::State::Base]
       # @param name [Symbol]
       def initialize(subject_class, blue_prints, state, name)
         @blue_prints = blue_prints

data/lib/automation_object/dsl/element.rb

@@ -10,10 +10,11 @@ module AutomationObject
     # Proxy for Element
     class ElementProxy < Proxy
       # @param [AutomationObject::BluePrint::Composite::Element] blue_prints
-      # @param [AutomationObject::State::Session] state
+      # @param [AutomationObject::State::Modal, AutomationObject::State::Screen] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        super Element, blue_prints, state, name
+        element_state = state.elements[name]
+        super Element, blue_prints, element_state, name
       end
 
       # @param [Symbol] method
@@ -22,10 +23,15 @@ module AutomationObject
       def method_missing(method, *args, &block)
         return super if Element.methods.include?(method)
 
-        @subject = @state.load(:element, @name)
+        @subject = @state.utilize
 
         super
       end
+
+      # @return [Boolean]
+      def active?
+        @state.active?
+      end
     end
   end
 end

data/lib/automation_object/dsl/element_array.rb

@@ -10,10 +10,11 @@ module AutomationObject
     # Proxy for ElementArray
     class ElementArrayProxy < Proxy
       # @param [AutomationObject::BluePrint::Composite::ElementArray] blue_prints
-      # @param [AutomationObject::State::Session] state
+      # @param [AutomationObject::State::Modal, AutomationObject::State::Screen] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        super ElementArray, blue_prints, state, name
+        element_array_state = state.element_arrays[name]
+        super ElementArray, blue_prints, element_array_state, name
       end
 
       # @param [Symbol] method
@@ -22,10 +23,15 @@ module AutomationObject
       def method_missing(method, *args, &block)
         return super if ElementArray.methods.include?(method)
 
-        @subject = @state.load(:element_array, @name)
+        @subject = @state.utilize
 
         super
       end
+
+      # @return [Boolean]
+      def active?
+        @state.active?
+      end
     end
   end
 end

data/lib/automation_object/dsl/element_hash.rb

@@ -10,10 +10,11 @@ module AutomationObject
     # Proxy for ElementHash
     class ElementHashProxy < Proxy
       # @param [AutomationObject::BluePrint::Composite::ElementHash] blue_prints
-      # @param [AutomationObject::State::Session] state
+      # @param [AutomationObject::State::Modal, AutomationObject::State::Screen] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        super ElementHash, blue_prints, state, name
+        element_hash_state = state.element_hashes[name]
+        super ElementHash, blue_prints, element_hash_state, name
       end
 
       # @param [Symbol] method
@@ -22,10 +23,15 @@ module AutomationObject
       def method_missing(method, *args, &block)
         return super if ElementHash.methods.include?(method)
 
-        @subject = @state.load(:element_hash, @name)
+        @subject = @state.utilize
 
         super
       end
+
+      # @return [Boolean]
+      def active?
+        @state.active?
+      end
     end
   end
 end

data/lib/automation_object/dsl/modal.rb

@@ -18,10 +18,11 @@ module AutomationObject
     # Proxy for Modal
     class ModalProxy < Proxy
       # @param [AutomationObject::BluePrint::Composite::Modal] blue_prints
-      # @param [AutomationObject::State::Session] state
+      # @param [AutomationObject::State::Screen] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        super Modal, blue_prints, state, name
+        modal_state = state.modals[name]
+        super Modal, blue_prints, modal_state, name
       end
 
       # @param [Symbol] method
@@ -31,13 +32,15 @@ module AutomationObject
         return super if Modal.methods.include?(method)
 
         # Attempt to load modal if composite object contains that child
-        if @subject.to_h.include?(method)
-          # puts "@state.load(:modal, #{@name})"
-          @state.load(:modal, @name)
-        end
+        @state.utilize if @subject.to_h.include?(method)
 
         super
       end
+
+      # @return [Boolean]
+      def active?
+        @state.active?
+      end
     end
   end
 end

data/lib/automation_object/dsl/screen.rb

@@ -20,10 +20,11 @@ module AutomationObject
     # Proxy for Screen
     class ScreenProxy < Proxy
       # @param [AutomationObject::BluePrint::Composite::Screen] blue_prints
-      # @param [AutomationObject::State::Session] state
+      # @param [AutomationObject::State::Top] top state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        super Screen, blue_prints, state, name
+        screen_state = state.screens[name]
+        super Screen, blue_prints, screen_state, name
       end
 
       # @param [Symbol] method
@@ -33,17 +34,14 @@ module AutomationObject
         return super if Screen.methods.include?(method)
 
         # Attempt to load screen if composite object contains that child
-        if @subject.to_h.include?(method)
-          # puts "@state.load(:screen, #{@name})"
-          @state.load(:screen, @name)
-        end
+        @state.utilize if @subject.to_h.include?(method)
 
         super
       end
 
       # @return [Boolean]
       def active?
-        @state.active?(:screen, @name)
+        @state.active?
       end
     end
   end

data/lib/automation_object/dsl/top.rb

@@ -14,12 +14,16 @@ module AutomationObject
     # Proxy for Top Composite
     # Use proxy for methods trying to do a @state call
     class TopProxy < Proxy
-      # @param [AutomationObject::BluePrint::Composite::Top] blue_prints
-      # @param [AutomationObject::State::Session] state
-      # @param [Symbol] name
+      # @param blue_prints [AutomationObject::BluePrint::Composite::Top]
+      # @param state [AutomationObject::State::Top] top composite
+      # @param name [Symbol]
       def initialize(blue_prints, state, name)
         super Top, blue_prints, state, name
       end
+
+      def active?
+        true
+      end
     end
   end
 end

data/lib/automation_object/state/_base.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+require_relative '../helpers/composite'
+
+module AutomationObject
+  module State
+    # Parent composite class
+    class Base < ::AutomationObject::Composite
+      # @return [AutomationObject::Driver::Driver]
+      attr_accessor :driver
+
+      # @return [AutomationObject::BluePrint::Composite::Base]
+      attr_accessor :blue_prints
+
+      # @param driver [AutomationObject::Driver] driver
+      # @param blue_prints [AutomationObject::BluePrint::Composite::Base] blue print composite
+      # @param name [Symbol] name of composite element
+      # @param parent [Object, nil] parent composite object
+      # @param location [String] string location for error/debugging purposes
+      def initialize(driver, blue_prints, name = :top, parent = nil, location = 'top')
+        self.driver = driver
+        self.blue_prints = blue_prints
+
+        super(name, parent, location)
+      end
+
+      # Overriding base get_child method
+      # @param name [Symbol] name of child
+      # @param args [Hash] args
+      def get_child(name, args)
+        child_location = location + "[#{name}]"
+
+        args.fetch(:interface).new(driver,
+                                   blue_prints.send(name),
+                                   name, self, child_location)
+      end
+
+      # Overriding base get_children method
+      # @param name [Symbol] name of child
+      # @param args [Hash] args
+      # @return children [Array<Composite>] return children and names
+      def get_children(name, args)
+        children_hash = {}
+
+        blue_prints.send(name).each do |child_key, child_blue_prints|
+          child_location = location + "[#{child_key}]"
+
+          children_hash[child_key] = args.fetch(:interface).new(driver,
+                                                                child_blue_prints,
+                                                                name, self, child_location)
+        end
+
+        children_hash
+      end
+
+      # Recursive function to reach parent screen
+      # Can return nil if above a screen!
+      # @return [AutomationObject::State::Screen,nil]
+      def screen
+        return nil if is_a?(Top)
+
+        # Should recursively call top until parent is nil
+        is_a?(Screen) ? self : parent.screen
+      end
+
+      # Recursive function to reach top
+      # @return [AutomationObject::State::Top]
+      def top
+        is_a?(Top) ? self : parent.top
+      end
+    end
+  end
+end

data/lib/automation_object/state/_common_element.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require_relative 'hook'
+
+module AutomationObject
+  module State
+    # Helper module for Element composite classes
+    module CommonElement
+      attr_accessor :cache
+
+      # Whether or not modal is active
+      attr_accessor :active
+
+      # @return [Boolean] screen is active or not
+      def active?
+        @active ||= false
+      end
+
+      def reset
+        @active = false
+        self.cache = nil
+      end
+
+      def method_hook?(name)
+        blue_prints.method_hooks.key?(name)
+      end
+
+      # @return [Hash<Hook>] array of Hook that are defined under the element
+      def method_hooks
+        return @method_hooks if @method_hooks
+
+        @method_hooks = {}
+        blue_prints.method_hooks.each do |key, blue_prints|
+          @method_hooks[key] = Hook.new(driver,
+                                        blue_prints,
+                                        key,
+                                        self,
+                                        location + "[#{key}]")
+        end
+
+        @method_hooks
+      end
+    end
+  end
+end