rubocop 0.30.1 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15ac3af5a6e2843d6162ca7003c8c634ea775ab8
-  data.tar.gz: 405ae47879512a38f71b7a976f81e630ff747733
+  metadata.gz: c41bd779d02cd33eca9911b0c15c002ec42715b7
+  data.tar.gz: b8cacc39e2c68e7122bf50b78c163fd7b3df3e73
 SHA512:
-  metadata.gz: ad617b327afb98f2fbde6d7422101e68c75a67035ea58a10cde649d24d92ff3d24200fd298a76a08d8ec2501751c0d42f106a834f96ac32cfb6246766a5bd10b
-  data.tar.gz: 3bfc81a422483a54281b50576fe7a9fec0545bb74cc05b93ba5aa76e2a4372ac7759180e200d951cbd5b99c928373ff0b4e23cbd0788163f6bd53e25101abeb0
+  metadata.gz: 8e5e0fd412cc13b16887e3043a2e00d55cf7f65b10bd73fc00729d0ec48c13e9e6a7867616b2ba3b509f43e9a010a2db295fd5ffd944b1755189aeb695690063
+  data.tar.gz: 583b7509b1ac9536f4d78533a92376501b007275796c87bd7623575a99377610141406613f1ce8c809bbc71a146908ed82e61a9b77765bd2b4e4c387f8168c33

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 ## master (unreleased)
 
+## 0.31.0 (05/05/2015)
+
+### New features
+
+* `Rails/TimeZone` emits acceptable methods on a violation when `EnforcedStyle` is `:acceptable`. ([@l8nite][])
+* Recognize rackup file (config.ru) out of the box. ([@carhartl][])
+* [#1788](https://github.com/bbatsov/rubocop/pull/1788): New cop `ModuleLength` checks for overly long module definitions. ([@sdeframond][])
+* New cop `Performance/Count` to convert `Enumerable#select...size`, `Enumerable#reject...size`, `Enumerable#select...count`, `Enumerable#reject...count` `Enumerable#select...length`, and `Enumerable#reject...length` to `Enumerable#count`. ([@rrosenblum][])
+* `CommentAnnotation` cop does auto-correction. ([@dylandavidson][])
+* New cop `Style/TrailingUnderscoreVariable` to remove trailing underscore variables from mass assignment. ([@rrosenblum][])
+* [#1136](https://github.com/bbatsov/rubocop/issues/1136): New cop `Performance/ParallelAssignment` to avoid usages of unnessary parallel assignment. ([@rrosenblum][])
+* [#1278](https://github.com/bbatsov/rubocop/issues/1278): `DefEndAlignment` and `EndAlignment` cops do auto-correction. ([@lumeet][])
+* `IndentationWidth` cop follows the `AlignWith` option of the `DefEndAlignment` cop. ([@lumeet][])
+* [#1837](https://github.com/bbatsov/rubocop/issues/1837): New cop `EachWithObjectArgument` checks that `each_with_object` isn't called with an immutable object as argument. ([@jonas054][])
+* `ArrayJoin` cop does auto-correction. ([@tmr08c][])
+
+### Bugs fixed
+
+* [#1816](https://github.com/bbatsov/rubocop/issues/1816): Fix bug in `Sample` when calling `#shuffle` with something other than an element selector. ([@rrosenblum][])
+* [#1768](https://github.com/bbatsov/rubocop/pull/1768): `DefEndAlignment` recognizes preceding `private_class_method` or `public_class_method` before `def`. ([@til][])
+* [#1820](https://github.com/bbatsov/rubocop/issues/1820): Correct the logic in `AlignHash` for when to ignore a key because it's not on its own line. ([@jonas054][])
+* [#1829](https://github.com/bbatsov/rubocop/pull/1829): Fix bug in `Sample` and `FlatMap` that would cause them to report having been auto-corrected when they were not. ([@rrosenblum][])
+* [#1832](https://github.com/bbatsov/rubocop/pull/1832): Fix bug in `UnusedMethodArgument` that would cause them to report having been auto-corrected when they were not. ([@jonas054][])
+* [#1834](https://github.com/bbatsov/rubocop/issues/1834): Support only boolean values for `AutoCorrect` configuration parameter, and remove warning for unknown parameter. ([@jonas054][])
+* [#1843](https://github.com/bbatsov/rubocop/issues/1843): Fix crash in `TrailingBlankLines` when a file ends with a block comment without final newline. ([@jonas054][])
+* [#1849](https://github.com/bbatsov/rubocop/issues/1849): Fix bug where you can not have nested arrays in the Rake task configuration. ([@rrosenblum][])
+* Fix bug in `MultilineTernaryOperator` where it will not register an offense when only the false branch is on a separate line. ([@rrosenblum][])
+* Fix crash in `MultilineBlockLayout` when using new lambda literal syntax without parentheses. ([@hbd225][])
+* [#1859](https://github.com/bbatsov/rubocop/pull/1859): Fix bugs in `IfUnlessModifier` concerning comments and empty lines. ([@jonas054][])
+* Fix handling of trailing comma in `SpaceAroundBlockParameters` and `SpaceAfterComma`. ([@lumeet][])
+
 ## 0.30.1 (21/04/2015)
 
 ### Bugs fixed
@@ -1355,3 +1386,10 @@
 [@bankair]: https://github.com/bankair
 [@crimsonknave]: https://github.com/crimsonknave
 [@renuo]: https://github.com/renuo
+[@sdeframond]: https://github.com/sdeframond
+[@til]: https://github.com/til
+[@carhartl]: https://github.com/carhartl
+[@dylandavidson]: https://github.com/dylandavidson
+[@tmr08c]: https://github.com/tmr08c
+[@hbd225]: https://github.com/hbd225
+[@l8nite]: https://github.com/l8nite

data/README.md

@@ -384,6 +384,16 @@ Metrics/CyclomaticComplexity:
   Severity: warning
 ```
 
+#### AutoCorrect
+
+Cops that support the `--auto-correct` option can have that support
+disabled. For example:
+
+```yaml
+Style/PerlBackrefs:
+  AutoCorrect: false
+```
+
 ### Automatically Generated Configuration
 
 If you have a code base with an overwhelming amount of offenses, it can

data/config/default.yml

@@ -7,13 +7,14 @@ inherit_from:
 
 # Common configuration.
 AllCops:
-  # Include gemspec and Rakefile
+  # Include common Ruby source files.
   Include:
     - '**/*.gemspec'
     - '**/*.podspec'
     - '**/*.jbuilder'
     - '**/*.rake'
     - '**/*.opal'
+    - '**/config.ru'
     - '**/Gemfile'
     - '**/Rakefile'
     - '**/Capfile'
@@ -735,6 +736,10 @@ Metrics/ClassLength:
   CountComments: false  # count full line comments?
   Max: 100
 
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+
 # Avoid complex methods.
 Metrics/CyclomaticComplexity:
   Max: 6
@@ -776,6 +781,7 @@ Lint/EndAlignment:
   SupportedStyles:
     - keyword
     - variable
+  AutoCorrect: false
 
 Lint/DefEndAlignment:
   # The value `def` means that `end` should be aligned with the def keyword.
@@ -786,6 +792,7 @@ Lint/DefEndAlignment:
   SupportedStyles:
     - start_of_line
     - def
+  AutoCorrect: false
 
 ##################### Rails ##################################
 

data/config/enabled.yml

@@ -714,6 +714,12 @@ Style/UnneededPercentQ:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-q'
   Enabled: true
 
+Style/TrailingUnderscoreVariable:
+  Description: >-
+                 Checks for the usage of unneeded trailing underscores at the
+                 end of parallel variable assignment.
+  Enabled: true
+
 Style/VariableInterpolation:
   Description: >-
                  Don't interpolate global, instance and class variables
@@ -765,6 +771,10 @@ Metrics/ClassLength:
   Description: 'Avoid classes longer than 100 lines of code.'
   Enabled: true
 
+Metrics/ModuleLength:
+  Description: 'Avoid modules longer than 100 lines of code.'
+  Enabled: true
+
 Metrics/CyclomaticComplexity:
   Description: >-
                  A complexity metric that is strongly correlated to the number
@@ -840,6 +850,10 @@ Lint/DuplicateMethods:
   Description: 'Check for duplicate methods calls.'
   Enabled: true
 
+Lint/EachWithObjectArgument:
+  Description: 'Check for immutable argument given to each_with_object.'
+  Enabled: true
+
 Lint/ElseLayout:
   Description: 'Check for odd code arrangement in an else block.'
   Enabled: true
@@ -979,6 +993,13 @@ Lint/Void:
 
 ##################### Performance #############################
 
+Performance/Count:
+  Description: >-
+                  Use `count` instead of `select...size`, `reject...size`,
+                  `select...count`, `reject...count`, `select...length`,
+                  and `reject...length`.
+  Enabled: true
+
 Performance/Detect:
   Description: >-
                   Use `detect` instead of `select.first`, `find_all.first`,
@@ -997,6 +1018,13 @@ Performance/FlatMap:
   # This can be dangerous since `flat_map` will only flatten 1 level, and
   # `flatten` without any parameters can flatten multiple levels.
 
+Performance/ParallelAssignment:
+  Description: >-
+                  Check for simple usages of parallel assignment.
+                  It will only warn when the number of variables
+                  matches on both sides of the assignment.
+  Enabled: true
+
 Performance/ReverseEach:
   Description: 'Use `reverse_each` instead of `reverse.each`.'
   Enabled: true

data/lib/rubocop.rb

@@ -45,6 +45,7 @@ require 'rubocop/cop/mixin/autocorrect_unless_changing_ast'
 require 'rubocop/cop/mixin/check_assignment'
 require 'rubocop/cop/mixin/configurable_max'
 require 'rubocop/cop/mixin/code_length'
+require 'rubocop/cop/mixin/classish_length'
 require 'rubocop/cop/mixin/configurable_enforced_style'
 require 'rubocop/cop/mixin/configurable_naming'
 require 'rubocop/cop/mixin/empty_lines_around_body'
@@ -53,6 +54,7 @@ require 'rubocop/cop/mixin/if_node'
 require 'rubocop/cop/mixin/negative_conditional'
 require 'rubocop/cop/mixin/on_method_def'
 require 'rubocop/cop/mixin/method_complexity'
+require 'rubocop/cop/mixin/min_body_length'
 require 'rubocop/cop/mixin/on_normal_if_unless'
 require 'rubocop/cop/mixin/parser_diagnostic'
 require 'rubocop/cop/mixin/percent_literal'
@@ -75,6 +77,7 @@ require 'rubocop/cop/lint/debugger'
 require 'rubocop/cop/lint/def_end_alignment'
 require 'rubocop/cop/lint/deprecated_class_methods'
 require 'rubocop/cop/lint/duplicate_methods'
+require 'rubocop/cop/lint/each_with_object_argument'
 require 'rubocop/cop/lint/else_layout'
 require 'rubocop/cop/lint/empty_ensure'
 require 'rubocop/cop/lint/empty_interpolation'
@@ -108,6 +111,7 @@ require 'rubocop/cop/lint/void'
 
 require 'rubocop/cop/metrics/block_nesting'
 require 'rubocop/cop/metrics/class_length'
+require 'rubocop/cop/metrics/module_length'
 require 'rubocop/cop/metrics/cyclomatic_complexity'
 require 'rubocop/cop/metrics/abc_size'
 require 'rubocop/cop/metrics/line_length'
@@ -115,8 +119,10 @@ require 'rubocop/cop/metrics/method_length'
 require 'rubocop/cop/metrics/parameter_lists'
 require 'rubocop/cop/metrics/perceived_complexity'
 
+require 'rubocop/cop/performance/count'
 require 'rubocop/cop/performance/detect'
 require 'rubocop/cop/performance/flat_map'
+require 'rubocop/cop/performance/parallel_assignment'
 require 'rubocop/cop/performance/reverse_each'
 require 'rubocop/cop/performance/sample'
 require 'rubocop/cop/performance/size'
@@ -270,6 +276,7 @@ require 'rubocop/cop/style/trivial_accessors'
 require 'rubocop/cop/style/unless_else'
 require 'rubocop/cop/style/unneeded_capital_w'
 require 'rubocop/cop/style/unneeded_percent_q'
+require 'rubocop/cop/style/trailing_underscore_variable'
 require 'rubocop/cop/style/variable_interpolation'
 require 'rubocop/cop/style/variable_name'
 require 'rubocop/cop/style/when_then'

data/lib/rubocop/cli.rb

@@ -4,6 +4,8 @@ module RuboCop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
   class CLI
+    include Formatter::TextUtil
+
     attr_reader :options, :config_store
 
     def initialize
@@ -100,8 +102,7 @@ module RuboCop
     def display_error_summary(errors)
       return if errors.empty?
 
-      plural = errors.count > 1 ? 's' : ''
-      warn "\n#{errors.count} error#{plural} occurred:".color(:red)
+      warn "\n#{pluralize(errors.size, 'error')} occurred:".color(:red)
 
       errors.each { |error| warn error }
 

data/lib/rubocop/config.rb

@@ -14,14 +14,13 @@ module RuboCop
 
     class ValidationError < StandardError; end
 
-    COMMON_PARAMS = %w(Exclude Include Severity)
+    COMMON_PARAMS = %w(Exclude Include Severity AutoCorrect)
 
     attr_reader :loaded_path
 
     def initialize(hash = {}, loaded_path = nil)
-      @hash = hash
       @loaded_path = loaded_path
-      super(@hash)
+      super(hash)
     end
 
     def make_excludes_absolute
@@ -31,9 +30,8 @@ module RuboCop
 
         self[key]['Exclude'].map! do |exclude_elem|
           if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
-            File.expand_path(
-              File.join(base_dir_for_path_parameters, exclude_elem)
-            )
+            File.expand_path(File.join(base_dir_for_path_parameters,
+                                       exclude_elem))
           else
             exclude_elem
           end
@@ -102,13 +100,12 @@ module RuboCop
                                                     'config'))
       return if File.expand_path(loaded_path).start_with?(base_config_path)
 
-      valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
+      valid_cop_names, invalid_cop_names = keys.partition do |key|
         ConfigLoader.default_configuration.key?(key)
       end
 
       invalid_cop_names.each do |name|
-        fail ValidationError,
-             "unrecognized cop #{name} found in #{loaded_path || self}"
+        fail ValidationError, "unrecognized cop #{name} found in #{loaded_path}"
       end
 
       validate_parameter_names(valid_cop_names)
@@ -150,11 +147,11 @@ module RuboCop
     end
 
     def patterns_to_include
-      @hash['AllCops']['Include']
+      self['AllCops']['Include']
     end
 
     def patterns_to_exclude
-      @hash['AllCops']['Exclude']
+      self['AllCops']['Exclude']
     end
 
     def path_relative_to_config(path)
@@ -176,22 +173,19 @@ module RuboCop
     private
 
     def validate_section_presence(name)
-      return unless @hash.key?(name) && @hash[name].nil?
-      fail ValidationError,
-           "empty section #{name} found " \
-           "in #{loaded_path || self}"
+      return unless key?(name) && self[name].nil?
+      fail ValidationError, "empty section #{name} found in #{loaded_path}"
     end
 
     def validate_parameter_names(valid_cop_names)
       valid_cop_names.each do |name|
         validate_section_presence(name)
-        @hash[name].each_key do |param|
+        self[name].each_key do |param|
           next if COMMON_PARAMS.include?(param) ||
                   ConfigLoader.default_configuration[name].key?(param)
 
           fail ValidationError,
-               "unrecognized parameter #{name}:#{param} found " \
-               "in #{loaded_path || self}"
+               "unrecognized parameter #{name}:#{param} found in #{loaded_path}"
         end
       end
     end

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -19,7 +19,7 @@ module RuboCop
       def autocorrect_enabled?
         # allow turning off autocorrect on a cop by cop basis
         return true unless cop_config
-        cop_config['AutoCorrect'] != 'False'
+        cop_config['AutoCorrect'] != false
       end
     end
   end

data/lib/rubocop/cop/cop.rb

@@ -2,7 +2,6 @@
 
 module RuboCop
   module Cop
-    class CorrectionNotPossible < Exception; end
     class AmbiguousCopName < Exception; end
 
     # Store for all cops with helper functions
@@ -22,6 +21,28 @@ module RuboCop
       def without_type(type)
         CopStore.new(reject { |c| c.cop_type == type })
       end
+
+      def qualified_cop_name(name, origin)
+        @cop_names ||= Set.new(map(&:cop_name))
+        basename = File.basename(name)
+        found_ns = types.map(&:capitalize).select do |ns|
+          @cop_names.include?("#{ns}/#{basename}")
+        end
+
+        case found_ns.size
+        when 0 then name # No namespace found. Deal with it later in caller.
+        when 1 then cop_name_with_namespace(name, origin, basename, found_ns[0])
+        else fail AmbiguousCopName, "`#{basename}` used in #{origin}"
+        end
+      end
+
+      def cop_name_with_namespace(name, origin, basename, found_ns)
+        if name != basename && found_ns != File.dirname(name).to_sym
+          warn "#{origin}: #{name} has the wrong namespace - should be " \
+               "#{found_ns}"
+        end
+        "#{found_ns}/#{basename}"
+      end
     end
 
     # A scaffold for concrete cops.
@@ -59,25 +80,7 @@ module RuboCop
       end
 
       def self.qualified_cop_name(name, origin)
-        @cop_names ||= Set.new(all.map(&:cop_name))
-        basename = File.basename(name)
-        found_ns = @all.types.map(&:capitalize).select do |ns|
-          @cop_names.include?("#{ns}/#{basename}")
-        end
-
-        case found_ns.size
-        when 0 then name # No namespace found. Deal with it later in caller.
-        when 1 then cop_name_with_namespace(name, origin, basename, found_ns[0])
-        else fail AmbiguousCopName, "`#{basename}` used in #{origin}"
-        end
-      end
-
-      def self.cop_name_with_namespace(name, origin, basename, found_ns)
-        if name != basename && found_ns != File.dirname(name).to_sym
-          warn "#{origin}: #{name} has the wrong namespace - should be " \
-               "#{found_ns}"
-        end
-        "#{found_ns}/#{basename}"
+        @all.qualified_cop_name(name, origin)
       end
 
       def self.non_rails
@@ -135,6 +138,15 @@ module RuboCop
             config['AllCops'] && config['AllCops']['DisplayStyleGuide'])
       end
 
+      # Returns true if the cop name or the cop namespace matches any of the
+      # given names.
+      def self.match?(given_names)
+        return false unless given_names
+
+        given_names.include?(cop_name) ||
+          given_names.include?(cop_type.to_s.capitalize)
+      end
+
       def message(_node = nil)
         self.class::MSG
       end
@@ -162,10 +174,10 @@ module RuboCop
         return nil unless support_autocorrect?
         return false unless autocorrect?
 
-        autocorrect(node)
+        correction = autocorrect(node)
+        return false unless correction
+        @corrections << correction
         true
-      rescue CorrectionNotPossible
-        false
       end
 
       def config_to_allow_offenses

data/lib/rubocop/cop/lint/block_alignment.rb

@@ -143,7 +143,7 @@ module RuboCop
           ancestor_node = ancestor_on_same_line(node)
           source = node.loc.expression.source_buffer
 
-          @corrections << lambda do |corrector|
+          lambda do |corrector|
             start_col = (ancestor_node || node).loc.expression.column
             starting_position_of_block_end = node.loc.end.begin_pos
             end_col = node.loc.end.column

data/lib/rubocop/cop/lint/def_end_alignment.rb

@@ -45,6 +45,12 @@ module RuboCop
 
           ignore_node(method_def) # Don't check the same `end` again.
         end
+
+        private
+
+        def autocorrect(node)
+          align(node, style == :start_of_line ? node.ancestors.first : node)
+        end
       end
     end
   end