Modernize gem.

socketry · Aug 17, 2024 · b35de14 · b35de14
1 parent fb2d89f
commit b35de14
Show file tree

Hide file tree

Showing 21 changed files with 127 additions and 20 deletions.
diff --git a/.github/workflows/documentation-coverage.yaml b/.github/workflows/documentation-coverage.yaml
@@ -0,0 +1,25 @@
+name: Documentation Coverage
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+  COVERAGE: PartialSummary
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.3"
+        bundler-cache: true
+
+    - name: Validate coverage
+      timeout-minutes: 5
+      run: bundle exec bake decode:index:coverage lib
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -40,7 +40,7 @@ jobs:
       run: bundle exec bake utopia:project:static --force no
 
     - name: Upload documentation artifact
-      uses: actions/upload-pages-artifact@v2
+      uses: actions/upload-pages-artifact@v3
       with:
         path: docs
 
@@ -55,4 +55,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v3
+        uses: actions/deploy-pages@v4
diff --git a/.github/workflows/rubocop.yaml b/.github/workflows/rubocop.yaml
@@ -0,0 +1,24 @@
+name: RuboCop
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ruby
+        bundler-cache: true
+
+    - name: Run RuboCop
+      timeout-minutes: 10
+      run: bundle exec rubocop
diff --git a/.github/workflows/coverage.yaml → .github/workflows/test-coverage.yaml b/.github/workflows/coverage.yaml → .github/workflows/test-coverage.yaml
@@ -1,4 +1,4 @@
-name: Coverage
+name: Test Coverage
 
 on: [push, pull_request]
 
@@ -33,7 +33,7 @@ jobs:
     - name: Run tests
       timeout-minutes: 5
       run: bundle exec bake test
-
+    
     - uses: actions/upload-artifact@v3
       with:
         name: coverage-${{matrix.os}}-${{matrix.ruby}}

diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,49 @@
+AllCops:
+  DisabledByDefault: true
+
+Layout/IndentationStyle:
+  Enabled: true
+  EnforcedStyle: tabs
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Layout/IndentationWidth:
+  Enabled: true
+  Width: 1
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+Layout/BlockAlignment:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/BeginEndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/DefEndAlignment:
+  Enabled: true
+
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
diff --git a/examples/benchmark/bake.rb b/examples/benchmark/bake.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
 require 'etc'
 

diff --git a/examples/benchmark/config.ru b/examples/benchmark/config.ru
@@ -6,6 +6,10 @@ class Benchmark
 		@app = app
 	end
 
+	def hello(env)
+		[200, {'content-length' => 12}, ["Hello World\n"]]
+	end
+
 	PATH_INFO = 'PATH_INFO'.freeze
 
 	SMALL = [200, {}, ["Hello World\n" * 10] * 10].freeze

diff --git a/examples/hello/falcon.rb b/examples/hello/falcon.rb
@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require 'falcon/environment/self_signed_tls'
 require 'falcon/environment/rack'

diff --git a/examples/server/standalone.rb b/examples/server/standalone.rb
@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require 'async'
 require 'async/http/endpoint'

diff --git a/falcon.gemspec b/falcon.gemspec
@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
 	spec.version = Falcon::VERSION
 
 	spec.summary = "A fast, asynchronous, rack-compatible web server."
-	spec.authors = ["Samuel Williams", "Janko Marohnić", "Bryan Powell", "Trevor Turk", "Claudiu Garba", "Kyle Tam", "Mitsutaka Mimura", "Sho Ito", "Colby Swandale", "Daniel Evans", "Kent Gruber", "Michael Adams", "Mikel Kew", "Nick Janetakis", "Olle Jonsson", "Peter Schrammel", "Santiago Bartesaghi", "Sh Lin", "Tad Thorley", "Tasos Latsas", "dependabot[bot]"]
+	spec.authors = ["Samuel Williams", "Janko Marohnić", "Bryan Powell", "Trevor Turk", "Claudiu Garba", "Kyle Tam", "Mitsutaka Mimura", "Peter Schrammel", "Sho Ito", "Adam Daniels", "Colby Swandale", "Daniel Evans", "Kent Gruber", "Michael Adams", "Mikel Kew", "Nick Janetakis", "Olle Jonsson", "Santiago Bartesaghi", "Sh Lin", "Stefan Buhrmester", "Tad Thorley", "Tasos Latsas", "dependabot[bot]"]
 	spec.license = "MIT"
 
 	spec.cert_chain  = ['release.cert']
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
 	spec.add_dependency "async"
 	spec.add_dependency "async-container", "~> 0.18"
-	spec.add_dependency "async-http", "~> 0.66", ">= 0.66.3"
+	spec.add_dependency "async-http", ["~> 0.66", ">= 0.66.3"]
 	spec.add_dependency "async-http-cache", "~> 0.4.0"
 	spec.add_dependency "async-service", "~> 0.10"
 	spec.add_dependency "bundler"

diff --git a/gems.rb b/gems.rb
@@ -35,6 +35,8 @@
 group :test do
 	gem 'sus'
 	gem 'covered'
+	gem "decode"
+	gem "rubocop"
 
 	gem 'sus-fixtures-async'
 	gem 'sus-fixtures-async-http'

diff --git a/lib/falcon/command/paths.rb b/lib/falcon/command/paths.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require_relative '../configuration'
 

diff --git a/lib/falcon/middleware/proxy.rb b/lib/falcon/middleware/proxy.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
 require 'async/http/client'
 require 'protocol/http/headers'

diff --git a/lib/falcon/proxy_endpoint.rb b/lib/falcon/proxy_endpoint.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require 'io/endpoint/unix_endpoint'
 

diff --git a/lib/falcon/rackup/handler.rb b/lib/falcon/rackup/handler.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2024, by Samuel Williams.
 
 require 'rackup/handler'
 

diff --git a/lib/rack/handler/falcon.rb b/lib/rack/handler/falcon.rb
@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2017-2024, by Samuel Williams.
+# Copyright, 2019, by Bryan Powell.
 
 require 'rack/handler'
 

diff --git a/lib/rackup/handler/falcon.rb b/lib/rackup/handler/falcon.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 'rackup/handler'
 

diff --git a/license.md b/license.md
@@ -21,6 +21,8 @@ Copyright, 2024, by Peter Schrammel.
 Copyright, 2024, by Santiago Bartesaghi.  
 Copyright, 2024, by Trevor Turk.  
 Copyright, 2024, by dependabot[bot].  
+Copyright, 2024, by Adam Daniels.  
+Copyright, 2024, by Stefan Buhrmester.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/readme.md b/readme.md
@@ -53,8 +53,8 @@ We welcome contributions to this project.
 
 ### 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.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.
diff --git a/test/falcon/rackup/handler/falcon.rb b/test/falcon/rackup/handler/falcon.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require 'sus/fixtures/async'
 

diff --git a/test/falcon/ssl_server.rb b/test/falcon/ssl_server.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 # Copyright, 2020, by Tasos Latsas.
 
 require 'server_context'