rubocop.yml

################################################################################
# Layout
################################################################################

Layout/ParameterAlignment:
  Enabled: false

Layout/EmptyLinesAroundClassBody:
  Enabled: false

Layout/MultilineMethodCallIndentation:
  EnforcedStyle: indented

################################################################################
# Metrics
################################################################################

Layout/LineLength:
  Enabled: false

Metrics/AbcSize:
  Enabled: false

Metrics/ModuleLength:
  Enabled: false

Metrics/ClassLength:
  Enabled: false

Metrics/MethodLength:
  Enabled: false

Metrics/BlockLength:
  Enabled: false

Metrics/CyclomaticComplexity:
  Enabled: false

Metrics/ParameterLists:
  Enabled: false

Metrics/PerceivedComplexity:
  Enabled: false

################################################################################
# Style
###############################################################################

Style/BlockDelimiters:
  EnforcedStyle: semantic
  Exclude:
    - spec/**/*

# Executables are conventionally named bin/foo-bar
Naming/FileName:
  Exclude:
    - bin/**/*

# Naming format tokens is often less readable, especially with time values.
Style/FormatStringToken:
  Enabled: false

# We don't (currently) document our code
Style/Documentation:
  Enabled: false

Style/StringLiterals:
  Enabled: false

Style/StringLiteralsInInterpolation:
  EnforcedStyle: double_quotes

# Use a trailing comma to keep diffs clean when elements are inserted or removed
Style/TrailingCommaInArguments:
  EnforcedStyleForMultiline: comma

Style/TrailingCommaInArrayLiteral:
  EnforcedStyleForMultiline: comma

Style/TrailingCommaInHashLiteral:
  EnforcedStyleForMultiline: comma

Layout/TrailingWhitespace:
  Enabled: false

# We avoid GuardClause because it can result in "suprise return"
Style/GuardClause:
  Enabled: false

# We avoid IfUnlessModifier because it can result in "suprise if"
Style/IfUnlessModifier:
  Enabled: false

# We don't care about the fail/raise distinction
Style/SignalException:
  EnforcedStyle: only_raise

Layout/DotPosition:
  EnforcedStyle: trailing

# Common globals we allow
Style/GlobalVars:
  AllowedVariables:
    - "$statsd"
    - "$mongo"
    - "$rollout"

# Using english names requires loading an extra module, which is annoying, so
# we prefer the perl names for consistency.
Style/SpecialGlobalVars:
  EnforcedStyle: use_perl_names

# We have common cases where has_ and have_ make sense
Naming/PredicateName:
  Enabled: true
  ForbiddenPrefixes:
    - is_

# We use %w[ ], not %w( ) because the former looks like an array
Style/PercentLiteralDelimiters:
  PreferredDelimiters:
    "%i": "[]"
    "%I": "[]"
    "%w": "[]"
    "%W": "[]"

# Allow "trivial" accessors when defined as a predicate? method
Style/TrivialAccessors:
  AllowPredicates: true

Style/Next:
  Enabled: false

# We think it's OK to use the "extend self" module pattern
Style/ModuleFunction:
  Enabled: false

Layout/ExtraSpacing:
  Enabled: false

# and/or in conditionals has no meaningful difference (only gotchas), so we
# disallow them there. When used for control flow, the difference in precedence
# can make for a less noisy expression, as in:
#
#   x = find_x or raise XNotFound
#
Style/AndOr:
  EnforcedStyle: conditionals

Style/MultilineBlockChain:
  Enabled: false

Layout/MultilineOperationIndentation:
  EnforcedStyle: indented

Layout/HashAlignment:
  EnforcedLastArgumentHashStyle: ignore_implicit

# This has the behavior we want, but it has a bug in it which produces a lot of false positives
# https://github.com/bbatsov/rubocop/issues/3462
# MultilineMethodCallBraceLayout:
#   EnforcedStyle: new_line

# We prefer alias_method. This cop's documentation actually indicates that's
# what it enforces, but it seems to behave exactly the opposite.
Style/Alias:
  Enabled: false

Style/StderrPuts:
  Enabled: false

Style/MissingElse:
  Enabled: true
  EnforcedStyle: case

################################################################################
# Performance
################################################################################

Performance/RedundantMerge:
  Enabled: false

################################################################################
# Rails - disabled because we're primarily non-Rails
################################################################################

Rails:
  Enabled: false

################################################################################
# Specs - be more lenient on length checks and block styles
################################################################################

Style/ClassAndModuleChildren:
  Exclude:
    - spec/**/*