chemlab 0.8.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8768461aba3f55a80a1ef51e13b894d8f876343abb1a402c7de72e4fbfa4a9e
-  data.tar.gz: a3a48670a730d1d873ce671d94de87198478e54bfa2f29665aa2c05bf686f328
+  metadata.gz: 5511ef5fd5d6d4aba05a6ad59ba41d25d75c019b5314a2b079feada7cba946db
+  data.tar.gz: 9bbfbf9bf30ddd61c2f6caf5ede340be131217c2cf3e8e0db462abcad21b30c6
 SHA512:
-  metadata.gz: 9f6b5cd6c624455c9204da1815b891f65a97725309acf4157b280df795c56f072aa905ae3d48c75a3c42c7414bee7a3408d379dcfdbbc406eb1d849f6c4da3ed
-  data.tar.gz: 5cc500d4395d6470dc19cb4e250721d600d34e2f0f561410de26437490cf83d2529122c19d7da64ed7f17fd135f3fbfd93cfd01e90a253faae8b54956a7b2092
+  metadata.gz: 88ade200b47c7f01db6a4ca215da19a3c877cc9aede859ece778591f039d597def1f2d986146677ec5143d9e1df585ac23b3627e9f6dc06de1bab0061cb3f47e
+  data.tar.gz: f1b87c97400fee349d7eac0e94576eaec15ccc9694e0a92826e02865e79135f6a812b9dce3491961fa4fdcf2f1d9fd1a43621e10aacf73881875176ca6dda25c

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/runtime/browser.rb

@@ -45,29 +45,21 @@ module Chemlab
       #
       #   Chemlab::Runtime::Browser.navigate_to(ThePage) #=> Navigates to https://example.com/path
       def self.navigate_to(page_class)
-        unless page_class&.name.respond_to?(:root_module)
+        unless page_class&.name.respond_to?(:root_module) && page_class.name.root_module.respond_to?(:base_url)
           return Chemlab.configuration.browser.navigate_to(Chemlab.configuration.base_url + page_class.path)
         end
 
-        # workaround for file:// protocol.  URI.join() does not work with URI.join('file:///Users', '/user')
-        uri = if URI(page_class.name.root_module.base_url).scheme == 'file'
-                URI(File.join(page_class.name.root_module.base_url, page_class.path))
-              else
-                URI.join(page_class.name.root_module.base_url, page_class.path)
-              end
-
-        Chemlab.configuration.browser.navigate_to(uri)
+        Chemlab.configuration.browser.navigate_to(File.join(page_class.name.root_module.base_url, page_class.path))
       end
 
-      # Navigate to a URI or Path
-      # @param [URI,String] uri_or_path the URI or path
-      # @return [URI,String] the URI or Path that was navigated to
+      # Navigate to a Path
+      # @param [String] path the path to navigate to, relative to the +base_url+
+      # @return [String] the path that was navigated to
       # @example
       #   Chemlab.configuration.browser.navigate_to('/path') #=> /path
-      #   Chemlab.configuration.browser.navigate_to(URI('https://example.com/path')) #=> URI('https://example.com/path')
-      def navigate_to(uri_or_path)
+      def navigate_to(path)
         @session ||= Chemlab.configuration.browser.session
-        @session.engine.goto(uri_or_path.to_s)
+        @session.engine.goto(path.to_s)
       end
 
       # The options used to create the browser session

data/lib/chemlab/version.rb

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

metadata

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