chemlab 0.7.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d84958e53d93ed46c4a4f93d1c236ae724b7f328ed010b0432ceef6c1ba23d21
-  data.tar.gz: 78df858369ff4a789f328bfb75f6ef550a594456b2ab57b0dcf44dd294c2772e
+  metadata.gz: c09a8e6e3c407893b4df27fadd71ffff047f3ea3df27b34a1ad7f1c0b8119de9
+  data.tar.gz: c79979483ff6d8dc48716c3d6be27e683117bba9c346b925e6b7013e0d616238
 SHA512:
-  metadata.gz: 2da525ce9135405cf917410515943d1542db46c4270f25ec5bbaa910b93f1d7a4fac83c8defa51ec9513e826c681bb22db2bd8721fe4561584d5588ae6019a02
-  data.tar.gz: 99086cec60d34d42b25ea7415fdf464259e4742085d77e438fe9553692a176e4d5ad819f466c25e3c07841adeb4d17f1cff2a1f78d23f72632ab5dc1c395207f
+  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/core_ext/string/root_module.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Start monkey patch of String
+class String
+  # Find the root module (parent module) of a class or module
+  # @example
+  #   'A::B::C'.root_module #=> A
+  #   'A::B'.root_module => A
+  # @return [Module] the root module
+  def root_module
+    Object.const_get(split('::').first)
+  end
+end

data/lib/chemlab/library.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Chemlab
+  # Application Library Definition
+  # Provides accessors for +:base_url+, +:base_url=+
+  # +base_url+ will default to Chemlab's configured base_url
+  module Library
+    def self.included(base)
+      base.module_eval do
+        class << self
+          # The Base URL where this library / application exists
+          # If you have multiple applications that Chemlab will target,
+          # this is useful for having separate base_urls.
+          #
+          # @return [String] the base_url.  +Chemlab.configuration.base_url+ by default if not set
+          #
+          # @example
+          #   Chemlab.configure do |chemlab|
+          #     A.base_url = 'https://first_app'
+          #     B.base_url = 'https://second_app'
+          #     chemlab.base_url = 'https://main_app'
+          #
+          #     chemlab.libraries = [A, B, C]
+          #
+          #     C.base_url #=> https://main_app
+          #   end
+          attr_writer :base_url
+
+          def base_url
+            @base_url ||= Chemlab.configuration.base_url
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chemlab/runtime/browser.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'chemlab/core_ext/string/root_module'
 
 module Chemlab
   module Runtime
@@ -17,13 +18,56 @@ module Chemlab
         @session = Session.new(browser_options)
       end
 
+      # Navigate to a given Page library
+      # @param [Class<Chemlab::Page>] page_class the class of the Page to navigate to
+      # @example
+      #   Given:
+      #     module TheLibrary
+      #       def self.base_url
+      #         'https://example.com'
+      #       end
+      #       class ThePage < Chemlab::Page
+      #         path '/path'
+      #       end
+      #     end
+      #
+      #   Chemlab::Runtime::Browser.navigate_to(TheLibrary::ThePage) #=> Navigates to https://example.com/path
+      #
+      # @example
+      #   Given:
+      #     Chemlab.configure do |chemlab|
+      #       chemlab.base_url = 'https://example.com'
+      #     end
+      #
+      #     class ThePage < Chemlab::Page
+      #       path '/'
+      #     end
+      #
+      #   Chemlab::Runtime::Browser.navigate_to(ThePage) #=> Navigates to https://example.com/path
       def self.navigate_to(page_class)
-        Chemlab.configuration.browser.navigate_to(page_class.path)
+        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)
       end
 
-      def navigate_to(path)
+      # 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
+      # @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)
         @session ||= Chemlab.configuration.browser.session
-        @session.engine.goto(Chemlab.configuration.base_url + path)
+        @session.engine.goto(uri_or_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.7.2'
+  VERSION = '0.9.0'
 end

data/lib/chemlab.rb

@@ -34,6 +34,7 @@ module Chemlab
   autoload :Element, 'chemlab/element'
   autoload :Component, 'chemlab/component'
   autoload :Page, 'chemlab/page'
+  autoload :Library, 'chemlab/library'
 
   # Runtime modules
   module Runtime

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chemlab
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.9.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -240,7 +240,9 @@ files:
 - lib/chemlab/component.rb
 - lib/chemlab/configuration.rb
 - lib/chemlab/core_ext/string/inflections.rb
+- lib/chemlab/core_ext/string/root_module.rb
 - lib/chemlab/element.rb
+- lib/chemlab/library.rb
 - lib/chemlab/page.rb
 - lib/chemlab/runtime/browser.rb
 - lib/chemlab/runtime/env.rb
@@ -263,7 +265,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="