chemlab 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22938ab6275dea5d261c7499696a054b8858d978ca599894cbf38f21c38760eb
-  data.tar.gz: 839a5a65657bdd878de6b3a77f2ee76299f046e64dc916d9c38b04b6b3864c55
+  metadata.gz: c09a8e6e3c407893b4df27fadd71ffff047f3ea3df27b34a1ad7f1c0b8119de9
+  data.tar.gz: c79979483ff6d8dc48716c3d6be27e683117bba9c346b925e6b7013e0d616238
 SHA512:
-  metadata.gz: d9b1e6d51ecfe17edc783f3d02897dfc19339e84f45b4ff4c2228224ef0857ee7668e53d6762aa9282fbb943bcd38339308effb5221e1b29a46be3fc6ecf9aae
-  data.tar.gz: 572de2ab4941bbe65c49817f4da6d818d811f643ab2a7899294eb2d8a137442c78aa11b47833d91183bf211a279c8ce457c15a17c92204e838791c351be0808b
+  metadata.gz: 96fc1f354f2b5568362c01688d265be896ca238f24819f075f1d16aa6b4f43c7b9cacf72662cd110d46dda4ee2bf6448b6a870927f9f1c9d2847fafa53949130
+  data.tar.gz: f1aa2b1677db2f65e134db511b4741fc4a8977c1d0098c1f5eb1f246a6107ab45576df778b93117b93b617e94234a481a4ebd58d5c4fa7417b505e4002cbbecd

data/lib/chemlab/attributable.rb

@@ -17,6 +17,8 @@ module Chemlab
           default_value = nil
           default_value = yield if block_given?
 
+          attr_writer name
+
           define_method(name) do
             instance_variable_get("@#{name}") ||
               instance_variable_set(

data/lib/chemlab/component.rb

@@ -46,18 +46,18 @@ module Chemlab
           public_elements << { type: watir_method, name: name, args: args }
 
           # @return [Watir::Element] the raw Watir element
-          define_method("#{name}_element") do
-            find_element(watir_method, name, args.first, &block)
+          define_method("#{name}_element") do |**find_args|
+            find_element(watir_method, name, args.first, **find_args, &block)
           end
 
           # @return [Boolean] true if the element is present
-          define_method("#{name}?") do
-            public_send("#{name}_element").present?
+          define_method("#{name}?") do |wait: nil, wait_until: nil|
+            public_send("#{name}_element", wait: wait, wait_until: wait_until).present?
           end
 
           # === GETTER / CLICKER === #
-          define_method(name) do
-            element = public_send("#{name}_element")
+          define_method(name) do |wait: nil, wait_until: :exists?|
+            element = public_send("#{name}_element", wait: wait, wait_until: wait_until)
             if Element::CLICKABLES.include? watir_method
               element.wait_until(&:present?).click
             elsif Element::INPUTS.include? watir_method
@@ -132,12 +132,59 @@ module Chemlab
     # @api private
     # @example
     #   #find_element(:text_field, :username) #=>
-    def find_element(watir_method, name, locator = nil, &block)
+    def find_element(watir_method, name, locator = nil, **args, &block)
       locator = { css: %([data-qa-selector="#{name}"]) } if locator.nil?
 
+      # extract extraneous arguments from the locator and insert them into args
+      chemlab_options, locator = extract_chemlab_options(locator)
+      args.merge!(chemlab_options)
+
+      old_timeout = Chemlab.configuration.default_timeout
+      args[:wait] ||= old_timeout
+
       return instance_exec(&block) if block_given?
 
-      Chemlab.configuration.browser.session.engine.public_send(watir_method, locator).wait_until(&:exist?)
+      element = Chemlab.configuration.browser.session.engine.public_send(watir_method, locator)
+
+      return element if args[:wait_until].nil?
+
+      begin
+        # change timeout temporarily to the wait specified
+        change_timeout(args[:wait])
+
+        # perform wait(s) on the element
+        element.wait_until do |conditions|
+          break conditions.public_send(args[:wait_until]) unless args[:wait_until].respond_to?(:each)
+
+          args[:wait_until].each { |condition| conditions.public_send(condition) }
+        end
+
+        element
+      ensure
+        # reset timeout
+        change_timeout(old_timeout)
+      end
+    end
+
+    # Extract Chemlab specific options from an array
+    # @param [Array<Hash>] args given arguments
+    # @return [Array<Array<Hash>>] first array returned are the chemlab options, second is the resulting array
+    # @example
+    #   arr = { id: 'test', foo: 'bar', wait: 10 }
+    #   a, b = extract_chemlab_options!(**arr)
+    #   a #=> { wait: 10 }
+    #   b #=> { id: 'test', foo: 'bar' }
+    def extract_chemlab_options(**args)
+      [args.keys.each_with_object({}) do |arg, chemlab_opts|
+        chemlab_opts[arg] = args.delete(arg) if %i[wait wait_until].include?(arg)
+      end, args]
+    end
+
+    # Set / Reset default Chemlab timeout
+    # @param [Integer] timeout the timeout to set (defaults to +Chemlab.configuration.default_timeout)
+    # @return [Integer] the new timeout
+    def change_timeout(timeout = Chemlab.configuration.default_timeout)
+      Chemlab.configuration.default_timeout = timeout
     end
 
     protected

data/lib/chemlab/configuration.rb

@@ -4,6 +4,8 @@ module Chemlab
   # Chemlab Configuration
   class Configuration
     include Runtime::Logger
+    include Attributable
+    extend Forwardable
 
     # Chemlab Terminal Banner
     BANNER = <<~'BANNER'
@@ -59,13 +61,13 @@ module Chemlab
       CONF
     end
 
-    # Add a chemlab configuration
-    def self.add_config(name)
-      attr_accessor name
-    end
+    attribute :base_url
+    attribute :hide_banner
 
-    add_config :base_url
-    add_config :hide_banner
+    # Delegate `default_timeout` to Watir.default_timeout
+    # Chemlab.configuration.default_timeout #=> Watir.default_timeout
+    # Chemlab.configuration.default_timeout = Watir.default_timeout = 30
+    def_delegators Watir, :default_timeout, :default_timeout=
 
     attr_reader :browser, :libraries
 

data/lib/chemlab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chemlab
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chemlab
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control