rubocop.yml

AllCops:
  Exclude:
    - bin/**/*
    - config/deploy/*
    - db/schema.rb
    - node_modules/**/*
    - vendor/**/*
    - .git/**/*
    - Rakefile
    - db/migrate/*
    - spec/spec_helper.rb
    - spec/rails_helper.rb
  StyleGuideBaseURL: https://github.com/Interfolio/ruby-style-guide

Rails:
  Enabled: true

#################
#   Overrides   #
#################

# Enforce LF line endings
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_layout.md#layoutendofline
Layout/EndOfLine:
  EnforcedStyle: lf

# Allow less whitespace in indentation
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_layout.md#layoutalignparameters
Layout/AlignParameters:
  EnforcedStyle: with_fixed_indentation

# Don't require empty lines between module and class lines
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_layout.md#layoutemptylinesaroundclassbody
Layout/EmptyLinesAroundClassBody:
  EnforcedStyle: empty_lines_except_namespace

# Don't require empty lines between module and class lines
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_layout.md#layoutemptylinesaroundmodulebody
Layout/EmptyLinesAroundModuleBody:
  EnforcedStyle: empty_lines_except_namespace
  Exclude:
    - "lib/swagger_responses.rb"

# Allow multi-line methods to be indented instead of aligned
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_layout.md#layoutmultilinemethodcallindentation
Layout/MultilineMethodCallIndentation:
  EnforcedStyle: indented

# This cop checks for ambiguous block association with method when param passed without parentheses
# However, the style of ambiguous block is standard in specs
# https://github.com/rubocop-hq/rubocop/issues/4222
Lint/AmbiguousBlockAssociation:
  Exclude:
    - "spec/**/*"

# Allows lengthy describes in specs
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_metrics.md#metricsblocklength
Metrics/BlockLength:
  Exclude:
    - 'spec/**/*'

# Noise from longer lines
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_metrics.md#metricslinelength
Metrics/LineLength:
  Max: 120

# Allow swagger response documentation blocks to be lengthy
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_metrics.md#metricsmethodlength
Metrics/MethodLength:
  Exclude:
    - "lib/swagger_responses.rb"

# Exclude deploy configurations from requiring snake_case filenames.
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_naming.md#namingfilename
Naming/FileName:
  Exclude:
    - 'config/deploy/*.rb'

# Allows the available environments to pass the Rails.env.{environment}? check
# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsunknownenv
Rails/UnknownEnv:
  Environments:
    - production
    - nonprod
    - development
    - test
    - qa
    - alpha
    - sandbox
    - beta

# Allows { { } } in specs
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#styleblockdelimiters
Style/BlockDelimiters:
  Exclude:
    - 'spec/**/*'

# Prefer compact style over exploded.
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#styleraiseargs
Style/RaiseArgs:
  EnforcedStyle: compact

# Prefer double quotes.
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#stylestringliterals
Style/StringLiterals:
  EnforcedStyle: double_quotes

# Prefer brackets to %i
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#stylesymbolarray
Style/SymbolArray:
  EnforcedStyle: brackets

# Prefer brackets to %w
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#stylewordarray
Style/WordArray:
  EnforcedStyle: brackets

#################
# Disabled cops #
#################

# Lean towards readable code over meaningless required code comments
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#styledocumentation
Style/Documentation:
  Enabled: false

# Lean towards readable code over meaningless required code comments
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#styledocumentationmethod
Style/DocumentationMethod:
  Enabled: false

# Quieting noise for now
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#stylefrozenstringliteralcomment
Style/FrozenStringLiteralComment:
  Enabled: false

# Don't require 1000000 to be typed 1_000_000
# https://github.com/rubocop-hq/rubocop/blob/master/manual/cops_style.md#stylenumericliterals
Style/NumericLiterals:
  Enabled: false