appraisal-rb Logo by GitHub

๐Ÿ’Ž Appraisal2::Rubocop

Version Ruby Users Forum GitHub tag (latest SemVer) License: MIT Total downloads CodeCov Test Coverage Coveralls Test Coverage QLTY Test Coverage QLTY Maintainability CI Heads CI Runtime Dependencies @ HEAD CI Current CI Truffle Ruby CI JRuby Deps Locked Deps Unlocked CI Test Coverage CI Style Apache SkyWalking Eyes License Compatibility Check

if ci_badges.map(&:color).detect { it != "green"} โ˜๏ธ let me know on Discord or RubyForum, as I may have missed the notification.


if ci_badges.map(&:color).all? { it == "green"} ๐Ÿ‘‡๏ธ send money so I can do more of this. FLOSS maintenance is now my full-time job.

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate at ko-fi.com

๐Ÿ‘ฃ How will this project approach the September 2025 hostile takeover of RubyGems? ๐Ÿš‘๏ธ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).

๐ŸŒป Synopsis Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0 ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5

Runs RuboCop against Appraisal2-generated gemfiles via Appraisal2 lifecycle hooks.

This plugin is intended for modern Ruby style-maintenance environments. It does not match Appraisal2's legacy runtime floor.

Load it as an Appraisal2 generator plugin, and make its RuboCop toolchain available only to the generator bundle.

๐Ÿ’ก Info you can shake a stick at

Tokens to Remember Gem name Gem namespace
Works with JRuby JRuby 9.4 Compat JRuby 10.0 Compat JRuby current Compat JRuby HEAD Compat
Works with Truffle Ruby Truffle Ruby 23.1 Compat
Truffle Ruby 24.2 Compat Truffle Ruby 25.0 Compat Truffle Ruby 33.0 Compat Truffle Ruby current Compat Truffle Ruby HEAD Compat
Works with MRI Ruby 4 Ruby current Compat Ruby HEAD Compat
Works with MRI Ruby 3 Ruby 3.1 Compat Ruby 3.2 Compat Ruby 3.3 Compat Ruby 3.4 Compat
Support & Community Join Me on Daily.dev's RubyFriends Get help from RubyForum Live Chat on Discord Get help from me on Upwork Get help from me on Codementor
Source Source on GitLab.com Source on CodeBerg.org Source on GitHub.com The best SHA: dQw4w9WgXcQ!
Documentation Current release on RubyDoc.info YARD on Galtzo.com Maintainer Blog GitLab Wiki GitHub Wiki
Compliance License: MIT Apache license compatibility: Category A ๐Ÿ“„ilo-declaration-img Security Policy Contributor Covenant 2.1 SemVer 2.0.0
Style Enforced Code Style Linter Keep-A-Changelog 1.0.0 Gitmoji Commits Compatibility appraised by: appraisal2
Maintainer ๐ŸŽ–๏ธ Follow Me on LinkedIn Follow Me on Ruby.Social Follow Me on Bluesky Contact Maintainer My technical writing
... ๐Ÿ’– Find Me on WellFound: Find Me on CrunchBase My LinkTree More About Me ๐ŸงŠ ๐Ÿ™ ๐Ÿ›– ๐Ÿงช

Compatibility

Compatible with MRI Ruby 3.1.0+, JRuby, and TruffleRuby. CI workflows and Appraisals are generated for MRI Ruby 3.1.0+. This test floor is configured by ruby.test_minimum in .kettle-jem.yml and may be higher than the gem's runtime compatibility floor when legacy Rubies are not practical for the current toolchain.

kettle-dev Logo by Aboling0, CC BY-SA 4.0

The amazing test matrix is powered by the kettle-dev stack.

How kettle-dev manages complexity in tests | Gem | Source | Role | Total downloads | |-----|--------|------|---------------------| | [appraisal2](https://clickgems.clickhouse.com/dashboard/appraisal2) | [GitHub](https://github.com/appraisal-rb/appraisal2) | multi-dependency Appraisal matrix generation | [![Total downloads for appraisal2](https://img.shields.io/gem/dt/appraisal2.svg?style=flat-square)](https://clickgems.clickhouse.com/dashboard/appraisal2) | | [kettle-dev](https://clickgems.clickhouse.com/dashboard/kettle-dev) | [GitHub](https://github.com/kettle-dev/kettle-dev) | development, release, and CI workflow tooling | [![Total downloads for kettle-dev](https://img.shields.io/gem/dt/kettle-dev.svg?style=flat-square)](https://clickgems.clickhouse.com/dashboard/kettle-dev) | | [kettle-jem](https://clickgems.clickhouse.com/dashboard/kettle-jem) | [GitHub](https://github.com/kettle-dev/kettle-jem) | Appraisals & CI workflow templates | [![Total downloads for kettle-jem](https://img.shields.io/gem/dt/kettle-jem.svg?style=flat-square)](https://clickgems.clickhouse.com/dashboard/kettle-jem) | | [kettle-soup-cover](https://clickgems.clickhouse.com/dashboard/kettle-soup-cover) | [GitHub](https://github.com/kettle-dev/kettle-soup-cover) | SimpleCov coverage policy and reporting | [![Total downloads for kettle-soup-cover](https://img.shields.io/gem/dt/kettle-soup-cover.svg?style=flat-square)](https://clickgems.clickhouse.com/dashboard/kettle-soup-cover) | | [kettle-test](https://clickgems.clickhouse.com/dashboard/kettle-test) | [GitHub](https://github.com/kettle-dev/kettle-test) | standard test runner and coverage harness | [![Total downloads for kettle-test](https://img.shields.io/gem/dt/kettle-test.svg?style=flat-square)](https://clickgems.clickhouse.com/dashboard/kettle-test) | | [rubocop-lts](https://clickgems.clickhouse.com/dashboard/rubocop-lts) | [GitHub](https://github.com/rubocop-lts/rubocop-lts) | Ruby-version-aware linting | [![Total downloads for rubocop-lts](https://img.shields.io/gem/dt/rubocop-lts.svg?style=flat-square)](https://clickgems.clickhouse.com/dashboard/rubocop-lts) | | [turbo_tests2](https://clickgems.clickhouse.com/dashboard/turbo_tests2) | [GitHub](https://github.com/galtzo-floss/turbo_tests2) | parallel test execution | [![Total downloads for turbo_tests2](https://img.shields.io/gem/dt/turbo_tests2.svg?style=flat-square)](https://clickgems.clickhouse.com/dashboard/turbo_tests2) |

Federated DVCS

Find this repo on federated forges (Coming soon!) | Federated [DVCS][๐Ÿ’Žd-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | |-------------------------------------------------|-------------------------------------------|-------------------|------------------|-----------------|----------------| | ๐Ÿงช [appraisal-rb/appraisal2-rubocop on GitLab][๐Ÿ“œsrc-gl] | The Truth | [๐Ÿ’š][๐Ÿคgl-issues] | [๐Ÿ’š][๐Ÿคgl-pulls] | [๐Ÿ’š][๐Ÿ“œgl-wiki] | ๐Ÿญ Tiny Matrix | | ๐ŸงŠ [appraisal-rb/appraisal2-rubocop on CodeBerg][๐Ÿ“œsrc-cb] | An Ethical Mirror ([Donate][๐Ÿคcb-donate]) | [๐Ÿ’š][๐Ÿคcb-issues] | [๐Ÿ’š][๐Ÿคcb-pulls] | โž– | โญ•๏ธ No Matrix | | ๐Ÿ™ [appraisal-rb/appraisal2-rubocop on GitHub][๐Ÿ“œsrc-gh] | Another Mirror | [๐Ÿ’š][๐Ÿคgh-issues] | [๐Ÿ’š][๐Ÿคgh-pulls] | [๐Ÿ’š][๐Ÿ“œgh-wiki] | ๐Ÿ’ฏ Full Matrix |

Enterprise Support

Tidelift

Available as part of the Tidelift Subscription.

Need enterprise-level guarantees? The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [![Get help from me on Tidelift][๐Ÿ™๏ธentsup-tidelift-img]][๐Ÿ™๏ธentsup-tidelift] - ๐Ÿ’กSubscribe for support guarantees covering _all_ your FLOSS dependencies - ๐Ÿ’กTidelift is part of [Sonar][๐Ÿ™๏ธentsup-tidelift-sonar] - ๐Ÿ’กTidelift pays maintainers to maintain the software you depend on!
๐Ÿ“Š`@`Pointy Haired Boss: An [enterprise support][๐Ÿ™๏ธentsup-tidelift] subscription is "[never gonna let you down][๐Ÿงฎkloc]", and *supports* open source maintainers Alternatively: - [![Ruby Users Forum][โœ‰๏ธruby-forum-img]][โœ‰๏ธruby-forum] - [![Live Chat on Discord][โœ‰๏ธdiscord-invite-img-ftb]][โœ‰๏ธdiscord-invite] - [![Get help from me on Upwork][๐Ÿ‘จ๐Ÿผโ€๐Ÿซexpsup-upwork-img]][๐Ÿ‘จ๐Ÿผโ€๐Ÿซexpsup-upwork] - [![Get help from me on Codementor][๐Ÿ‘จ๐Ÿผโ€๐Ÿซexpsup-codementor-img]][๐Ÿ‘จ๐Ÿผโ€๐Ÿซexpsup-codementor]

โœจ Installation

Install the gem and add to the application's Gemfile by executing:

bundle add appraisal2-rubocop

If bundler is not being used to manage dependencies, install the gem by executing:

gem install appraisal2-rubocop

โš™๏ธ Configuration

  • APPRAISAL2_RUBOCOP=false disables the hook.
  • APPRAISAL2_RUBOCOP_COMMAND overrides the executable.
  • APPRAISAL2_RUBOCOP_FLAGS overrides the default --autocorrect flag list.

๐Ÿ”ง Basic Usage

Add the plugin to the style toolchain used by the Appraisal root bundle:

# gemfiles/modular/style.gemfile
gem "appraisal2-rubocop", "~> 0.1", ">= 0.1.0", require: false

Expose that style toolchain only to the Appraisal generator bundle:

# Appraisal.root.gemfile
if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.2")
  if respond_to?(:generator_only)
    generator_only do
      eval_gemfile "gemfiles/modular/style.gemfile"
    end
  else
    eval_gemfile "gemfiles/modular/style.gemfile"
  end
end

The respond_to?(:generator_only) split is for the two DSLs that read this file: Appraisal2 uses the generator_only block when building generated appraisal gemfiles, while Bundler evaluates the same file to install the generator bundle.

Load the plugin from Appraisals:

plugin "appraisal2-rubocop", require: "appraisal2/rubocop", optional: true

By default each generated gemfile is processed in memory with:

rubocop --stdin path/to/generated.gemfile --autocorrect --stderr --format quiet
Field Value
Package appraisal2-rubocop
Description ๐Ÿ’Ž Appraisal2::Rubocop registers Appraisal2 generation hooks that run RuboCop against generated appraisal gemfiles.
Homepage https://github.com/appraisal-rb/appraisal2-rubocop
Source https://github.com/appraisal-rb/appraisal2-rubocop
License MIT
Funding https://github.com/sponsors/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/appraisal-rb, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/appraisal2-rubocop, https://www.buymeacoffee.com/pboling

๐Ÿฆท FLOSS Funding

While appraisal-rb tools are free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of... "dollars" would make the project more sustainable.

We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences. Currently, Open Collective is our preferred funding platform.

If you're working in a company that's making significant use of appraisal-rb tools we'd appreciate it if you suggest to your company to become a appraisal-rb sponsor.

You can support the development of appraisal-rb tools via GitHub Sponsors, Liberapay, PayPal, Open Collective and Tidelift.

๐Ÿ“ NOTE
If doing a sponsorship in the form of donation is problematic for your company
from an accounting standpoint, we'd recommend the use of Tidelift,
where you can get a support-like subscription instead.

Open Collective for Individuals

Support us with a monthly donation and help us continue our activities. [Become a backer]

NOTE: kettle-readme-backers updates this list every day, automatically.

No backers yet. Be the first!

Open Collective for Organizations

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

NOTE: kettle-readme-backers updates this list every day, automatically.

No sponsors yet. Be the first!

Another way to support open-source

Iโ€™m driven by a passion to foster a thriving open-source community โ€“ a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. Iโ€™m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 ๐Ÿ” chickens, 2 ๐Ÿถ dogs, 3 ๐Ÿฐ rabbits, 8 ๐Ÿˆโ€ cats).

If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.

Iโ€™m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.

Floss-Funding.dev: ๐Ÿ‘‰๏ธ No network calls. ๐Ÿ‘‰๏ธ No tracking. ๐Ÿ‘‰๏ธ No oversight. ๐Ÿ‘‰๏ธ Minimal crypto hashing. ๐Ÿ’ก Easily disabled nags

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate to my FLOSS efforts at ko-fi.com

๐Ÿ” Security

See SECURITY.md.

๐Ÿค Contributing

If you need some ideas of where to help, you could work on adding more code coverage, check issues or PRs, or use the gem and think about how it could be better.

We Keep A Changelog so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

๐Ÿš€ Release Instructions

See CONTRIBUTING.md.

Code Coverage

Coverage service badges [![Coverage Graph][๐Ÿ€codecov-g]][๐Ÿ€codecov] [![Coveralls Test Coverage][๐Ÿ€coveralls-img]][๐Ÿ€coveralls] [![QLTY Test Coverage][๐Ÿ€qlty-covi]][๐Ÿ€qlty-cov]

๐Ÿช‡ Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the Contributor Covenant 2.1.

๐ŸŒˆ Contributors

Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/appraisal-rb/appraisal2-rubocop/-/graphs/main

๐Ÿ“Œ Versioning

This library follows Semantic Versioning 2.0.0 for its public API where practical. For most applications, prefer the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("appraisal2-rubocop", "~> 1.0")
๐Ÿ“Œ Is "Platform Support" part of the public API? More details inside. Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind. To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer: - ["Major Version Numbers are Not Sacred"][๐Ÿ“Œmajor-versions-not-sacred]

See CHANGELOG.md for a list of releases.

๐Ÿ“„ License

The gem is available as open source under the terms of the MIT License: MIT.

See LICENSE.md for the official copyright notice.

Copyright holders - Copyright (c) 2026 Peter H. Boling

๐Ÿค‘ A request for help

Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March, and encountering difficulty finding a new one, I began spending most of my time building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.

To join the community or get help, use the RubyForum or Discord.

Ruby Users Forum Live Chat on Discord

To say "thanks!" โ˜๏ธ Join the community or ๐Ÿ‘‡๏ธ send money.

Sponsor appraisal-rb/appraisal2-rubocop on Open Source Collective ๐Ÿ’Œ Sponsor me on GitHub Sponsors ๐Ÿ’Œ Sponsor me on Liberapay ๐Ÿ’Œ Donate on PayPal

Please give the project a star โญ โ™ฅ.

Many parts of this project are actively managed by a kettle-jem smart template utilizing StructuredMerge.org merge contracts.

Thanks for RTFM. โ˜บ๏ธ