.rubocop.yml

---
plugins:
    - rubocop-rails
    - rubocop-rspec

require:
    - rubocop-capybara
    - rubocop-factory_bot
    - rubocop-rspec_rails
    - './lib/cop/all'

AllCops:
    NewCops: enable
    TargetRubyVersion: 3.4
    Exclude:
        - 'db/schema.rb'
        - 'db/seeds.rb'
        - 'bin/**/*'
        - 'vendor/**/*'
        - 'tmp/**/*'
        - 'storage/**/*'
        - 'lib/tasks/supply_teachers/**/*'
        - 'lib/tasks/management_consultancy/**/*'
        - 'lib/tasks/legal_services/**/*'
        - 'node_modules/**/*'
        - 'db/migrate/*.active_storage.rb' # These are rails autogenerated migration, so happy for rubocop to ignore it

# Capyabara rubocop config
Capybara:
    Enabled: true
    Exclude:
        - 'spec/features/**/*'

Capybara/ClickLinkOrButtonStyle:
    Enabled: false

# FactoryBot rubocop config
FactoryBot:
    Enabled: true

# Rails rubocop config
Rails:
    Enabled: true

Rails/Presence:
    Enabled: false

Rails/FilePath:
    EnforcedStyle: arguments

Rails/HelperInstanceVariable:
    Enabled: false

Rails/ThreeStateBooleanColumn:
    Enabled: false

Rails/BulkChangeTable:
    Exclude:
    - 'db/migrate/2021**'
    - 'db/migrate/2022**'
    - 'db/migrate/2023**'

# RSpec rubocop config
RSpec:
    Enabled: true

RSpec/DescribeClass:
    Exclude:
        - 'spec/models/db_seeds_spec.rb'
        - 'spec/views/**/*'
        - 'spec/i18n_spec.rb'
        - 'spec/requests/dfe_signin_spec.rb'

RSpec/MultipleExpectations:
    Max: 3
    Exclude:
        - 'spec/features/**/*'

RSpec/ExampleLength:
    Max: 10
    Exclude:
        - 'spec/features/**/*'

RSpec/NestedGroups:
    Max: 4
    Exclude:
        - 'spec/**/journey_*_spec.rb'
        - 'spec/**/branches_controller_spec.rb'

RSpec/ContextWording:
    Prefixes:
      - when
      - with
      - without
      - and

RSpec/MultipleMemoizedHelpers:
    Enabled: false

RSpec/VariableName:
    Enabled: false

RSpec/IndexedLet:
    Enabled: false

# RSpecRails rubocop config
RSpecRails:
    Enabled: true

# Standard rubocop config
Bundler/OrderedGems:
    Enabled: false

Layout/EndOfLine:
   EnforcedStyle: lf

Layout/LineLength:
    Max: 120
    Enabled: false
    AllowedPatterns:
        - 'it .* do$'
        - 'context .* do$'
        - 'scenario .* do$'

Layout/TrailingEmptyLines:
    Enabled: true

Lint/MissingSuper:
    Enabled: false

Lint/UselessConstantScoping:
    Enabled: false

Metrics/AbcSize:
    Max: 25 # TODO: Restore to '20'
    Exclude:
        - 'spec/**/*'

Metrics/BlockLength:
    Max: 40
    Exclude:
        - 'spec/**/*'

Metrics/ClassLength:
    Enabled: false

Metrics/MethodLength:
    Max: 50

Metrics/ModuleLength:
    Exclude:
        - 'spec/models/**/*'
        - 'spec/controllers/**/*'
        - 'spec/services/**/*'

Metrics/ParameterLists:
    Exclude:
        - 'app/models/supply_teachers/branch_search_result.rb'
        - 'app/calculators/supply_teachers/**/temp_to_perm_calculator/calculator.rb'

Migration/RequireLimitOnString:
    Include:
        - 'db/migrate/*.rb'

Migration/RequireUUIDPrimaryKeys:
  Enabled: false
  Include:
    - 'db/migrate/*.rb'

Naming/VariableNumber:
    Enabled: false

Style/Alias:
    Enabled: false

Style/ClassAndModuleChildren:
    Enabled: false

Style/Documentation:
    Enabled: false

Style/DoubleNegation:
    Enabled: false

Style/FrozenStringLiteralComment:
    Enabled: false

Style/HashSyntax:
    EnforcedShorthandSyntax: consistent

Style/NumericLiterals:
    Enabled: false

Style/OptionalBooleanParameter:
    Enabled: false

Style/TrailingCommaInArguments:
    Enabled: false

Style/TrailingCommaInArrayLiteral:
    Enabled: false

Style/TrailingCommaInHashLiteral:
    Enabled: false

Style/WordArray:
    Enabled: false