rubocop 0.13.1 → 0.14.0

data/lib/rubocop.rb

@@ -6,8 +6,6 @@ require 'parser/current'
 require 'ast/sexp'
 require 'powerpack'
 
-require 'rubocop/backports/bsearch'
-
 require 'rubocop/cop/util'
 require 'rubocop/cop/offence'
 require 'rubocop/cop/cop'
@@ -25,6 +23,7 @@ require 'rubocop/cop/variable_inspector/variable_table'
 
 require 'rubocop/cop/lint/assignment_in_condition'
 require 'rubocop/cop/lint/block_alignment'
+require 'rubocop/cop/lint/debugger'
 require 'rubocop/cop/lint/empty_ensure'
 require 'rubocop/cop/lint/end_alignment'
 require 'rubocop/cop/lint/end_in_method'
@@ -36,6 +35,7 @@ require 'rubocop/cop/lint/loop'
 require 'rubocop/cop/lint/parentheses_as_grouped_expression'
 require 'rubocop/cop/lint/rescue_exception'
 require 'rubocop/cop/lint/shadowing_outer_local_variable'
+require 'rubocop/cop/lint/syntax'
 require 'rubocop/cop/lint/unreachable_code'
 require 'rubocop/cop/lint/useless_assignment'
 require 'rubocop/cop/lint/useless_comparison'
@@ -43,6 +43,7 @@ require 'rubocop/cop/lint/useless_setter_call'
 require 'rubocop/cop/lint/void'
 
 require 'rubocop/cop/style/autocorrect_alignment'
+require 'rubocop/cop/style/configurable_naming'
 require 'rubocop/cop/style/string_help'
 require 'rubocop/cop/style/access_control'
 require 'rubocop/cop/style/alias'
@@ -61,6 +62,7 @@ require 'rubocop/cop/style/case_equality'
 require 'rubocop/cop/style/case_indentation'
 require 'rubocop/cop/style/character_literal'
 require 'rubocop/cop/style/class_and_module_camel_case'
+require 'rubocop/cop/style/class_length'
 require 'rubocop/cop/style/class_methods'
 require 'rubocop/cop/style/class_vars'
 require 'rubocop/cop/style/collection_methods'
@@ -93,9 +95,10 @@ require 'rubocop/cop/style/lambda'
 require 'rubocop/cop/style/lambda_call'
 require 'rubocop/cop/style/leading_comment_space'
 require 'rubocop/cop/style/line_length'
-require 'rubocop/cop/style/method_and_variable_snake_case'
 require 'rubocop/cop/style/method_call_parentheses'
+require 'rubocop/cop/style/method_called_on_do_end_block'
 require 'rubocop/cop/style/method_length'
+require 'rubocop/cop/style/method_name'
 require 'rubocop/cop/style/module_function'
 require 'rubocop/cop/style/multiline_block_chain'
 require 'rubocop/cop/style/multiline_if_then'
@@ -108,8 +111,10 @@ require 'rubocop/cop/style/parameter_lists'
 require 'rubocop/cop/style/parentheses_around_condition'
 require 'rubocop/cop/style/perl_backrefs'
 require 'rubocop/cop/style/proc'
+require 'rubocop/cop/style/raise_args'
 require 'rubocop/cop/style/reduce_arguments'
 require 'rubocop/cop/style/redundant_begin'
+require 'rubocop/cop/style/redundant_exception'
 require 'rubocop/cop/style/redundant_return'
 require 'rubocop/cop/style/redundant_self'
 require 'rubocop/cop/style/regexp_literal'
@@ -133,6 +138,7 @@ require 'rubocop/cop/style/trailing_whitespace'
 require 'rubocop/cop/style/trivial_accessors'
 require 'rubocop/cop/style/unless_else'
 require 'rubocop/cop/style/variable_interpolation'
+require 'rubocop/cop/style/variable_name'
 require 'rubocop/cop/style/when_then'
 require 'rubocop/cop/style/while_until_do'
 require 'rubocop/cop/style/word_array'
@@ -159,4 +165,5 @@ require 'rubocop/token'
 require 'rubocop/processed_source'
 require 'rubocop/source_parser'
 require 'rubocop/cli'
+require 'rubocop/options'
 require 'rubocop/version'

data/lib/rubocop/cli.rb

@@ -1,17 +1,13 @@
 # encoding: utf-8
-require 'pathname'
-require 'optparse'
 
 module Rubocop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
   class CLI
-    DEFAULT_FORMATTER = 'progress'
-
     # If set true while running,
     # RuboCop will abort processing and exit gracefully.
     attr_accessor :wants_to_quit
-    attr_accessor :options
+    attr_reader :options
 
     alias_method :wants_to_quit?, :wants_to_quit
 
@@ -28,11 +24,10 @@ module Rubocop
     def run(args = ARGV)
       trap_interrupt
 
-      parse_options(args)
+      @options, target_files = Options.new(@config_store).parse(args)
 
       Config.debug = @options[:debug]
 
-      target_files = target_finder.find(args)
       target_files.each(&:freeze).freeze
       inspected_files = []
       any_failed = false
@@ -63,15 +58,16 @@ module Rubocop
       return 1
     end
 
-    def mobilized_cop_classes
-      @mobilized_cop_classes ||= begin
+    def mobilized_cop_classes(config)
+      @mobilized_cop_classes ||= {}
+      @mobilized_cop_classes[config.object_id] ||= begin
         cop_classes = Cop::Cop.all
 
         if @options[:only]
           cop_classes.select! { |c| c.cop_name == @options[:only] }
         else
           # filter out Rails cops unless requested
-          cop_classes.reject!(&:rails?) unless @options[:rails]
+          cop_classes.reject!(&:rails?) unless run_rails_cops?(config)
 
           # filter out style cops when --lint is passed
           cop_classes.select!(&:lint?) if @options[:lint]
@@ -83,161 +79,12 @@ module Rubocop
 
     def inspect_file(file)
       config = @config_store.for(file)
-      team = Cop::Team.new(mobilized_cop_classes, config, @options)
+      team = Cop::Team.new(mobilized_cop_classes(config), config, @options)
       offences = team.inspect_file(file)
       @errors.concat(team.errors)
       offences
     end
 
-    def validate_only_option
-      if Cop::Cop.all.none? { |c| c.cop_name == @options[:only] }
-        fail ArgumentError, "Unrecognized cop name: #{@options[:only]}."
-      end
-    end
-
-    def validate_auto_gen_config_option(args)
-      if args.any?
-        fail ArgumentError,
-             '--auto-gen-config can not be combined with any other arguments.'
-      end
-
-      target_finder.find(args).each do |file|
-        config = @config_store.for(file)
-        if @options[:auto_gen_config] && config.contains_auto_generated_config
-          fail "Remove #{Config::AUTO_GENERATED_FILE} from the current " +
-            'configuration before generating it again.'
-        end
-      end
-    end
-
-    def print_available_cops
-      cops = Cop::Cop.all
-      puts "Available cops (#{cops.length}) + config for #{Dir.pwd.to_s}: "
-      dirconf = @config_store.for(Dir.pwd.to_s)
-      cops.types.sort!.each do |type|
-        coptypes = cops.with_type(type).sort_by!(&:cop_name)
-        puts "Type '#{type.to_s.capitalize}' (#{coptypes.size}):"
-        coptypes.each do |cop|
-          puts " - #{cop.cop_name}"
-          cnf = dirconf.for_cop(cop).dup
-          print_conf_option('Description',
-                            cnf.delete('Description') { 'None' })
-          cnf.each { |k, v| print_conf_option(k, v) }
-        end
-      end
-    end
-
-    def print_conf_option(option, value)
-      puts  "    - #{option}: #{value}"
-    end
-
-    # rubocop:disable MethodLength
-    def parse_options(args)
-      ignore_dropped_options(args)
-      convert_deprecated_options(args)
-
-      OptionParser.new do |opts|
-        opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
-
-        opts.on('-d', '--debug', 'Display debug info.') do |d|
-          @options[:debug] = d
-        end
-        opts.on('-c', '--config FILE', 'Specify configuration file.') do |f|
-          @options[:config] = f
-          @config_store.set_options_config(@options[:config])
-        end
-        opts.on('--only COP', 'Run just one cop.') do |s|
-          @options[:only] = s
-          validate_only_option
-        end
-        opts.on('--auto-gen-config',
-                'Generate a configuration file acting as a',
-                'TODO list.') do
-          @options[:auto_gen_config] = true
-          @options[:formatters] = [
-            [DEFAULT_FORMATTER],
-            [Formatter::DisabledConfigFormatter, Config::AUTO_GENERATED_FILE]
-          ]
-          validate_auto_gen_config_option(args)
-        end
-        opts.on('--show-cops',
-                'Shows cops and their config for the',
-                'current directory.') do
-          print_available_cops
-          exit(0)
-        end
-        opts.on('-f', '--format FORMATTER',
-                'Choose an output formatter. This option',
-                'can be specified multiple times to enable',
-                'multiple formatters at the same time.',
-                '  [p]rogress (default)',
-                '  [s]imple',
-                '  [c]lang',
-                '  [e]macs',
-                '  [j]son',
-                '  [f]iles',
-                '  [o]ffences',
-                '  custom formatter class name') do |key|
-          @options[:formatters] ||= []
-          @options[:formatters] << [key]
-        end
-        opts.on('-o', '--out FILE',
-                'Write output to a file instead of STDOUT.',
-                'This option applies to the previously',
-                'specified --format, or the default format',
-                'if no format is specified.') do |path|
-          @options[:formatters] ||= [[DEFAULT_FORMATTER]]
-          @options[:formatters].last << path
-        end
-        opts.on('-r', '--require FILE', 'Require Ruby file.') do |f|
-          require f
-        end
-        opts.on('-R', '--rails', 'Run extra Rails cops.') do |r|
-          @options[:rails] = r
-        end
-        opts.on('-l', '--lint', 'Run only lint cops.') do |l|
-          @options[:lint] = l
-        end
-        opts.on('-a', '--auto-correct', 'Auto-correct offences.') do |a|
-          @options[:autocorrect] = a
-        end
-        opts.on('-n', '--no-color', 'Disable color output.') do |s|
-          Sickill::Rainbow.enabled = false
-        end
-        opts.on('-v', '--version', 'Display version.') do
-          puts Rubocop::Version.version(false)
-          exit(0)
-        end
-        opts.on('-V', '--verbose-version', 'Display verbose version.') do
-          puts Rubocop::Version.version(true)
-          exit(0)
-        end
-      end.parse!(args)
-    end
-    # rubocop:enable MethodLength
-
-    def ignore_dropped_options(args)
-      # Currently we don't make -s/--silent option raise error
-      # 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. ' +
-             '`emacs` and `files` formatters no longer display summary.'
-      end
-    end
-
-    def convert_deprecated_options(args)
-      args.map! do |arg|
-        case arg
-        when '-e', '--emacs'
-          deprecate("#{arg} option", '--format emacs', '1.0.0')
-          %w(--format emacs)
-        else
-          arg
-        end
-      end.flatten!
-    end
-
     def trap_interrupt
       Signal.trap('INT') do
         exit!(1) if wants_to_quit?
@@ -260,14 +107,14 @@ module Rubocop
 
     private
 
-    def target_finder
-      @target_finder ||= TargetFinder.new(@config_store, @options[:debug])
+    def run_rails_cops?(config)
+      @options[:rails] || config['AllCops']['RunRailsCops']
     end
 
     def formatter_set
       @formatter_set ||= begin
         set = Formatter::FormatterSet.new
-        pairs = @options[:formatters] || [[DEFAULT_FORMATTER]]
+        pairs = @options[:formatters] || [[Options::DEFAULT_FORMATTER]]
         pairs.each do |formatter_key, output_path|
           set.add_formatter(formatter_key, output_path)
         end
@@ -277,13 +124,5 @@ module Rubocop
         exit(1)
       end
     end
-
-    def deprecate(subject, alternative = nil, version = nil)
-      message =  "#{subject} is deprecated"
-      message << " and will be removed in RuboCop #{version}" if version
-      message << '.'
-      message << " Please use #{alternative} instead." if alternative
-      warn message
-    end
   end
 end

data/lib/rubocop/cop/cop.rb

@@ -93,29 +93,32 @@ module Rubocop
       end
 
       def autocorrect?
-        @options[:autocorrect]
+        @options[:autocorrect] && support_autocorrect?
       end
 
       def debug?
         @options[:debug]
       end
 
-      def autocorrect_action(node)
-      end
-
       def message(node = nil)
         self.class::MSG
       end
 
+      def support_autocorrect?
+        respond_to?(:autocorrect, true)
+      end
+
       def add_offence(severity, node, loc, message = nil)
         location = loc.is_a?(Symbol) ? node.loc.send(loc) : loc
 
-        unless disabled_line?(location.line)
-          message = message ? message : message(node)
-          message = debug? ? "#{name}: #{message}" : message
-          @offences << Offence.new(severity, location, message, name)
-          autocorrect_action(node) if autocorrect?
-        end
+        return if disabled_line?(location.line)
+
+        message = message ? message : message(node)
+        message = debug? ? "#{name}: #{message}" : message
+        @offences <<
+          Offence.new(severity, location, message, name, autocorrect?)
+
+        autocorrect(node) if autocorrect?
       end
 
       def convention(node, location, message = nil)
@@ -158,7 +161,7 @@ module Rubocop
       end
 
       def ignored_node?(node)
-        @ignored_nodes.include?(node)
+        @ignored_nodes.any? { |n| n.eql?(node) } # Same object found in array?
       end
 
       def on_node(syms, sexp, excludes = [])

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

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Lint
+      # This cop checks for calls to debugger or pry.
+      class Debugger < Cop
+        MSG = 'Remove calls to debugger.'
+
+        # debugger call node
+        #
+        # (send nil :debugger)
+        DEBUGGER_NODE = s(:send, nil, :debugger)
+
+        # binding.pry node
+        #
+        # (send
+        #   (send nil :binding) :pry)
+        PRY_NODE = s(:send, s(:send, nil, :binding), :pry)
+
+        # binding.remote_pry node
+        #
+        # (send
+        #   (send nil :binding) :remote_pry)
+        REMOTE_PRY_NODE = s(:send, s(:send, nil, :binding), :remote_pry)
+
+        DEBUGGER_NODES = [DEBUGGER_NODE, PRY_NODE, REMOTE_PRY_NODE]
+
+        def on_send(node)
+          warning(node, :selector) if DEBUGGER_NODES.include?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Lint
+      # This cop actually inspects nothing, just repacks Parser's diagnostics
+      # into RuboCop's offences.
+      # The purpose of this cop is to support disabling Syntax offences with
+      # config or inline comments by conforming to the cop framework.
+      class Syntax < Cop
+        def self.offences_from_diagnostics(diagnostics)
+          diagnostics.map do |diagnostic|
+            offence_from_diagnostic(diagnostic)
+          end
+        end
+
+        def self.offence_from_diagnostic(diagnostic)
+          Offence.new(
+            diagnostic.level,
+            diagnostic.location,
+            diagnostic.message,
+            cop_name
+          )
+        end
+
+        def investigate(processed_source)
+          processed_source.diagnostics.each do |d|
+            add_offence(d.level, nil, d.location, d.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/offence.rb

@@ -9,15 +9,6 @@ module Rubocop
       # @api private
       SEVERITIES = [:refactor, :convention, :warning, :error, :fatal]
 
-      def self.from_diagnostic(diagnostic)
-        new(
-          diagnostic.level,
-          diagnostic.location,
-          diagnostic.message,
-          'Syntax'
-        )
-      end
-
       # @api public
       #
       # @!attribute [r] severity
@@ -61,6 +52,15 @@ module Rubocop
       #   'LineLength'
       attr_reader :cop_name
 
+      # @api public
+      #
+      # @!attribute [r] corrected
+      #
+      # @return [Boolean]
+      #   whether this offence is automatically corrected.
+      attr_reader :corrected
+      alias_method :corrected?, :corrected
+
       # @api private
       attr_reader :line
 
@@ -68,7 +68,7 @@ module Rubocop
       attr_reader :column
 
       # @api private
-      def initialize(severity, location, message, cop_name)
+      def initialize(severity, location, message, cop_name, corrected = false)
         unless SEVERITIES.include?(severity)
           fail ArgumentError, "Unknown severity: #{severity}"
         end
@@ -78,30 +78,22 @@ module Rubocop
         @column = location.column.freeze
         @message = message.freeze
         @cop_name = cop_name.freeze
+        @corrected = corrected.freeze
         freeze
       end
 
       # @api private
+      # This is just for debugging purpose.
       def to_s
-        sprintf("#{encode_severity}:%3d:%3d: %s",
-                line, real_column, message)
+        sprintf('%s:%3d:%3d: %s',
+                severity_code, line, real_column, message)
       end
 
       # @api private
-      def encode_severity
+      def severity_code
         @severity.to_s[0].upcase
       end
 
-      # @api private
-      def clang_severity
-        case @severity
-        when :fatal then 'F'.color(:red)
-        when :error then 'E'.color(:red)
-        when :warning then 'W'.color(:magenta)
-        when :convention then 'C'.color(:yellow)
-        end
-      end
-
       # @api private
       def severity_level
         SEVERITIES.index(severity) + 1