Modernize code.

samuel-williams-shopify · samuel-williams-shopify · commit 32ebe45baada · 2025-08-25T20:11:28.000+12:00
diff --git a/.github/workflows/documentation-coverage.yaml b/.github/workflows/documentation-coverage.yaml
@@ -6,7 +6,6 @@ permissions:
   contents: read
 
 env:
-  CONSOLE_OUTPUT: XTerm
   COVERAGE: PartialSummary
 
 jobs:
@@ -17,7 +16,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - name: Validate coverage
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -17,7 +17,6 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  CONSOLE_OUTPUT: XTerm
   BUNDLE_WITH: maintenance
 
 jobs:
@@ -29,7 +28,7 @@ jobs:
 
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - name: Installing packages
diff --git a/.github/workflows/rubocop.yaml b/.github/workflows/rubocop.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   check:
     runs-on: ubuntu-latest
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -6,7 +6,6 @@ permissions:
   contents: read
 
 env:
-  CONSOLE_OUTPUT: XTerm
   COVERAGE: PartialSummary
 
 jobs:
@@ -21,7 +20,7 @@ jobs:
           - macos
         
         ruby:
-          - "3.4"
+          - ruby
     
     steps:
     - uses: actions/checkout@v4
@@ -49,7 +48,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - uses: actions/download-artifact@v4
diff --git a/.github/workflows/test-external.yaml b/.github/workflows/test-external.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   test:
     name: ${{matrix.ruby}} on ${{matrix.os}}
@@ -20,7 +17,6 @@ jobs:
           - macos
         
         ruby:
-          - "3.1"
           - "3.2"
           - "3.3"
           - "3.4"
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   test:
     name: ${{matrix.ruby}} on ${{matrix.os}}
@@ -21,7 +18,6 @@ jobs:
           - macos
         
         ruby:
-          - "3.1"
           - "3.2"
           - "3.3"
           - "3.4"
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,7 @@
-/.bundle/
-/pkg/
+/agent.md
+/.context
+/.bundle
+/pkg
 /gems.locked
 /.covered.db
 /external
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,6 +1,12 @@
+plugins:
+  - rubocop-socketry
+
 AllCops:
   DisabledByDefault: true
 
+Layout/ConsistentBlankLineIndentation:
+  Enabled: true
+
 Layout/IndentationStyle:
   Enabled: true
   EnforcedStyle: tabs
@@ -45,6 +51,18 @@ Layout/EmptyLinesAroundClassBody:
 Layout/EmptyLinesAroundModuleBody:
   Enabled: true
 
+Layout/EmptyLineAfterMagicComment:
+   Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: true
+  EnforcedStyleInsidePipes: no_space
+
 Style/FrozenStringLiteralComment:
   Enabled: true
 
diff --git a/bake.rb b/bake.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+# Update the project documentation with the new version number.
+#
+# @parameter version [String] The new version number.
+def after_gem_release_version_increment(version)
+	context["releases:update"].call(version)
+	context["utopia:project:readme:update"].call
+	context["utopia:project:agent:context:update"].call
+end
diff --git a/gems.rb b/gems.rb
@@ -10,6 +10,9 @@
 group :maintenance, optional: true do
 	gem "bake-modernize"
 	gem "bake-gem"
+	gem "bake-releases"
+	
+	gem "agent-context"
 	
 	gem "utopia-project"
 end
@@ -18,7 +21,9 @@
 	gem "sus"
 	gem "covered"
 	gem "decode"
+
 	gem "rubocop"
+	gem "rubocop-socketry"
 	
 	gem "bake-test"
 	gem "bake-test-external"
diff --git a/guides/getting-started/readme.md b/guides/getting-started/readme.md
@@ -0,0 +1,34 @@
+# Getting Started
+
+This guide explains how to get started with `traces-backend-open_telemetry` to send application traces to OpenTelemetry.
+
+## Installation
+
+Add the gem to your project:
+
+```bash
+$ bundle add traces-backend-open_telemetry
+```
+
+## Usage
+
+You will need to configure OpenTelemetry appropriately:
+
+```bash
+$ bundle add opentelemetry-exporter-otlp
+```
+
+Then, you can emit traces:
+
+```ruby
+require "opentelemetry/sdk"
+
+ENV["TRACES_BACKEND"] ||= "traces/backend/open_telemetry"
+require "traces"
+
+OpenTelemetry::SDK.configure
+
+Traces.trace("main") do
+	puts "Hello World"
+end
+```
diff --git a/guides/links.yaml b/guides/links.yaml
@@ -0,0 +1,2 @@
+getting-started:
+  order: 1
diff --git a/lib/traces/backend/open_telemetry/interface.rb b/lib/traces/backend/open_telemetry/interface.rb
@@ -71,7 +71,7 @@ def with_context(context)
 				def inject(headers = nil, context = nil)
 					context ||= ::OpenTelemetry::Context.current
 					headers ||= Hash.new
-
+					
 					count = headers.count
 					
 					::OpenTelemetry.propagation.inject(headers, context: context)
diff --git a/readme.md b/readme.md
@@ -16,6 +16,10 @@ $ bundle add traces-backend-open_telemetry
 $ TRACES_BACKEND=traces/backend/open_telemetry ./my_script.rb
 ```
 
+## Releases
+
+There are no documented releases.
+
 ## Contributing
 
 We welcome contributions to this project.
diff --git a/releases.md b/releases.md
@@ -0,0 +1,3 @@
+# Releases
+
+## Unreleased
diff --git a/test/traces/backend/open_telemetry.rb b/test/traces/backend/open_telemetry.rb
@@ -30,7 +30,7 @@ def my_span
 	def my_context
 		Traces.trace("my_context") {|span| return Traces.trace_context}
 	end
-
+	
 	def my_span_and_context
 		Traces.trace("my_span_and_context") {|span| return span, Traces.trace_context}
 	end
@@ -93,7 +93,7 @@ def my_span_and_context
 		let(:span_and_context) {instance.my_span_and_context}
 		let(:span) {span_and_context.first}
 		let(:context) {span_and_context.last}
-
+		
 		with "#trace_context" do
 			it "has a valid trace id" do
 				expect(context).to have_attributes(
diff --git a/traces-backend-open_telemetry.gemspec b/traces-backend-open_telemetry.gemspec
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 	
 	spec.files = Dir.glob(["{lib}/**/*", "*.md"], File::FNM_DOTMATCH, base: __dir__)
 	
-	spec.required_ruby_version = ">= 3.1"
+	spec.required_ruby_version = ">= 3.2"
 	
 	spec.add_dependency "opentelemetry-api", "~> 1.0"
 	spec.add_dependency "traces", "~> 0.10"
