automation_object 0.5.0 → 0.5.1

data/lib/automation_object/step_definitions/element_array.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+require_relative 'support/parse'
+require_relative 'support/element_array'
+
+# Description: Provides step definitions related to element arrays
+
+# For: Calling an element array method
+# Examples:
+# - I click on the first "home_screen" "about_button" element array
+# - I hover over all "home_screen" "about_button" element array
+# - I click on 0..9 "home_screen" "about_button" element array
+# - I click on a random "home_screen" "about_button" element array
+When(%r(^I (\w+|%\{[\w\d]+\})?(?: on| over)?(?: the| a)? (%\{[\w\d]+\}|all|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element array$/)) do |*args|
+  method, key, low_range, high_range, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementArray.iterate_and_do(
+    screen, element, key, low_range, high_range
+  ) do |sub_element|
+    sub_element.send(method)
+  end
+end
+
+# For: Typing into element array field
+# Examples:
+# - I type "blah" into the first "home_screen" "text_field" element array
+When(%r(^I type "([\w\s]+|%\{[\w\d]+\})" in(?:to| to)? (?:the )?(%\{[\w\d]+\}|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element array$/)) do |*args|
+  text, key, low_range, high_range, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementArray.iterate_and_do(
+    screen, element, key, low_range, high_range
+  ) do |sub_element|
+    sub_element.send_keys(text)
+  end
+end
+
+# For: Scrolling element array item(s) into focus
+# Examples:
+# - I scroll to the first "home_screen" "logo_button" element array
+When(%r(^I (?:scroll |focus )(?:to |through )(?:the )?(%\{[\w\d]+\}|all|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element array$/)) do |*args|
+  key, low_range, high_range, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementArray.iterate_and_do(
+    screen, element, key, low_range, high_range, &:scroll_into_view
+  )
+end
+
+# For: Saving value from element array for use later
+# Examples:
+# - I save "text" as "unique_value" from the first "home_screen" "logo_button" element array
+When(%r(^I save "(\w+|%\{[\w\d]+\})" as "([\w\d]+)" from (?:the )?(%\{[\w\d]+\}|all|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element array$/)) do |*args|
+  method, value_key, key, low_range, high_range, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementArray.iterate_and_do(
+    screen, element, key, low_range, high_range
+  ) do |sub_element|
+    value = sub_element.send(method)
+    AutomationObject::StepDefinitions::Cache.set(value_key, value)
+  end
+end
+
+# For: Testing the element arrays size
+# Examples:
+# - the "home_screen" "title" element array should be greater than 0
+Then(%r(^(?:the )?"([\w\d]+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element array should(n't|not)? (?:be )?(larger th[ae]n|greater th[ae]n|less th[ae]n|smaller th[ae]n|equals?) (?:to )?(\d+)$/)) do |*args|
+  screen, element, negative, comparison, expected_value = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  element_array = AutomationObject::Framework.get.send(screen).send(element)
+  assert element_array.is_a?(Array)
+
+  if comparison =~ /larger th[ae]n|greater th[ae]n/
+    if negative
+      refute expected_value < element_array.length
+    else
+      assert expected_value < element_array.length
+    end
+  elsif comparison =~ /smaller th[ae]n|less th[ae]n/
+    if negative
+      refute expected_value > element_array.length
+    else
+      assert expected_value > element_array.length
+    end
+  elsif comparison =~ /equals?/
+    if negative
+      refute_equals expected_value, element_array.length
+    else
+      assert_equals expected_value, element_array.length
+    end
+  end
+end
+
+# For: Testing if the element method value equals a given value
+# Examples:
+# - the first "home_screen" "title" element array "text" should equal "Home"
+# - the last "home_screen" "title" element array "text" shouldn't equal "Home"
+# - the random "home_screen" "title" element array "text" should not equal "Home"
+# - the 0..9 "home_screen" "title" element array "text" should equal "Home"
+# - the all "home_screen" "title" element array "text" should not equal "Home"
+Then(%r(^(?:the )?(%\{\w+\}|all|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element array "(\w+|%\{[\w\d]+\})" should?(n't| not)? equal "(\w+|%\{[\w\d]+\})"$/)) do |*args|
+  key, low_range, high_range, screen, element, method, negative, expected_value = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementArray.iterate_and_do(
+    screen, element, key, low_range, high_range
+  ) do |sub_element|
+    value = sub_element.send(method)
+
+    if negative
+      refute_equals expected_value, value
+    else
+      assert_equals expected_value, value
+    end
+  end
+end
+
+# For: Testing if the element arrays uniqueness
+# Examples:
+# - the "home_screen" "title" element array "text" should be unique
+# - the "home_screen" "title" element array "text" should not be unique
+# - the "home_screen" "title" element array "text" shouldn't be unique
+Then(%r(^(?:the )?"([\w\d]+|%\{[\w\d]+\})" "([\w\d]+|%\{[\w\d]+\})" element array "([\w\d]+|%\{[\w\d]+\})" should(n't| not)? be unique$/)) do |*args|
+  screen, element, method, negative = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  element_array = AutomationObject::Framework.get.send(screen).send(element)
+  assert element_array.is_a?(Array)
+
+  values = []
+  element_array.each do |sub_element|
+    values.push(sub_element.send(method))
+  end
+
+  if negative
+    refute_equals values.uniq, values
+  else
+    assert_equals values.uniq, values
+  end
+end

data/lib/automation_object/step_definitions/element_hash.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+require_relative 'support/parse'
+require_relative 'support/element_hash'
+
+# Description: Provides step definitions related to element hashes
+
+# For: Calling an element hash method
+# Examples:
+# - I click on the first "home_screen" "about_button" element hash
+When(%r(^I (\w+|%\{[\w\d]+\})?(?: on| over)?(?: the| a)? (%\{[\w\d]+\}|all|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element hash/)) do |*args|
+  method, key, low_range, high_range, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementHash.iterate_and_do(
+    screen, element, key, low_range, high_range
+  ) do |sub_element|
+    sub_element.send(method)
+  end
+end
+
+# For: Typing into element hash field
+# Examples:
+# - I type "blah" into the first "home_screen" "text_field" element hash
+When(%r(^I type "([\w\s]+|%\{[\w\d]+\})" in(?:to| to)? (?:the )?(%\{[\w\d]+\}|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element hash/)) do |*args|
+  text, key, low_range, high_range, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementHash.iterate_and_do(
+    screen, element, key, low_range, high_range
+  ) do |sub_element|
+    sub_element.send_keys(text)
+  end
+end
+
+# For: Scrolling element hash item(s) into focus
+# Examples:
+# - I scroll to the first "home_screen" "logo_button" element hash
+When(%r(^I (?:scroll |focus )(?:to |through )(?:the )?(%\{[\w\d]+\}|all|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element hash/)) do |*args|
+  key, low_range, high_range, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementHash.iterate_and_do(
+    screen, element, key, low_range, high_range, &:scroll_into_view
+  )
+end
+
+# For: Saving value from element hash for use later
+# Examples:
+# - I save "text" as "unique_value" from the first "home_screen" "logo_button" element hash
+When(%r(^I save "(\w+|%\{[\w\d]+\})" as "([\w\d]+)" from (?:the )?(%\{[\w\d]+\}|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element hash/)) do |*args|
+  method, value_key, key, low_range, high_range, screen, element = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementHash.iterate_and_do(
+    screen, element, key, low_range, high_range
+  ) do |sub_element|
+    value = sub_element.send(method)
+    AutomationObject::StepDefinitions::Cache.set(value_key, value)
+  end
+end
+
+# For: Testing the element hashes size
+# Examples:
+# - the "home_screen" "title" element hash should be greater than 0
+Then(%r(^(?:the )?"([\w\d]+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element hash should(n't|not)? (?:be )?(larger th[ae]n|greater th[ae]n|less th[ae]n|smaller th[ae]n|equals?) (?:to )?(\d+)$/)) do |*args|
+  screen, element, negative, comparison, expected_value = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  element_hash = AutomationObject::Framework.get.send(screen).send(element)
+  assert element_hash.is_a?(Hash)
+
+  if comparison =~ /larger th[ae]n|greater th[ae]n/
+    if negative
+      refute expected_value < element_hash.keys.length
+    else
+      assert expected_value < element_hash.keys.length
+    end
+  elsif comparison =~ /smaller th[ae]n|less th[ae]n/
+    if negative
+      refute expected_value > element_hash.keys.length
+    else
+      assert expected_value > element_hash.keys.length
+    end
+  elsif comparison =~ /equals?/
+    if negative
+      refute_equals expected_value, element_hash.keys.length
+    else
+      assert_equals expected_value, element_hash.keys.length
+    end
+  end
+end
+
+# For: Testing if the element hash value equals a given value
+# Examples:
+# - the first "home_screen" "title" element hash "text" should equal "Home"
+Then(%r(^(?:the )?(%\{\w+\}|random|last|first|(\d+)\.\.(\d+)) "(\w+|%\{[\w\d]+\})" "(\w+|%\{[\w\d]+\})" element hash "(\w+|%\{[\w\d]+\})" should ?(n't |not )?equal "(\w+|%\{[\w\d]+\})"$/)) do |*args|
+  key, low_range, high_range, screen, element, method, negative, expected_value = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  AutomationObject::StepDefinitions::ElementHash.iterate_and_do(
+    screen, element, key, low_range, high_range
+  ) do |sub_element|
+    value = sub_element.send(method)
+
+    if negative
+      refute_equals expected_value, value
+    else
+      assert_equals expected_value, value
+    end
+  end
+end
+
+# For: Testing if the element hashes uniqueness
+# Examples:
+# - the "home_screen" "title" element hash "text" should be unique
+Then(%r(^(?:the )?"([\w\d]+|%\{[\w\d]+\})" "([\w\d]+|%\{[\w\d]+\})" element hash "([\w\d]+|%\{[\w\d]+\})" should(n't|not)? be unique$/)) do |*args|
+  screen, element, method, negative = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  element_hash = AutomationObject::Framework.get.send(screen).send(element)
+  assert element_hash.is_a?(Hash)
+
+  values = []
+  element_hash.each_value do |sub_element|
+    values.push(sub_element.send(method))
+  end
+
+  if negative
+    refute_equals values.uniq, values
+  else
+    assert_equals values.uniq, values
+  end
+end

data/lib/automation_object/step_definitions/screen.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require_relative 'support/parse'
+
+# Description: Provides step definitions related to screens
+
+# For: Close the current screen or given screen
+# Examples:
+# - I close the "contact" screen
+# - I close the screen
+# - I destroy the screen
+Then(%r(^I (?:close|destroy) the ("([\w\s]+|%\{[\w\d]+\})")? ?screen$/)) do |*args|
+  _unparsed_name, name = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  if name
+    AutomationObject::Framework.get.screen(name).close
+  else
+    AutomationObject::Framework.get.current_screen.close
+  end
+end
+
+# For: Navigating back on a given or current screen
+# Examples:
+# - I navigate back on the screen
+# - I navigate back on the "contact" screen
+Then(%r(^I (?:navigate|go) back (?:on )?(?:the )?("([\w\s]+|%\{[\w\d]+\})")? ?screen$/)) do
+  _unparsed_name, name = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  if name
+    AutomationObject::Framework.get.screen(name).back
+  else
+    AutomationObject::Framework.get.current_screen.back
+  end
+end
+
+# For: Switch/Focus screen
+# Examples:
+# - I switch to the "home" screen
+# - I focus the "contact" screen
+Then(%r(^I (?:switch|focus) (?:to )?(?:the )?"([\w\s]+|%\{[\w\d]+\})" screen$/)) do |*args|
+  screen = AutomationObject::StepDefinitions::Parse.new(args).get
+  AutomationObject::Framework.get.focus(screen)
+end
+
+# For: Setting the current screen's width or given screen
+# Examples:
+# - I set the screen size to 1000x2000
+# - I set the "home" screen size to 1000x2000
+# - I set the screen width to 1000
+# - I set the screen height to 2000
+Then(%r(^I set the ("([\w\s]+|%\{[\w\d]+\})")? ?screen (size|width|height) to (\d+|(\d+)x(\d+))$/)) do |*args|
+  _unparsed_screen, screen, dimension, size, width, height = AutomationObject::StepDefinitions::Parse.new(args).get
+
+  screen = if screen
+             AutomationObject::Framework.get.screen(screen)
+           else
+             AutomationObject::Framework.get.current_screen
+           end
+
+  screen.size(width.to_i, height.to_i) if width && height
+  screen.width(size) if dimension == 'width' && size
+  screen.height(size) if dimension == 'height' && size
+end

data/lib/automation_object/step_definitions/{cache.rb → support/cache.rb}

@@ -1,10 +1,12 @@
-#Class for caching values between steps
+# frozen_string_literal: true
+# Class for caching values between steps
 module AutomationObject
   module StepDefinitions
+    # Cache module for temporary storage of vars
     module Cache
-      extend self
+      module_function
 
-      #Singleton hash, create new if needed
+      # Singleton hash, create new if needed
       # @return [Hash] hash of values saved or new hash
       def values
         return @values if @values
@@ -12,12 +14,12 @@ module AutomationObject
       end
 
       def get(key)
-        return self.values[key]
+        values[key]
       end
 
       def set(key, value)
-        self.values[key] = value
+        values[key] = value
       end
     end
   end
-end
+end

data/lib/automation_object/step_definitions/support/element_array.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module AutomationObject
+  module StepDefinitions
+    # Element array module for iterating through an array
+    module ElementArray
+      module_function
+
+      def iterate_and_do(screen, element, key, low_range, high_range)
+        element_array = AutomationObject::Framework.get.send(screen).send(element)
+        assert element_array.is_a?(Array)
+
+        return range(element_array, low_range, high_range) if low_range && high_range
+
+        case key
+        when 'all'
+          element_array.each do |sub_element|
+            yield sub_element
+          end
+        when 'random'
+          yield element_array[rand(0..(element_array.length - 1))]
+        when 'first'
+          yield element_array[0]
+        when 'last'
+          yield element_array[element_array.length - 1]
+        else
+          yield element_array[key.to_i]
+        end
+      end
+
+      private
+
+      def range(element_array, low_range, high_range)
+        low_range.to_i..high_range.to_i.each do |i|
+          assert element_array.length > i
+          yield element_array[i]
+        end
+      end
+    end
+  end
+end

data/lib/automation_object/step_definitions/support/element_hash.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module AutomationObject
+  module StepDefinitions
+    # Element hash module for iterating through an hash
+    module ElementHash
+      module_function
+
+      def iterate_and_do(screen, element, key, low_range, high_range)
+        element_hash = AutomationObject::Framework.get.send(screen).send(element)
+        assert element_hash.is_a?(Hash)
+
+        return range(element_hash, low_range, high_range) if low_range && high_range
+
+        case key
+        when 'all'
+          element_hash.each_value do |sub_element|
+            yield sub_element
+          end
+        when 'random'
+          yield element_hash[element_hash.keys[rand(0..(element_hash.keys.length - 1))]]
+        when 'first'
+          yield element_hash[element_hash.keys[0]]
+        when 'last'
+          yield element_hash[element_hash.keys[element_hash.keys.length - 1]]
+        else
+          yield element_hash[key.to_s]
+        end
+      end
+
+      private
+
+      def range(element_hash, low_range, high_range)
+        low_range.to_i..high_range.to_i.each do |i|
+          assert element_hash.keys.length > i
+
+          block.call element_hash[element_hash.keys[i]]
+        end
+      end
+    end
+  end
+end

data/lib/automation_object/step_definitions/{parse.rb → support/parse.rb}

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 require_relative 'cache'
 
 module AutomationObject
   module StepDefinitions
+    # Class to parse arguments passed through step definitions
     class Parse
       # @param args [Array] input args from step definition
       def initialize(args)
@@ -10,11 +12,11 @@ module AutomationObject
 
       def get
         parsed_args = []
-        for arg in @args
+        @args.each do |arg|
           parsed_args.push(parse(arg))
         end
 
-        return parsed_args
+        parsed_args
       end
 
       private
@@ -25,15 +27,15 @@ module AutomationObject
       def parse(string)
         parsed_string = string
 
-        string.scan(/%\{(\w+)\}/) { |cache_key|
+        string.scan(/%\{(\w+)\}/) do |cache_key|
           cached_value = AutomationObject::StepDefinitions::Cache.get(cache_key)
           next unless cached_value
 
           parsed_string.gsub("%{#{cache_key}}", cached_value)
-        }
+        end
 
-        return parsed_string
+        parsed_string
       end
     end
   end
-end
+end