automation_object 0.7.6 → 0.8.0

data/lib/automation_object/state/helpers/container_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module AutomationObject
+  module State
+    module ContainerHelper
+      # Whether or not modal is active
+      attr_accessor :active
+
+      # @return [Boolean] screen is active or not
+      def active?
+        @active ||= false
+      end
+
+      # Automatically find a way to go to this screen
+      # @return [Boolean]
+      def go
+        if active?
+          utilize
+          return true
+        end
+
+        AutomaticRouting.new(top, name).route
+      end
+
+      # @return [Array<Symbol>]
+      def changes
+        blue_prints.changes
+      end
+
+      # @param name [Symbol] name of container you want to go to
+      # @return [AutomationObject::State::Element]
+      def element_to_container(name)
+        element_name, element_type = blue_prints.element_to_container(name)
+        return unless element_name || element_type
+
+        send(element_type)[element_name]
+      end
+
+      def reset
+        elements.values.map(&:reset)
+        element_arrays.values.map(&:reset)
+        element_hashes.values.map(&:reset)
+      end
+    end
+  end
+end

data/lib/automation_object/state/hook.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 
 require_relative 'hook_action'

data/lib/automation_object/state/hook_action.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 
 require_relative 'hook_actions/change_screen'

data/lib/automation_object/state/hook_actions/action_loop.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AutomationObject
   module State
     # Composite action loop base class

data/lib/automation_object/state/hook_actions/change_screen.rb

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

data/lib/automation_object/state/hook_actions/change_to_previous_screen.rb

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

data/lib/automation_object/state/hook_actions/close_modal.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'action_loop'
 require_relative '../_error'
 

data/lib/automation_object/state/hook_actions/close_screen.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'action_loop'
 require_relative '../_error'
 

data/lib/automation_object/state/hook_actions/element_requirement.rb

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

data/lib/automation_object/state/hook_actions/new_screen.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'action_loop'
 require_relative '../_error'
 

data/lib/automation_object/state/hook_actions/possible_screen_changes.rb

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

data/lib/automation_object/state/hook_actions/reset_screen.rb

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

data/lib/automation_object/state/hook_actions/show_modal.rb

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

data/lib/automation_object/state/hook_actions/sleep.rb

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

data/lib/automation_object/state/hook_actions/wait_for_elements.rb

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

data/lib/automation_object/state/modal.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_error'
 
@@ -6,10 +7,14 @@ require_relative 'element'
 require_relative 'element_array'
 require_relative 'element_hash'
 
+require_relative 'helpers/container_helper'
+
 module AutomationObject
   module State
     # Modal composite for managing state
     class Modal < Base
+      include ContainerHelper
+
       has_one :load, interface: Hook
 
       has_many :elements, interface: Element
@@ -20,14 +25,6 @@ module AutomationObject
         raise ModalNotActiveError, name unless active?
       end
 
-      # Whether or not modal is active
-      attr_accessor :active
-
-      # @return [Boolean] screen is active or not
-      def active?
-        @active ||= false
-      end
-
       def activate
         @active = true
       end
@@ -36,12 +33,6 @@ module AutomationObject
         @active = false
         reset
       end
-
-      def reset
-        elements.values.map(&:reset)
-        element_arrays.values.map(&:reset)
-        element_hashes.values.map(&:reset)
-      end
     end
   end
 end

data/lib/automation_object/state/screen.rb

@@ -1,70 +1,84 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_error'
 
+require_relative 'automatic_modal_change'
+require_relative 'automatic_screen_changes'
 require_relative 'modal'
 require_relative 'hook'
 require_relative 'element'
 require_relative 'element_array'
 require_relative 'element_hash'
 
+require_relative 'helpers/automatic_routing'
+require_relative 'helpers/container_helper'
+
 module AutomationObject
   module State
     # Screen composite for managing state
     class Screen < Base
+      include ContainerHelper
+
       attr_accessor :modal, :window_handle, :previous_screen_name
 
+      # @return [AutomaticScreenChanges]
+      attr_accessor :automatic_screen_changes
+
       has_one :load, interface: Hook
 
       # Children for this composite
+      # has_many :automatic_modal_changes, interface: AutomaticModalChange
       has_many :modals, interface: Modal
 
       has_many :elements, interface: Element
       has_many :element_arrays, interface: ElementArray
       has_many :element_hashes, interface: ElementHash
 
-      # Whether or not modal is active
-      attr_accessor :active
-
-      # @return [Boolean] screen is active or not
-      def active?
-        @active ||= false
-      end
-
+      # @return [void]
       def activate
         @active = true
         self.window_handle = driver.window_handle
+
+        return if blue_prints.automatic_screen_changes.empty?
+
+        # Add automatic screen change to a new thread and test for screen changes
+        self.automatic_screen_changes = AutomaticScreenChanges.new(driver,
+                                                                   blue_prints.automatic_screen_changes,
+                                                                   :automatic_screen_changes,
+                                                                   self,
+                                                                   location + '[automatic_screen_changes]')
+        automatic_screen_changes.activate
       end
 
+      # @return [void]
       def deactivate
+        automatic_screen_changes&.deactivate
+
+        self.automatic_screen_changes, self.window_handle = nil
         @active = false
-        self.window_handle = nil
+
         modals.values.map(&:deactivate)
         reset
       end
 
+      # @return [void]
       def utilize
         raise ScreenNotActiveError, name unless active?
-        driver.window_handle = window_handle if window_handle != driver.window_handle
+        driver.window_handle = window_handle
       end
 
+      # @return [void]
       def close
-        raise ScreenNotActiveError, name unless active?
-
-        driver.window_handle = window_handle if window_handle != driver.window_handle
+        utilize
         driver.close
+        deactivate
       end
 
       # @return [Boolean]
       def closed?
         !driver.window_handles.include?(window_handle)
       end
-
-      def reset
-        elements.values.map(&:reset)
-        element_arrays.values.map(&:reset)
-        element_hashes.values.map(&:reset)
-      end
     end
   end
 end

data/lib/automation_object/state/top.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '_base'
 require_relative '_error'
 
@@ -9,11 +10,20 @@ module AutomationObject
     # Top composite for managing state
     class Top < Base
       # Children for this composite
+      # @return [Hash<Screen>]
       has_many :screens, interface: Screen
 
-      def initialize(*args)
-        super(*args)
+      # @param driver [AutomationObject::Driver] driver
+      # @param blue_prints [AutomationObject::BluePrint::Composite::Base] blue print composite
+      # @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(driver, blue_prints, name = :top, parent = nil, location = 'top')
+        super
+      end
 
+      # @return [Void]
+      def start
         driver.get(blue_prints.base_url) if blue_prints.base_url
         set_initial_screen
       end
@@ -38,6 +48,11 @@ module AutomationObject
 
         raise AutomationObject::State::NoInitialScreenError
       end
+
+      # @return [Hash<Screen>] active screens
+      def active_screens
+        screens.select { |_key, value| value.active? }
+      end
     end
   end
 end

data/lib/automation_object/step_definitions.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
+
 module AutomationObject
   # Require step definitons at run-time, only when running in a Cucumber context
   module StepDefinitions
     module_function
 
     def load
-      # Using minitest to run assertions
-      require 'minitest/autorun'
-      require 'minitest/unit'
-      require 'minitest-bonus-assertions'
+      # Using rspec to run assertions
+      require 'rspec/expectations'
 
       Dir[File.dirname(__FILE__) + '/step_definitions/**/*.rb'].each { |file| require file }
     end

data/lib/automation_object/step_definitions/element.rb

@@ -1,78 +1,77 @@
 # frozen_string_literal: true
 require_relative 'support/parse'
-require_relative 'support/minitest'
 
 # Description: Provides step definitions related to elements
 
-# For: Calling an element method
+# Call an element method
 # Examples:
 # - I click on the "home_screen" "about_button" element
 # - I hover over the "home_screen" "test_link" element
 # - I tap on "home_screen" "logo_button" element
-When(/^I (\w+|%\{[\w\d]+\}) ?(?: on| over)? (?:the )?"(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element$/) do |*args|
+When(%r(^I (\w+|%\{\w+\}) ?(?: on| over)? (?:the )?"(\w+|%\{\w+\})" "(\w+|%\{\w+\})" element$)) do |*args|
   method, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
-  AutomationObject::Framework.get.send(screen).send(element).send(method)
+  AutomationObject::Framework.get.screen(screen).element(element).send(method)
 end
 
-# For: Typing into element field
+# For: Type into element field
 # Examples:
 # - I type "blah" into the "home_screen" "text_field" element
 # - I type "test" in the "home_screen" "text_field" element
 # - I type "blah" in "home_screen" "text_field" element
-When(/^I type "([^"]+|%\{[\w\d]+\})" in(?:to)? (?:the )?"(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element$/) do |*args|
+When(%r(^I type "([^"]+|%\{\w+\})" in(?:to)? (?:the )?"(\w+|%\{\w+\})" "(\w+|%\{\w+\})" element$)) do |*args|
   text, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
-  AutomationObject::Framework.get.send(screen).send(element).send_keys(text)
+  AutomationObject::Framework.get.screen(screen).element(element).send_keys(text)
 end
 
-# For: Scrolling element into focus
+# For: Scroll element into focus
 # Examples:
 # - I scroll to the "home_screen" "logo_button" element
 # - I focus to the "home_screen" "logo_button" element
 # - I scroll to "home_screen" "logo_button" element
-When(/^I (?:scroll |focus )to (?:the )?"(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element$/) do |*args|
+When(%r(^I (?:scroll |focus )to (?:the )?"(\w+|%\{\w+\})" "(\w+|%\{\w+\})" element$)) do |*args|
   screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
-  AutomationObject::Framework.get.send(screen).send(element).scroll_into_view
+  AutomationObject::Framework.get.screen(screen).element(element).scroll_into_view
 end
 
-# For: Saving value from element for use later
+# For: Save value from element for use later
 # Examples:
 # - I save "text" as "unique_value" from the "home_screen" "logo_button" element
 # - I save "id" as "unique_value" from "home_screen" "logo_button" element
-When(/^I save "(\w+|%\{[\w\d]+\})" as "([\w\d]+)" from (?:the )?"(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element$/) do |*args|
+When(%r(^I save "(\w+|%\{\w+\})" as "(\w+)" from (?:the )?"(\w+|%\{\w+\})" "(\w+|%\{\w+\})" element$)) do |*args|
   method, key, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
   # Save value from called method/property
-  value = AutomationObject::Framework.get.send(screen).send(element).send(method)
+  value = AutomationObject::Framework.get.screen(screen).element(element).send(method)
   AutomationObject::StepDefinitions::Cache.set(key, value)
 end
 
-# For: Testing if the element exists or not
+# For: Test if the element exists or not
 # Examples:
 # - the "home_screen" "title" element should exist
 # - the "home_screen" "title" element shouldn't exist
 # - "home_screen" "title" element should not exist
-Then(/^(?:the )?"(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element should ?(n't |not )?exist$/) do |*args|
+Then(%r(^(?:the )?"(\w+|%\{\w+\})" "(\w+|%\{\w+\})" element should ?(n't |not )?exist$)) do |*args|
   screen, element, negative = AutomationObject::StepDefinitions::Parse.new(args).get
 
-  exists = AutomationObject::Framework.get.send(screen).send(element).exists?
+  exists = AutomationObject::Framework.get.screen(screen).element(element).exists?
   if negative
-    assert_equal false, exists
+    expect(exists).to eq(false)
   else
-    assert_equal true, exists
+    expect(exists).to eq(true)
   end
 end
 
-# For: Testing if the element method value equals a given value
+# For: Test if the element method value equals a given value
 # Examples:
 # - the "home_screen" "title" element "text" should equal "Home"
 # - "home_screen" "title" element "text" should not equal "About"
 # - the "home_screen" "title" element "text" shouldn't equal "%{saved_value}"
-Then(/^(?:the )?"(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element "(\w+|%\{[\w\d]+\})" should ?(n't |not )?equal "(\w+|%\{[\w\d]+\})"$/) do |*args|
+Then(%r(^(?:the )?"(\w+|%\{\w+\})" "(\w+|%\{\w+\})" element "(\w+|%\{\w+\})" should ?(n't |not )?equal "(\w+|%\{\w+\})"$)) do |*args|
   screen, element, method, negative, expected_value = AutomationObject::StepDefinitions::Parse.new(args).get
 
-  actual_value = AutomationObject::Framework.get.send(screen).send(element).send(method)
+  actual_value = AutomationObject::Framework.get.screen(screen).element(element).send(method)
   if negative
-    refute_equal expected_value, actual_value
+    expect(expected_value).not_to eq(actual_value)
   else
-    assert_equal expected_value, actual_value
+    expect(expected_value).to eq(actual_value)
   end
 end