Modernize gem.

socketry · May 2, 2024 · 79d3868 · 79d3868
1 parent 1986b33
commit 79d3868
Show file tree

Hide file tree

Showing 45 changed files with 74 additions and 55 deletions.
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/test-external.yaml b/.github/workflows/test-external.yaml
@@ -20,7 +20,6 @@ jobs:
           - macos
 
         ruby:
-          - "3.0"
           - "3.1"
           - "3.2"
           - "3.3"

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -21,7 +21,6 @@ jobs:
           - macos
 
         ruby:
-          - "3.0"
           - "3.1"
           - "3.2"
           - "3.3"

diff --git a/console.gemspec b/console.gemspec
@@ -13,11 +13,15 @@ Gem::Specification.new do |spec|
 	spec.cert_chain  = ['release.cert']
 	spec.signing_key = File.expand_path('~/.gem/release.pem')
 
-	spec.homepage = "https://socketry.github.io/console/"
+	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.required_ruby_version = ">= 3.0"
+	spec.required_ruby_version = ">= 3.1"
 
 	spec.add_dependency "fiber-annotation"
 	spec.add_dependency "fiber-storage"

diff --git a/fixtures/console/captured_output.rb b/fixtures/console/captured_output.rb
@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
 require 'sus/shared'
 
 module Console

diff --git a/gems.rb b/gems.rb
@@ -1,24 +1,22 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in console.gemspec
 gemspec
 
 group :maintenance, optional: true do
 	gem "bake-gem"
 	gem "bake-modernize"
 
-	gem "bake-github-pages"
 	gem "utopia-project"
 end
 
 group :test do
-	gem "covered", "~> 0.18.1"
-	gem "sus", "~> 0.14"
+	gem "sus"
+	gem "covered"
 
 	gem "bake-test"
 	gem "bake-test-external"

diff --git a/lib/console.rb b/lib/console.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.
 # Copyright, 2019, by Bryan Powell.
 # Copyright, 2020, by Michael Adams.
 # Copyright, 2021, by Cédric Boutillier.

diff --git a/lib/console/adapter.rb b/lib/console/adapter.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.
 
 module Console
 	# This namespace is reserved for logging adapters provided by other gems.

diff --git a/lib/console/capture.rb b/lib/console/capture.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_relative 'filter'
 

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

diff --git a/lib/console/event.rb b/lib/console/event.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'event/spawn'
 require_relative 'event/failure'
diff --git a/lib/console/event/failure.rb b/lib/console/event/failure.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Robert Schulze.
 
 require_relative 'generic'
@@ -11,8 +11,8 @@ module Event
 		# Represents a failure event.
 		#
 		# ```ruby
-		# Console.error(self, **Console::Event::Failure.for(exception))
-		# ````
+		# Console::Event::Failure.for(exception).emit(self)
+		# ```
 		class Failure < Generic
 			def self.default_root
 				Dir.getwd

diff --git a/lib/console/event/generic.rb b/lib/console/event/generic.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 module Console
 	module Event

diff --git a/lib/console/event/spawn.rb b/lib/console/event/spawn.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'generic'
 require_relative '../clock'

diff --git a/lib/console/filter.rb b/lib/console/filter.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.
 # Copyright, 2019, by Bryan Powell.
 # Copyright, 2020, by Michael Adams.
 # Copyright, 2021, by Robert Schulze.

diff --git a/lib/console/format.rb b/lib/console/format.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_relative 'format/safe'
 

diff --git a/lib/console/logger.rb b/lib/console/logger.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2021, by Bryan Powell.
 # Copyright, 2021, by Robert Schulze.
 

diff --git a/lib/console/output.rb b/lib/console/output.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative 'output/default'
 require_relative 'output/serialized'

diff --git a/lib/console/output/default.rb b/lib/console/output/default.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative 'terminal'
 require_relative 'serialized'

diff --git a/lib/console/output/null.rb b/lib/console/output/null.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.
 
 module Console
 	module Output

diff --git a/lib/console/output/sensitive.rb b/lib/console/output/sensitive.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative 'wrapper'
 

diff --git a/lib/console/output/serialized.rb b/lib/console/output/serialized.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_relative '../format'
 require 'time'

diff --git a/lib/console/output/split.rb b/lib/console/output/split.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 module Console
 	module Output

diff --git a/lib/console/output/terminal.rb b/lib/console/output/terminal.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.
 # Copyright, 2021, by Robert Schulze.
 
 require_relative '../clock'

diff --git a/lib/console/output/wrapper.rb b/lib/console/output/wrapper.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 module Console
 	module Output
@@ -19,4 +19,4 @@ def call(...)
 			end
 		end
 	end
-end
+end
diff --git a/lib/console/progress.rb b/lib/console/progress.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.
 # Copyright, 2022, by Anton Sozontov.
 
 require_relative 'clock'

diff --git a/lib/console/terminal.rb b/lib/console/terminal.rb
@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-# Copyright, 2021, by Robert Schulze.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require_relative 'terminal/text'
 require_relative 'terminal/xterm'

diff --git a/lib/console/terminal/formatter/failure.rb b/lib/console/terminal/formatter/failure.rb
@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
-# Copyright, 2021, by Robert Schulze.
+# Copyright, 2024, by Samuel Williams.
 
 module Console
 	module Terminal

diff --git a/lib/console/terminal/formatter/progress.rb b/lib/console/terminal/formatter/progress.rb
@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2024, by Samuel Williams.
 
 module Console
 	module Terminal

diff --git a/lib/console/terminal/formatter/spawn.rb b/lib/console/terminal/formatter/spawn.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 module Console
 	module Terminal
@@ -39,4 +39,4 @@ def chdir_string(options)
 			end
 		end
 	end
-end
+end
diff --git a/lib/console/terminal/text.rb b/lib/console/terminal/text.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require 'io/console'
 

diff --git a/lib/console/terminal/xterm.rb b/lib/console/terminal/xterm.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/console'
 

diff --git a/lib/console/version.rb b/lib/console/version.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.
 
 module Console
 	VERSION = "1.24.0"

diff --git a/test.rb b/test.rb
@@ -1,4 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
 
 require_relative 'lib/console'
 

diff --git a/test/console.rb b/test/console.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.
 # Copyright, 2019, by Bryan Powell.
 # Copyright, 2020, by Michael Adams.
 

diff --git a/test/console/compatible/logger.rb b/test/console/compatible/logger.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 require 'console/compatible/logger'
 require 'console/output/terminal'

diff --git a/test/console/event/failure.rb b/test/console/event/failure.rb
@@ -2,7 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2021, by Robert Schulze.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require 'console'
 require 'console/capture'
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,7 +20,6 @@ jobs: @@
               - macos
             ruby:
-              - "3.0"
               - "3.1"
               - "3.2"
               - "3.3"
@@ Expand Down @@