solargraph_test_coverage 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87bb6c9da590a67d83bc973958129c9a51048932b10e6f93f5b71f434dbc5c24
-  data.tar.gz: 860848733c64a6ecb211547511e189d6a88375785b0b6de000a32cb9f565a737
+  metadata.gz: 69e0c33725c04d5fe0ccb51767c639d8e864996edf5396e05c16e3aa72bc18da
+  data.tar.gz: 30ed55d17273d8ec327f9f83cf69573a33bcc1a77ec036e7267136da2aff17a1
 SHA512:
-  metadata.gz: 05b5cd3c1dd159e537d1832f4a4e95c69225908b9b58a94010de09997264b6262519f32d320e9a43e25b2c24911e59db25e3f89737db934fb4c1653736d14e3e
-  data.tar.gz: be451c86383a71ad4e462bef3b2bb5f807061d392ba5510cb2b0b957fa639192579c191e9fbb034b5066a389662ebd7422f2390e253941a9f6568ec07dcea980
+  metadata.gz: f3b2c1f49dec3b91a85495ecbeeeb381d6948fdbcdd0bf10ed843be0b02d33c1a84545a902cd220051e52f272ad0bb4d651d4e5c7043f2d97612cb48f3cabdae
+  data.tar.gz: 440383a6909e68f20d726c5fce67d6b8f195e772be6702161e4421c04cf1720f451ba0c23637b906732e2a0a9895612901cbc2b5c9198a30070393d392d59ce7

data/.gitignore

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

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in solargraph_test_coverage.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    solargraph_test_coverage (0.1.1)
-      rspec-core (~> 3.10, >= 3.10.0)
+    solargraph_test_coverage (0.2.1)
       solargraph (~> 0.40, > 0.40)
 
 GEM
@@ -18,7 +17,7 @@ GEM
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    nokogiri (1.12.3-x86_64-darwin)
+    nokogiri (1.12.4-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.2.0)
@@ -30,9 +29,6 @@ GEM
     reverse_markdown (2.0.0)
       nokogiri
     rexml (3.2.5)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
     rubocop (1.20.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)

data/README.md

@@ -2,7 +2,12 @@
 
 Solargraph Plugin that provides a diagnostic reporter for unit-test coverage.
 
-Currently only works with RSpec. 
+Currently there are four different diagnostics:
+- Line is not covered
+- Branch is not covered (With a note if it's the 'THEN' or 'ELSE' branch)
+- Spec is failing (Error message will be on line 1)
+- Spec cannot be found (Error message will be on line 1)
+
 
 ## Installation
 
@@ -13,6 +18,7 @@ gem 'solargraph_test_coverage'
 ```
 
 Then add this to your `.solargraph.yml` config:
+
 ```yaml
 plugins:
   - solargraph_test_coverage
@@ -20,16 +26,22 @@ reporters:
   - test_coverage
 ```
 
-If you are using a `spec/rails_helper.rb` file, you will need to change:
-```ruby
-require "spec_helper"
+Additionally, a `test_coverage` key can be added to `.solargraph.yml`. The default values are shown below:
+
+```yaml
+test_coverage:
+  preload_rails: true
+  test_framework: rspec # or minitest
+  coverage:
+  - line
+  - branch
+  - test_failing
+  - test_missing
+  exclude_paths:
+  - 'app/controller'
 ```
 
-to
 
-```ruby
-require_relative "spec_helper"
-```
 
 And then execute:
 
@@ -41,18 +53,12 @@ Or install it yourself as:
 
 ## Usage
 
-With solargraph running and connected to your text editor, you should see diagnostic messages for test coverage.
-
-Currently there are four different messages:
-- Line is not covered
-- Branch is not covered (With a note if it's the 'THEN' or 'ELSE' branch)
-- Spec is failing (Error message will be on line 1)
-- Spec cannot be found (Error message will be on line 1)
+With solargraph running and connected to your text editor, you should see diagnostic messages for line coverage, branch coverage, test file presence, and test status (if it's failing)
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ckolkey/solargraph_test_coverage.
+Bug reports and pull requests are welcome on GitHub at https://github.com/deepdivr/solargraph_test_coverage.
 
 
 ## License

data/Rakefile

@@ -1,2 +1,4 @@
-require "bundler/gem_tasks"
-task :default => :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/lib/solargraph_test_coverage/config.rb

@@ -0,0 +1,82 @@
+# 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
+
+      def exclude_paths
+        plugin_config['exclude_paths']
+      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']
+      end
+
+      def test_dir
+        case test_framework
+        when 'rspec'
+          'spec'
+        when 'minitest'
+          'test'
+        end
+      end
+
+      def test_file_suffix
+        case test_framework
+        when 'rspec'
+          '_spec.rb'
+        when 'minitest'
+          '_test.rb'
+        end
+      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
+    end
+  end
+end

data/lib/solargraph_test_coverage/helpers.rb

@@ -1,34 +1,43 @@
 # 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]
     #
-    # Attempts to find the corrosponding unit test file
-    # TODO: This could be a bit more robust, supporting gems (/lib/) and
-    #       minitest (/test/)
-    #
+    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 locate_test_file(source)
-      source.location.filename.sub('/app/', '/spec/').sub('.rb', '_spec.rb')
+    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 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]
     #
-    def run_rspec(source, test_file)
+    def run_test(source)
       ForkProcess.run do
         Coverage.start(lines: true, branches: true)
-        exit_code = RSpec::Core::Runner.run([test_file])
-        Coverage.result.fetch(source.location.filename, {}).merge({ test_status: exit_code })
+        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
@@ -40,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
     #
@@ -55,7 +63,27 @@ 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!
+      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
@@ -63,21 +91,37 @@ module SolargraphTestCoverage
     # 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
-    # from having Rails preloaded, but... we'll see :)
+    #
+    # @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')
+
+      $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
     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

data/lib/solargraph_test_coverage/test_coverage_reporter.rb

@@ -5,71 +5,96 @@ module SolargraphTestCoverage
   class TestCoverageReporter < Solargraph::Diagnostics::Base
     include Helpers
 
-    #
     # LSP Diagnostic method
-    #
     # @return [Array]
     #
     def diagnose(source, _api_map)
-      return [] if source.code.empty? || !source.location.filename.include?('/app/')
-
-      test_file = locate_test_file(source)
-      return [no_test_file_error(source, test_file)] unless File.file?(test_file)
-
-      results  = run_rspec(source, test_file)
-      lines    = uncovered_lines(results).map { |line| line_coverage_warning(source, line) }
-      branches = uncovered_branches(results).map { |branch| branch_coverage_warning(source, branch.report) }
-      status   = results[:test_status].zero? ? [] : [test_failing_error(source)]
+      return [] if source.code.empty? || exclude_file?(source.location.filename)
+      return [test_missing_error(source)] unless File.file?(test_file(source))
 
-      lines + branches + status
+      results = run_test(source)
+      messages(source, results)
     rescue ChildFailedError
       []
     end
 
     private
 
+    # Compiles all diagnostic messages for source file
+    # @return [Array]
     #
-    # Creates LSP warning message for missing line coverage
+    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: 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]
     #
     def branch_coverage_warning(source, report)
+      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."
+        message: 'Unit Test is currently failing.'
       }
     end
 
@@ -78,12 +103,14 @@ module SolargraphTestCoverage
     #
     # @return [Hash]
     #
-    def no_test_file_error(source, test_file_location)
+    def test_missing_error(source)
+      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_location}"
+        message: "No unit test file found at #{test_file(source)}"
       }
     end
   end

data/lib/solargraph_test_coverage/test_runner.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  # Parent Class for different testing frameworks
+  class TestRunner
+    def self.with(test_file)
+      case Config.test_framework
+      when 'rspec'
+        RSpecRunner.new(test_file)
+      when 'minitest'
+        MinitestRunner.new(test_file)
+      end
+    end
+
+    def initialize(test_file)
+      @test_file = test_file
+      @result    = nil
+    end
+
+    def run!
+      @result = test_framework_runner.run([@test_file])
+      self
+    end
+
+    def passed?
+      raise NotImplementedError
+    end
+
+    def test_framework_runner
+      raise NotImplementedError
+    end
+  end
+
+  # Test Runner Subclass for RSpec
+  class RSpecRunner < TestRunner
+    def passed?
+      @result&.zero?
+    end
+
+    def test_framework_runner
+      RSpec::Core::Runner
+    end
+  end
+
+  # Test Runner Subclass for Minitest
+  class MinitestRunner < TestRunner
+    def passed?
+      @result
+    end
+
+    def test_framework_runner
+      Minitest
+    end
+  end
+end

data/lib/solargraph_test_coverage/version.rb

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

data/lib/solargraph_test_coverage.rb

@@ -1,24 +1,23 @@
+# frozen_string_literal: true
+
 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/config'
+require 'solargraph_test_coverage/test_runner'
 require 'solargraph_test_coverage/test_coverage_reporter'
 
 require 'solargraph'
-require 'rspec/core'
 require 'coverage'
 
-# TODO
-# - Finding the right file could use some work
-# - Config Options for different errors (line, branch, test missing, test failing)
-# - Minitest/Cucumber Support
-# - app/lib support
-# - filter out stuff like controllers that wouldn't have tests
-# - Publish Gem to Rubygems
-
 module SolargraphTestCoverage
   class ChildFailedError < StandardError; end
-  Helpers.preload_rails!
+
+  class UnknownTestingGem < StandardError; end
+
+  Helpers.require_testing_framework!
+  Helpers.preload_rails! if Config.preload_rails?
 
   Solargraph::Diagnostics.register 'test_coverage', TestCoverageReporter
 end

data/solargraph_test_coverage.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/solargraph_test_coverage/version'
 
 Gem::Specification.new do |spec|
@@ -8,11 +10,11 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Solargraph Plugin'
   spec.description   = 'Solargraph Plugin that reports line/branch coverage from unit tests'
-  spec.homepage      = 'https://github.com/ckolkey/solargraph_test_coverage'
+  spec.homepage      = 'https://github.com/deepdivr/solargraph_test_coverage'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
-  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
@@ -29,5 +31,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'solargraph', '~> 0.40', '> 0.40'
-  spec.add_runtime_dependency 'rspec-core', '~> 3.10', '>= 3.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph_test_coverage
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Cameron Kolkey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solargraph
@@ -30,26 +30,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.40'
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.10.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.10.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
 description: Solargraph Plugin that reports line/branch coverage from unit tests
 email:
 - Cameron.Kolkey@gmail.com
@@ -66,19 +46,21 @@ files:
 - Rakefile
 - lib/solargraph_test_coverage.rb
 - 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/test_coverage_reporter.rb
+- lib/solargraph_test_coverage/test_runner.rb
 - lib/solargraph_test_coverage/version.rb
 - solargraph_test_coverage.gemspec
-homepage: https://github.com/ckolkey/solargraph_test_coverage
+homepage: https://github.com/deepdivr/solargraph_test_coverage
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/ckolkey/solargraph_test_coverage
-  source_code_uri: https://github.com/ckolkey/solargraph_test_coverage
-  changelog_uri: https://github.com/ckolkey/solargraph_test_coverage
+  homepage_uri: https://github.com/deepdivr/solargraph_test_coverage
+  source_code_uri: https://github.com/deepdivr/solargraph_test_coverage
+  changelog_uri: https://github.com/deepdivr/solargraph_test_coverage
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -87,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="