rubocop 0.29.1 → 0.30.0

data/config/enabled.yml

@@ -78,7 +78,7 @@ Style/BlockEndNewline:
   Description: 'Put end statement of multiline block on its own line.'
   Enabled: true
 
-Style/Blocks:
+Style/BlockDelimiters:
   Description: >-
                 Avoid using {...} for multi-line blocks (multiline chaining is
                 always ugly).
@@ -128,11 +128,20 @@ Style/ClassVars:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-class-vars'
   Enabled: true
 
+Style/ClosingParenthesisIndentation:
+  Description: 'Checks the indentation of hanging closing parentheses.'
+  Enabled: true
+
 Style/ColonMethodCall:
   Description: 'Do not use :: for method call.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#double-colons'
   Enabled: true
 
+Style/CommandLiteral:
+  Description: 'Use `` or %x around command literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-x'
+  Enabled: true
+
 Style/CommentAnnotation:
   Description: >-
                  Checks formatting of special comments
@@ -494,11 +503,7 @@ Style/RedundantSelf:
   Enabled: true
 
 Style/RegexpLiteral:
-  Description: >-
-                 Use %r for regular expressions matching more than
-                 `MaxSlashes` '/' characters.
-                 Use %r only for regular expressions matching more than
-                 `MaxSlashes` '/' character.
+  Description: 'Use / or %r around regular expressions.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-r'
   Enabled: true
 
@@ -611,7 +616,7 @@ Style/SpaceAroundEqualsInParameterDefault:
   Enabled: true
 
 Style/SpaceAroundOperators:
-  Description: 'Use spaces around operators.'
+  Description: 'Use a single space around operators.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
   Enabled: true
 
@@ -660,6 +665,10 @@ Style/StructInheritance:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-extend-struct-new'
   Enabled: true
 
+Style/SymbolLiteral:
+  Description: 'Use plain symbols instead of string symbols when possible.'
+  Enabled: true
+
 Style/SymbolProc:
   Description: 'Use symbols as procs instead of blocks when possible.'
   Enabled: true
@@ -705,11 +714,6 @@ Style/UnneededPercentQ:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-q'
   Enabled: true
 
-Style/UnneededPercentX:
-  Description: 'Checks for %x when `` would do.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-x'
-  Enabled: true
-
 Style/VariableInterpolation:
   Description: >-
                  Don't interpolate global, instance and class variables
@@ -891,6 +895,10 @@ Lint/Loop:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#loop-with-break'
   Enabled: true
 
+Lint/NonLocalExitFromIterator:
+  Description: 'Do not use return in iterator to cause non-local exit.'
+  Enabled: true
+
 Lint/ParenthesesAsGroupedExpression:
   Description: >-
                  Checks for method calls with a space before the opening
@@ -969,12 +977,54 @@ Lint/Void:
   Description: 'Possible use of operator/literal/variable in void context.'
   Enabled: true
 
+##################### Performance #############################
+
+Performance/Detect:
+  Description: >-
+                  Use `detect` instead of `select.first`, `find_all.first`,
+                  `select.last`, and `find_all.last`.
+  Enabled: true
+
+Performance/FlatMap:
+  Description: >-
+                  Use `Enumerable#flat_map`
+                  instead of `Enumerable#map...Array#flatten(1)`
+                  or `Enumberable#collect..Array#flatten(1)`
+  Enabled: true
+  EnabledForFlattenWithoutParams: false
+  # If enabled, this cop will warn about usages of
+  # `flatten` being called without any parameters.
+  # This can be dangerous since `flat_map` will only flatten 1 level, and
+  # `flatten` without any parameters can flatten multiple levels.
+
+Performance/ReverseEach:
+  Description: 'Use `reverse_each` instead of `reverse.each`.'
+  Enabled: true
+
+Performance/Sample:
+  Description: >-
+                  Use `sample` instead of `shuffle.first`,
+                  `shuffle.last`, and `shuffle[Fixnum]`.
+  Enabled: true
+
+Performance/Size:
+  Description: >-
+                  Use `size` instead of `count` for counting
+                  the number of elements in `Array` and `Hash`.
+  Enabled: true
+
 ##################### Rails ##################################
 
 Rails/ActionFilter:
   Description: 'Enforces consistent use of action filter methods.'
   Enabled: true
 
+Rails/Date:
+  Description: >-
+                  Checks the correct usage of date aware methods,
+                  such as Date.today, Date.current etc.
+  Enabled: true
+
 Rails/DefaultScope:
   Description: 'Checks if the argument passed to default_scope is a block.'
   Enabled: true
@@ -983,6 +1033,14 @@ Rails/Delegate:
   Description: 'Prefer delegate method for delegations.'
   Enabled: true
 
+Rails/FindBy:
+  Description: 'Prefer find_by over where.first.'
+  Enabled: true
+
+Rails/FindEach:
+  Description: 'Prefer all.find_each over all.find.'
+  Enabled: true
+
 Rails/HasAndBelongsToMany:
   Description: 'Prefer has_many :through to has_and_belongs_to_many.'
   Enabled: true
@@ -1001,6 +1059,10 @@ Rails/ScopeArgs:
   Description: 'Checks the arguments of ActiveRecord scopes.'
   Enabled: true
 
+Rails/TimeZone:
+  Description: 'Checks the correct usage of time zone aware methods.'
+  Enabled: true
+
 Rails/Validation:
   Description: 'Use validates :attribute, hash of validations.'
   Enabled: true

data/lib/rubocop.rb

@@ -21,6 +21,7 @@ require 'rubocop/string_util'
 require 'rubocop/cop/util'
 require 'rubocop/cop/offense'
 require 'rubocop/cop/ignored_node'
+require 'rubocop/cop/autocorrect_logic'
 require 'rubocop/cop/cop'
 require 'rubocop/cop/commissioner'
 require 'rubocop/cop/corrector'
@@ -86,6 +87,7 @@ 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/non_local_exit_from_iterator'
 require 'rubocop/cop/lint/parentheses_as_grouped_expression'
 require 'rubocop/cop/lint/require_parentheses'
 require 'rubocop/cop/lint/rescue_exception'
@@ -113,6 +115,12 @@ require 'rubocop/cop/metrics/method_length'
 require 'rubocop/cop/metrics/parameter_lists'
 require 'rubocop/cop/metrics/perceived_complexity'
 
+require 'rubocop/cop/performance/detect'
+require 'rubocop/cop/performance/flat_map'
+require 'rubocop/cop/performance/reverse_each'
+require 'rubocop/cop/performance/sample'
+require 'rubocop/cop/performance/size'
+
 require 'rubocop/cop/style/access_modifier_indentation'
 require 'rubocop/cop/style/accessor_method_name'
 require 'rubocop/cop/style/alias'
@@ -124,11 +132,12 @@ require 'rubocop/cop/style/array_join'
 require 'rubocop/cop/style/ascii_comments'
 require 'rubocop/cop/style/ascii_identifiers'
 require 'rubocop/cop/style/attr'
+require 'rubocop/cop/style/auto_resource_cleanup'
 require 'rubocop/cop/style/bare_percent_literals'
 require 'rubocop/cop/style/begin_block'
 require 'rubocop/cop/style/block_comments'
 require 'rubocop/cop/style/block_end_newline'
-require 'rubocop/cop/style/blocks'
+require 'rubocop/cop/style/block_delimiters'
 require 'rubocop/cop/style/braces_around_hash_parameters'
 require 'rubocop/cop/style/case_equality'
 require 'rubocop/cop/style/case_indentation'
@@ -138,10 +147,13 @@ require 'rubocop/cop/style/class_and_module_children'
 require 'rubocop/cop/style/class_check'
 require 'rubocop/cop/style/class_methods'
 require 'rubocop/cop/style/class_vars'
+require 'rubocop/cop/style/closing_parenthesis_indentation'
 require 'rubocop/cop/style/collection_methods'
 require 'rubocop/cop/style/colon_method_call'
+require 'rubocop/cop/style/command_literal'
 require 'rubocop/cop/style/comment_annotation'
 require 'rubocop/cop/style/comment_indentation'
+require 'rubocop/cop/style/copyright'
 require 'rubocop/cop/style/constant_name'
 require 'rubocop/cop/style/def_with_parentheses'
 require 'rubocop/cop/style/deprecated_hash_methods'
@@ -151,6 +163,7 @@ require 'rubocop/cop/style/double_negation'
 require 'rubocop/cop/style/each_with_object'
 require 'rubocop/cop/style/else_alignment'
 require 'rubocop/cop/style/empty_else'
+require 'rubocop/cop/style/missing_else'
 require 'rubocop/cop/style/empty_line_between_defs'
 require 'rubocop/cop/style/empty_lines'
 require 'rubocop/cop/style/empty_lines_around_access_modifier'
@@ -247,6 +260,7 @@ require 'rubocop/cop/style/string_literals'
 require 'rubocop/cop/style/string_literals_in_interpolation'
 require 'rubocop/cop/style/struct_inheritance'
 require 'rubocop/cop/style/symbol_array'
+require 'rubocop/cop/style/symbol_literal'
 require 'rubocop/cop/style/symbol_proc'
 require 'rubocop/cop/style/tab'
 require 'rubocop/cop/style/trailing_blank_lines'
@@ -256,7 +270,6 @@ 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/unneeded_percent_x'
 require 'rubocop/cop/style/variable_interpolation'
 require 'rubocop/cop/style/variable_name'
 require 'rubocop/cop/style/when_then'
@@ -265,12 +278,16 @@ require 'rubocop/cop/style/while_until_modifier'
 require 'rubocop/cop/style/word_array'
 
 require 'rubocop/cop/rails/action_filter'
+require 'rubocop/cop/rails/date'
 require 'rubocop/cop/rails/default_scope'
 require 'rubocop/cop/rails/delegate'
+require 'rubocop/cop/rails/find_by'
+require 'rubocop/cop/rails/find_each'
 require 'rubocop/cop/rails/has_and_belongs_to_many'
 require 'rubocop/cop/rails/output'
 require 'rubocop/cop/rails/read_write_attribute'
 require 'rubocop/cop/rails/scope_args'
+require 'rubocop/cop/rails/time_zone'
 require 'rubocop/cop/rails/validation'
 
 require 'rubocop/formatter/base_formatter'

data/lib/rubocop/config.rb

@@ -95,8 +95,9 @@ module RuboCop
     # TODO: This should be a private method
     def validate
       # Don't validate RuboCop's own files. Avoids infinite recursion.
-      return if loaded_path.start_with?(File.join(ConfigLoader::RUBOCOP_HOME,
-                                                  'config'))
+      base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME,
+                                                    'config'))
+      return if File.expand_path(loaded_path).start_with?(base_config_path)
 
       valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
         ConfigLoader.default_configuration.key?(key)
@@ -111,14 +112,33 @@ module RuboCop
     end
 
     def file_to_include?(file)
-      absolute_file_path = File.expand_path(file)
       relative_file_path = path_relative_to_config(file)
+
+      # Optimization to quickly decide if the given file is hidden (on the top
+      # level) and can not be matched by any pattern.
+      is_hidden = relative_file_path.start_with?('.') &&
+                  !relative_file_path.start_with?('..')
+      return false if is_hidden && !possibly_include_hidden?
+
+      absolute_file_path = File.expand_path(file)
+
       patterns_to_include.any? do |pattern|
         match_path?(pattern, relative_file_path, loaded_path) ||
           match_path?(pattern, absolute_file_path, loaded_path)
       end
     end
 
+    # Returns true if there's a chance that an Include pattern matches hidden
+    # files, false if that's definitely not possible.
+    def possibly_include_hidden?
+      if @possibly_include_hidden.nil?
+        @possibly_include_hidden = patterns_to_include.any? do |s|
+          s.is_a?(Regexp) || s.start_with?('.') || s.include?('/.')
+        end
+      end
+      @possibly_include_hidden
+    end
+
     def file_to_exclude?(file)
       file = File.expand_path(file)
       patterns_to_exclude.any? do |pattern|

data/lib/rubocop/config_loader.rb

@@ -114,7 +114,7 @@ module RuboCop
         # is not possible to reproduce now, but we want to avoid it in case
         # it's still there. So we only load the YAML code if we find some real
         # code in there.
-        hash = yaml_code =~ /^[A-Z]/i ? YAML.load(yaml_code) : {}
+        hash = yaml_code =~ /^[A-Z]/i ? yaml_safe_load(yaml_code) : {}
         puts "configuration from #{absolute_path}" if debug?
 
         unless hash.is_a?(Hash)
@@ -124,6 +124,14 @@ module RuboCop
         hash
       end
 
+      def yaml_safe_load(yaml_code)
+        if YAML.respond_to?(:safe_load) # Ruby 2.1+
+          YAML.safe_load(yaml_code, [Regexp])
+        else
+          YAML.load(yaml_code)
+        end
+      end
+
       def resolve_inheritance(path, hash)
         base_configs(path, hash['inherit_from']).reverse_each do |base_config|
           base_config.each do |k, v|

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module RuboCop
+  module Cop
+    # This module encapsulates the logic for autocorrect behaviour for a cop
+    module AutocorrectLogic
+      def autocorrect?
+        autocorrect_requested? && support_autocorrect? && autocorrect_enabled?
+      end
+
+      def autocorrect_requested?
+        @options.fetch(:auto_correct, false)
+      end
+
+      def support_autocorrect?
+        respond_to?(:autocorrect, true)
+      end
+
+      def autocorrect_enabled?
+        # allow turning off autocorrect on a cop by cop basis
+        return true unless cop_config
+        cop_config['AutoCorrect'] != 'False'
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cop.rb

@@ -47,6 +47,7 @@ module RuboCop
       extend AST::Sexp
       include Util
       include IgnoredNode
+      include AutocorrectLogic
 
       attr_reader :config, :offenses, :corrections
       attr_accessor :processed_source # TODO: Bad design.
@@ -105,7 +106,7 @@ module RuboCop
 
       def initialize(config = nil, options = nil)
         @config = config || Config.new
-        @options = options || { auto_correct: false, debug: false }
+        @options = options || { debug: false }
 
         @offenses = []
         @corrections = []
@@ -119,10 +120,6 @@ module RuboCop
         @config.for_cop(self)
       end
 
-      def autocorrect?
-        @options[:auto_correct] && support_autocorrect?
-      end
-
       def debug?
         @options[:debug]
       end
@@ -132,12 +129,14 @@ module RuboCop
           config['AllCops'] && config['AllCops']['DisplayCopNames']
       end
 
-      def message(_node = nil)
-        self.class::MSG
+      def display_style_guide?
+        style_guide_url &&
+          (@options[:display_style_guide] ||
+            config['AllCops'] && config['AllCops']['DisplayStyleGuide'])
       end
 
-      def support_autocorrect?
-        respond_to?(:autocorrect, true)
+      def message(_node = nil)
+        self.class::MSG
       end
 
       def add_offense(node, loc, message = nil, severity = nil)
@@ -151,18 +150,24 @@ module RuboCop
         severity = custom_severity || severity || default_severity
 
         message ||= message(node)
-        message = display_cop_names? ? "#{name}: #{message}" : message
-
-        corrected = begin
-                      autocorrect(node) if autocorrect?
-                      autocorrect?
-                    rescue CorrectionNotPossible
-                      false
-                    end
+        message = annotate_message(message)
+
+        corrected = correct(node)
+
         @offenses << Offense.new(severity, location, message, name, corrected)
         yield if block_given?
       end
 
+      def correct(node)
+        return nil unless support_autocorrect?
+        return false unless autocorrect?
+
+        autocorrect(node)
+        true
+      rescue CorrectionNotPossible
+        false
+      end
+
       def config_to_allow_offenses
         Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name]
       end
@@ -183,8 +188,19 @@ module RuboCop
           !file_name_matches_any?(file, 'Exclude', false)
       end
 
+      def style_guide_url
+        url = cop_config && cop_config['StyleGuide']
+        (url.nil? || url.empty?) ? nil : url
+      end
+
       private
 
+      def annotate_message(message)
+        message = "#{name}: #{message}" if display_cop_names?
+        message = "#{message} (#{style_guide_url})" if display_style_guide?
+        message
+      end
+
       def file_name_matches_any?(file, parameter, default_result)
         patterns = cop_config && cop_config[parameter]
         return default_result unless patterns