guard-falcon 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e138f9e0a7c2ec228f48a5ea9f0d1b4fd533786e79923b2fa45d979d89c677f3
-  data.tar.gz: eb6414031e416a70b0a211bfd3abe3f0bd08f7df836d3e55e8f4be839deedd2b
+  metadata.gz: 2429f5321a048be77d11a9ceded01b6a5ecceae7541d33e9e87f2acd3aeee759
+  data.tar.gz: 12135bb50118469a193935832c95b48599f72b5051eebc6ff7152d26306a2030
 SHA512:
-  metadata.gz: 0b9904d8b58e69085e9a144ac1292f8479696e419c27a575e80f83c38deea9feedcae66eb9fe101b06bbc06f5bda9d764ee90eaf3f2e48a333d914d3aa60b0c5
-  data.tar.gz: cf7b0ac7af995a33c901c604e22cc81371df2da972537ba7c1b3fb2fd494ccc3ceb3eed47d0f70c21fcbc3523411ad98969c91833769de2b308fadf8bd28b062
+  metadata.gz: 82130f429075e607bbcb91d38c4d044bd9c43c3e2f325f102bf1c0d93a1beff4ebc693c65670e44d4b70b6ac3eabfca78bd9a967c5c9b18d19c180f42ee31536
+  data.tar.gz: e66a2343d9f846046c75d9a5cd84caa9f9c5211c66fcab08fd2a315ea1e410d003c36d88b7c9a55152e762b89ade012b04390ac2581a4fd0867cc1f4facb6ee3

data/lib/guard/falcon/plugin.rb

@@ -1,89 +1,65 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
-require 'guard/compat/plugin'
-
-require 'rack/builder'
+# Released under the MIT License.
+# Copyright, 2017-2024, by Samuel Williams.
+# Copyright, 2018-2019, by Huba Nagy.
 
-require 'console/logger'
-require 'async/container'
+require 'guard/compat/plugin'
 
-require 'falcon/server'
+require 'falcon'
 require 'falcon/endpoint'
-require 'falcon/controller/serve'
+require 'falcon/environment/rackup'
+require 'falcon/environment/server'
+require 'async/service'
+require 'console'
 
 module Guard
 	module Falcon
 		class Plugin < Guard::Plugin
-			DEFAULT_OPTIONS = {
-				config: 'config.ru',
-				count: 1,
-				verbose: false,
-			}
-			
-			def initialize(**options)
-				super
+			module Environment
+				include ::Falcon::Environment::Server
+				include ::Falcon::Environment::Rackup
 				
-				@options = DEFAULT_OPTIONS.merge(options)
-				
-				@endpoint = nil
-				
-				@controller = ::Falcon::Controller::Serve.new(self)
-			end
-			
-			def container_class
-				Async::Container::Threaded
+				# The upstream endpoint that will handle incoming requests.
+				# @returns [Async::HTTP::Endpoint]
+				def endpoint
+					::Falcon::Endpoint.parse(url).with(
+						reuse_address: true,
+						# reuse_port: true,
+						timeout: timeout,
+					)
+				end
 			end
 			
-			def container_options
-				{}
+			def self.default_environment(**options)
+				Async::Service::Environment.new(Environment).with(**options)
 			end
 			
-			private def build_endpoint
-				# Support existing use cases where only port: is specified.
-				if @options[:endpoint]
-					return @options[:endpoint]
+			def initialize(**options)
+				super
+				
+				options[:root] ||= Dir.pwd
+				options[:name] ||= "falcon"
+				
+				if paths = options[:paths]
+					@configuration = Async::Service::Configuration.load(paths)
 				else
-					url = @options.fetch(:url, "https://localhost")
-					port = @options.fetch(:port, 9292)
+					@configuration = Async::Service::Configuration.new
+					
+					# Compatibility
+					if rackup_path = options.delete(:config)
+						warn "The :config option is deprecated, please use :rackup_path instead.", uplevel: 1
+						options[:rackup_path] = rackup_path
+					end
 					
-					return ::Falcon::Endpoint.parse(url, port: port)
+					@configuration.add(self.class.default_environment(**options))
 				end
-			end
-			
-			def endpoint
-				@endpoint ||= build_endpoint
-			end
-			
-			def load_app
-				rack_app, options = Rack::Builder.parse_file(@options[:config])
 				
-				return ::Falcon::Server.middleware(rack_app, verbose: @options[:verbose])
-			end
-			
-			# As discussed in https://github.com/guard/guard/issues/713
-			def logger
-				Console.logger
+				@controller = ::Async::Service::Controller.new(@configuration.services.to_a)
 			end
 			
 			def start
+				Console.info(self, "Starting...")
 				@controller.start
 			end
 			
@@ -92,10 +68,12 @@ module Guard
 			end
 			
 			def reload
+				Console.info(self, "Reloading...")
 				@controller.restart
 			end
 			
 			def stop
+				Console.info(self, "Stopping...")
 				@controller.stop
 			end
 			

data/lib/guard/falcon/version.rb

@@ -1,25 +1,10 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2024, by Samuel Williams.
 
 module Guard
 	module Falcon
-		VERSION = "0.13.1"
+		VERSION = "0.14.0"
 	end
 end

data/lib/guard/falcon.rb

@@ -1,22 +1,7 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2024, by Samuel Williams.
 
 require_relative 'falcon/plugin'
 
@@ -25,10 +10,5 @@ module Guard
 		def self.new(*arguments, **options)
 			Plugin.new(*arguments, **options)
 		end
-		
-		# Workaround for https://github.com/guard/guard/pull/872
-		def self.superclass
-			nil
-		end
 	end
-end
+end

data/license.md

@@ -0,0 +1,23 @@
+# MIT License
+
+Copyright, 2017-2024, by Samuel Williams.  
+Copyright, 2018-2019, by Huba Nagy.  
+Copyright, 2020, by Olle Jonsson.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,44 @@
+# Guard::Falcon
+
+Efficiently runs a asynchronous Falcon server, restarting it as required by guard.
+
+[![Development Status](https://github.com/socketry/guard-falcon/workflows/Test/badge.svg)](https://github.com/socketry/guard-falcon/actions?workflow=Test)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'guard-falcon'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Falcon can restart very quickly and is ideal for use with guard. In your `Guardfile`:
+
+``` ruby
+guard :falcon do
+end
+```
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+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: guard-falcon
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -39,22 +39,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-06 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: async-container
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: console
   requirement: !ruby/object:Gem::Requirement
@@ -111,62 +97,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !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: 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: covered
-  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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 description:
 email:
 executables: []
@@ -177,10 +107,13 @@ files:
 - lib/guard/falcon/plugin.rb
 - lib/guard/falcon/templates/Guardfile
 - lib/guard/falcon/version.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/guard-falcon
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/socketry/guard-falcon.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -189,14 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A guard plugin to run an instance of the falcon web server.