rubocop 0.17.0 → 0.18.0

data/lib/rubocop/cop/mixin/configurable_enforced_style.rb

@@ -39,7 +39,7 @@ module Rubocop
       def alternative_style
         a = cop_config['SupportedStyles'].map(&:to_sym)
         if a.size != 2
-          fail 'alternative_style can only be used when there are exactly ' +
+          fail 'alternative_style can only be used when there are exactly ' \
             '2 SupportedStyles'
         end
         style == a.first ? a.last : a.first

data/lib/rubocop/cop/style/access_modifier_indentation.rb

@@ -7,6 +7,7 @@ module Rubocop
       # Modifiers should be indented as deeps are method definitions and
       # surrounded by blank lines.
       class AccessModifierIndentation < Cop
+        include AutocorrectAlignment
         include ConfigurableEnforcedStyle
 
         MSG = '%s access modifiers like %s.'
@@ -47,7 +48,8 @@ module Rubocop
           access_modifier_start_col = send_node.loc.expression.column
           offset = access_modifier_start_col - class_start_col
 
-          if offset == expected_indent_offset
+          @column_delta = expected_indent_offset - offset
+          if @column_delta == 0
             correct_style_detected
           else
             add_offence(send_node, :expression) do

data/lib/rubocop/cop/style/align_array.rb

@@ -8,7 +8,7 @@ module Rubocop
       class AlignArray < Cop
         include AutocorrectAlignment
 
-        MSG = 'Align the elements of an array literal if they span more ' +
+        MSG = 'Align the elements of an array literal if they span more ' \
           'than one line.'
 
         def on_array(node)

data/lib/rubocop/cop/style/align_hash.rb

@@ -141,7 +141,7 @@ module Rubocop
           end
         end
 
-        MSG = 'Align the elements of a hash literal if they span more than ' +
+        MSG = 'Align the elements of a hash literal if they span more than ' \
           'one line.'
 
         def on_hash(node)

data/lib/rubocop/cop/style/align_parameters.rb

@@ -8,7 +8,7 @@ module Rubocop
       class AlignParameters < Cop
         include AutocorrectAlignment
 
-        MSG = 'Align the parameters of a method call if they span ' +
+        MSG = 'Align the parameters of a method call if they span ' \
           'more than one line.'
 
         def on_send(node)

data/lib/rubocop/cop/style/def_parentheses.rb

@@ -9,7 +9,7 @@ module Rubocop
       class DefWithParentheses < Cop
         include CheckMethods
 
-        MSG = "Omit the parentheses in defs when the method doesn't accept " +
+        MSG = "Omit the parentheses in defs when the method doesn't accept " \
             'any arguments.'
 
         def check(node, _method_name, args, _body)

data/lib/rubocop/cop/style/line_end_concatenation.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Style
+      # This cop checks for string literal concatenation at
+      # the end of a line.
+      #
+      # @example
+      #
+      #   # bad
+      #   some_str = 'ala' +
+      #              'bala'
+      #
+      #   # good
+      #   some_str = 'ala' \
+      #              'bala'
+      #
+      class LineEndConcatenation < Cop
+        MSG = 'Use \\ instead of + to concatenate those strings.'
+
+        def on_send(node)
+          add_offence(node, :selector) if offending_node?(node)
+        end
+
+        def autocorrect(node)
+          @corrections << lambda do |corrector|
+            # replace + with \
+            corrector.replace(node.loc.selector, '\\')
+          end
+        end
+
+        private
+
+        def offending_node?(node)
+          receiver, method, arg = *node
+
+          # TODO: Report Emacs bug.
+          return false unless :+ == method
+
+          return false unless receiver.type == :str
+
+          return false unless arg.type == :str
+
+          receiver_line = receiver.loc.expression.line
+          arg_line = arg.loc.expression.line
+
+          receiver_line != arg_line
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/nested_ternary_operator.rb

@@ -5,7 +5,7 @@ module Rubocop
     module Style
       # This cop checks for nested ternary op expressions.
       class NestedTernaryOperator < Cop
-        MSG = 'Ternary operators must not be nested. Prefer if/else ' +
+        MSG = 'Ternary operators must not be nested. Prefer if/else ' \
             'constructs instead.'
 
         def on_if(node)

data/lib/rubocop/cop/style/proc.rb

@@ -20,6 +20,12 @@ module Rubocop
 
           add_offence(block_method, :expression) if block_method == TARGET
         end
+
+        def autocorrect(node)
+          @corrections << lambda do |corrector|
+            corrector.replace(node.loc.expression, 'proc')
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/style/regexp_literal.rb

@@ -39,7 +39,7 @@ module Rubocop
         end
 
         def error_message(word)
-          sprintf('Use %%r %sfor regular expressions matching more ' +
+          sprintf('Use %%r %sfor regular expressions matching more ' \
                   "than %d '/' character%s.",
                   word,
                   max_slashes,

data/lib/rubocop/cop/style/space_after_method_name.rb

@@ -7,7 +7,7 @@ module Rubocop
       class SpaceAfterMethodName < Cop
         include CheckMethods
 
-        MSG = 'Never put a space between a method name and the opening ' +
+        MSG = 'Never put a space between a method name and the opening ' \
           'parenthesis.'
 
         def check(_node, _method_name, args, body)

data/lib/rubocop/cop/style/trailing_comma.rb

@@ -48,6 +48,9 @@ module Rubocop
         def check(node, items, kind, begin_pos, end_pos)
           sb = items.first.loc.expression.source_buffer
           after_last_item = Parser::Source::Range.new(sb, begin_pos, end_pos)
+
+          return if heredoc?(after_last_item.source)
+
           comma_offset = after_last_item.source =~ /,/
           should_have_comma = style == :comma && multiline?(node)
           if comma_offset
@@ -60,6 +63,10 @@ module Rubocop
           end
         end
 
+        def heredoc?(source_after_last_item)
+          source_after_last_item =~ /\w/
+        end
+
         # Returns true if the node has round/square/curly brackets.
         def brackets?(node)
           !node.loc.end.nil?

data/lib/rubocop/cop/style/word_array.rb

@@ -53,6 +53,33 @@ module Rubocop
         def min_size
           cop_config['MinSize']
         end
+
+        def autocorrect(node)
+          sb = node.loc.expression.source_buffer
+          interpolated = false
+
+          contents = node.children.map do |n|
+            if character_literal?(n)
+              interpolated = true
+              begin_pos = n.loc.expression.begin_pos + '?'.length
+              end_pos = n.loc.expression.end_pos
+            else
+              begin_pos = n.loc.begin.end_pos
+              end_pos = n.loc.end.begin_pos
+            end
+            Parser::Source::Range.new(sb, begin_pos, end_pos).source
+          end.join(' ')
+
+          char = interpolated ? 'W' : 'w'
+
+          @corrections << lambda do |corrector|
+            corrector.replace(node.loc.expression, "%#{char}(#{contents})")
+          end
+        end
+
+        def character_literal?(node)
+          node.loc.end.nil?
+        end
       end
     end
   end

data/lib/rubocop/cop/util.rb

@@ -4,6 +4,7 @@ module Rubocop
   module Cop
     # This module contains a collection of useful utility methods.
     module Util
+      include PathUtil
       extend AST::Sexp
 
       PROC_NEW_NODE = s(:send, s(:const, nil, :Proc), :new)

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -9,6 +9,7 @@ module Rubocop
     # location of the problem and the associated message.
     class SimpleTextFormatter < BaseFormatter
       include Colorizable
+      include PathUtil
 
       COLOR_FOR_SEVERITY = {
         refactor:   :yellow,
@@ -73,8 +74,11 @@ module Rubocop
       end
 
       def smart_path(path)
-        if path.start_with?(Dir.pwd)
-          Pathname.new(path).relative_path_from(Pathname.getwd).to_s
+        # Ideally, we calculate this relative to the project root.
+        base_dir = Dir.pwd
+
+        if path.start_with? base_dir
+          relative_path(path, base_dir)
         else
           path
         end

data/lib/rubocop/options.rb

@@ -123,7 +123,7 @@ module Rubocop
       # since those are mostly used by external tools.
       rejected = args.reject! { |a| %w(-s --silent).include?(a) }
       if rejected
-        warn '-s/--silent options is dropped. ' +
+        warn '-s/--silent options is dropped. ' \
           '`emacs` and `files` formatters no longer display summary.'
       end
     end

data/lib/rubocop/path_util.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Rubocop
+  # Common methods and behaviors for dealing with paths.
+  module PathUtil
+    module_function
+
+    def relative_path(path, base_dir = Dir.pwd)
+      Pathname.new(path).relative_path_from(Pathname.new(base_dir)).to_s
+    end
+
+    def match_path?(pattern, path)
+      case pattern
+      when String
+        basename = File.basename(path)
+        path == pattern || basename == pattern || File.fnmatch(pattern, path)
+      when Regexp
+        path =~ pattern
+      end
+    end
+  end
+end

data/lib/rubocop/rake_task.rb

@@ -3,8 +3,6 @@
 require 'rake'
 require 'rake/tasklib'
 
-require 'rubocop/options'
-
 module Rubocop
   # Provides a custom rake task.
   #
@@ -16,6 +14,8 @@ module Rubocop
     attr_accessor :fail_on_error
     attr_accessor :patterns
     attr_accessor :formatters
+    attr_accessor :requires
+    attr_accessor :options
 
     def initialize(*args, &task_block)
       setup_ivars(args)
@@ -39,17 +39,31 @@ module Rubocop
 
       cli = CLI.new
       puts 'Running RuboCop...' if verbose
-      result = cli.run([formatters.map { |f| ['-f', f] }, patterns])
+      result = cli.run(full_options)
       abort('RuboCop failed!') if fail_on_error unless result == 0
     end
 
     private
 
+    def full_options
+      [].tap do |result|
+        result.concat(formatters.map { |f| ['--format', f] }.flatten)
+        result.concat(requires.map { |r| ['--require', r] }.flatten)
+        result.concat(options)
+        result.concat(patterns)
+      end
+    end
+
     def setup_ivars(args)
+      # More lazy-loading to keep load time down.
+      require 'rubocop/options'
+
       @name = args.shift || :rubocop
       @verbose = true
       @fail_on_error = true
       @patterns = []
+      @requires = []
+      @options = []
       @formatters = [Rubocop::Options::DEFAULT_FORMATTER]
     end
   end

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module Rubocop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.17.0'
+    STRING = '0.18.0'
 
     MSG = '%s (using Parser %s, running on %s %s %s)'
 

data/rubocop.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.8.23'
   s.summary = 'Automatic Ruby code style checking tool.'
 
-  s.add_runtime_dependency('rainbow', '~> 1.99.1')
+  s.add_runtime_dependency('rainbow', '>= 1.99.1', '< 3.0')
   s.add_runtime_dependency('parser', '~> 2.1.3')
   s.add_runtime_dependency('powerpack', '~> 0.0.6')
-  s.add_runtime_dependency('json', '~> 1.8')
+  s.add_runtime_dependency('json', '>= 1.7.7', '< 2')
   s.add_development_dependency('rake', '~> 10.1')
   s.add_development_dependency('rspec', '~> 2.14')
   s.add_development_dependency('yard', '~> 0.8')

data/spec/project_spec.rb

@@ -22,4 +22,97 @@ describe 'RuboCop Project' do
       end
     end
   end
+
+  describe 'changelog' do
+    subject(:changelog) do
+      path = File.join(File.dirname(__FILE__), '..', 'CHANGELOG.md')
+      File.read(path)
+    end
+
+    it 'has link definitions for all implicit links' do
+      implicit_link_names = changelog.scan(/\[([^\]]+)\]\[\]/).flatten.uniq
+      implicit_link_names.each do |name|
+        expect(changelog).to include("[#{name}]: http")
+      end
+    end
+
+    describe 'entry' do
+      subject(:entries) { lines.grep(/^\*/).map(&:chomp) }
+      let(:lines) { changelog.each_line }
+
+      it 'has a whitespace between the * and the body' do
+        entries.each do |entry|
+          expect(entry).to match(/^\* \S/)
+        end
+      end
+
+      context 'after version 0.14.0' do
+        let(:lines) do
+          changelog.each_line.take_while do |line|
+            !line.start_with?('## 0.14.0')
+          end
+        end
+
+        it 'has a link to the contributors at the end' do
+          entries.each do |entry|
+            expect(entry).to match(/\(\[@\S+\]\[\](?:, \[@\S+\]\[\])*\)$/)
+          end
+        end
+      end
+
+      describe 'link to related issue' do
+        let(:issues) do
+          entries.map do |entry|
+            entry.match(/\[(?<number>[#\d]+)\]\((?<url>[^\)]+)\)/)
+          end.compact
+        end
+
+        it 'has an issue number prefixed with #' do
+          issues.each do |issue|
+            expect(issue[:number]).to match(/^#\d+$/)
+          end
+        end
+
+        it 'has a valid URL' do
+          issues.each do |issue|
+            number = issue[:number].gsub(/\D/, '')
+            pattern = %r{^https://github\.com/bbatsov/rubocop/(?:issues|pull)/#{number}$} # rubocop:disable LineLength
+            expect(issue[:url]).to match(pattern)
+          end
+        end
+
+        it 'has a colon and a whitespace at the end' do
+          entries_including_issue_link = entries.select do |entry|
+            entry.match(/^\*\s*\[/)
+          end
+
+          entries_including_issue_link.each do |entry|
+            expect(entry).to include('): ')
+          end
+        end
+      end
+
+      describe 'body' do
+        let(:bodies) do
+          entries.map do |entry|
+            entry
+              .sub(/^\*\s*(?:\[.+?\):\s*)?/, '')
+              .sub(/\s*\([^\)]+\)$/, '')
+          end
+        end
+
+        it 'does not start with a lower case' do
+          bodies.each do |body|
+            expect(body).not_to match(/^[a-z]/)
+          end
+        end
+
+        it 'ends with a punctuation' do
+          bodies.each do |body|
+            expect(body).to match(/[\.\!]$/)
+          end
+        end
+      end
+    end
+  end
 end