solargraph_test_coverage 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 663088457d9de39c37ee21f06b2bd16be5a983025af2909f55acfa1d432be0f4
-  data.tar.gz: adc3da11d72363b2c1d3ca4a8db307609b34090d9bdf24643a411e47e0a8be09
+  metadata.gz: 1038b1738247fe8ef8aa47e6675989d5d1e97e4e18c2f26fb9d6aafceca5f6a6
+  data.tar.gz: 9893901996387356d5547b57aa4ebb787998845976c8d7ae067bba3985acf49e
 SHA512:
-  metadata.gz: f3407c7390c65e09f14c8f872455317ef28e8dfc30592554d9087d5bf1fb34e30b802077b7098dd1adc7c1a2082ce29c37b999a358654a929c614d6952e376b4
-  data.tar.gz: 7c252dc55695be04bdfed84d654d3d1ab41143c4d7cd606488f5cdd56365bea3eee8968f8674d1aa4e1d38e254ece0170dd3f6567752bf46e6fe4451da783f8e
+  metadata.gz: 28ab19d5bfe978d8783bfd03f584b49228cc0d06bf310d8c1b8e5cdc20815d077c8587b3faac1ec1d6ddce6b2f7e7af74ace67a91ca94c0125269536607cad15
+  data.tar.gz: f91c21643e59dd1001712f2e62248adccb52a0032ac6d300177a7779e3283bddca769f67c24b307dcba8947b1b5279607c2e32e532bf1c44b11d419df064f5e7

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solargraph_test_coverage (0.2.0)
+    solargraph_test_coverage (0.2.1)
       solargraph (~> 0.40, > 0.40)
 
 GEM

data/README.md

@@ -9,8 +9,6 @@ Currently there are four different diagnostics:
 - Spec cannot be found (Error message will be on line 1)
 
 
-Currently expects RSpec/Rails.
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/solargraph_test_coverage/helpers.rb

@@ -1,48 +1,32 @@
 # 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? File.join(Dir.pwd, Config.test_dir)
+      return true if source_filename.start_with? 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)
-      @test_file ||= begin
-        relative_filepath = source.location.filename.sub(Dir.pwd, '').split('/').reject(&:empty?)
-        relative_filepath[0] = Config.test_dir
+      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
-    end
-
-    #
-    # Memoized wrapper for #run_test
-    #
-    # @return [Hash]
-    #
-    def results(source)
-      @results ||= run_test(source)
+      File.join(Dir.pwd, relative_filepath.join('/'))
+          .sub('.rb', Config.test_file_suffix)
     end
 
-    #
-    # Runs RSpec on test file in a child process
+    # Runs test file in a child process with specified testing framework
     # Returns coverage results for current working file
-    # RSpec::Core::Runner.run will return 0 if the test file passes, and 1 if it does not.
     #
     # @return [Hash]
     #
@@ -54,7 +38,6 @@ module SolargraphTestCoverage
       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
@@ -66,12 +49,11 @@ module SolargraphTestCoverage
     def uncovered_lines(results)
       results.fetch(:lines)
              .each_with_index
-             .select { |c, _| c == 0 }
+             .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
     #
@@ -81,9 +63,14 @@ module SolargraphTestCoverage
       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!
@@ -97,7 +84,6 @@ module SolargraphTestCoverage
       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
@@ -117,13 +103,11 @@ module SolargraphTestCoverage
     # @return [Boolean]
     #
     def self.preload_rails!
-      return if defined?(Rails)
-      return unless File.file?('spec/rails_helper.rb')
+      return if defined?(Rails) || !File.file?('spec/rails_helper.rb')
 
-      spec_path = File.join(Dir.pwd, 'spec')
-      $LOAD_PATH.unshift(spec_path) unless $LOAD_PATH.include?(spec_path)
+      $LOAD_PATH.unshift(test_path) unless $LOAD_PATH.include?(test_path)
 
-      require File.expand_path('spec/rails_helper')
+      require File.join(test_path, 'rails_helper')
       Coverage.result(stop: true, clear: true) if Coverage.running?
 
       true
@@ -133,5 +117,9 @@ module SolargraphTestCoverage
 
       false
     end
+
+    def test_path
+      File.join(Dir.pwd, Config.test_dir)
+    end
   end
 end

data/lib/solargraph_test_coverage/test_coverage_reporter.rb

@@ -5,65 +5,71 @@ module SolargraphTestCoverage
   class TestCoverageReporter < Solargraph::Diagnostics::Base
     include Helpers
 
-    #
     # 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))
 
-      messages(source)
+      results = run_test(source)
+      messages(source, results)
     rescue ChildFailedError
       []
     end
 
     private
 
-    def messages(source)
+    # Compiles all diagnostic messages for source file
+    # @return [Array]
+    #
+    def messages(source, results)
       messages = [
-        line_warnings(source),
-        branch_warnings(source),
-        test_passing_error(source)
+        line_warnings(source, results),
+        branch_warnings(source, results),
+        test_passing_error(source, results)
       ]
 
       messages.flatten.compact
     end
 
-    def line_warnings(source)
-      uncovered_lines(results(source)).map { |line| line_coverage_warning(source, line) }
+    # 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
 
-    def branch_warnings(source)
-      uncovered_branches(results(source)).map { |branch| branch_coverage_warning(source, branch.report) }
+    # 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
 
-    def test_passing_error(source)
-      results(source)[:test_status] ? [] : [test_failing_error(source)]
+    # 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: Solargraph::Range.from_to(line, 0, line, source.code.lines[line].length).to_hash,
+        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
-    # We need to correct the line number (-1), since the coverage module
-    # starts counting lines at 1, while the LSP (source.code.line) is an array
-    # with an index starting at 0
+    # Line numbers are off by 1, since Branch Coverage starts counting at 1, not 0
     #
     # @return [Hash]
     #
@@ -71,24 +77,21 @@ module SolargraphTestCoverage
       return unless Config.branch_coverage?
 
       {
-        range: Solargraph::Range.from_to(report[:line] - 1, 0, report[:line] - 1,
-                                         source.code.lines[report[:line] - 1].length).to_hash,
+        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 is failing
-    #
+    # Creates LSP error message if test file is failing
     # @return [Hash]
     #
     def test_failing_error(source)
       return unless Config.test_failing_coverage?
 
       {
-        range: Solargraph::Range.from_to(0, 0, 0, source.code.lines[0].length).to_hash,
+        range: range(0, 0, 0, source.code.lines[0].length),
         severity: Solargraph::Diagnostics::Severities::ERROR,
         source: 'TestCoverage',
         message: 'Unit Test is currently failing.'
@@ -104,7 +107,7 @@ module SolargraphTestCoverage
       return unless Config.test_missing_coverage?
 
       {
-        range: Solargraph::Range.from_to(0, 0, 0, source.code.lines[0].length).to_hash,
+        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)}"

data/lib/solargraph_test_coverage/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solargraph_test_coverage
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Cameron Kolkey