rubocop.yml

# Override default Rubocop confg
# See https://github.com/bbatsov/rubocop

AllCops:
  NewCops: enable
  SuggestExtensions: false

Layout/DotPosition:
  EnforcedStyle: leading

Layout/EmptyLineAfterGuardClause:
  # We disable this rule to allow each developer
  # to choose the appropriate style.
  #
  # For example, the following example couldn't reach
  # a consensus :
  #
  # odds = []
  # 10.times.each do |i|
  #   next if i % 2 == 0
  #
  #   odds << i
  # end
  #
  Enabled: false

Layout/SpaceInsideHashLiteralBraces:
  EnforcedStyle: space
  EnforcedStyleForEmptyBraces: no_space

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

# Please keep rules in alphabetical order...

Style/AsciiComments:
  # Because 👆 is not the finger you are looking for.
  Enabled: false

Style/ClassAndModuleChildren:
  # Checks the style of children definitions at classes and modules.
  #
  # Basically there are two different styles:
  #
  # `nested` - have each child on a separate line
  #   class Foo
  #     class Bar
  #     end
  #   end
  #
  # `compact` - combine definitions as much as possible
  #   class Foo::Bar
  #   end
  #
  # There are good reasons to use both, do not enforce this style.
  Enabled: false

Style/CommentedKeyword:
  # Checks if a comment is added after a keyword:
  #
  #   class Foo < ActiveRecord::Base # Not AppRecord, this is specific
  #
  # We don't have any specific reason to disallow it.
  Enabled: false

Style/Documentation:
  Enabled: false

Style/DocumentationMethod:
  Enabled: true

Style/HashSyntax:
  EnforcedStyle: ruby19_no_mixed_keys
  SupportedStyles:
    # checks for 1.9 syntax (e.g. {a: 1}) for all symbol keys
    - ruby19
    # checks for hash rocket syntax for all hashes
    - hash_rockets
    # forbids mixed key syntaxes (e.g. {a: 1, :b => 2})
    - no_mixed_keys
    # enforces both ruby19 and no_mixed_keys styles
    - ruby19_no_mixed_keys
  # Force hashes that have a symbol value to use hash rockets
  UseHashRocketsWithSymbolValues: false
  # Do not suggest { a?: 1 } over { :a? => 1 } in ruby19 style
  PreferHashRocketsForNonAlnumEndingSymbols: false

# Do not assign mutable objects to constants.
Style/MutableConstant:
  Enabled: true
  EnforcedStyle: strict

# Do not enforce usage of `unless foo` over `if !foo`
Style/NegatedIf:
  Enabled: false

Style/NumericPredicate:
  # Disabled : depending on the context, we think it's a good thing
  # to have the choice between `> 0` and `positive?`.
  EnforcedStyle: comparison

Style/PercentLiteralDelimiters:
  # Why do we need different delimiters ?!
  # Always use the `()` delimiter
  PreferredDelimiters:
    default: '()'
    '%i': '()'
    '%I': '()'
    '%r': '()'
    '%w': '()'
    '%W': '()'

Style/RedundantReturn:
  # Allow usage of `return` keyword when it helps clarity.
  Enabled: false

Style/ReturnNil:
  # Favor usage of `return nil` in stead of `return`
  EnforcedStyle: return_nil

Style/StringLiterals:
  EnforcedStyle: double_quotes
  # If true, strings which span multiple lines using \ for continuation must
  # use the same type of quotes on each line.
  ConsistentQuotesInMultiline: true

# Since we always want to enforce double quotes, having single quotes on such
# places feels weird:
#
#   "Hello, #{APP_CONFIG['little_world']"
#
Style/StringLiteralsInInterpolation:
  EnforcedStyle: double_quotes

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

# Please keep rules in alphabetical order...

Metrics/AbcSize:
  # Default 15 (9999 to disable it)
  # => cyclomatic complexity is better
  Max: 9999

Metrics/BlockLength:
  Exclude:
    - "spec/**/*"

Metrics/ClassLength:
  CountComments: false  # count full line comments?
  Max: 300

Metrics/ModuleLength:
  CountComments: false  # count full line comments?
  Max: 300

Metrics/MethodLength:
  CountComments: false  # count full line comments?
  Max: 20

Layout/LineLength:
  Max: 80