solargraph_test_coverage 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aba663e3f7dca496c3c527adc1be8024353932ef806cf6f9eed9c70bd44f120
-  data.tar.gz: d4a031ffbb4e97f2d13eff2552760d3beae56413b1666e6e84edd1c182919c1e
+  metadata.gz: 74b455e9459cc2032d23bcb1acf41d4d31f9ee3b8148c67895598ace977a98e9
+  data.tar.gz: a0c2942f3973466af1d7782363415e5accd17fb1f65c9fcd6d930dedd8b363c0
 SHA512:
-  metadata.gz: 71edec840ad30fb0e2852c0f6ad3928b961631f546d02060500001e4c8e6bc0ff9f5bb3f71f4e4261ed00d483d6d4c6c3e25fc7dca35cd970a386b77ba28df16
-  data.tar.gz: 1abf9451d0fdcaca5f5f4ec52a6ffb918391bfdc092a09c77778b76dcc137b41c0e17719d7141182a92f472f2505d56f2f9b93fc0547748f681a1f1ba226bd78
+  metadata.gz: f8abcd10d5c816586cab20e0b20ca3925df48723d64c9442fe63d8cbcbfacdc51367da617bf77adb158c22653ca08bf8cc92005cd83ecf170216ccb19eefc3ad
+  data.tar.gz: 7d4fbef5094bb5ebc477daebfe20b70ca0c9e6fd6d3a04053138bafee245094bfe51b38e05251837a665b275b2a16cfd8f6f33ce4dc3839bc9726000eb499b94

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:

data/lib/solargraph_test_coverage/config.rb

@@ -57,6 +57,10 @@ module SolargraphTestCoverage
       plugin_config['test_framework']
     end
 
+    def full_test_dir
+      File.join(Dir.pwd, test_dir)
+    end
+
     def test_dir
       case test_framework
       when 'rspec'
@@ -102,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
@@ -126,9 +130,5 @@ module SolargraphTestCoverage
     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

@@ -2,64 +2,64 @@
 
 module SolargraphTestCoverage
   module DiagnosticMessages
-    def line_coverage_warning(source, line)
+    def line_coverage_warning(line)
       return unless Config.line_coverage?
 
       {
-        range: range(line, 0, line, source.code.lines[line].length),
+        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)
+    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),
+        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)
+    def test_failing_error
       return unless Config.test_failing_coverage?
 
       {
-        range: range(0, 0, 0, source.code.lines[0].length),
+        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)
+    def test_missing_error
       return unless Config.test_missing_coverage?
 
       {
-        range: range(0, 0, 0, source.code.lines[0].length),
+        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}/", '')}'"
+        message: "No test file found at '#{FileHelpers.relative_test_file(@filename)}'"
       }
     end
 
-    def example_failing_error(example, source)
+    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),
+        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)
+    def debug_message(exception)
       {
-        range: range(0, 0, 0, source.code.lines[0].length),
+        range: range(0, 0, 0, @source.code.lines[0].length),
         severity: Solargraph::Diagnostics::Severities::ERROR,
         source: 'SolargraphTestCoverage Plugin',
         message: "DEBUG: (ChildFailedError) #{exception.message}"

data/lib/solargraph_test_coverage/example_status_reporter.rb

@@ -8,13 +8,16 @@ module SolargraphTestCoverage
     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
+      @source    = source
+      @filename  = source.location.filename
 
-      example_failing_errors(source, run_test(source, 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, source)] : []
+      Config.debug? ? [debug_message(e)] : []
     end
   end
 end

data/lib/solargraph_test_coverage/file_helpers.rb

@@ -4,19 +4,27 @@ module SolargraphTestCoverage
   module FileHelpers
     extend self
 
-    def test_file(source)
-      relative_filepath = source.location.filename.sub(Dir.pwd, '').split('/').reject(&:empty?)
+    def test_file(filename)
+      return filename if test_file?(filename)
 
-      if relative_filepath.first == Config.test_dir && relative_filepath.last.end_with?(Config.test_file_suffix)
-        return source.location.filename
-      end
+      path     = relative_path(filename).split('/')
+      path[0]  = Config.test_dir
+      path[-1] = path.last.sub(/\.rb$/, Config.test_file_suffix)
 
-      relative_filepath[0] = Config.test_dir
-      File.join(Dir.pwd, relative_filepath.join('/')).sub('.rb', Config.test_file_suffix)
+      File.join(Dir.pwd, path.join('/'))
     end
 
-    def test_path
-      File.join(Dir.pwd, Config.test_dir)
+    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/reporter_guards.rb

@@ -3,26 +3,24 @@
 module SolargraphTestCoverage
   # Some guard functions for the diagnostics
   module ReporterGuards
-    def has_test_file?(source)
-      File.file? FileHelpers.test_file(source)
+    def test_file_exists?
+      File.file? FileHelpers.test_file(@filename)
     end
 
-    def is_test_file?(source)
-      source.location.filename.start_with? FileHelpers.test_path
+    def in_test_dir?
+      @filename.start_with? Config.full_test_dir
     end
 
-    def is_test_support_file?(source)
-      is_test_file?(source) && !source.location.filename.end_with?(Config.test_file_suffix)
+    def test_support_file?
+      in_test_dir? && !@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 }
+    def exclude_file?
+      Config.exclude_paths.any? { |path| FileHelpers.relative_path(@filename).include? path }
     end
 
-    def using_debugger?(source)
-      source.code.include?('binding.pry') ||
-        source.code.include?('byebug') ||
-        source.code.include?('debugger')
+    def using_debugger?
+      @source.code.match?(/(binding\.pry|byebug|debugger)/)
     end
   end
 end

data/lib/solargraph_test_coverage/reporter_helpers.rb

@@ -4,32 +4,33 @@ module SolargraphTestCoverage
   # Some helper functions for the diagnostics
   module ReporterHelpers
     # @return [Hash]
-    def run_test(source, test_file)
+    def run_test(test_file)
       ForkProcess.call do
         Coverage.start(lines: true, branches: true)
         runner = TestRunner.with(test_file).run!
+        extra = { test_status: runner.passed?, failed_examples: runner.failed_examples }
 
-        Coverage.result
-                .fetch(source.location.filename, {})
-                .merge({ test_status: runner.passed?, failed_examples: runner.failed_examples })
+        Coverage.result.fetch(@filename, {}).merge(extra)
       end
     end
 
-    def line_warnings(source, results)
-      uncovered_lines(results).map { |line| line_coverage_warning(source, line) }
+    def branch_warnings
+      Branch.build_from(@results)
+            .reject(&:covered?)
+            .map { |branch| branch_coverage_warning(branch.report) }
     end
 
-    def branch_warnings(source, results)
-      uncovered_branches(results).map { |branch| branch_coverage_warning(source, branch.report) }
+    def test_passing_error
+      @results[:test_status] ? [] : [test_failing_error]
     end
 
-    def test_passing_error(source, results)
-      results[:test_status] ? [] : [test_failing_error(source)]
+    def example_failing_errors
+      @results.fetch(:failed_examples, [])
+              .map { |example| example_failing_error(example) }
     end
 
-    def example_failing_errors(source, results)
-      results.fetch(:failed_examples, [])
-             .map { |example| example_failing_error(example, source) }
+    def line_warnings
+      uncovered_lines.map { |line| line_coverage_warning(line) }
     end
 
     # Adapted from SingleCov
@@ -38,17 +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]
+    def uncovered_lines
+      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?)
+      @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

@@ -8,18 +8,17 @@ module SolargraphTestCoverage
     include DiagnosticMessages
 
     def diagnose(source, _api_map)
-      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)
+      @source   = source
+      @filename = source.location.filename
 
-      results = run_test(source, FileHelpers.test_file(source))
+      return [] if source.code.empty? || using_debugger? || exclude_file? || in_test_dir?
+      return [test_missing_error] unless test_file_exists?
 
-      [
-        line_warnings(source, results),
-        branch_warnings(source, results),
-        test_passing_error(source, results)
-      ].flatten.compact
+      @results = run_test(FileHelpers.test_file(@filename))
+
+      [line_warnings, branch_warnings, test_passing_error].flatten.compact
     rescue ChildFailedError => e
-      Config.debug? ? [debug_message(e, source)] : []
+      Config.debug? ? [debug_message(e)] : []
     end
   end
 end

data/lib/solargraph_test_coverage/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph_test_coverage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Cameron Kolkey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph