require: - rubocop-rspec - ./rubocop/rubocop inherit_from: .rubocop_todo.yml AllCops: TargetRubyVersion: 2.1 # Cop names are not d§splayed in offense messages by default. Change behavior # by overriding DisplayCopNames, or by giving the -D/--display-cop-names # option. DisplayCopNames: true # Style guide URLs are not displayed in offense messages by default. Change # behavior by overriding DisplayStyleGuide, or by giving the # -S/--display-style-guide option. DisplayStyleGuide: false # Exclude some GitLab files Exclude: - 'vendor/**/*' - 'db/*' - 'db/fixtures/**/*' - 'tmp/**/*' - 'bin/**/*' - 'lib/backup/**/*' - 'lib/ci/backup/**/*' - 'lib/tasks/**/*' - 'lib/ci/migrate/**/*' - 'lib/email_validator.rb' - 'lib/gitlab/upgrader.rb' - 'lib/gitlab/seeder.rb' - 'generator_templates/**/*' ##################### Style ################################## # Check indentation of private/protected visibility modifiers. Style/AccessModifierIndentation: Enabled: true # Check the naming of accessor methods for get_/set_. Style/AccessorMethodName: Enabled: false # Use alias_method instead of alias. Style/Alias: EnforcedStyle: prefer_alias_method Enabled: true # Align the elements of an array literal if they span more than one line. Style/AlignArray: Enabled: true # Align the elements of a hash literal if they span more than one line. Style/AlignHash: Enabled: true # Use `Array#join` instead of `Array#*`. Style/ArrayJoin: Enabled: true # Use only ascii symbols in comments. Style/AsciiComments: Enabled: true # Use only ascii symbols in identifiers. Style/AsciiIdentifiers: Enabled: true # Checks for uses of Module#attr. Style/Attr: Enabled: true # Avoid the use of BEGIN blocks. Style/BeginBlock: Enabled: true # Do not use block comments. Style/BlockComments: Enabled: true # Put end statement of multiline block on its own line. Style/BlockEndNewline: Enabled: true # Avoid using {...} for multi-line blocks (multiline chaining is # always # ugly). Prefer {...} over do...end for single-line blocks. Style/BlockDelimiters: Enabled: true # Indentation of when in a case/when/[else/]end. Style/CaseIndentation: Enabled: true # Checks for uses of character literals. Style/CharacterLiteral: Enabled: true # Use CamelCase for classes and modules.' Style/ClassAndModuleCamelCase: Enabled: true # Checks style of children classes and modules. Style/ClassAndModuleChildren: Enabled: false # Enforces consistent use of `Object#is_a?` or `Object#kind_of?`. Style/ClassCheck: Enabled: false # Use self when defining module/class methods. Style/ClassMethods: Enabled: true # Avoid the use of class variables. Style/ClassVars: Enabled: true # Indentation of comments. Style/CommentIndentation: Enabled: true # Constants should use SCREAMING_SNAKE_CASE. Style/ConstantName: Enabled: true # Use def with parentheses when there are arguments. Style/DefWithParentheses: Enabled: true # Document classes and non-namespace modules. Style/Documentation: Enabled: false # Align elses and elsifs correctly. Style/ElseAlignment: Enabled: true # Use empty lines between defs. Style/EmptyLineBetweenDefs: Enabled: false # Don't use several empty lines in a row. Style/EmptyLines: Enabled: true # Keep blank lines around access modifiers. Style/EmptyLinesAroundAccessModifier: Enabled: true # Keeps track of empty lines around block bodies. Style/EmptyLinesAroundBlockBody: Enabled: true # Keeps track of empty lines around class bodies. Style/EmptyLinesAroundClassBody: Enabled: true # Keeps track of empty lines around module bodies. Style/EmptyLinesAroundModuleBody: Enabled: true # Keeps track of empty lines around method bodies. Style/EmptyLinesAroundMethodBody: Enabled: true # Avoid the use of END blocks. Style/EndBlock: Enabled: true # Use Unix-style line endings. Style/EndOfLine: Enabled: true # Favor the use of Fixnum#even? && Fixnum#odd? Style/EvenOdd: Enabled: true # Use snake_case for source file names. Style/FileName: Enabled: true # Checks for a line break before the first parameter in a multi-line method # parameter definition. Style/FirstMethodParameterLineBreak: Enabled: true # Checks for flip flops. Style/FlipFlop: Enabled: true # Checks use of for or each in multiline loops. Style/For: Enabled: true # Checks if there is a magic comment to enforce string literals Style/FrozenStringLiteralComment: Enabled: false # Do not introduce global variables. Style/GlobalVars: Enabled: true # Prefer Ruby 1.9 hash syntax `{ a: 1, b: 2 }` # over 1.8 syntax `{ :a => 1, :b => 2 }`. Style/HashSyntax: Enabled: true # Do not use if x; .... Use the ternary operator instead. Style/IfWithSemicolon: Enabled: true # Checks that conditional statements do not have an identical line at the # end of each branch, which can validly be moved out of the conditional. Style/IdenticalConditionalBranches: Enabled: true # Checks the indentation of the first line of the right-hand-side of a # multi-line assignment. Style/IndentAssignment: Enabled: true # Keep indentation straight. Style/IndentationConsistency: Enabled: true # Use 2 spaces for indentation. Style/IndentationWidth: Enabled: true # Use Kernel#loop for infinite loops. Style/InfiniteLoop: Enabled: true # Use lambda.call(...) instead of lambda.(...). Style/LambdaCall: Enabled: true # Comments should start with a space. Style/LeadingCommentSpace: Enabled: true # Checks if the method definitions have or don't have parentheses. Style/MethodDefParentheses: Enabled: true # Use the configured style when naming methods. Style/MethodName: Enabled: true # Checks for usage of `extend self` in modules. Style/ModuleFunction: Enabled: false # Checks that the closing brace in an array literal is either on the same line # as the last array element, or a new line. Style/MultilineArrayBraceLayout: Enabled: false EnforcedStyle: symmetrical # Avoid multi-line chains of blocks. Style/MultilineBlockChain: Enabled: true # Ensures newlines after multiline block do statements. Style/MultilineBlockLayout: Enabled: true # Checks that the closing brace in a hash literal is either on the same line as # the last hash element, or a new line. Style/MultilineHashBraceLayout: Enabled: false EnforcedStyle: symmetrical # Do not use then for multi-line if/unless. Style/MultilineIfThen: Enabled: true # Checks that the closing brace in a method call is either on the same line as # the last method argument, or a new line. Style/MultilineMethodCallBraceLayout: Enabled: false EnforcedStyle: symmetrical # Checks indentation of method calls with the dot operator that span more than # one line. Style/MultilineMethodCallIndentation: Enabled: false # Checks that the closing brace in a method definition is symmetrical with # respect to the opening brace and the method parameters. Style/MultilineMethodDefinitionBraceLayout: Enabled: false # Checks indentation of binary operations that span more than one line. Style/MultilineOperationIndentation: Enabled: false # Avoid multi-line `? :` (the ternary operator), use if/unless instead. Style/MultilineTernaryOperator: Enabled: true # Favor unless over if for negative conditions (or control flow or). Style/NegatedIf: Enabled: true # Avoid using nested modifiers. Style/NestedModifier: Enabled: true # Use one expression per branch in a ternary operator. Style/NestedTernaryOperator: Enabled: true # Prefer x.nil? to x == nil. Style/NilComparison: Enabled: true # Checks for redundant nil checks. Style/NonNilCheck: Enabled: true # Use ! instead of not. Style/Not: Enabled: true # Add underscores to large numeric literals to improve their readability. Style/NumericLiterals: Enabled: false # Favor the ternary operator(?:) over if/then/else/end constructs. Style/OneLineConditional: Enabled: true # When defining binary operators, name the argument other. Style/OpMethod: Enabled: true # Don't use parentheses around the condition of an if/unless/while. Style/ParenthesesAroundCondition: Enabled: true # Checks for parentheses that seem not to serve any purpose. Style/RedundantParentheses: Enabled: true # Don't use return where it's not required. Style/RedundantReturn: Enabled: true # Don't use semicolons to terminate expressions. Style/Semicolon: Enabled: true # Checks for proper usage of fail and raise. Style/SignalException: EnforcedStyle: only_raise Enabled: true # Use spaces after colons. Style/SpaceAfterColon: Enabled: true # Use spaces after commas. Style/SpaceAfterComma: Enabled: true # Do not put a space between a method name and the opening parenthesis in a # method definition. Style/SpaceAfterMethodName: Enabled: true # Tracks redundant space after the ! operator. Style/SpaceAfterNot: Enabled: true # Use spaces after semicolons. Style/SpaceAfterSemicolon: Enabled: true # Use space around equals in parameter default Style/SpaceAroundEqualsInParameterDefault: Enabled: true # Use a space around keywords if appropriate. Style/SpaceAroundKeyword: Enabled: true # Use a single space around operators. Style/SpaceAroundOperators: Enabled: true # No spaces before commas. Style/SpaceBeforeComma: Enabled: true # Checks for missing space between code and a comment on the same line. Style/SpaceBeforeComment: Enabled: true # No spaces before semicolons. Style/SpaceBeforeSemicolon: Enabled: true # Use spaces inside hash literal braces - or don't. Style/SpaceInsideHashLiteralBraces: Enabled: true # No spaces inside range literals. Style/SpaceInsideRangeLiteral: Enabled: true # Checks for padding/surrounding spaces inside string interpolation. Style/SpaceInsideStringInterpolation: EnforcedStyle: no_space Enabled: true # Check for the usage of parentheses around stabby lambda arguments. Style/StabbyLambdaParentheses: EnforcedStyle: require_parentheses Enabled: true # Checks if uses of quotes match the configured preference. Style/StringLiterals: Enabled: false # Checks if configured preferred methods are used over non-preferred. Style/StringMethods: PreferredMethods: intern: to_sym Enabled: true # No hard tabs. Style/Tab: Enabled: true # Checks trailing blank lines and final newline. Style/TrailingBlankLines: Enabled: true # Checks for %W when interpolation is not needed. Style/UnneededCapitalW: Enabled: true # Checks for %q/%Q when single quotes or double quotes would do. Style/UnneededPercentQ: Enabled: false # Don't interpolate global, instance and class variables directly in strings. Style/VariableInterpolation: Enabled: true # Use the configured style when naming variables. Style/VariableName: EnforcedStyle: snake_case Enabled: true # Use the configured style when numbering variables. Style/VariableNumber: Enabled: false # Use when x then ... for one-line cases. Style/WhenThen: Enabled: true # Checks for redundant do after while or until. Style/WhileUntilDo: Enabled: true # Favor modifier while/until usage when you have a single-line body. Style/WhileUntilModifier: Enabled: true # Use %w or %W for arrays of words. Style/WordArray: Enabled: false #################### Metrics ################################ # A calculated magnitude based on number of assignments, # branches, and conditions. Metrics/AbcSize: Enabled: true Max: 60 # Avoid excessive block nesting. Metrics/BlockNesting: Enabled: true Max: 4 # Avoid classes longer than 100 lines of code. Metrics/ClassLength: Enabled: false # A complexity metric that is strongly correlated to the number # of test cases needed to validate a method. Metrics/CyclomaticComplexity: Enabled: true Max: 17 # Limit lines to 80 characters. Metrics/LineLength: Enabled: false # Avoid methods longer than 10 lines of code. Metrics/MethodLength: Enabled: false # Avoid modules longer than 100 lines of code. Metrics/ModuleLength: Enabled: false # Avoid parameter lists longer than three or four parameters. Metrics/ParameterLists: Enabled: true Max: 8 # A complexity metric geared towards measuring complexity for a human reader. Metrics/PerceivedComplexity: Enabled: true Max: 18 #################### Lint ################################ # Checks for useless access modifiers. Lint/UselessAccessModifier: Enabled: true # Checks for attempts to use `private` or `protected` to set the visibility # of a class method, which does not work. Lint/IneffectiveAccessModifier: Enabled: false # Checks for ambiguous operators in the first argument of a method invocation # without parentheses. Lint/AmbiguousOperator: Enabled: true # Align block ends correctly. Lint/BlockAlignment: Enabled: true # Default values in optional keyword arguments and optional ordinal arguments # should not refer back to the name of the argument. Lint/CircularArgumentReference: Enabled: true # Checks for condition placed in a confusing position relative to the keyword. Lint/ConditionPosition: Enabled: true # Check for debugger calls. Lint/Debugger: Enabled: true # Align ends corresponding to defs correctly. Lint/DefEndAlignment: Enabled: true # Check for deprecated class method calls. Lint/DeprecatedClassMethods: Enabled: true # Check for immutable argument given to each_with_object. Lint/EachWithObjectArgument: Enabled: true # Check for odd code arrangement in an else block. Lint/ElseLayout: Enabled: true # Checks for empty ensure block. Lint/EmptyEnsure: Enabled: true # Align ends correctly. Lint/EndAlignment: Enabled: true # END blocks should not be placed inside method definitions. Lint/EndInMethod: Enabled: true # Do not use return in an ensure block. Lint/EnsureReturn: Enabled: true # The use of eval represents a serious security risk. Lint/Eval: Enabled: true # Catches floating-point literals too large or small for Ruby to represent. Lint/FloatOutOfRange: Enabled: true # The number of parameters to format/sprint must match the fields. Lint/FormatParameterMismatch: Enabled: true # Checks for adjacent string literals on the same line, which could better be # represented as a single string literal. Lint/ImplicitStringConcatenation: Enabled: true # Checks for invalid character literals with a non-escaped whitespace # character. Lint/InvalidCharacterLiteral: Enabled: true # Checks of literals used in conditions. Lint/LiteralInCondition: Enabled: true # Checks for literals used in interpolation. Lint/LiteralInInterpolation: Enabled: true # Do not use nested method definitions. Lint/NestedMethodDefinition: Enabled: true # Do not omit the accumulator when calling `next` in a `reduce`/`inject` block. Lint/NextWithoutAccumulator: Enabled: true # Checks for method calls with a space before the opening parenthesis. Lint/ParenthesesAsGroupedExpression: Enabled: true # Checks for `rand(1)` calls. Such calls always return `0` and most likely # a mistake. Lint/RandOne: Enabled: true # Use parentheses in the method call to avoid confusion about precedence. Lint/RequireParentheses: Enabled: true # Avoid rescuing the Exception class. Lint/RescueException: Enabled: true # Checks for the order which exceptions are rescued to avoid rescueing a less specific exception before a more specific exception. Lint/ShadowedException: Enabled: false # Checks for Object#to_s usage in string interpolation. Lint/StringConversionInInterpolation: Enabled: true # Do not use prefix `_` for a variable that is used. Lint/UnderscorePrefixedVariableName: Enabled: true # Checks for rubocop:disable comments that can be removed. # Note: this cop is not disabled when disabling all cops. # It must be explicitly disabled. Lint/UnneededDisable: Enabled: false # Unreachable code. Lint/UnreachableCode: Enabled: true # Checks for useless assignment to a local variable. Lint/UselessAssignment: Enabled: true # Checks for comparison of something with itself. Lint/UselessComparison: Enabled: true # Checks for useless `else` in `begin..end` without `rescue`. Lint/UselessElseWithoutRescue: Enabled: true # Checks for useless setter call to a local variable. Lint/UselessSetterCall: Enabled: true # Possible use of operator/literal/variable in void context. Lint/Void: Enabled: true ##################### Performance ############################ # Use `casecmp` rather than `downcase ==`. Performance/Casecmp: Enabled: true # Use `str.{start,end}_with?(x, ..., y, ...)` instead of # `str.{start,end}_with?(x, ...) || str.{start,end}_with?(y, ...)`. Performance/DoubleStartEndWith: Enabled: true # Use `strip` instead of `lstrip.rstrip`. Performance/LstripRstrip: Enabled: true # Use `Range#cover?` instead of `Range#include?`. Performance/RangeInclude: Enabled: true # Use `sort` instead of `sort_by { |x| x }`. Performance/RedundantSortBy: Enabled: true # Use `start_with?` instead of a regex match anchored to the beginning of a # string. Performance/StartWith: Enabled: true # Use `tr` instead of `gsub` when you are replacing the same number of # characters. Use `delete` instead of `gsub` when you are deleting # characters. Performance/StringReplacement: Enabled: true # Checks for `.times.map` calls. Performance/TimesMap: Enabled: true ##################### Rails ################################## # Enables Rails cops. Rails: Enabled: true # Enforces consistent use of action filter methods. Rails/ActionFilter: Enabled: true EnforcedStyle: action # Checks the correct usage of date aware methods, such as `Date.today`, # `Date.current`, etc. Rails/Date: Enabled: false # Prefer delegate method for delegations. Rails/Delegate: Enabled: false # Prefer `find_by` over `where.first`. Rails/FindBy: Enabled: true # Prefer `all.find_each` over `all.find`. Rails/FindEach: Enabled: true # Prefer has_many :through to has_and_belongs_to_many. Rails/HasAndBelongsToMany: Enabled: true # Checks for calls to puts, print, etc. Rails/Output: Enabled: true # Checks for incorrect grammar when using methods like `3.day.ago`. Rails/PluralizationGrammar: Enabled: true # Checks for `read_attribute(:attr)` and `write_attribute(:attr, val)`. Rails/ReadWriteAttribute: Enabled: false # Checks the arguments of ActiveRecord scopes. Rails/ScopeArgs: Enabled: true ##################### RSpec ################################## # Check that instances are not being stubbed globally. RSpec/AnyInstance: Enabled: false # Check that the first argument to the top level describe is the tested class or # module. RSpec/DescribeClass: Enabled: false # Use `described_class` for tested class / module. RSpec/DescribeMethod: Enabled: false # Checks that the second argument to top level describe is the tested method # name. RSpec/DescribedClass: Enabled: false # Checks for long example. RSpec/ExampleLength: Enabled: false Max: 5 # Do not use should when describing your tests. RSpec/ExampleWording: Enabled: false CustomTransform: be: is have: has not: does not IgnoredWords: [] # Checks the file and folder naming of the spec file. RSpec/FilePath: Enabled: false CustomTransform: RuboCop: rubocop RSpec: rspec # Checks if there are focused specs. RSpec/Focus: Enabled: true # Checks for the usage of instance variables. RSpec/InstanceVariable: Enabled: false # Checks for multiple top-level describes. RSpec/MultipleDescribes: Enabled: false # Enforces the usage of the same method on all negative message expectations. RSpec/NotToNot: EnforcedStyle: not_to Enabled: true # Prefer using verifying doubles over normal doubles. RSpec/VerifiedDoubles: Enabled: false