automation_object 0.7.6 → 0.8.0

data/lib/automation_object/blue_print/yaml_adapter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'yaml'
 
 require_relative '../helpers/file'

data/lib/automation_object/driver.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'helpers/string'
 
 require_relative 'proxy/throttle_proxy'

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'appium_lib'
 
 require_relative '../../proxy/proxy'
@@ -85,7 +86,7 @@ module AutomationObject
 
         # @return [Boolean] whether or not browser is being used
         def browser?
-          return @browser unless @browser.nil?
+          return @browser if defined? @browser
           @browser = false
 
           # Now we need to check Appium's contexts to see if WEBVIEW is in available_contexts

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../common_selenium/element'
 
 module AutomationObject

data/lib/automation_object/driver/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module Driver
     # Base class for driver and element adapter interface

data/lib/automation_object/driver/common_selenium/driver.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../driver'
 
 module AutomationObject

data/lib/automation_object/driver/common_selenium/element.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../driver'
 require_relative 'element_geometry'
 

data/lib/automation_object/driver/common_selenium/element_geometry.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../driver'
 
 module AutomationObject

data/lib/automation_object/driver/driver.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'base'
 require_relative 'element'
 

data/lib/automation_object/driver/element.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'base'
 
 module AutomationObject

data/lib/automation_object/driver/nokogiri_adapter/driver.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'session'
 
 require_relative '../element'
@@ -56,8 +57,7 @@ module AutomationObject
         # Set timeout wait
         # @param timeout [Integer] the timeout in seconds
         # @return [void]
-        def wait(timeout = nil)
-        end
+        def wait(timeout = nil); end
 
         # @param selector_type [Symbol] selector type, :css, :xpath, etc...
         # @param selector_path [String] path to element
@@ -92,12 +92,10 @@ module AutomationObject
         end
 
         # Accept prompt either in browser or mobile
-        def accept_prompt
-        end
+        def accept_prompt; end
 
         # Dismiss the prompt
-        def dismiss_prompt
-        end
+        def dismiss_prompt; end
 
         # Check if browser, more useful for Appium but can be generic here
         # @return [Boolean] whether or not browser is being used
@@ -131,8 +129,7 @@ module AutomationObject
 
         # @param script [String] JS to run
         # @return [Object, nil]
-        def execute_script(script)
-        end
+        def execute_script(script); end
 
         # @return [Point] x,y scroll position
         def scroll_position

data/lib/automation_object/driver/nokogiri_adapter/element.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../driver'
 require_relative 'error'
 
@@ -61,22 +62,18 @@ module AutomationObject
         end
 
         # @return [Boolean]
-        def visible?
-        end
+        def visible?; end
 
         # @return [Boolean]
-        def invisible?
-        end
+        def invisible?; end
 
         # Get the location
         # @return [Point]
-        def location
-        end
+        def location; end
 
         # Get the size of an element
         # @return [Dimension]
-        def size
-        end
+        def size; end
 
         # Perform a submit action on an element
         # @return [void]
@@ -88,8 +85,7 @@ module AutomationObject
 
         # Scroll the element into view
         # @return [void]
-        def scroll_into_view
-        end
+        def scroll_into_view; end
 
         # Perform a click action on the element
         # @return [void]
@@ -130,8 +126,8 @@ module AutomationObject
           BoxCoordinates.new(x1: 0, y1: 0, x2: 0, y2: 0)
         end
 
-        # @param second_element_object [Object] element to compare to
-        # @param collision_tolerance [Numeric, FalseClass] pixel tolerance of collisions
+        # @param _second_element_object [Object] element to compare to
+        # @param _collision_tolerance [Numeric, FalseClass] pixel tolerance of collisions
         # @return [Boolean] element collides with other
         def collides_with_element?(_second_element_object, _collision_tolerance = false)
           false
@@ -139,8 +135,7 @@ module AutomationObject
 
         # Hover over element
         # @return [void]
-        def hover
-        end
+        def hover; end
 
         # Helper method to switch to this element's iframe
         # @return [void]

data/lib/automation_object/driver/nokogiri_adapter/error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module Driver
     # Emulate Selenium errors

data/lib/automation_object/driver/nokogiri_adapter/form.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module Driver
     module NokogiriAdapter

data/lib/automation_object/driver/nokogiri_adapter/request.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module Driver
     module NokogiriAdapter

data/lib/automation_object/driver/nokogiri_adapter/session.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'error'
 require_relative 'window'
 

data/lib/automation_object/driver/nokogiri_adapter/window.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rest-client'
 require 'nokogiri'
 

data/lib/automation_object/driver/selenium_adapter/driver.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../proxy/proxy'
 
 require_relative '../driver'

data/lib/automation_object/driver/selenium_adapter/element.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../common_selenium/element'
 
 module AutomationObject

data/lib/automation_object/dsl.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
+
 require_relative 'dsl/top'
+require_relative 'state/top'
 
 module AutomationObject
   # Dsl Port
   module Dsl
     module_function
 
-    # @param [AutomationObject::BluePrint::Composite::Top] blue_prints
-    # @param [AutomationObject::State::Session] state
+    # @param blue_prints [AutomationObject::BluePrint::Composite::Top]  top blue print
+    # @param state [AutomationObject::State::Top] top state
     # @return [AutomationObject::Dsl::Top]
     def create(blue_prints, state)
       TopProxy.new(blue_prints, state, :top)

data/lib/automation_object/dsl/_base.rb

@@ -12,13 +12,23 @@ module AutomationObject
         # Add attributes the call super
         self.class.has_many_relationships.each do |name, composite_class|
           blue_prints.send(name).each do |child_key, child_blue_prints|
-            ostruct_hash[child_key] = composite_class.new(child_blue_prints, state, child_key)
+            child_state = state.send(name)[child_key]
+            ostruct_hash[child_key] = composite_class.new(child_blue_prints, child_state, child_key)
           end
         end
 
         super ostruct_hash
       end
 
+      # @param [Symbol] method
+      # @param [Array, nil] args
+      # @param [Proc] block
+      def method_missing(method, *args, &block)
+        return super if to_h.key?(method)
+
+        raise NoMethodError.new("undefined method '#{method}'", method, args)
+      end
+
       def to_s
         inspect
       end

data/lib/automation_object/dsl/_error.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module AutomationObject
+  module Dsl
+    # Errors related to interacting with the DSL
+    module Error
+      # Error for automatically reaching screen
+      class AutoReachScreenError < StandardError
+        # @param name [Symbol,String] screen name
+        def initialize(name)
+          message = "#{name}, unable to automatically reach screen"
+          super(message)
+        end
+      end
+
+      # Error for automatically reaching modal
+      class AutoReachModalError < StandardError
+        # @param name [Symbol,String] screen name
+        def initialize(name)
+          message = "#{name}, unable to automatically reach modal"
+          super(message)
+        end
+      end
+
+      # Error for non-existent screen
+      class ScreenDoesNotExistError < StandardError
+        # @param name [Symbol,String] screen name
+        def initialize(name)
+          message = "#{name} screen does not exist"
+          super(message)
+        end
+      end
+
+      # Error for non-existent modal
+      class ModalDoesNotExistError < StandardError
+        # @param name [Symbol,String] modal name
+        def initialize(name)
+          message = "#{name} modal does not exist"
+          super(message)
+        end
+      end
+
+      # Error for non-existent element
+      class ElementDoesNotExistError < StandardError
+        # @param name [Symbol,String] element name
+        def initialize(name)
+          message = "#{name} element does not exist"
+          super(message)
+        end
+      end
+
+      # Error for non-existent element hash
+      class ElementHashDoesNotExistError < StandardError
+        # @param name [Symbol,String] element hash name
+        def initialize(name)
+          message = "#{name} element hash does not exist"
+          super(message)
+        end
+      end
+
+      # Error for non-existent element array
+      class ElementArrayDoesNotExistError < StandardError
+        # @param name [Symbol,String] element array name
+        def initialize(name)
+          message = "#{name} element array does not exist"
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/automation_object/dsl/_proxy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../proxy/proxy'
 
 module AutomationObject

data/lib/automation_object/dsl/element.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_proxy'
 
 module AutomationObject
@@ -13,8 +14,7 @@ module AutomationObject
       # @param [AutomationObject::State::Modal, AutomationObject::State::Screen] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        element_state = state.elements[name]
-        super Element, blue_prints, element_state, name
+        super Element, blue_prints, state, name
       end
 
       # @param [Symbol] method

data/lib/automation_object/dsl/element_array.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_proxy'
 
 module AutomationObject
@@ -13,8 +14,7 @@ module AutomationObject
       # @param [AutomationObject::State::Modal, AutomationObject::State::Screen] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        element_array_state = state.element_arrays[name]
-        super ElementArray, blue_prints, element_array_state, name
+        super ElementArray, blue_prints, state, name
       end
 
       # @param [Symbol] method

data/lib/automation_object/dsl/element_hash.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_proxy'
 
 module AutomationObject
@@ -13,8 +14,7 @@ module AutomationObject
       # @param [AutomationObject::State::Modal, AutomationObject::State::Screen] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        element_hash_state = state.element_hashes[name]
-        super ElementHash, blue_prints, element_hash_state, name
+        super ElementHash, blue_prints, state, name
       end
 
       # @param [Symbol] method

data/lib/automation_object/dsl/modal.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_proxy'
+require_relative '_error'
 
 require_relative 'element'
 require_relative 'element_array'
@@ -21,8 +23,7 @@ module AutomationObject
       # @param [AutomationObject::State::Screen] state
       # @param [Symbol] name
       def initialize(blue_prints, state, name)
-        modal_state = state.modals[name]
-        super Modal, blue_prints, modal_state, name
+        super Modal, blue_prints, state, name
       end
 
       # @param [Symbol] method
@@ -41,6 +42,50 @@ module AutomationObject
       def active?
         @state.active?
       end
+
+      # Go to this modal
+      # Will try to automatically reach it, will throw error if it cannot
+      # @raise [AutomationObject::Dsl::Error::AutoReachModalError]
+      # @return [void]
+      def go
+        raise AutomationObject::Dsl::Error::AutoReachModalError, @name unless @state.go
+      end
+
+      # Retrieve element from composite
+      # @param name [String, Symbol] name of element
+      # @raise [AutomationObject::Dsl::Error::ElementDoesNotExistError]
+      # @return [AutomationObject::Dsl::ElementProxy]
+      def element(name)
+        name = name.to_sym
+        raise AutomationObject::Dsl::Error::ElementDoesNotExistError, name unless @subject.to_h.include?(name)
+
+        @state.utilize
+        @subject.send(name)
+      end
+
+      # Retrieve element array from composite
+      # @param name [String, Symbol] name of element array
+      # @raise [AutomationObject::Dsl::Error::ElementArrayDoesNotExistError]
+      # @return [AutomationObject::Dsl::ElementArrayProxy]
+      def element_array(name)
+        name = name.to_sym
+        raise AutomationObject::Dsl::Error::ElementArrayDoesNotExistError, name unless @subject.to_h.include?(name)
+
+        @state.utilize
+        @subject.send(name)
+      end
+
+      # Retrieve element hash from composite
+      # @param name [String, Symbol] name of element hash
+      # @raise [AutomationObject::Dsl::Error::ElementHashDoesNotExistError]
+      # @return [AutomationObject::Dsl::ElementHashProxy]
+      def element_hash(name)
+        name = name.to_sym
+        raise AutomationObject::Dsl::Error::ElementHashDoesNotExistError, name unless @subject.to_h.include?(name)
+
+        @state.utilize
+        @subject.send(name)
+      end
     end
   end
 end