Added the Ability to Generate a todo File

README.md

@@ -86,6 +86,20 @@ $ bundle exec standardrb "lib/**/*.rb" test
 **Note:** by default, StandardRB will look for all `*.rb` files (and some other
 files typically associated with Ruby like `*.gemspec` and `Gemfile`)
 
+If you have an existing project but aren't ready to fix all the files yet you can
+generate a todo file:
+
+```bash
+$ bundle exec standardrb --generate-todo
+```
+
+This will create a `.standard_todo.yml` that lists all the files that contain errors.
+When you run Standard in the future it will ignore these files as if they lived under the
+`ignore` section in the `.standard.yml` file.
+
+As you refactor your existing project you can remove files from the list.  You can
+also regenerate the todo file at anytime by re-running the above command.
+
 ### Using with Rake
 
 Standard also ships with Rake tasks. If you're using Rails, these should
@@ -141,6 +155,8 @@ cannot be found by ascending the current working directory (i.e. against a
 temporary file buffer in your editor), you can specify the config location with
 `--config path/to/.standard.yml`.
 
+Similarly, for the `.standard_todo.yml` file, you can specify `--todo path/to/.standard_todo.yml`.
+
 ## What you might do if you're REALLY clever
 
 Because StandardRB is essentially a wrapper on top of

lib/standard/loads_yaml_config.rb

@@ -10,13 +10,29 @@ def initialize
     end
 
     def call(argv, search_path)
-      yaml_path = @parses_cli_option.call(argv, "--config") ||
-        FileFinder.new.call(".standard.yml", search_path)
-      construct_config(yaml_path, load_standard_yaml(yaml_path))
+      standard_yaml_path = determine_yaml_file(argv, search_path, "--config", ".standard.yml")
+      todo_yaml_path = determine_yaml_file(argv, search_path, "--todo", ".standard_todo.yml")
+
+      standard_yaml = load_standard_yaml(standard_yaml_path)
+      todo_yaml = load_standard_yaml(todo_yaml_path)
+
+      merge_ignore(standard_yaml, todo_yaml)
+      construct_config(standard_yaml_path, standard_yaml)
     end
 
     private
 
+    def merge_ignore(merge_into_yaml, merge_from_yaml)
+      merge_into_yaml["ignore"] = arrayify(merge_into_yaml["ignore"])
+      merge_from_yaml["ignore"] = arrayify(merge_from_yaml["ignore"])
+
+      merge_into_yaml["ignore"] = merge_into_yaml["ignore"] + merge_from_yaml["ignore"]
+    end
+
+    def determine_yaml_file(argv, search_path, option_name, default_file)
+      @parses_cli_option.call(argv, option_name) || FileFinder.new.call(default_file, search_path)
+    end
+
     def load_standard_yaml(yaml_path)
       if yaml_path
         YAML.load_file(yaml_path) || {}

lib/standard/merges_settings.rb

@@ -20,7 +20,7 @@ def call(argv, standard_yaml)
 
     def separate_argv(argv)
       argv.partition { |flag|
-        ["--fix", "--no-fix", "--version", "-v", "--help", "-h"].include?(flag)
+        ["--generate-todo", "--fix", "--no-fix", "--version", "-v", "--help", "-h"].include?(flag)
       }
     end
 
@@ -41,6 +41,8 @@ def determine_command(argv)
         :help
       elsif (argv & ["--version", "-v"]).any?
         :version
+      elsif (argv & ["--generate-todo"]).any?
+        :genignore
       else
         :rubocop
       end

lib/standard/runners/genignore.rb

@@ -0,0 +1,43 @@
+require "yaml"
+require_relative "rubocop"
+
+module Standard
+  module Runners
+    class Genignore
+      def call(config)
+        # Run Rubocop to generate the files with errors.
+        config.rubocop_options[:formatters] = [["files", "temp_exclude.txt"]]
+        config.rubocop_options[:format] = "files"
+        config.rubocop_options[:out] = "temp_exclude.txt"
+
+        File.delete("exclude.txt") if File.exist?("temp_exclude.txt")
+        Runners::Rubocop.new.call(config)
+
+        # Read in the files with errors.  It will have the absolute paths
+        # of the files but we only want the relative path.
+        files_with_errors = File.open("temp_exclude.txt").readlines.map(&:chomp)
+        files_with_errors.map! do |file|
+          # Get the relative file path.  Don't use the
+          # relative_path_from method as it will raise an
+          # error in Ruby 2.4.1 and possibly other versions.
+          #
+          # https://bugs.ruby-lang.org/issues/10011
+          #
+          file.sub(Dir.pwd + File::SEPARATOR, "")
+        end
+
+        yaml_format_errors = {"ignore" => files_with_errors}
+
+        # Regenerate the todo file.
+        File.open(".standard_todo.yml", "w") do |file|
+          file.puts "# Auto generated files with errors to ignore."
+          file.puts "# Remove from this list as you refactor files."
+          file.write(yaml_format_errors.to_yaml)
+        end
+
+        # Clean up
+        File.delete("temp_exclude.txt") if File.exist?("temp_exclude.txt")
+      end
+    end
+  end
+end

test/fixture/config/u/.standard.yml

@@ -0,0 +1,3 @@
+ignore:
+  - none_todo_path/**/*
+  - none_todo_file.rb

test/fixture/config/u/.standard_todo.yml

@@ -0,0 +1,3 @@
+ignore:
+  - todo_file_one.rb
+  - todo_file_two.rb

test/fixture/genignore/errors_one.rb

@@ -0,0 +1,9 @@
+class ErrorsOne
+  def stuff(id)
+    if bar = Bar.find(id)
+      bar.nice!
+    else
+      false
+    end
+  end
+end

test/fixture/genignore/errors_two.rb

@@ -0,0 +1 @@
+useless_assignment = "LOL"

test/fixture/genignore/no_errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Has no errors
+class NoErrors
+  def add(aaaa, bbbb)
+    aaaa + bbbb
+  end
+end

test/standard/builds_config_test.rb

@@ -92,6 +92,19 @@ def test_specified_standard_yaml_raises
     assert_match(/Configuration file ".*fake\.file" not found/, err.message)
   end
 
+  def test_todo_merged
+    result = @subject.call([], path("test/fixture/config/u"))
+
+    assert_equal DEFAULT_OPTIONS, result.rubocop_options
+
+    assert_equal config_store("test/fixture/config/u").dup.tap { |config_store|
+      config_store["AllCops"]["Exclude"] |= [path("test/fixture/config/u/none_todo_path/**/*")]
+      config_store["AllCops"]["Exclude"] |= [path("test/fixture/config/u/none_todo_file.rb")]
+      config_store["AllCops"]["Exclude"] |= [path("test/fixture/config/u/todo_file_one.rb")]
+      config_store["AllCops"]["Exclude"] |= [path("test/fixture/config/u/todo_file_two.rb")]
+    }, result.rubocop_config_store.for("").to_h
+  end
+
   private
 
   def config_store(config_root = nil, rubocop_yml = "config/base.yml", ruby_version = RUBY_VERSION)

test/standard/merges_settings_test.rb

@@ -25,6 +25,10 @@ def test_version_sets_command_to_version
     assert_equal :version, @subject.call(["-v"], {}).runner
   end
 
+  def test_gen_ignore_sets_command_to_gen_ignore
+    assert_equal :genignore, @subject.call(["--generate-todo"], {}).runner
+  end
+
   def test_fix_flag_sets_auto_correct_options
     options = @subject.call(["--fix"], {}).options
 

test/standard/runners/genignore_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+require "standard/runners/genignore"
+require "standard/runners/rubocop"
+
+class Standard::Runners::GenignoreTest < UnitTest
+  def setup
+    super
+
+    @subject = Standard::Runners::Genignore.new
+  end
+
+  def test_todo_generated
+    FileUtils.rm_rf("tmp/genignore_test")
+    FileUtils.mkdir_p("tmp/genignore_test")
+    FileUtils.cp_r("test/fixture/genignore/.", "tmp/genignore_test")
+
+    Dir.chdir("tmp/genignore_test") do
+      @subject.call(create_config)
+    end
+
+    assert File.exist?("tmp/genignore_test/.standard_todo.yml")
+
+    expected_yaml = {"ignore" => %w[errors_one.rb errors_two.rb]}
+    assert_equal expected_yaml, YAML.load_file("tmp/genignore_test/.standard_todo.yml")
+  end
+
+  private
+
+  def create_config
+    Standard::Config.new(nil, ["."], {}, RuboCop::ConfigStore.new)
+  end
+end

test/standard/runners/rubocop_test.rb

@@ -9,6 +9,8 @@ class Standard::Runners::RubocopTest < UnitTest
   }.freeze
 
   def setup
+    super
+
     @subject = Standard::Runners::Rubocop.new
   end
 

test/test_helper.rb

@@ -17,6 +17,19 @@ def self.path(relative)
     Pathname.new(Dir.pwd).join(relative).to_s
   end
 
+  def setup
+    # Rubocop will cache and reuse the current working directory, which can
+    # be different the actual working directory.  This can mess up tests that
+    # use the quite/simple formatter as they can write out either relative or
+    # absolute paths.  This is not in the Rubocop documentation but can be
+    # found in this PR:
+    #
+    # https://github.com/rubocop-hq/rubocop/pull/262#issuecomment-19265766
+    #
+    # This forces RuboCop to use current working directory.
+    RuboCop::PathUtil.reset_pwd
+  end
+
   def teardown
     Gimme.reset
   end