oneshot_cov 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe615da2b6ef69eccd7249e4db9c3c45d9a83f2c113b97890d1630a45cdf2dfe
-  data.tar.gz: 6388ee9eca25bece1e30fa9502baa71883075f0ff418c256c3b7e94016934a21
+  metadata.gz: 69b518feccec2167f23f4966fa6555025c439117b07004ca96292796b206397a
+  data.tar.gz: 155e225c25569b761bc8863f459177ddcf58eda2abe266db1da460014cb5649c
 SHA512:
-  metadata.gz: '06289b3542f6a08fdbac3bcdbd58535a4d58380a11a05ff501e1117a1187b4e0e28494bf834d082a68ea3876fe7ba35cfe8a85c0fd9b50b6259386b2b4333fc7'
-  data.tar.gz: f64275609de0feae4b88e7f12e160f8ef76bdbf11c0e3c81d3aa9f68f60f6338805cd2ceea0c2be281f02377d8f21662d0045bddc341103e8cf34c035f28533e
+  metadata.gz: 84e8913cf76ca73cd6f2624bca634892fbb626b57549b7eab3ed555c4e13098ea7b5b4867cb6815cac585991c6012436511cdad596daf6b799f46426f8680eb2
+  data.tar.gz: a8d6da794ebbb580ec28cf6822d465965a2d4ae0b227b1078eda758028969b3139dbf40158a4cc5d4a59ce45fbc599b9a8176c4d20da5d9079acdade685959fc

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    oneshot_cov (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  oneshot_cov!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -22,7 +22,60 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a configuration file to run `OneshotCov.configure` and` OneshotCov.start`
+The logger sample will be described later.
+
+```ruby:config/initializers/oneshot_cov.rb
+logger = Rails.application.config.oneshot_cov_logger
+
+OneshotCov.configure(
+  logger: OneshotCov::Logger::LineByLineLogger.new(logger),
+  emit_term: 600,
+)
+OneshotCov.start
+```
+
+### Sample loggers
+
+* LineByLineLogger(logger)
+
+The logger passed to the argument is set in the application config
+please
+
+```ruby:config/application.rb
+config.oneshot_cov_logger = Logger.new(Rails.root.join('log/oneshot_cov.log'))
+config.oneshot_cov_logger.formatter = proc { |_, _, _, msg| "#{msg}\n" }
+```
+
+```
+app/controllers/users/user?controller.rb: 2
+app/controllers/users/user?controller.rb: 3
+app/controllers/users/user?controller.rb: 4
+```
+
+* EachFileLogger(logger)
+
+The logger passed to the argument is set in the application config
+please
+
+```ruby:config/application.rb
+config.oneshot_cov_logger = Logger.new(Rails.root.join('log/oneshot_cov.log'))
+config.oneshot_cov_logger.formatter = proc { |_, _, _, msg| "#{msg}\n" }
+```
+
+```ruby:config/initializers/oneshot_cov.rb
+logger = Rails.application.config.oneshot_cov_logger
+
+OneshotCov.configure(
+  logger: OneshotCov::Logger::EachFileLogger.new(logger),
+  emit_term: 600,
+)
+OneshotCov.start
+```
+
+```
+app/controllers/users/user?controller.rb: 2,3,4
+```
 
 ## Development
 

data/lib/oneshot_cov.rb

@@ -1,6 +1,8 @@
 require "coverage"
 
-require "oneshot_cov/logger"
+require "oneshot_cov/logger/line_by_line_logger"
+require "oneshot_cov/logger/replace_logger"
+require "oneshot_cov/logger/each_file_logger"
 require "oneshot_cov/middleware"
 require "oneshot_cov/reporter"
 require "oneshot_cov/railtie" if defined?(Rails)
@@ -18,11 +20,14 @@ module OneshotCov
   end
 
   def emit(force_emit: false)
-    OneshotCov.configure if @reporter.nil?
     @reporter.emit(force_emit)
   end
 
-  def configure(target_path: Rails.root, logger: OneshotCov::Logger.new('log/oneshot_cov.log'), emit_term: nil)
+  def configure(target_path: Rails.root, logger: nil, emit_term: nil)
+    if logger.nil?
+      raise ArgumentError.new("Specifying logger in `OneshotCov.configure` is mandatory`")
+    end
+
     target_path_by_pathname =
       if target_path.is_a? Pathname
         target_path

data/lib/oneshot_cov/logger/each_file_logger.rb

@@ -0,0 +1,18 @@
+module OneshotCov
+  module Logger
+    class EachFileLogger
+      def initialize(logger)
+        @logger = logger
+      end
+ 
+      def post(new_logs)
+        new_logs.each do |new_log|
+          log_path = new_log.path
+          lines = new_log.lines.join(",")
+
+          @logger.info("#{log_path}: #{lines}")
+        end
+      end
+    end
+  end
+end 

data/lib/oneshot_cov/logger/line_by_line_logger.rb

@@ -0,0 +1,20 @@
+module OneshotCov
+  module Logger
+    class LineByLineLogger
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def post(new_logs)
+        new_logs.each do |new_log|
+          log_path = new_log.path
+          oneshot_lines = new_log.lines
+
+          oneshot_lines.each do |line|
+            @logger.info("#{log_path}: #{line}")
+          end
+        end
+      end
+    end
+  end
+end 

data/lib/oneshot_cov/logger/replace_logger.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module OneshotCov
+  module Logger
+    class ReplaceLogger
+      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}"
+
+          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_cov/reporter.rb

@@ -27,7 +27,7 @@ module OneshotCov
         Coverage.result(clear: true, stop: false).
         select { |k, v| is_target?(k, v) }.
         map do |filepath, v|
-          OneshotLog.new(relative_path(filepath), v)
+          OneshotLog.new(relative_path(filepath), v[:oneshot_lines])
         end
 
       if logs.size > 0
@@ -49,7 +49,7 @@ module OneshotCov
     end
 
     def is_target?(filepath, value)
-      return false if value.empty?
+      return false if value[:oneshot_lines].empty?
       return false if !filepath.start_with?(@target_path)
       return false if @bundler_path && filepath.start_with?(@bundler_path)
       true

data/lib/oneshot_cov/version.rb

@@ -1,3 +1,3 @@
 module OneshotCov
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneshot_cov
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - soartec-lab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,13 +64,16 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/oneshot_cov.rb
-- lib/oneshot_cov/logger.rb
+- lib/oneshot_cov/logger/each_file_logger.rb
+- lib/oneshot_cov/logger/line_by_line_logger.rb
+- lib/oneshot_cov/logger/replace_logger.rb
 - lib/oneshot_cov/middleware.rb
 - lib/oneshot_cov/railtie.rb
 - lib/oneshot_cov/reporter.rb

data/lib/oneshot_cov/logger.rb

@@ -1,33 +0,0 @@
-require 'json'
-
-module OneshotCov
-  class Logger
-    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}"
-
-        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