This gem holds makandra's default Rubocop configuration. It is currently very relaxed, and will evolve over time.

Note that we lock each version on a specific Rubocop version, as Rubocop's syntax changes regularly.

Installation

Add this line to your application's Gemfile:

gem 'makandra-rubocop'

And then execute:

$ bundle

Or install it yourself as:

$ gem install makandra-rubocop

Usage

Add a .rubocop.yml to your project with the following contents:

For Ruby

inherit_gem:
  makandra-rubocop: config/default.yml

For Rails

inherit_gem:
  makandra-rubocop:
    - config/default.yml
    - config/ext/rails.yml

For RSpec

inherit_gem:
  makandra-rubocop:
    - config/default.yml
    - config/ext/rspec.yml

Any per-project rules can then be defined in the .rubocop.yml:

inherit_gem:
  makandra-rubocop:
    - config/default.yml
    - config/ext/rails.yml

AllCops:
  Exclude:
    - 'lib/assets/**/*'

Layout/MultilineArrayLineBreaks:
  Enabled: true

It also might be desired to set inherit_mode, which specifies which configuration keys that have array values should be merged together instead of overriding the inherited value:

inherit_mode:
  merge:
    - Exclude

Executing Rubocop on demand

Run Rubocop via bundle exec rubocop from your project directory.

For an initial run it might also useful to use the auto-correct option (bundle exec rubocop --auto-correct) and carefully check in all changes. You can follow this guide for bigger projects.

Integrating Rubocop into your test suite

We recommend you add an RSpec test that runs rubocop automatically and confirms that there are no offenses. This gem provides one. Simply add spec/rubocop_spec.rb to your project with the following code.

require 'makandra_rubocop/support/rubocop_spec'

Configuring exceptions

Some of our defaults might not fit your project. You can disable specific cops or add exclusions to .rubocop.yml in such cases. You basically have two options:

• Disable cops for specific lines using Ruby comments in your code, like so:

  for x in (0..19) # rubocop:disable Style/For

• Disable entire files by adding exclusions to .rubocop.yml, like so:

  Style/For: Exclude: - app/models/example.rb

See Rubocop's configuration manual for more information.

Note that disabling cops should be an exception for extremely rare cases where your code can not be aligned with Rubocop's requirements. If our defaults don't match your opinion, you should discuss with the team.

Development

After checking out the repo, run bin/setup to install dependencies. 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 tags, and push the .gem file to rubygems.org.

Upgrading Rubocop version being used

1. Change rubocop dependency in gemspec to the release you want to upgrade to.
2. bundle
3. git add remote rubocop https://github.com/rubocop-hq/rubocop.git
4. git fetch rubocop --no-tags (we can't import their tags or they would clash with ours)
5. Find out the commit SHA of the release you put into the gemspec and the commit SHA of the newest release (with a tag).
6. git diff $OLDER_SHA $NEWER_SHA config/default.yml | git apply --3way
7. Resolve the merge conflicts carefully and review all changes. We do not want to loose our overrides.
8. Commit.

This procedure is the same for rubocop-rails.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/makandra/makandra-rubocop.

If you make any changes to this gem's Ruby code, make sure to run rubocop.

License

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