falcon-capybara 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01acd8665a3d99cf7c1fa53c438db7c9b5e341f77ba09114660f5cceffd86603
-  data.tar.gz: 3b14914f66d4637bf7ffd72858f0ed8db7827b67995a1c2a9c699bfc4463cfbe
+  metadata.gz: a729f1548db40e54fa9de296a0cd8dee98559aee2eeb246852867197f080226e
+  data.tar.gz: 0e9bdd77739597ad47c3b4b895021d59a46a7bd8f807ebd198e65c47908e4e1f
 SHA512:
-  metadata.gz: 5a2efd236298b2165e47efa3c3d083de996b7740f934dd4a65cc5ab09de8374adfc770ec11f92aba10680e9c8fb01327109113cf253b7771dce207ce44b847c0
-  data.tar.gz: 80f846895f524710119ddc31425b906d9ec556a2517746b48f4bbd1c30ecee04a03a8f7227d797517049ffec80827ebb160ee861a32c2b8c0bf2b8417e5aedde
+  metadata.gz: 901cc06fa726b2844a6f53ff2f9f53017292cddd0d034a9f063dbc6f256cfa21e028b4ca764c91d8597894c35164133df041289c915e3008963ca4924f2b3e32
+  data.tar.gz: d5f4cf87a4ea682e39bcc181c6b0c45ab9183a9daf260d5d9321e1c03258fbf652a3bb96c71a330192fdbb2ecdd3a6a68f1c25d715df387a6e0cf1865769e44f

data/lib/falcon/capybara.rb

@@ -21,6 +21,6 @@
 require 'capybara'
 
 require_relative "capybara/version"
-require_relative "capybara/wrapper"
+
 require_relative "capybara/servers"
 require_relative "capybara/drivers"

data/lib/falcon/capybara/drivers.md

@@ -0,0 +1,16 @@
+# Falcon::Capybara::Drivers
+
+Provides Capybara driver definitions for using Chrome with self-signed HTTPS via localhost **only**.
+
+## Usage
+
+In your Capybara configuration, you'd typically select one of the named server configurations:
+
+~~~ ruby
+Capybara.configure do |config|
+	config.javascript_driver = :selenium_chrome_https
+	
+	# Or for headless:
+	config.javascript_driver = :selenium_chrome_headless_https
+end
+~~~

data/lib/falcon/capybara/drivers.rb

@@ -19,15 +19,26 @@
 # THE SOFTWARE.
 
 require 'capybara'
-require 'selenium/webdriver'
 
+# A selenium driver for chrome which allows insecure localhost https protocol.
+# @scope Falcon Capybara Drivers
+# @name selenium_chrome_https
+# @attribute [Block]
 Capybara.register_driver :selenium_chrome_https do |app|
+	require 'selenium/webdriver'
+	
 	Capybara.drivers[:selenium_chrome].call(app).tap do |driver|
 		driver.options[:options].args << '--allow-insecure-localhost'
 	end
 end
 
+# A headless selenium driver for chrome which allows insecure localhost https protocol.
+# @scope Falcon Capybara Drivers
+# @name selenium_chrome_headless_https
+# @attribute [Block]
 Capybara.register_driver :selenium_chrome_headless_https do |app|
+	require 'selenium/webdriver'
+	
 	Capybara.drivers[:selenium_chrome_headless].call(app).tap do |driver|
 		driver.options[:options].args << '--allow-insecure-localhost'
 	end

data/lib/falcon/capybara/servers.md

@@ -0,0 +1,13 @@
+# Falcon::Capybara::Servers
+
+Provides Capybara server definitions for using Falcon with Capybara integration & acceptance tests.
+
+## Usage
+
+In your Capybara configuration, you'd typically select one of the named server configurations:
+
+~~~ ruby
+Capybara.configure do |config|
+	config.server = :falcon_https
+end
+~~~

data/lib/falcon/capybara/servers.rb

@@ -20,6 +20,29 @@
 
 require 'capybara'
 
-Capybara.servers[:falcon] = Falcon::Capybara::Wrapper.new
-Capybara.servers[:falcon_http] = Falcon::Capybara::Wrapper.new("http")
-Capybara.servers[:falcon_https] = Falcon::Capybara::Wrapper.new("https")
+# The default Falcon server wrapper which uses the `HTTP` scheme.
+# @scope Falcon Capybara Servers
+# @name falcon
+# @attribute [Block]
+Capybara.register_server(:falcon) do |*arguments|
+	require_relative 'wrapper'
+	Falcon::Capybara::Wrapper.new.call(*arguments)
+end
+
+# An explicit Falcon server wrapper which uses the `HTTP` scheme.
+# @scope Falcon Capybara Servers
+# @name falcon_http
+# @attribute [Block]
+Capybara.register_server(:falcon_http) do |*arguments|
+	require_relative 'wrapper'
+	Falcon::Capybara::Wrapper.new('http').call(*arguments)
+end
+
+# The default Falcon server wrapper which uses the `HTTPS` scheme.
+# @scope Falcon Capybara Servers
+# @name falcon_https
+# @attribute [Block]
+Capybara.register_server(:falcon_https) do |*arguments|
+	require_relative 'wrapper'
+	Falcon::Capybara::Wrapper.new('https').call(*arguments)
+end

data/lib/falcon/capybara/version.rb

@@ -20,6 +20,6 @@
 
 module Falcon
 	module Capybara
-		VERSION = "1.4.0"
+		VERSION = "1.5.0"
 	end
 end

data/lib/falcon/capybara/wrapper.rb

@@ -26,34 +26,23 @@ require 'async/io/notification'
 
 module Falcon
 	module Capybara
+		# Implements a wrapper for starting the Falcon server for Capybara.
 		class Wrapper
+			# @parameter scheme [String] The scheme for the server to bind to.
+			# 	e.g. `http` or `https`.
 			def initialize(scheme = "http")
-				@job = nil
 				@scheme = scheme
-				
-				@job_available = Async::IO::Notification.new
-				@job_complete = Async::IO::Notification.new
-			end
-			
-			def close
-				@job_available.close
-				@job_complete.close
-			end
-			
-			def remote(&block)
-				@job = block
-				@job_available.signal
-				
-				Async do
-					Async.logger.debug (self) {"Waiting for job completion..."}
-					@job_complete.wait
-				end.wait
 			end
 			
+			# Build a server endpoint using the given scheme.
 			def endpoint(host, port)
 				Falcon::Endpoint.parse("#{@scheme}://#{host}:#{port}")
 			end
 			
+			# Run the Falcon server hosting the given rack application.
+			# @parameter rack_app [Proc] A Rack application.
+			# @parameter port [Integer] The port number to bind to.
+			# @parameter host [String] The local host to bind to.
 			def call(rack_app, port, host)
 				require 'async/reactor'
 				require 'falcon/server'
@@ -69,22 +58,8 @@ module Falcon
 					
 					server = Falcon::Server.new(app, endpoint, endpoint.protocol, endpoint.scheme)
 					
-					task.async do
-						Async.logger.debug (self) {"Running server..."}
-						server.run
-					end
-					
-					while true
-						Async.logger.debug (self) {"Waiting for job..."}
-						@job_available.wait while @job.nil?
-						
-						Async.logger.debug (self) {"Running job #{@job}"}
-						@job.call
-						@job = nil
-						
-						Async.logger.debug (self) {"Completing job #{@job}"}
-						@job_complete.signal
-					end
+					Async.logger.debug (self) {"Running server..."}
+					server.run
 				end
 			end
 		end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falcon-capybara
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -66,34 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-modernize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,14 +122,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/falcon/capybara.rb
+- lib/falcon/capybara/drivers.md
 - lib/falcon/capybara/drivers.rb
+- lib/falcon/capybara/servers.md
 - lib/falcon/capybara/servers.rb
 - lib/falcon/capybara/version.rb
 - lib/falcon/capybara/wrapper.rb
@@ -165,7 +139,7 @@ homepage: https://github.com/socketry/falcon-capybara
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Use the falcon web server to run capybara/selenium tests.
 test_files: []