automation_object 0.0.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c36cc7abfa4e9979ce44a0944d93226186e95322
-  data.tar.gz: 3c7a3f82d088f77f7fc8decb354eeafa5694632d
+  metadata.gz: bac9e2b6a0367c100fc66c0541dbea6800308e28
+  data.tar.gz: 3b16e66a40739ac2cb865664daf3aaf7aebe97ba
 SHA512:
-  metadata.gz: c2ece489fe81158e7aa27736e461042c8577180215b24cc0f01d0820e46e163b74b3a594dfb8b886fcdcede3426d84ea15ea7660826934d09311b33f7ae8bc68
-  data.tar.gz: 3fbbfa38f5f69f88e21eac36987a9b83f030f769bf211412d97dad5501a3ce6e4e1d65f661fdf731c0242579736134c510fe22565df2830eb19bd7f6ebc5bfb3
+  metadata.gz: 7aeb3799b980a4d0f68b649c0441ddda946ee3a1cdb8049b711259cdb35cb025db681fa662b47f3e2908afa86015ceeecda8105fc4433975211a14f2a5714b35
+  data.tar.gz: 6d93962d0df0434dd34fb238bb7fa5c8ab10610df17aea9abeb128c3b221e5fce7611b38ee2f97e30ceb20f756abd5b796530e8e757fd2d46ae6a28463dabcb4

data/lib/automation_object.rb

@@ -1,80 +1,22 @@
-require_relative 'automation_object/version'
-
-#Third-Party
-require 'event_emitter'
-require 'thread'
-require 'colorize'
+#Gems
 require 'awesome_print'
-require 'yaml'
-require 'rspec'
-require 'rspec/expectations'
-require 'securerandom'
-
-#Convience methods
-require_relative 'automation_object/hash'
-require_relative 'automation_object/object'
-require_relative 'automation_object/logger'
-
-#Driver Object that has Mutex for keeping Thread Safe!
-require_relative 'automation_object/driver/anonymous'
-require_relative 'automation_object/driver/element'
-require_relative 'automation_object/driver/driver'
-
-#HookHelper Module
-require_relative 'automation_object/hook_helpers'
+require 'ostruct'
+require 'event_emitter'
+require 'appium_lib'
+require 'selenium-webdriver'
 
-#BluePrintValidation Module
-require_relative 'automation_object/blue_print_validation/key_value_constants'
-require_relative 'automation_object/blue_print_validation/formatted_errors'
-require_relative 'automation_object/blue_print_validation/common_methods'
-require_relative 'automation_object/blue_print_validation/base_validation'
-require_relative 'automation_object/blue_print_validation/screen_modal_common_methods'
-require_relative 'automation_object/blue_print_validation/screen_validation'
-require_relative 'automation_object/blue_print_validation/modal_validation'
-require_relative 'automation_object/blue_print_validation/element_validation'
-require_relative 'automation_object/blue_print_validation/hook_validation'
-require_relative 'automation_object/blue_print_validation/validation_object'
+#Local Files
+require_relative 'automation_object/version'
 
-#BluePrint
-require_relative 'automation_object/blue_print'
+#Class method additions
+require_relative 'automation_object/helpers/string'
+require_relative 'automation_object/helpers/hash'
 
-#Framework Object
-require_relative 'automation_object/framework/helpers'
-require_relative 'automation_object/framework/window_helpers'
-require_relative 'automation_object/framework/print_objects'
-require_relative 'automation_object/framework/screen_routing'
-require_relative 'automation_object/framework/screen_monitor'
-require_relative 'automation_object/framework/events'
+#Core Framework
 require_relative 'automation_object/framework'
 
-#Screen/Modal Objects
-require_relative 'automation_object/screen/screen_window_helpers'
-require_relative 'automation_object/screen/screen_hook_helpers'
-require_relative 'automation_object/screen/screen_prompt_helpers'
-require_relative 'automation_object/screen/screen_modal_helpers'
-require_relative 'automation_object/screen/screen'
-require_relative 'automation_object/screen/modal'
-
-#Element/ElementHash/ElementArray Objects
-require_relative 'automation_object/element/element_helpers'
-require_relative 'automation_object/element/elements_helpers'
-require_relative 'automation_object/element/element_methods'
-require_relative 'automation_object/element/element'
-require_relative 'automation_object/element/element_array'
-require_relative 'automation_object/element/element_hash'
-
-#ElementGroup
-require_relative 'automation_object/element/element_group'
-require_relative 'automation_object/element/element_cell'
+#Cucumber Step Definitions
+require_relative 'automation_object/step_definitions'
 
 module AutomationObject
-  @@debug_mode = false
-
-  def self.debug_mode
-    @@debug_mode
-  end
-
-  def self.debug_mode=(value)
-    @@debug_mode = value
-  end
-end
+end

data/lib/automation_object/blue_print.rb

@@ -1,106 +1,43 @@
-module AutomationObject
-  class BluePrint < Hash
-    #Static
-    @@max_folder_depth = 10
-    @@base_directory = nil
-    @@validate_blueprint = false
-
-    def self.max_folder_depth
-      @@max_folder_depth
-    end
-
-    def self.max_folder_depth=(value)
-      @@max_folder_depth = value
-    end
-
-    def self.base_directory
-      @@base_directory
-    end
-
-    def self.base_directory=(value)
-      @@base_directory = value
-    end
-
-    def self.validate_blueprint
-      @@validate_blueprint
-    end
-
-    def self.validate_blueprint=(value)
-      @@validate_blueprint = value
-    end
-
-    #Instance
-    def initialize(path)
-      full_path = path
-      full_path = File.join(@@base_directory, path) if @@base_directory
-
-      unless File.directory?(full_path)
-        raise ArgumentError, "Blue prints directory doesn't exist: #{full_path}"
-      end
-
-      @configuration = Hash.new
-      self.merge_directory(full_path)
-
-      if @@validate_blueprint
-        BluePrintValidation::ValidationObject.new(self)
-      end
+require_relative 'blue_print/hash_adapter'
+require_relative 'blue_print/yaml_adapter'
 
-      self.merge_views
-    end
-
-    def merge_directory(path, depth = 0)
-      raise ArgumentError, "Folder depth breached max depth of #{@@max_folder_depth}" if depth > @@max_folder_depth
-
-      unless File.directory?(path)
-        raise ArgumentError, "Blue print path doesn't exist: #{path}"
-      end
-
-      Dir.foreach(path) do |item|
-        next if item == '.' or item == '..'
-        next if item[0] == '.'
-
-        file_path = File.join(path, "#{item}")
-        if File.directory?(file_path)
-          depth = depth + 1
-          self.merge_directory("#{path}/#{item}", depth) #call this method again for the subdirectory
-          next
-        end
-
-        next unless self.is_yaml_file?(file_path)
-
-        file_configuration = YAML.load_file(file_path)
-        @configuration = @configuration.deep_merge(file_configuration) if file_configuration.class == Hash
+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.
+  module BluePrint
+    extend self
+
+    # Get method for BluePrint adapter const for composite BluePrint build
+    # Each adapter will implement common BluePrint interface
+    # @return [AutomationObject::BluePrint::YamlAdapter, AutomationObject::BluePrint::HashAdapter]
+    def adapter
+      return @adapter if @adapter
+      self.adapter = :hash
+      @adapter
+    end
+
+    # Sets adapter const will append _adapter if needed
+    # @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_const = adapter_name.pascalize
+
+      @adapter = AutomationObject::BluePrint.const_get("#{adapter_const}")
+    end
+
+    # Adapters use the composite AutomationObject::BluePrint::Composite interfaces
+    # @return [AutomationObject::BluePrint::Composite::Top]
+    def new(blueprint_arg)
+      case blueprint_arg
+        when String
+          self.adapter = :yaml
+        when Hash
+          self.adapter = :hash
       end
 
-      @configuration.each { |key, value|
-        self[key] = value
-      }
-    end
-
-    def is_yaml_file?(file_path)
-      return (file_path.match(/\.ya?ml$/)) ? true : false
-    end
-
-    def merge_views
-      return unless self['screens'].is_a?(Hash)
-      return unless self['views'].is_a?(Hash)
-
-      self['screens'].each { |screen_name, screen_configuration|
-        next unless screen_configuration.is_a?(Hash)
-        next unless screen_configuration['included_views'].is_a?(Array)
-
-        screen_configuration['elements'] = Hash.new unless screen_configuration['elements'].class == Hash
-
-        screen_configuration['included_views'].each { |view|
-          next unless self['views'][view].is_a?(Hash)
-          self['views'][view]['elements'] = Hash.new unless self['views'][view]['elements'].is_a?(Hash)
-          screen_configuration = screen_configuration.deep_merge(self['views'][view])
-        }
-
-        self['screens'][screen_name] = screen_configuration
-      }
-
-      self.delete('views')
+      adapter.build(blueprint_arg)
     end
   end
 end

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

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

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

@@ -0,0 +1,18 @@
+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
+      class Base
+        attr_accessor :adapter
+
+        def initialize(adapter_object)
+          self.adapter = adapter_object
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+#Require parent class
+require_relative 'base'
+
+require_relative 'hook'
+require_relative 'custom_method'
+
+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
+      class Element < Base
+        include ElementHelper
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+#Require parent class
+require_relative 'base'
+
+require_relative 'hook'
+
+require_relative 'helpers/element_helper'
+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
+      class ElementArray < Base
+        include ElementHelper
+        include MultipleElementsHelper
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+#Require parent class
+require_relative 'base'
+
+require_relative 'hook'
+
+require_relative 'helpers/element_helper'
+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
+      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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module AutomationObject
+  module BluePrint
+    module Composite
+      #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
+        end
+
+        # @return [Symbol, nil] element name of iframe element is in or nil if not
+        def in_iframe
+          self.adapter.in_iframe
+        end
+
+        # @return [Boolean] whether or not element is in iframe
+        def in_iframe?
+          self.adapter.in_iframe?
+        end
+
+        def method_hook?(name)
+          self.adapter.method_hook?(name)
+        end
+
+        # @return [Hash<Hook>] array of Hook that are defined under the element
+        def method_hooks
+          self.adapter.method_hooks
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,18 @@
+module AutomationObject
+  module BluePrint
+    module Composite
+      #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
+        end
+
+        # @return [Symbol, nil] gives element method to remove duplicates on or nil
+        def remove_duplicates
+          self.adapter.remove_duplicates
+        end
+      end
+    end
+  end
+end