solargraph_test_coverage 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7c7bd9d2a4a3b6184942c28ce619023f098a515ca356e8534788adb93f9cb96
-  data.tar.gz: 11850e7e7184658995b6e15479e8c3c87527f4b945c8b8bc9ab446242c5dba32
+  metadata.gz: 5aba663e3f7dca496c3c527adc1be8024353932ef806cf6f9eed9c70bd44f120
+  data.tar.gz: d4a031ffbb4e97f2d13eff2552760d3beae56413b1666e6e84edd1c182919c1e
 SHA512:
-  metadata.gz: d4901017237a8e5cfc49e8a0228776c48929304ebb043bdd9c89500e56db2c4d7349b01838c911a3080900ca1d657b07f2d29a921d0cc39b2da96efe517d1443
-  data.tar.gz: c00ecc7e6c928c42a93abda3f976e3d0811934f21f21362a40711dbc449244a3e443d683a6c6204955ea3ec28989226f41d5b371344238594d78c86b3fb98987
+  metadata.gz: 71edec840ad30fb0e2852c0f6ad3928b961631f546d02060500001e4c8e6bc0ff9f5bb3f71f4e4261ed00d483d6d4c6c3e25fc7dca35cd970a386b77ba28df16
+  data.tar.gz: 1abf9451d0fdcaca5f5f4ec52a6ffb918391bfdc092a09c77778b76dcc137b41c0e17719d7141182a92f472f2505d56f2f9b93fc0547748f681a1f1ba226bd78

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solargraph_test_coverage (0.2.6)
+    solargraph_test_coverage (0.3.0)
       solargraph (~> 0.40, > 0.40)
 
 GEM
@@ -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/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,6 +49,10 @@ 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
@@ -118,7 +128,7 @@ module SolargraphTestCoverage
     end
 
     def test_path
-      ReporterHelpers.test_path
+      FileHelpers.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(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
+
+    def test_missing_error(source)
+      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.test_file(source).sub("#{Dir.pwd}/", '')}'"
+      }
+    end
+
+    def example_failing_error(example, source)
+      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, source)
+      {
+        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,20 @@
+# 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)
+      if source.code.empty? || using_debugger?(source) || !is_test_file?(source) || is_test_support_file?(source)
+        return []
+      end
+
+      example_failing_errors(source, run_test(source, source.location.filename))
+    rescue ChildFailedError => e
+      Config.debug? ? [debug_message(e, source)] : []
+    end
+  end
+end

data/lib/solargraph_test_coverage/file_helpers.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  module FileHelpers
+    extend self
+
+    def test_file(source)
+      relative_filepath = source.location.filename.sub(Dir.pwd, '').split('/').reject(&:empty?)
+
+      if relative_filepath.first == Config.test_dir && relative_filepath.last.end_with?(Config.test_file_suffix)
+        return source.location.filename
+      end
+
+      relative_filepath[0] = Config.test_dir
+      File.join(Dir.pwd, relative_filepath.join('/')).sub('.rb', Config.test_file_suffix)
+    end
+
+    def test_path
+      File.join(Dir.pwd, Config.test_dir)
+    end
+  end
+end

data/lib/solargraph_test_coverage/fork_process.rb

@@ -24,17 +24,20 @@ module SolargraphTestCoverage
       result = @read.read
 
       Process.wait(pid)
-      raise ChildFailedError if result.nil?
+      raise ChildFailedError, "Couldn't read pipe" if result.nil?
 
-      Marshal.load(result).tap { |r| raise ChildFailedError if r.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
 
     def run_block_with_timeout(&block)
-      Timeout.timeout(30, &block)
-    rescue StandardError
-      nil
+      Timeout.timeout(30000, &block)
+    rescue StandardError => e
+      e
     end
   end
 end

data/lib/solargraph_test_coverage/reporter_guards.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  # Some guard functions for the diagnostics
+  module ReporterGuards
+    def has_test_file?(source)
+      File.file? FileHelpers.test_file(source)
+    end
+
+    def is_test_file?(source)
+      source.location.filename.start_with? FileHelpers.test_path
+    end
+
+    def is_test_support_file?(source)
+      is_test_file?(source) && !source.location.filename.end_with?(Config.test_file_suffix)
+    end
+
+    def exclude_file?(source)
+      Config.exclude_paths.any? { |path| source.location.filename.sub(Dir.pwd, '').include? path }
+    end
+
+    def using_debugger?(source)
+      source.code.include?('binding.pry') ||
+        source.code.include?('byebug') ||
+        source.code.include?('debugger')
+    end
+  end
+end

data/lib/solargraph_test_coverage/reporter_helpers.rb

@@ -3,42 +3,16 @@
 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 using_debugger?(source)
-      source.code.include?('binding.pry') ||
-        source.code.include?('byebug') ||
-        source.code.include?('debugger')
-    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)
+    def run_test(source, 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? })
-      end
-    end
+        runner = TestRunner.with(test_file).run!
 
-    def messages(source, results)
-      messages = [
-        line_warnings(source, results),
-        branch_warnings(source, results),
-        test_passing_error(source, results)
-      ]
-
-      messages.flatten.compact
+        Coverage.result
+                .fetch(source.location.filename, {})
+                .merge({ test_status: runner.passed?, failed_examples: runner.failed_examples })
+      end
     end
 
     def line_warnings(source, results)
@@ -53,6 +27,11 @@ module SolargraphTestCoverage
       results[:test_status] ? [] : [test_failing_error(source)]
     end
 
+    def example_failing_errors(source, results)
+      results.fetch(:failed_examples, [])
+             .map { |example| example_failing_error(example, source) }
+    end
+
     # Adapted from SingleCov
     # Coverage returns nil for untestable lines (like 'do', 'end', 'if' keywords)
     # otherwise returns int showing how many times a line was called
@@ -71,17 +50,5 @@ module SolargraphTestCoverage
     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 test_path
-      ReporterHelpers.test_path
-    end
   end
 end

data/lib/solargraph_test_coverage/test_coverage_reporter.rb

@@ -4,61 +4,22 @@
 module SolargraphTestCoverage
   class TestCoverageReporter < Solargraph::Diagnostics::Base
     include ReporterHelpers
+    include ReporterGuards
+    include DiagnosticMessages
 
     def diagnose(source, _api_map)
-      return [] if source.code.empty? || using_debugger?(source) || exclude_file?(source.location.filename)
-      return [test_missing_error(source)] unless File.file?(test_file(source))
-
-      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
-
-    def test_missing_error(source)
-      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 '#{test_file(source).sub("#{Dir.pwd}/", '')}'"
-      }
+      return [] if source.code.empty? || using_debugger?(source) || exclude_file?(source) || is_test_file?(source)
+      return [test_missing_error(source)] unless has_test_file?(source)
+
+      results = run_test(source, FileHelpers.test_file(source))
+
+      [
+        line_warnings(source, results),
+        branch_warnings(source, results),
+        test_passing_error(source, results)
+      ].flatten.compact
+    rescue ChildFailedError => e
+      Config.debug? ? [debug_message(e, source)] : []
     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.7'
+  VERSION = '0.3.0'
 end

data/lib/solargraph_test_coverage.rb

@@ -4,9 +4,13 @@ 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'
@@ -21,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.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Cameron Kolkey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-18 00:00:00.000000000 Z
+date: 2021-09-23 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