oneshot_coverage 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d60a116028cbd90801d1a0883c3bedbdd497c591458f91f9a8e285adf2d85100
-  data.tar.gz: e5e04c825c36bab7e1405920a9b159d034152f8367fdc6432028269ec494ce0a
+  metadata.gz: 2b39908101b69a0d652f8219df289b541f44dd763586f938f714da7990aa801e
+  data.tar.gz: 9f71dd33954f1cc1e8e88f46a71cd99800f41afea57197851a9d4e46a9c98c49
 SHA512:
-  metadata.gz: cab0f5ece8e3d3c258c3524af5f5ea16d60ff8dcab2f64cc9c7b109008420f29be4fda94c2ac64433b25229966a804a975464134c345bdb19b2c81d4a974d319
-  data.tar.gz: 6d95ce0b3b5fc2d40cca0827e12805f125ed9d3c168b6a1ce467e021c8627dd1d86f7f006adc845e21fc3c993de58be75da8eb6f78e7e39af23059e31e10405d
+  metadata.gz: cf5c1b77da9e902783c2d62b65fb20827b78e7601cf9322ee0ac2802444d08db108a793634ae50a4891e1bf5809acb9203cd22fe7ad29351717f8f92787be56d
+  data.tar.gz: 9bad05fb306ccdf11c4ef94e8838f2eb63d24f69444c614439d578a812f2fd8decea5d8e3882256750c17fe8ec9b07f3539385d1c6bb89b01488449f27933a52

data/README.md

@@ -35,7 +35,7 @@ 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`.
 )
 OneshotCoverage.start
 ```
@@ -44,25 +44,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/lib/oneshot_coverage.rb

@@ -19,29 +19,50 @@ 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)
       @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
       end
     end
 
-    def emit
-      Coverage.result(clear: true, stop: false).
+    def emit(force_emit)
+      if !force_emit
+        if !time_to_emit?
+          return true
+        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
+
+      @logger.post(logs)
+    end
 
-      @buffer.shift(emit_at_once).each do |row|
-        # Retry when fail to post
-        unless @logger.post(row)
-          @buffer << row
+    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)
@@ -51,30 +72,20 @@ module OneshotCoverage
       true
     end
 
-    def transform(filepath, value)
-      rel_path = filepath[@target_path.size..-1]
-      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_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,15 +96,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_at_once: 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
@@ -103,7 +114,7 @@ module OneshotCoverage
     @reporter = OneshotCoverage::Reporter.new(
       target_path: target_path_by_pathname.cleanpath.to_s + "/",
       logger: logger,
-      max_emit_at_once: max_emit_at_once
+      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/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.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneshot_coverage
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Shia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2019-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +55,7 @@ files:
 - 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