rubocop 0.26.1 → 0.27.0

data/config/disabled.yml

@@ -1,5 +1,10 @@
 # These are all the cops that are disabled in the default configuration.
 
+Style/CollectionMethods:
+  Description: 'Preferred collection methods.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#map-fine-select-reduce-size'
+  Enabled: false
+
 Style/Encoding:
   Description: 'Use UTF-8 as the source file encoding.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#utf-8'

data/config/enabled.yml

@@ -128,11 +128,6 @@ Style/ClassVars:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-class-vars'
   Enabled: true
 
-Style/CollectionMethods:
-  Description: 'Preferred collection methods.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#map-fine-select-reduce-size'
-  Enabled: true
-
 Style/ColonMethodCall:
   Description: 'Do not use :: for method call.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#double-colons'
@@ -182,6 +177,10 @@ Style/EachWithObject:
   Description: 'Prefer `each_with_object` over `inject` or `reduce`.'
   Enabled: true
 
+Style/ElseAlignment:
+  Description: 'Align elses and elsifs correctly.'
+  Enabled: true
+
 Style/EmptyLineBetweenDefs:
   Description: 'Use empty lines between defs.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods'
@@ -195,8 +194,16 @@ Style/EmptyLinesAroundAccessModifier:
   Description: "Keep blank lines around access modifiers."
   Enabled: true
 
-Style/EmptyLinesAroundBody:
-  Description: "Keeps track of empty lines around expression bodies."
+Style/EmptyLinesAroundClassBody:
+  Description: "Keeps track of empty lines around class bodies."
+  Enabled: true
+
+Style/EmptyLinesAroundModuleBody:
+  Description: "Keeps track of empty lines around module bodies."
+  Enabled: true
+
+Style/EmptyLinesAroundMethodBody:
+  Description: "Keeps track of empty lines around method bodies."
   Enabled: true
 
 Style/EmptyLiteral:
@@ -349,6 +356,12 @@ Style/MultilineIfThen:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-then'
   Enabled: true
 
+Style/MultilineOperationIndentation:
+  Description: >-
+                 Checks indentation of binary operations that span more than
+                 one line.
+  Enabled: true
+
 Style/MultilineTernaryOperator:
   Description: >-
                  Avoid multi-line ?: (the ternary operator);
@@ -620,6 +633,12 @@ Style/StringLiterals:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
   Enabled: true
 
+Style/StringLiteralsInInterpolation:
+  Description: >-
+                 Checks if uses of quotes inside expressions in interpolated
+                 strings match the configured preference.
+  Enabled: true
+
 Style/SymbolProc:
   Description: 'Use symbols as procs instead of blocks when possible.'
   Enabled: true
@@ -706,6 +725,12 @@ Style/WordArray:
 
 #################### Metrics ################################
 
+Metrics/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Enabled: true
+
 Metrics/BlockNesting:
   Description: 'Avoid excessive block nesting'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'

data/lib/rubocop.rb

@@ -46,10 +46,11 @@ require 'rubocop/cop/mixin/configurable_max'
 require 'rubocop/cop/mixin/code_length'
 require 'rubocop/cop/mixin/configurable_enforced_style'
 require 'rubocop/cop/mixin/configurable_naming'
+require 'rubocop/cop/mixin/empty_lines_around_body'
 require 'rubocop/cop/mixin/end_keyword_alignment'
 require 'rubocop/cop/mixin/if_node'
 require 'rubocop/cop/mixin/negative_conditional'
-require 'rubocop/cop/mixin/on_method'
+require 'rubocop/cop/mixin/on_method_def'
 require 'rubocop/cop/mixin/method_complexity'
 require 'rubocop/cop/mixin/on_normal_if_unless'
 require 'rubocop/cop/mixin/parser_diagnostic'
@@ -61,6 +62,7 @@ require 'rubocop/cop/mixin/space_after_punctuation'
 require 'rubocop/cop/mixin/space_before_punctuation'
 require 'rubocop/cop/mixin/statement_modifier'
 require 'rubocop/cop/mixin/string_help'
+require 'rubocop/cop/mixin/string_literals_help'
 require 'rubocop/cop/mixin/unused_argument'
 
 require 'rubocop/cop/lint/ambiguous_operator'
@@ -104,6 +106,7 @@ require 'rubocop/cop/lint/void'
 require 'rubocop/cop/metrics/block_nesting'
 require 'rubocop/cop/metrics/class_length'
 require 'rubocop/cop/metrics/cyclomatic_complexity'
+require 'rubocop/cop/metrics/abc_size'
 require 'rubocop/cop/metrics/line_length'
 require 'rubocop/cop/metrics/method_length'
 require 'rubocop/cop/metrics/parameter_lists'
@@ -145,10 +148,13 @@ require 'rubocop/cop/style/documentation'
 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_line_between_defs'
 require 'rubocop/cop/style/empty_lines'
 require 'rubocop/cop/style/empty_lines_around_access_modifier'
-require 'rubocop/cop/style/empty_lines_around_body'
+require 'rubocop/cop/style/empty_lines_around_class_body'
+require 'rubocop/cop/style/empty_lines_around_method_body'
+require 'rubocop/cop/style/empty_lines_around_module_body'
 require 'rubocop/cop/style/empty_literal'
 require 'rubocop/cop/style/encoding'
 require 'rubocop/cop/style/end_block'
@@ -181,6 +187,7 @@ require 'rubocop/cop/style/module_function'
 require 'rubocop/cop/style/multiline_block_chain'
 require 'rubocop/cop/style/multiline_block_layout'
 require 'rubocop/cop/style/multiline_if_then'
+require 'rubocop/cop/style/multiline_operation_indentation'
 require 'rubocop/cop/style/multiline_ternary_operator'
 require 'rubocop/cop/style/negated_if'
 require 'rubocop/cop/style/negated_while'
@@ -231,6 +238,7 @@ require 'rubocop/cop/style/space_inside_parens'
 require 'rubocop/cop/style/space_inside_range_literal'
 require 'rubocop/cop/style/special_global_vars'
 require 'rubocop/cop/style/string_literals'
+require 'rubocop/cop/style/string_literals_in_interpolation'
 require 'rubocop/cop/style/symbol_array'
 require 'rubocop/cop/style/symbol_proc'
 require 'rubocop/cop/style/tab'

data/lib/rubocop/comment_config.rb

@@ -32,16 +32,12 @@ module RuboCop
 
       each_mentioned_cop do |cop_name, disabled, line, single_line|
         if single_line
-          next unless disabled
-          disabled_line_ranges[cop_name] << (line..line)
+          disabled_line_ranges[cop_name] << (line..line) if disabled
+        elsif disabled
+          disablement_start_line_numbers[cop_name] = line
         else
-          if disabled
-            disablement_start_line_numbers[cop_name] = line
-          else
-            start_line = disablement_start_line_numbers.delete(cop_name)
-            next unless start_line
-            disabled_line_ranges[cop_name] << (start_line..line)
-          end
+          start_line = disablement_start_line_numbers.delete(cop_name)
+          disabled_line_ranges[cop_name] << (start_line..line) if start_line
         end
       end
 
@@ -53,8 +49,6 @@ module RuboCop
     end
 
     def each_mentioned_cop
-      all_cop_names = nil # For performance improvement
-
       return if processed_source.comments.nil?
 
       processed_source.comments.each do |comment|
@@ -63,12 +57,8 @@ module RuboCop
 
         switch, cops_string = match.captures
 
-        if cops_string == 'all'
-          all_cop_names ||= Cop::Cop.all.map(&:cop_name)
-          cop_names = all_cop_names
-        else
-          cop_names = cops_string.split(/,\s*/)
-        end
+        cop_names =
+          cops_string == 'all' ? all_cop_names : cops_string.split(/,\s*/)
 
         disabled = (switch == 'disable')
         comment_line_number = comment.loc.expression.line
@@ -82,6 +72,10 @@ module RuboCop
       end
     end
 
+    def all_cop_names
+      @all_cop_names ||= Cop::Cop.all.map(&:cop_name)
+    end
+
     def comment_only_line?(line_number)
       non_comment_token_line_numbers.none? do |non_comment_line_number|
         non_comment_line_number == line_number

data/lib/rubocop/config.rb

@@ -38,7 +38,7 @@ module RuboCop
 
     def add_excludes_from_higher_level(highest_config)
       return unless highest_config['AllCops'] &&
-        highest_config['AllCops']['Exclude']
+                    highest_config['AllCops']['Exclude']
 
       self['AllCops'] ||= {}
       excludes = self['AllCops']['Exclude'] ||= []
@@ -93,13 +93,11 @@ module RuboCop
     # TODO: This should be a private method
     def validate
       # Don't validate RuboCop's own files. Avoids inifinite recursion.
-      return if @loaded_path.start_with?(File.join(ConfigLoader::RUBOCOP_HOME,
-                                                   'config'))
-
-      default_config = ConfigLoader.default_configuration
+      return if loaded_path.start_with?(File.join(ConfigLoader::RUBOCOP_HOME,
+                                                  'config'))
 
       valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
-        default_config.key?(key)
+        ConfigLoader.default_configuration.key?(key)
       end
 
       invalid_cop_names.each do |name|
@@ -107,16 +105,7 @@ module RuboCop
              "unrecognized cop #{name} found in #{loaded_path || self}"
       end
 
-      valid_cop_names.each do |name|
-        @hash[name].each_key do |param|
-          next if COMMON_PARAMS.include?(param) ||
-            default_config[name].key?(param)
-
-          fail ValidationError,
-               "unrecognized parameter #{name}:#{param} found " \
-               "in #{loaded_path || self}"
-        end
-      end
+      validate_parameter_names(valid_cop_names)
     end
 
     def file_to_include?(file)
@@ -156,5 +145,20 @@ module RuboCop
         Dir.pwd
       end
     end
+
+    private
+
+    def validate_parameter_names(valid_cop_names)
+      valid_cop_names.each do |name|
+        @hash[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}"
+        end
+      end
+    end
   end
 end

data/lib/rubocop/config_loader.rb

@@ -24,18 +24,14 @@ module RuboCop
 
       def load_file(path)
         path = File.absolute_path(path)
-
-        # Psych can give an error when reading an empty file, so we use syck in
-        # Ruby versions where it's available. Also, the problem with empty
-        # files does not appear in Ruby 2 or in JRuby 1.9 mode.
-        if RUBY_VERSION < '2.0.0' && RUBY_PLATFORM != 'java'
-          original_yamler = YAML::ENGINE.yamler
-          YAML::ENGINE.yamler = 'syck'
-        end
-        hash = YAML.load_file(path) || {}
-        # Restore yamler for applications using RuboCop as a library.
-        YAML::ENGINE.yamler = original_yamler if original_yamler
-
+        yaml_code = IO.read(path)
+        # At one time, there was a problem with the psych YAML engine under
+        # Ruby 1.9.3. YAML.load_file would crash when reading empty .yml files
+        # or files that only contained comments and blank lines. This problem
+        # 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) : {}
         puts "configuration from #{path}" if debug?
 
         resolve_inheritance(path, hash)

data/lib/rubocop/cop/cop.rb

@@ -65,17 +65,18 @@ module RuboCop
         end
 
         case found_ns.size
-        when 0
-          name # No namespace found. Deal with it later in caller.
-        when 1
-          if name != basename && found_ns.first != File.dirname(name).to_sym
-            warn "#{origin}: #{name} has the wrong namespace - " \
-                 "should be #{found_ns.first}"
-          end
-          "#{found_ns.first}/#{basename}"
-        else
-          fail AmbiguousCopName, "`#{basename}` used in #{origin}"
+        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}"
       end
 
       def self.non_rails
@@ -208,9 +209,9 @@ module RuboCop
         if Severity::NAMES.include?(severity.to_sym)
           severity.to_sym
         else
-          warn "Warning: Invalid severity '#{severity}'. " +
+          warn("Warning: Invalid severity '#{severity}'. " +
                "Valid severities are #{Severity::NAMES.join(', ')}."
-               .color(:red)
+               .color(:red))
         end
       end
     end

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

@@ -130,7 +130,7 @@ module RuboCop
 
         def alt_start_msg(match, start_loc, do_loc, indentation_of_do_line)
           if start_loc.line == do_loc.line &&
-              start_loc.column == indentation_of_do_line
+             start_loc.column == indentation_of_do_line
             ''
           else
             " or `#{match[0]}` at #{do_loc.line}, #{indentation_of_do_line}"
@@ -161,11 +161,9 @@ module RuboCop
               delta = start_col - end_col
               corrector.insert_before(node.loc.end, ' ' * delta)
             elsif end_col > start_col
-              delta = start_col - end_col
-              range_start = starting_position_of_block_end + delta
-              range_end = range_start - delta
-
-              range = Parser::Source::Range.new(source, range_start, range_end)
+              range_start = starting_position_of_block_end + start_col - end_col
+              range = Parser::Source::Range.new(source, range_start,
+                                                starting_position_of_block_end)
               corrector.remove(range)
             end
           end

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

@@ -17,12 +17,12 @@ module RuboCop
       #   private def foo
       #   end
       class DefEndAlignment < Cop
-        include OnMethod
+        include OnMethodDef
         include EndKeywordAlignment
 
         MSG = '`end` at %d, %d is not aligned with `%s` at %d, %d'
 
-        def on_method(node, _method_name, _args, _body)
+        def on_method_def(node, _method_name, _args, _body)
           check_offset_of_node(node)
         end
 

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

@@ -56,7 +56,7 @@ module RuboCop
         end
 
         def predicate?(method_name)
-          method_name =~ /\w\?$/
+          method_name.to_s.end_with?('?')
         end
 
         def offense?(node)

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

@@ -24,7 +24,7 @@ module RuboCop
 
           body_nodes.each do |child_node|
             check_for_access_modifier(child_node) ||
-            check_for_instance_method(child_node)
+              check_for_instance_method(child_node)
           end
 
           add_offense_for_access_modifier
@@ -41,8 +41,7 @@ module RuboCop
         end
 
         def check_for_instance_method(node)
-          return unless node.type == :def ||
-            node.type == :send
+          return unless node.type == :def || node.type == :send
 
           @access_modifier_node = nil
         end

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

@@ -13,7 +13,7 @@ module RuboCop
       #    x.attr = 5
       #  end
       class UselessSetterCall < Cop
-        include OnMethod
+        include OnMethodDef
 
         MSG = 'Useless setter call to local variable `%s`.'
         ASSIGNMENT_TYPES = [:lvasgn, :ivasgn, :cvasgn, :gvasgn].freeze
@@ -27,7 +27,7 @@ module RuboCop
 
         private
 
-        def on_method(_node, _method_name, _args, body)
+        def on_method_def(_node, _method_name, _args, body)
           return unless body
 
           if body.type == :begin

data/lib/rubocop/cop/metrics/abc_size.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module RuboCop
+  module Cop
+    module Metrics
+      # This cop checks that the ABC size of methods is not higher than the
+      # configured maximum. The ABC size is based on assignments, branches
+      # (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
+      class AbcSize < Cop
+        include MethodComplexity
+
+        MSG = 'Assignment Branch Condition size for %s is too high. [%.4g/%.4g]'
+        BRANCH_NODES = [:send]
+        CONDITION_NODES = CyclomaticComplexity::COUNTED_NODES
+
+        private
+
+        def complexity(node)
+          a = node.each_node(ASGN_NODES).count
+          b = node.each_node(BRANCH_NODES).count
+          c = node.each_node(CONDITION_NODES).count
+          Math.sqrt(a**2 + b**2 + c**2).round(2)
+        end
+      end
+    end
+  end
+end