Datarockets::Style

Datarockets shared style configs and notes of code-style conventions. Based on the Rubocop util.

This config enforces many of the guidelines outlined in the datarockets Ruby Style Guide.

Add this line to your application's Gemfile:

group :test, :development do
  gem 'datarockets-style', '~> 1.5.0'
end

Or, for a Ruby library, add this to your gemspec:

spec.add_development_dependency 'datarockets-style', '~> 1.5.0'

And then execute:

$ bundle install

Create a .rubocop.yml with the following directives:

This config includes specific rules for Ruby application. It works for Ruby gems and no-Rails applications.

inherit_gem:
  datarockets-style:
    - config/ruby.yml

For Rails applications, you can use a specific Rails instead of Ruby config

inherit_gem:
  datarockets-style:
    - config/rails.yml

By default, it doesn't include rules for I18n. For enabling them, add the next styles

inherit_gem:
  datarockets-style:
    - config/rails.yml
    - config/rails-locales.yml

To include specific rules for GraphQL, you can add the following config

inherit_gem:
  datarockets-style:
    - config/graphql.yml

For Rspec tests, you can add a special rubocop config

inherit_gem:
  datarockets-style:
    - config/ruby.yml
    - config/rspec.yml

Now, run:

$ bundle exec rubocop

You do not need to include rubocop directly in your application's dependencies. Datarockets-style will include a specific version of rubocop and rubocop-rspec that is shared across all projects.

There are some areas in which there is no clear consensus in datarockets team regarding a particular style (like string literal quoting). In such scenarios, all popular styles are acknowledged and it’s up to you to pick one and apply it consistently. For that just set up these cops before starting of usage.

This cop is enabled by default and we suggest not to use unreferenced let variables in your test cases. However, if it feels like the cop should be enabled and tests can't be written w/o them, please create an issue with your cases so that we can re-thinking our solution about enabling this cop.

There are two popular styles in the Ruby community, both of which are considered good - single quotes by default and double quotes by default. There is no clear consensus about this style in the Ruby community and in the datarockets team. So we suggest just to set up a preferable style before running this gem.

P.S. The string literals in this gem are using double quotes by default.

For an existing project, we suggest running rubocop with both styles and choose which has fewer offenses (which is more popular in the current project).

We have custom cops. You can find specification for them here.

This formatter allows us to get list of files for some offense and with number of offenses in each file. This file can be useful if you need to fix a large some cop step by step.

Result of the formatter is compatible with rubocop config or rubocop todo file.

For running that cop, just print in your command like

$ bundle exec rubocop -f TodoListFormatter -r datarockets_style
Inspecting 10 files
...CC.CC..
10 files inspected, 7 offenses detected

Layout/IndentationConsistency:
  Exclude:
    - 'spec/datarockets_style/formatter/todo_list_formatter_spec.rb' # 1

Naming/MemoizedInstanceVariableName:
  Exclude:
    - 'lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb' # 1

RSpec/ExampleLength:
  Exclude:
    - 'spec/datarockets_style/formatter/todo_list_formatter/report_summary_spec.rb' # 1
    - 'spec/datarockets_style/formatter/todo_list_formatter_spec.rb' # 2

Style/Documentation:
  Exclude:
    - 'lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb' # 1
    - 'lib/datarockets_style/formatter/todo_list_formatter.rb' # 1

If you run the formatter with autocorrection options, the formatter skip corrected cop and does not include it to the result.

$ bundle exec rubocop -f TodoListFormatter -r datarockets_style -a
Inspecting 10 files
...CC.CC..
10 files inspected, 7 offenses detected, 1 offenses corrected

Naming/MemoizedInstanceVariableName:
  Exclude:
    - 'lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb' # 1

RSpec/ExampleLength:
  Exclude:
    - 'spec/datarockets_style/formatter/todo_list_formatter/report_summary_spec.rb' # 1
    - 'spec/datarockets_style/formatter/todo_list_formatter_spec.rb' # 2

Style/Documentation:
  Exclude:
    - 'lib/datarockets_style/formatter/todo_list_formatter/report_summary.rb' # 1
    - 'lib/datarockets_style/formatter/todo_list_formatter.rb' # 1

RSpec-core library provides some configuration rules which provides some linting rules itself. Read more about it in RuboCop Rspec non-goals topic.

Datarockets Style's changelog is available here.

Bug reports and pull requests are welcome on GitHub at https://github.com/datarockets/datarockets-style. If you'd like to contribute to our RuboCop config and code-style rules, please take the time to go through our short contribution guidelines.

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

Everyone interacting in the DatarocketsStyle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.