rubocop.yml

---
require:
  - rubocop-rails
  - rubocop-rspec
  - rubocop-performance

AllCops:
  Exclude:
    - tags
    - log/**/*
    - bin/**/*
    - script/**/*
    - config/initializers/**/*
    - db/migrate/**/*
    - gems/*/db/migrate/*
    - db/schema.rb
    - gems/**/*/db/schema.rb
    - extras/importer/**/*
    - vendor/**/*
    - gems/**/vendor/**/*
    - public/**/*
    - tmp/**/*
    - node_modules/**/*
    - spec/files/**/*
  DisplayStyleGuide: true
  # Display cop names in messages
  DisplayCopNames: true
  TargetRailsVersion: 5.0

Rails:
  Enabled: true

Rails/TimeZone:
  Exclude:
    - gems/**/*

Rails/HttpPositionalArguments:
  Enabled: true

Rails/SkipsModelValidations:
  Enabled: false

Rails/RefuteMethods:
  Enabled: false

# We have tasks that don't depend on the Rails environment.
# Not depending on it makes the tasks faster.
Rails/RakeEnvironment:
  Enabled: false

# Disabled because of the mentioned possibility of false positives:
# https://docs.rubocop.org/rubocop/0.85/cops_style.html#stylehasheachmethods
Style/HashEachMethods:
  Enabled: false

# Disabled because of the mentioned possibility of false positives:
# https://docs.rubocop.org/rubocop/0.85/cops_style.html#stylehashtransformkeys
Style/HashTransformKeys:
  Enabled: false

# Disabled because of the mentioned possibility of false positives:
# https://docs.rubocop.org/rubocop/0.85/cops_style.html#stylehashtransformvalues
Style/HashTransformValues:
  Enabled: false

# We try to focus documentation on our library(ish) classes instead of
# documenting framework glue code.
Style/Documentation:
  Exclude:
    - config/**/*
    - app/models/task/*
    - app/controllers/**/*
    - app/datatables/*
    - app/helpers/**/*
    - app/mailers/**/*
    - app/cells/**/*
    - app/serializers/**/*
    - spec/**/*
    - test/**/*
    - db/migrate/*
    - gems/**/*/app/serializers/**/*
    - gems/**/*/app/controllers/**/*
    - gems/**/*/app/helpers/**/*
    - gems/**/*/spec/**/*

Metrics/BlockLength:
  Exclude:
    - config/routes.rb
    - spec/**/*
    - test/**/*
    - '*.gemspec'
    - gems/*/spec/**/*
    - gems/*/*.gemspec
    - '*.rake'
    - automations/**/*.rb
    - lib/tasks/global_data.rake
    - lib/tasks/development.rake

Metrics/ClassLength:
  Exclude:
    - test/**/*

Layout/ParameterAlignment:
  EnforcedStyle: with_fixed_indentation

Layout/MultilineOperationIndentation:
  Enabled: false

Layout/FirstHashElementIndentation:
  EnforcedStyle: consistent

Naming/MemoizedInstanceVariableName:
  Enabled: false

Layout/LineLength:
  Max: 120
  AllowURI: true
  Exclude:
    - automations/*/manifest.rb
    - lib/tasks/global_data.rake

Style/FrozenStringLiteralComment:
  Exclude:
    - db/migrate/*
    - automations/*/*.rb

Style/TrailingCommaInArrayLiteral:
  EnforcedStyleForMultiline: comma

Style/TrailingCommaInHashLiteral:
  EnforcedStyleForMultiline: comma

Metrics/ModuleLength:
  Enabled: false
  Exclude:
    - spec/**/*
    - test/**/*
    - gems/*/spec/**/*

Metrics/MethodLength:
  Max: 15
  Exclude:
    - spec/**/*
    - test/**/*
    - lib/tasks/**/*
    - automations/**/*
    - lib/tasks/global_data.rake


Metrics/AbcSize:
  Exclude:
    - spec/**/*
    - test/**/*
    - automations/**/*
    - lib/tasks/global_data.rake

Metrics/CyclomaticComplexity:
  Exclude:
    - automations/**/*

Metrics/PerceivedComplexity:
  Exclude:
    - automations/**/*

# Because we want our tests to be more explicit
RSpec/DescribedClass:
  EnforcedStyle: explicit

RSpec/Focus:
  AutoCorrect: false

RSpec/DescribeClass:
  Exclude:
    - spec/requests/**/*_spec.rb
    - gems/**/*/spec/requests/**/*_spec.rb

    - spec/features/**/*_spec.rb
    - gems/**/*/spec/features/**/*_spec.rb

    - spec/system/**/*_spec.rb
    - gems/**/*/spec/system/**/*_spec.rb

    - spec/views/**/*_spec.rb
    - gems/**/*/spec/views/**/*_spec.rb

RSpec/MultipleExpectations:
  Enabled: false

RSpec/AnyInstance:
  Enabled: false

RSpec/MultipleMemoizedHelpers:
  Enabled: false

RSpec/StubbedMock:
  Enabled: false

RSpec/ExampleLength:
  Max: 20
  Exclude:
    - spec/acceptance/**/*_spec.rb
    - spec/features/**/*_spec.rb
    - spec/system/**/*_spec.rb

RSpec/NestedGroups:
  Max: 5

RSpec/MessageSpies:
  EnforcedStyle: receive

# This lint was crashing on some files.
RSpec/FactoryBot/CreateList:
  Enabled: false

# This lint was crashing on some files.
RSpec/Rails/HttpStatus:
  Enabled: false

# For sorbet, we need to accessors separated
Style/AccessorGrouping:
  Enabled: false

# For sorbet, we need to accessors separated
Style/BisectedAttrAccessor:
  Enabled: false

# Formats incorrectly...
Layout/RescueEnsureAlignment:
  Enabled: false

# Formats incorrectly...
Layout/BeginEndAlignment:
  Enabled: false

RSpec/FactoryBot/SyntaxMethods:
  Enabled: false

Lint/EmptyBlock:
  Exclude:
    - spec/**/*
    - test/**/*
    - gems/*/spec/**/*

# Imo, this makes code harder to understand, like `unless`
Rails/NegateInclude:
  Enabled: false

# Security isn't a concern in tests, so disable the lint there and make our
# lives easier.
Style/OpenStructUse:
  Exclude:
    - spec/**/*
    - test/**/*
    - gems/*/spec/**/*

# I'd rather be verbose
Style/RedundantArgument:
  Enabled: false

# This seems to make the code less readable.
Rails/CompactBlank:
  Enabled: false

# Too many false-positives
Rails/TimeZoneAssignment:
  Enabled: false

Style/HashSyntax:
  EnforcedShorthandSyntax: never