solargraph_test_coverage 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17b226826380f6ebff660ad770a654eba615c2dcb6070f15ec1ba65c31b2d68b
+  data.tar.gz: cfc0da7a98ffbcebaa9e567d513fe60e64f6a084cc8cb00f254c5ab242f33e20
+SHA512:
+  metadata.gz: 4f67f75212d3291c8c5201633d5847f28b30a731f4e90cf4a341a4a83701cc9a6c9c4c58a8530769d9d1bb41123c0e8fc4df9c7f4f006d50a60b0f16068dd39f
+  data.tar.gz: 47a3455b307c0144c0ff5f2ff440aef688002978ab6db7fa48804a49db833721d9d9a6b03ae362aaf67b537b137676380642eea70eaea94e32c2d9b66bedbbe2

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    solargraph_test_coverage (0.1.1)
+      rspec-core (~> 3.10, >= 3.10.0)
+      solargraph (~> 0.40, > 0.40)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.1.1)
+    diff-lcs (1.4.4)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    nokogiri (1.12.3-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    regexp_parser (2.1.1)
+    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)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    solargraph (0.43.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.1.0)
+    tilt (2.0.10)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rake (~> 12.0)
+  solargraph_test_coverage!
+
+BUNDLED WITH
+   2.2.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Cameron
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# SolargraphTestCoverage
+
+Solargraph Plugin that provides a diagnostic reporter for unit-test coverage.
+
+Currently only works with RSpec. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solargraph_test_coverage'
+```
+
+Then add this to your `.solargraph.yml` config:
+```yaml
+plugins:
+  - solargraph_test_coverage
+reporters:
+  - test_coverage
+```
+
+If you are using a `spec/rails_helper.rb` file, you will need to change:
+```ruby
+require "spec_helper"
+```
+
+to
+
+```ruby
+require_relative "spec_helper"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install solargraph_test_coverage
+
+## 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)
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ckolkey/solargraph_test_coverage.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/solargraph_test_coverage/branch.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+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
+
+          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
+        end
+      end
+    end
+
+    attr_reader :start_line, :end_line, :coverage, :type
+
+    def initialize(start_line:, end_line:, coverage:, inline:, type:)
+      @start_line = start_line
+      @end_line   = end_line
+      @coverage   = coverage
+      @inline     = inline
+      @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
+  end
+end

data/lib/solargraph_test_coverage/fork_process.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  # https://stackoverflow.com/questions/1076257/returning-data-from-forked-processes
+  # 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
+
+      pid = fork do
+        read.close
+        result = yield
+        Marshal.dump(result, write)
+        exit!(0) # skips exit handlers.
+      end
+
+      write.close
+      result = read.read
+      Process.wait(pid)
+      raise ChildFailedError if result.nil? || result.empty?
+
+      Marshal.load(result)
+    end
+  end
+end

data/lib/solargraph_test_coverage/helpers.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module SolargraphTestCoverage
+  module Helpers
+    #
+    # Attempts to find the corrosponding unit test file
+    # TODO: This could be a bit more robust, supporting gems (/lib/) and
+    #       minitest (/test/)
+    #
+    # @return [String]
+    #
+    def locate_test_file(source)
+      source.location.filename.sub('/app/', '/spec/').sub('.rb', '_spec.rb')
+    end
+
+    #
+    # Runs RSpec on test file in a child process
+    # 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)
+      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 })
+      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 == 0 }
+             .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
+
+    #
+    # 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.
+    #
+    # 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 :)
+    #
+    def self.preload_rails!
+      return if defined?(Rails)
+      return unless File.file?('spec/rails_helper.rb')
+
+      require File.expand_path("spec/rails_helper")
+      Coverage.result(stop: true, clear: true) if Coverage.running?
+    rescue LoadError => e
+      Solargraph::Logging.logger.warn "LoadError when trying to require 'rails_helper'"
+      Solargraph::Logging.logger.warn "[#{e.class}] #{e.message}"
+    end
+  end
+end

data/lib/solargraph_test_coverage/test_coverage_reporter.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# test_coverage reporter for Solargraph
+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)]
+
+      lines + branches + status
+    rescue ChildFailedError
+      []
+    end
+
+    private
+
+    #
+    # Creates LSP warning message for missing line coverage
+    #
+    # @return [Hash]
+    #
+    def line_coverage_warning(source, line)
+      {
+        range: Solargraph::Range.from_to(line, 0, line, source.code.lines[line].length).to_hash,
+        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
+    #
+    # @return [Hash]
+    #
+    def branch_coverage_warning(source, report)
+      {
+        range: Solargraph::Range.from_to(report[:line] - 1, 0, report[:line] - 1, source.code.lines[report[:line] - 1].length).to_hash,
+        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
+    #
+    # @return [Hash]
+    #
+    def test_failing_error(source)
+      {
+        range: Solargraph::Range.from_to(0, 0, 0, source.code.lines[0].length).to_hash,
+        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 no_test_file_error(source, test_file_location)
+      {
+        range: Solargraph::Range.from_to(0, 0, 0, source.code.lines[0].length).to_hash,
+        severity: Solargraph::Diagnostics::Severities::ERROR,
+        source: 'TestCoverage',
+        message: "No unit test file found at #{test_file_location}"
+      }
+    end
+  end
+end

data/lib/solargraph_test_coverage/version.rb

@@ -0,0 +1,3 @@
+module SolargraphTestCoverage
+  VERSION = "0.1.1"
+end

data/lib/solargraph_test_coverage.rb

@@ -0,0 +1,25 @@
+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/test_coverage_reporter'
+
+require 'solargraph'
+require 'rspec/core'
+require 'coverage'
+require 'pry-byebug'
+
+# 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!
+
+  Solargraph::Diagnostics.register 'test_coverage', TestCoverageReporter
+end

data/solargraph_test_coverage.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/solargraph_test_coverage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'solargraph_test_coverage'
+  spec.version       = SolargraphTestCoverage::VERSION
+  spec.authors       = ['Cameron Kolkey']
+  spec.email         = ['Cameron.Kolkey@gmail.com']
+
+  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.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: solargraph_test_coverage
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Cameron Kolkey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/solargraph_test_coverage.rb
+- lib/solargraph_test_coverage/branch.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/version.rb
+- solargraph_test_coverage.gemspec
+homepage: https://github.com/ckolkey/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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Solargraph Plugin
+test_files: []