solargraph_test_coverage 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afacac1a6d557ea7ef39c86081fc7f3aafcb7e09c3a8243679e9d252ba47a2c7
-  data.tar.gz: 9e929da5ff5873ef3c044edebb4a96575cb47f4bfb9b2d36121082257ac03569
+  metadata.gz: 5aba663e3f7dca496c3c527adc1be8024353932ef806cf6f9eed9c70bd44f120
+  data.tar.gz: d4a031ffbb4e97f2d13eff2552760d3beae56413b1666e6e84edd1c182919c1e
 SHA512:
-  metadata.gz: 58b77e64736847a4d5d6fedb3c67f7b76e6af6056e844926356269c052b8bfe5f29af0c1f76e916f2e26d1ddb5c5628d3d324f53c890ceeff55f289959409b8c
-  data.tar.gz: 92e5f351f941d99103339f80fb05450e1393cb5929f584cd7d080759450f9cd31422a71d51ba847664b1217b88c761f1f132f346f280106580c8c806ba1c6bd9
+  metadata.gz: 71edec840ad30fb0e2852c0f6ad3928b961631f546d02060500001e4c8e6bc0ff9f5bb3f71f4e4261ed00d483d6d4c6c3e25fc7dca35cd970a386b77ba28df16
+  data.tar.gz: 1abf9451d0fdcaca5f5f4ec52a6ffb918391bfdc092a09c77778b76dcc137b41c0e17719d7141182a92f472f2505d56f2f9b93fc0547748f681a1f1ba226bd78

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solargraph_test_coverage (0.2.3)
+    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

@@ -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/branch.rb

@@ -3,22 +3,15 @@
 module SolargraphTestCoverage
   # Adapted from SimpleCov - Small class that turns branch coverage data into something easier to work with
   class Branch
-    class << self
-      #
-      # Builds an array of Branch objects for every branch in results hash.
-      #
-      # @return [Array]
-      #
-      def build_from(results)
-        results.fetch(:branches, {}).flat_map do |condition, branches|
-          _condition_type, _condition_id, condition_start_line, * = condition
+    def self.build_from(results)
+      results.fetch(:branches, {}).flat_map do |condition, branches|
+        _condition_type, _condition_id, condition_start_line, * = condition
 
-          branches.map do |branch_data, hit_count|
-            type, _id, start_line, _start_col, end_line, _end_col = branch_data
+        branches.map do |branch_data, hit_count|
+          type, _id, start_line, _start_col, end_line, _end_col = branch_data
 
-            new(start_line: start_line, end_line: end_line, coverage: hit_count,
-                inline: start_line == condition_start_line, type: type)
-          end
+          new(start_line: start_line, end_line: end_line, coverage: hit_count,
+              inline: start_line == condition_start_line, type: type)
         end
       end
     end
@@ -33,44 +26,18 @@ module SolargraphTestCoverage
       @type       = type
     end
 
-    #
-    # Predicate method for @inline instance variable
-    #
-    # @return [Boolean]
-    #
     def inline?
       @inline
     end
 
-    #
-    # Return true if there is relevant count defined > 0
-    #
-    # @return [Boolean]
-    #
     def covered?
       coverage.positive?
     end
 
-    #
-    # The line on which we want to report the coverage
-    #
-    # Usually we choose the line above the start of the branch (so that it shows up
-    # at if/else) because that
-    # * highlights the condition
-    # * makes it distinguishable if the first line of the branch is an inline branch
-    #   (see the nested_branches fixture)
-    #
-    # @return [Integer]
-    #
     def report_line
       inline? ? start_line : start_line - 1
     end
 
-    #
-    # Return array with coverage count and badge
-    #
-    # @return [Hash]
-    #
     def report
       { type: type, line: report_line }
     end

data/lib/solargraph_test_coverage/config.rb

@@ -1,82 +1,134 @@
 # frozen_string_literal: true
 
-# frozen_string_literal = true
-
 module SolargraphTestCoverage
-  class Config
-    class << self
-      DEFAULTS = {
-        'preload_rails' => true,         # can be true or false - performance optimization
-        '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'
-        ],
-        'exclude_paths' => [             # don't attempt to find/run a spec for files that match these paths
-          'app/controller',
-          'concerns'
-        ]
-      }.freeze
-
-      def preload_rails?
-        plugin_config['preload_rails']
-      end
+  module Config
+    extend self
 
-      def exclude_paths
-        plugin_config['exclude_paths']
-      end
+    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',
+        'example_failing'
+      ],
+      'exclude_paths' => [             # don't attempt to find/run a spec for files that match these paths
+        'app/controller',
+        'concerns'
+      ]
+    }.freeze
 
-      def line_coverage?
-        plugin_config['coverage'].include? 'line'
-      end
+    def debug?
+      plugin_config['debug']
+    end
 
-      def branch_coverage?
-        plugin_config['coverage'].include? 'branch'
-      end
+    def preload_rails?
+      plugin_config['preload_rails']
+    end
 
-      def test_failing_coverage?
-        plugin_config['coverage'].include? 'test_failing'
-      end
+    def exclude_paths
+      plugin_config['exclude_paths']
+    end
 
-      def test_missing_coverage?
-        plugin_config['coverage'].include? 'test_missing'
-      end
+    def line_coverage?
+      plugin_config['coverage'].include? 'line'
+    end
+
+    def branch_coverage?
+      plugin_config['coverage'].include? 'branch'
+    end
+
+    def test_failing_coverage?
+      plugin_config['coverage'].include? 'test_failing'
+    end
+
+    def test_missing_coverage?
+      plugin_config['coverage'].include? 'test_missing'
+    end
 
-      def test_framework
-        plugin_config['test_framework']
+    def example_failing_coverage?
+      plugin_config['coverage'].include? 'example_failing'
+    end
+
+    def test_framework
+      plugin_config['test_framework']
+    end
+
+    def test_dir
+      case test_framework
+      when 'rspec'
+        'spec'
+      when 'minitest'
+        'test'
       end
+    end
 
-      def test_dir
-        case test_framework
-        when 'rspec'
-          'spec'
-        when 'minitest'
-          'test'
-        end
+    def test_file_suffix
+      case test_framework
+      when 'rspec'
+        '_spec.rb'
+      when 'minitest'
+        '_test.rb'
       end
+    end
 
-      def test_file_suffix
-        case test_framework
-        when 'rspec'
-          '_spec.rb'
-        when 'minitest'
-          '_test.rb'
-        end
+    def require_testing_framework!
+      case test_framework
+      when 'rspec'
+        require 'rspec/core'
+      when 'minitest'
+        require 'minitest/autorun'
+      else
+        raise UnknownTestingGem
       end
+    end
 
-      private
+    # This gives us a nice speed-boost when running test in child process
+    #
+    # We rescue the LoadError since Solargraph would catch it otherwise,
+    # and not load the plugin at all.
+    #
+    # Adding the spec/ directory to the $LOAD_PATH lets 'require "spec_helper"'
+    # commonly found in rails_helper work.
+    #
+    # If Coverage was started in Rails/Spec helper by SimpleCov,
+    # calling Coverage.result after requiring stops and resets it.
+    #
+    # This is a bit experimental
+    #
+    def preload_rails!
+      return if defined?(Rails) || !File.file?('spec/rails_helper.rb')
 
-      def plugin_config
-        @plugin_config ||= workspace_config.tap do |config|
-          DEFAULTS.each_key { |key| config[key] = DEFAULTS[key] unless config.key?(key) }
-        end
-      end
+      $LOAD_PATH.unshift(test_path) unless $LOAD_PATH.include?(test_path)
+
+      require File.join(test_path, 'rails_helper')
+      Coverage.result(stop: true, clear: true) if Coverage.running?
 
-      def workspace_config
-        Solargraph::Workspace::Config.new(Dir.pwd).raw_data.fetch('test_coverage', {})
+      true
+    rescue LoadError => e
+      Solargraph::Logging.logger.warn "LoadError when trying to require 'rails_helper'"
+      Solargraph::Logging.logger.warn "[#{e.class}] #{e.message}"
+
+      false
+    end
+
+    private
+
+    def plugin_config
+      @plugin_config ||= workspace_config.tap do |config|
+        DEFAULTS.each_key { |key| config[key] = DEFAULTS[key] unless config.key?(key) }
       end
     end
+
+    def workspace_config
+      Solargraph::Workspace::Config.new(Dir.pwd).raw_data.fetch('test_coverage', {})
+    end
+
+    def 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

@@ -5,28 +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
-    #
-    # @return [Object]
-    #
-    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,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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  # Some helper functions for the diagnostics
+  module ReporterHelpers
+    # @return [Hash]
+    def run_test(source, test_file)
+      ForkProcess.call do
+        Coverage.start(lines: true, branches: true)
+        runner = TestRunner.with(test_file).run!
+
+        Coverage.result
+                .fetch(source.location.filename, {})
+                .merge({ test_status: runner.passed?, failed_examples: runner.failed_examples })
+      end
+    end
+
+    def line_warnings(source, results)
+      uncovered_lines(results).map { |line| line_coverage_warning(source, line) }
+    end
+
+    def branch_warnings(source, results)
+      uncovered_branches(results).map { |branch| branch_coverage_warning(source, branch.report) }
+    end
+
+    def test_passing_error(source, results)
+      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
+    #
+    #  [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
+  end
+end

data/lib/solargraph_test_coverage/test_coverage_reporter.rb

@@ -3,115 +3,23 @@
 # test_coverage reporter for Solargraph
 module SolargraphTestCoverage
   class TestCoverageReporter < Solargraph::Diagnostics::Base
-    include Helpers
+    include ReporterHelpers
+    include ReporterGuards
+    include DiagnosticMessages
 
-    # LSP Diagnostic method
-    # @return [Array]
-    #
     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))
+      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)
-      messages(source, results)
-    rescue ChildFailedError
-      []
-    end
-
-    private
+      results = run_test(source, FileHelpers.test_file(source))
 
-    # Compiles all diagnostic messages for source file
-    # @return [Array]
-    #
-    def messages(source, results)
-      messages = [
+      [
         line_warnings(source, results),
         branch_warnings(source, results),
         test_passing_error(source, results)
-      ]
-
-      messages.flatten.compact
-    end
-
-    # Creates array of warnings for uncovered lines
-    # @return [Array]
-    #
-    def line_warnings(source, results)
-      uncovered_lines(results).map { |line| line_coverage_warning(source, line) }
-    end
-
-    # Creates array of warnings for uncovered branches
-    # @return [Array]
-    #
-    def branch_warnings(source, results)
-      uncovered_branches(results).map { |branch| branch_coverage_warning(source, branch.report) }
-    end
-
-    # Creates array containing error for failing spec
-    # @return [Array]
-    #
-    def test_passing_error(source, results)
-      results[:test_status] ? [] : [test_failing_error(source)]
-    end
-
-    # Creates LSP warning message for missing line coverage
-    # @return [Hash]
-    #
-    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
-
-    # Creates LSP warning message for missing branch coverage
-    # Line numbers are off by 1, since Branch Coverage starts counting at 1, not 0
-    #
-    # @return [Hash]
-    #
-    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
-
-    # Creates LSP error message if test file is failing
-    # @return [Hash]
-    #
-    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
-
-    #
-    # Creates LSP error message if no test file can be found
-    #
-    # @return [Hash]
-    #
-    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::ERROR,
-        source: 'TestCoverage',
-        message: "No unit test file found at #{test_file(source)}"
-      }
+      ].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.4'
+  VERSION = '0.3.0'
 end

data/lib/solargraph_test_coverage.rb

@@ -3,21 +3,27 @@
 require 'solargraph_test_coverage/version'
 require 'solargraph_test_coverage/branch'
 require 'solargraph_test_coverage/fork_process'
-require 'solargraph_test_coverage/helpers'
+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
 
   class UnknownTestingGem < StandardError; end
 
-  Helpers.require_testing_framework!
-  Helpers.preload_rails! if Config.preload_rails?
+  Config.require_testing_framework!
+  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.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Cameron Kolkey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
@@ -47,8 +47,12 @@ 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/helpers.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
 - lib/solargraph_test_coverage/version.rb

data/lib/solargraph_test_coverage/helpers.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-module SolargraphTestCoverage
-  # Some helper functions for the diagnostics
-  module Helpers
-    # @return [Boolean]
-    def exclude_file?(source_filename)
-      return true if source_filename.start_with? Helpers.test_path
-
-      Config.exclude_paths.each { |path| return true if source_filename.sub(Dir.pwd, '').include? path }
-
-      false
-    end
-
-    # @return [String]
-    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
-        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
-
-    # 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
-    #
-    #  [nil, 1, 0, 1, 0] -> [3, 5]
-    #
-    # @return [Array]
-    #
-    def uncovered_lines(results)
-      return [] unless results[:lines]
-
-      results[:lines].each_with_index
-                     .select { |c, _| c&.zero? }
-                     .map { |_, i| i }
-                     .compact
-    end
-
-    # @return [Array]
-    def uncovered_branches(results)
-      Branch.build_from(results).reject(&:covered?)
-    end
-
-    # @return [Hash]
-    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.require_testing_framework!
-      case Config.test_framework
-      when 'rspec'
-        require 'rspec/core'
-      when 'minitest'
-        require 'minitest/autorun'
-      else
-        raise UnknownTestingGem
-      end
-    end
-
-    # Only called once, when gem is loaded
-    # Preloads rails via spec/rails_helper if Rails isn't already defined
-    # This gives us a nice speed-boost when running test in child process
-    #
-    # We rescue the LoadError since Solargraph would catch it otherwise,
-    # and not load the plugin at all.
-    #
-    # Adding the spec/ directory to the $LOAD_PATH lets 'require "spec_helper"'
-    # commonly found in rails_helper work.
-    #
-    # If Coverage was started in Rails/Spec helper by SimpleCov,
-    # calling Coverage.result after requiring stops and resets it.
-    #
-    # This is a bit experimental - I'm not sure if there will be downstream side-effects
-    #
-    # @return [Boolean]
-    #
-    def self.preload_rails!
-      return if defined?(Rails) || !File.file?('spec/rails_helper.rb')
-
-      $LOAD_PATH.unshift(test_path) unless $LOAD_PATH.include?(test_path)
-
-      require File.join(test_path, 'rails_helper')
-      Coverage.result(stop: true, clear: true) if Coverage.running?
-
-      true
-    rescue LoadError => e
-      Solargraph::Logging.logger.warn "LoadError when trying to require 'rails_helper'"
-      Solargraph::Logging.logger.warn "[#{e.class}] #{e.message}"
-
-      false
-    end
-
-    # @return [String]
-    def self.test_path
-      File.join(Dir.pwd, Config.test_dir)
-    end
-  end
-end