rubocop.yml

require:
  - rubocop-rspec
  - rubocop-performance
  - rubocop-factory_bot

AllCops:
  DisplayCopNames: true
  DisplayStyleGuide: true
  ExtraDetails: true
  Exclude:
    - .*/**/*
    - vendor/**/*
    - bin/**/*
    - node_modules/**/*

Gemspec/DeprecatedAttributeAssignment:
  Enabled: true

Lint/RedundantCopEnableDirective:
  Severity: error

Lint/RedundantCopDisableDirective:
  Severity: error

Lint/RaiseException:
  Enabled: true

Lint/StructNewOverride:
  Enabled: true

Lint/MixedRegexpCaptureTypes:
  Enabled: true

Lint/AmbiguousRange:
  Enabled: true

Metrics/ClassLength:
  Enabled: false

Metrics/AbcSize:
  Max: 60

Layout/LineLength:
  Max: 120

Layout/EmptyLinesAroundAttributeAccessor:
  Enabled: true

Metrics/BlockLength:
  Enabled: false

Metrics/MethodLength:
  Enabled: false

Metrics/ModuleLength:
  Enabled: false

Metrics/ParameterLists:
  CountKeywordArgs: false
  Max: 10

Metrics/PerceivedComplexity:
  Max: 11

Metrics/CyclomaticComplexity:
  Max: 10

Style/AsciiComments:
  Enabled: false

Style/Alias:
  Enabled: true
  EnforcedStyle: prefer_alias_method

Style/Documentation:
  Enabled: false

Layout/DotPosition:
  EnforcedStyle: trailing

Style/Encoding:
  Enabled: false

Style/FormatString:
  EnforcedStyle: sprintf

Style/FrozenStringLiteralComment:
  Enabled: true

Style/TrailingCommaInHashLiteral:
  EnforcedStyleForMultiline: comma

Style/TrailingCommaInArrayLiteral:
  EnforcedStyleForMultiline: comma

Style/TrailingCommaInArguments:
  EnforcedStyleForMultiline: comma

# As of 0.43.0 this cop complains in situations where a guard clause would be
# unhelpful or erroneous.
# The auto-correct is also buggy.
Style/GuardClause:
  Enabled: false

Layout/FirstArrayElementIndentation:
  EnforcedStyle: consistent

Layout/FirstHashElementIndentation:
  EnforcedStyle: consistent

Style/Lambda:
  EnforcedStyle: literal

Layout/MultilineMethodCallIndentation:
  EnforcedStyle: indented

Layout/MultilineOperationIndentation:
  EnforcedStyle: indented

Style/NumericPredicate:
  Exclude:
    - "spec/**/*"

Style/NumericLiterals:
  MinDigits: 11

Style/ReturnNilInPredicateMethodDefinition:
  Enabled: false

Style/SignalException:
  EnforcedStyle: "only_raise"

Style/SingleLineBlockParams:
  Enabled: false

Style/StringLiterals:
  EnforcedStyle: "double_quotes"
  Exclude:
    - Gemfile

Naming/VariableNumber:
  Enabled: false

Naming/InclusiveLanguage:
  Enabled: false

Style/YodaCondition:
  Enabled: true

Style/EndlessMethod:
  Enabled: true

Style/HashConversion:
  Enabled: true

Style/HashExcept:
  Enabled: true

Style/IfWithBooleanLiteralBranches:
  Enabled: true

Style/IfUnlessModifier:
  Enabled: false

Layout/SpaceBeforeBlockBraces:
  EnforcedStyle: space
  EnforcedStyleForEmptyBraces: space

Layout/SpaceAroundMethodCallOperator:
  Enabled: true

RSpec/NotToNot:
  EnforcedStyle: to_not

RSpec/ContextWording:
  Enabled: false

RSpec/AnyInstance:
  Enabled: false

RSpec/MessageSpies:
  EnforcedStyle: receive

RSpec/Pending:
  Enabled: true

RSpec/ImplicitBlockExpectation:
  Enabled: false

RSpec/MultipleMemoizedHelpers:
  Max: 30

RSpec/StubbedMock:
  Enabled: false

RSpec/IdenticalEqualityAssertion:
  Enabled: true

FactoryBot/SyntaxMethods:
  Enabled: false

# Re-enable this when the following is resolved:
# https://github.com/rubocop-hq/rubocop/issues/5953
Style/AccessModifierDeclarations:
  Enabled: false

# Re-enable this when the following is resolved:
# https://github.com/rubocop-hq/ruby-style-guide/issues/556
Style/ModuleFunction:
  Enabled: false

Style/HashEachMethods:
  Enabled: false

Style/HashTransformKeys:
  Enabled: true

Style/HashTransformValues:
  Enabled: true

Style/ExponentialNotation:
  Enabled: true

Style/SlicingWithRange:
  Enabled: true

Style/RedundantRegexpCharacterClass:
  Enabled: true

Style/RedundantRegexpEscape:
  Enabled: true

Style/RedundantFetchBlock:
  Enabled: true

Style/AccessorGrouping:
  Enabled: false

Style/BisectedAttrAccessor:
  Enabled: true

Style/RedundantAssignment:
  Enabled: true

Lint/DeprecatedOpenSSLConstant:
  Enabled: true

Performance/AncestorsInclude:
  Enabled: true

Performance/BigDecimalWithNumericArgument:
  Enabled: true

Performance/RedundantSortBlock:
  Enabled: true

Performance/Sum:
  Enabled: true

# Disabled as it removes some idiomatic code, and does some byte/char moving around
# encoding which we're not confident with.
Performance/RedundantStringChars:
  Enabled: false

Performance/ReverseFirst:
  Enabled: true

Performance/SortReverse:
  Enabled: true

Performance/Squeeze:
  Enabled: true

Performance/StringInclude:
  Enabled: true

Performance/ArraySemiInfiniteRangeSlice:
  Enabled: false

Performance/BlockGivenWithExplicitBlock:
  Enabled: true

Performance/CollectionLiteralInLoop:
  Enabled: true

Performance/ConstantRegexp:
  Enabled: true

Performance/MethodObjectAsBlock:
  Enabled: true

Performance/RedundantEqualityComparisonBlock:
  Enabled: true

Performance/RedundantSplitRegexpArgument:
  Enabled: true

Performance/MapCompact:
  Enabled: true

Lint/DuplicateElsifCondition:
  Enabled: true

Style/ArrayCoercion:
  Enabled: true
  # Disable auto-correct since there's usually a cleaner fix than the one it suggests.
  AutoCorrect: false

Style/CaseLikeIf:
  Enabled: true

# Disabled as the two styles that can be chosen are both idiomatic in some places, and
# not in others.
Style/HashAsLastArrayItem:
  Enabled: false

Style/HashLikeCase:
  Enabled: true

Style/RedundantFileExtensionInRequire:
  Enabled: true

Lint/BinaryOperatorWithIdenticalOperands:
  Enabled: true

Lint/DuplicateRescueException:
  Enabled: true

Lint/EmptyConditionalBody:
  Enabled: true

Lint/FloatComparison:
  Enabled: true

Lint/MissingSuper:
  Enabled: true

Lint/OutOfRangeRegexpRef:
  Enabled: true

Lint/SelfAssignment:
  Enabled: true

Lint/TopLevelReturnWithArgument:
  Enabled: true

Lint/UnreachableLoop:
  Enabled: true

Lint/DuplicateRequire:
  Enabled: true

Lint/EmptyFile:
  Enabled: true

Lint/TrailingCommaInAttributeDeclaration:
  Enabled: true

Lint/UselessMethodDefinition:
  Enabled: true

Lint/ConstantDefinitionInBlock:
  Enabled: false

Lint/HashCompareByIdentity:
  Enabled: true

Lint/IdentityComparison:
  Enabled: true

Lint/RedundantSafeNavigation:
  Enabled: true

Lint/UselessTimes:
  Enabled: true

Lint/DuplicateBranch:
  Enabled: false

Lint/EmptyBlock:
  Enabled: false

Lint/EmptyClass:
  Enabled: true
  Exclude:
    - "spec/**/*"

Lint/NoReturnInBeginEndBlocks:
  Enabled: false

Lint/DuplicateRegexpCharacterClassElement:
  Enabled: true

Lint/ToEnumArguments:
  Enabled: true

Lint/UnmodifiedReduceAccumulator:
  Enabled: true

Lint/UnexpectedBlockArity:
  Enabled: true

Lint/AmbiguousAssignment:
  Enabled: true

Lint/DeprecatedConstants:
  Enabled: true

Lint/LambdaWithoutLiteralBlock:
  Enabled: true

Lint/NumberedParameterAssignment:
  Enabled: true

Lint/OrAssignmentToConstant:
  Enabled: true

Lint/RedundantDirGlobSort:
  Enabled: true

Lint/SymbolConversion:
  Enabled: true

Lint/TripleQuotes:
  Enabled: true

Lint/EmptyInPattern:
  Enabled: true

Style/ExplicitBlockArgument:
  Enabled: true

Style/GlobalStdStream:
  Enabled: true

Style/SingleArgumentDig:
  Enabled: true

Style/OptionalBooleanParameter:
  Enabled: false

Style/StringConcatenation:
  Enabled: false

Style/CombinableLoops:
  Enabled: false

Style/KeywordParametersOrder:
  Enabled: true

Style/RedundantSelfAssignment:
  Enabled: true

Style/SoleNestedConditional:
  Enabled: false

Style/ClassEqualityComparison:
  Enabled: true

Style/CommentAnnotation:
  Enabled: false

Style/DocumentDynamicEvalDefinition:
  Enabled: false

Style/NegatedIfElseCondition:
  Enabled: false

Style/NegatedIf:
  Enabled: false

Style/ArgumentsForwarding:
  Enabled: true
  UseAnonymousForwarding: false

Style/CollectionCompact:
  Enabled: true

Style/NilLambda:
  Enabled: true

Style/SwapValues:
  Enabled: true

Style/RedundantArgument:
  Enabled: true

Style/StringChars:
  Enabled: true

Style/InPatternThen:
  Enabled: true

Style/MultilineInPatternThen:
  Enabled: true

Style/QuotedSymbols:
  Enabled: true

Style/RedundantSelfAssignmentBranch:
  Enabled: true

Layout/BeginEndAlignment:
  Enabled: true

Layout/SpaceBeforeBrackets:
  Enabled: true

Layout/LineEndStringConcatenationIndentation:
  Enabled: true

Style/HashSyntax:
  Enabled: false

Style/FileRead:
  Enabled: false

Style/FileWrite:
  Enabled: false

Style/MapToHash:
  Enabled: true

Style/NumberedParameters:
  Enabled: true

Style/NumberedParametersLimit:
  Enabled: true
  Max: 2

Style/OpenStructUse:
  Enabled: false

Style/SelectByRegexp:
  Enabled: false

Security/IoMethods:
  Enabled: true

Gemspec/RequireMFA:
  Enabled: true

Lint/AmbiguousOperatorPrecedence:
  Enabled: true

Lint/IncompatibleIoSelectWithFiberScheduler:
  Enabled: true

Lint/RequireRelativeSelfPath:
  Enabled: true

Lint/UselessRuby2Keywords:
  Enabled: true

Naming/BlockForwarding:
  Enabled: true
  EnforcedStyle: "explicit"

RSpec/ExcessiveDocstringSpacing:
  Enabled: true

RSpec/SubjectDeclaration:
  Enabled: true

Performance/ConcurrentMonotonicTime:
  Enabled: true

Performance/StringIdentifierArgument:
  Enabled: true

Style/NestedFileDirname:
  Enabled: true

# new in 1.27
Style/RedundantInitialize:
  Enabled: true

Lint/RefinementImportMethods:
  Enabled: true

# new in 1.28
Security/CompoundHash:
  Enabled: true

Style/FetchEnvVar:
  Enabled: false

Style/ObjectThen:
  Enabled: true

# new in 1.29
Style/EnvHome:
  Enabled: true

# new in 2.9.0
RSpec/BeEq:
  Enabled: false

RSpec/BeNil:
  Enabled: true

# new in 2.10.0
RSpec/VerifiedDoubleReference:
  Enabled: true

# new in 2.11.0
RSpec/ChangeByZero:
  Enabled: true

# new in 1.31
Layout/LineContinuationLeadingSpace:
  Enabled: true

Layout/LineContinuationSpacing:
  Enabled: true

Lint/ConstantOverwrittenInRescue:
  Enabled: true

Lint/NonAtomicFileOperation:
  Enabled: true

# new in 1.32 - many false positives
Lint/RequireRangeParentheses:
  Enabled: false

Style/EmptyHeredoc:
  Enabled: true

# new in 1.35
Style/MagicCommentFormat:
  Enabled: true

# new in 1.30
Style/MapCompactWithConditionalBlock:
  Enabled: true

# new in 2.13
RSpec/ClassCheck:
  Enabled: true

# new in 2.13 - doesn't work with `its`
RSpec/NoExpectationExample:
  Enabled: false

Lint/DuplicateMagicComment: # new in 1.37
  Enabled: true

Style/OperatorMethodCall: # new in 1.37
  Enabled: true

Style/RedundantStringEscape: # new in 1.37
  Enabled: true

RSpec/SortMetadata: # new in 2.14
  Enabled: true

# Seems to be buggy, causes an infinite loop for `subjects` named `create`
FactoryBot/ConsistentParenthesesStyle: # new in 2.14
  Enabled: false

Style/AndOr:
  Enabled: true
  EnforcedStyle: always

# Autocorrect is a little simplified and can lead to confusion
RSpec/ExampleWording:
  Enabled: false