Conversation
There was a problem hiding this comment.
Pull request overview
This PR modernizes the kramdown_rpf gem by upgrading Ruby and dependency requirements, refactoring tests to follow RSpec best practices, and adopting the Raspberry Pi Foundation's centralized code style configuration.
Changes:
- Upgraded Ruby requirement from unspecified to >= 3.2.0
- Updated kramdown from ~> 1.2 to ~> 2.5 and added kramdown-parser-gfm dependency explicitly
- Refactored test files to eliminate constants in favor of
letblocks and replacedbefore(:all)withbefore - Moved development dependencies from gemspec to Gemfile following modern gem conventions
- Adopted RPF Digital Products team's centralized RuboCop configuration via remote URLs
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| kramdown_rpf.gemspec | Updated Ruby version requirement, upgraded kramdown to 2.5+, added kramdown-parser-gfm, removed version pins from i18n and rexml, moved dev dependencies to Gemfile, updated team name |
| Gemfile | Moved development dependencies (rake, rspec, rubocop suite) from gemspec to development group |
| lib/kramdown_rpf.rb | Removed redundant kramdown require (now loaded via kramdown_rpf/kramdown.rb) |
| lib/kramdown_rpf/kramdown.rb | Added explicit require for kramdown/parser/gfm to support kramdown 2.x |
| spec/kramdown_rpf_spec.rb | Refactored tests: converted KRAMDOWN_OPTIONS constant to inline options, changed conversion_tests from constant to local variable, restructured test using subject and let, changed be nil to be_nil, updated test descriptions |
| spec/i18n_spec.rb | Converted KRAMDOWN_OPTIONS constant to let block, changed constants to local variables, replaced before(:all) with before, updated test descriptions |
| spec/errors_spec.rb | Converted KRAMDOWN_OPTIONS constant to let block, moved I18n setup to before block, updated test descriptions |
| spec/spec_helper.rb | Removed byebug require (no longer a development dependency) |
| .rubocop.yml | Configured to inherit from RPF Digital Products team's remote style configs (base, performance, rspec) |
| .rubocop_todo.yml | Regenerated to reflect resolved offenses from test refactoring (removed Lint/ConstantDefinitionInBlock, Gemspec violations, BlockLength, MethodLength, and Style/Documentation issues) |
| .gitignore | Added /vendor/ directory and .rubocop-http* files for downloaded remote configs |
| .github/workflows/ci.yml | Added trigger for version tags (v*) and fixed indentation of GitHub Release creation step |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a general update of Kramdown RPF: