sul-dlss-deprecated / dlss_cops

[DEPRECATED] A gem for versioning DLSS's baseline Ruby style guide

DEPRECATED

This gem was deprecated on March 4th, 2022 after lying fallow for four years.

DlssCops

DlssCops is a Rubocop configuration gem that holds DLSS's baseline Ruby style guide. See https://github.com/sul-dlss/DeveloperPlaybook/tree/master/style for more information about the DLSS style. See https://github.com/bbatsov/rubocop for more information about Rubocop.

Installation

We recommend you use the latest version of DlssCops but if needed, you can select a specific version to manage change.

Add a development_dependency in your gem's gemspec file

  gemspec.add_development_dependency 'dlss_cops'

OR, if it's not a gem, add these lines to your Gemfile:

group :development, :test do
  gem 'dlss_cops'
end

Usage

Set up your .rubocop.yml file:

inherit_gem:
  dlss_cops: "config/dlss_baseline.yml"

AllCops:
  TargetRubyVersion: 2.2

Then you can launch rubocop via: bundle exec rubocop <options>

See https://github.com/bbatsov/rubocop#basic-usage for more information.

dlss_cops's Issues

Differentiate any intentionally disabled cops

Right now we disable a bunch of stuff that is "not baseline" but optional or even desired. We should differentiate cops that we intend to stay disabled, if any.

Create a corresponding .editorconfig for ruby code style

The purpose of this issue is to identify a way that we can auto-format code in our IDEs so that it's consistent with rubocop style checks. The question is, how do we translate the rubop style settings from the dlss_baseline.yml into an .editorconfig file?

• https://github.com/sul-dlss/dlss_cops/blob/master/config/dlss_baseline.yml

Rubocop is a style checker that enforces style after the fact. It does not facilitate the creation or autoformatting of consistent code in an IDE. There are some rubocop plugins that enable warnings in IDEs that code is inconsistent with rubocop, but they have to constantly run rubocop in the background to check code (performance hit). Some IDEs do not provide enough configuration options to support developing code in a style that is consistent with rubocop settings. This is where http://editorconfig.org/ comes in. It can help to configure an IDE in a way that auto-formats code in a consistent way, across IDEs.

Initial suggestion from slack...

@mjgiarlo - investigating a possible connection, if any, between rubocop ruby style stuff and http://editorconfig.org/

• e.g.
  • https://github.com/bbatsov/rubocop/blob/master/.editorconfig
  • https://github.com/AtomLinter/linter-rubocop/blob/master/.editorconfig
• seems like each project can define it’s own style this way and various IDEs can use it for autoformatting
• atom support:
  • https://discuss.atom.io/t/editorconfig-support/327/2
  • https://github.com/sindresorhus/atom-editorconfig
• JetBrains support:
  • https://plugins.jetbrains.com/plugin/7294-editorconfig
• longer story - JetBrains IDEs (IntelliJ, RubyMine, etc.) have a plugin to support http://editorconfig.org/ to specify the code style details. Seems like editorconfig.org is something like a generic .vimrc or .emacs code style system that maybe many other IDEs support. I’m going to learn a little more about it, because I’m constantly getting tiny inconsistencies in the way RubyMine auto-formats my ruby code in a way that is slightly inconsistent with the rubocop settings for a project. Plus, the RubyMine code style settings just don’t have enough options to even enable some of the rubocop settings. I’m hoping to find a way that rubocop could create a .editorconfig file that the RubyMine-EditorConfig plugin can read. Then, presto, my IDE auto-formatting will conform to rubocop settings and I won’t always have to think about it or always check and correct with rubocop -a.

Curious to see if there is a way to create an .editorconfig that is consistent with https://github.com/sul-dlss/dlss_cops - would be great if rubocop can auto-gen an .editorconfig file, but manual creation might not be too tedious.

Enhance README with `.rubocop_todo.yml` recommendations

Please add README recommendations on how to create and manage a .rubocop_todo.yml file.

rubocop update brakes stuff

# Updated dlss_cops and rubocop on the sul_pub project and get the following:
$ bundle exec rubocop
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/IndentationConsistency has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/AccessModifierIndentation has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/AlignHash has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/AlignParameters has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/EmptyLinesAroundClassBody has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/EmptyLinesAroundModuleBody has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/LeadingCommentSpace has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/SpaceAfterNot has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/SpaceAroundEqualsInParameterDefault has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/SpaceInsideBrackets has the wrong namespace - should be Layout
/users/dlweber/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/dlss_cops-0.0.4/config/dlss_baseline.yml: Style/TrailingBlankLines has the wrong namespace - should be Layout

Update rubocop to be able to upgrade to rake 12.x

We cannot upgrade to rake because dlss_cops has rubocop pinned to an old version that uses deprecated/removed methods in a rake task.

Rake 12.x removed the last_comment method, see

• https://github.com/ruby/rake/blob/master/History.rdoc#1200

$ bundle exec rake rubocop
rake aborted!
NoMethodError: undefined method `last_comment' for #<Rake::Application:0x00561039bd7d20>
/data/src/dlss/cap/sul_pub/Rakefile:27:in `new'
/data/src/dlss/cap/sul_pub/Rakefile:27:in `block in <top (required)>'
/data/src/dlss/cap/sul_pub/.bundle/bin/bundle:104:in `load'
/data/src/dlss/cap/sul_pub/.bundle/bin/bundle:104:in `<main>'
Tasks: TOP => rubocop
(See full trace by running task with --trace)

Connected to sul-dlss/sul_pub#416