rubocop 0.18.1 → 0.19.0

data/Rakefile

@@ -33,3 +33,11 @@ require 'yard'
 YARD::Rake::YardocTask.new
 
 Rubocop::RakeTask.new
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'rubocop'
+  ARGV.clear
+  IRB.start
+end

data/config/default.yml

@@ -11,7 +11,8 @@ AllCops:
   Includes:
     - '**/*.gemspec'
     - '**/Rakefile'
-  Excludes: []
+  Excludes:
+    - 'vendor/**'
   # By default, the rails cops are not run. Override in project or home
   # directory .rubocop.yml files, or by giving the -R/--rails option.
   RunRailsCops: false
@@ -49,6 +50,62 @@ AlignHash:
   #   a:  0
   #   bb: 1
   EnforcedColonStyle: key
+  # Select whether hashes that are the last argument in a method call should be
+  # inspected? Valid values are:
+  #
+  # always_inspect - Inspect both implicit and explicit hashes.
+  #   Registers and offence for:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offence for:
+  #     function({a: 1,
+  #       b: 2})
+  # always_ignore - Ignore both implicit and explicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_implicit - Ingore only implicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offence for:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_explicit - Ingore only explicit hashes.
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  #   Registers an offence for:
+  #     function(a: 1,
+  #       b: 2)
+  EnforcedLastArgumentHashStyle: always_inspect
+  SupportedLastArgumentHashStyles:
+    - always_inspect
+    - always_ignore
+    - ignore_implicit
+    - ignore_explicit
+
+AlignParameters:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_first_parameter` style aligns the following lines along the same column
+  # as the first parameter.
+  #
+  #     method_call(a,
+  #                 b)
+  #
+  # The `with_fixed_indentation` style alignes the following lines with one
+  # level of indenation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_first_parameter
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation
 
 # Allow safe assignment in conditions.
 AssignmentInCondition:
@@ -71,6 +128,27 @@ CaseIndentation:
     - end
   IndentOneStep: false
 
+ClassAndModuleChildren:
+  # Checks the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separat line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # The compact style is only forced, for classes / modules with one child.
+  EnforcedStyle: nested
+  SupportedStyles:
+    - nested
+    - compact
+
 ClassLength:
   CountComments: false  # count full line comments?
   Max: 100
@@ -99,7 +177,7 @@ CyclomaticComplexity:
 
 # Multi-line method chaining should be done with leading dots.
 DotPosition:
-  Style: leading
+  EnforcedStyle: leading
   SupportedStyles:
     - leading
     - trailing
@@ -129,6 +207,14 @@ For:
     - for
     - each
 
+# Enforce the method used for string formatting.
+FormatString:
+  EnforcedStyle: format
+  SupportedStyles:
+    - format
+    - sprintf
+    - percent
+
 # Built-in global variables are allowed by default.
 GlobalVars:
   AllowedVariables: []
@@ -139,6 +225,23 @@ HashSyntax:
     - ruby19
     - hash_rockets
 
+IfUnlessModifier:
+  MaxLineLength: 79
+
+# Checks the indentation of the first key in a hash literal.
+IndentHash:
+  # The value `special_inside_parentheses` means that hash literals with braces
+  # that have their opening brace on the same line as a surrounding opening
+  # round parenthesis, shall have their first key indented relative to the
+  # first position inside the parenthesis.
+  # The value `consistent` means that the indentation of the first key shall
+  # always be relative to the first position of the line where the opening
+  # brace is.
+  EnforcedStyle: special_inside_parentheses
+  SupportedStyles:
+    - special_inside_parentheses
+    - consistent
+
 LambdaCall:
   EnforcedStyle: call
   SupportedStyles:
@@ -167,13 +270,6 @@ MethodName:
 NumericLiterals:
   MinDigits: 5
 
-Output:
-  Ignore:
-    - '^.*\.rake$'
-    - '^.*/script/.*$'
-    - '^.*/tasks/.*$'
-    - 'Rakefile$'
-
 ParameterLists:
   Max: 5
   CountKeywordArgs: true
@@ -182,6 +278,18 @@ ParameterLists:
 ParenthesesAroundCondition:
   AllowSafeAssignment: true
 
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
 PredicateName:
   NamePrefixBlacklist:
     - is_
@@ -200,6 +308,8 @@ RedundantReturn:
   AllowMultipleReturnValues: false
 
 RegexpLiteral:
+  # The maximum number of (escaped) slashes that a slash-delimited regexp is
+  # allowed to have. If there are more slashes, a %r regexp shall be used.
   MaxSlashes: 1
 
 Semicolon:
@@ -216,7 +326,7 @@ SignalException:
 
 SingleLineBlockParams:
   Methods:
-    - reduce: 
+    - reduce:
         - a
         - e
     - inject:
@@ -232,11 +342,23 @@ StringLiterals:
     - single_quotes
     - double_quotes
 
-SpaceAroundBlockBraces:
-  EnforcedStyle: space_inside_braces
+SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+
+SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+
+SpaceInsideBlockBraces:
+  EnforcedStyle: space
   SupportedStyles:
-    - space_inside_braces
-    - no_space_inside_braces
+    - space
+    - no_space
   # Valid values are: space, no_space
   EnforcedStyleForEmptyBraces: no_space
   # Space between { and |. Overrides EnforcedStyle if there is a conflict.
@@ -285,11 +407,22 @@ VariableName:
     - snake_case
     - camelCase
 
+WhileUntilModifier:
+  MaxLineLength: 79
+
 WordArray:
   MinSize: 0
 
 ##################### Rails ##################################
 
+ActionFilter:
+  EnforcedStyle: action
+  SupportedStyles:
+    - action
+    - filter
+  IncludePaths:
+    -app/controllers
+
 DefaultScope:
   IncludePaths:
     - app/models
@@ -302,6 +435,10 @@ ReadAttribute:
   IncludePaths:
     - app/models
 
+ScopeArgs:
+  IncludePaths:
+    - app/models
+
 Validation:
   IncludePaths:
     - app/models

data/config/enabled.yml

@@ -85,6 +85,10 @@ ClassAndModuleCamelCase:
   Description: 'Use CamelCase for classes and modules.'
   Enabled: true
 
+ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  Enabled: true
+
 ClassLength:
   Description: 'Avoid classes longer than 100 lines of code.'
   Enabled: true
@@ -131,6 +135,10 @@ DotPosition:
   Description: 'Checks the position of the dot in multi-line method calls.'
   Enabled: true
 
+DoubleNegation:
+  Description: 'Checks for uses of double negation (!!).'
+  Enabled: true
+
 EmptyLineBetweenDefs:
   Description: 'Use empty lines between defs.'
   Enabled: true
@@ -171,10 +179,6 @@ FavorJoin:
   Description: 'Use Array#join instead of Array#*.'
   Enabled: true
 
-FavorSprintf:
-  Description: 'Use sprintf instead of String#%.'
-  Enabled: true
-
 FavorUnlessOverNegatedIf:
   Description: >-
                  Favor unless over if for negative conditions
@@ -185,6 +189,10 @@ FavorUntilOverNegatedWhile:
   Description: 'Favor until over while for negative conditions.'
   Enabled: true
 
+FileName:
+  Description: 'Use snake_case for source file names.'
+  Enabled: true
+
 FinalNewline:
   Description: 'Checks for a final newline in a source file.'
   Enabled: true
@@ -197,6 +205,10 @@ For:
   Description: 'Checks use of for or each in multiline loops.'
   Enabled: true
 
+FormatString:
+  Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
+  Enabled: true
+
 GlobalVars:
   Description: 'Do not introduce global variables.'
   Enabled: true
@@ -229,6 +241,16 @@ IndentationWidth:
   Description: 'Use 2 spaces for indentation.'
   Enabled: true
 
+IndentArray:
+  Description: >-
+                 Checks the indentation of the first element in an array
+                 literal.
+  Enabled: true
+
+IndentHash:
+  Description: 'Checks the indentation of the first key in a hash literal.'
+  Enabled: true
+
 Lambda:
   Description: 'Use the new lambda literal syntax for single-line blocks.'
   Enabled: true
@@ -244,7 +266,7 @@ LeadingCommentSpace:
 LineEndConcatenation:
   Description: 'Use \\ instead of + to concatenate two string literals at line end.'
   Enabled: true
-  
+
 LineLength:
   Description: 'Limit lines to 79 characters.'
   Enabled: true
@@ -323,6 +345,10 @@ ParenthesesAroundCondition:
                  if/unless/while.
   Enabled: true
 
+PercentLiteralDelimiters:
+  Description: 'Use `%`-literal delimiters consistently'
+  Enabled: true
+
 PerlBackrefs:
   Description: 'Avoid Perl-style regex back references.'
   Enabled: true
@@ -367,6 +393,10 @@ RescueModifier:
   Description: 'Avoid using rescue in its modifier form.'
   Enabled: true
 
+SelfAssignment:
+  Description: 'Checks for places where self-assignment shorthand should have been used.'
+  Enabled: true
+
 Semicolon:
   Description: "Don't use semicolons to terminate expressions."
   Enabled: true
@@ -409,7 +439,13 @@ SpaceAfterSemicolon:
   Description: 'Use spaces after semicolons.'
   Enabled: true
 
-SpaceAroundBlockBraces:
+SpaceBeforeBlockBraces:
+  Description: >-
+                 Checks that the left block brace has or doesn't have space
+                 before it.
+  Enabled: true
+
+SpaceInsideBlockBraces:
   Description: >-
                  Checks that block braces have or don't have surrounding space.
                  For blocks taking parameters, checks that the left brace has
@@ -418,8 +454,9 @@ SpaceAroundBlockBraces:
 
 SpaceAroundEqualsInParameterDefault:
   Description: >-
-                 Use spaces around the = operator when assigning default
-                 values in def params.
+                 Checks that the equals signs in parameter default assignments
+                 have or don't have surrounding space depending on
+                 configuration.
   Enabled: true
 
 SpaceAroundOperators:
@@ -535,6 +572,10 @@ Debugger:
   Description: 'Check for debugger calls.'
   Enabled: true
 
+DeprecatedClassMethods:
+  Description: 'Check for deprecated class method calls.'
+  Enabled: true
+
 ElseLayout:
   Description: 'Check for odd code arrangement in an else block.'
   Enabled: true
@@ -573,6 +614,10 @@ LiteralInCondition:
   Description: 'Checks of literals used in conditions.'
   Enabled: true
 
+LiteralInInterpolation:
+  Description: 'Checks for literals used in interpolation.'
+  Enabled: true
+
 Loop:
   Description: >-
                  Use Kernel#loop with break rather than begin/end/until or
@@ -601,6 +646,10 @@ ShadowingOuterLocalVariable:
                  for block arguments or block local variables.
   Enabled: true
 
+StringConversionInInterpolation:
+  Description: 'Checks for Object#to_s usage in string interpolation.'
+  Enabled: true
+
 UnreachableCode:
   Description: 'Unreachable code.'
   Enabled: true
@@ -627,6 +676,10 @@ Void:
 
 ##################### Rails ##################################
 
+ActionFilter:
+  Description: 'Enforces consistent use of action filter methods.'
+  Enabled: true
+
 DefaultScope:
   Description: 'Checks if the argument passed to default_scope is a block.'
   Enabled: true
@@ -643,6 +696,10 @@ ReadAttribute:
   Description: 'Prefer self[:attribute] over read_attribute(:attribute).'
   Enabled: true
 
+ScopeArgs:
+  Description: 'Checks the arguments of ActiveRecord scopes.'
+  Enabled: true
+
 Validation:
   Description: 'Use sexy validations.'
   Enabled: true

data/lib/rubocop.rb

@@ -15,7 +15,7 @@ require 'rubocop/version'
 require 'rubocop/path_util'
 
 require 'rubocop/cop/util'
-require 'rubocop/cop/offence'
+require 'rubocop/cop/offense'
 require 'rubocop/cop/ignored_node'
 require 'rubocop/cop/cop'
 require 'rubocop/cop/commissioner'
@@ -56,6 +56,7 @@ require 'rubocop/cop/lint/assignment_in_condition'
 require 'rubocop/cop/lint/block_alignment'
 require 'rubocop/cop/lint/condition_position'
 require 'rubocop/cop/lint/debugger'
+require 'rubocop/cop/lint/deprecated_class_methods'
 require 'rubocop/cop/lint/else_layout'
 require 'rubocop/cop/lint/empty_ensure'
 require 'rubocop/cop/lint/end_alignment'
@@ -65,11 +66,13 @@ require 'rubocop/cop/lint/eval'
 require 'rubocop/cop/lint/handle_exceptions'
 require 'rubocop/cop/lint/invalid_character_literal'
 require 'rubocop/cop/lint/literal_in_condition'
+require 'rubocop/cop/lint/literal_in_interpolation'
 require 'rubocop/cop/lint/loop'
 require 'rubocop/cop/lint/parentheses_as_grouped_expression'
 require 'rubocop/cop/lint/rescue_exception'
 require 'rubocop/cop/lint/require_parentheses'
 require 'rubocop/cop/lint/shadowing_outer_local_variable'
+require 'rubocop/cop/lint/string_conversion_in_interpolation'
 require 'rubocop/cop/lint/syntax'
 require 'rubocop/cop/lint/unreachable_code'
 require 'rubocop/cop/lint/useless_assignment'
@@ -97,6 +100,7 @@ require 'rubocop/cop/style/case_equality'
 require 'rubocop/cop/style/case_indentation'
 require 'rubocop/cop/style/character_literal'
 require 'rubocop/cop/style/class_and_module_camel_case'
+require 'rubocop/cop/style/class_and_module_children'
 require 'rubocop/cop/style/class_length'
 require 'rubocop/cop/style/class_methods'
 require 'rubocop/cop/style/class_vars'
@@ -108,6 +112,7 @@ require 'rubocop/cop/style/cyclomatic_complexity'
 require 'rubocop/cop/style/def_parentheses'
 require 'rubocop/cop/style/documentation'
 require 'rubocop/cop/style/dot_position'
+require 'rubocop/cop/style/double_negation'
 require 'rubocop/cop/style/empty_line_between_defs'
 require 'rubocop/cop/style/empty_lines'
 require 'rubocop/cop/style/empty_lines_around_access_modifier'
@@ -118,17 +123,20 @@ require 'rubocop/cop/style/end_block'
 require 'rubocop/cop/style/end_of_line'
 require 'rubocop/cop/style/even_odd'
 require 'rubocop/cop/style/favor_join'
-require 'rubocop/cop/style/favor_sprintf'
 require 'rubocop/cop/style/favor_unless_over_negated_if'
 require 'rubocop/cop/style/favor_until_over_negated_while'
+require 'rubocop/cop/style/file_name'
 require 'rubocop/cop/style/final_newline'
 require 'rubocop/cop/style/flip_flop'
 require 'rubocop/cop/style/for'
+require 'rubocop/cop/style/format_string'
 require 'rubocop/cop/style/global_vars'
 require 'rubocop/cop/style/hash_methods'
 require 'rubocop/cop/style/hash_syntax'
 require 'rubocop/cop/style/if_unless_modifier'
 require 'rubocop/cop/style/if_with_semicolon'
+require 'rubocop/cop/style/indent_array'
+require 'rubocop/cop/style/indent_hash'
 require 'rubocop/cop/style/indentation_consistency'
 require 'rubocop/cop/style/indentation_width'
 require 'rubocop/cop/style/lambda'
@@ -153,6 +161,7 @@ require 'rubocop/cop/style/one_line_conditional'
 require 'rubocop/cop/style/op_method'
 require 'rubocop/cop/style/parameter_lists'
 require 'rubocop/cop/style/parentheses_around_condition'
+require 'rubocop/cop/style/percent_literal_delimiters'
 require 'rubocop/cop/style/perl_backrefs'
 require 'rubocop/cop/style/predicate_name'
 require 'rubocop/cop/style/proc'
@@ -163,6 +172,7 @@ require 'rubocop/cop/style/redundant_return'
 require 'rubocop/cop/style/redundant_self'
 require 'rubocop/cop/style/regexp_literal'
 require 'rubocop/cop/style/rescue_modifier'
+require 'rubocop/cop/style/self_assignment'
 require 'rubocop/cop/style/semicolon'
 require 'rubocop/cop/style/signal_exception'
 require 'rubocop/cop/style/single_line_block_params'
@@ -173,10 +183,11 @@ require 'rubocop/cop/style/space_after_control_keyword'
 require 'rubocop/cop/style/space_after_method_name'
 require 'rubocop/cop/style/space_after_not'
 require 'rubocop/cop/style/space_after_semicolon'
-require 'rubocop/cop/style/space_around_block_braces'
 require 'rubocop/cop/style/space_around_equals_in_parameter_default'
 require 'rubocop/cop/style/space_around_operators'
+require 'rubocop/cop/style/space_before_block_braces'
 require 'rubocop/cop/style/space_before_modifier_keyword'
+require 'rubocop/cop/style/space_inside_block_braces'
 require 'rubocop/cop/style/space_inside_brackets'
 require 'rubocop/cop/style/space_inside_hash_literal_braces'
 require 'rubocop/cop/style/space_inside_parens'
@@ -196,10 +207,12 @@ require 'rubocop/cop/style/while_until_do'
 require 'rubocop/cop/style/while_until_modifier'
 require 'rubocop/cop/style/word_array'
 
+require 'rubocop/cop/rails/action_filter'
 require 'rubocop/cop/rails/default_scope'
 require 'rubocop/cop/rails/has_and_belongs_to_many'
 require 'rubocop/cop/rails/output'
 require 'rubocop/cop/rails/read_attribute'
+require 'rubocop/cop/rails/scope_args'
 require 'rubocop/cop/rails/validation'
 
 require 'rubocop/formatter/base_formatter'
@@ -208,9 +221,10 @@ require 'rubocop/formatter/disabled_config_formatter'
 require 'rubocop/formatter/emacs_style_formatter'
 require 'rubocop/formatter/clang_style_formatter'
 require 'rubocop/formatter/progress_formatter'
+require 'rubocop/formatter/fuubar_style_formatter'
 require 'rubocop/formatter/json_formatter'
 require 'rubocop/formatter/file_list_formatter'
-require 'rubocop/formatter/offence_count_formatter'
+require 'rubocop/formatter/offense_count_formatter'
 require 'rubocop/formatter/formatter_set'
 
 require 'rubocop/config'
@@ -218,6 +232,7 @@ require 'rubocop/config_loader'
 require 'rubocop/config_store'
 require 'rubocop/target_finder'
 require 'rubocop/token'
+require 'rubocop/comment_config'
 require 'rubocop/processed_source'
 require 'rubocop/source_parser'
 require 'rubocop/file_inspector'