Modernize gem. Prefer sus-fixtures-console for captured logger.

socketry · Nov 5, 2024 · 3f95f0a · 3f95f0a
1 parent 076f777
commit 3f95f0a
Show file tree

Hide file tree

Showing 54 changed files with 262 additions and 286 deletions.
diff --git a/.github/workflows/rubocop.yaml b/.github/workflows/rubocop.yaml
@@ -1,4 +1,4 @@
-name: Test External
+name: RuboCop
 
 on: [push, pull_request]
 
@@ -9,26 +9,14 @@ env:
   CONSOLE_OUTPUT: XTerm
 
 jobs:
-  test:
-    name: ${{matrix.ruby}} on ${{matrix.os}}
-    runs-on: ${{matrix.os}}-latest
-
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-          - macos
-
-        ruby:
-          - "3.1"
-          - "3.2"
-          - "3.3"
+  check:
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{matrix.ruby}}
+        ruby-version: ruby
         bundler-cache: true
 
     - name: Run RuboCop

diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -33,9 +33,11 @@ jobs:
     - name: Run tests
       timeout-minutes: 5
       run: bundle exec bake test
-
-    - uses: actions/upload-artifact@v3
+    
+    - uses: actions/upload-artifact@v4
       with:
+        include-hidden-files: true
+        if-no-files-found: error
         name: coverage-${{matrix.os}}-${{matrix.ruby}}
         path: .covered.db
 
@@ -50,7 +52,7 @@ jobs:
         ruby-version: "3.3"
         bundler-cache: true
 
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
 
     - name: Validate coverage
       timeout-minutes: 5

diff --git a/.rubocop.yml b/.rubocop.yml
@@ -16,6 +16,9 @@ Layout/IndentationConsistency:
   Enabled: true
   EnforcedStyle: normal
 
+Layout/BlockAlignment:
+  Enabled: true
+
 Layout/EndAlignment:
   Enabled: true
   EnforcedStyleAlignWith: start_of_line
@@ -44,3 +47,7 @@ Layout/EmptyLinesAroundModuleBody:
 
 Style/FrozenStringLiteralComment:
   Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
diff --git a/bake.rb b/bake.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 # Update the project documentation with the new version number.
 #

diff --git a/bake/console.rb b/bake/console.rb
@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 # Increase the verbosity of the logger to info.
 def info
-	require_relative '../lib/console'
+	require_relative "../lib/console"
 
 	Console.logger.info!
 end
 
 # Increase the verbosity of the logger to debug.
 def debug
-	require_relative '../lib/console'
+	require_relative "../lib/console"
 
 	Console.logger.debug!
 end
diff --git a/benchmark/fiber_vs_thread.rb b/benchmark/fiber_vs_thread.rb
@@ -2,10 +2,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
-require 'benchmark/ips'
-require 'fiber'
+require "benchmark/ips"
+require "fiber"
 
 # GC.disable
 

diff --git a/config/sus.rb b/config/sus.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'covered/sus'
+require "covered/sus"
 include Covered::Sus
diff --git a/console.gemspec b/console.gemspec
@@ -10,16 +10,16 @@ Gem::Specification.new do |spec|
 	spec.authors = ["Samuel Williams", "Robert Schulze", "Bryan Powell", "Michael Adams", "Anton Sozontov", "Cyril Roelandt", "Cédric Boutillier", "Felix Yan", "Olle Jonsson", "Patrik Wenger", "William T. Nelson"]
 	spec.license = "MIT"
 
-	spec.cert_chain  = ['release.cert']
-	spec.signing_key = File.expand_path('~/.gem/release.pem')
+	spec.cert_chain  = ["release.cert"]
+	spec.signing_key = File.expand_path("~/.gem/release.pem")
 
 	spec.homepage = "https://socketry.github.io/console"
 
 	spec.metadata = {
 		"documentation_uri" => "https://socketry.github.io/console/",
 	}
 
-	spec.files = Dir.glob(['{bake,lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)
+	spec.files = Dir.glob(["{bake,lib}/**/*", "*.md"], File::FNM_DOTMATCH, base: __dir__)
 
 	spec.required_ruby_version = ">= 3.1"
 

diff --git a/examples/datadog/gems.rb b/examples/datadog/gems.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'traces'
-gem 'traces-backend-datadog'
+gem "traces"
+gem "traces-backend-datadog"
 
-gem 'console', path: '../..'
-gem 'console-output-datadog'
+gem "console", path: "../.."
+gem "console-output-datadog"
diff --git a/examples/datadog/integration.rb b/examples/datadog/integration.rb
@@ -2,19 +2,19 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 # Run this using `systemd-cat bundle exec ./integration.rb`
 # This will send logs to datadog using the standard systemd journal.
 
-ENV['TRACES_BACKEND'] ||= 'traces/backend/datadog'
-ENV['CONSOLE_OUTPUT'] ||= 'Console::Output::Datadog,Console::Output::Default'
+ENV["TRACES_BACKEND"] ||= "traces/backend/datadog"
+ENV["CONSOLE_OUTPUT"] ||= "Console::Output::Datadog,Console::Output::Default"
 
-require 'ddtrace'
+require "ddtrace"
 
-require 'traces'
-require 'console/output/datadog'
-require 'console'
+require "traces"
+require "console/output/datadog"
+require "console"
 
 # Standard log levels according to syslog:
 # Fatal: system is unusable
@@ -41,9 +41,9 @@ def call(message)
 
 	Traces::Provider(self) do
 		def call(message)
-			trace('logly.call') {super}
+			trace("logly.call") {super}
 		end
 	end
 end
 
-Logly.new.call('Hello, world!')
+Logly.new.call("Hello, world!")
diff --git a/fixtures/console/captured_output.rb b/fixtures/console/captured_output.rb
diff --git a/lib/console.rb b/lib/console.rb
@@ -6,9 +6,9 @@
 # Copyright, 2020, by Michael Adams.
 # Copyright, 2021, by Cédric Boutillier.
 
-require_relative 'console/version'
-require_relative 'console/logger'
-require_relative 'console/warn'
+require_relative "console/version"
+require_relative "console/logger"
+require_relative "console/warn"
 
 module Console
 	class << self

diff --git a/lib/console/capture.rb b/lib/console/capture.rb
@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'filter'
+require_relative "filter"
 
 module Console
 	# A general sink which captures all events into a buffer.

diff --git a/lib/console/compatible/logger.rb b/lib/console/compatible/logger.rb
@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require 'logger'
+require "logger"
 
 module Console
 	module Compatible

diff --git a/lib/console/event.rb b/lib/console/event.rb
@@ -3,5 +3,5 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'event/spawn'
-require_relative 'event/failure'
+require_relative "event/spawn"
+require_relative "event/failure"
diff --git a/lib/console/event/failure.rb b/lib/console/event/failure.rb
@@ -5,7 +5,7 @@
 # Copyright, 2021, by Robert Schulze.
 # Copyright, 2024, by Patrik Wenger.
 
-require_relative 'generic'
+require_relative "generic"
 
 module Console
 	module Event
@@ -59,7 +59,7 @@ def extract(exception, hash)
 					message = exception.detailed_message
 
 					# We want to remove the trailling exception class as we format it differently:
-					message.sub!(/\s*\(.*?\)$/, '')
+					message.sub!(/\s*\(.*?\)$/, "")
 
 					hash[:message] = message
 				else

diff --git a/lib/console/event/spawn.rb b/lib/console/event/spawn.rb
@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'generic'
-require_relative '../clock'
+require_relative "generic"
+require_relative "../clock"
 
 module Console
 	module Event

diff --git a/lib/console/filter.rb b/lib/console/filter.rb
@@ -10,7 +10,7 @@ module Console
 	UNKNOWN = :unknown
 
 	class Filter
-		if Object.const_defined?(:Ractor) and RUBY_VERSION >= '3.1'
+		if Object.const_defined?(:Ractor) and RUBY_VERSION >= "3.1"
 			def self.define_immutable_method(name, &block)
 				block = Ractor.make_shareable(block)
 				self.define_method(name, &block)

diff --git a/lib/console/format.rb b/lib/console/format.rb
@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'format/safe'
+require_relative "format/safe"
 
 module Console
 	module Format

diff --git a/lib/console/format/safe.rb b/lib/console/format/safe.rb
@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
-require 'json'
+require "json"
 
 module Console
 	module Format

diff --git a/lib/console/logger.rb b/lib/console/logger.rb
@@ -5,13 +5,13 @@
 # Copyright, 2021, by Bryan Powell.
 # Copyright, 2021, by Robert Schulze.
 
-require_relative 'output'
-require_relative 'filter'
-require_relative 'event'
-require_relative 'resolver'
-require_relative 'progress'
+require_relative "output"
+require_relative "filter"
+require_relative "event"
+require_relative "resolver"
+require_relative "progress"
 
-require 'fiber/local'
+require "fiber/local"
 
 module Console
 	class Logger < Filter[debug: 0, info: 1, warn: 2, error: 3, fatal: 4]
@@ -21,7 +21,7 @@ class Logger < Filter[debug: 0, info: 1, warn: 2, error: 3, fatal: 4]
 		# You can also specify CONSOLE_LEVEL=debug or CONSOLE_LEVEL=info in environment.
 		# https://mislav.net/2011/06/ruby-verbose-mode/ has more details about how it all fits together.
 		def self.default_log_level(env = ENV)
-			if level = env['CONSOLE_LEVEL']
+			if level = env["CONSOLE_LEVEL"]
 				LEVELS[level.to_sym] || level.to_i
 			elsif $DEBUG
 				DEBUG
@@ -34,7 +34,7 @@ def self.default_log_level(env = ENV)
 
 		# Controls verbose output using `$VERBOSE`.
 		def self.verbose?(env = ENV)
-			!$VERBOSE.nil? || env['CONSOLE_VERBOSE']
+			!$VERBOSE.nil? || env["CONSOLE_VERBOSE"]
 		end
 
 		def self.default_logger(output = $stderr, env = ENV, **options)

diff --git a/lib/console/output.rb b/lib/console/output.rb
@@ -3,16 +3,16 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'output/default'
-require_relative 'output/serialized'
-require_relative 'output/terminal'
-require_relative 'output/null'
+require_relative "output/default"
+require_relative "output/serialized"
+require_relative "output/terminal"
+require_relative "output/null"
 
 module Console
 	module Output
 		def self.new(output = nil, env = ENV, **options)
-			if names = env['CONSOLE_OUTPUT']
-				names = names.split(',').reverse
+			if names = env["CONSOLE_OUTPUT"]
+				names = names.split(",").reverse
 
 				names.inject(output) do |output, name|
 					Output.const_get(name).new(output, **options)