Ruby Style Guide

Ruby Style Guide for Pattern Ruby Projects

Installation

1. Add below gems to your Gemfile. If you have remote, development and test group in your Gemfile, please add these gems to all envs.

   gem 'rubocop'
   gem 'rubocop-thread_safety'
   gem 'rubocop-rails'
   gem 'rubocop-rspec'
   gem 'rubocop-performance'
   gem 'rubocop-sequel'
   gem 'rubocop-rake'

2. Create a new file .rubocop.yml. If you already have .rubocop.yml file, we recommend that you delete it as it may have been obsolute.

   touch .rubocop.yml

3. Add below code to your .rubocop.yml.

   Always go with the latest version.

   inherit_from:
   - https://raw.githubusercontent.com/patterninc/ruby-style-guide/main/rubocop.yml
   - .rubocop_todo.yml

   For some reason, if you want to go to the previous version, you can use it like this:

   inherit_from:
   - https://raw.githubusercontent.com/patterninc/ruby-style-guide/1.0.0/rubocop.yml
   - .rubocop_todo.yml

4. Run the below command to generate your todo. This will put all existing violations into TODO file which will let you ignore them for intital setup. This shouldn't be a practice to run it to exclude your violations.

   rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 10000

5. Run Rubocop before every commit to prevent new violations.

   bundle exec rubocop

6. Setup CircleCI. Add below code to your .circleci/config.yml

   run:
       name: Static Code Analysis
       command: bundle exec rubocop

7. Add this to your .gitignore file

   .rubocop-https---raw-githubusercontent-com-patterninc-ruby-style-guide-*
   

Updating Project's Ruby Style Guide

When you modify rubocop.yml, all consuming repositories would start getting voilations depending on the rules you change. Whenever this file is updated, we need to regenerate .rubocop_todo.yml in all projects. This will add newly discovered voiloations into .rubocop_todo.yml file and prevent builds from breaking.

Regenrate todo using this command

rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 10000

Updating Pattern's Ruby Style Guide

This repository follows Semantic Versioning. All changes are documented in CHANGELOG.md as per https://keepachangelog.com/.

Regenerating .rubocop_todo.yml file

Always regenerate todo file using below command

rubocop --regenerate-todo --auto-gen-only-exclude --exclude-limit 10000