solargraph_test_coverage 0.2.3 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e0c33725c04d5fe0ccb51767c639d8e864996edf5396e05c16e3aa72bc18da
-  data.tar.gz: 30ed55d17273d8ec327f9f83cf69573a33bcc1a77ec036e7267136da2aff17a1
+  metadata.gz: b7c7bd9d2a4a3b6184942c28ce619023f098a515ca356e8534788adb93f9cb96
+  data.tar.gz: 11850e7e7184658995b6e15479e8c3c87527f4b945c8b8bc9ab446242c5dba32
 SHA512:
-  metadata.gz: f3b2c1f49dec3b91a85495ecbeeeb381d6948fdbcdd0bf10ed843be0b02d33c1a84545a902cd220051e52f272ad0bb4d651d4e5c7043f2d97612cb48f3cabdae
-  data.tar.gz: 440383a6909e68f20d726c5fce67d6b8f195e772be6702161e4421c04cf1720f451ba0c23637b906732e2a0a9895612901cbc2b5c9198a30070393d392d59ce7
+  metadata.gz: d4901017237a8e5cfc49e8a0228776c48929304ebb043bdd9c89500e56db2c4d7349b01838c911a3080900ca1d657b07f2d29a921d0cc39b2da96efe517d1443
+  data.tar.gz: c00ecc7e6c928c42a93abda3f976e3d0811934f21f21362a40711dbc449244a3e443d683a6c6204955ea3ec28989226f41d5b371344238594d78c86b3fb98987

data/Gemfile.lock

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

data/README.md

@@ -33,12 +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'
+    - 'app/controller'
+    - 'concerns'
 ```
 
 
@@ -50,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,124 @@
 # 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
+      '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 line_coverage?
-        plugin_config['coverage'].include? 'line'
-      end
+    def preload_rails?
+      plugin_config['preload_rails']
+    end
 
-      def branch_coverage?
-        plugin_config['coverage'].include? 'branch'
-      end
+    def exclude_paths
+      plugin_config['exclude_paths']
+    end
 
-      def test_failing_coverage?
-        plugin_config['coverage'].include? 'test_failing'
-      end
+    def line_coverage?
+      plugin_config['coverage'].include? 'line'
+    end
 
-      def test_missing_coverage?
-        plugin_config['coverage'].include? 'test_missing'
-      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 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?
+
+      true
+    rescue LoadError => e
+      Solargraph::Logging.logger.warn "LoadError when trying to require 'rails_helper'"
+      Solargraph::Logging.logger.warn "[#{e.class}] #{e.message}"
 
-      def workspace_config
-        Solargraph::Workspace::Config.new(Dir.pwd).raw_data.fetch('test_coverage', {})
+      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
+      ReporterHelpers.test_path
+    end
   end
 end

data/lib/solargraph_test_coverage/fork_process.rb

@@ -5,28 +5,36 @@ 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 if result.nil?
+
+      Marshal.load(result).tap { |r| raise ChildFailedError if r.nil? }
+    end
+
+    private
 
-      Marshal.load(result)
+    def run_block_with_timeout(&block)
+      Timeout.timeout(30, &block)
+    rescue StandardError
+      nil
     end
   end
 end

data/lib/solargraph_test_coverage/reporter_helpers.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+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)
+      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
+
+    def messages(source, results)
+      messages = [
+        line_warnings(source, results),
+        branch_warnings(source, results),
+        test_passing_error(source, results)
+      ]
+
+      messages.flatten.compact
+    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
+
+    # 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
+
+    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

@@ -3,13 +3,10 @@
 # test_coverage reporter for Solargraph
 module SolargraphTestCoverage
   class TestCoverageReporter < Solargraph::Diagnostics::Base
-    include Helpers
+    include ReporterHelpers
 
-    # LSP Diagnostic method
-    # @return [Array]
-    #
     def diagnose(source, _api_map)
-      return [] if source.code.empty? || exclude_file?(source.location.filename)
+      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)
@@ -20,43 +17,6 @@ module SolargraphTestCoverage
 
     private
 
-    # 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?
 
@@ -68,11 +28,6 @@ module SolargraphTestCoverage
       }
     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?
 
@@ -84,9 +39,6 @@ module SolargraphTestCoverage
       }
     end
 
-    # Creates LSP error message if test file is failing
-    # @return [Hash]
-    #
     def test_failing_error(source)
       return unless Config.test_failing_coverage?
 
@@ -98,19 +50,14 @@ module SolargraphTestCoverage
       }
     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,
+        severity: Solargraph::Diagnostics::Severities::HINT,
         source: 'TestCoverage',
-        message: "No unit test file found at #{test_file(source)}"
+        message: "No test file found at '#{test_file(source).sub("#{Dir.pwd}/", '')}'"
       }
     end
   end

data/lib/solargraph_test_coverage/test_runner.rb

@@ -18,10 +18,14 @@ module SolargraphTestCoverage
     end
 
     def run!
-      @result = test_framework_runner.run([@test_file])
+      @result = test_framework_runner.run(test_options)
       self
     end
 
+    def test_options
+      raise NotImplementedError
+    end
+
     def passed?
       raise NotImplementedError
     end
@@ -33,6 +37,10 @@ module SolargraphTestCoverage
 
   # Test Runner Subclass for RSpec
   class RSpecRunner < TestRunner
+    def test_options
+      [@test_file, '-o', '/dev/null']
+    end
+
     def passed?
       @result&.zero?
     end
@@ -44,6 +52,10 @@ module SolargraphTestCoverage
 
   # Test Runner Subclass for Minitest
   class MinitestRunner < TestRunner
+    def test_options
+      [@test_file]
+    end
+
     def passed?
       @result
     end

data/lib/solargraph_test_coverage/version.rb

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

data/lib/solargraph_test_coverage.rb

@@ -3,21 +3,22 @@
 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/config'
 require 'solargraph_test_coverage/test_runner'
 require 'solargraph_test_coverage/test_coverage_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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph_test_coverage
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.7
 platform: ruby
 authors:
 - Cameron Kolkey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
@@ -48,7 +48,7 @@ files:
 - lib/solargraph_test_coverage/branch.rb
 - lib/solargraph_test_coverage/config.rb
 - lib/solargraph_test_coverage/fork_process.rb
-- lib/solargraph_test_coverage/helpers.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,127 +0,0 @@
-# frozen_string_literal: true
-
-module SolargraphTestCoverage
-  # Some helper functions for the diagnostics
-  module Helpers
-    # Determines if a file should be excluded from running diagnostics
-    # @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
-
-    # Attempts to find the corresponding unit test file
-    # @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
-
-    # Runs test file in a child process with specified testing framework
-    # Returns coverage results for current working file
-    #
-    # @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)
-      results.fetch(:lines)
-             .each_with_index
-             .select { |c, _| c&.zero? }
-             .map { |_, i| i }
-             .compact
-    end
-
-    # Builds a new Branch object for each branch tested from results hash
-    # Then removes branches which have test coverage
-    #
-    # @return [Array]
-    #
-    def uncovered_branches(results)
-      Branch.build_from(results).reject(&:covered?)
-    end
-
-    # Builds a range for warnings/errors
-    # @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
-
-    # requires the specified testing framework
-    # @return [Boolean]
-    #
-    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
-
-    # Returns absolute path for test folder
-    # @return [String]
-    #
-    def self.test_path
-      File.join(Dir.pwd, Config.test_dir)
-    end
-  end
-end