rubocop 0.39.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfcbbab3c5c192b9ec4f2af0d65ef6af2218196a
-  data.tar.gz: 13951f737deacbbca91730cafca92ed861e5b4b9
+  metadata.gz: c54ef854713e3c180b88e86b627ef3694c44b080
+  data.tar.gz: be923c307bd8873232a0955f2ebc917219967994
 SHA512:
-  metadata.gz: 938228431a9934dc8916618e35256c75bf5a95ad3387933019599ecc242a3281ce2a234f3a174793634b44bcf5043b924ee18f1949f3abfd97e67c8db1aea088
-  data.tar.gz: 20459e73a5a9fbe29eeac14413a6f2e54253692d474e01cde4ec1155dfff8010a1202297b1d35a4d422cddc27d7d15a2f633725d1ebe6e63ffff41bf672f8114
+  metadata.gz: 007d8566d96c61467cfa6c700642c0cc1023781b575c6a438f5e64638d378a507886c59259db8e51e1b7d7b30be1e9e8bf5d454eeff75a735165e686ced8b85f
+  data.tar.gz: 908bceb1c0eb19cf3e290d9f620dc6e4a75fbc22c4bc5a749e164203a70166db544659c5cb8bfc4355207d2ae2f043358e566700032e0f887318d1bdfcf81be7

data/README.md

@@ -42,6 +42,7 @@ specific RuboCop release.**
         - [Style](#style)
         - [Lint](#lint)
         - [Metrics](#metrics)
+        - [Performance](#performance)
         - [Rails](#rails)
 - [Configuration](#configuration)
     - [Inheritance](#inheritance)
@@ -60,6 +61,7 @@ specific RuboCop release.**
     - [File List Formatter](#file-list-formatter)
     - [JSON Formatter](#json-formatter)
     - [Offense Count Formatter](#offense-count-formatter)
+    - [Worst Offenders Formatter](#worst-offenders-formatter)
     - [HTML Formatter](#html-formatter)
 - [Compatibility](#compatibility)
 - [Editor integration](#editor-integration)
@@ -92,6 +94,7 @@ specific RuboCop release.**
 - [Logo](#logo)
 - [Contributors](#contributors)
 - [Mailing List](#mailing-list)
+- [Freenode](#freenode)
 - [Changelog](#changelog)
 - [Copyright](#copyright)
 
@@ -115,7 +118,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version locking in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.39.0', require: false
+gem 'rubocop', '~> 0.40.0', require: false
 ```
 
 ## Basic Usage
@@ -200,6 +203,13 @@ Command flag              | Description
 `-s/--stdin`              | Pipe source from STDIN. This is useful for editor integration.
 `--[no-]color`            | Force color output on or off.
 
+Default command-line options are loaded from `.rubocop` and `RUBOCOP_OPTS` and are combined with command-line options that are explicitly passed to `rubocop`.
+Thus, the options have the following order of precedence (from highest to lowest):
+
+1. Explicit command-line options
+2. Options from `RUBOCOP_OPTS` environment variable
+3. Options from `.rubocop` file.
+
 ### Cops
 
 In RuboCop lingo the various checks performed on the code are called cops. There are several cop departments.

data/config/default.yml

@@ -425,10 +425,11 @@ Style/EmptyLinesAroundModuleBody:
 # AutoCorrectEncodingComment must match the regex
 # /#.*coding\s?[:=]\s?(?:UTF|utf)-8/
 Style/Encoding:
-  EnforcedStyle: always
+  EnforcedStyle: never
   SupportedStyles:
     - when_needed
     - always
+    - never
   AutoCorrectEncodingComment: '# encoding: utf-8'
 
 Style/ExtraSpacing:
@@ -590,6 +591,13 @@ Style/IndentHash:
   # But it can be overridden by setting this parameter
   IndentationWidth: ~
 
+Style/Lambda:
+  EnforcedStyle: line_count_dependent
+  SupportedStyles:
+    - line_count_dependent
+    - lambda
+    - literal
+
 Style/LambdaCall:
   EnforcedStyle: call
   SupportedStyles:
@@ -630,6 +638,16 @@ Style/MethodName:
     - snake_case
     - camelCase
 
+Style/MultilineArrayBraceLayout:
+  EnforcedStyle: symmetrical
+  SupportedStyles:
+    # symmetrical: closing brace is positioned in same way as opening brace
+    # new_line: closing brace is always on a new line
+    # same_line: closing brace is always on the same line as last element
+    - symmetrical
+    - new_line
+    - same_line
+
 Style/MultilineAssignmentLayout:
   # The types of assignments which are subject to this rule.
   SupportedTypes:
@@ -648,6 +666,26 @@ Style/MultilineAssignmentLayout:
     # for the set of supported types.
     - new_line
 
+Style/MultilineHashBraceLayout:
+  EnforcedStyle: symmetrical
+  SupportedStyles:
+    # symmetrical: closing brace is positioned in same way as opening brace
+    # new_line: closing brace is always on a new line
+    # same_line: closing brace is always on same line as last element
+    - symmetrical
+    - new_line
+    - same_line
+
+Style/MultilineMethodCallBraceLayout:
+  EnforcedStyle: symmetrical
+  SupportedStyles:
+    # symmetrical: closing brace is positioned in same way as opening brace
+    # new_line: closing brace is always on a new line
+    # same_line: closing brace is always on the same line as last argument
+    - symmetrical
+    - new_line
+    - same_line
+
 Style/MultilineMethodCallIndentation:
   EnforcedStyle: aligned
   SupportedStyles:
@@ -657,6 +695,16 @@ Style/MultilineMethodCallIndentation:
   # But it can be overridden by setting this parameter
   IndentationWidth: ~
 
+Style/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: symmetrical
+  SupportedStyles:
+    # symmetrical: closing brace is positioned in same way as opening brace
+    # new_line: closing brace is always on a new line
+    # same_line: closing brace is always on the same line as last parameter
+    - symmetrical
+    - new_line
+    - same_line
+
 Style/MultilineOperationIndentation:
   EnforcedStyle: aligned
   SupportedStyles:
@@ -715,6 +763,10 @@ Style/PredicateName:
   # should still be accepted
   NameWhitelist:
     - is_a?
+  # Exclude Rspec specs because there is a strong convetion to write spec
+  # helpers in the form of `have_something` or `be_something`.
+  Exclude:
+    - 'spec/**/*'
 
 Style/RaiseArgs:
   EnforcedStyle: exploded
@@ -864,6 +916,7 @@ Style/SymbolProc:
   # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
   IgnoredMethods:
     - respond_to
+    - define_method
 
 Style/TrailingBlankLines:
   EnforcedStyle: final_newline
@@ -944,11 +997,17 @@ Style/VariableName:
 Style/WhileUntilModifier:
   MaxLineLength: 80
 
+# WordArray enforces how array literals of word-like strings should be expressed.
 Style/WordArray:
   EnforcedStyle: percent
   SupportedStyles:
+    # percent style: %w(word1 word2)
     - percent
+    # bracket style: ['word1', 'word2']
     - brackets
+  # The MinSize option causes the WordArray rule to be ignored for arrays
+  # smaller than a certain size.  The rule is only applied to arrays
+  # whose element count is greater than or equal to MinSize.
   MinSize: 0
   # The regular expression WordRegex decides what is considered a word.
   WordRegex: !ruby/regexp '/\A[\p{Word}\n\t]+\z/'
@@ -1006,7 +1065,7 @@ Lint/AssignmentInCondition:
 Lint/BlockAlignment:
   # The value `start_of_block` means that the `end` should be aligned with line
   # where the `do` keyword appears.
-  # The value `start_of_line` means it should be aligned with the whole 
+  # The value `start_of_line` means it should be aligned with the whole
   # expression's starting line.
   # The value `either` means both are allowed.
   AlignWith: either
@@ -1051,6 +1110,10 @@ Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: false
   IgnoreEmptyMethods: true
 
+# Checks for unused block arguments.
+Lint/UnusedBlockArgument:
+  AllowUnusedKeywordArguments: false
+
 ##################### Performance ############################
 
 Performance/RedundantMerge:

data/config/disabled.yml

@@ -73,39 +73,11 @@ Style/MissingElse:
     - case
     - both
 
-Style/MultilineArrayBraceLayout:
-  Description: >-
-                 Checks that the closing brace in an array literal is
-                 symmetrical with respect to the opening brace and the
-                 array elements.
-  Enabled: false
-
 Style/MultilineAssignmentLayout:
   Description: 'Check for a newline after the assignment operator in multi-line assignments.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#indent-conditional-assignment'
   Enabled: false
 
-Style/MultilineHashBraceLayout:
-  Description: >-
-                 Checks that the closing brace in a hash literal is
-                 symmetrical with respect to the opening brace and the
-                 hash elements.
-  Enabled: false
-
-Style/MultilineMethodCallBraceLayout:
-  Description: >-
-                 Checks that the closing brace in a method call is
-                 symmetrical with respect to the opening brace and the
-                 method arguments.
-  Enabled: false
-
-Style/MultilineMethodDefinitionBraceLayout:
-  Description: >-
-                 Checks that the closing brace in a method definition is
-                 symmetrical with respect to the opening brace and the
-                 method parameters.
-  Enabled: false
-
 Style/OptionHash:
   Description: "Don't use option hashes when you can use keyword arguments."
   Enabled: false

data/config/enabled.yml

@@ -204,6 +204,10 @@ Style/EmptyElse:
   Description: 'Avoid empty else-clauses.'
   Enabled: true
 
+Style/EmptyCaseCondition:
+  Description: 'Avoid empty condition in case statements.'
+  Enabled: true
+
 Style/EmptyLineBetweenDefs:
   Description: 'Use empty lines between defs.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods'
@@ -411,6 +415,13 @@ Style/ModuleFunction:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#module-function'
   Enabled: true
 
+Style/MultilineArrayBraceLayout:
+  Description: >-
+                 Checks that the closing brace in an array literal is
+                 either on the same line as the last array element, or
+                 a new line.
+  Enabled: true
+
 Style/MultilineBlockChain:
   Description: 'Avoid multi-line chains of blocks.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
@@ -420,17 +431,38 @@ Style/MultilineBlockLayout:
   Description: 'Ensures newlines after multiline block do statements.'
   Enabled: true
 
+Style/MultilineHashBraceLayout:
+  Description: >-
+                 Checks that the closing brace in a hash literal is
+                 either on the same line as the last hash element, or
+                 a new line.
+  Enabled: true
+
 Style/MultilineIfThen:
   Description: 'Do not use then for multi-line if/unless.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-then'
   Enabled: true
 
+Style/MultilineMethodCallBraceLayout:
+  Description: >-
+                 Checks that the closing brace in a method call is
+                 either on the same line as the last method argument, or
+                 a new line.
+  Enabled: true
+
 Style/MultilineMethodCallIndentation:
   Description: >-
                  Checks indentation of method calls with the dot operator
                  that span more than one line.
   Enabled: true
 
+Style/MultilineMethodDefinitionBraceLayout:
+  Description: >-
+                 Checks that the closing brace in a method definition is
+                 either on the same line as the last method parameter, or
+                 a new line.
+  Enabled: true
+
 Style/MultilineOperationIndentation:
   Description: >-
                  Checks indentation of binary operations that span more than
@@ -1135,6 +1167,10 @@ Lint/UselessAccessModifier:
   Description: 'Checks for useless access modifiers.'
   Enabled: true
 
+Lint/UselessArraySplat:
+  Description: 'Checks for useless array splats.'
+  Enabled: true
+
 Lint/UselessAssignment:
   Description: 'Checks for useless assignment to a local variable.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
@@ -1347,6 +1383,10 @@ Rails/TimeZone:
   Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
   Enabled: true
 
+Rails/UniqBeforePluck:
+  Description: 'Prefer the use of uniq before pluck.'
+  Enabled: true
+
 Rails/Validation:
   Description: 'Use validates :attribute, hash of validations.'
   Enabled: true

data/lib/rubocop.rb

@@ -128,6 +128,7 @@ require 'rubocop/cop/lint/unreachable_code'
 require 'rubocop/cop/lint/unused_block_argument'
 require 'rubocop/cop/lint/unused_method_argument'
 require 'rubocop/cop/lint/useless_access_modifier'
+require 'rubocop/cop/lint/useless_array_splat'
 require 'rubocop/cop/lint/useless_assignment'
 require 'rubocop/cop/lint/useless_comparison'
 require 'rubocop/cop/lint/useless_else_without_rescue'
@@ -208,6 +209,7 @@ require 'rubocop/cop/style/dot_position'
 require 'rubocop/cop/style/double_negation'
 require 'rubocop/cop/style/each_with_object'
 require 'rubocop/cop/style/else_alignment'
+require 'rubocop/cop/style/empty_case_condition'
 require 'rubocop/cop/style/empty_else'
 require 'rubocop/cop/style/empty_line_between_defs'
 require 'rubocop/cop/style/empty_lines'
@@ -366,6 +368,7 @@ require 'rubocop/cop/rails/pluralization_grammar'
 require 'rubocop/cop/rails/read_write_attribute'
 require 'rubocop/cop/rails/scope_args'
 require 'rubocop/cop/rails/time_zone'
+require 'rubocop/cop/rails/uniq_before_pluck'
 require 'rubocop/cop/rails/validation'
 
 require 'rubocop/cop/team'

data/lib/rubocop/ast_node.rb

@@ -419,13 +419,13 @@ module RuboCop
       kind_filter = :"#{kind}?"
       define_method(recursive_kind) do
         case type
-        when :begin, :pair, *OPERATOR_KEYWORDS, *COMPOSITE_LITERALS
-          children.all?(&recursive_kind)
         when :send
           receiver, method_name, *args = *self
           COMPARISON_OPERATORS.include?(method_name) &&
             receiver.send(recursive_kind) &&
             args.all?(&recursive_kind)
+        when :begin, :pair, *OPERATOR_KEYWORDS, *COMPOSITE_LITERALS
+          children.all?(&recursive_kind)
         else
           send(kind_filter)
         end
@@ -503,7 +503,6 @@ module RuboCop
     def value_used?
       # Be conservative and return true if we're not sure
       return false if parent.nil?
-      index = parent.children.index { |child| child.equal?(self) }
 
       case parent.type
       when :array, :defined?, :dstr, :dsym, :eflipflop, :erange, :float,
@@ -511,19 +510,13 @@ module RuboCop
            :xstr
         parent.value_used?
       when :begin, :kwbegin
-        # the last child node determines the value of the parent
-        index == parent.children.size - 1 ? parent.value_used? : false
+        begin_value_used?
       when :for
-        # `for var in enum; body; end`
-        # (for <var> <enum> <body>)
-        index == 2 ? parent.value_used? : true
+        for_value_used?
       when :case, :if
-        # (case <condition> <when...>)
-        # (if <condition> <truebranch> <falsebranch>)
-        index == 0 ? true : parent.value_used?
+        case_if_value_used?
       when :while, :until, :while_post, :until_post
-        # (while <condition> <body>) -> always evaluates to `nil`
-        index == 0
+        while_until_value_used?
       else
         true
       end
@@ -589,5 +582,27 @@ module RuboCop
         last_node = current_node
       end
     end
+
+    def begin_value_used?
+      # the last child node determines the value of the parent
+      sibling_index == parent.children.size - 1 ? parent.value_used? : false
+    end
+
+    def for_value_used?
+      # `for var in enum; body; end`
+      # (for <var> <enum> <body>)
+      sibling_index == 2 ? parent.value_used? : true
+    end
+
+    def case_if_value_used?
+      # (case <condition> <when...>)
+      # (if <condition> <truebranch> <falsebranch>)
+      sibling_index == 0 ? true : parent.value_used?
+    end
+
+    def while_until_value_used?
+      # (while <condition> <body>) -> always evaluates to `nil`
+      sibling_index == 0
+    end
   end
 end

data/lib/rubocop/cached_data.rb

@@ -47,8 +47,7 @@ module RuboCop
 
     # Restore an offense object loaded from a JSON file.
     def deserialize_offenses(offenses)
-      source_buffer = Parser::Source::Buffer.new(@filename)
-      source_buffer.read
+      source_buffer = utf8_source_buffer
       offenses.map! do |o|
         location = Parser::Source::Range.new(source_buffer,
                                              o['location']['begin_pos'],
@@ -61,5 +60,19 @@ module RuboCop
                          o['cop_name'], o['status'].to_sym)
       end
     end
+
+    # Return a source buffer that has a UTF-8 encoded source.
+    def utf8_source_buffer
+      # We are given a source with an encoding of ASCII-8BIT
+      ascii_source = Parser::Source::Buffer.new(@filename).read.source
+
+      # Correct the encoding of the source as we expect UTF-8
+      source = ascii_source.dup.force_encoding('UTF-8')
+
+      # The existing source is immutable so we need a new object
+      source_buffer = Parser::Source::Buffer.new(@filename)
+      source_buffer.source = source
+      source_buffer
+    end
   end
 end