automation_object 0.7.6 → 0.8.0

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
@@ -12,12 +13,12 @@ module AutomationObject
       # Hoping to improve code completion and standard interface where
       # classes use this as a template to add additional adapters
       class Top < Base
-        # @return [Hash<Screen>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::Screen>]
         def screens
           adapter.screens
         end
 
-        # @return [Hash<View>]
+        # @return [Hash<AutomationObject::BluePrint::Composite::View>]
         def views
           adapter.views
         end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'base'
 
@@ -24,9 +25,9 @@ module AutomationObject
           adapter.dismiss
         end
 
-        # @return [Array<AutomaticOnloadModal>]
-        def automatic_onload_modals
-          adapter.automatic_onload_modals
+        # @return [Array<AutomationObject::BluePrint::Composite::AutomaticModalChange>]
+        def automatic_modal_changes
+          adapter.automatic_modal_changes
         end
 
         # @return [Array<Symbol>]
@@ -34,22 +35,22 @@ module AutomationObject
           adapter.automatic_screen_changes
         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

data/lib/automation_object/blue_print/hash_adapter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'composite/top'
 require_relative 'hash_adapter/top'
 

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

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 
 module AutomationObject
   module BluePrint
     module HashAdapter
-      # Automatic Onload Modal Composite
-      class AutomaticOnloadModal < Composite
+      # Automatic Modal Change Composite
+      class AutomaticModalChange < Composite
         # Validations
         validates :modal_name, instance_of: [String, Symbol], modal_presence_of: true, presence_of: true
         validates :number_of_checks, instance_of: Numeric

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../helpers/composite'
 require_relative '../../helpers/string'
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 
@@ -29,6 +30,7 @@ module AutomationObject
         validates :in_iframe, instance_of: String, element_presence_of: true
         validates :css, instance_of: String, presence_of: { unless_presence_of: :xpath }
         validates :xpath, instance_of: String, presence_of: { unless_presence_of: :css }
+        validates :default_input, instance_of: String
       end
     end
   end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 

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

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module BluePrint
     module HashAdapter
       # Helper module for Element composite classes
       module ElementHelper
+        # @return [String, nil] text input for automatic screen/modal change if needed
+        def default_input
+          hash[:default_input]
+        end
+
         # @return [Array<Symbol, String>, nil] params as an array for driver find_element args
         def selector_params
           if hash[:xpath].is_a?(String)
@@ -30,7 +36,7 @@ module AutomationObject
           method_hooks.key?(name)
         end
 
-        # @return [Hash<Hook>] array of Hook that are defined under the element
+        # @return [Hash<Hook>] hash of Hook that are defined under the element
         def method_hooks
           return @method_hooks if defined? @method_hooks
 
@@ -38,7 +44,7 @@ module AutomationObject
           hash.each do |key, value|
             # Skip possible keys that elements can have
             # Otherwise should be a method hook
-            next if [:load, :custom_methods, :in_iframe, :css, :xpath, :define_elements_by, :custom_range].include?(key)
+            next if %i[load custom_methods in_iframe css xpath define_elements_by custom_range].include?(key)
             children[key] = value
           end
 

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

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

data/lib/automation_object/blue_print/hash_adapter/helpers/validation_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module BluePrint
     module HashAdapter
@@ -16,7 +17,7 @@ module AutomationObject
         def message
           message = "\nBluePrint::HashAdapter composite validation failed for the following errors:\n"
           @errors.each do |error|
-            message << "     - #{error}\n"
+            message += "     - #{error}\n"
           end
 
           message + "\n"

data/lib/automation_object/blue_print/hash_adapter/helpers/validation_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require all the validators
 require_relative 'validators/validate_instance_of'
 require_relative 'validators/validate_allowed_keys'

data/lib/automation_object/blue_print/hash_adapter/helpers/validators/validate.rb

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

data/lib/automation_object/blue_print/hash_adapter/helpers/validators/validate_allowed_keys.rb

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

data/lib/automation_object/blue_print/hash_adapter/helpers/validators/validate_element_presence_of.rb

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

data/lib/automation_object/blue_print/hash_adapter/helpers/validators/validate_instance_of.rb

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

data/lib/automation_object/blue_print/hash_adapter/helpers/validators/validate_modal_presence_of.rb

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

data/lib/automation_object/blue_print/hash_adapter/helpers/validators/validate_presence_of.rb

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

data/lib/automation_object/blue_print/hash_adapter/helpers/validators/validate_screen_presence_of.rb

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

data/lib/automation_object/blue_print/hash_adapter/helpers/validators/validate_view_presence_of.rb

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

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 
@@ -18,7 +19,7 @@ module AutomationObject
         has_one :after, interface: HookAction
 
         # Validations
-        validates_keys allowed_keys: [:before, :live?, :after]
+        validates_keys allowed_keys: %i[before live? after]
 
         # @return [Array<HookElementRequirements>] array of element requirements
         def live?

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 require_relative 'hook_element_requirements'
@@ -12,9 +13,9 @@ module AutomationObject
         before_create :wait_for_elements
 
         # Validations
-        validates_keys allowed_keys: [:new_screen, :show_modal, :close_screen, :change_screen,
-                                      :sleep, :wait_for_elements, :change_to_previous_screen, :close_modal, :reset_screen,
-                                      :possible_screen_changes]
+        validates_keys allowed_keys: %i[new_screen show_modal close_screen change_screen
+                                        sleep wait_for_elements change_to_previous_screen close_modal reset_screen
+                                        possible_screen_changes]
 
         validates :change_screen, instance_of: [String, Symbol], screen_presence_of: true
         validates :new_screen, instance_of: [String, Symbol], screen_presence_of: true

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 
@@ -17,7 +18,7 @@ module AutomationObject
           hook_order = [:exists?] # Always put exists? first
 
           hash.each_key do |hook_name|
-            hook_order.push(hook_name) unless [:element_name, :exists?].include?(hook_name)
+            hook_order.push(hook_name) unless %i[element_name exists?].include?(hook_name)
           end
 
           hook_order

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 
@@ -21,7 +22,7 @@ module AutomationObject
         has_many :element_hashes, interface: ElementHash
 
         # Validations
-        validates_keys allowed_keys: [:load, :elements, :element_arrays, :element_hashes]
+        validates_keys allowed_keys: %i[load elements element_arrays element_hashes]
 
         validates :load, instance_of: Hash
         validates :elements, instance_of: Hash

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

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 
 # Require child classes
-require_relative 'automatic_onload_modal'
+require_relative 'automatic_modal_change'
 require_relative 'element'
 require_relative 'element_array'
 require_relative 'element_hash'
@@ -17,7 +18,7 @@ module AutomationObject
       class Screen < Composite
         # Creation hooks
         before_create :merge_views
-        before_create :automatic_onload_modals
+        before_create :automatic_modal_changes
 
         # Relationships
         has_one :load, interface: Hook
@@ -30,10 +31,10 @@ module AutomationObject
         has_many :element_hashes, interface: ElementHash
 
         # Validations
-        validates_keys allowed_keys: [:automatic_onload_modals, :automatic_screen_changes, :elements,
-                                      :element_arrays, :element_hashes, :included_views, :load, :modals]
+        validates_keys allowed_keys: %i[automatic_modal_changes automatic_screen_changes elements
+                                        element_arrays element_hashes included_views load modals]
 
-        validates :automatic_onload_modals, instance_of: Array, modal_presence_of: true
+        validates :automatic_modal_changes, instance_of: Array, modal_presence_of: true
         validates :automatic_screen_changes, instance_of: Array, screen_presence_of: true
 
         validates :elements, instance_of: Hash
@@ -48,17 +49,17 @@ module AutomationObject
 
         validates :modals, instance_of: Hash
 
-        # @return [Array<AutomaticOnloadModal>] array of AutomaticOnloadModal that are defined under the screen
-        def automatic_onload_modals
-          return @automatic_onload_modals if defined? @automatic_onload_modals
+        # @return [Array<AutomaticModalChange>] array of AutomaticModalChange that are defined under the screen
+        def automatic_modal_changes
+          return @automatic_modal_changes if defined? @automatic_modal_changes
 
-          children = hash[:automatic_onload_modals]
+          children = hash[:automatic_modal_changes]
           children = children.is_a?(Array) ? children : []
-          @automatic_onload_modals = create_array_children(:automatic_onload_modals, children,
-                                                           interface: AutomaticOnloadModal,
-                                                           location: location + '[automatic_onload_modals]')
+          @automatic_modal_changes = create_array_children(:automatic_modal_changes, children,
+                                                           interface: AutomaticModalChange,
+                                                           location: location + '[automatic_modal_changes]')
 
-          @automatic_onload_modals
+          @automatic_modal_changes
         end
 
         # @return [Array<Symbol>] array of screens where screen can automatically change to

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 
@@ -16,8 +17,8 @@ module AutomationObject
         has_many :views, interface: View
 
         # Validations
-        validates_keys allowed_keys: [:base_url, :default_screen, :screen_transition_sleep, :screens,
-                                      :throttle_driver_methods, :throttle_element_methods, :views]
+        validates_keys allowed_keys: %i[base_url default_screen screen_transition_sleep screens
+                                        throttle_driver_methods throttle_element_methods views]
 
         validates :base_url, instance_of: String
         validates :default_screen, instance_of: [Symbol, String], screen_presence_of: true

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Require parent class
 require_relative 'composite'
 
@@ -9,7 +10,7 @@ module AutomationObject
       class View < Composite
         # Creation hooks
         before_create :merge_views
-        before_create :automatic_onload_modals
+        before_create :automatic_modal_changes
 
         # Relationships
         has_one :load, interface: Hook
@@ -22,8 +23,8 @@ module AutomationObject
         has_many :element_hashes, interface: ElementHash
 
         # Validations
-        validates_keys allowed_keys: [:automatic_onload_modals, :automatic_screen_changes, :elements, :element_arrays,
-                                      :element_groups, :element_hashes, :included_views, :load, :modals]
+        validates_keys allowed_keys: %i[automatic_onload_modals automatic_screen_changes elements element_arrays
+                                        element_groups element_hashes included_views load modals]
 
         validates :automatic_onload_modals, instance_of: Array, modal_presence_of: true
         validates :automatic_screen_changes, instance_of: Array, screen_presence_of: true
@@ -39,17 +40,17 @@ module AutomationObject
 
         validates :modals, instance_of: Hash
 
-        # @return [Array<AutomaticOnloadModal>] array of AutomaticOnloadModal that are defined under the screen
-        def automatic_onload_modals
-          return @automatic_onload_modals if defined? @automatic_onload_modals
+        # @return [Array<AutomaticModalChange>] array of AutomaticModalChange that are defined under the screen
+        def automatic_modal_changes
+          return @automatic_modal_changes if defined? @automatic_modal_changes
 
-          children = hash[:automatic_onload_modals]
+          children = hash[:automatic_modal_changes]
           children = children.is_a?(Array) ? children : []
-          @automatic_onload_modals = create_array_children(:automatic_onload_modals, children,
-                                                           interface: AutomaticOnloadModal,
-                                                           location: location + '[automatic_onload_modals]')
+          @automatic_modal_changes = create_array_children(:automatic_modal_changes, children,
+                                                           interface: AutomaticModalChange,
+                                                           location: location + '[automatic_modal_change]')
 
-          @automatic_onload_modals
+          @automatic_modal_changes
         end
 
         # @return [Array<Symbol>] array of screens where screen can automatically change to