Skip to content

[ruby] Optimise Architecture of App#124

Merged
hayat01sh1da merged 3 commits into
masterfrom
hayat01sh1da/ruby/optimise-architecture-of-app
Jul 4, 2026
Merged

[ruby] Optimise Architecture of App#124
hayat01sh1da merged 3 commits into
masterfrom
hayat01sh1da/ruby/optimise-architecture-of-app

Conversation

@hayat01sh1da

@hayat01sh1da hayat01sh1da commented Jul 3, 2026

Copy link
Copy Markdown
Owner

1. Overview

This PR removes the only RuboCop override in ruby/.rubocop.yml and completes the project's RBS inline coverage.
The config excluded **/test/**/* from Style/Documentation because the sub-app test directories (e.g. fizzbuzz/test/) are not matched by RuboCop's default top-level test/**/* exclusion, so six test classes were flagged as missing top-level documentation.
Instead of keeping the exclusion, each of the six test classes now carries a one-line documentation comment, and the one test file that lacked the # rbs_inline: enabled magic comment (letter_matching_inspection/test/application_test.rb) received it, so every test file now participates in signature generation.

2. Key Changes & Differences

File Before After Changes & Differences
ruby/.rubocop.yml Style/Documentation: Exclude: '**/test/**/*' Plugins + AllCops only Patch deleted.
Six ruby/**/test/*_test.rb files No class comment One-line documentation comment per test class Resolves Style/Documentation in code.
ruby/letter_matching_inspection/test/application_test.rb No # rbs_inline: enabled magic comment Magic comment added The only test file previously outside rbs-inline's scope.
ruby/sig/generated/** No sig for the letter-matching test; other test sigs lacked the new doc comments letter_matching_inspection/test/application_test.rbs generated for the first time; five test sigs refreshed Regenerated with rbs-inline --output sig/generated/ ..

3. Summary

Comment-only changes plus regenerated signatures; no runtime behaviour is affected.
Verified with RuboCop 1.88.1 (16 files inspected, no offenses detected) and rbs-inline 0.14.0 regeneration.

Branch commits (newest first):

  • 4fad39d Articulate RBS inline types and regenerate signatures
  • 2b58093 Remove Style/Documentation RuboCop patch
  • 12de45d Add documentation comments to test classes

4. References

hayat01sh1da and others added 2 commits July 4, 2026 00:50
Satisfies Style/Documentation for the sub-app test directories, which fall outside RuboCop's default top-level test exclusion.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@hayat01sh1da hayat01sh1da force-pushed the hayat01sh1da/ruby/optimise-architecture-of-app branch from 88385dd to 2b58093 Compare July 3, 2026 15:57
@hayat01sh1da hayat01sh1da self-assigned this Jul 3, 2026
@hayat01sh1da hayat01sh1da changed the title Hayat01sh1da/ruby/optimise architecture of app [ruby] Optimise Architecture of App Jul 3, 2026
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@hayat01sh1da hayat01sh1da left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hayat01sh1da hayat01sh1da merged commit 79766f1 into master Jul 4, 2026
9 checks passed
@hayat01sh1da hayat01sh1da deleted the hayat01sh1da/ruby/optimise-architecture-of-app branch July 4, 2026 04:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant