automation_object 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bac9e2b6a0367c100fc66c0541dbea6800308e28
-  data.tar.gz: 3b16e66a40739ac2cb865664daf3aaf7aebe97ba
+  metadata.gz: 752355905e1e3e9177ad9e481b27abd8d0979076
+  data.tar.gz: e58e752b120609eb53030fc41c3ab5ccaee717b9
 SHA512:
-  metadata.gz: 7aeb3799b980a4d0f68b649c0441ddda946ee3a1cdb8049b711259cdb35cb025db681fa662b47f3e2908afa86015ceeecda8105fc4433975211a14f2a5714b35
-  data.tar.gz: 6d93962d0df0434dd34fb238bb7fa5c8ab10610df17aea9abeb128c3b221e5fce7611b38ee2f97e30ceb20f756abd5b796530e8e757fd2d46ae6a28463dabcb4
+  metadata.gz: a59cd4c3e1b7843e825752e6e8921c45620733a2092305ec6746e04720c2f6bf8bcbf2e8a694769a6ba2e19fcbb341a88fa662eb62068dab4cbd0998fa25e6e1
+  data.tar.gz: 8adbce64b6b3ac96cde758814d2a643d5c04b2af2d302edd0aff46ebe9a780891721bc320b5865c63a59547fbb846395eccb77a81dfb97b3c7359379c93b3c5c

data/lib/automation_object.rb

@@ -1,22 +1,33 @@
-#Gems
-require 'awesome_print'
-require 'ostruct'
-require 'event_emitter'
-require 'appium_lib'
-require 'selenium-webdriver'
+# frozen_string_literal: true
 
-#Local Files
+require_relative 'automation_object/helpers/kernel'
+
+# Require Gems
+# Ignore warning coming from third-party libraries
+Kernel.suppress_warnings do
+  require 'awesome_print'
+  require 'ostruct'
+  require 'event_emitter'
+  require 'appium_lib'
+  require 'selenium-webdriver'
+  require 'colorize'
+end
+
+# Local Files
 require_relative 'automation_object/version'
 
-#Class method additions
+# Class method additions
 require_relative 'automation_object/helpers/string'
 require_relative 'automation_object/helpers/hash'
 
-#Core Framework
+# Core Framework
 require_relative 'automation_object/framework'
 
-#Cucumber Step Definitions
+# Cucumber Step Definitions
 require_relative 'automation_object/step_definitions'
 
+# Top level namespace
+# AutomationObject is a dynamic DSL framework created by configurations that
+# allow for UI automation using business logic
 module AutomationObject
-end
+end

data/lib/automation_object/blue_print.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
 require_relative 'blue_print/hash_adapter'
 require_relative 'blue_print/yaml_adapter'
 
 module AutomationObject
-  #BluePrint Port, encapsulation of code required to parse and build composite data structure representing UI
-  #Provides for loading Hash/YAML, validates the resulting structure (throws errors), and a common
-  #interface for the rest of the code base to use.
+  # BluePrint Port, encapsulation of code required to parse and build composite data structure representing UI
+  # Provides for loading Hash/YAML, validates the resulting structure (throws errors), and a common
+  # interface for the rest of the code base to use.
   module BluePrint
-    extend self
+    module_function
 
     # Get method for BluePrint adapter const for composite BluePrint build
     # Each adapter will implement common BluePrint interface
@@ -21,23 +22,23 @@ module AutomationObject
     # @param adapter_name [String] name of adapter wanted for composite creation
     def adapter=(adapter_name)
       adapter_name = adapter_name.to_s
-      adapter_name << '_adapter' unless adapter_name.match(/_adapter$/)
+      adapter_name << '_adapter' unless adapter_name =~ /_adapter$/
       adapter_const = adapter_name.pascalize
 
-      @adapter = AutomationObject::BluePrint.const_get("#{adapter_const}")
+      @adapter = AutomationObject::BluePrint.const_get(adapter_const.to_s)
     end
 
     # Adapters use the composite AutomationObject::BluePrint::Composite interfaces
     # @return [AutomationObject::BluePrint::Composite::Top]
-    def new(blueprint_arg)
+    def create(blueprint_arg)
       case blueprint_arg
-        when String
-          self.adapter = :yaml
-        when Hash
-          self.adapter = :hash
+      when String
+        self.adapter = :yaml
+      when Hash
+        self.adapter = :hash
       end
 
       adapter.build(blueprint_arg)
     end
   end
-end
+end

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

@@ -1,28 +1,29 @@
-#Require parent class
+# 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
+      # 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
         # @return [Symbol, nil]
         def modal_name
-          self.adapter.modal_name
+          adapter.modal_name
         end
 
         # @return [Integer]
         def number_of_checks
-          self.adapter.number_of_checks
+          adapter.number_of_checks
         end
 
         # @return [Boolean]
         def close
-          self.adapter.close
+          adapter.close
         end
       end
     end
   end
-end
+end

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

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 require_relative '../../../../lib/automation_object/helpers/composite'
 
 module AutomationObject
   module BluePrint
     module Composite
-      #This composite namespace is the interface contract for the rest of the application to rely on
-      #Adapters should implement the same classes and methods as the composite to achieve reliability
-      #with the rest of the application
+      # This composite namespace is the interface contract for the rest of the application to rely on
+      # Adapters should implement the same classes and methods as the composite to achieve reliability
+      # with the rest of the application
       class Base
         attr_accessor :adapter
 
@@ -15,4 +16,4 @@ module AutomationObject
       end
     end
   end
-end
+end

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

@@ -1,23 +1,24 @@
-#Require parent class
+# 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, 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 CustomMethod < Base
         # @return [Symbol, nil]
         def element_method
-          self.adapter.element_method
+          adapter.element_method
         end
 
         # @return [String, nil]
         def evaluate
-          self.adapter.evaluate
+          adapter.evaluate
         end
       end
     end
   end
-end
+end

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

@@ -1,4 +1,5 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'base'
 
 require_relative 'hook'
@@ -9,12 +10,12 @@ 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, 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 Element < Base
         include ElementHelper
       end
     end
   end
-end
+end

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

@@ -1,4 +1,5 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'base'
 
 require_relative 'hook'
@@ -9,13 +10,13 @@ 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, 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 ElementArray < Base
         include ElementHelper
         include MultipleElementsHelper
       end
     end
   end
-end
+end

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

@@ -1,4 +1,5 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'base'
 
 require_relative 'hook'
@@ -9,18 +10,18 @@ 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, 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 ElementHash < Base
         include ElementHelper
         include MultipleElementsHelper
 
         # @return [Symbol] element method to define element keys by
         def define_elements_by
-          return self.adapter.define_elements_by
+          adapter.define_elements_by
         end
       end
     end
   end
-end
+end

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

@@ -1,33 +1,33 @@
+# frozen_string_literal: true
 module AutomationObject
   module BluePrint
     module Composite
-      #Helper module for Element composite classes
+      # Helper module for Element composite classes
       module ElementHelper
         # @return [Array<Symbol, String>, nil] params as an array for driver find_element args
         def selector_params
-          self.adapter.selector_params
+          adapter.selector_params
         end
 
         # @return [Symbol, nil] element name of iframe element is in or nil if not
         def in_iframe
-          self.adapter.in_iframe
+          adapter.in_iframe
         end
 
         # @return [Boolean] whether or not element is in iframe
         def in_iframe?
-          self.adapter.in_iframe?
+          adapter.in_iframe?
         end
 
         def method_hook?(name)
-          self.adapter.method_hook?(name)
+          adapter.method_hook?(name)
         end
 
         # @return [Hash<Hook>] array of Hook that are defined under the element
         def method_hooks
-          self.adapter.method_hooks
+          adapter.method_hooks
         end
       end
     end
   end
 end
-

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

@@ -1,18 +1,19 @@
+# frozen_string_literal: true
 module AutomationObject
   module BluePrint
     module Composite
-      #Helper module for multiple element composite classes
+      # Helper module for multiple element composite classes
       module MultipleElementsHelper
         # @return [Range, nil] gives range for limiting multiple elements or nil
         def custom_range
-          self.adapter.custom_range
+          adapter.custom_range
         end
 
         # @return [Symbol, nil] gives element method to remove duplicates on or nil
         def remove_duplicates
-          self.adapter.remove_duplicates
+          adapter.remove_duplicates
         end
       end
     end
   end
-end
+end

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

@@ -1,31 +1,29 @@
-#Require parent class
+# frozen_string_literal: true
+# 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
+      # 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
+          adapter.before
         end
 
         # @return [HookAction]
         def after
-          self.adapter.after
+          adapter.after
         end
 
         # @return [Array<HookElementRequirements>] array of element requirements
         def live?
-          self.adapter.live?
+          adapter.live?
         end
       end
     end
   end
-end
+end

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

@@ -1,4 +1,5 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'base'
 
 require_relative 'hook_element_requirements'
@@ -6,79 +7,79 @@ 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, 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
+        # 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 length of hook actions
+        # Get length of hook actions
         # @return [Integer] length of hook actions
         def length
-          self.adapter.length
+          adapter.length
         end
 
-        #See if hook actions are empty
+        # See if hook actions are empty
         # @return [Boolean] if hook actions are empty
         def empty?
-          self.adapter.empty?
+          adapter.empty?
         end
 
         # @return [Symbol, nil] screen to change to
         def change_screen
-          self.adapter.change_screen
+          adapter.change_screen
         end
 
         # @return [Symbol, nil] new screen
         def new_screen
-          self.adapter.new_screen
+          adapter.new_screen
         end
 
         # @return [Boolean]
         def close_screen
-          self.adapter.close_screen
+          adapter.close_screen
         end
 
         # @return [Boolean]
         def close_modal
-          self.adapter.close_modal
+          adapter.close_modal
         end
 
         # @return [Boolean]
         def change_to_previous_screen
-          self.adapter.change_to_previous_screen
+          adapter.change_to_previous_screen
         end
 
         # @return [Symbol, nil]
         def show_modal
-          self.adapter.show_modal
+          adapter.show_modal
         end
 
         # @return [Array]
         def possible_screen_changes
-          self.adapter.possible_screen_changes
+          adapter.possible_screen_changes
         end
 
-        #@return [Boolean] reset the screen?
+        # @return [Boolean] reset the screen?
         def reset_screen
-          self.adapter.reset_screen
+          adapter.reset_screen
         end
 
-        #@return [Numeric] amount of time to sleep
+        # @return [Numeric] amount of time to sleep
         def sleep
-          self.adapter.sleep
+          adapter.sleep
         end
 
-        #Custom method for array of children instead of Hash
+        # 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
+          adapter.wait_for_elements
         end
       end
     end
   end
-end
+end