chemlab 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b138dd1ea82aa663333b42dcdaa00efbba338a929d7f2fb1789aa864094747
-  data.tar.gz: b35c1771c8ceb822ed8e948b6e1d5c40b9a89b39bfede2f9c36348ca20bbcc2e
+  metadata.gz: b8768461aba3f55a80a1ef51e13b894d8f876343abb1a402c7de72e4fbfa4a9e
+  data.tar.gz: a3a48670a730d1d873ce671d94de87198478e54bfa2f29665aa2c05bf686f328
 SHA512:
-  metadata.gz: 417cd502e6da022cb8e6e4fbacc061bd6191c363fce8c7c6a47d910d9d9b315bde7de3fa99802455a8fbb73fe2017a5bf11164be1b597a0bf232322a4919f032
-  data.tar.gz: 5a4272aaf6b7d431660cb595432260e59bc3b83d1078acdbb08039d8c96441f748f8fad1716ab3f3b052790c6e711419362ae4bc7eedd499ace4cd53defe3b6c
+  metadata.gz: 9f6b5cd6c624455c9204da1815b891f65a97725309acf4157b280df795c56f072aa905ae3d48c75a3c42c7414bee7a3408d379dcfdbbc406eb1d849f6c4da3ed
+  data.tar.gz: 5cc500d4395d6470dc19cb4e250721d600d34e2f0f561410de26437490cf83d2529122c19d7da64ed7f17fd135f3fbfd93cfd01e90a253faae8b54956a7b2092

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)
+          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.3'
+  VERSION = '0.8.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.3
+  version: 0.8.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2021-09-15 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