rubocop 0.78.0

data/lib/rubocop/cached_data.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module RuboCop
+  # Converts RuboCop objects to and from the serialization format JSON.
+  class CachedData
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def from_json(text)
+      deserialize_offenses(JSON.parse(text))
+    end
+
+    def to_json(offenses)
+      JSON.dump(offenses.map { |o| serialize_offense(o) })
+    end
+
+    private
+
+    def serialize_offense(offense)
+      {
+        # Calling #to_s here ensures that the serialization works when using
+        # other json serializers such as Oj. Some of these gems do not call
+        # #to_s implicitly.
+        severity: offense.severity.to_s,
+        location: {
+          begin_pos: offense.location.begin_pos,
+          end_pos: offense.location.end_pos
+        },
+        message:  message(offense),
+        cop_name: offense.cop_name,
+        status:   :uncorrected
+      }
+    end
+
+    def message(offense)
+      # JSON.dump will fail if the offense message contains text which is not
+      # valid UTF-8
+      offense.message.dup.force_encoding(::Encoding::UTF_8).scrub
+    end
+
+    # Restore an offense object loaded from a JSON file.
+    def deserialize_offenses(offenses)
+      source_buffer = Parser::Source::Buffer.new(@filename)
+      source_buffer.source = File.read(@filename, encoding: Encoding::UTF_8)
+      offenses.map! do |o|
+        location = Parser::Source::Range.new(source_buffer,
+                                             o['location']['begin_pos'],
+                                             o['location']['end_pos'])
+        Cop::Offense.new(o['severity'], location,
+                         o['message'],
+                         o['cop_name'], o['status'].to_sym)
+      end
+    end
+  end
+end

data/lib/rubocop/cli.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # The CLI is a class responsible of handling all the command line interface
+  # logic.
+  class CLI
+    STATUS_SUCCESS     = 0
+    STATUS_OFFENSES    = 1
+    STATUS_ERROR       = 2
+    STATUS_INTERRUPTED = 128 + Signal.list['INT']
+
+    class Finished < RuntimeError; end
+
+    attr_reader :options, :config_store
+
+    def initialize
+      @options = {}
+      @config_store = ConfigStore.new
+    end
+
+    # @api public
+    #
+    # Entry point for the application logic. Here we
+    # do the command line arguments processing and inspect
+    # the target files.
+    #
+    # @param args [Array<String>] command line arguments
+    # @return [Integer] UNIX exit code
+    #
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def run(args = ARGV)
+      @options, paths = Options.new.parse(args)
+      @env = Environment.new(@options, @config_store, paths)
+
+      if @options[:init]
+        run_command(:init)
+      else
+        validate_options_vs_config
+        act_on_options
+        apply_default_formatter
+        execute_runners
+      end
+    rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
+      warn e.message
+      STATUS_ERROR
+    rescue RuboCop::Error => e
+      warn Rainbow("Error: #{e.message}").red
+      STATUS_ERROR
+    rescue Finished
+      STATUS_SUCCESS
+    rescue OptionParser::InvalidOption => e
+      warn e.message
+      warn 'For usage information, use --help'
+      STATUS_ERROR
+    rescue StandardError, SyntaxError, LoadError => e
+      warn e.message
+      warn e.backtrace
+      STATUS_ERROR
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+    private
+
+    def run_command(name)
+      @env.run(name)
+    end
+
+    def execute_runners
+      if @options[:auto_gen_config]
+        run_command(:auto_gen_config)
+      else
+        run_command(:execute_runner)
+      end
+    end
+
+    def validate_options_vs_config
+      if @options[:parallel] &&
+         !@config_store.for(Dir.pwd).for_all_cops['UseCache']
+        raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
+                                   'execution, so combining with AllCops: ' \
+                                   'UseCache: false is not allowed.'
+      end
+    end
+
+    def act_on_options
+      ConfigLoader.debug = @options[:debug]
+      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
+      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
+      ConfigLoader.options_config = @options[:config]
+
+      @config_store.options_config = @options[:config] if @options[:config]
+      @config_store.force_default_config! if @options[:force_default_config]
+
+      handle_exiting_options
+
+      if @options[:color]
+        # color output explicitly forced on
+        Rainbow.enabled = true
+      elsif @options[:color] == false
+        # color output explicitly forced off
+        Rainbow.enabled = false
+      end
+    end
+
+    def handle_exiting_options
+      return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
+
+      run_command(:version) if @options[:version] || @options[:verbose_version]
+      run_command(:show_cops) if @options[:show_cops]
+      raise Finished
+    end
+
+    def apply_default_formatter
+      # This must be done after the options have already been processed,
+      # because they can affect how ConfigStore behaves
+      @options[:formatters] ||= begin
+        if @options[:auto_gen_config]
+          formatter = 'autogenconf'
+        else
+          cfg = @config_store.for(Dir.pwd).for_all_cops
+          formatter = cfg['DefaultFormatter'] || 'progress'
+        end
+        [[formatter, @options[:output_path]]]
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    # Home of subcommands in the CLI.
+    module Command
+      class << self
+        # Find the command with a given name and run it in an environment.
+        def run(env, name)
+          class_for(name).new(env).run
+        end
+
+        private
+
+        def class_for(name)
+          Base.by_command_name(name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/auto_genenerate_config.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Generate a configuration file acting as a TODO list.
+      class AutoGenerateConfig < Base
+        self.command_name = :auto_gen_config
+
+        PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
+        PHASE_2 = 'Phase 2 of 2: run all cops'
+
+        PHASE_1_OVERRIDDEN =
+          '(skipped because the default Layout/LineLength:Max is overridden)'
+        PHASE_1_DISABLED =
+          '(skipped because Layout/LineLength is disabled)'
+
+        def run
+          add_formatter
+          reset_config_and_auto_gen_file
+          line_length_contents = maybe_run_line_length_cop
+          run_all_cops(line_length_contents)
+        end
+
+        private
+
+        def maybe_run_line_length_cop
+          if !line_length_enabled?(@config_store.for(Dir.pwd))
+            skip_line_length_cop(PHASE_1_DISABLED)
+          elsif !same_max_line_length?(
+            @config_store.for(Dir.pwd), ConfigLoader.default_configuration
+          )
+            skip_line_length_cop(PHASE_1_OVERRIDDEN)
+          else
+            run_line_length_cop
+          end
+        end
+
+        def skip_line_length_cop(reason)
+          puts Rainbow("#{PHASE_1} #{reason}").yellow
+          ''
+        end
+
+        def line_length_enabled?(config)
+          line_length_cop(config)['Enabled']
+        end
+
+        def same_max_line_length?(config1, config2)
+          max_line_length(config1) == max_line_length(config2)
+        end
+
+        def max_line_length(config)
+          line_length_cop(config)['Max']
+        end
+
+        def line_length_cop(config)
+          config.for_cop('Layout/LineLength')
+        end
+
+        # Do an initial run with only Layout/LineLength so that cops that
+        # depend on Layout/LineLength:Max get the correct value for that
+        # parameter.
+        def run_line_length_cop
+          puts Rainbow(PHASE_1).yellow
+          @options[:only] = ['Layout/LineLength']
+          execute_runner
+          @options.delete(:only)
+          @config_store = ConfigStore.new
+          # Save the todo configuration of the LineLength cop.
+          IO.read(ConfigLoader::AUTO_GENERATED_FILE)
+            .lines
+            .drop_while { |line| line.start_with?('#') }
+            .join
+        end
+
+        def run_all_cops(line_length_contents)
+          puts Rainbow(PHASE_2).yellow
+          result = execute_runner
+          # This run was made with the current maximum length allowed, so append
+          # the saved setting for LineLength.
+          File.open(ConfigLoader::AUTO_GENERATED_FILE, 'a') do |f|
+            f.write(line_length_contents)
+          end
+          result
+        end
+
+        def reset_config_and_auto_gen_file
+          @config_store = ConfigStore.new
+          @config_store.options_config = @options[:config] if @options[:config]
+          File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w') {}
+          ConfigLoader.add_inheritance_from_auto_generated_file
+        end
+
+        def add_formatter
+          @options[:formatters] << [Formatter::DisabledConfigFormatter,
+                                    ConfigLoader::AUTO_GENERATED_FILE]
+        end
+
+        def execute_runner
+          Environment.new(@options, @config_store, @paths).run(:execute_runner)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # A subcommand in the CLI.
+      class Base
+        attr_reader :env
+
+        @subclasses = []
+
+        class << self
+          attr_accessor :command_name
+
+          def inherited(subclass)
+            @subclasses << subclass
+          end
+
+          def by_command_name(name)
+            @subclasses.detect { |s| s.command_name == name }
+          end
+        end
+
+        def initialize(env)
+          @env = env
+          @options = env.options
+          @config_store = env.config_store
+          @paths = env.paths
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/execute_runner.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Run all the selected cops and report the result.
+      class ExecuteRunner < Base
+        include Formatter::TextUtil
+
+        self.command_name = :execute_runner
+
+        def run
+          execute_runner(@paths)
+        end
+
+        private
+
+        def execute_runner(paths)
+          runner = Runner.new(@options, @config_store)
+
+          all_passed = runner.run(paths)
+          display_warning_summary(runner.warnings)
+          display_error_summary(runner.errors)
+          maybe_print_corrected_source
+
+          all_pass_or_excluded = all_passed || @options[:auto_gen_config]
+
+          if runner.aborting?
+            STATUS_INTERRUPTED
+          elsif all_pass_or_excluded && runner.errors.empty?
+            STATUS_SUCCESS
+          else
+            STATUS_OFFENSES
+          end
+        end
+
+        def display_warning_summary(warnings)
+          return if warnings.empty?
+
+          warn Rainbow("\n#{pluralize(warnings.size, 'warning')}:").yellow
+
+          warnings.each { |warning| warn warning }
+        end
+
+        def display_error_summary(errors)
+          return if errors.empty?
+
+          warn Rainbow("\n#{pluralize(errors.size, 'error')} occurred:").red
+
+          errors.each { |error| warn error }
+
+          warn <<~WARNING
+            Errors are usually caused by RuboCop bugs.
+            Please, report your problems to RuboCop's issue tracker.
+            #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
+
+            Mention the following information in the issue report:
+            #{RuboCop::Version.version(true)}
+          WARNING
+        end
+
+        def maybe_print_corrected_source
+          # If we are asked to autocorrect source code read from stdin, the only
+          # reasonable place to write it is to stdout
+          # Unfortunately, we also write other information to stdout
+          # So a delimiter is needed for tools to easily identify where the
+          # autocorrected source begins
+          return unless @options[:stdin] && @options[:auto_correct]
+
+          puts '=' * 20
+          print @options[:stdin]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli/command/init_dotfile.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  class CLI
+    module Command
+      # Generate a .rubocop.yml file in the current directory.
+      class InitDotfile < Base
+        DOTFILE = ConfigLoader::DOTFILE
+
+        self.command_name = :init
+
+        def run
+          path = File.expand_path(DOTFILE)
+
+          if File.exist?(DOTFILE)
+            warn Rainbow("#{DOTFILE} already exists at #{path}").red
+
+            STATUS_ERROR
+          else
+            description = <<~DESC
+              # The behavior of RuboCop can be controlled via the .rubocop.yml
+              # configuration file. It makes it possible to enable/disable
+              # certain cops (checks) and to alter their behavior if they accept
+              # any parameters. The file can be placed either in your home
+              # directory or in some project directory.
+              #
+              # RuboCop will start looking for the configuration file in the directory
+              # where the inspected file is and continue its way up to the root directory.
+              #
+              # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+            DESC
+
+            File.open(DOTFILE, 'w') do |f|
+              f.write(description)
+            end
+
+            puts "Writing new #{DOTFILE} to #{path}"
+
+            STATUS_SUCCESS
+          end
+        end
+      end
+    end
+  end
+end