automation_object 0.5.0 → 0.5.1

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

@@ -1,20 +1,21 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'composite'
 
-#Require child classes
+# Require child classes
 require_relative 'screen'
 require_relative 'view'
 
 module AutomationObject
   module BluePrint
     module HashAdapter
-      #Top composite
+      # Top composite
       class Top < Composite
-        #Relationships
+        # Relationships
         has_many :screens, interface: Screen
         has_many :views, interface: View
 
-        #Validations
+        # Validations
         validates_keys allowed_keys: [:base_url, :default_screen, :screen_transition_sleep, :screens,
                                       :throttle_driver_methods, :throttle_element_methods, :views]
 
@@ -28,36 +29,36 @@ module AutomationObject
 
         # @return [String, nil] base url to navigate to upon framework creation
         def base_url
-          self.hash[:base_url] ||= nil
+          hash[:base_url] ||= nil
         end
 
         # @return [Symbol, nil] default screen to be set when framework is created
         def default_screen
-          default_screen = self.hash[:default_screen]
+          default_screen = hash[:default_screen]
 
           case default_screen
-            when Symbol, String
-              return default_screen.to_sym
-            else
-              return nil
+          when Symbol, String
+            return default_screen.to_sym
+          else
+            return nil
           end
         end
 
         # @return [Numeric] sleep when transitioning screens
         def screen_transition_sleep
-          self.hash[:screen_transition_sleep] ||= 0
+          hash[:screen_transition_sleep] ||= 0
         end
 
         # @return [Hash] driver methods to throttle
         def throttle_driver_methods
-          self.hash[:throttle_driver_methods] ||= Hash.new
+          hash[:throttle_driver_methods] ||= {}
         end
 
         # @return [Hash] element methods to throttle
         def throttle_element_methods
-          self.hash[:throttle_element_methods] ||= Hash.new
+          hash[:throttle_element_methods] ||= {}
         end
       end
     end
   end
-end
+end

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

@@ -1,12 +1,27 @@
-#Require parent class
+# frozen_string_literal: true
+# Require parent class
 require_relative 'composite'
 
 module AutomationObject
   module BluePrint
     module HashAdapter
-      #View composite
+      # View composite
       class View < Composite
-        #Validations
+        # Creation hooks
+        before_create :merge_views
+        before_create :automatic_onload_modals
+
+        # Relationships
+        has_one :load, interface: Hook
+        has_one :accept, interface: Hook
+        has_one :dismiss, interface: Hook
+
+        has_many :modals, interface: Modal
+        has_many :elements, interface: Element
+        has_many :element_arrays, interface: ElementArray
+        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]
 
@@ -23,7 +38,46 @@ module AutomationObject
         validates :load, instance_of: Hash
 
         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
+
+          children = hash[:automatic_onload_modals]
+          children = children.is_a?(Array) ? children : []
+          @automatic_onload_modals = create_array_children(:automatic_onload_modals, children,
+                                                           interface: AutomaticOnloadModal,
+                                                           location: location + '[automatic_onload_modals]')
+
+          @automatic_onload_modals
+        end
+
+        # @return [Array<Symbol>] array of screens where screen can automatically change to
+        def automatic_screen_changes
+          screen_array = hash[:automatic_screen_changes] ||= []
+          screen_array.map(&:to_sym)
+        end
+
+        # @return [Array<Symbol>] array of views this can has
+        def included_views
+          included_views_array = hash[:included_views] ||= []
+          included_views_array.map(&:to_sym)
+        end
+
+        # Method to take views and merge into this composite
+        def merge_views
+          top_hash = top.hash
+
+          return unless top_hash.is_a?(Hash)
+          return unless top_hash[:views].is_a?(Hash)
+          top_view_hash = top_hash[:views]
+
+          included_views.each do |included_view|
+            next unless top_view_hash[included_view].is_a?(Hash)
+            self.hash = hash.deep_merge(top_view_hash[included_view])
+          end
+        end
       end
     end
   end
-end
+end

data/lib/automation_object/blue_print/yaml_adapter.rb

@@ -1,50 +1,49 @@
+# frozen_string_literal: true
 require 'yaml'
 
-require_relative '../blue_print'
+require_relative '../helpers/file'
 require_relative 'hash_adapter'
-require_relative 'helpers/file_helper'
 
-module AutomationObject::BluePrint
-  #BluePrint YAML Adapter
-  module YamlAdapter
-    extend self
-    extend FileHelper
+module AutomationObject
+  module BluePrint
+    # BluePrint YAML Adapter
+    module YamlAdapter
+      module_function
 
-    # @param path [String] path to YAML directory
-    # @return [AutomationObject::BluePrint::Composite::Top] Composite BluePrint Object
-    def build(path = '')
-      path = File.expand_path(path)
+      # @param path [String] path to YAML directory
+      # @return [AutomationObject::BluePrint::Composite::Top] Composite BluePrint Object
+      def build(path = '')
+        path = File.expand_path(path)
 
-      file_array = self.collect_files(path)
-      merged_yaml_hash = self.load_yaml_files(file_array)
+        file_array = File.collect_files(path)
+        merged_yaml_hash = load_yaml_files(file_array)
 
-      return AutomationObject::BluePrint::HashAdapter.build(merged_yaml_hash)
-    end
+        AutomationObject::BluePrint::HashAdapter.build(merged_yaml_hash)
+      end
 
-    # @param file_array [Array<String>] array of file paths to load
-    # @return [Hash] merged YAML Hash
-    def load_yaml_files(file_array)
-      merged_yaml_hash = Hash.new
+      # @param file_array [Array<String>] array of file paths to load
+      # @return [Hash] merged YAML Hash
+      def load_yaml_files(file_array)
+        merged_yaml_hash = {}
 
-      file_array.each { |file_path|
-        next unless self.is_yaml_file?(file_path)
+        file_array.each do |file_path|
+          next unless yaml_file?(file_path)
 
-        file_hash = YAML.load_file(file_path)
+          file_hash = YAML.load_file(file_path)
 
-        unless file_hash.is_a?(Hash)
-          raise "Expecting file #{file_path} to be a hash when loaded"
-        end
+          raise "Expecting file #{file_path} to be a hash when loaded" unless file_hash.is_a?(Hash)
 
-        merged_yaml_hash = merged_yaml_hash.deep_merge(file_hash)
-      }
+          merged_yaml_hash = merged_yaml_hash.deep_merge(file_hash)
+        end
 
-      return merged_yaml_hash
-    end
+        merged_yaml_hash
+      end
 
-    # @param file_path [String] file path
-    # @return [Boolean] whether or not it is a YAML file
-    def is_yaml_file?(file_path)
-      return (file_path.match(/\.ya?ml$/)) ? true : false
+      # @param file_path [String] file path
+      # @return [Boolean] whether or not it is a YAML file
+      def yaml_file?(file_path)
+        file_path =~ /\.ya?ml$/ ? true : false
+      end
     end
   end
-end
+end

data/lib/automation_object/driver.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
 require_relative 'helpers/string'
 
-require_relative 'proxies/throttle_proxy'
-require_relative 'proxies/mutex_proxy'
+require_relative 'proxy/throttle_proxy'
+require_relative 'proxy/mutex_proxy'
 
 require_relative 'driver/driver'
 
-#Adapters
+# Adapters
 require_relative 'driver/appium_adapter/driver'
 require_relative 'driver/nokogiri_adapter/driver'
 require_relative 'driver/selenium_adapter/driver'
 
 module AutomationObject
-  #Driver Port
+  # Driver Port
   module Driver
-    extend self
+    module_function
 
     def adapter
       return @adapter if @adapter
@@ -25,20 +26,21 @@ 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::Driver.const_get("#{adapter_const}")
+      @adapter = AutomationObject::Driver.const_get(adapter_const.to_s)::Driver
     end
 
     # @param driver [Object] selenium or appium driver. default nil for Nokogiri
     # @return [AutomationObject::Driver::Driver]
-    def new(driver = nil)
-      adapted_driver = Driver.new(self.adapter.new(driver))
+    def create(driver = nil)
+      adapted_driver = Driver.new(adapter.new(driver))
 
-      #Add throttling and mutex proxies around adapter
-      return AutomationObject::Proxies::MutexProxy.new(
-                    AutomationObject::Proxies::ThrottleProxy.new(adapted_driver))
+      # Add throttling and mutex proxies around adapter
+      AutomationObject::Proxy::MutexProxy.new(
+        AutomationObject::Proxy::ThrottleProxy.new(adapted_driver)
+      )
     end
   end
-end
+end

data/lib/automation_object/driver/appium_adapter/driver.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
 require 'appium_lib'
 
-require_relative '../../proxies/proxy'
-require_relative '../helpers/selenium_driver_helper'
+require_relative '../../proxy/proxy'
+
+require_relative '../driver'
+require_relative '../common_selenium/driver'
 
 require_relative '../element'
 require_relative 'element'
@@ -9,10 +12,10 @@ require_relative 'element'
 module AutomationObject
   module Driver
     module AppiumAdapter
-      #Driver proxy for Appium
-      #Conform Appium driver interface to what's expected of the Driver Port
-      class Driver < AutomationObject::Proxies::Proxy
-        include AutomationObject::Driver::SeleniumDriverHelper
+      # Driver proxy for Appium
+      # Conform Appium driver interface to what's expected of the Driver Port
+      class Driver < AutomationObject::Proxy::Proxy
+        include AutomationObject::Driver::CommonSelenium::Driver
 
         # @param driver [Appium::Driver] Appium Driver
         def initialize(driver)
@@ -26,16 +29,16 @@ module AutomationObject
           @subject.get(url)
         end
 
-        # @param script [String] JS to run
-        # @return [Object, nil]
-        def execute_script(script)
-          @subject.execute_script(script)
+        # Get the title of the document
+        # @return [String]
+        def title
+          @subject.title
         end
 
-        #Set timeout wait
+        # Set timeout wait
         # @param timeout [Integer] the timeout in seconds
         # @return [void]
-        def set_wait(timeout = nil)
+        def wait(timeout = nil)
           @subject.set_wait(timeout)
         end
 
@@ -43,7 +46,7 @@ module AutomationObject
         # @param selector_path [String] path to element
         # @return [Boolean] exists or not
         def exists?(selector_type, selector_path)
-          return @subject.exists { @subject.find_element(selector_type, selector_path) }
+          @subject.exists { @subject.find_element(selector_type, selector_path) }
         end
 
         # @param selector_type [Symbol] selector type, :css, :xpath, etc...
@@ -51,8 +54,8 @@ module AutomationObject
         # @return [AutomationObject::Driver::Element] element
         def find_element(selector_type, selector_path)
           element = @subject.find_element(selector_type, selector_path)
-          #Wrap element in the adapter interface
-          return AutomationObject::Driver::Element.new(Element.new(driver: self, element: element))
+          # Wrap element in the adapter interface
+          AutomationObject::Driver::Element.new(Element.new(self, element))
         end
 
         # @param selector_type [Symbol] selector type, :css, :xpath, etc...
@@ -61,10 +64,10 @@ module AutomationObject
         def find_elements(selector_type, selector_path)
           elements = @subject.find_elements(selector_type, selector_path)
 
-          elements.map { |element|
-            #Wrap element in the adapter interface
-            AutomationObject::Driver::Element.new(Element.new(driver: self, element: element))
-          }
+          elements.map do |element|
+            # Wrap element in the adapter interface
+            AutomationObject::Driver::Element.new(Element.new(self, element))
+          end
         end
 
         # @return [void]
@@ -78,52 +81,50 @@ module AutomationObject
         end
 
         # @return [Boolean] whether or not browser is being used
-        def is_browser?
-          return @is_browser unless @is_browser == nil
-          @is_browser = false
+        def browser?
+          return @browser unless @browser.nil?
+          @browser = false
 
-          #Now we need to check Appium's contexts to see if WEBVIEW is in available_contexts
+          # Now we need to check Appium's contexts to see if WEBVIEW is in available_contexts
           available_contexts = @subject.available_contexts
-          available_contexts.each { |context|
-            if context.match(/^WEBVIEW_\d+$/)
-              @is_browser = true
+          available_contexts.each do |context|
+            if context =~ /^WEBVIEW_\d+$/
+              @browser = true
               break
             end
-          }
+          end
 
-          return @is_browser
+          @browser
         end
 
-        #Window Handles Override
+        # Window Handles Override
         # @return [Array<String>] array of window handles
         def window_handles
-          if @subject.device_is_android? and self.is_browser?
+          if @subject.device_is_android? && is_browser?
             window_handles = @subject.window_handles
           else
-            return @subject.available_contexts unless self.is_browser?
+            return @subject.available_contexts unless is_browser?
 
             window_handles = []
-            @subject.available_contexts.each { |context|
-              window_handles.push(context) if context.match(/^WEBVIEW_\d+$/)
-            }
+            @subject.available_contexts.each do |context|
+              window_handles.push(context) if context =~ /^WEBVIEW_\d+$/
+            end
           end
 
-          return window_handles
+          window_handles
         end
 
-        #Get window handle override
+        # Get window handle override
         # @return [String] current window handle
         def window_handle
-          return @subject.current_context unless self.is_browser?
+          return @subject.current_context unless is_browser?
 
-          if @subject.device_is_android?
-            return @subject.window_handle
-          else
-            return @subject.current_context
-          end
+          return @subject.window_handle if @subject.device_is_android?
+
+          @subject.current_context
         end
 
-        #Set window handle override
+        # Set window handle override
         # @param handle_value [String] window handle value
         # @return [void]
         def window_handle=(handle_value)
@@ -136,8 +137,8 @@ module AutomationObject
 
         # @return [Boolean] document is complete
         def document_complete?
-          return true unless self.is_browser? #Skip for non-browser Appium sessions
-          return @subject.execute_script('return document.readyState;') == 'complete'
+          return true unless is_browser? # Skip for non-browser Appium sessions
+          @subject.execute_script('return document.readyState;') == 'complete'
         end
 
         # @return [void]
@@ -147,4 +148,4 @@ module AutomationObject
       end
     end
   end
-end
+end