Modernize gem.

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

Hide file tree

Showing 29 changed files with 283 additions and 178 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/bin/falcon b/bin/falcon
@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 

diff --git a/bin/falcon-host b/bin/falcon-host
@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 

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'
 
@@ -88,16 +88,16 @@ def compare
 
 				n = 2
 
-				# threads.times do |n|
+				threads.times do |n|
 					c = (n*n).to_s
 					puts "Running #{command.first} with #{c} concurrent connections..."
-
+						
 					Async::Process.spawn("curl", "-o", "/dev/null", "#{host}#{@request_path}")
-
+						
 					# Async::Process.spawn("ab", "-k", "-n", "1000", "#{host}#{@request_path}")
-
+						
 					Async::Process.spawn("wrk", "-c", c.to_s, "-t", (n).to_s, "-d", "10", "#{host}#{@request_path}")
-				# end
+				end
 			ensure
 				child_process.kill(:INT)
 			end

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/bug/config.ru b/examples/bug/config.ru
@@ -1,27 +1,24 @@
+# frozen_string_literal: true
 class HelloWorld
-  JSON_TYPE = "application/json".freeze
-  PLAINTEXT_TYPE = "text/plain".freeze
-
-  def respond(type, body)
-    [200, { "Content-Type" => type }, [body]]
-  end
-
-  def call(env)
-    case env["PATH_INFO"]
-    when "/json"
-      # Test type 1: JSON serialization
-      return respond JSON_TYPE,
-              Oj.dump({ message: "Hello, World!" }, { mode: :strict })
-    when "/plaintext"
-      # Test type 6: Plaintext
-      return respond PLAINTEXT_TYPE, "Hello, World!"
-    end
-
-    [200, {}, []]
-  end
+	JSON_TYPE = "application/json".freeze
+	PLAINTEXT_TYPE = "text/plain".freeze
+
+	def respond(type, body)
+		[200, { "Content-Type" => type }, [body]]
+	end
+
+	def call(env)
+		case env["PATH_INFO"]
+		when "/json"
+			# Test type 1: JSON serialization
+			return respond JSON_TYPE, Oj.dump({ message: "Hello, World!" }, { mode: :strict })
+		when "/plaintext"
+			# Test type 6: Plaintext
+			return respond PLAINTEXT_TYPE, "Hello, World!"
+		end
+
+		[200, {}, []]
+	end
 end
 
-# run HelloWorld.new
-
-run do
-end
+run HelloWorld.new
diff --git a/examples/bug/falcon.rb b/examples/bug/falcon.rb
@@ -8,9 +8,7 @@
 
 hostname = File.basename(__dir__)
 rack hostname do
-  endpoint Async::HTTP::Endpoint.parse("http://0.0.0.0:8080").with(
-             protocol: Async::HTTP::Protocol::HTTP11
-           )
+	endpoint Async::HTTP::Endpoint.parse("http://0.0.0.0:8080").with(protocol: Async::HTTP::Protocol::HTTP11)
 end
 
 supervisor
diff --git a/examples/echo/config.ru b/examples/echo/config.ru
@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
 class EchoBody
-  def initialize(input)
-    @input = input
-  end
+	def initialize(input)
+		@input = input
+	end
 
-  def each(&output)
-    while chunk = @input.read(1024)
-      output.call(chunk)
-    end
-  end
+	def each(&output)
+		while chunk = @input.read(1024)
+			output.call(chunk)
+		end
+	end
 end
 
 run lambda{|env|
-  [200, [], EchoBody.new(env['rack.input'])]
+	[200, [], EchoBody.new(env['rack.input'])]
 }
-
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'