oneshot_coverage 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b39908101b69a0d652f8219df289b541f44dd763586f938f714da7990aa801e
-  data.tar.gz: 9f71dd33954f1cc1e8e88f46a71cd99800f41afea57197851a9d4e46a9c98c49
+  metadata.gz: 074f86971202b3cb656203277d3032b669b36bd62fe6938633e57b0c50e6a151
+  data.tar.gz: 0c8660a5997eba0e6bb17b8b2c444bae52100c5bff099c90246637e9a9fb005d
 SHA512:
-  metadata.gz: cf5c1b77da9e902783c2d62b65fb20827b78e7601cf9322ee0ac2802444d08db108a793634ae50a4891e1bf5809acb9203cd22fe7ad29351717f8f92787be56d
-  data.tar.gz: 9bad05fb306ccdf11c4ef94e8838f2eb63d24f69444c614439d578a812f2fd8decea5d8e3882256750c17fe8ec9b07f3539385d1c6bb89b01488449f27933a52
+  metadata.gz: 6ce75ffbfe041e4f86b5e685fd0e7b8c2c5b58e7ece2095fc526243d129ec20d09a3c875e1a33cd5b779e10cf8b770ba936ae563c5cb3cc26b540d63bada3636
+  data.tar.gz: 977016fc11910a04de1d690a23bd6bb44a6bcf4e74ef2384b1d1aca01c1da784c95f8f97973781e52c142e4a27868bc6b431dd5495a3876521bb056556c33074

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0' ]
+    name: Test on Ruby ${{ matrix.ruby }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Execute test
+      run: bundle exec rake

data/.gitignore

@@ -41,6 +41,7 @@ Temporary Items
 /test/tmp/
 /test/version_tmp/
 /tmp/
+Gemfile.lock
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -93,3 +94,6 @@ build-iPhoneSimulator/
 /pkg/
 /spec/reports/
 /tmp/
+
+target_app/coverage.json
+target_app/coverage/

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.4.1
+
+- Add SimplecovReporter
+
+## 0.4.0
+
+- Provide options for checking bundle_path (#7)
+- Fix error when empty log file is exist (#4)

data/Gemfile

@@ -4,3 +4,8 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in oneshot_coverage.gemspec
 gemspec
+
+gem "rake", "~> 13.0"
+gem "bundler", "> 1.17"
+
+gem "minitest", "~> 5.0"

data/README.md

@@ -1,6 +1,6 @@
 # OneshotCoverage
 
-This gem may not be very useful when you want to use [Coverage onetshot mode](https://bugs.ruby-lang.org/issues/15022),
+This gem may not be very useful when you want to use [Coverage oneshot mode](https://bugs.ruby-lang.org/issues/15022),
 however, It could be good example to study how to implement by yourself.
 
 This gem provides simple tools to use oneshot mode easier. It gives you:
@@ -9,7 +9,7 @@ This gem provides simple tools to use oneshot mode easier. It gives you:
 - Pluggable logger interface
 
 Please notice that it records code executions under the target path(usually, project base path).
-If you have bundle gem path under target path, It will be ignored automatically.
+If you have bundle gem path under target path, It will be ignored by default.
 
 ## Installation
 
@@ -36,6 +36,7 @@ OneshotCoverage.configure(
   target_path: '/base/project/path',
   logger: OneshotCoverage::Logger::NullLogger.new,
   emit_term: nil, # emit per `emit_term` seconds. It tries to emit per request when `nil`.
+  cover_bundle_path: false, # record bundle gem path. Default value is false.
 )
 OneshotCoverage.start
 ```
@@ -98,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/Rakefile

@@ -1,2 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-task :default => :spec
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: %i[test]

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)
+    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
@@ -32,24 +39,28 @@ module OneshotCoverage
 
       if defined?(Bundler)
         @bundler_path = Bundler.bundle_path.to_s
+        @cover_bundle_path = cover_bundle_path
       end
     end
 
     def emit(force_emit)
       if !force_emit
         if !time_to_emit?
-          return true
+          return
         end
       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
 
-      @logger.post(logs)
+      if logs.size > 0
+        @logger.post(logs)
+      end
     end
 
     private
@@ -67,13 +78,29 @@ module OneshotCoverage
 
     def is_target?(filepath, value)
       return false if value[:oneshot_lines].empty?
+      return @cover_bundle_path if from_bundler?(filepath)
       return false if !filepath.start_with?(@target_path)
-      return false if @bundler_path && filepath.start_with?(@bundler_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)
-      filepath[@target_path.size..-1]
+      if filepath.include?(@target_path)
+        filepath[@target_path.size..-1]
+      else
+        filepath
+      end
     end
 
     def md5_hash_cache
@@ -104,17 +131,19 @@ module OneshotCoverage
     @reporter&.emit(force_emit)
   end
 
-  def configure(target_path:, logger: OneshotCoverage::Logger::NullLogger.new, emit_term: nil)
-    target_path_by_pathname =
-      if target_path.is_a? Pathname
-        target_path
-      else
-        Pathname.new(target_path)
-      end
+  def configure(
+    target_path:,
+    logger: OneshotCoverage::Logger::NullLogger.new,
+    coverage_module: Coverage,
+    emit_term: nil,
+    cover_bundle_path: false
+  )
     @reporter = OneshotCoverage::Reporter.new(
-      target_path: target_path_by_pathname.cleanpath.to_s + "/",
+      coverage_module: coverage_module,
+      target_path: Pathname.new(target_path).cleanpath.to_s + "/",
       logger: logger,
       emit_term: emit_term,
+      cover_bundle_path: cover_bundle_path
     )
   end
 end

data/lib/oneshot_coverage/logger/file_logger.rb

@@ -22,7 +22,7 @@ module OneshotCoverage
       private
 
       def fetch
-        JSON.load(File.read(@log_path))
+        JSON.load(File.read(@log_path)) || {}
       rescue Errno::ENOENT
         {}
       end

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.3.0"
+  VERSION = "0.4.1"
 end

data/oneshot_coverage.gemspec

@@ -36,7 +36,4 @@ Gem::Specification.new do |spec|
 
   # Release ruby version lock temperary
   # spec.required_ruby_version = '>= 2.6'
-
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
 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,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oneshot_coverage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Shia
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+date: 2021-07-14 00:00:00.000000000 Z
+dependencies: []
 description: OneshotCoverage will help you to measure oneshot coverage on production
 email:
 - rise.shia@gmail.com
@@ -45,10 +17,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -59,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
@@ -68,7 +47,7 @@ metadata:
   homepage_uri: https://github.com/riseshia/oneshot_coverage
   source_code_uri: https://github.com/riseshia/oneshot_coverage
   changelog_uri: https://github.com/riseshia/oneshot_coverage
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Simple toolbox for oneshot coverage
 test_files: []

data/Gemfile.lock

@@ -1,20 +0,0 @@
-PATH
-  remote: .
-  specs:
-    oneshot_coverage (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    rake (10.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  oneshot_coverage!
-  rake (~> 10.0)
-
-BUNDLED WITH
-   1.17.2