solargraph_test_coverage 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c76dedeaddccb806778b5846c3587233919f1d78088edde15bb7b61681013896
-  data.tar.gz: 387c79384703dd5e92dddf31995982539a233094c7b985ad2977ff1265b2c16c
+  metadata.gz: 74b455e9459cc2032d23bcb1acf41d4d31f9ee3b8148c67895598ace977a98e9
+  data.tar.gz: a0c2942f3973466af1d7782363415e5accd17fb1f65c9fcd6d930dedd8b363c0
 SHA512:
-  metadata.gz: 8d80b6d4abe2d40414c5dbc84652c1c4161a5b1d439b79e232414a1cbfbab1f27c51cf11e4d00a940309a01d5813ef59b4d88e57374ba1ce8ef81725b56b0c6a
-  data.tar.gz: 8bb2180c520a7b8b1c9dcecb191b68fc3c4be7c68c65cd2b4b5bc1ec6f8a40102f069cba5d0e4edebdd28753631657a4f50eb3886b6cbc1bde74c5cee293f70b
+  metadata.gz: f8abcd10d5c816586cab20e0b20ca3925df48723d64c9442fe63d8cbcbfacdc51367da617bf77adb158c22653ca08bf8cc92005cd83ecf170216ccb19eefc3ad
+  data.tar.gz: 7d4fbef5094bb5ebc477daebfe20b70ca0c9e6fd6d3a04053138bafee245094bfe51b38e05251837a665b275b2a16cfd8f6f33ce4dc3839bc9726000eb499b94

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solargraph_test_coverage (0.2.4)
+    solargraph_test_coverage (0.3.0)
       solargraph (~> 0.40, > 0.40)
 
 GEM
@@ -19,7 +19,7 @@ GEM
       kramdown (~> 2.0)
     nokogiri (1.12.4-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     racc (1.5.2)
@@ -29,7 +29,7 @@ GEM
     reverse_markdown (2.0.0)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.20.0)
+    rubocop (1.21.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -41,7 +41,7 @@ GEM
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
-    solargraph (0.43.0)
+    solargraph (0.43.2)
       backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)
@@ -58,7 +58,7 @@ GEM
       yard (~> 0.9, >= 0.9.24)
     thor (1.1.0)
     tilt (2.0.10)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     yard (0.9.26)
 
 PLATFORMS

data/README.md

@@ -14,7 +14,7 @@ Currently there are four different diagnostics:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'solargraph_test_coverage'
+gem 'solargraph_test_coverage', require: false
 ```
 
 Then add this to your `.solargraph.yml` config:
@@ -33,13 +33,13 @@ test_coverage:
   preload_rails: true
   test_framework: rspec # or minitest
   coverage:
-  - line
-  - branch
-  - test_failing
-  - test_missing
+    - line
+    - branch
+    - test_failing
+    - test_missing
   exclude_paths:
-  - 'app/controller'
-  - 'concerns'
+    - 'app/controller'
+    - 'concerns'
 ```
 
 
@@ -51,6 +51,9 @@ And then execute:
 Or install it yourself as:
 
     $ gem install solargraph_test_coverage
+    
+A note on testing framework:
+Since both Minitest and RSpec are supported, neither are direct dependencies of this gem. Therefore, you have to have them installed separately either via your bundle or via `gem install`.
 
 ## Usage
 

data/lib/solargraph_test_coverage/config.rb

@@ -6,12 +6,14 @@ module SolargraphTestCoverage
 
     DEFAULTS = {
       'preload_rails' => true,         # can be true or false - performance optimization
+      'debug' => false,                # can be true or false - shows debug messages when ChildFailedError is raised
       'test_framework' => 'rspec',     # can be 'rspec' or 'minitest'
       'coverage' => [                  # All diagnostics are enabled by default
         'line',                        # Specifying an array with fewer diagnostics will overwrite this
         'branch',
         'test_failing',
-        'test_missing'
+        'test_missing',
+        'example_failing'
       ],
       'exclude_paths' => [             # don't attempt to find/run a spec for files that match these paths
         'app/controller',
@@ -19,6 +21,10 @@ module SolargraphTestCoverage
       ]
     }.freeze
 
+    def debug?
+      plugin_config['debug']
+    end
+
     def preload_rails?
       plugin_config['preload_rails']
     end
@@ -43,10 +49,18 @@ module SolargraphTestCoverage
       plugin_config['coverage'].include? 'test_missing'
     end
 
+    def example_failing_coverage?
+      plugin_config['coverage'].include? 'example_failing'
+    end
+
     def test_framework
       plugin_config['test_framework']
     end
 
+    def full_test_dir
+      File.join(Dir.pwd, test_dir)
+    end
+
     def test_dir
       case test_framework
       when 'rspec'
@@ -92,9 +106,9 @@ module SolargraphTestCoverage
     def preload_rails!
       return if defined?(Rails) || !File.file?('spec/rails_helper.rb')
 
-      $LOAD_PATH.unshift(test_path) unless $LOAD_PATH.include?(test_path)
+      $LOAD_PATH.unshift(full_test_dir) unless $LOAD_PATH.include?(full_test_dir)
 
-      require File.join(test_path, 'rails_helper')
+      require File.join(full_test_dir, 'rails_helper')
       Coverage.result(stop: true, clear: true) if Coverage.running?
 
       true
@@ -116,9 +130,5 @@ module SolargraphTestCoverage
     def workspace_config
       Solargraph::Workspace::Config.new(Dir.pwd).raw_data.fetch('test_coverage', {})
     end
-
-    def test_path
-      ReporterHelpers.test_path
-    end
   end
 end

data/lib/solargraph_test_coverage/diagnostic_messages.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  module DiagnosticMessages
+    def line_coverage_warning(line)
+      return unless Config.line_coverage?
+
+      {
+        range: range(line, 0, line, @source.code.lines[line].length),
+        severity: Solargraph::Diagnostics::Severities::WARNING,
+        source: 'TestCoverage',
+        message: 'Line is missing test coverage'
+      }
+    end
+
+    def branch_coverage_warning(report)
+      return unless Config.branch_coverage?
+
+      {
+        range: range(report[:line] - 1, 0, report[:line] - 1, @source.code.lines[report[:line] - 1].length),
+        severity: Solargraph::Diagnostics::Severities::WARNING,
+        source: 'TestCoverage',
+        message: "'#{report[:type].upcase}' branch is missing test coverage"
+      }
+    end
+
+    def test_failing_error
+      return unless Config.test_failing_coverage?
+
+      {
+        range: range(0, 0, 0, @source.code.lines[0].length),
+        severity: Solargraph::Diagnostics::Severities::ERROR,
+        source: 'TestCoverage',
+        message: 'Unit Test is currently failing.'
+      }
+    end
+
+    def test_missing_error
+      return unless Config.test_missing_coverage?
+
+      {
+        range: range(0, 0, 0, @source.code.lines[0].length),
+        severity: Solargraph::Diagnostics::Severities::HINT,
+        source: 'TestCoverage',
+        message: "No test file found at '#{FileHelpers.relative_test_file(@filename)}'"
+      }
+    end
+
+    def example_failing_error(example)
+      return unless Config.example_failing_coverage?
+
+      {
+        range: range(example[:line_number], 0, example[:line_number], @source.code.lines[example[:line_number]].length),
+        severity: Solargraph::Diagnostics::Severities::ERROR,
+        source: 'ExampleStatus',
+        message: example[:message]
+      }
+    end
+
+    def debug_message(exception)
+      {
+        range: range(0, 0, 0, @source.code.lines[0].length),
+        severity: Solargraph::Diagnostics::Severities::ERROR,
+        source: 'SolargraphTestCoverage Plugin',
+        message: "DEBUG: (ChildFailedError) #{exception.message}"
+      }
+    end
+
+    private
+
+    def range(start_line, start_column, end_line, end_column)
+      Solargraph::Range.from_to(start_line, start_column, end_line, end_column).to_hash
+    end
+  end
+end

data/lib/solargraph_test_coverage/example_status_reporter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# example_status reporter for Solargraph
+module SolargraphTestCoverage
+  class ExampleStatusReporter < Solargraph::Diagnostics::Base
+    include ReporterHelpers
+    include ReporterGuards
+    include DiagnosticMessages
+
+    def diagnose(source, _api_map)
+      @source    = source
+      @filename  = source.location.filename
+
+      return [] if source.code.empty? || using_debugger? || !in_test_dir? || test_support_file?
+
+      @results = run_test(@filename)
+
+      example_failing_errors
+    rescue ChildFailedError => e
+      Config.debug? ? [debug_message(e)] : []
+    end
+  end
+end

data/lib/solargraph_test_coverage/file_helpers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  module FileHelpers
+    extend self
+
+    def test_file(filename)
+      return filename if test_file?(filename)
+
+      path     = relative_path(filename).split('/')
+      path[0]  = Config.test_dir
+      path[-1] = path.last.sub(/\.rb$/, Config.test_file_suffix)
+
+      File.join(Dir.pwd, path.join('/'))
+    end
+
+    def relative_path(path)
+      path.sub("#{Dir.pwd}/", '')
+    end
+
+    def relative_test_file(filename)
+      relative_path test_file(filename)
+    end
+
+    def test_file?(filename)
+      filename.start_with?(Config.full_test_dir) &&
+        filename.end_with?(Config.test_file_suffix)
+    end
+  end
+end

data/lib/solargraph_test_coverage/fork_process.rb

@@ -5,25 +5,39 @@ module SolargraphTestCoverage
   # When called with a block, runs the content of said block in a new (forked) process
   # the return value of the process/block can be captured and used in parent process
   class ForkProcess
-    # Executes block in forked process, and captures returned value of that block
-    # Returns result of block
-    #
-    def self.run
-      read, write = IO.pipe
+    def self.call(&block)
+      new.run(&block)
+    end
+
+    def initialize
+      @read, @write = IO.pipe
+    end
 
+    def run(&block)
       pid = fork do
-        read.close
-        result = yield
-        Marshal.dump(result, write)
+        @read.close
+        Marshal.dump(run_block_with_timeout(&block), @write)
         exit!(0) # skips exit handlers.
       end
 
-      write.close
-      result = read.read
+      @write.close
+      result = @read.read
+
       Process.wait(pid)
-      raise ChildFailedError if result.nil? || result.empty?
+      raise ChildFailedError, "Couldn't read pipe" if result.nil?
+
+      Marshal.load(result).tap do |r|
+        raise ChildFailedError, "Marshal.load(result) returned nil" if r.nil?
+        raise ChildFailedError, r.message if r.is_a? Exception
+      end
+    end
+
+    private
 
-      Marshal.load(result)
+    def run_block_with_timeout(&block)
+      Timeout.timeout(30000, &block)
+    rescue StandardError => e
+      e
     end
   end
 end

data/lib/solargraph_test_coverage/reporter_guards.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  # Some guard functions for the diagnostics
+  module ReporterGuards
+    def test_file_exists?
+      File.file? FileHelpers.test_file(@filename)
+    end
+
+    def in_test_dir?
+      @filename.start_with? Config.full_test_dir
+    end
+
+    def test_support_file?
+      in_test_dir? && !@filename.end_with?(Config.test_file_suffix)
+    end
+
+    def exclude_file?
+      Config.exclude_paths.any? { |path| FileHelpers.relative_path(@filename).include? path }
+    end
+
+    def using_debugger?
+      @source.code.match?(/(binding\.pry|byebug|debugger)/)
+    end
+  end
+end

data/lib/solargraph_test_coverage/reporter_helpers.rb

@@ -3,48 +3,34 @@
 module SolargraphTestCoverage
   # Some helper functions for the diagnostics
   module ReporterHelpers
-    def exclude_file?(source_filename)
-      return true if source_filename.start_with? test_path
-
-      Config.exclude_paths.any? { |path| source_filename.sub(Dir.pwd, '').include? path }
-    end
-
-    def test_file(source)
-      relative_filepath = source.location.filename.sub(Dir.pwd, '').split('/').reject(&:empty?)
-      relative_filepath[0] = Config.test_dir
-
-      File.join(Dir.pwd, relative_filepath.join('/')).sub('.rb', Config.test_file_suffix)
-    end
-
     # @return [Hash]
-    def run_test(source)
-      ForkProcess.run do
+    def run_test(test_file)
+      ForkProcess.call do
         Coverage.start(lines: true, branches: true)
-        runner = TestRunner.with(test_file(source)).run!
-        Coverage.result.fetch(source.location.filename, {}).merge({ test_status: runner.passed? })
+        runner = TestRunner.with(test_file).run!
+        extra = { test_status: runner.passed?, failed_examples: runner.failed_examples }
+
+        Coverage.result.fetch(@filename, {}).merge(extra)
       end
     end
 
-    def messages(source, results)
-      messages = [
-        line_warnings(source, results),
-        branch_warnings(source, results),
-        test_passing_error(source, results)
-      ]
-
-      messages.flatten.compact
+    def branch_warnings
+      Branch.build_from(@results)
+            .reject(&:covered?)
+            .map { |branch| branch_coverage_warning(branch.report) }
     end
 
-    def line_warnings(source, results)
-      uncovered_lines(results).map { |line| line_coverage_warning(source, line) }
+    def test_passing_error
+      @results[:test_status] ? [] : [test_failing_error]
     end
 
-    def branch_warnings(source, results)
-      uncovered_branches(results).map { |branch| branch_coverage_warning(source, branch.report) }
+    def example_failing_errors
+      @results.fetch(:failed_examples, [])
+              .map { |example| example_failing_error(example) }
     end
 
-    def test_passing_error(source, results)
-      results[:test_status] ? [] : [test_failing_error(source)]
+    def line_warnings
+      uncovered_lines.map { |line| line_coverage_warning(line) }
     end
 
     # Adapted from SingleCov
@@ -53,29 +39,13 @@ module SolargraphTestCoverage
     #
     #  [nil, 1, 0, 1, 0] -> [3, 5]
     #  Returns array of line numbers with 0 coverage
-    def uncovered_lines(results)
-      return [] unless results[:lines]
-
-      results[:lines].each_with_index
-                     .select { |c, _| c&.zero? }
-                     .map { |_, i| i }
-                     .compact
-    end
-
-    def uncovered_branches(results)
-      Branch.build_from(results).reject(&:covered?)
-    end
-
-    def range(start_line, start_column, end_line, end_column)
-      Solargraph::Range.from_to(start_line, start_column, end_line, end_column).to_hash
-    end
-
-    def self.test_path
-      File.join(Dir.pwd, Config.test_dir)
-    end
+    def uncovered_lines
+      return [] unless @results[:lines]
 
-    def test_path
-      ReporterHelpers.test_path
+      @results[:lines].each_with_index
+                      .select { |c, _| c&.zero? }
+                      .map { |_, i| i }
+                      .compact
     end
   end
 end

data/lib/solargraph_test_coverage/test_coverage_reporter.rb

@@ -4,61 +4,21 @@
 module SolargraphTestCoverage
   class TestCoverageReporter < Solargraph::Diagnostics::Base
     include ReporterHelpers
+    include ReporterGuards
+    include DiagnosticMessages
 
     def diagnose(source, _api_map)
-      return [] if source.code.empty? || exclude_file?(source.location.filename)
-      return [test_missing_error(source)] unless File.file?(test_file(source))
+      @source   = source
+      @filename = source.location.filename
 
-      results = run_test(source)
-      messages(source, results)
-    rescue ChildFailedError
-      []
-    end
-
-    private
-
-    def line_coverage_warning(source, line)
-      return unless Config.line_coverage?
-
-      {
-        range: range(line, 0, line, source.code.lines[line].length),
-        severity: Solargraph::Diagnostics::Severities::WARNING,
-        source: 'TestCoverage',
-        message: 'Line is missing test coverage'
-      }
-    end
-
-    def branch_coverage_warning(source, report)
-      return unless Config.branch_coverage?
-
-      {
-        range: range(report[:line] - 1, 0, report[:line] - 1, source.code.lines[report[:line] - 1].length),
-        severity: Solargraph::Diagnostics::Severities::WARNING,
-        source: 'TestCoverage',
-        message: "'#{report[:type].upcase}' branch is missing test coverage"
-      }
-    end
-
-    def test_failing_error(source)
-      return unless Config.test_failing_coverage?
-
-      {
-        range: range(0, 0, 0, source.code.lines[0].length),
-        severity: Solargraph::Diagnostics::Severities::ERROR,
-        source: 'TestCoverage',
-        message: 'Unit Test is currently failing.'
-      }
-    end
+      return [] if source.code.empty? || using_debugger? || exclude_file? || in_test_dir?
+      return [test_missing_error] unless test_file_exists?
 
-    def test_missing_error(source)
-      return unless Config.test_missing_coverage?
+      @results = run_test(FileHelpers.test_file(@filename))
 
-      {
-        range: range(0, 0, 0, source.code.lines[0].length),
-        severity: Solargraph::Diagnostics::Severities::HINT,
-        source: 'TestCoverage',
-        message: "No test file found at '#{test_file(source).sub("#{Dir.pwd}/", '')}'"
-      }
+      [line_warnings, branch_warnings, test_passing_error].flatten.compact
+    rescue ChildFailedError => e
+      Config.debug? ? [debug_message(e)] : []
     end
   end
 end

data/lib/solargraph_test_coverage/test_runner.rb

@@ -15,14 +15,15 @@ module SolargraphTestCoverage
     def initialize(test_file)
       @test_file = test_file
       @result    = nil
+      @output    = StringIO.new
     end
 
     def run!
-      @result = test_framework_runner.run(test_options)
+      @result = test_framework_runner.run(test_options, $stderr, @output)
       self
     end
 
-    def test_options
+    def failed_examples
       raise NotImplementedError
     end
 
@@ -30,21 +31,43 @@ module SolargraphTestCoverage
       raise NotImplementedError
     end
 
+    private
+
+    def test_options
+      raise NotImplementedError
+    end
+
     def test_framework_runner
       raise NotImplementedError
     end
+
+    def output
+      return if @output.string.empty?
+
+      JSON.parse @output.string
+    end
   end
 
   # Test Runner Subclass for RSpec
   class RSpecRunner < TestRunner
-    def test_options
-      [@test_file, '-o', '/dev/null']
+    def failed_examples
+      return unless output
+
+      output['examples']
+        .select { |example| example['status'] == 'failed' }
+        .map { |example| { line_number: example['line_number'] - 1, message: example.dig('exception', 'message') } }
     end
 
     def passed?
       @result&.zero?
     end
 
+    private
+
+    def test_options
+      [@test_file, '--format', 'json']
+    end
+
     def test_framework_runner
       RSpec::Core::Runner
     end
@@ -52,14 +75,21 @@ module SolargraphTestCoverage
 
   # Test Runner Subclass for Minitest
   class MinitestRunner < TestRunner
-    def test_options
-      [@test_file]
+    # TODO
+    def failed_examples
+      []
     end
 
     def passed?
       @result
     end
 
+    private
+
+    def test_options
+      [@test_file]
+    end
+
     def test_framework_runner
       Minitest
     end

data/lib/solargraph_test_coverage/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolargraphTestCoverage
-  VERSION = '0.2.5'
+  VERSION = '0.3.1'
 end

data/lib/solargraph_test_coverage.rb

@@ -4,12 +4,17 @@ require 'solargraph_test_coverage/version'
 require 'solargraph_test_coverage/branch'
 require 'solargraph_test_coverage/fork_process'
 require 'solargraph_test_coverage/reporter_helpers'
+require 'solargraph_test_coverage/reporter_guards'
+require 'solargraph_test_coverage/file_helpers'
 require 'solargraph_test_coverage/config'
 require 'solargraph_test_coverage/test_runner'
+require 'solargraph_test_coverage/diagnostic_messages'
 require 'solargraph_test_coverage/test_coverage_reporter'
+require 'solargraph_test_coverage/example_status_reporter'
 
 require 'solargraph'
 require 'coverage'
+require 'timeout'
 
 module SolargraphTestCoverage
   class ChildFailedError < StandardError; end
@@ -20,4 +25,5 @@ module SolargraphTestCoverage
   Config.preload_rails! if Config.preload_rails?
 
   Solargraph::Diagnostics.register 'test_coverage', TestCoverageReporter
+  Solargraph::Diagnostics.register 'example_status', ExampleStatusReporter
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph_test_coverage
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Cameron Kolkey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
@@ -47,7 +47,11 @@ files:
 - lib/solargraph_test_coverage.rb
 - lib/solargraph_test_coverage/branch.rb
 - lib/solargraph_test_coverage/config.rb
+- lib/solargraph_test_coverage/diagnostic_messages.rb
+- lib/solargraph_test_coverage/example_status_reporter.rb
+- lib/solargraph_test_coverage/file_helpers.rb
 - lib/solargraph_test_coverage/fork_process.rb
+- lib/solargraph_test_coverage/reporter_guards.rb
 - lib/solargraph_test_coverage/reporter_helpers.rb
 - lib/solargraph_test_coverage/test_coverage_reporter.rb
 - lib/solargraph_test_coverage/test_runner.rb