automation_object 0.7.6 → 0.8.0

data/lib/automation_object/dsl/screen.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_proxy'
+require_relative '_error'
 
 require_relative 'modal'
 require_relative 'element'
@@ -20,11 +22,10 @@ module AutomationObject
     # Proxy for Screen
     class ScreenProxy < Proxy
       # @param [AutomationObject::BluePrint::Composite::Screen] blue_prints
-      # @param [AutomationObject::State::Top] top state
+      # @param [AutomationObject::State::Top] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        screen_state = state.screens[name]
-        super Screen, blue_prints, screen_state, name
+        super Screen, blue_prints, state, name
       end
 
       # @param [Symbol] method
@@ -39,10 +40,73 @@ module AutomationObject
         super
       end
 
+      # Is the screen active
       # @return [Boolean]
       def active?
         @state.active?
       end
+
+      # Close screen
+      # @return [void]
+      def close
+        @state.close
+      end
+
+      # Go to this screen
+      # Will try to automatically reach it, will throw error if it cannot
+      # @raise [AutomationObject::Dsl::Error::AutoReachScreenError]
+      # @return [void]
+      def go
+        raise AutomationObject::Dsl::Error::AutoReachScreenError, @name unless @state.go
+      end
+
+      # Retrieve modal from composite
+      # @param name [String, Symbol] name of modal
+      # @raise [AutomationObject::Dsl::Error::ModalDoesNotExistError]
+      # @return [AutomationObject::Dsl::ModalProxy]
+      def modal(name)
+        name = name.to_sym
+        raise AutomationObject::Dsl::Error::ModalDoesNotExistError, name unless @subject.to_h.include?(name)
+
+        @state.utilize
+        @subject.send(name)
+      end
+
+      # Retrieve element from composite
+      # @param name [String, Symbol] name of element
+      # @raise [AutomationObject::Dsl::Error::ElementDoesNotExistError]
+      # @return [AutomationObject::Dsl::ElementProxy]
+      def element(name)
+        name = name.to_sym
+        raise AutomationObject::Dsl::Error::ElementDoesNotExistError, name unless @subject.to_h.include?(name)
+
+        @state.utilize
+        @subject.send(name)
+      end
+
+      # Retrieve element array from composite
+      # @param name [String, Symbol] name of element array
+      # @raise [AutomationObject::Dsl::Error::ElementArrayDoesNotExistError]
+      # @return [AutomationObject::Dsl::ElementArrayProxy]
+      def element_array(name)
+        name = name.to_sym
+        raise AutomationObject::Dsl::Error::ElementArrayDoesNotExistError, name unless @subject.to_h.include?(name)
+
+        @state.utilize
+        @subject.send(name)
+      end
+
+      # Retrieve element hash from composite
+      # @param name [String, Symbol] name of element hash
+      # @raise [AutomationObject::Dsl::Error::ElementHashDoesNotExistError]
+      # @return [AutomationObject::Dsl::ElementHashProxy]
+      def element_hash(name)
+        name = name.to_sym
+        raise AutomationObject::Dsl::Error::ElementHashDoesNotExistError, name unless @subject.to_h.include?(name)
+
+        @state.utilize
+        @subject.send(name)
+      end
     end
   end
 end

data/lib/automation_object/dsl/top.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_proxy'
+require_relative '_error'
 
 require_relative 'screen'
 
@@ -24,6 +26,23 @@ module AutomationObject
       def active?
         true
       end
+
+      # Retrieve screen from composite
+      # @param name [String, Symbol] name of screen
+      # @raise [AutomationObject::Dsl::Error::ScreenDoesNotExistError]
+      # @return [AutomationObject::Dsl::ScreenProxy]
+      def screen(name)
+        name = name.to_sym
+        raise AutomationObject::Dsl::Error::ScreenDoesNotExistError, name unless @subject.to_h.include?(name)
+
+        @subject.send(name)
+      end
+
+      # Current Screen
+      # @return [AutomationObject::Dsl::ScreenProxy]
+      def current_screen
+        @subject.send(@state.current_screen)
+      end
     end
   end
 end

data/lib/automation_object/framework.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
+
 require_relative 'proxy/proxy'
 require_relative 'blue_print'
 require_relative 'driver'
 require_relative 'dsl'
 require_relative 'state'
 
+require_relative 'dsl/_error'
+
 module AutomationObject
   # Framework class, the core
   # A Proxy class that will become the DSL Framework
@@ -35,6 +38,20 @@ module AutomationObject
       AutomationObject::Framework.singleton = self
     end
 
+    # Retrieve screen from composite
+    # @param name [String, Symbol] name of screen
+    # @raise [AutomationObject::Dsl::Error::ScreenDoesNotExistError]
+    # @return [AutomationObject::Dsl::ScreenProxy]
+    def screen(name)
+      @subject.screen(name)
+    end
+
+    # Current Screen
+    # @return [AutomationObject::Dsl::ScreenProxy]
+    def current_screen
+      @subject.current_screen
+    end
+
     # BluePrints (UI configurations) wrapped in an composite
     # Composite provides a common interface for all adapters
     # @param value [String, Hash] String to YAML files or Hash configuration
@@ -82,7 +99,7 @@ module AutomationObject
       attr_accessor :singleton
 
       # Singleton method if using Cucumber
-      # @return [Framework] singleton of self
+      # @return [AutomationObject::Framework] singleton of self
       def get
         singleton
       end

data/lib/automation_object/helpers/composite.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'reflection'
 require_relative 'composite_hook'
 
@@ -14,7 +15,8 @@ module AutomationObject
     # @param name [Symbol] name of the object
     # @param parent [Object, nil] parent composite object
     # @param location [String] string location for error/debugging purposes
-    def initialize(_name = :top, parent = nil, location = 'top')
+    def initialize(name = :top, parent = nil, location = 'top')
+      self.name = name
       self.parent = parent
       self.location = location
 

data/lib/automation_object/helpers/composite_hook.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   # Hooks for composites
   module CompositeHook

data/lib/automation_object/helpers/file.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Extend file class
 # Collect files in directory recursively and return Array
 class File

data/lib/automation_object/helpers/hash.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Hash class method additions
 class Hash
   def deep_merge(second)

data/lib/automation_object/helpers/kernel.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Kernel method additions
 module Kernel
   def suppress_warnings

data/lib/automation_object/helpers/reflection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   # Helper module for adding attributes/alias to classes dynamically
   # Reflection/MetaProgramming

data/lib/automation_object/helpers/string.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # String class method additions
 class String
   # Test whether a string is a valid url or not

data/lib/automation_object/proxy/mutex_proxy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'proxy'
 
 module AutomationObject

data/lib/automation_object/proxy/proxy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module Proxy
     # CompositeBase Proxy class for getting between another

data/lib/automation_object/proxy/throttle_proxy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'proxy'
 
 module AutomationObject
@@ -45,7 +46,7 @@ module AutomationObject
         total_time_taken = Time.new.to_f - start_time
 
         sleep_time = throttle_methods[method_symbol] - total_time_taken
-        sleep(sleep_time) if sleep_time.positive?
+        sleep(sleep_time) if sleep_time > 0
       end
     end
   end

data/lib/automation_object/state.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'state/top'
 
 module AutomationObject
@@ -13,7 +14,10 @@ module AutomationObject
     # @param blue_prints [AutomationObject::BluePrint::Composite::Top] Top composite interface
     # # @return [AutomationObject::State::Top] Top instance
     def create(driver, blue_prints)
-      Top.new(driver, blue_prints)
+      top = Top.new(driver, blue_prints)
+      top.start
+
+      top
     end
   end
 end

data/lib/automation_object/state/_base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../helpers/composite'
 
 module AutomationObject
@@ -46,7 +47,7 @@ module AutomationObject
 
           children_hash[child_key] = args.fetch(:interface).new(driver,
                                                                 child_blue_prints,
-                                                                name, self, child_location)
+                                                                child_key, self, child_location)
         end
 
         children_hash

data/lib/automation_object/state/_common_element.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'hook'
 
 module AutomationObject
@@ -39,6 +40,10 @@ module AutomationObject
 
         @method_hooks
       end
+
+      def method_to_container(name)
+        blue_prints.method_to_container(name)
+      end
     end
   end
 end

data/lib/automation_object/state/_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module State
     # Cannot navigate back error

data/lib/automation_object/state/automatic_modal_change.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '_base'
+
+module AutomationObject
+  module State
+    class AutomaticModalChange < Base
+      def activate; end
+
+      def deactivate; end
+    end
+  end
+end

data/lib/automation_object/state/automatic_screen_changes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '_base'
+
+module AutomationObject
+  module State
+    class AutomaticScreenChanges < Base
+      def activate; end
+
+      def deactivate; end
+    end
+  end
+end

data/lib/automation_object/state/element.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_common_element'
 
@@ -12,7 +13,7 @@ module AutomationObject
 
       # @return [AutomationObject::State::ElementProxy] Selenium proxy
       def utilize
-        # return self.cache if self.cache
+        return cache if cache
 
         element = driver.find_element(*blue_prints.selector_params)
         @active = true

data/lib/automation_object/state/element_array.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_common_element'
 
@@ -12,7 +13,7 @@ module AutomationObject
 
       # @return [Array<AutomationObject::State::ElementProxy>] Selenium proxy
       def utilize
-        # return self.cache if self.cache
+        return cache if cache
 
         elements = driver.find_elements(*blue_prints.selector_params)
 

data/lib/automation_object/state/element_hash.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_common_element'
 
@@ -12,7 +13,7 @@ module AutomationObject
 
       # @return [Hash<String, AutomationObject::State::ElementProxy>] Selenium proxy
       def utilize
-        # return self.cache if self.cache
+        return cache if cache
 
         elements = driver.find_elements(*blue_prints.selector_params)
         self.cache = {}

data/lib/automation_object/state/element_proxy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../proxy/proxy'
 
 module AutomationObject

data/lib/automation_object/state/helpers/automatic_routing.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module AutomationObject
+  module State
+    class AutomaticRouting
+      MAX_RECURSION_DEPTH = 10
+
+      # @param top_state [AutomationObject::State::Top]
+      # @param target [Symbol]
+      def initialize(top_state, target)
+        @top = top_state
+        @target = target
+      end
+
+      # @return [Boolean] success or not
+      def route
+        paths = {}
+        @top.active_screens.each do |screen_name, screen|
+          paths[screen_name] = recursive_search(screen)
+        end
+
+        flattened_paths = flat_hash(paths).keys.sort_by(&:length)
+        flattened_paths.each do |flattened_path|
+          next unless flattened_path.last == @target
+          return follow_route(flattened_path)
+        end
+
+        false
+      end
+
+      private
+
+      def follow_route(flattened_path)
+        flattened_path.each_with_index do |container_name, index|
+          parent_name = index > 0 ? flattened_path[index - 1] : nil
+          next_container_name = index < flattened_path.length ? flattened_path[index + 1] : nil
+
+          container = container_by_key(container_name, parent_name)
+          container.utilize
+
+          return true unless next_container_name
+
+          element = container.element_to_container(next_container_name)
+          element_method = element.method_to_container(next_container_name)
+
+          element_proxy = element.utilize
+
+          case element
+          when ElementArray
+            element_proxy.sample.send(element_method) # grab random
+          when ElementHash
+            element_proxy[element_proxy.keys.sample].send(element_method)
+          else
+            element_proxy.send(element_method)
+          end
+        end
+
+        false
+      end
+
+      def flat_hash(h, f = [], g = {})
+        return g.update(f => h) unless h.is_a? Hash
+        h.each { |k, r| flat_hash(r, f + [k], g) }
+        g
+      end
+
+      # @param container [AutomationObject::State::Screen, AutomationObject::State::Modal]
+      # @param depth [Integer]
+      def recursive_search(container, depth = 0)
+        return nil if depth >= MAX_RECURSION_DEPTH
+
+        next_level = {}
+        container.changes.each do |next_container_name|
+          next if next_container_name == container.name
+
+          if next_container_name == @target
+            next_level[next_container_name] = nil
+            return next_level
+          end
+
+          next_level[next_container_name] = recursive_search(container_by_key(next_container_name, container.name), depth + 1)
+        end
+
+        next_level
+      end
+
+      # @param container_name [Symbol]
+      # @param parent_name [Symbol]
+      # @return [AutomationObject::State::Screen, AutomationObject::State::Modal]
+      def container_by_key(container_name, parent_name)
+        return @top.screens[container_name] if @top.screens[container_name]
+        @top.screens[parent_name].modals[container_name]
+      end
+    end
+  end
+end