async-webdriver 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2885f18a964ec45c687168efd25b89326eb2a7cdf30e2458a8d348a6613d22ff
-  data.tar.gz: 58de67040f73f43aa73e2877acab7c7637575721613d63941127bb69a38e3899
+  metadata.gz: bf43f03c5d84881a589b4b8ada0b4b610bd81d7434b42387986c2e62be565748
+  data.tar.gz: eeeda998354a547586c84f796a74062304510e3778011d18e60bead39ffb9d63
 SHA512:
-  metadata.gz: ddfea03fb616984f3f48d2bf6199918119c6750a84e53f012d9d3e3a9c6231508cb911578c19cfd7cd7a88a4fe15965d5a8a8502fd7fc3148af0c8aa409f1fd1
-  data.tar.gz: 7a309bf300d64898d622da707e9fa98e37876cd1752e9ce749b45ed74d0648b7d3f5030d3bad9b123f5bfec468faee57271c45e596af7936868acc34c62fa4b4
+  metadata.gz: 061ec510b866722f3893e549153532e8053a8aa4301316b338fec0bdd0785d00e7b84257969bfd2622581aecedaf59dd08f375577f051fc64c51ab4411b9fbe0
+  data.tar.gz: 73ef488209fcdff4efb657b3c47b61459de197e9303790ed59356e05c6f7553155971b225d2271987da64e7336d5343aa5de4882bf0610c6d435cad369860c86

data/lib/async/webdriver/bridge/chrome.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
 require_relative 'generic'
 require_relative 'process_group'
@@ -71,7 +71,7 @@ module Async
 				# The default capabilities for the Chrome browser which need to be provided when requesting a new session.
 				# @parameter headless [Boolean] Whether to run the browser in headless mode.
 				# @returns [Hash] The default capabilities for the Chrome browser.
-				def default_capabilities(headless: true)
+				def default_capabilities(headless: self.headless?)
 					{
 						alwaysMatch: {
 							browserName: "chrome",

data/lib/async/webdriver/bridge/firefox.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
 require_relative 'generic'
 require_relative 'process_group'
@@ -74,7 +74,7 @@ module Async
 				# The default capabilities for the Firefox browser which need to be provided when requesting a new session.
 				# @parameter headless [Boolean] Whether to run the browser in headless mode.
 				# @returns [Hash] The default capabilities for the Firefox browser.
-				def default_capabilities(headless: true)
+				def default_capabilities(headless: self.headless?)
 					{
 						alwaysMatch: {
 							browserName: "firefox",

data/lib/async/webdriver/bridge/generic.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
 require 'socket'
 require 'async/http/endpoint'
@@ -29,6 +29,10 @@ module Async
 				def supported?
 					version != nil
 				end
+				
+				def headless?
+					@options.fetch(:headless, true)
+				end
 			end
 		end
 	end

data/lib/async/webdriver/bridge/safari.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Samuel Williams.
+
+require_relative 'generic'
+require_relative 'process_group'
+
+module Async
+	module WebDriver
+		module Bridge
+			# A bridge to the Safari browser using `safaridriver`.
+			#
+			# ``` ruby
+			# begin
+			# 	bridge = Async::WebDriver::Bridge::Safari.start
+			# 	client = Async::WebDriver::Client.open(bridge.endpoint)
+			# ensure
+			# 	bridge&.close
+			# end
+			# ```
+			class Safari < Generic
+				def path
+					@options.fetch(:path, "safaridriver")
+				end
+				
+				# @returns [String] The version of the `safaridriver` executable.
+				def version
+					::IO.popen([self.path, "--version"]) do |io|
+						return io.read
+					end
+				rescue Errno::ENOENT
+					return nil
+				end
+				
+				class Driver < Bridge::Driver
+					def initialize(**options)
+						super(**options)
+						@process_group = nil
+					end
+					
+					# @returns [Array(String)] The arguments to pass to the `safaridriver` executable.
+					def arguments(**options)
+						[
+							options.fetch(:path, "safaridriver"),
+							"--port=#{self.port}",
+						].compact
+					end
+					
+					def start
+						@process_group = ProcessGroup.spawn(*arguments(**@options))
+						
+						super
+					end
+					
+					def close
+						if @process_group
+							@process_group.close
+							@process_group = nil
+						end
+						
+						super
+					end
+				end
+				
+				# Start the driver.
+				def start(**options)
+					Driver.new(**options).tap(&:start)
+				end
+				
+				# The default capabilities for the Safari browser which need to be provided when requesting a new session.
+				# @parameter headless [Boolean] Whether to run the browser in headless mode.
+				# @returns [Hash] The default capabilities for the Safari browser.
+				def default_capabilities(headless: self.headless?)
+					{
+						alwaysMatch: {
+							browserName: "safari",
+						},
+					}
+				end
+			end
+		end
+	end
+end

data/lib/async/webdriver/bridge.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
 require_relative 'bridge/chrome'
 require_relative 'bridge/firefox'
+require_relative 'bridge/safari'
 
 require_relative 'error'
 
@@ -17,6 +18,7 @@ module Async
 			ALL = [
 				Bridge::Chrome,
 				Bridge::Firefox,
+				Bridge::Safari,
 			]
 			
 			def self.each(&block)
@@ -36,16 +38,27 @@ module Async
 			# ```
 			ASYNC_WEBDRIVER_BRIDGE = 'ASYNC_WEBDRIVER_BRIDGE'
 			
+			# The environment variable used to disable headless mode.
+			#
+			# ```
+			# ASYNC_WEBDRIVER_BRIDGE_HEADLESS=false
+			# ```
+			ASYNC_WEBDRIVER_BRIDGE_HEADLESS = 'ASYNC_WEBDRIVER_BRIDGE_HEADLESS'
+			
 			class UnsupportedError < Error
 			end
 			
 			# @returns [Bridge] The default bridge to use.
-			def self.default(env = ENV)
+			def self.default(env = ENV, **options)
+				if env[ASYNC_WEBDRIVER_BRIDGE_HEADLESS] == "false"
+					options[:headless] = false
+				end
+				
 				if name = env[ASYNC_WEBDRIVER_BRIDGE]
-					self.const_get(name).new
+					self.const_get(name).mew(**options)
 				else
 					ALL.each do |klass|
-						instance = klass.new
+						instance = klass.new(**options)
 						return instance if instance.supported?
 					end
 					

data/lib/async/webdriver/locator.rb

@@ -3,8 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2023, by Samuel Williams.
 
-require 'base64'
-
 module Async
 	module WebDriver
 		# A locator is used to find elements in the DOM.

data/lib/async/webdriver/scope/elements.rb

@@ -3,8 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2023, by Samuel Williams.
 
-require 'base64'
-
 module Async
 	module WebDriver
 		module Scope

data/lib/async/webdriver/scope/fields.rb

@@ -3,8 +3,6 @@
 # Released under the MIT License.
 # Copyright, 2023, by Samuel Williams.
 
-require 'base64'
-
 require_relative '../xpath'
 
 module Async

data/lib/async/webdriver/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module WebDriver
-		VERSION = "0.4.0"
+		VERSION = "0.6.0"
 	end
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2023, by Samuel Williams.  
+Copyright, 2023-2024, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -18,6 +18,10 @@ Please see the [project documentation](https://socketry.github.io/async-webdrive
 
   - [GitHub Actions Integrations](https://socketry.github.io/async-webdriver/guides/github-actions-integration/index) - This guide explains how to use `async-webdriver` with GitHub Actions.
 
+## See Also
+
+  - [sus-fixtures-async-webdriver](https://github.com/socketry/sus-fixtures-async-webdriver) - STandard fixtures for testing web applications with `async-webdriver`.
+
 ## Contributing
 
 We welcome contributions to this project.
@@ -34,4 +38,4 @@ This project uses the [Developer Certificate of Origin](https://developercertifi
 
 ### Contributor Covenant
 
-This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-webdriver
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,8 +37,22 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-05-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-actor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: async-http
   requirement: !ruby/object:Gem::Requirement
@@ -54,47 +68,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.61'
 - !ruby/object:Gem::Dependency
-  name: async-websocket
+  name: async-pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.25'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.25'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: async-actor
+  name: async-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.25'
 - !ruby/object:Gem::Dependency
-  name: async-pool
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.2'
 description:
 email:
 executables: []
@@ -109,6 +123,7 @@ files:
 - lib/async/webdriver/bridge/generic.rb
 - lib/async/webdriver/bridge/pool.rb
 - lib/async/webdriver/bridge/process_group.rb
+- lib/async/webdriver/bridge/safari.rb
 - lib/async/webdriver/client.rb
 - lib/async/webdriver/element.rb
 - lib/async/webdriver/error.rb
@@ -130,12 +145,13 @@ files:
 - lib/async/webdriver/xpath.rb
 - license.md
 - readme.md
-homepage: https://github.com/socketry/async-webdriver/
+homepage: https://github.com/socketry/async-webdriver
 licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/async-webdriver/
   funding_uri: https://github.com/sponsors/ioquatix
+  source_code_uri: https://github.com/socketry/async-webdriver.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -144,14 +160,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A native library implementing the W3C WebDriver client specification.