standard 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7368d84b38b7c89c397955507edcf80bec5faf78ec478c9f5b70969abd1f3cd8
-  data.tar.gz: f74eb8f5da9fd6459c9aee08c16ab5a5de09392230e545e9812d29ac3d745720
+  metadata.gz: e4c53488a0de2cfd83d5a709a948b34f8cc824e4c6e12112f9a54b639b0f8b52
+  data.tar.gz: 2ee6d881d29a8f0c1e97f8463973cf98673b709f5771f445313395f07e382958
 SHA512:
-  metadata.gz: a357e1a42c1114344a68531cb65a22d2f82256dc98ce9b96ecea78959bae66a9beca785b266ec02d4f09ccbb2e3b2823ea30835682c917c2519b86c2e012b3f2
-  data.tar.gz: 2acd01cc74605a7d97e367e24d439a22ee1aa8c3520d1da76f763a0491b2fff31bc3ab6d9884c14d7921f349d2d93039ea5346f3f64ad394574a177784a4ee42
+  metadata.gz: 125bfbc5932e5dc79d05716189735a492b7ec334912397dcd002b322ae88eec59513fc6969b512b423aa9a9d87c4ce333ab03d75970d9d0edabe2b93ca4ed417
+  data.tar.gz: 72e9e47eb341377a3de943609d6e368d00e3e60940b5b45eec3654d9f3b12cd135cb1d1c4265d21b819b9a41ec8fc12b5e22bfe9e2860705025fc068ade64519

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.4.0
+
+* Add `--todo` mode for incremental adoption of Standard to a project ([PR](https://github.com/testdouble/standard/pull/155) by [@mrbiggred](https://github.com/mrbiggred))
+
+## 0.3.0
+
+* Update Standard to track Rubocop 0.82.0 ([commit](https://github.com/testdouble/standard/commit/d663ea62d519c659087ad606bfed031c6303ff20))
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standard (0.3.0)
+    standard (0.4.0)
       rubocop (~> 0.82.0)
       rubocop-performance (~> 1.5.2)
 

data/README.md

@@ -88,6 +88,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
@@ -143,6 +157,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

data/lib/standard/builds_config.rb

@@ -7,13 +7,17 @@ module Standard
 
   class BuildsConfig
     def initialize
+      @parses_cli_option = ParsesCliOption.new
       @loads_yaml_config = LoadsYamlConfig.new
       @merges_settings = MergesSettings.new
       @creates_config_store = CreatesConfigStore.new
     end
 
     def call(argv, search_path = Dir.pwd)
-      standard_config = @loads_yaml_config.call(argv, search_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_config = @loads_yaml_config.call(standard_yaml_path, todo_yaml_path)
+
       settings = @merges_settings.call(argv, standard_config)
       Config.new(
         settings.runner,
@@ -22,5 +26,11 @@ module Standard
         @creates_config_store.call(standard_config)
       )
     end
+
+    private
+
+    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
   end
 end

data/lib/standard/formatter.rb

@@ -1,3 +1,4 @@
+require "yaml"
 require "rubocop"
 require_relative "detects_fixability"
 
@@ -29,6 +30,7 @@ module Standard
     end
 
     def finished(_)
+      print_todo_warning
       print_call_for_feedback if @any_uncorrected_offenses
     end
 
@@ -59,6 +61,22 @@ module Standard
       end
     end
 
+    def print_todo_warning
+      todo_file = options[:todo_file]
+      return unless todo_file
+
+      todo_ignore_files = options[:todo_ignore_files]
+      return unless todo_ignore_files
+
+      output.print <<-HEADER.gsub(/^ {8}/, "")
+        WARNING: this project is being migrated to standard gradually via `#{todo_file}` and is ignoring these files:
+      HEADER
+
+      todo_ignore_files.each do |f|
+        output.printf("  %s\n", f)
+      end
+    end
+
     def path_to(file)
       Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
     end

data/lib/standard/loads_yaml_config.rb

@@ -5,14 +5,11 @@ require_relative "parses_cli_option"
 
 module Standard
   class LoadsYamlConfig
-    def initialize
-      @parses_cli_option = ParsesCliOption.new
-    end
+    def call(standard_yaml_path, todo_yaml_path)
+      standard_yaml = load_standard_yaml(standard_yaml_path)
+      todo_yaml = load_standard_yaml(todo_yaml_path)
 
-    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))
+      construct_config(standard_yaml_path, standard_yaml, todo_yaml_path, todo_yaml)
     end
 
     private
@@ -25,15 +22,17 @@ module Standard
       end
     end
 
-    def construct_config(yaml_path, standard_yaml)
+    def construct_config(yaml_path, standard_yaml, todo_path, todo_yaml)
       {
         ruby_version: Gem::Version.new((standard_yaml["ruby_version"] || RUBY_VERSION)),
         fix: !!standard_yaml["fix"],
         format: standard_yaml["format"],
         parallel: !!standard_yaml["parallel"],
-        ignore: expand_ignore_config(standard_yaml["ignore"]),
+        ignore: expand_ignore_config(standard_yaml["ignore"]) + expand_ignore_config(todo_yaml["ignore"]),
         default_ignores: standard_yaml.key?("default_ignores") ? !!standard_yaml["default_ignores"] : true,
-        config_root: yaml_path ? Pathname.new(yaml_path).dirname.to_s : nil
+        config_root: yaml_path ? Pathname.new(yaml_path).dirname.to_s : nil,
+        todo_file: todo_path,
+        todo_ignore_files: todo_yaml["ignore"] || []
       }
     end
 

data/lib/standard/merges_settings.rb

@@ -20,7 +20,7 @@ module Standard
 
     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 @@ module Standard
         :help
       elsif (argv & ["--version", "-v"]).any?
         :version
+      elsif (argv & ["--generate-todo"]).any?
+        :genignore
       else
         :rubocop
       end
@@ -51,7 +53,9 @@ module Standard
         auto_correct: standard_yaml[:fix],
         safe_auto_correct: standard_yaml[:fix],
         formatters: [[standard_yaml[:format] || "Standard::Formatter", nil]],
-        parallel: standard_yaml[:parallel]
+        parallel: standard_yaml[:parallel],
+        todo_file: standard_yaml[:todo_file],
+        todo_ignore_files: standard_yaml[:todo_ignore_files]
       }.merge(standard_cli_flags).merge(rubocop_cli_flags)
     end
 

data/lib/standard/runners/genignore.rb

@@ -0,0 +1,48 @@
+require "tempfile"
+require "yaml"
+require_relative "rubocop"
+
+module Standard
+  module Runners
+    class Genignore
+      def call(config)
+        # Place to temporally store the ignored files.
+        temp_file = Tempfile.new("excluded.txt")
+        begin
+          # Run Rubocop to generate the files with errors into the temp file.
+          config.rubocop_options[:formatters] = [["files", temp_file.path]]
+          config.rubocop_options[:format] = "files"
+          config.rubocop_options[:out] = temp_file.path
+          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 = temp_file.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
+
+          # Read the files with errors from the temp file.
+          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
+        ensure
+          # Clean up temp file.
+          temp_file.close
+          temp_file.unlink
+        end
+      end
+    end
+  end
+end

data/lib/standard/version.rb

@@ -1,3 +1,3 @@
 module Standard
-  VERSION = Gem::Version.new("0.3.0")
+  VERSION = Gem::Version.new("0.4.0")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -133,6 +133,7 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".standard.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -163,6 +164,7 @@ files:
 - lib/standard/railtie.rb
 - lib/standard/rake.rb
 - lib/standard/rubocop/ext.rb
+- lib/standard/runners/genignore.rb
 - lib/standard/runners/help.rb
 - lib/standard/runners/rubocop.rb
 - lib/standard/runners/version.rb