oneshot_coverage 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 031ca916bcee96033586ba0e1c6f7a93129b8b758a1c297c9555d9de91bb14af
-  data.tar.gz: 0dd69d9959a49fc94518926d498cb3350ec1d952de2887853fa09b0497011c2d
+  metadata.gz: d6573e60b68c3d682f2199237df98af49b7d9bd79ff7d117bf6edc07a773b15b
+  data.tar.gz: 0ccbec0f4e0bdfc3a807caf80be8080fb3e26ace5b261751c71d893190c4fa05
 SHA512:
-  metadata.gz: 548640eb62924ec9d465fa6521c57fdf9cf1b2e63075a171bb24128d3dfbf8793e5f0165dd233ab898e7a9f7c63af431591eac5645fb1ed574d5a7dc26b7584a
-  data.tar.gz: 1017152226c61dd4e2d588f59c62cd2a9a6b4f9a126dece207b27e0fc11281b164cd7456b7a12a6146464092d2d58966d417d40f1910536c5a817b6cdf4bd25d
+  metadata.gz: c8003ea1b0a4c6f5b7c23e0f250735085feabbf0cf1ac61c1f82872d7ae5528ed596506ba343ea9f812e2ea63e1032cdef33c5e903319179880d1fca2bd5e617
+  data.tar.gz: 460dab03da64b57a86986e143520dc4521ac2ebd4457d4acb23ca59cff129c66c8ed856293609ff3310d54a0b47ff658da3cc47fb1d09d86f66b8bd5569586cf

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/README.md

@@ -35,6 +35,7 @@ Or install it yourself as:
 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`.
 )
 OneshotCoverage.start
 ```
@@ -43,18 +44,40 @@ 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
 ```

data/lib/oneshot_coverage.rb

@@ -19,24 +19,52 @@ module OneshotCoverage
     end
   end
 
+  OneshotLog = Struct.new(:path, :md5_hash, :lines)
+
   class Reporter
-    def initialize(target_path:, logger:, max_emit_per_request:)
+    def initialize(target_path:, logger:, emit_term: nil)
       @target_path = target_path
       @logger = logger
-      @buffer = []
-      @max_emit_per_request = max_emit_per_request
+      @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
       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
 
-      @buffer.shift(emit_per_request).each { |row| @logger.post(row) }
+      if logs.size > 0
+        @logger.post(logs)
+      end
+    end
+
+    private
+
+    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)
@@ -46,30 +74,20 @@ module OneshotCoverage
       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
-        }
-      end
+    def relative_path(filepath)
+      filepath[@target_path.size..-1]
     end
 
     def md5_hash_cache
       @md5_hash_cache ||= {}
     end
 
-    def emit_per_request
-      @max_emit_per_request || @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
 
@@ -80,15 +98,15 @@ 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_per_request: nil)
+  def configure(target_path:, logger: OneshotCoverage::Logger::NullLogger.new, emit_term: nil)
     target_path_by_pathname =
       if target_path.is_a? Pathname
         target_path
@@ -98,7 +116,7 @@ module OneshotCoverage
     @reporter = OneshotCoverage::Reporter.new(
       target_path: target_path_by_pathname.cleanpath.to_s + "/",
       logger: logger,
-      max_emit_per_request: max_emit_per_request
+      emit_term: emit_term,
     )
   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/stdout_logger.rb

@@ -1,10 +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}"
-        )
+      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.0"
+  VERSION = "0.3.2"
 end

data/oneshot_coverage.gemspec

@@ -37,6 +37,6 @@ 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"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneshot_coverage
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Shia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: OneshotCoverage will help you to measure oneshot coverage on production
 email:
 - rise.shia@gmail.com
@@ -48,13 +48,13 @@ files:
 - ".gitignore"
 - 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
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple toolbox for oneshot coverage

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