automation_object 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e852570c1534fa6f78f8f1c0cfd03ce6823b849
-  data.tar.gz: 02ec9763691fb5500d68b5ab3de7441d9ab84153
+  metadata.gz: fb61b7d19da29a48f5444b2b1abe5ef3813daf05
+  data.tar.gz: afe8919e786499ef1ba563f93c5060d9bdab3c44
 SHA512:
-  metadata.gz: 5a8267d04713753f765933b67938983117a351ba8cb7505db24d1cd7242256c5f8fdbd553aa40fac5386a79e8764235d9fa4293d57d005ca89ab77b8d20a0c2a
-  data.tar.gz: abd5d37f408e8d7f71c898555730b94867293e1c1bb6063dc443084f854555a8435f4848dc9ea31c0d2a47570baf5c8e03c58ed6fb1de134d290230728dbbbe9
+  metadata.gz: 5d7b4c210aee08a2ee8a568cdf5d9cfb19e0e3885ee94e011233aa42761fa79cd84bd6a833b7542fefd084fd7eb6d09ada93981b45afd8bb99b750a105fc0c87
+  data.tar.gz: 61866d54c863b0f462eb3c8cab35fcf10c890c8d46ad1cea36e9ce3ed9621288b85385fd66b179f1014105f6072bef07df53e8e34cc02cf8862bbb26363ab719

data/lib/automation_object/blue_print.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'blue_print/hash_adapter'
 require_relative 'blue_print/yaml_adapter'
 

data/lib/automation_object/blue_print/composite/{automatic_onload_modal.rb → automatic_modal_change.rb}

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
 module AutomationObject
   module BluePrint
     module Composite
-      # AutomaticOnloadModal composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
-      class AutomaticOnloadModal < Base
+      # AutomaticModalChange composite class
+      class AutomaticModalChange < Base
         # @return [Symbol, nil]
         def modal_name
           adapter.modal_name

data/lib/automation_object/blue_print/composite/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../../lib/automation_object/helpers/composite'
 
 module AutomationObject

data/lib/automation_object/blue_print/composite/custom_method.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
 module AutomationObject
   module BluePrint
     module Composite
-      # CustomMethod composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # CustomMethod composite class
       class CustomMethod < Base
         # @return [Symbol, nil]
         def element_method

data/lib/automation_object/blue_print/composite/element.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
@@ -10,9 +11,7 @@ require_relative 'helpers/element_helper'
 module AutomationObject
   module BluePrint
     module Composite
-      # Element composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # Element composite class
       class Element < Base
         include ElementHelper
       end

data/lib/automation_object/blue_print/composite/element_array.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
@@ -10,9 +11,7 @@ require_relative 'helpers/multiple_elements_helper'
 module AutomationObject
   module BluePrint
     module Composite
-      # ElementArray composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # ElementArray composite class
       class ElementArray < Base
         include ElementHelper
         include MultipleElementsHelper

data/lib/automation_object/blue_print/composite/element_hash.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
@@ -10,9 +11,7 @@ require_relative 'helpers/multiple_elements_helper'
 module AutomationObject
   module BluePrint
     module Composite
-      # ElementHash composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # ElementHash composite class
       class ElementHash < Base
         include ElementHelper
         include MultipleElementsHelper

data/lib/automation_object/blue_print/composite/helpers/container_helper.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Require parent class
+module AutomationObject
+  module BluePrint
+    module Composite
+      # Screen composite class
+      module ContainerHelper
+        # @return [Array<AutomationObject::BluePrint::Composite::AutomaticModalChange>]
+        def automatic_modal_changes
+          adapter.automatic_modal_changes
+        end
+
+        # @return [Array<Symbol>]
+        def automatic_screen_changes
+          adapter.automatic_screen_changes
+        end
+
+        # @return [AutomationObject::BluePrint::Composite::Hook]
+        def load
+          adapter.load
+        end
+
+        # @return [Hash<AutomationObject::BluePrint::Composite::Element>]
+        def elements
+          adapter.elements
+        end
+
+        # @return [Hash<AutomationObject::BluePrint::Composite::ElementArray>]
+        def element_arrays
+          adapter.element_arrays
+        end
+
+        # @return [Hash<AutomationObject::BluePrint::Composite::ElementHash>]
+        def element_hashes
+          adapter.element_hashes
+        end
+
+        # Get possible changes
+        # @return [Array<Symbol>]
+        def changes
+          changes = []
+          elements.merge(element_arrays).merge(element_hashes).each_value do |element|
+            changes += element.changes
+          end
+
+          changes.uniq.compact
+        end
+
+        # @param name [Symbol] name of container you want to go to
+        # @return [Symbol, Symbol] name and type of element
+        def element_to_container(name)
+          elements.merge(element_arrays).merge(element_hashes).each do |element_name, element|
+            next unless element.changes.include?(name)
+
+            element_type = nil
+
+            case element
+            when Element
+              element_type = :elements
+            when ElementArray
+              element_type = :element_arrays
+            when ElementHash
+              element_type = :element_hashes
+            end
+
+            return element_name, element_type
+          end
+
+          [nil, nil]
+        end
+      end
+    end
+  end
+end

data/lib/automation_object/blue_print/composite/helpers/element_helper.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module BluePrint
     module Composite
       # Helper module for Element composite classes
       module ElementHelper
+        # @return [String, nil] text input for automatic screen/modal change if needed
+        def default_input
+          adapter.default_input
+        end
+
         # @return [Array<Symbol, String>, nil] params as an array for driver find_element args
         def selector_params
           adapter.selector_params
@@ -23,10 +29,33 @@ module AutomationObject
           adapter.method_hook?(name)
         end
 
-        # @return [Hash<Hook>] array of Hook that are defined under the element
+        # @return [Hash<AutomationObject::BluePrint::Composite::Hook>] hash of Hook that are defined under the element
         def method_hooks
           adapter.method_hooks
         end
+
+        # Get possible changes
+        # @return [Array<Symbol>]
+        def changes
+          changes = []
+          method_hooks.each_value do |hook|
+            changes += hook.changes
+          end
+
+          changes.uniq.compact
+        end
+
+        # @param name [Symbol] name of container you want to go to
+        # @return [Symbol] method name
+        def method_to_container(name)
+          method_hooks.each do |method_name, hook|
+            next unless hook.changes.include?(name)
+
+            return method_name
+          end
+
+          nil
+        end
       end
     end
   end

data/lib/automation_object/blue_print/composite/helpers/multiple_elements_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module BluePrint
     module Composite

data/lib/automation_object/blue_print/composite/hook.rb

@@ -1,28 +1,40 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
 module AutomationObject
   module BluePrint
     module Composite
-      # Hook composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # Hook composite class
       class Hook < Base
-        # @return [HookAction]
+        # @return [AutomationObject::BluePrint::Composite::HookAction]
         def before
           adapter.before
         end
 
-        # @return [HookAction]
+        # @return [AutomationObject::BluePrint::Composite::HookAction]
         def after
           adapter.after
         end
 
-        # @return [Array<HookElementRequirements>] array of element requirements
+        # @return [Array<AutomationObject::BluePrint::Composite::HookElementRequirements>] array of element requirements
         def live?
           adapter.live?
         end
+
+        # Get possible changes
+        # @return [Array<Symbol>]
+        def changes
+          [before.change_screen, before.new_screen,
+           after.change_screen, after.new_screen, before.show_modal, after.show_modal].uniq.compact
+        end
+
+        # @param name [Symbol]
+        # @return [Boolean]
+        def changes_to_container?(name)
+          changes.include?(name)
+        end
       end
     end
   end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
@@ -7,9 +8,7 @@ require_relative 'hook_element_requirements'
 module AutomationObject
   module BluePrint
     module Composite
-      # HookAction composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # HookAction composite class
       class HookAction < Base
         # Get the order to run the hook in
         # @return [Array<Symbol>] list of hook methods to run in given order
@@ -75,7 +74,7 @@ module AutomationObject
         end
 
         # Custom method for array of children instead of Hash
-        # @return [Array<HookElementRequirements>] array of wait for element children
+        # @return [Array<AutomationObject::BluePrint::Composite::HookElementRequirements>] array of wait for element children
         def wait_for_elements
           adapter.wait_for_elements
         end

data/lib/automation_object/blue_print/composite/hook_element_requirements.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
@@ -7,9 +8,7 @@ require_relative 'element'
 module AutomationObject
   module BluePrint
     module Composite
-      # HookElementRequirements composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # HookElementRequirements composite class
       class HookElementRequirements < Base
         # Get the order to run the hook in
         # @return [Array<Symbol>] list of hook methods to run in given order
@@ -29,7 +28,7 @@ module AutomationObject
           adapter.element_name
         end
 
-        # Convience for getting element blueprints
+        # Convenience for getting element blueprints
         # @return [AutomationObject::BluePrint::Composite::Element]
         def element_blueprints(composite_object = nil)
           adapter.element_blueprints(composite_object)

data/lib/automation_object/blue_print/composite/modal.rb

@@ -1,42 +1,45 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
-require_relative 'automatic_onload_modal'
+require_relative 'automatic_modal_change'
 require_relative 'hook'
 
 require_relative 'element'
 require_relative 'element_array'
 require_relative 'element_hash'
 
+require_relative 'helpers/container_helper'
+
 module AutomationObject
   module BluePrint
     module Composite
-      # Modal composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # Modal composite class
       class Modal < Base
+        include ContainerHelper
+
         # @return [Array<Symbol>]
         def included_views
-          adapter.screens
+          adapter.included_views
         end
 
-        # @return [Hook]
+        # @return [AutomationObject::BluePrint::Composite::Hook]
         def load
           adapter.load
         end
 
-        # @return [Hash<Element>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::Element>]
         def elements
           adapter.elements
         end
 
-        # @return [Hash<ElementArray>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::ElementArray>]
         def element_arrays
           adapter.element_arrays
         end
 
-        # @return [Hash<ElementHash>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::ElementHash>]
         def element_hashes
           adapter.element_hashes
         end

data/lib/automation_object/blue_print/composite/screen.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
-require_relative 'automatic_onload_modal'
+require_relative 'automatic_modal_change'
 require_relative 'hook'
 
 require_relative 'modal'
@@ -10,16 +11,18 @@ require_relative 'element'
 require_relative 'element_array'
 require_relative 'element_hash'
 
+require_relative 'helpers/container_helper'
+
 module AutomationObject
   module BluePrint
     module Composite
-      # Screen composite class, passing method to adapter only
-      # Hoping to improve code completion and standard interface where
-      # classes use this as a template to add additional adapters
+      # Screen composite class
       class Screen < Base
-        # @return [Array<AutomaticOnloadModal>]
-        def automatic_onload_modals
-          adapter.automatic_onload_modals
+        include ContainerHelper
+
+        # @return [Array<AutomationObject::BluePrint::Composite::AutomaticModalChange>]
+        def automatic_modal_changes
+          adapter.automatic_modal_changes
         end
 
         # @return [Array<Symbol>]
@@ -27,37 +30,37 @@ module AutomationObject
           adapter.automatic_screen_changes
         end
 
-        # @return [Hook]
+        # @return [AutomationObject::BluePrint::Composite::Hook]
         def accept
           adapter.accept
         end
 
-        # @return [Hook]
+        # @return [AutomationObject::BluePrint::Composite::Hook]
         def dismiss
           adapter.dismiss
         end
 
-        # @return [Hook]
+        # @return [AutomationObject::BluePrint::Composite::Hook]
         def load
           adapter.load
         end
 
-        # @return [Hash<Modal>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::Modal>]
         def modals
           adapter.modals
         end
 
-        # @return [Hash<Element>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::Element>]
         def elements
           adapter.elements
         end
 
-        # @return [Hash<ElementArray>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::ElementArray>]
         def element_arrays
           adapter.element_arrays
         end
 
-        # @return [Hash<ElementHash>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::ElementHash>]
         def element_hashes
           adapter.element_hashes
         end