automation_object 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b00fa7d1b91d8a50f85fa6cd641d9f77eb2dbd40
-  data.tar.gz: b760483a7adc8d77a0099dd2c935982d64e1b611
+  metadata.gz: 948c2e3cbdbda291e87ce5d000bad8871ffd9e03
+  data.tar.gz: f2bb2fed5cce0206a3380adf874f96ee07091241
 SHA512:
-  metadata.gz: 5fd8bca116e06c3a059d96454f2fb9d1be23911ebb1c5a4da32779cf6d93460915bdd8655b5f3cfb6fe28fa7bc88cdd9dd58adc4ac88a5895f46a3bdb25f0e2d
-  data.tar.gz: ce4f20355199641b260f17d5cebdea9211d12ae4ece0e06a1305e4c22d21409351c3e6522c7f178f4a9d5f56d599dda4ef850349dac6ce35803d23af48631586
+  metadata.gz: 9ef1f75d16980edba5bccd0324a633b4d55961f3d2a30727dec03c241ce399686f7f61db23448fd61bfd45ebf6b78415b05452c1aa1f1822fae4870909fec191
+  data.tar.gz: 06a21cd5eac5ccc6855c055ab78affb5315d0e3aa721d076c347e68c13ca6bfdcc16e9b000a3131ee45e85448efc6260ac29d7325e27b3b8c92b36ea3937e3a2

data/lib/automation_object/blue_print.rb

@@ -2,6 +2,7 @@
 
 require_relative 'blue_print/hash_adapter'
 require_relative 'blue_print/yaml_adapter'
+require_relative 'blue_print/page_object_adapter'
 
 module AutomationObject
   # BluePrint Port, encapsulation of code required to parse and build composite data structure representing UI
@@ -12,7 +13,7 @@ module AutomationObject
 
     # Get method for BluePrint adapter const for composite BluePrint build
     # Each adapter will implement common BluePrint interface
-    # @return [AutomationObject::BluePrint::YamlAdapter, AutomationObject::BluePrint::HashAdapter]
+    # @return [AutomationObject::BluePrint::YamlAdapter, AutomationObject::BluePrint::HashAdapter, AutomationObject::BluePrint::PageObjectAdapter]
     def adapter
       return @adapter if @adapter
       self.adapter = :hash
@@ -34,7 +35,13 @@ module AutomationObject
     def create(blueprint_arg)
       case blueprint_arg
       when String
-        self.adapter = :yaml
+        path = File.expand_path(blueprint_arg)
+
+        self.adapter = if !Dir[File.join(path, '/**/*.rb')].empty?
+                         :page_object
+                       else
+                         :yaml
+                       end
       when Hash
         self.adapter = :hash
       end

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

@@ -6,14 +6,9 @@ module AutomationObject
     module Composite
       # Screen composite class
       module ContainerHelper
-        # @return [Array<AutomationObject::BluePrint::Composite::AutomaticModalChange>]
-        def automatic_modal_changes
-          adapter.automatic_modal_changes
-        end
-
         # @return [Array<Symbol>]
-        def automatic_screen_changes
-          adapter.automatic_screen_changes
+        def included_views
+          adapter.included_views
         end
 
         # @return [AutomationObject::BluePrint::Composite::Hook]

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

@@ -18,31 +18,6 @@ module AutomationObject
       # Modal composite class
       class Modal < Base
         include ContainerHelper
-
-        # @return [Array<Symbol>]
-        def included_views
-          adapter.included_views
-        end
-
-        # @return [AutomationObject::BluePrint::Composite::Hook]
-        def load
-          adapter.load
-        end
-
-        # @return [Hash<AutomationObject::BluePrint::Composite::Element>]
-        def elements
-          adapter.elements
-        end
-
-        # @return [Hash<AutomationObject::BluePrint::Composite::ElementArray>]
-        def element_arrays
-          adapter.element_arrays
-        end
-
-        # @return [Hash<AutomationObject::BluePrint::Composite::ElementHash>]
-        def element_hashes
-          adapter.element_hashes
-        end
       end
     end
   end

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

@@ -40,30 +40,10 @@ module AutomationObject
           adapter.dismiss
         end
 
-        # @return [AutomationObject::BluePrint::Composite::Hook]
-        def load
-          adapter.load
-        end
-
         # @return [Hash<AutomationObject::BluePrint::Composite::Modal>]
         def modals
           adapter.modals
         end
-
-        # @return [Hash<AutomationObject::BluePrint::Composite::Element>]
-        def elements
-          adapter.elements
-        end
-
-        # @return [Hash<AutomationObject::BluePrint::Composite::ElementArray>]
-        def element_arrays
-          adapter.element_arrays
-        end
-
-        # @return [Hash<AutomationObject::BluePrint::Composite::ElementHash>]
-        def element_hashes
-          adapter.element_hashes
-        end
       end
     end
   end

data/lib/automation_object/blue_print/hash_adapter.rb

@@ -14,7 +14,7 @@ module AutomationObject
       def build(hash = {})
         hash.symbolize_keys_deep!
 
-        top_hash = AutomationObject::BluePrint::HashAdapter::Top.new(hash)
+        top_hash = self::Top.new(hash)
         AutomationObject::BluePrint::Composite::Top.new(top_hash)
       end
     end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# Require parent class
 require_relative 'composite'
 
 # Require child classes

data/lib/automation_object/blue_print/page_object_adapter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require 'securerandom'
+
+require_relative 'composite/top'
+require_relative 'page_object_adapter/top'
+
+require_relative '../page_object'
+
+# PageObject adapter
+module AutomationObject
+  module BluePrint
+    # BluePrint PageObject Adapter
+    # Using classes to define page objects
+    module PageObjectAdapter
+      module_function
+
+      # @param path [String] path to PageObject classes
+      # @return [AutomationObject::BluePrint::Composite::Top] Composite BluePrint Object
+      def build(path = '')
+        # Require ruby files in that path into a module namespace
+        path = File.expand_path(path)
+
+        defined_module = define_random_module()
+
+        # Remove any defined classes in UserDefined namespace
+        defined_module.constants.select do |constant|
+          defined_module.const_get(constant).is_a? Class
+          defined_module.remove_const(constant)
+        end
+
+        # Add classes defined into UserDefined module
+        Dir[File.join(path, '**/*.rb')].each do |file|
+          defined_module.module_eval(File.read(file))
+        end
+
+        # Will look for classes defined
+        adapter_top = self::Top.new(defined_module)
+        AutomationObject::BluePrint::Composite::Top.new(adapter_top)
+      end
+
+      def define_random_module
+        random_module_name = [*('A'..'Z')].sample(20).join
+        random_module_symbol = random_module_name.to_sym
+
+        AutomationObject::BluePrint::PageObjectAdapter.module_eval %Q?
+          module #{random_module_name}
+
+          end
+        ?
+
+        const_get(random_module_symbol)
+      end
+    end
+  end
+end

data/lib/automation_object/blue_print/page_object_adapter/automatic_modal_change.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'composite'
+
+module AutomationObject
+  module BluePrint
+    module PageObjectAdapter
+      # Modal composite
+      class AutomaticModalChange < Composite
+        # @return [Symbol, nil]
+        def modal_name
+          modal_name = get_property(:modal_name)
+
+          case modal_name
+            when Symbol, String
+              return modal_name.to_sym
+            else
+              return nil
+          end
+        end
+
+        # @return [Integer]
+        def number_of_checks
+          get_property(:number_of_checks) || 1
+        end
+
+        # @return [Boolean]
+        def close
+          get_property(:close) || false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative '../../helpers/composite'
+require_relative '../../helpers/string'
+
+require_relative '../../page_object'
+
+module AutomationObject
+  module BluePrint
+    module PageObjectAdapter
+      # Base composite for PageObject adapter
+      class Composite < AutomationObject::Composite
+        # @return [Module]
+        attr_accessor :user_defined_module
+
+        # @return [AutomationObject::PageObject::Base]
+        attr_accessor :constant
+
+        # @param user_defined_module [Module] runtime defined module for loaded page objects
+        # @param constant [Class] class to build composite off of
+        # @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(user_defined_module, constant = nil, name = :top, parent = nil, location = 'top')
+          self.user_defined_module = user_defined_module
+          self.constant = constant.is_a?(Class) ? constant : nil
+
+          super(name, parent, location)
+        end
+
+        # Get child of composite
+        # @param name [Symbol] name of child
+        # @param options [Hash] options for child
+        # @return child [Object, nil] return child composite object
+        def get_child(name, options)
+          self.constant.constants.each { |constant_symbol|
+            constant = self.constant.const_get(constant_symbol)
+
+            # Check to see if constant is a child class of the public PageObject interface
+            next unless constant < get_page_object(options[:interface])
+
+            name = constant.name.split('::').last.to_underscore.to_sym
+            return create_composite(constant, options[:interface], name)
+          }
+
+          nil
+        end
+
+        # Get children of composite
+        # @param name [Symbol] name of child
+        # @param options [Hash] options for child
+        # @return [Hash] return children and names
+        def get_children(name, options)
+          new_children = {}
+
+          self.constant.constants.each { |constant_symbol|
+            constant = self.constant.const_get(constant_symbol)
+
+            # Check to see if constant is a child class of the public PageObject interface
+            next unless constant < get_page_object(options[:interface])
+
+            name = constant.name.split('::').last.to_underscore.to_sym
+            new_children[name] = create_composite(constant, options[:interface], name)
+          }
+
+          new_children
+        end
+
+        def create_composite(constant, interface, name)
+          # Get the Composite Class that corresponds with the PageObjectAdapter Class
+          class_name = interface.name.split('::').last
+          child_location = location + "[#{name}]"
+
+          require_relative "../composite/#{class_name.to_underscore}"
+          composite_class = AutomationObject::BluePrint::Composite.const_get(class_name)
+
+          composite_class.new(interface.new(user_defined_module, constant, name, self, child_location))
+        end
+
+        def get_page_object(adapter_interface)
+          name = adapter_interface.name.split('::').last.to_sym
+          AutomationObject::PageObject.const_get(name)
+        end
+
+        # @param name [Symbol]
+        # @return [Object]
+        def get_property(name)
+          self.constant.get_property(name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'composite'
+
+module AutomationObject
+  module BluePrint
+    module PageObjectAdapter
+      # CustomMethod composite
+      class CustomMethod < Composite
+        def element_method
+          element_method = get_property(:element_method)
+
+          case element_method
+          when Symbol, String
+            return element_method.to_sym
+          else
+            return nil
+          end
+        end
+
+        def evaluate
+          get_property(:evaluate) || nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'composite'
+
+require_relative 'helpers/element_helper'
+
+module AutomationObject
+  module BluePrint
+    module PageObjectAdapter
+      # Element composite
+      class Element < Composite
+        include ElementHelper
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'composite'
+
+require_relative 'helpers/element_helper'
+require_relative 'helpers/multiple_elements_helper'
+
+module AutomationObject
+  module BluePrint
+    module PageObjectAdapter
+      # ElementArray composite
+      class ElementArray < Composite
+        include ElementHelper
+        include MultipleElementsHelper
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'composite'
+
+require_relative 'helpers/element_helper'
+require_relative 'helpers/multiple_elements_helper'
+
+module AutomationObject
+  module BluePrint
+    module PageObjectAdapter
+      # ElementHash composite
+      class ElementHash < Composite
+        include ElementHelper
+        include MultipleElementsHelper
+
+        # @return [Symbol, nil] element method to define element keys by
+        def define_elements_by
+          return nil unless get_property(:define_elements_by)
+
+          get_property(:define_elements_by).to_sym
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../hook'
+
+module AutomationObject
+  module BluePrint
+    module PageObjectAdapter
+      # Helper module for Element composite classes
+      module ElementHelper
+        # @return [String, nil] text input for automatic screen/modal change if needed
+        def default_input
+          get_property(:default_input)
+        end
+
+        # @return [Array<Symbol, String>, nil] params as an array for driver find_element args
+        def selector_params
+          if hash[:xpath].is_a?(String)
+            [:xpath, hash[:xpath]]
+          elsif hash[:css].is_a?(String)
+            [:css, hash[:css]]
+          end
+        end
+
+        # @return [Symbol, nil] element name of iframe element is in or nil if not
+        def in_iframe
+          case hash[:in_iframe]
+          when Symbol, String
+            hash[:in_iframe].to_sym
+          end
+        end
+
+        # @return [Boolean] whether or not element is in iframe
+        def in_iframe?
+          in_iframe ? true : false
+        end
+
+        def method_hook?(name)
+          method_hooks.key?(name)
+        end
+
+        # @return [Hash<Hook>] hash of Hook that are defined under the element
+        def method_hooks
+          return @method_hooks if defined? @method_hooks
+
+          children = {}
+          hash.each do |key, value|
+            # Skip possible keys that elements can have
+            # Otherwise should be a method hook
+            next if %i[load custom_methods in_iframe css xpath define_elements_by custom_range].include?(key)
+            children[key] = value
+          end
+
+          @method_hooks = create_hash_children(children,
+                                               interface: Hook,
+                                               location: location + '[hook]')
+
+          @method_hooks
+        end
+      end
+    end
+  end
+end