oneshot_coverage 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 293537ff9297d5f5aa840aee43fcc4f80e01f6f386117211887be7f643b3c311
-  data.tar.gz: 05d17ad02efabffa178b7ca1f414bdfe131b3f4a28c62d272359f4bcf3f8e4dc
+  metadata.gz: 074f86971202b3cb656203277d3032b669b36bd62fe6938633e57b0c50e6a151
+  data.tar.gz: 0c8660a5997eba0e6bb17b8b2c444bae52100c5bff099c90246637e9a9fb005d
 SHA512:
-  metadata.gz: 555c67956799e0fd4284360938c64d41c3aea1b829306ef2e5d0a7308134694ccaa3250e591dd953ab8e816f4f62dcb53e49ddc120777ce92239ea1f47f4369a
-  data.tar.gz: fe81e8fc2256a7b1792eb13719f6958a1a67198ed4082cf1f2821cf7f19f3f5f17875620b7aa6446ced775b0956806e38823faa599655f787e5f47c5ba724f35
+  metadata.gz: 6ce75ffbfe041e4f86b5e685fd0e7b8c2c5b58e7ece2095fc526243d129ec20d09a3c875e1a33cd5b779e10cf8b770ba936ae563c5cb3cc26b540d63bada3636
+  data.tar.gz: 977016fc11910a04de1d690a23bd6bb44a6bcf4e74ef2384b1d1aca01c1da784c95f8f97973781e52c142e4a27868bc6b431dd5495a3876521bb056556c33074

data/.gitignore

@@ -94,3 +94,6 @@ build-iPhoneSimulator/
 /pkg/
 /spec/reports/
 /tmp/
+
+target_app/coverage.json
+target_app/coverage/

data/{CHANGELOG → CHANGELOG.md}

@@ -1,3 +1,7 @@
+## 0.4.1
+
+- Add SimplecovReporter
+
 ## 0.4.0
 
 - Provide options for checking bundle_path (#7)

data/README.md

@@ -99,6 +99,28 @@ to emit via `at_exit`.
 On the other hand, it's not, then you need to emit it manually
 at proper timing(i.e. when batch finished)
 
+### Generate report with simplecov
+
+You can generate pretty report using simplecov(confirmed with 0.21.2). Here is some example:
+
+```ruby
+require 'simplecov'
+require 'oneshot_coverage/simplecov_reporter'
+
+OneshotCoverage::SimplecovReporter.new(
+  project_path: Dir.pwd, # target project path. Dir.pwd is default.
+  log_path: 'coverage.json', # oneshot coverage log generated by FileLogger or same scheme json file acceptable
+  file_filter: OneshotCoverage::SimplecovReporter::DefaultFilter # Object respond to #call with return true | false. this filter used for coverage target. file_filter.call(path) return false, then path will not be included to report. DefaultFilter is default, which exclude non-ruby file, files under /spec/, /test/, /script/, /config/
+).run
+```
+
+This code generates html report under 'project_path/`coverage/`'
+
+### Note
+
+Note that `cover_bundle_path` only cover managed gem by bundler.
+In the other words, the gem installed with `path` option, which bundler just load it, will not be included by this.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/oneshot_coverage.rb

@@ -22,7 +22,14 @@ module OneshotCoverage
   OneshotLog = Struct.new(:path, :md5_hash, :lines)
 
   class Reporter
-    def initialize(target_path:, logger:, emit_term: nil, cover_bundle_path: false)
+    def initialize(
+      coverage_module:,
+      target_path:,
+      logger:,
+      emit_term: nil,
+      cover_bundle_path: false
+    )
+      @coverage_module = coverage_module
       @target_path = target_path
       @logger = logger
       @emit_term = emit_term
@@ -44,10 +51,11 @@ module OneshotCoverage
       end
 
       logs =
-        Coverage.result(clear: true, stop: false).
+        @coverage_module.result(clear: true, stop: false).
         select { |k, v| is_target?(k, v) }.
         map do |filepath, v|
-          OneshotLog.new(relative_path(filepath), md5_hash_for(filepath), v[:oneshot_lines])
+          formatted_path = format_filepath(filepath)
+          OneshotLog.new(format_filepath(filepath), md5_hash_for(filepath), v[:oneshot_lines])
         end
 
       if logs.size > 0
@@ -70,11 +78,23 @@ module OneshotCoverage
 
     def is_target?(filepath, value)
       return false if value[:oneshot_lines].empty?
-      return @cover_bundle_path if @bundler_path && filepath.start_with?(@bundler_path)
+      return @cover_bundle_path if from_bundler?(filepath)
       return false if !filepath.start_with?(@target_path)
       true
     end
 
+    def from_bundler?(filepath)
+      @bundler_path && filepath.start_with?(@bundler_path)
+    end
+
+    def format_filepath(filepath)
+      if from_bundler?(filepath)
+        filepath
+      else
+        relative_path(filepath)
+      end
+    end
+
     def relative_path(filepath)
       if filepath.include?(@target_path)
         filepath[@target_path.size..-1]
@@ -111,8 +131,15 @@ module OneshotCoverage
     @reporter&.emit(force_emit)
   end
 
-  def configure(target_path:, logger: OneshotCoverage::Logger::NullLogger.new, emit_term: nil, cover_bundle_path: false)
+  def configure(
+    target_path:,
+    logger: OneshotCoverage::Logger::NullLogger.new,
+    coverage_module: Coverage,
+    emit_term: nil,
+    cover_bundle_path: false
+  )
     @reporter = OneshotCoverage::Reporter.new(
+      coverage_module: coverage_module,
       target_path: Pathname.new(target_path).cleanpath.to_s + "/",
       logger: logger,
       emit_term: emit_term,

data/lib/oneshot_coverage/simplecov_reporter.rb

@@ -0,0 +1,95 @@
+require 'coverage'
+require 'find'
+require 'json'
+
+module OneshotCoverage
+  class SimplecovReporter
+    module DefaultFilter
+      module_function def call(path)
+        return false unless File.extname(path) == '.rb'
+        return false if path.include?('/spec/')
+        return false if path.include?('/test/')
+        return false if path.include?('/script/')
+        return false if path.include?('/config/')
+
+        true
+      end
+    end
+
+    # @option log_path [String] oneshot coverage log generated by FileLogger or same scheme json file acceptable
+    # @option project_path [String] target project path.
+    # @option file_filter [Object] Object respond to #call with return true | false. this filter used for coverage target. file_filter.call(path) return false, then path will not be included to report
+    def initialize(
+      log_path:,
+      project_path: Dir.pwd,
+      file_filter: DefaultFilter
+    )
+      @project_path = project_path.end_with?('/') ? project_path : "#{project_path}/"
+      @log_path = log_path
+      @file_filter = file_filter
+    end
+
+    def run
+      raise "Please install & require 'simplecov' if you want to use this" unless defined? SimpleCov
+
+      coverages = coverage_stubs
+      fill_lines(coverages)
+      gen_html(coverages)
+    end
+
+    private
+
+    def coverage_candidates
+      @coverage_candidates ||=
+        Find.find(@project_path).
+          select { |fp| @file_filter.call(fp) }
+          # map { |fp| fp.sub(@project_path, '') }
+    end
+
+    def coverage_stubs
+      {}.tap do |stubs|
+        coverage_candidates.each do |filepath|
+          stub = Coverage.line_stub(filepath)
+          stubs[filepath] = stub
+        end
+      end
+    end
+
+    def oneshot_coverage_logs
+      @oneshot_coverage_logs ||= begin
+        raise "#{@log_path} isn't exist!" unless File.exist?(@log_path)
+
+        JSON.parse(File.read(@log_path)).transform_keys do |filepath_with_md5_hash|
+          *path_tokens, _md5_hash = filepath_with_md5_hash.split('-')
+          "#{@project_path}#{path_tokens.join('-')}"
+        end
+      end
+    end
+
+    def fill_lines(coverages)
+      oneshot_coverage_logs.each do |filepath, linenums|
+        linenums.each do |linenum|
+          coverages[filepath][linenum - 1] = 1
+        end
+      end
+    end
+
+    def format_data(coverages)
+      coverages.transform_values do |lines|
+        { "lines" => lines }
+      end
+    end
+
+    def gen_html(coverages)
+      coverages_for_simcov = format_data(coverages)
+      SimpleCov.root(@project_path)
+      result = SimpleCov::Result.from_hash({
+        'oneshot' => {
+          'coverage' => coverages_for_simcov,
+          'timestamp' => Time.now.to_i
+        }
+      }).first
+      SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    end
+  end
+end

data/lib/oneshot_coverage/version.rb

@@ -1,3 +1,3 @@
 module OneshotCoverage
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/target_app/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "minitest"
+gem "simplecov"

data/target_app/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.4.0)
+    minitest (5.14.4)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  minitest
+  simplecov
+
+BUNDLED WITH
+   2.2.3

data/target_app/adder.rb

@@ -0,0 +1,10 @@
+class Adder
+  def initialize(a, b)
+    @a = a
+    @b = b
+  end
+
+  def call
+    @a + @b
+  end
+end

data/target_app/cover_code_test.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "oneshot_coverage"
+require "oneshot_coverage/logger/file_logger"
+
+OneshotCoverage.configure(
+  target_path: Dir.pwd,
+  logger: OneshotCoverage::Logger::FileLogger.new('coverage.json'),
+  emit_term: nil,
+  cover_bundle_path: ENV["COVER_BUNDLE_PATH"] == "1",
+)
+
+OneshotCoverage.start
+
+require "minitest"
+require_relative "adder"
+
+Adder.new(1, 2).call

data/target_app/gen_simplecov_report.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require 'simplecov'
+require 'oneshot_coverage/simplecov_reporter'
+
+OneshotCoverage::SimplecovReporter.new(
+  project_path: Dir.pwd,
+  log_path: 'coverage.json',
+  file_filter: OneshotCoverage::SimplecovReporter::DefaultFilter
+).run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneshot_coverage
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Shia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies: []
 description: OneshotCoverage will help you to measure oneshot coverage on production
 email:
@@ -19,7 +19,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
-- CHANGELOG
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -32,8 +32,14 @@ files:
 - lib/oneshot_coverage/logger/null_logger.rb
 - lib/oneshot_coverage/logger/stdout_logger.rb
 - lib/oneshot_coverage/railtie.rb
+- lib/oneshot_coverage/simplecov_reporter.rb
 - lib/oneshot_coverage/version.rb
 - oneshot_coverage.gemspec
+- target_app/Gemfile
+- target_app/Gemfile.lock
+- target_app/adder.rb
+- target_app/cover_code_test.rb
+- target_app/gen_simplecov_report.rb
 homepage: https://github.com/riseshia/oneshot_coverage
 licenses:
 - MIT