Rubocop::Ruby20
See the intro blog post!
This gem requires no other gems. It depends on rubocop
, but does not require 'rubocop'
.
Awareness of rubocop
's lack of SemVer adherence isn't evenly dispersed in the Ruby community.
The Rubocop team has real reasons
for not following SemVer, but if you've
found this project their reasons likely weigh less, in your context (e.g. running rubocop
from command line), than
what brought you here.
The purpose of this gem is to constrain the rubocop
dependency of a project in
a SemVer compliant (Semantic Versioning) way that aligns with the the desired minimum
compatible/supported Ruby version.
Ruby Version Support Matrix
Adding this gem will facilitate the best practice of adding a ~>
version constrained rubocop
dependency, while
minimizing the risk of a rubocop minor / patch upgrade breaking the build. See the
official compatibility matrix for rubocop
.
rubocop-ruby2_0
(this gem) will install on any version of Ruby >= 2.0, and can be used to analyze code intended to support Ruby >= 2.0.
- 🧊 - Install on Ruby
<version>
- 🏃 - Will Execute on Ruby
<version>
- 🪷 - Will not execute correctly on Ruby
<version>
- 🛠 - Lint code with Ruby
<version>
syntax as the target
gem | 1.8.7 | 1.9.3 | 2.0 | 2.1 | 2.2 | 2.3 | 2.4 | 2.5 | 2.6 | 2.7 | 3.0 | 3.1 | ruby-head | jruby-head |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rubocop-ruby1_9 | 🛠 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 |
rubocop-ruby2_0 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | ||
rubocop-ruby2_1 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | |||
rubocop-ruby2_2 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | ||||
rubocop-ruby2_3 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | |||||
rubocop-ruby2_4 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🪷 | 🧊 🪷 | 🧊 🪷 | ||||||
rubocop-ruby2_5 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🪷 | |||||||
rubocop-ruby2_6 | 🛠 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🪷 | |||||||
rubocop-ruby2_7 | 🛠 | 🛠 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | |||||||
rubocop-ruby3_0 | 🛠 | 🛠 | 🛠 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 | 🧊 🏃 | |||||||
rubocop-ruby3_1 | 🛠 | 🛠 | 🛠 | 🛠 | 🧊 🏃 🛠 | 🧊 🏃 | 🧊 🏃 |
🗿 Stable
All releases of this gem are stable releases. The first version is 1.0.0
.
✨ Installation
Without bundler execute:
$ gem install
Add this line to your application's Gemfile:
gem 'rubocop-ruby2_0', '~> 1.0', require: false
And then execute:
$ bundle
Or install it yourself as:
$ gem install rubocop-ruby2_0
🔧 Usage
The following is optional. We'll discuss why you might want to do this after you see what it does.
Add to the top of your project's .rubocop.yml
configuration file:
inherit_gem:
rubocop-ruby2_0: rubocop.yml
This has the same effect as you declaring the following in your .rubocop.yml
:
AllCops:
# remove if already present in your `.rubocop.yml` to gain the full benefit of this gem!
TargetRubyVersion: 2.0
# The sibling gems for newer versions of Ruby support the NewCops directive as soon as RuboCop adds it.
# NewCops: enable
Style/BracesAroundHashParameters:
Enabled: true
EnforcedStyle: context_dependent
Let's talk about these settings.
TargetRubyVersion
Allowing this gem to manage the target ruby version means you can switch to a different gem within the family when you upgrade to the next version of Ruby, and have nothing else to change. A single line in the Gemfile
, and you are done.
NewCops: enable
Commented out! Setting does not exist in the very old version of rubocop that works with Ruby 1.9.
If you want to use this you'll have to upgrade to Ruby >= 2.4 and use the appropriate sibling gem, e.g. rubocop-ruby2_4
.
Style/BracesAroundHashParameters
In an effort to help users of this gem prepare their code for more modern Rubies it has been enabled and configured with coontext_dependent
as the closest parallel to what will work with Ruby 2.7+, and also retain compatibility with old Ruby.
See:
NOTE: This cop was removed from RuboCop as of 0.80.0, so if you are on modern RuboCop and reading this for some reason, you can't use it.
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and the created tag, and push the .gem
file to rubygems.org.
⚡️ Contributing
See CONTRIBUTING.md
🌈 Contributors
Made with contributors-img.
📄 License
The gem is available as open source under the terms of the MIT License . See LICENSE for the official Copyright Notice.
Project Logos (rubocop-ruby3_1)
See [docs/images/logo/README.txt][project-logos]Organization Logo (rubocop-semver)
Author: [Yusuf Evli][org-logo-author] Source: [Unsplash][org-logo-source] License: [Unsplash License][org-logo-license]© Copyright
- Copyright (c) 2022 Peter H. Boling of Rails Bling
🤝 Code of Conduct
Everyone interacting in the Rubocop::Ruby20 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
📌 Versioning
This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.
As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision.
For example:
spec.add_dependency "rubocop-ruby2_0", "~> 1.0"