Project

caliber

0.0
A long-lived project that still receives updates
A global, high quality, and constantly updated RuboCop configuration.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Project Readme

Caliber

This gem provides global RuboCop configurations for ensuring high quality and consistent software development practices.

Due to the ever changing nature of the RuboCop ecosystem — and the fact you can fall behind quickly — this gem takes an aggressive approach to staying atop the latest changes. This also means this gem might never reach Version 1.0.0 because new — often breaking — changes are being introduced in each minor release. That said, if you always want to keep pace with recent changes — because you know how costly technical debt is — then this gem has you covered. 🎉

Table of Contents
  • Features
  • Requirements
  • Setup
  • Usage
    • Customization
    • Requirements
    • Inheritance
    • Coexistence
    • Command Line Interface (CLI)
  • Development
    • Check
  • Tests
  • License
  • Security
  • Code of Conduct
  • Contributions
  • Versions
  • Community
  • Credits

Features

Requirements

Setup

To install with security, run:

# 💡 Skip this line if you already have the public certificate installed.
gem cert --add <(curl --compressed --location https://alchemists.io/gems.pem)
gem install caliber --trust-policy HighSecurity

To install without security, run:

gem install caliber

You can also add the gem directly to your project:

bundle add caliber

Usage

This gem is designed to replace all of your RuboCop setup with only a single reference to this gem. You’ll want to start with your Gemfile by adding the following:

group :quality do
  gem "caliber"
end

Then, in your .rubocop.yml, add the following to the top of the file:

inherit_gem:
  caliber: config/all.yml

That’s it!

Customization

You can customize the gem by specifying what you need:

inherit_gem:
  caliber:
    - config/ruby.yml
    - config/capybara.yml
    - config/disable_syntax.yml
    - config/packaging.yml
    - config/performance.yml
    - config/thread.yml
    - config/rake.yml
    - config/rspec.yml

The above is what config/all.yml expands to but now you can mix and match how you like for your specific needs.

Requirements

When Caliber is added to your Gemfile, you don’t have to require RuboCop because Caliber does that for you by default. All RuboCop dependencies are also automatically required because they are defined in each configuration. Here’s a full breakdown of how this works:

inherit_gem:
  caliber:
    - config/all.yml

The above will require and load the configurations for following gems:

When you don’t use the default all.yml configuration, then behavior changes as follows:

Ruby

inherit_gem:
  caliber:
    - config/ruby.yml

The above will only load the RuboCop Ruby configuration. No further requirements are necessary since Caliber already requires the RuboCop gem by default.

Capybara

inherit_gem:
  caliber:
    - config/capybara.yml

The above will only require the RuboCop Capybara gem and load the associated configuration.

💡 This is a dependency of RuboCop RSpec so doesn’t need to be directly required if already requiring RuboCop RSpec.

Disable Syntax

inherit_gem:
  caliber:
    - config/disable_syntax.yml

The above will only require the RuboCop Disable Syntax gem and load the associated configuration.

Packaging

inherit_gem:
  caliber:
    - config/packaging.yml

The above will only require the RuboCop Packaging gem and load the associated configuration.

Performance

inherit_gem:
  caliber:
    - config/peformance.yml

The above will only require the RuboCop Performance gem and load the associated configuration.

Thread Safety

inherit_gem:
  caliber:
    - config/thread.yml

The above will only require the RuboCop Thread Safety gem and load the associated configuration.

Rake

inherit_gem:
  caliber:
    - config/rake.yml

The above will only require the RuboCop Rake gem and load the associated configuration.

RSpec

inherit_gem:
  caliber:
    - config/rspec.yml

The above will only require the RuboCop RSpec gem and load the associated configuration.

Inheritance

Should you not want to include this gem in your project for some reason, you can directly inherit the configuration files supported by this project instead. To do this, you’ll need to add the following to the top of your .rubocop.yml:

inherit_from:
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/all.yml

You’ll also want to add .rubocop-https* to your project’s .gitignore since imported RuboCop YAML configurations will be cached locally and you’ll not want them checked into your source code repository.

If importing all configurations from all.yml is too much — and much like you can do with requiring this gem directly — you can mix and match what you want to import by defining which configurations you want to use. For example, the following is what all.yml expands too:

inherit_from:
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/ruby.yml
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/capybara.yml
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/disable_syntax.yml
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/packaging.yml
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/performance.yml
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/thread.yml
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/rake.yml
  - https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/rspec.yml

You can also target a specific version of this gem by swapping out the main path in the YAML URLs listed above with a specific version like 0.0.0.

Lastly, when using this YAML import approach, you’ll not benefit from having all gems you need required and installed for you. So you’ll need to manually require these gems in your Gemfile:

Coexistence

In situations where you’d like to use Caliber alongside additional RuboCop gems, you only need to add the new gems to your Gemfile and then require them within your .rubocop.yml. For example, let’s say you wanted to use both the Caliber and RuboCop Markdown gems together. Here is how you can use both by updating your .rubocop.yml (assuming your Gemfile was updated as well):

inherit_gem:
  caliber: config/all.yml

require:
  - rubocop-md

Adding additional RuboCop gems only requires adding them to your YAML configuration.

Command Line Interface (CLI)

⚠️ This is experimental but might be of interest to anyone using RuboCop’s local XDG Base Directory Specification (highly recommend).

At the moment, RuboCop doesn’t have native functionality for handling these updates and this CLI is one solution to that problem (see this issue for details). So this CLI automates the updating of outstanding issues you have not resolved for your RuboCop configuration (i.e. .rubocop_todo.yml) and is handy when you’ve fixed issues and want to update your configuration to reflect these changes. The CLI assumes you are using the following structure:

.config/rubocop/config.yml
.config/rubocop/issues.yml

…​and that you have this line in .config/rubocop/config.yml:

inherit_from: issues.yml

Assuming the above is true, you can run the caliber CLI and follow the prompts for either updating your outstanding issues or exiting. Upon competition, the CLI will update your .config/rubocop/issues.yml so you can commit these updates/changes to your repository.

Development

To contribute, run:

git clone https://github.com/bkuhlmann/caliber
cd caliber
bin/setup

You can also use the IRB console for direct access to all objects:

bin/console

Check

Use the bin/check script — when upgrading to newer RuboCop gem dependencies — to check if duplicate configurations exist. This ensures Caliber configurations don’t duplicate effort provided by RuboCop. The script only identifies duplicate Caliber configurations which are enabled and have no other settings.

When both RuboCop and Caliber are in sync, the following will be output:

RUBY: ✓
CAPYBARA: ✓
DISABLE_SYNTAX: ✓
PACKAGING: ✓
PERFORMANCE: ✓
THREAD: ✓
RAKE: ✓
RSPEC: ✓

When RuboCop has finally enabled cops that Caliber already has enabled, the following will display as an example:

RUBY:
* Lint/BinaryOperatorWithIdenticalOperands
* Lint/ConstantDefinitionInBlock
CAPYBARA: ✓
DISABLE_SYNTAX: ✓
PACKAGING: ✓
PERFORMANCE: ✓
THREAD: ✓
RAKE: ✓
RSPEC:
* RSpec/StubbedMock

The above can then be used as a checklist to remove from Caliber.

Tests

To test, run:

bin/rake

Credits