automation_object 0.5.0 → 0.5.1

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

@@ -1,4 +1,5 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'base'
 
 require_relative 'element'
@@ -6,34 +7,34 @@ 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, 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
+        # 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
+          adapter.hook_order
         end
 
-        #Get element requirement
+        # Get element requirement
         # @param name [Symbol] name of requested requirement
         def requirement(name)
-          self.adapter.requirement(name)
+          adapter.requirement(name)
         end
 
-        #Get name of the element
+        # Get name of the element
         # @return [Symbol] name of element
         def element_name
-          self.adapter.element_name
+          adapter.element_name
         end
 
-        #Convience for getting element blueprints
+        # Convience for getting element blueprints
         # @return [AutomationObject::BluePrint::Composite::Element]
         def element_blueprints(composite_object = nil)
-          self.adapter.element_blueprints(composite_object)
+          adapter.element_blueprints(composite_object)
         end
       end
     end
   end
-end
+end

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

@@ -1,10 +1,10 @@
-#Require parent class
+# frozen_string_literal: true
+# 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'
@@ -12,45 +12,35 @@ 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
+      # 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
+          adapter.screens
         end
 
         # @return [Hook]
         def load
-          self.adapter.load
+          adapter.load
         end
 
         # @return [Hash<Element>]
         def elements
-          self.adapter.elements
+          adapter.elements
         end
 
         # @return [Hash<ElementArray>]
         def element_arrays
-          self.adapter.element_arrays
+          adapter.element_arrays
         end
 
         # @return [Hash<ElementHash>]
         def element_hashes
-          self.adapter.element_hashes
+          adapter.element_hashes
         end
       end
     end
   end
-end
+end

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

@@ -1,4 +1,5 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'base'
 
 require_relative 'automatic_onload_modal'
@@ -12,48 +13,53 @@ 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
+      # 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
+          adapter.automatic_onload_modals
         end
 
         # @return [Array<Symbol>]
         def automatic_screen_changes
-          self.adapter.automatic_screen_changes
+          adapter.automatic_screen_changes
+        end
+
+        # @return [Hook]
+        def accept
+          adapter.accept
+        end
+
+        # @return [Hook]
+        def dismiss
+          adapter.dismiss
         end
 
         # @return [Hook]
         def load
-          self.adapter.load
+          adapter.load
         end
 
         # @return [Hash<Modal>]
         def modals
-          self.adapter.modals
+          adapter.modals
         end
 
         # @return [Hash<Element>]
         def elements
-          self.adapter.elements
+          adapter.elements
         end
 
         # @return [Hash<ElementArray>]
         def element_arrays
-          self.adapter.element_arrays
+          adapter.element_arrays
         end
 
         # @return [Hash<ElementHash>]
         def element_hashes
-          self.adapter.element_hashes
+          adapter.element_hashes
         end
       end
     end

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

@@ -1,4 +1,5 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'base'
 
 require_relative 'screen'
@@ -7,45 +8,45 @@ 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
+      # 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
+          adapter.screens
         end
 
         # @return [Hash<View>]
         def views
-          self.adapter.views
+          adapter.views
         end
 
         # @return [String, nil] base url to navigate to upon framework creation
         def base_url
-          self.adapter.base_url
+          adapter.base_url
         end
 
         # @return [Symbol, nil] default screen to be set when framework is created
         def default_screen
-          self.adapter.default_screen
+          adapter.default_screen
         end
 
         # @return [Numeric] sleep when transitioning screens
         def screen_transition_sleep
-          self.adapter.screen_transition_sleep
+          adapter.screen_transition_sleep
         end
 
         # @return [Hash] driver methods to throttle
         def throttle_driver_methods
-          self.adapter.throttle_driver_methods
+          adapter.throttle_driver_methods
         end
 
         # @return [Hash] element methods to throttle
         def throttle_element_methods
-          self.adapter.throttle_element_methods
+          adapter.throttle_element_methods
         end
       end
     end
   end
-end
+end

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

@@ -1,48 +1,59 @@
-#Require parent class
+# frozen_string_literal: true
+# 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
+      # 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 [Hook]
+        def load
+          adapter.load
+        end
+
+        # @return [Hook]
+        def accept
+          adapter.accept
+        end
+
+        # @return [Hook]
+        def dismiss
+          adapter.dismiss
+        end
+
         # @return [Array<AutomaticOnloadModal>]
         def automatic_onload_modals
-          self.adapter.automatic_onload_modals
+          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
+          adapter.automatic_screen_changes
         end
 
         # @return [Hash<Modal>]
         def modals
-          self.adapter.modals
+          adapter.modals
         end
 
         # @return [Hash<Element>]
         def elements
-          self.adapter.elements
+          adapter.elements
         end
 
         # @return [Hash<ElementArray>]
         def element_arrays
-          self.adapter.element_arrays
+          adapter.element_arrays
         end
 
         # @return [Hash<ElementHash>]
         def element_hashes
-          self.adapter.element_hashes
+          adapter.element_hashes
         end
       end
     end
   end
-end
+end

data/lib/automation_object/blue_print/hash_adapter.rb

@@ -1,17 +1,21 @@
+# frozen_string_literal: true
 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!
+module AutomationObject
+  module BluePrint
+    # BluePrint Hash Adapter
+    module HashAdapter
+      module_function
 
-      top_hash = AutomationObject::BluePrint::HashAdapter::Top.new(hash)
-      AutomationObject::BluePrint::Composite::Top.new(top_hash)
+      # @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
-end
+end

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

@@ -1,35 +1,36 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'composite'
 
 module AutomationObject
   module BluePrint
     module HashAdapter
-      #Automatic Onload Modal Composite
+      # Automatic Onload Modal Composite
       class AutomaticOnloadModal < Composite
-        #Validations
+        # 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]
+          modal_name = hash[:modal_name]
 
           case modal_name
-            when Symbol, String
-              return modal_name.to_sym
-            else
-              return nil
+          when Symbol, String
+            return modal_name.to_sym
+          else
+            return nil
           end
         end
 
         def number_of_checks
-          return self.hash[:number_of_checks] ||= 1
+          hash[:number_of_checks] ||= 1
         end
 
         def close
-          return self.hash[:close] ||= false
+          hash[:close] ||= false
         end
       end
     end
   end
-end
+end

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require_relative '../../helpers/composite'
+require_relative '../../helpers/string'
 
 require_relative 'helpers/validation_helper'
 require_relative 'helpers/validation_error'
@@ -6,6 +8,7 @@ require_relative 'helpers/validation_error'
 module AutomationObject
   module BluePrint
     module HashAdapter
+      # Base composite for blue print hash adapter
       class Composite < AutomationObject::Composite
         include ValidationHelper
 
@@ -16,28 +19,26 @@ module AutomationObject
         # @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 : {}
+          # 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
+          # Validate using ValidationHelper
+          return if valid?
+
+          raise ValidationError, errors.uniq.reverse unless self.parent
+
+          self.parent.add_errors(errors)
         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}]"
+          child = hash[name].is_a?(Hash) ? hash[name] : {}
+          child_location = location + "[#{name}]"
 
           create_composite(options, child, name, child_location)
         end
@@ -47,42 +48,44 @@ module AutomationObject
         # @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
+          children = hash[name]
+          children = children.is_a?(Hash) ? children : {}
 
-          self.create_hash_children(children, options)
+          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
+          composite_children = children.map.with_index do |child, index|
+            location = args[:location] ? args[:location] : self.location
             child_location = location + "[#{index}]"
 
             create_composite(args, child, "#{name}[#{index}]", child_location)
-          }
+          end
 
-          return composite_children
+          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}]"
+          composite_children = children.each_with_object({}) do |(key, value), hash|
+            child_location = location + "[#{key}]"
 
             hash[key] = create_composite(args, value, key, child_location)
             hash
-          }
+          end
 
-          return composite_children
+          composite_children
         end
 
         def create_composite(args, child, name, location)
-          #Get the Composite Class that corresponds with the HashAdapter Class
+          # Get the Composite Class that corresponds with the HashAdapter Class
           class_name = args[:interface].name.split('::').last
+
+          require_relative "../composite/#{class_name.to_underscore}"
           composite_class = AutomationObject::BluePrint::Composite.const_get(class_name)
 
           composite_class.new(args[:interface].new(child, name, self, location))
@@ -90,4 +93,4 @@ module AutomationObject
       end
     end
   end
-end
+end