appom 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dfe63bdf19bf6f40316e2936d3999a4b38c318fea12b9c6c4da67349ac0e5d5
-  data.tar.gz: 0fd90a46359d87728ef19c10369710a47957ce23773e7b850531e9751a5656c9
+  metadata.gz: a2f17ca36a2cd4e5621ecf4f2d2d842f229494df5cb2ca7629fb02faba05115f
+  data.tar.gz: 646ba303457e66fd2517b45100efac3e15bd97d1fd3ced1d7bc9cccccdacc4aa
 SHA512:
-  metadata.gz: 257d602e52213df6d7cf4bc87c8b40aa97926047bfa0af025f226c68c215a8261cf6e8e6327de02c12ddec8acf14b8b5455e6daa4197156cb2c5c7c91c4236fc
-  data.tar.gz: d8ddb29f6881a3e9ab4204917642f36f2767359f77e614fe43785c36e24bd8cef8331500edc0c8c8f2f669cf97f1527485d918b4bbba102740f3c808032fe71c
+  metadata.gz: aad052c0abe308b033616d60e94598c500d2eebba065677a49ac59fe170227305fea83f7a918c3be2f7265fec82fed4920c5257de92057cf36d759ddc1564540
+  data.tar.gz: 50b469a37d97e15f9a001b7e9cda5c7e5ea7a37598b7667259bbac93d6c9cdee999c6e5584fccf7afd4e57514bba6194f6e19ce9fdf2c699ee01b489cc8c4fc4

data/README.md

@@ -45,6 +45,12 @@ end
 ```
 `appium_lib_options` and `caps` are options to initiate a appium driver. You can follow [Appium Ruby Client](https://github.com/appium/ruby_lib)
 
+### Change default max wait time
+```ruby
+Appom.configure do |config|
+  config.max_wait_time = 30
+end
+```
 
 ### Define a page
 ```ruby
@@ -55,6 +61,9 @@ class LoginPage < Appom::Page
 end
 ```
 
+The Appom Wiki has lots of additional information about Appom. Please browse the Wiki after finishing this README:
+https://github.com/hoangtaiki/appom/wiki
+
 ## Example
 [authentication-appom-appium](https://github.com/hoangtaiki/authentication-appom-appium) is an example about using Appom with Appium. 
 

data/lib/appom.rb

@@ -5,16 +5,28 @@ require 'appium_lib'
 require 'appom/cucumber'
 
 module Appom
-  # A item was defined without a selector
+  # A item was defined without a selector.
   class InvalidElementError < StandardError; end
-  # A block was passed to the method, which it cannot interpret
+  # A block was passed to the method, which it cannot interpreter.
   class UnsupportedBlockError < StandardError; end
+  # The condition that was being evaluated inside the block did not evaluate
+  # to true within the time limit.
+  class TimeoutError < StandardError; end
+  # An element could not be located on the page using the given search parameters.
+  class NoSuchElementError < StandardError; end
 
   autoload :ElementContainer, 'appom/element_container'
   autoload :Page, 'appom/page'
+  autoload :Wait, 'appom/wait'
 
   class << self
     attr_accessor :driver
+    attr_accessor :max_wait_time
+
+    # Configure appom
+    def configure
+      yield self
+    end
 
     # Register a new appium driver for Appom.
     # @return [Appium::Driver] A appium driver instance
@@ -41,6 +53,8 @@ module Appom
       end
     end
   end
+
+  @max_wait_time = 20
 end
 
 World(Appom)

data/lib/appom/element_container.rb

@@ -36,7 +36,7 @@ module Appom
       #     element :email, :accessibility_id, 'email_text_field'
       #
       # @param name             Element name
-      # @param *find_args       An array contain information to find the element. It contains locator stratery and search target
+      # @param *find_args       An array contain information to find the element. It contains locator strategy and search target
       # http://appium.io/docs/en/commands/element/find-element/
       #
       # Element doesn't support block so that will raise if pass a block when declare
@@ -57,7 +57,7 @@ module Appom
       #     elements :contact_cell, :accessibility_id, 'contact_cell'
       #
       # @param name             Element name
-      # @param *find_args       An array contain information to find the elements. It contains locator stratery and search target
+      # @param *find_args       An array contain information to find the elements. It contains locator strategy and search target
       # http://appium.io/docs/en/commands/element/find-element/
       #
       # Elements doesn't support block so that will raise if pass a block when declare
@@ -83,7 +83,7 @@ module Appom
 
       private
 
-      # Add item to @mapped_items or define mothod to notify that we can't find item without args
+      # Add item to @mapped_items or define method to notify that we can't find item without args
       def build(name, *find_args)
         if find_args.empty?
           create_error_method(name)
@@ -91,14 +91,72 @@ module Appom
           add_to_mapped_items(name)
           yield
         end
+        add_helper_methods(name, *find_args)
       end
 
-      # Define mothod to notify that we can't find item without args
+      # Define method to notify that we can't find item without args
       def create_error_method(name)
         define_method(name) do
           raise Appom::InvalidElementError
         end
       end
+
+      def add_helper_methods(name, *find_args)
+        create_existence_checker(name, *find_args)
+        create_nonexistence_checker(name, *find_args)
+        create_get_all_elements(name, *find_args)
+      end
+
+      def create_helper_method(proposed_method_name, *find_args)
+        if find_args.empty?
+          create_error_method(proposed_method_name)
+        else
+          yield
+        end
+      end
+
+      ##
+      # Check element exist
+      # We will try to find all elements with *find_args
+      # Condition is pass when response is not empty
+      #
+      def create_existence_checker(element_name, *find_args)
+        method_name = "has_#{element_name}?"
+        create_helper_method(method_name, *find_args) do
+          define_method(method_name) do |*runtime_args|
+            args = merge_args(find_args, runtime_args)
+            wait_check_util_not_empty(*args)
+          end
+        end
+      end
+
+      ##
+      # Check element non-existent
+      # We will try to find all elements with *find_args
+      # Condition is pass when response is empty
+      #
+      def create_nonexistence_checker(element_name, *find_args)
+        method_name = "has_no_#{element_name}?"
+        create_helper_method(method_name, *find_args) do
+          define_method(method_name) do |*runtime_args|
+            args = merge_args(find_args, runtime_args)
+            wait_check_util_empty(*args)
+          end
+        end
+      end
+
+      ##
+      # Try to get all elements until not get empty array
+      #
+      def create_get_all_elements(element_name, *find_args)
+        method_name = "get_all_#{element_name}"
+        create_helper_method(method_name, *find_args) do
+          define_method(method_name) do |*runtime_args|
+            args = merge_args(find_args, runtime_args)
+            wait_check_util_empty(*args)
+          end
+        end
+      end
     end
   end
 end

data/lib/appom/page.rb

@@ -5,12 +5,52 @@ module Appom
 
     # Find an element
     def find(*find_args)
-      Appom.driver.find_element(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until { Appom.driver.find_element(*find_args) }
     end
 
     # Find elements
     def all(*find_args)
       Appom.driver.find_elements(*find_args)
     end
+
+    ##
+    # Use wait to check element non-exist
+    # Before timeout we will try to find elements and check response is empty
+    #
+    def wait_check_util_empty(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until do
+        Appom.driver.find_elements(*find_args).empty?
+      end
+    end
+
+    ##
+    # Use wait to check element exist
+    # Before timeout we will try to find elements and check response is not empty
+    #
+    def wait_check_util_not_empty(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until do
+        !Appom.driver.find_elements(*find_args).empty?
+      end
+    end
+
+    ##
+    # Use wait to get elements
+    # Before timeout we will try to find elements until response is not empty
+    #
+    def wait_util_get_not_empty(*find_args)
+      wait = Wait.new(timeout: Appom.max_wait_time)
+      wait.until do
+        result = Appom.driver.find_elements(*find_args)
+        # If reponse is empty we will return false to make it not pass Wait condition
+        if result.empty?
+          return false
+        end
+        # Return result
+        return result
+      end
+    end
   end
-end
+end

data/lib/appom/version.rb

@@ -1,3 +1,3 @@
 module Appom
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/appom/wait.rb

@@ -0,0 +1,40 @@
+module Appom
+  class Wait
+    DEFAULT_TIMEOUT  = 5
+    DEFAULT_INTERVAL = 0.25
+
+    ##
+    # Create a new Wait instance
+    #
+    # @param [Hash] opts Options for this instance
+    # @option opts [Numeric] :timeout (5) Seconds to wait before timing out.
+    # @option opts [Numeric] :interval (0.25) Seconds to sleep between polls.
+    #
+    def initialize(opts = {})
+      @timeout  = opts.fetch(:timeout, DEFAULT_TIMEOUT)
+      @interval = opts.fetch(:interval, DEFAULT_INTERVAL)
+    end
+
+    ##
+    # Wait until the given block returns a true value.
+    #
+    # @raise [Error::TimeOutError]
+    # @return [Object] the result of the block
+    #
+    def until
+      end_time = Time.now + @timeout
+
+      until Time.now > end_time
+        begin
+          result = yield
+          return result if result
+        rescue
+        end
+
+        sleep @interval
+      end
+
+      raise Appom::TimeoutError, "Timed out after #{@timeout}s."
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appom
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Harry.Tran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib
@@ -67,6 +67,7 @@ files:
 - lib/appom/element_container.rb
 - lib/appom/page.rb
 - lib/appom/version.rb
+- lib/appom/wait.rb
 homepage: https://github.com/hoangtaiki/appom
 licenses:
 - MIT