rubocop 0.9.1 → 0.10.0

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

@@ -8,8 +8,8 @@ module Rubocop
       class AsciiComments < Cop
         MSG = 'Use only ascii symbols in comments.'
 
-        def inspect(source_buffer, source, tokens, ast, comments)
-          comments.each do |comment|
+        def investigate(processed_source)
+          processed_source.comments.each do |comment|
             if comment.text =~ /[^\x00-\x7f]/
               add_offence(:convention, comment.loc, MSG)
             end

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

@@ -9,8 +9,8 @@ module Rubocop
       class AsciiIdentifiers < Cop
         MSG = 'Use only ascii symbols in identifiers.'
 
-        def inspect(source_buffer, source, tokens, ast, comments)
-          tokens.each do |t|
+        def investigate(processed_source)
+          processed_source.tokens.each do |t|
             if t.type == :tIDENTIFIER && t.text =~ /[^\x00-\x7f]/
               add_offence(:convention, t.pos, MSG)
             end

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

@@ -11,8 +11,6 @@ module Rubocop
           if command?(:attr, node)
             add_offence(:convention, node.loc.selector, MSG)
           end
-
-          super
         end
       end
     end

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

@@ -12,7 +12,6 @@ module Rubocop
         def on_cvasgn(node)
           class_var, = *node
           add_offence(:convention, node.loc.name, sprintf(MSG, class_var))
-          super
         end
       end
     end

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

@@ -9,8 +9,6 @@ module Rubocop
 
         def on_for(node)
           add_offence(:convention, node.loc.keyword, MSG)
-
-          super
         end
       end
     end

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

@@ -34,26 +34,22 @@ module Rubocop
           $' $POSTMATCH
           $+ $LAST_PAREN_MATCH
           $stdin $stdout $stderr
-          $DEBUG $FILENAME $VERBOSE
+          $DEBUG $FILENAME $VERBOSE $SAFE
           $-0 $-a $-d $-F $-i $-I $-l $-p $-v $-w
-        )
+        ).map(&:to_sym)
 
         def on_gvar(node)
           check(node)
-
-          super
         end
 
         def on_gvasgn(node)
           check(node)
-
-          super
         end
 
         def check(node)
           global_var, = *node
 
-          unless BUILT_IN_VARS.include?(global_var.to_s)
+          unless BUILT_IN_VARS.include?(global_var)
             add_offence(:convention,
                         node.loc.name,
                         MSG)

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

@@ -12,8 +12,6 @@ module Rubocop
           add_offence(:convention,
                       node.loc.expression,
                       "Prefer the use of MatchData over $#{backref}.")
-
-          super
         end
       end
     end

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

@@ -28,11 +28,11 @@ module Rubocop
           '$`' => '$PREMATCH from English library',
           '$\'' => '$POSTMATCH from English library',
           '$+' => '$LAST_PAREN_MATCH from English library'
-        }
+        }.symbolize_keys
 
         def on_gvar(node)
           global_var, = *node
-          global_var = global_var.to_s
+          global_var = global_var
 
           if PREFERRED_VARS[global_var]
             add_offence(
@@ -41,8 +41,6 @@ module Rubocop
               "Prefer #{PREFERRED_VARS[global_var]} over #{global_var}."
             )
           end
-
-          super
         end
       end
     end

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

@@ -9,8 +9,6 @@ module Rubocop
 
         def on_preexe(node)
           add_offence(:convention, node.loc.keyword, MSG)
-
-          super
         end
       end
     end

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

@@ -7,8 +7,8 @@ module Rubocop
       class BlockComments < Cop
         MSG = 'Do not use block comments.'
 
-        def inspect(source_buffer, source, tokens, ast, comments)
-          comments.each do |comment|
+        def investigate(processed_source)
+          processed_source.comments.each do |comment|
             if comment.text.start_with?('=begin')
               add_offence(:convention, comment.loc, MSG)
             end

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

@@ -12,10 +12,10 @@ module Rubocop
         NESTING_BLOCKS = [:case, :if, :while, :while_post, :until, :until_post,
                           :for, :resbody]
 
-        def inspect(source_buffer, source, tokens, ast, comments)
-          return unless ast
+        def investigate(processed_source)
+          return unless processed_source.ast
           max = BlockNesting.config['Max']
-          check_nesting_level(ast, max, 0)
+          check_nesting_level(processed_source.ast, max, 0)
         end
 
         private

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

@@ -18,8 +18,6 @@ module Rubocop
           elsif block_length == 0 && block_begin != '{'
             add_offence(:convention, node.loc.begin, SINGLE_LINE_MSG)
           end
-
-          super
         end
       end
     end

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

@@ -13,8 +13,6 @@ module Rubocop
           if method_name == :===
             add_offence(:convention, node.loc.selector, MSG)
           end
-
-          super
         end
       end
     end

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

@@ -19,8 +19,6 @@ module Rubocop
             pos = when_node.loc.keyword
             add_offence(:convention, pos, MSG) if pos.column != case_column
           end
-
-          super
         end
       end
     end

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

@@ -11,9 +11,11 @@ module Rubocop
           # Constants like __FILE__ are handled as strings,
           # but don't respond to begin.
           return unless node.loc.respond_to?(:begin)
+          return if part_of_ignored_node?(node)
 
           # we don't register an offence for things like ?\C-\M-d
-          if node.loc.begin.is?('?') && node.loc.expression.source.size < 4
+          if node.loc.begin.is?('?') &&
+              node.loc.expression.source.size.between?(2, 3)
             add_offence(:convention, node.loc.expression, MSG)
             do_autocorrect(node)
           end
@@ -23,12 +25,14 @@ module Rubocop
         alias_method :on_regexp, :ignore_node
 
         def autocorrect_action(node)
-          string = node.loc.expression.source[1..-1]
+          @corrections << lambda do |corrector|
+            string = node.loc.expression.source[1..-1]
 
-          if string.length == 1 # normal character
-            replace(node.loc.expression, "'#{string}'")
-          elsif string.length == 2 # special character like \n
-            replace(node.loc.expression, %Q("#{string}"))
+            if string.length == 1 # normal character
+              corrector.replace(node.loc.expression, "'#{string}'")
+            elsif string.length == 2 # special character like \n
+              corrector.replace(node.loc.expression, %Q("#{string}"))
+            end
           end
         end
       end

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

@@ -10,14 +10,10 @@ module Rubocop
 
         def on_class(node)
           check_name(node)
-
-          super
         end
 
         def on_module(node)
           check_name(node)
-
-          super
         end
 
         private

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

@@ -8,7 +8,7 @@ module Rubocop
       class ClassMethods < Cop
         MSG = 'Prefer self over class/module for class/module methods.'
 
-        # TODO - check if we're in a class/module
+        # TODO: Check if we're in a class/module
         def on_defs(node)
           definee, _name, _args, _body = *node
 

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

@@ -13,15 +13,15 @@ module Rubocop
         MSG = 'Prefer %s over %s.'
 
         def self.preferred_methods
-          Util.symbolize_keys(config['PreferredMethods'])
+          if config['PreferredMethods']
+            config['PreferredMethods'].symbolize_keys
+          end
         end
 
         def on_block(node)
           method, _args, _body = *node
 
           check_method_node(method)
-
-          super
         end
 
         def on_send(node)
@@ -30,8 +30,6 @@ module Rubocop
           if args.size == 1 && args.first.type == :block_pass
             check_method_node(node)
           end
-
-          super
         end
 
         private

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

@@ -16,12 +16,12 @@ module Rubocop
             add_offence(:convention, node.loc.dot, MSG)
             do_autocorrect(node)
           end
-
-          super
         end
 
         def autocorrect_action(node)
-          replace(node.loc.dot, '.')
+          @corrections << lambda do |corrector|
+            corrector.replace(node.loc.dot, '.')
+          end
         end
       end
     end

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

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Style
+      # This cop checks that comment annotation keywords are written according
+      # to guidelines.
+      class CommentAnnotation < Cop
+        MSG = 'Annotation keywords shall be all upper case, followed by a ' +
+          'colon and a space, then a note describing the problem.'
+        KEYWORDS = %w(TODO FIXME OPTIMIZE HACK REVIEW)
+
+        def investigate(processed_source)
+          processed_source.comments.each do |comment|
+            match = comment.text.match(/^(# ?)([A-Za-z]+)(\s*:)?(\s+)?(\S+)?/)
+            if match
+              margin, first_word, colon, space, note = *match.captures
+              if annotation?(first_word, colon, space, note) &&
+                  !correct_annotation?(first_word, colon, space, note)
+                start = comment.loc.begin_pos + margin.length
+                length = first_word.length + (colon || '').length
+                range = Parser::Source::Range.new(processed_source.buffer,
+                                                  start,
+                                                  start + length)
+                add_offence(:convention, range, MSG)
+              end
+            end
+          end
+        end
+
+        private
+
+        def annotation?(first_word, colon, space, note)
+          KEYWORDS.include?(first_word.upcase) && (colon || space || !note)
+        end
+
+        def correct_annotation?(first_word, colon, space, note)
+          KEYWORDS.include?(first_word) &&
+            (colon && space && note || !colon && !note)
+        end
+      end
+    end
+  end
+end

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

@@ -22,8 +22,6 @@ module Rubocop
               add_offence(:convention, node.loc.name, MSG)
             end
           end
-
-          super
         end
       end
     end

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

@@ -20,8 +20,6 @@ module Rubocop
           if args.children == [] && args.loc.begin
             add_offence(:convention, args.loc.begin, MSG)
           end
-
-          super
         end
 
         def on_defs(node)
@@ -34,8 +32,6 @@ module Rubocop
           if args.children == [] && args.loc.begin
             add_offence(:convention, args.loc.begin, MSG)
           end
-
-          super
         end
       end
 
@@ -51,8 +47,6 @@ module Rubocop
           if args.children.size > 0 && args.loc.begin.nil?
             add_offence(:convention, args.loc.expression, MSG)
           end
-
-          super
         end
 
         def on_defs(node)
@@ -61,8 +55,6 @@ module Rubocop
           if args.children.size > 0 && args.loc.begin.nil?
             add_offence(:convention, args.loc.expression, MSG)
           end
-
-          super
         end
       end
     end

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

@@ -10,10 +10,14 @@ module Rubocop
       class Documentation < Cop
         MSG = 'Missing top-level %s documentation comment.'
 
-        def inspect(source_buffer, source, tokens, ast, comments)
+        def investigate(processed_source)
+          ast = processed_source.ast
           return unless ast
 
-          ast_with_comments = Parser::Source::Comment.associate(ast, comments)
+          ast_with_comments = Parser::Source::Comment.associate(
+            ast,
+            processed_source.comments
+          )
 
           check_classes(ast, ast_with_comments)
           check_modules(ast, ast_with_comments)

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

@@ -13,8 +13,6 @@ module Rubocop
           unless proper_dot_position?(node)
             add_offence(:convention, node.loc.dot, MSG)
           end
-
-          super
         end
 
         private

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

@@ -17,8 +17,6 @@ module Rubocop
           end
 
           @prev_def_end = def_end
-
-          super
         end
       end
     end

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

@@ -8,12 +8,12 @@ module Rubocop
         MSG = 'Extra blank line detected.'
         LINE_OFFSET = 2
 
-        def inspect(source_buffer, source, tokens, ast, comments)
-          return if tokens.empty?
+        def investigate(processed_source)
+          return if processed_source.tokens.empty?
 
           prev_line = 1
 
-          tokens.each do |token|
+          processed_source.tokens.each do |token|
             cur_line = token.pos.line
             line_diff = cur_line - prev_line
 
@@ -22,11 +22,13 @@ module Rubocop
               # don't show up in the tokens
               ((prev_line + 1)...cur_line).each do |line|
                 # we check if the prev and current lines are empty
-                if source[line - 2].empty? && source[line - 1].empty?
-                  add_offence(:convention,
-                              source_range(source_buffer,
-                                           source[0...(line - 1)], 0, 1),
-                              MSG)
+                if processed_source[line - 2].empty? &&
+                    processed_source[line - 1].empty?
+                  range = source_range(processed_source.buffer,
+                                       processed_source[0...(line - 1)],
+                                       0,
+                                       1)
+                  add_offence(:convention, range, MSG)
                 end
               end
             end