automation_object 0.0.4 → 0.5.0

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

@@ -0,0 +1,31 @@
+#Require parent class
+require_relative 'base'
+
+require_relative 'hook_action'
+require_relative 'hook_element_requirements'
+
+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
+      class Hook < Base
+        # @return [HookAction]
+        def before
+          self.adapter.before
+        end
+
+        # @return [HookAction]
+        def after
+          self.adapter.after
+        end
+
+        # @return [Array<HookElementRequirements>] array of element requirements
+        def live?
+          self.adapter.live?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+#Require parent class
+require_relative 'base'
+
+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
+      class HookAction < Base
+        #Get the order to run the hook in
+        # @return [Array<Symbol>] list of hook methods to run in given order
+        def hook_order
+          self.adapter.hook_order
+        end
+
+        #Get length of hook actions
+        # @return [Integer] length of hook actions
+        def length
+          self.adapter.length
+        end
+
+        #See if hook actions are empty
+        # @return [Boolean] if hook actions are empty
+        def empty?
+          self.adapter.empty?
+        end
+
+        # @return [Symbol, nil] screen to change to
+        def change_screen
+          self.adapter.change_screen
+        end
+
+        # @return [Symbol, nil] new screen
+        def new_screen
+          self.adapter.new_screen
+        end
+
+        # @return [Boolean]
+        def close_screen
+          self.adapter.close_screen
+        end
+
+        # @return [Boolean]
+        def close_modal
+          self.adapter.close_modal
+        end
+
+        # @return [Boolean]
+        def change_to_previous_screen
+          self.adapter.change_to_previous_screen
+        end
+
+        # @return [Symbol, nil]
+        def show_modal
+          self.adapter.show_modal
+        end
+
+        # @return [Array]
+        def possible_screen_changes
+          self.adapter.possible_screen_changes
+        end
+
+        #@return [Boolean] reset the screen?
+        def reset_screen
+          self.adapter.reset_screen
+        end
+
+        #@return [Numeric] amount of time to sleep
+        def sleep
+          self.adapter.sleep
+        end
+
+        #Custom method for array of children instead of Hash
+        # @return [Array<HookElementRequirements>] array of wait for element children
+        def wait_for_elements
+          self.adapter.wait_for_elements
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+#Require parent class
+require_relative 'base'
+
+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
+      class HookElementRequirements < Base
+        #Get the order to run the hook in
+        # @return [Array<Symbol>] list of hook methods to run in given order
+        def hook_order
+          self.adapter.hook_order
+        end
+
+        #Get element requirement
+        # @param name [Symbol] name of requested requirement
+        def requirement(name)
+          self.adapter.requirement(name)
+        end
+
+        #Get name of the element
+        # @return [Symbol] name of element
+        def element_name
+          self.adapter.element_name
+        end
+
+        #Convience for getting element blueprints
+        # @return [AutomationObject::BluePrint::Composite::Element]
+        def element_blueprints(composite_object = nil)
+          self.adapter.element_blueprints(composite_object)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+#Require parent class
+require_relative 'base'
+
+require_relative 'automatic_onload_modal'
+require_relative 'hook'
+
+require_relative 'modal'
+require_relative 'element'
+require_relative 'element_array'
+require_relative 'element_hash'
+
+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
+      class Modal < Base
+        # @return [Array<Symbol>]
+        def included_views
+          self.adapter.screens
+        end
+
+        # @return [Array<AutomaticOnloadModal>]
+        def automatic_onload_modals
+          self.adapter.automatic_onload_modals
+        end
+
+        # @return [Array<Symbol>]
+        def automatic_screen_changes
+          self.adapter.automatic_screen_changes
+        end
+
+        # @return [Hook]
+        def load
+          self.adapter.load
+        end
+
+        # @return [Hash<Element>]
+        def elements
+          self.adapter.elements
+        end
+
+        # @return [Hash<ElementArray>]
+        def element_arrays
+          self.adapter.element_arrays
+        end
+
+        # @return [Hash<ElementHash>]
+        def element_hashes
+          self.adapter.element_hashes
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+#Require parent class
+require_relative 'base'
+
+require_relative 'automatic_onload_modal'
+require_relative 'hook'
+
+require_relative 'modal'
+require_relative 'element'
+require_relative 'element_array'
+require_relative 'element_hash'
+
+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
+      class Screen < Base
+        # @return [Array<Symbol>]
+        def included_views
+          self.adapter.screens
+        end
+
+        # @return [Array<AutomaticOnloadModal>]
+        def automatic_onload_modals
+          self.adapter.automatic_onload_modals
+        end
+
+        # @return [Array<Symbol>]
+        def automatic_screen_changes
+          self.adapter.automatic_screen_changes
+        end
+
+        # @return [Hook]
+        def load
+          self.adapter.load
+        end
+
+        # @return [Hash<Modal>]
+        def modals
+          self.adapter.modals
+        end
+
+        # @return [Hash<Element>]
+        def elements
+          self.adapter.elements
+        end
+
+        # @return [Hash<ElementArray>]
+        def element_arrays
+          self.adapter.element_arrays
+        end
+
+        # @return [Hash<ElementHash>]
+        def element_hashes
+          self.adapter.element_hashes
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+#Require parent class
+require_relative 'base'
+
+require_relative 'screen'
+require_relative 'view'
+
+module AutomationObject
+  module BluePrint
+    module Composite
+      #Top 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 Top < Base
+        # @return [Hash<Screen>]
+        def screens
+          self.adapter.screens
+        end
+
+        # @return [Hash<View>]
+        def views
+          self.adapter.views
+        end
+
+        # @return [String, nil] base url to navigate to upon framework creation
+        def base_url
+          self.adapter.base_url
+        end
+
+        # @return [Symbol, nil] default screen to be set when framework is created
+        def default_screen
+          self.adapter.default_screen
+        end
+
+        # @return [Numeric] sleep when transitioning screens
+        def screen_transition_sleep
+          self.adapter.screen_transition_sleep
+        end
+
+        # @return [Hash] driver methods to throttle
+        def throttle_driver_methods
+          self.adapter.throttle_driver_methods
+        end
+
+        # @return [Hash] element methods to throttle
+        def throttle_element_methods
+          self.adapter.throttle_element_methods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+#Require parent class
+require_relative 'base'
+
+module AutomationObject
+  module BluePrint
+    module Composite
+      #View 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 View < Base
+        # @return [Array<AutomaticOnloadModal>]
+        def automatic_onload_modals
+          self.adapter.automatic_onload_modals
+        end
+
+        # @return [Array<Symbol>]
+        def automatic_screen_changes
+          self.adapter.automatic_screen_changes
+        end
+
+        # @return [Hook]
+        def load
+          self.adapter.load
+        end
+
+        # @return [Hash<Modal>]
+        def modals
+          self.adapter.modals
+        end
+
+        # @return [Hash<Element>]
+        def elements
+          self.adapter.elements
+        end
+
+        # @return [Hash<ElementArray>]
+        def element_arrays
+          self.adapter.element_arrays
+        end
+
+        # @return [Hash<ElementHash>]
+        def element_hashes
+          self.adapter.element_hashes
+        end
+      end
+    end
+  end
+end

data/lib/automation_object/blue_print/hash_adapter.rb

@@ -0,0 +1,17 @@
+require_relative 'composite/top'
+require_relative 'hash_adapter/top'
+
+module AutomationObject::BluePrint
+  #BluePrint Hash Adapter
+  module HashAdapter
+    extend self
+    # @param [Hash] hash that includes all the information needed to create a BluePrint
+    # @return [AutomationObject::BluePrint::Composite::Top] Composite BluePrint Object
+    def build(hash = {})
+      hash.symbolize_keys_deep!
+
+      top_hash = AutomationObject::BluePrint::HashAdapter::Top.new(hash)
+      AutomationObject::BluePrint::Composite::Top.new(top_hash)
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+#Require parent class
+require_relative 'composite'
+
+module AutomationObject
+  module BluePrint
+    module HashAdapter
+      #Automatic Onload Modal Composite
+      class AutomaticOnloadModal < Composite
+        #Validations
+        validates :modal_name, instance_of: [String, Symbol], modal_presence_of: true, presence_of: true
+        validates :number_of_checks, instance_of: Numeric
+        validates :close, instance_of: TrueClass
+
+        def modal_name
+          modal_name = self.hash[:modal_name]
+
+          case modal_name
+            when Symbol, String
+              return modal_name.to_sym
+            else
+              return nil
+          end
+        end
+
+        def number_of_checks
+          return self.hash[:number_of_checks] ||= 1
+        end
+
+        def close
+          return self.hash[:close] ||= false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require_relative '../../helpers/composite'
+
+require_relative 'helpers/validation_helper'
+require_relative 'helpers/validation_error'
+
+module AutomationObject
+  module BluePrint
+    module HashAdapter
+      class Composite < AutomationObject::Composite
+        include ValidationHelper
+
+        attr_accessor :hash
+
+        # @param hash [Hash] hash for the composite to build of off
+        # @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(hash = {}, name = :top, parent = nil, location = 'top')
+          #Add hash before calling super
+          self.hash = (hash.is_a?(Hash)) ? hash : {}
+          self.hash.symbolize_keys_deep!
+
+          super(name, parent, location)
+
+          #Validate using ValidationHelper
+          unless self.valid?
+            if self.parent
+              self.parent.add_errors(self.errors)
+            else
+              raise ValidationError.new(self.errors.uniq.reverse)
+            end
+          end
+        end
+
+        # Overriding base get_child method
+        # @param name [Symbol] name of child
+        # @param options [Hash] options for child
+        def get_child(name, options)
+          child = (self.hash[name].is_a?(Hash)) ? self.hash[name] : Hash.new
+          child_location = self.location + "[#{name}]"
+
+          create_composite(options, child, name, child_location)
+        end
+
+        # Overriding base get_children method
+        # @param name [Symbol] name of child
+        # @param options [Hash] options for child
+        # @return children [Hash] return children and names
+        def get_children(name, options)
+          children = self.hash[name]
+          children = (children.is_a?(Hash)) ? children : Hash.new
+
+          self.create_hash_children(children, options)
+        end
+
+        # @param name [Symbol] name of child
+        # @param children [Array] hash of children
+        # @param args [Hash] arguments for adding children
+        def create_array_children(name, children, args)
+          composite_children = children.map.with_index { |child, index|
+            location = (args[:location]) ? args[:location] : self.location
+            child_location = location + "[#{index}]"
+
+            create_composite(args, child, "#{name}[#{index}]", child_location)
+          }
+
+          return composite_children
+        end
+
+        # @param children [Hash] hash of children
+        # @param args [Hash] arguments for adding children
+        def create_hash_children(children, args)
+          composite_children = children.inject({}) { |hash, (key, value)|
+            child_location = self.location + "[#{key}]"
+
+            hash[key] = create_composite(args, value, key, child_location)
+            hash
+          }
+
+          return composite_children
+        end
+
+        def create_composite(args, child, name, location)
+          #Get the Composite Class that corresponds with the HashAdapter Class
+          class_name = args[:interface].name.split('::').last
+          composite_class = AutomationObject::BluePrint::Composite.const_get(class_name)
+
+          composite_class.new(args[:interface].new(child, name, self, location))
+        end
+      end
+    end
+  end
+end