oneshot_coverage 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f17a50188404018a1e6a33f0ab5c71ddddabe4ac2686d3089bd6fb4b4e690d5
-  data.tar.gz: c4a47f69c6fd77ab84a12b698fb1a725c4719a4451d3afdb95d40fbd99b35e39
+  metadata.gz: 293537ff9297d5f5aa840aee43fcc4f80e01f6f386117211887be7f643b3c311
+  data.tar.gz: 05d17ad02efabffa178b7ca1f414bdfe131b3f4a28c62d272359f4bcf3f8e4dc
 SHA512:
-  metadata.gz: 0c09df9d74e6e6975e41933653b6c7904097e54eccaf50d24a18b5dd3f047d18eee8c8bd503c59bfc1bc1bccebd8381e0375b4359882c79b9ef95fd54bca84c9
-  data.tar.gz: bcb475a7d9ef58378738c0bd93126ba3b5ba1edb183272bb8f624f492b16b03616d84faace863c05b212f24c1d1bf2b9631135496283675d47a25b786e777448
+  metadata.gz: 555c67956799e0fd4284360938c64d41c3aea1b829306ef2e5d0a7308134694ccaa3250e591dd953ab8e816f4f62dcb53e49ddc120777ce92239ea1f47f4369a
+  data.tar.gz: fe81e8fc2256a7b1792eb13719f6958a1a67198ed4082cf1f2821cf7f19f3f5f17875620b7aa6446ced775b0956806e38823faa599655f787e5f47c5ba724f35

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

data/CHANGELOG

@@ -0,0 +1,4 @@
+## 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
 
@@ -35,7 +35,8 @@ Or install it yourself as:
 OneshotCoverage.configure(
   target_path: '/base/project/path',
   logger: OneshotCoverage::Logger::NullLogger.new,
-  max_emit_at_once: nil, # Flush all when it set to `nil`, which is default
+  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
 ```
@@ -44,25 +45,44 @@ As default, OneshotCoverage supports 2 logger.
 
 - OneshotCoverage::Logger::NullLogger (default)
 - OneshotCoverage::Logger::StdoutLogger
+- OneshotCoverage::Logger::FileLogger
 
 Only required interface is `#post` instance method, so you could implement
 by yourself easily.
 
 ```ruby
-class SampleFluentLogger
-  def initialize
-    @logger = Fluent::Logger::FluentLogger.new('tag_prefix')
+class FileLogger
+  def initialize(log_path)
+    @log_path = log_path
   end
 
-  def post(path:, md5_hash:, lineno:)
-    @logger.post(nil, path: path, md5_hash: md5_hash, lineno: lineno)
+  # new_logs: Struct.new(:path, :md5_hash, :lines)
+  def post(new_logs)
+    current_coverage = fetch
+
+    new_logs.each do |new_log|
+      key = "#{new_log.path}-#{new_log.md5_hash}"
+
+      logged_lines = current_coverage.fetch(key, [])
+      current_coverage[key] = logged_lines | new_log.lines
+    end
+    save(current_coverage)
+  end
+
+  private
+
+  def fetch
+    JSON.load(File.read(@log_path))
+  rescue Errno::ENOENT
+    {}
+  end
+
+  def save(data)
+    File.write(@log_path, JSON.dump(data))
   end
 end
 ```
 
-Please note that it will retry to send data if `#post` returns falsy value.
-Hence, make sure to return `true` if you don't want to retry.
-
 ### Emit logs
 
 #### With rack application

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

@@ -19,53 +19,67 @@ module OneshotCoverage
     end
   end
 
+  OneshotLog = Struct.new(:path, :md5_hash, :lines)
+
   class Reporter
-    def initialize(target_path:, logger:, max_emit_at_once:)
+    def initialize(target_path:, logger:, emit_term: nil, cover_bundle_path: false)
       @target_path = target_path
       @logger = logger
-      @buffer = []
-      @max_emit_at_once = max_emit_at_once
+      @emit_term = emit_term
+      if @emit_term
+        @next_emit_time = Time.now.to_i + rand(@emit_term)
+      end
+
       if defined?(Bundler)
         @bundler_path = Bundler.bundle_path.to_s
+        @cover_bundle_path = cover_bundle_path
       end
     end
 
-    def emit
-      Coverage.result(clear: true, stop: false).
+    def emit(force_emit)
+      if !force_emit
+        if !time_to_emit?
+          return
+        end
+      end
+
+      logs =
+        Coverage.result(clear: true, stop: false).
         select { |k, v| is_target?(k, v) }.
-        flat_map { |k, v| transform(k, v) }.
-        each { |row| @buffer << row }
+        map do |filepath, v|
+          OneshotLog.new(relative_path(filepath), md5_hash_for(filepath), v[:oneshot_lines])
+        end
+
+      if logs.size > 0
+        @logger.post(logs)
+      end
+    end
+
+    private
 
-      @buffer.shift(emit_at_once).each do |row|
-        # Retry when fail to post
-        unless @logger.post(row)
-          @buffer << row
+    def time_to_emit?
+      if @emit_term
+        if @next_emit_time > Time.now.to_i
+          return false # Do not emit until next_emit_time
+        else
+          @next_emit_time += @emit_term
         end
       end
+      true
     end
 
     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 false if !filepath.start_with?(@target_path)
-      return false if @bundler_path && filepath.start_with?(@bundler_path)
       true
     end
 
-    def transform(filepath, value)
-      rel_path = filepath[@target_path.size..]
-      md5_hash =
-        if md5_hash_cache.key?(filepath)
-          md5_hash_cache[filepath]
-        else
-          md5_hash_cache[filepath] = Digest::MD5.file(filepath).hexdigest
-        end
-
-      value[:oneshot_lines].map do |line|
-        {
-          path: rel_path,
-          md5_hash: md5_hash,
-          lineno: line
-        }
+    def relative_path(filepath)
+      if filepath.include?(@target_path)
+        filepath[@target_path.size..-1]
+      else
+        filepath
       end
     end
 
@@ -73,8 +87,12 @@ module OneshotCoverage
       @md5_hash_cache ||= {}
     end
 
-    def emit_at_once
-      @max_emit_at_once || @buffer.size
+    def md5_hash_for(filepath)
+      if md5_hash_cache.key? filepath
+        md5_hash_cache[filepath]
+      else
+        md5_hash_cache[filepath] = Digest::MD5.file(filepath).hexdigest
+      end
     end
   end
 
@@ -85,25 +103,20 @@ module OneshotCoverage
 
     # To handle execution with exit immediatly
     at_exit do
-      OneshotCoverage.emit
+      OneshotCoverage.emit(force_emit: true)
     end
   end
 
-  def emit
-    @reporter&.emit
+  def emit(force_emit: false)
+    @reporter&.emit(force_emit)
   end
 
-  def configure(target_path:, logger: OneshotCoverage::Logger::NullLogger.new, max_emit_at_once: 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, emit_term: nil, cover_bundle_path: false)
     @reporter = OneshotCoverage::Reporter.new(
-      target_path: target_path_by_pathname.cleanpath.to_s + "/",
+      target_path: Pathname.new(target_path).cleanpath.to_s + "/",
       logger: logger,
-      max_emit_at_once: max_emit_at_once
+      emit_term: emit_term,
+      cover_bundle_path: cover_bundle_path
     )
   end
 end

data/lib/oneshot_coverage/logger/file_logger.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module OneshotCoverage
+  module Logger
+    class FileLogger
+      def initialize(log_path)
+        @log_path = log_path
+      end
+
+      def post(new_logs)
+        current_coverage = fetch
+
+        new_logs.each do |new_log|
+          key = "#{new_log.path}-#{new_log.md5_hash}"
+
+          logged_lines = current_coverage.fetch(key, [])
+          current_coverage[key] = logged_lines | new_log.lines
+        end
+        save(current_coverage)
+      end
+
+      private
+
+      def fetch
+        JSON.load(File.read(@log_path)) || {}
+      rescue Errno::ENOENT
+        {}
+      end
+
+      def save(data)
+        File.write(@log_path, JSON.dump(data))
+      end
+    end
+  end
+end

data/lib/oneshot_coverage/logger/null_logger.rb

@@ -3,7 +3,6 @@ module OneshotCoverage
     class NullLogger
       def post(_row)
         # Do nothing
-        true
       end
     end
   end

data/lib/oneshot_coverage/logger/stdout_logger.rb

@@ -1,11 +1,12 @@
 module OneshotCoverage
   module Logger
     class StdoutLogger
-      def post(path:, md5_hash:, lineno:)
-        $stdout.puts(
-          "[OneshotCoverage] logged path: #{path}, md5_hash: #{md5_hash}, lineno: #{lineno}"
-        )
-        true
+      def post(logs)
+        logs.each do |log|
+          $stdout.puts(
+            "[OneshotCoverage] logged path: #{log.path}, md5_hash: #{log.md5_hash}, executed_lines: #{log.lines}"
+          )
+        end
       end
     end
   end

data/lib/oneshot_coverage/version.rb

@@ -1,3 +1,3 @@
 module OneshotCoverage
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 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

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oneshot_coverage
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Shia
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-22 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-05 00:00:00.000000000 Z
+dependencies: []
 description: OneshotCoverage will help you to measure oneshot coverage on production
 email:
 - rise.shia@gmail.com
@@ -45,16 +17,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
+- CHANGELOG
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/oneshot_coverage.rb
+- lib/oneshot_coverage/logger/file_logger.rb
 - lib/oneshot_coverage/logger/null_logger.rb
 - lib/oneshot_coverage/logger/stdout_logger.rb
 - lib/oneshot_coverage/railtie.rb
@@ -67,7 +41,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
@@ -82,8 +56,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