# Rubocop::Ruby22
See the intro [blog post](https://dev.to/pboling/rubocop-ruby-matrix-gems-nj)!
This gem requires no other gems. It depends on `rubocop`, but does not `require 'rubocop'`.
Awareness of `rubocop`'s lack of [SemVer][semver] adherence isn't evenly dispersed in the Ruby community.
The Rubocop team [has real reasons](https://github.com/semver/semver/issues/317)
for [not following SemVer](https://github.com/rubocop/rubocop/issues/4243), 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](https://semver.org/) (Semantic Versioning) way that aligns with the the desired minimum
compatible/supported Ruby version.
Adding this gem will facilitate the best practice of adding a `~> ` version constrained `rubocop` dependency, while
minimiszing the risk of a rubocop minor / patch upgrade breaking the build. See the
official [compatibility matrix](https://github.com/rubocop/rubocop/blob/master/docs/modules/ROOT/pages/compatibility.adoc#support-matrix) (Rubocop documentation)
## Stable
All releases of this gem are stable releases. The first version is `1.0.0`.
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add rubocop-ruby2_2 -r false
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install rubocop-ruby2_2
## 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 configuration file:
```yaml
inherit_gem:
rubocop-ruby2_2: rubocop.yml
```
This has the same effect as you declaring the following in your `.rubocop.yml`:
```yaml
AllCops:
# remove if already present in your `.rubocop.yml` to gain the full benefit of this gem!
TargetRubyVersion: 2.2
NewCops: enable
```
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
You may not use this setting in your project yet. Upgrades to the latest Rubocop can include all kinds of changes, including removing support for the version of Ruby your project uses, or adding a cop that may not work with some of your syntax (e.g. [some use cases of 'module_function`](https://github.com/rubocop/rubocop/issues/5953#issuecomment-805921993)). Accepting new cops arriving in a new version of Rubocop can feel risky, especially when it doesn't follow SemVer.
But this gem shoehorns rubocop into SemVer... so `NewCops` is now safe(r)! If you use a dependency greening tool like GitHub's `dependabot`, or the excellent alternatives [depfu](https://depfu.com/), and [`renovate`](https://www.whitesourcesoftware.com/free-developer-tools/renovate/), then you can see the effect of a minor / major version bumpin your CI Build!
## 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](https://rubygems.org).
## Contributing
See [CONTRIBUTING.md][contributing]
## Contributors
[]("https://github.com/rubocop-semver/rubocop-ruby2_2/graphs/contributors")
Made with [contributors-img](https://contrib.rocks).
## License
The gem is available as open source under the terms of
the [MIT License][license] [][license-ref].
See [LICENSE][license] for the official [Copyright Notice][copyright-notice-explainer].
* Copyright (c) 2022 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
[copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
## Code of Conduct
Everyone interacting in the Rubocop::Ruby22 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubocop-semver/rubocop-ruby2_2/blob/main/CODE_OF_CONDUCT.md).
## Versioning
This library aims to adhere to [Semantic Versioning 2.0.0][semver]. 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][pvc] with two digits of precision.
For example:
```ruby
spec.add_dependency "rubocop-ruby2_2", "~> 0.1"
```
[copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
[gh_discussions]: https://github.com/rubocop-semver/rubocop-ruby2_2/discussions
[conduct]: https://github.com/rubocop-semver/rubocop-ruby2_2/blob/main/CODE_OF_CONDUCT.md
[contributing]: https://github.com/rubocop-semver/rubocop-ruby2_2/blob/main/CONTRIBUTING.md
[security]: https://github.com/rubocop-semver/rubocop-ruby2_2/blob/main/SECURITY.md
[license]: https://github.com/rubocop-semver/rubocop-ruby2_2/blob/main/LICENSE.txt
[license-ref]: https://opensource.org/licenses/MIT
[semver]: http://semver.org/
[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
[railsbling]: http://www.railsbling.com
[peterboling]: http://www.peterboling.com
[aboutme]: https://about.me/peter.boling
[angelme]: https://angel.co/peter-boling
[coderme]:http://coderwall.com/pboling
[followme-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
[tweetme]: http://twitter.com/galtzo
[politicme]: https://nationalprogressiveparty.org
[documentation]: https://rubydoc.info/github/rubocop-semver/rubocop-ruby2_2/main
[source]: https://github.com/rubocop-semver/rubocop-ruby2_2/
[actions]: https://github.com/rubocop-semver/rubocop-ruby2_2/actions
[issues]: https://github.com/rubocop-semver/rubocop-ruby2_2/issues
[climate_maintainability]: https://codeclimate.com/github/rubocop-semver/rubocop-ruby2_2/maintainability
[code_triage]: https://www.codetriage.com/rubocop-semver/rubocop-ruby2_2
[blogpage]: http://www.railsbling.com/tags/rubocop-ruby2_2/
[rubygems]: https://rubygems.org/gems/rubocop-ruby2_2
[chat]: https://gitter.im/rubocop-semver/rubocop-ruby2_2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[maintenancee_policy]: https://guides.rubyonrails.org/maintenance_policy.html#security-issues
[liberapay_donate]: https://liberapay.com/pboling/donate
[gh_sponsors]: https://github.com/sponsors/pboling