standard 1.25.5 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd3dd8a74fc215df752f020ed7b5e29f831592bc15cccc3b6c8d8a256bfbee1
-  data.tar.gz: c914ab5a31d00ca0dd0ff6f483f2364b1a885d97988c3df38d169ef3c1edf5f8
+  metadata.gz: 98dc49ce80e703d0a3fb0d1d70bf4bac16c28e9dbf16988c09ebada4cb8bcd9f
+  data.tar.gz: 1e771a7f5eb05183f7700c590bb119eaa5cb104566b656b1945a2198099dd2f2
 SHA512:
-  metadata.gz: 60960dec029698d932669cc588558bce61cf0f58fec3eea09659d04a0c4d3b5708d7b6e055b652eb0cd46ea5c5c253685107df110212a48fc48ae13d78cc030e
-  data.tar.gz: d2d277d165b146c517837384d9519f044c3661f0499198189404ca9e9630065e774e7a3760f57f7f25e0648836558104c64e286f35163bc8e0d2460da3c20c9e
+  metadata.gz: 2ed743c84d1ca8fc6ed19678292463cdb98c1e82d6f698c3fce646a2bcc022dd133e0d1040216c68f5c70d6884248b1fae9a04ccace31497403ba200a0b512b5
+  data.tar.gz: fbef7298ac3da5a0842e087225ed5abd61ec75f8eb6a51629c6213fa196b477cef5b7a7b3b5be161434e405fb6068b9d2f5557f645f0ea145cb9ab39f444fdf0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.26.0
+
+* Introduce `--fix-unsafely` and `rake standard:fix_unsafely` for running
+  unsafe corrections. Improve output about fix suggestions, as well
+  [#545](https://github.com/testdouble/standard/pull/545)
+
 ## 1.25.5
 
 * Temporarily disable registration of `executeCommand` to prevent conflict with

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standard (1.25.5)
+    standard (1.26.0)
       language_server-protocol (~> 3.17.0.2)
       rubocop (~> 1.48.1)
       rubocop-performance (~> 1.16.0)

data/README.md

@@ -76,8 +76,8 @@ files in the current working directory:
 ```bash
 $ bundle exec standardrb
 standard: Use Ruby Standard Style (https://github.com/testdouble/standard)
-standard: Run `standardrb --fix` to automatically fix some problems.
-  /Users/code/cli.rb:31:23: Style/Semicolon: Do not use semicolons to terminate expressions.
+standard: Run `standardrb --fix` to potentially fix one problem.
+  /Users/jill/code/cli.rb:31:23: Style/Semicolon: Do not use semicolons to terminate expressions.
 ```
 
 You can optionally pass in a directory (or directories) using a glob pattern.
@@ -121,6 +121,7 @@ Here are the tasks bundled with Standard:
 ```
 $ rake standard     # equivalent to running `standardrb`
 $ rake standard:fix # equivalent to running `standardrb --fix`
+$ rake standard:fix_unsafely # equivalent to running `standardrb --fix-unsafely`
 ```
 
 You may also pass command line options to Standard's Rake tasks by embedding
@@ -268,6 +269,11 @@ Yes! You can use `standardrb --fix` to fix most issues automatically.
 `standardrb --fix` is built into `standardrb` for maximum convenience. Most
 problems are fixable, but some errors must be fixed manually.
 
+If you're feeling sinister, you can also use `standardrb --fix-unsafely`, which
+will also perform fixes, even if they run the risk of altering program behavior.
+If you read your git diffs closely and have good tests, this is often okay, but
+YMMV… it's called unsafe for a reason!
+
 ## Can I override the `fix: true` config setting?
 
 Also yes! You can use `standardrb --no-fix`. Not `fix`ing is the default

data/config/base.yml

@@ -78,7 +78,6 @@ Layout/AssignmentIndentation:
 Layout/BeginEndAlignment:
   Enabled: true
   EnforcedStyleAlignWith: start_of_line
-  AutoCorrect: true
   Severity: warning
 
 Layout/BlockAlignment:
@@ -110,7 +109,6 @@ Layout/ConditionPosition:
 Layout/DefEndAlignment:
   Enabled: true
   EnforcedStyleAlignWith: start_of_line
-  AutoCorrect: true
   Severity: warning
 
 Layout/DotPosition:
@@ -174,7 +172,6 @@ Layout/EmptyLinesAroundModuleBody:
 
 Layout/EndAlignment:
   Enabled: true
-  AutoCorrect: true
   EnforcedStyleAlignWith: variable
   Severity: warning
 
@@ -447,6 +444,8 @@ Lint/AmbiguousRegexpLiteral:
 Lint/AssignmentInCondition:
   Enabled: true
   AllowSafeAssignment: true
+  # Intentionally disable autocorrect to force us to intentionally decide
+  # whether assignment is intended as opposed to comparison
   AutoCorrect: false
 
 Lint/BigDecimalNew:
@@ -529,7 +528,6 @@ Lint/EmptyConditionalBody:
 
 Lint/EmptyEnsure:
   Enabled: true
-  AutoCorrect: true
 
 Lint/EmptyExpression:
   Enabled: true
@@ -695,7 +693,6 @@ Lint/RedundantWithObject:
 
 Lint/RefinementImportMethods:
   Enabled: true
-  SafeAutoCorrect: false
 
 Lint/RegexpAsCondition:
   Enabled: true
@@ -1003,7 +1000,6 @@ Performance/FlatMap:
 
 Performance/InefficientHashSearch:
   Enabled: true
-  Safe: false
 
 Performance/IoReadlines:
   Enabled: false
@@ -1019,7 +1015,6 @@ Performance/OpenStruct:
 
 Performance/RangeInclude:
   Enabled: true
-  Safe: false
 
 Performance/RedundantBlockCall:
   Enabled: false
@@ -1096,23 +1091,18 @@ Security/Eval:
 
 Security/IoMethods:
   Enabled: false
-  Safe: false
 
 Security/JSONLoad:
   Enabled: true
-  AutoCorrect: false
-  SafeAutoCorrect: false
 
 Security/MarshalLoad:
   Enabled: false
 
 Security/Open:
   Enabled: true
-  Safe: false
 
 Security/YAMLLoad:
   Enabled: true
-  SafeAutoCorrect: false
 
 Standard/BlockSingleLineBraces:
   Enabled: true
@@ -1305,7 +1295,6 @@ Style/Encoding:
 
 Style/EndBlock:
   Enabled: true
-  AutoCorrect: true
 
 Style/EndlessMethod:
   Enabled: false
@@ -1443,7 +1432,6 @@ Style/LambdaCall:
 
 Style/LineEndConcatenation:
   Enabled: true
-  SafeAutoCorrect: false
 
 Style/MagicCommentFormat:
   Enabled: false

data/lib/standard/builds_config.rb

@@ -7,15 +7,15 @@ module Standard
 
   class BuildsConfig
     def initialize
-      @parses_cli_option = ParsesCliOption.new
+      @resolves_yaml_option = ResolvesYamlOption.new
       @loads_yaml_config = LoadsYamlConfig.new
       @merges_settings = MergesSettings.new
       @creates_config_store = CreatesConfigStore.new
     end
 
     def call(argv, search_path = Dir.pwd)
-      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_path = @resolves_yaml_option.call(argv, search_path, "--config", ".standard.yml")
+      todo_yaml_path = @resolves_yaml_option.call(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)
@@ -26,11 +26,5 @@ 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,47 +1,41 @@
 require "yaml"
 require "rubocop"
-require_relative "detects_fixability"
 
 module Standard
   class Formatter < RuboCop::Formatter::BaseFormatter
-    STANDARD_GREETING = <<-MSG.gsub(/^ {6}/, "")
+    STANDARD_GREETING = <<~MSG
       standard: Use Ruby Standard Style (https://github.com/testdouble/standard)
     MSG
 
-    def self.fixable_error_message(command)
-      <<-MSG.gsub(/^ {8}/, "")
-        standard: Run `#{command}` to automatically fix some problems.
-      MSG
-    end
-
-    def initialize(*args)
-      super
-      @detects_fixability = DetectsFixability.new
-      @header_printed_already = false
-      @fix_suggestion_printed_already = false
-      @offenses_encountered = false
-    end
-
     def started(_target_files)
+      @header_printed_already = false
+      @total_correction_count = 0
+      @total_correctable_count = 0
+      @total_uncorrected_count = 0
       print_todo_warning
     end
 
     def file_finished(file, offenses)
-      uncorrected_offenses = offenses.reject(&:corrected?)
-
-      return unless uncorrected_offenses.any?
-
-      @offenses_encountered = true
+      track_stats(offenses)
 
-      print_header_once
-      print_fix_suggestion_once(uncorrected_offenses)
+      if (uncorrected_offenses = offenses.reject(&:corrected?)).any?
+        print_header_once
 
-      uncorrected_offenses.each do |o|
-        output.printf("  %s:%d:%d: %s\n", path_to(file), o.line, o.real_column, o.message.tr("\n", " "))
+        uncorrected_offenses.each do |o|
+          output.printf("  %s:%d:%d: %s\n", path_to(file), o.line, o.real_column, o.message.tr("\n", " "))
+        end
       end
     end
 
+    def track_stats(offenses)
+      corrected = offenses.count(&:corrected?)
+      @total_correction_count += corrected
+      @total_correctable_count += offenses.count(&:correctable?) - corrected
+      @total_uncorrected_count += offenses.count - corrected
+    end
+
     def finished(_inspected_files)
+      print_fix_suggestion
       print_todo_congratulations
     end
 
@@ -55,16 +49,17 @@ module Standard
       @header_printed_already = true
     end
 
-    def print_fix_suggestion_once(offenses)
-      if !@fix_suggestion_printed_already && should_suggest_fix?(offenses)
-        command = if File.split($PROGRAM_NAME).last == "rake"
-          "rake standard:fix"
+    def print_fix_suggestion
+      if (fix_mode = potential_fix_mode)
+        run_mode = determine_run_mode
+
+        command = if run_mode == :rake
+          "rake standard:#{fix_mode}"
         else
-          "standardrb --fix"
+          "standardrb --#{fix_mode.to_s.tr("_", "-")}"
         end
 
-        output.print self.class.fixable_error_message(command)
-        @fix_suggestion_printed_already = true
+        output.print fixable_error_message(command)
       end
     end
 
@@ -75,7 +70,7 @@ module Standard
       todo_ignore_files = options[:todo_ignore_files]
       return unless todo_ignore_files&.any?
 
-      output.print <<-HEADER.gsub(/^ {8}/, "")
+      output.print <<~HEADER
         WARNING: this project is being migrated to standard gradually via `#{todo_file}` and is ignoring these files:
       HEADER
 
@@ -85,29 +80,55 @@ module Standard
     end
 
     def print_todo_congratulations
-      return if @offenses_encountered
-
-      todo_file = options[:todo_file]
-      return unless todo_file
-
-      todo_ignore_files = options[:todo_ignore_files]
-      return if todo_ignore_files&.any?
-
-      output.print <<-HEADER.gsub(/^ {8}/, "")
-        Congratulations, you've successfully migrated this project to Standard! Delete `#{todo_file}` in celebration.
-      HEADER
+      if @total_uncorrected_count == 0 &&
+          options[:todo_file] &&
+          options[:todo_ignore_files]&.none?
+        output.print <<~HEADER
+          Congratulations, you've successfully migrated this project to Standard! Delete `#{options[:todo_file]}` in celebration.
+        HEADER
+      end
     end
 
     def path_to(file)
       Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
     end
 
-    def auto_correct_option_provided?
-      options[:autocorrect]
+    def potential_fix_mode
+      return nil unless @total_correctable_count > 0
+
+      if !options[:autocorrect]
+        :fix
+      elsif options[:autocorrect] && options[:safe_autocorrect]
+        :fix_unsafely
+      end
+    end
+
+    def determine_run_mode
+      if File.split($PROGRAM_NAME).last == "rake"
+        :rake
+      else
+        :cli
+      end
     end
 
-    def should_suggest_fix?(offenses)
-      !auto_correct_option_provided? && @detects_fixability.call(offenses)
+    def fixable_error_message(command)
+      sales_pitch = if !options[:autocorrect]
+        if @total_correctable_count > 1
+          "fix up to #{@total_correctable_count} problems"
+        else
+          "potentially fix one problem"
+        end
+      elsif options[:autocorrect] && options[:safe_autocorrect]
+        if @total_correctable_count > 1
+          "DANGEROUSLY fix #{@total_correctable_count} problems"
+        else
+          "DANGEROUSLY fix one problem"
+        end
+      end
+
+      <<~MSG
+        standard: Run `#{command}` to #{sales_pitch}.
+      MSG
     end
   end
 end

data/lib/standard/loads_yaml_config.rb

@@ -1,7 +1,7 @@
 require "yaml"
 require "pathname"
 require_relative "file_finder"
-require_relative "parses_cli_option"
+require_relative "resolves_yaml_option"
 
 module Standard
   class LoadsYamlConfig

data/lib/standard/lsp/standardizer.rb

@@ -49,9 +49,9 @@ module Standard
       }
       def fork_config(path, text, format:)
         options = if format
-          {stdin: text, autocorrect: true, formatters: [], safe_autocorrect: true}
+          {stdin: text, autocorrect: true, safe_autocorrect: true, formatters: []}
         else
-          {stdin: text, autocorrect: false, formatters: [["json"]], format: "json"}
+          {stdin: text, autocorrect: false, safe_autocorrect: false, formatters: [["json"]], format: "json"}
         end
         Standard::Config.new(@config.runner, [path], BASE_OPTIONS.merge(options), @config.rubocop_config_store)
       end

data/lib/standard/merges_settings.rb

@@ -20,7 +20,7 @@ module Standard
 
     def separate_argv(argv)
       argv.partition do |flag|
-        ["--generate-todo", "--fix", "--no-fix", "--version", "-v", "--verbose-version", "-V", "--help", "-h", "--lsp"].include?(flag)
+        ["--generate-todo", "--fix", "--fix-unsafely", "--no-fix", "--version", "-v", "--verbose-version", "-V", "--help", "-h", "--lsp"].include?(flag)
       end
     end
 
@@ -28,8 +28,13 @@ module Standard
       argv.each_with_object({}) do |arg, cli_flags|
         if arg == "--fix"
           cli_flags[:autocorrect] = true
+          cli_flags[:safe_autocorrect] = true
+        elsif arg == "--fix-unsafely"
+          cli_flags[:autocorrect] = true
+          cli_flags[:safe_autocorrect] = false
         elsif arg == "--no-fix"
           cli_flags[:autocorrect] = false
+          cli_flags[:safe_autocorrect] = false
         end
       end
     end
@@ -53,6 +58,7 @@ module Standard
     def merge(standard_yaml, standard_cli_flags, rubocop_cli_flags)
       {
         autocorrect: standard_yaml[:fix],
+        safe_autocorrect: true,
         formatters: [[standard_yaml[:format] || "Standard::Formatter", nil]],
         parallel: standard_yaml[:parallel],
         todo_file: standard_yaml[:todo_file],

data/lib/standard/rake.rb

@@ -18,9 +18,16 @@ task :standard do
   fail unless exit_code == 0
 end
 
-desc "Lint and automatically fix with the Standard Ruby style guide"
+desc "Lint and automatically make safe fixes with the Standard Ruby style guide"
 task :"standard:fix" do
   require "standard"
   exit_code = Standard::Cli.new(Standard::RakeSupport.argvify + ["--fix"]).run
   fail unless exit_code == 0
 end
+
+desc "Lint and automatically make fixes (even unsafe ones!) with the Standard Ruby style guide"
+task :"standard:fix_unsafely" do
+  require "standard"
+  exit_code = Standard::Cli.new(Standard::RakeSupport.argvify + ["--fix-unsafely"]).run
+  fail unless exit_code == 0
+end

data/lib/standard/{parses_cli_option.rb → resolves_yaml_option.rb}

@@ -1,8 +1,14 @@
 require "pathname"
 
 module Standard
-  class ParsesCliOption
-    def call(argv, option_name)
+  class ResolvesYamlOption
+    def call(argv, search_path, option_name, default_file)
+      search_argv(argv, option_name) || FileFinder.new.call(default_file, search_path)
+    end
+
+    private
+
+    def search_argv(argv, option_name)
       return unless (config_file = argv_value_for(argv, option_name))
 
       resolved_config = Pathname.new(config_file)

data/lib/standard/runners/help.rb

@@ -9,7 +9,8 @@ module Standard
 
           Options:
 
-            --fix             Automatically fix failures where possible
+            --fix             Apply automatic fixes that we're confident won't break your code
+            --fix-unsafely    Apply even more fixes, including some that may change code behavior
             --no-fix          Do not automatically fix failures
             --format <name>   Format output with any RuboCop formatter (e.g. "json")
             --generate-todo   Create a .standard_todo.yml that lists all the files that contain errors

data/lib/standard/runners/verbose_version.rb

@@ -4,7 +4,7 @@ module Standard
   module Runners
     class VerboseVersion
       def call(config)
-        puts <<-MSG.gsub(/^ {10}/, "")
+        puts <<~MSG
           Standard version: #{Standard::VERSION}
           RuboCop version:  #{RuboCop::Version.version(debug: true)}
         MSG

data/lib/standard/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 1.25.5
+  version: 1.26.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2023-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -97,7 +97,6 @@ files:
 - lib/standard/creates_config_store/configures_ignored_paths.rb
 - lib/standard/creates_config_store/merges_user_config_extensions.rb
 - lib/standard/creates_config_store/sets_target_ruby_version.rb
-- lib/standard/detects_fixability.rb
 - lib/standard/file_finder.rb
 - lib/standard/formatter.rb
 - lib/standard/loads_runner.rb
@@ -108,9 +107,9 @@ files:
 - lib/standard/lsp/server.rb
 - lib/standard/lsp/standardizer.rb
 - lib/standard/merges_settings.rb
-- lib/standard/parses_cli_option.rb
 - lib/standard/railtie.rb
 - lib/standard/rake.rb
+- lib/standard/resolves_yaml_option.rb
 - lib/standard/rubocop/ext.rb
 - lib/standard/runners/genignore.rb
 - lib/standard/runners/help.rb

data/lib/standard/detects_fixability.rb

@@ -1,16 +0,0 @@
-module Standard
-  class DetectsFixability
-    def call(offenses)
-      offenses.any? { |offense|
-        cop = cop_instance(offense.cop_name)
-        cop.correctable? && cop.safe_autocorrect?
-      }
-    end
-
-    private
-
-    def cop_instance(cop_name)
-      RuboCop::Cop.const_get(cop_name.gsub("/", "::")).new
-    end
-  end
-end