mutante 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5644bbc1cfc15fe2e6fe859d2ce4ee547f4780ea1215d62cb29408f48bbca591
-  data.tar.gz: 451058c2475efd8c91a90575bd8100f35672eea29431fab6d8755429af4c58d5
+  metadata.gz: ae5a33de8e678194912023676158d0fa89fcd36654799e479c82bc6659c09850
+  data.tar.gz: dba11952956c4ebce0745a598d10202d86599348231d983b9025df7be5549de7
 SHA512:
-  metadata.gz: dda544bdea5c32ddd89486e4cb459b20a24a6cb65a7793ea1378bbeda74e83f17761b3603618d42e00b1327ed12f001cc4cafc8506797bdd9f0b335ca18c43a5
-  data.tar.gz: d961f33aaa7064aa9219fcc93d7bb98d6973a4192c19889d0232a25b84d2da9b6f7b82e2650ddd8f25805a4b9d7158c8c8535a73b150071636d3cf71e00381e3
+  metadata.gz: 39ce2ce83999ddbe1a8b7c32f38c653c8146fa9aa9df243e40ff9cff1cd61db6fd42a1dab74a51ea9d0889bb7fe03db9847f545e89a026357f42475a95a7a425
+  data.tar.gz: 58eebb255f2e36162970157fe57840ed74e81c4e89217683c812e18fbe6fea14af4bd4eccc490a4445cc81e776d63a01faf7f5b2069894f566dc9bb64da6d9b3

data/lib/mutante/cli.rb

@@ -13,13 +13,16 @@ module Mutante
 
     def initialize(argv)
       @argv    = argv.dup
-      @options = { verbose: false, config: nil }
+      @options = { verbose: false, config: nil, output: "mutante_uncovered.txt" }
     end
 
     def run
       target = parse!
       load_configuration
-      ok = Runner.new(verbose: @options[:verbose]).call(target)
+      ok = Runner.new(
+        verbose:     @options[:verbose],
+        output_path: @options[:output]
+      ).call(target)
       exit(ok ? 0 : 1)
     end
 
@@ -37,6 +40,10 @@ module Mutante
           @options[:verbose] = true
         end
 
+        o.on("-o", "--output PATH", "Write uncovered lines to PATH (default: mutante_uncovered.txt)") do |v|
+          @options[:output] = v
+        end
+
         o.on("--version", "Print version and exit") do
           puts "mutante #{Mutante::VERSION}"
           exit 0

data/lib/mutante/line_analyzer.rb

@@ -14,6 +14,10 @@ module Mutante
       @original_lines = File.readlines(path)
     end
 
+    def total_lines
+      @original_lines.size
+    end
+
     # Yields |line_number, line_text| for each line worth trying.
     # Inside the block, the file on disk has that line commented out.
     # After the block returns, the file is restored to its original form.

data/lib/mutante/reporter.rb

@@ -17,7 +17,7 @@ module Mutante
 
     CLEAR_LINE = "\e[2K\r".freeze
 
-    def initialize(io: $stdout, force_plain: false)
+    def initialize(io: $stdout, force_plain: false, output_path: "mutante_uncovered.txt")
       @io            = io
       @flagged       = []
       @tty           = !force_plain && io.respond_to?(:tty?) && io.tty?
@@ -28,6 +28,11 @@ module Mutante
       @file_started  = nil
       @started_at    = nil
       @spinner_index = 0
+      @output_path   = output_path
+      @total_source_lines = 0
+      @total_eligible     = 0
+      @mutex          = Mutex.new
+      @spinner_thread = nil
     end
 
     def starting(files)
@@ -69,79 +74,96 @@ module Mutante
     end
 
     def file_starting(path)
-      @file_index  += 1
-      @current_file = path
-      @counts       = { tested: 0, flagged: 0, skipped: 0 }
-      @file_started = monotonic_now
-
-      if @tty
-        @io.puts
-        @io.puts "#{color(:cyan)}▸#{color(:reset)} " \
-                 "#{color(:bold)}#{path}#{color(:reset)} " \
-                 "#{color(:gray)}[#{@file_index}/#{@total_files}]#{color(:reset)}"
-        redraw_status
-      else
-        @io.puts path
+      @mutex.synchronize do
+        @file_index  += 1
+        @current_file = path
+        @counts       = { tested: 0, flagged: 0, skipped: 0 }
+        @file_started = monotonic_now
+
+        if @tty
+          @io.puts
+          @io.puts "#{color(:cyan)}▸#{color(:reset)} " \
+                   "#{color(:bold)}#{path}#{color(:reset)} " \
+                   "#{color(:gray)}[#{@file_index}/#{@total_files}]#{color(:reset)}"
+          redraw_status
+        else
+          @io.puts path
+        end
       end
+      start_spinner_thread
     end
 
     def line_flagged(path, line_number, line_text)
-      @flagged << { path: path, line: line_number, text: line_text }
-      @counts[:flagged] += 1 if @counts
-      @counts[:tested]  += 1 if @counts
-
-      if @tty
-        @io.print CLEAR_LINE
-        @io.puts "  #{color(:red)}⚑#{color(:reset)} " \
-                 "#{color(:red)}#{path}:#{line_number}#{color(:reset)}  " \
-                 "#{color(:dim)}#{line_text.strip}#{color(:reset)}"
-        redraw_status
-      else
-        @io.puts "  flagged #{path}:#{line_number}  #{line_text.strip}"
+      @mutex.synchronize do
+        @flagged << { path: path, line: line_number, text: line_text }
+        @counts[:flagged] += 1 if @counts
+        @counts[:tested]  += 1 if @counts
+
+        if @tty
+          @io.print CLEAR_LINE
+          @io.puts "  #{color(:red)}⚑#{color(:reset)} " \
+                   "#{color(:red)}#{path}:#{line_number}#{color(:reset)}  " \
+                   "#{color(:dim)}#{line_text.strip}#{color(:reset)}"
+          redraw_status
+        else
+          @io.puts "  flagged #{path}:#{line_number}  #{line_text.strip}"
+        end
       end
     end
 
     def line_safe(_path, _line_number)
-      @counts[:tested] += 1 if @counts
+      @mutex.synchronize do
+        @counts[:tested] += 1 if @counts
 
-      if @tty
-        redraw_status
-      else
-        @io.print "."
-        @io.flush
+        if @tty
+          redraw_status
+        else
+          @io.print "."
+          @io.flush
+        end
       end
     end
 
     def line_skipped(_path, _line_number, _reason)
-      @counts[:skipped] += 1 if @counts
+      @mutex.synchronize do
+        @counts[:skipped] += 1 if @counts
 
-      if @tty
-        redraw_status
-      else
-        @io.print "-"
-        @io.flush
+        if @tty
+          redraw_status
+        else
+          @io.print "-"
+          @io.flush
+        end
       end
     end
 
-    def file_finished
-      if @tty
-        @io.print CLEAR_LINE
-        elapsed = format_duration(monotonic_now - (@file_started || monotonic_now))
-        icon    = @counts && @counts[:flagged].positive? ? "#{color(:yellow)}⚑#{color(:reset)}" : "#{color(:green)}✓#{color(:reset)}"
-        parts   = []
-        parts << "#{@counts[:tested]} tested" if @counts
-        parts << "#{color(:red)}#{@counts[:flagged]} flagged#{color(:reset)}" if @counts && @counts[:flagged].positive?
-        parts << "#{@counts[:skipped]} skipped" if @counts && @counts[:skipped].positive?
-        parts << "#{color(:gray)}#{elapsed}#{color(:reset)}"
-        @io.puts "  #{icon} #{parts.join(color(:gray) + ' · ' + color(:reset))}"
-      else
-        @io.puts
+    def file_finished(total_lines: nil)
+      stop_spinner_thread
+      @mutex.synchronize do
+        @total_source_lines += total_lines.to_i if total_lines
+        @total_eligible     += @counts[:tested] if @counts
+
+        if @tty
+          @io.print CLEAR_LINE
+          elapsed = format_duration(monotonic_now - (@file_started || monotonic_now))
+          icon    = @counts && @counts[:flagged].positive? ? "#{color(:yellow)}⚑#{color(:reset)}" : "#{color(:green)}✓#{color(:reset)}"
+          parts   = []
+          parts << "#{@counts[:tested]} tested" if @counts
+          parts << "#{color(:red)}#{@counts[:flagged]} flagged#{color(:reset)}" if @counts && @counts[:flagged].positive?
+          parts << "#{@counts[:skipped]} skipped" if @counts && @counts[:skipped].positive?
+          parts << "#{color(:gray)}#{elapsed}#{color(:reset)}"
+          @io.puts "  #{icon} #{parts.join(color(:gray) + ' · ' + color(:reset))}"
+        else
+          @io.puts
+        end
       end
     end
 
     def finished
+      stop_spinner_thread
       if @tty
         draw_summary
+        draw_totals
       else
         @io.puts
         @io.puts "=" * 60
@@ -154,7 +176,10 @@ module Mutante
             @io.puts "  #{entry[:path]}:#{entry[:line]}  #{entry[:text].strip}"
           end
         end
+        print_totals_plain
       end
+
+      write_uncovered_file
     end
 
     attr_reader :flagged
@@ -173,10 +198,13 @@ module Mutante
       @spinner_index = (@spinner_index + 1) % SPINNER_FRAMES.size
       spinner = SPINNER_FRAMES[@spinner_index]
 
+      elapsed = format_duration(monotonic_now - (@file_started || monotonic_now))
+
       parts = []
       parts << "#{@counts[:tested]} tested"
       parts << "#{color(:red)}⚑ #{@counts[:flagged]}#{color(:reset)}" if @counts[:flagged].positive?
       parts << "#{color(:gray)}#{@counts[:skipped]} skipped#{color(:reset)}" if @counts[:skipped].positive?
+      parts << "#{color(:gray)}#{elapsed}#{color(:reset)}"
 
       line = "  #{color(:cyan)}#{spinner}#{color(:reset)} " \
              "#{parts.join(color(:gray) + ' · ' + color(:reset))}"
@@ -186,6 +214,27 @@ module Mutante
       @io.flush
     end
 
+    def start_spinner_thread
+      return unless @tty
+      stop_spinner_thread
+
+      @spinner_thread = Thread.new do
+        loop do
+          sleep 0.1
+          @mutex.synchronize { redraw_status }
+        end
+      end
+    end
+
+    def stop_spinner_thread
+      t = @spinner_thread
+      return unless t
+
+      t.kill
+      t.join
+      @spinner_thread = nil
+    end
+
     def draw_header(title, subtitle)
       width   = [title.length, subtitle.length].max + 4
       top     = "╭#{"─" * width}╮"
@@ -244,6 +293,76 @@ module Mutante
       str.gsub(/\e\[[0-9;]*m/, "").length
     end
 
+    def covered_count
+      @total_eligible - @flagged.size
+    end
+
+    def uncovered_count
+      @flagged.size
+    end
+
+    def percent(part, whole)
+      return "0.0%" if whole.nil? || whole.zero?
+
+      "#{((part.to_f / whole) * 100).round(1)}%"
+    end
+
+    def totals_lines
+      covered   = covered_count
+      uncovered = uncovered_count
+      [
+        "#{color(:bold)}totals#{color(:reset)}",
+        "",
+        "  total lines of code:        #{@total_source_lines}",
+        "  eligible lines:             #{@total_eligible} " \
+          "#{color(:gray)}(#{percent(@total_eligible, @total_source_lines)} of total)#{color(:reset)}",
+        "  #{color(:green)}covered (tests catch removal):#{color(:reset)}   " \
+          "#{covered} #{color(:gray)}(#{percent(covered, @total_eligible)} of eligible)#{color(:reset)}",
+        "  #{color(:red)}not covered (safely removable):#{color(:reset)}  " \
+          "#{uncovered} #{color(:gray)}(#{percent(uncovered, @total_eligible)} of eligible)#{color(:reset)}"
+      ]
+    end
+
+    def draw_totals
+      @io.puts
+      @io.puts draw_box(totals_lines, :cyan)
+      @io.puts "  #{color(:gray)}uncovered lines written to #{@output_path}#{color(:reset)}" if @output_path
+    end
+
+    def print_totals_plain
+      covered   = covered_count
+      uncovered = uncovered_count
+      @io.puts
+      @io.puts "totals:"
+      @io.puts "  total lines of code:              #{@total_source_lines}"
+      @io.puts "  eligible lines:                   #{@total_eligible} " \
+               "(#{percent(@total_eligible, @total_source_lines)} of total)"
+      @io.puts "  covered (tests catch removal):    #{covered} " \
+               "(#{percent(covered, @total_eligible)} of eligible)"
+      @io.puts "  not covered (safely removable):   #{uncovered} " \
+               "(#{percent(uncovered, @total_eligible)} of eligible)"
+      @io.puts "  uncovered lines written to #{@output_path}" if @output_path
+    end
+
+    def write_uncovered_file
+      return unless @output_path
+
+      File.open(@output_path, "w") do |f|
+        f.puts "# mutante uncovered lines"
+        f.puts "# total lines of code:              #{@total_source_lines}"
+        f.puts "# eligible lines:                   #{@total_eligible} " \
+               "(#{percent(@total_eligible, @total_source_lines)} of total)"
+        f.puts "# covered (tests catch removal):    #{covered_count} " \
+               "(#{percent(covered_count, @total_eligible)} of eligible)"
+        f.puts "# not covered (safely removable):   #{uncovered_count} " \
+               "(#{percent(uncovered_count, @total_eligible)} of eligible)"
+        f.puts
+        @flagged.each do |entry|
+          f.puts "#{entry[:path]}:#{entry[:line]}: #{entry[:text].strip}"
+        end
+      end
+    end
+
     def format_duration(seconds)
       return "0s" if seconds.nil? || seconds.negative?
 

data/lib/mutante/runner.rb

@@ -3,11 +3,12 @@ module Mutante
     def initialize(configuration: Mutante.configuration,
                    reporter: nil,
                    verbose: false,
+                   output_path: "mutante_uncovered.txt",
                    test_runner: nil,
                    file_finder: nil,
                    spec_finder: nil)
       @configuration = configuration
-      @reporter      = reporter || Reporter.new(force_plain: verbose)
+      @reporter      = reporter || Reporter.new(force_plain: verbose, output_path: output_path)
       @verbose       = verbose
       @finder        = file_finder || FileFinder.new(configuration)
       @spec_finder   = spec_finder || SpecFinder.new(configuration)
@@ -49,7 +50,7 @@ module Mutante
         end
       end
 
-      @reporter.file_finished
+      @reporter.file_finished(total_lines: analyzer.total_lines)
     end
 
     def relative_path(path)

data/lib/mutante/version.rb

@@ -1,3 +1,3 @@
 module Mutante
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mutante
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nazareno Moresco