Add RBS type validation and related dependencies #113

addersuk · 2025-12-30T13:36:09Z

Introduced RBS type validation in CI workflows.
Added RBS validation task in Rakefile.
Created RBS type signatures for various modules and classes.
Updated gemspec to include RBS as a development dependency.

This pull request introduces RBS (Ruby Signature) type checking to the project, adds type signature files for key classes and modules, and updates the CI workflow to validate RBS types during testing and publishing. The changes improve type safety, documentation, and reliability of the codebase.

RBS Type Checking Integration:

Added a new Rake task (:rbs) to validate RBS type signatures using the rbs gem, and included rbs as a development dependency in the gemspec. [1] [2]
Updated GitHub Actions workflows (ruby.yml and gem-publish.yml) to run RBS validation as part of the CI process. [1] [2]

Type Signature Files:

Added RBS files for core classes and modules, including Twiglet::Logger, Twiglet::Formatter, Twiglet::Validator, Twiglet::Message, and Twiglet::ErrorSerialiser, as well as for utility modules and external dependencies (hash_extensions.rbs, json-schema.rbs). [1] [2] [3] [4] [5] [6] [7]
Added a manifest.yaml listing RBS dependencies for development and standard library usage.
Added an RBS file for the Twiglet::VERSION constant.

- Introduced RBS type validation in CI workflows. - Added RBS validation task in Rakefile. - Created RBS type signatures for various modules and classes. - Updated gemspec to include RBS as a development dependency.

Copilot

Pull request overview

This pull request introduces RBS (Ruby Signature) type checking to enhance type safety and documentation. However, the PR contains critical issues in the gem-publish.yml workflow that appear to be unintended changes unrelated to RBS integration.

Key Changes:

Added RBS type signature files for core classes (Logger, Formatter, Validator, Message, ErrorSerialiser) and dependencies
Integrated RBS validation into CI workflows and Rakefile
Added rbs as a development dependency in gemspec

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
twiglet.gemspec	Added `rbs` as a development dependency
sig/twiglet/version.rbs	Type signature for VERSION constant
sig/twiglet/validator.rbs	Type signatures for Validator class
sig/twiglet/message.rbs	Type signatures for Message class
sig/twiglet/logger.rbs	Type signatures for Logger class methods and initialization
sig/twiglet/formatter.rbs	Type signatures for Formatter class
sig/twiglet/error_serialiser.rbs	Type signatures for ErrorSerialiser class
sig/manifest.yaml	Lists RBS dependencies for standard library usage
sig/json-schema.rbs	Type stubs for json-schema gem
sig/hash_extensions.rbs	Type signatures for HashExtensions module
Rakefile	Added rake task to validate RBS type signatures
.github/workflows/ruby.yml	Added RBS validation step to CI
.github/workflows/gem-publish.yml	Added RBS validation; contains critical breaking changes to build job

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-30T13:39:19Z

sig/twiglet/logger.rbs

+      **untyped args
+    ) -> void
+
+    def configure_validation_error_response: () { (JSON::Schema::ValidationError) -> void } -> void


The return type for configure_validation_error_response should be void rather than having a block that returns void. The method itself doesn't return a meaningful value, it just sets the custom error handler. The correct signature should be def configure_validation_error_response: () { (JSON::Schema::ValidationError) -> untyped } -> void.

Suggested change

def configure_validation_error_response: () { (JSON::Schema::ValidationError) -> void } -> void

def configure_validation_error_response: () { (JSON::Schema::ValidationError) -> untyped } -> void

Copilot · 2025-12-30T13:39:20Z

.github/workflows/gem-publish.yml


  build:
    name: Build and Publish
    runs-on: ubuntu-latest


The build job is missing the needs: test dependency that was removed in this PR. This means the build job will run in parallel with tests rather than waiting for tests to pass first. This could result in publishing a gem even if tests or RBS validation fail.

Suggested change

runs-on: ubuntu-latest

runs-on: ubuntu-latest

needs: test

.github/workflows/gem-publish.yml

Copilot · 2025-12-30T13:39:21Z

.github/workflows/gem-publish.yml

      - uses: actions/checkout@v5
      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:


The ruby-version: .ruby-version configuration was removed from the setup-ruby action. This means the build job will use a default Ruby version rather than the project's specified version, which could lead to compatibility issues during gem building and publishing.

Suggested change

with:

with:

ruby-version: .ruby-version

.github/workflows/gem-publish.yml

Copilot · 2025-12-30T13:39:22Z

sig/twiglet/validator.rbs

@@ -0,0 +1,11 @@
+module Twiglet
+  class Validator
+    attr_accessor custom_error_handler: ^(JSON::Schema::ValidationError) -> void


The type signature for custom_error_handler is incorrect. Looking at the implementation in lib/twiglet/validator.rb, the custom error handler is initialized as a lambda that takes an exception and either raises it or performs custom logic, but it doesn't have a void return type constraint. The handler can have any return value. The correct signature should be ^(JSON::Schema::ValidationError) -> untyped instead of ^(JSON::Schema::ValidationError) -> void.

Suggested change

attr_accessor custom_error_handler: ^(JSON::Schema::ValidationError) -> void

attr_accessor custom_error_handler: ^(JSON::Schema::ValidationError) -> untyped

…improved functionality

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…CI workflows to use Ruby 3.2 and above

addersuk · 2025-12-30T15:16:14Z

/dobby version minor

Copilot

Pull request overview

Copilot reviewed 17 out of 18 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-30T15:22:05Z

.github/workflows/gem-publish.yml

+      - uses: actions/checkout@v6
      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:


The ruby-version: .ruby-version line has been removed from the build job setup. This means the build job will now use the default Ruby version provided by the runner instead of the project's specified Ruby version in .ruby-version. This could lead to building the gem with a different Ruby version than intended. Consider restoring this configuration or explicitly specifying the Ruby version.

Suggested change

with:

with:

ruby-version: .ruby-version

Copilot · 2025-12-30T15:22:05Z

sig/twiglet/message.rbs

+  class Message < Hash[Symbol, untyped]
+    def initialize: (String | Hash[untyped, untyped] | nil msg) -> void


The Message class inherits from Hash[Symbol, untyped] in the RBS signature, but in the actual implementation (lib/twiglet/message.rb), it inherits from just Hash without type parameters. Additionally, the initialize method can accept nil and will call super for the nil case, which doesn't match the documented behavior in the signature. The signature should more accurately reflect that when msg is nil, the behavior delegates to Hash's default initialize.

Suggested change

class Message < Hash[Symbol, untyped]

def initialize: (String | Hash[untyped, untyped] | nil msg) -> void

class Message < Hash[untyped, untyped]

def initialize: () -> void

| (String | Hash[untyped, untyped] | nil msg) -> void

Copilot · 2025-12-30T15:22:06Z

.github/workflows/gem-publish.yml

+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}


The publish step uses a manual gem build and push approach instead of using the official rubygems/release-gem action that was presumably used before. While this can work, the manual approach requires managing credentials directly and is more error-prone. Additionally, building without specifying a Ruby version (due to the removal of the ruby-version configuration) could lead to inconsistencies. Consider using the official action or ensuring the Ruby version is explicitly set.

Copilot · 2025-12-30T15:22:06Z

sig/twiglet/logger.rbs

+    def debug: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true
+    def info: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true
+    def warn: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true
+    def error: (?String | Exception | nil message_or_error, ?Exception? error) ?{ () -> (String | Hash[untyped, untyped]) } -> true


The return type for the error method signature is inconsistent with the actual implementation. Looking at the implementation in lib/twiglet/logger.rb, the error method calls super(message, &) which returns the result from the parent ::Logger#error method. The parent Logger class's error method can return different values depending on the logger's state, not just true. The same issue applies to debug, info, and warn methods.

Suggested change

def debug: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true

def info: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true

def warn: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true

def error: (?String | Exception | nil message_or_error, ?Exception? error) ?{ () -> (String | Hash[untyped, untyped]) } -> true

def debug: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> untyped

def info: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> untyped

def warn: (?String | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> untyped

def error: (?String | Exception | nil message_or_error, ?Exception? error) ?{ () -> (String | Hash[untyped, untyped]) } -> untyped

Copilot · 2025-12-30T15:22:06Z

twiglet.gemspec

  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'simplecov', '0.17.1'
+  gem.add_development_dependency 'rbs'
+  gem.add_development_dependency 'simplecov'


The version constraint for SimpleCov has been removed. The previous version was pinned to 0.17.1. If this unpinning is intentional, it's acceptable, but be aware that this may introduce breaking changes if SimpleCov has released versions with incompatible APIs since 0.17.1. Consider verifying that the latest SimpleCov version is compatible with the test suite.

Suggested change

gem.add_development_dependency 'simplecov'

gem.add_development_dependency 'simplecov', '0.17.1'

Copilot · 2025-12-30T15:22:07Z

twiglet.gemspec


  gem.require_paths         = ['lib']
-  gem.required_ruby_version = ['>= 3.1 ', '< 3.5']
+  gem.required_ruby_version = ['>= 3.2 ', '< 3.5']


The minimum Ruby version requirement has been changed from >= 3.1 to >= 3.2. This is a breaking change that will prevent users on Ruby 3.1 from using this version of the gem. Ensure this change is documented in the changelog and that the version bump to 3.15.0 follows semantic versioning guidelines (this should likely be a major version bump if Ruby 3.1 support is being dropped).

Suggested change

gem.required_ruby_version = ['>= 3.2 ', '< 3.5']

gem.required_ruby_version = ['>= 3.1', '< 3.5']

Add RBS type validation and related dependencies

9e4f512

- Introduced RBS type validation in CI workflows. - Added RBS validation task in Rakefile. - Created RBS type signatures for various modules and classes. - Updated gemspec to include RBS as a development dependency.

Copilot AI review requested due to automatic review settings December 30, 2025 13:36

addersuk requested a review from a team as a code owner December 30, 2025 13:36

Copilot started reviewing on behalf of addersuk December 30, 2025 13:36 View session

Fix indentation in logger context provider for improved readability

98eb4e0

Copilot AI reviewed Dec 30, 2025

View reviewed changes

addersuk and others added 6 commits December 30, 2025 14:22

Upgrade actions/checkout to v6 in workflow files for consistency and …

4a3d4ce

…improved functionality

Update .github/workflows/gem-publish.yml

a76cb6e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Add fail-fast strategy to Ruby CI workflow for improved job management

021a2a2

Add minitest-mock as a development dependency in gemspec

1a9c9ef

Update Ruby version requirements and dependencies in gemspec; adjust …

a52dec4

…CI workflows to use Ruby 3.2 and above

Update TargetRubyVersion to 3.2 in .rubocop.yml for compatibility

3f970e0

Bump minor version

1f89838

addersuk requested a review from Copilot December 30, 2025 15:17

Copilot started reviewing on behalf of addersuk December 30, 2025 15:18 View session

Copilot AI reviewed Dec 30, 2025

View reviewed changes

FrancescaRodricks approved these changes Dec 30, 2025

View reviewed changes

addersuk merged commit edec111 into master Dec 30, 2025
14 checks passed

addersuk deleted the rbs-types branch December 30, 2025 15:32

	def configure_validation_error_response: () { (JSON::Schema::ValidationError) -> void } -> void
	def configure_validation_error_response: () { (JSON::Schema::ValidationError) -> untyped } -> void

	attr_accessor custom_error_handler: ^(JSON::Schema::ValidationError) -> void
	attr_accessor custom_error_handler: ^(JSON::Schema::ValidationError) -> untyped

		class Message < Hash[Symbol, untyped]
		def initialize: (String \| Hash[untyped, untyped] \| nil msg) -> void

-  class Message < Hash[Symbol, untyped]
-    def initialize: (String | Hash[untyped, untyped] | nil msg) -> void
+  class Message < Hash[untyped, untyped]
+    def initialize: () -> void
+                   | (String | Hash[untyped, untyped] | nil msg) -> void

	gem.add_development_dependency 'simplecov'
	gem.add_development_dependency 'simplecov', '0.17.1'

	gem.required_ruby_version = ['>= 3.2 ', '< 3.5']
	gem.required_ruby_version = ['>= 3.1', '< 3.5']

Add RBS type validation and related dependencies #113

Add RBS type validation and related dependencies #113

Uh oh!

Conversation

addersuk commented Dec 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

addersuk commented Dec 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants