cover_rage 0.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bea62a74d8c6c9e2bbcd7918e28a2ee43f71f0548b43d4813438a02a3bffa32
-  data.tar.gz: 47c5ef4df517fd22406db7dd4b93b10089a2d2b08bccd7a24b0e2ae23c76e55c
+  metadata.gz: 2d22a15a12e4376aa1a441dd5f4d21e7a6043390e1cef64e8739da1e6fcb81eb
+  data.tar.gz: ec07f2d32071bce21d03771e3d3ba3c6dd24e0e1cae745962fe0a36b89bc00ef
 SHA512:
-  metadata.gz: d4fecf3fc7435ba7e96b171e864d2463d7256c4c2f987546c3d10ea13543da59e779530a38094dd45bde32aba6cefc9c4663ebdd0df52b0a178d4ca318c4b658
-  data.tar.gz: f91e8dce7f3770d31547899baa4e5add2641af32596568b83bfc76525b1a44b82faa51064debc420c24535572dd9e89372a77f487054de15aea3b17a2d7043c7
+  metadata.gz: 16754fdef9cc29c0f6304e56a6f0c70dd91bc18c294bc944a7d3f927b642b07127acb079ecb9617156c3d0f703ec440536433f97b0f53d9742f6541d7df087cf
+  data.tar.gz: 94bddf50ab05b0f8227e42743910343b5f7c595c74774994bc60f5ecfc807dc1ec3f4bfcd5227ccb24a5207a2cfad77864077e934a986f91d4c8e254921cf359

data/lib/cover_rage/config.rb

@@ -3,13 +3,13 @@
 require 'uri'
 module CoverRage
   module Config
-    def self.root_path
-      @root_path ||= ENV.fetch('COVER_RAGE_ROOT_PATH', defined?(Rails) && Rails.root ? Rails.root.to_s : Dir.pwd)
+    def self.path_prefix
+      @path_prefix ||= ENV.fetch('COVER_RAGE_PATH_PREFIX', defined?(Rails) && Rails.root ? Rails.root.to_s : Dir.pwd)
     end
 
     def self.store
       @store ||= begin
-        uri = URI.parse(ENV.fetch('COVER_RAGE_STORE_URL'))
+        uri = URI.parse(ENV.fetch('COVER_RAGE_STORE_URL', "pstore:#{File.join(Dir.pwd, 'cover_rage.pstore')}"))
         case uri.scheme
         when 'redis', 'rediss'
           require 'cover_rage/stores/redis'
@@ -17,21 +17,17 @@ module CoverRage
         when 'sqlite'
           require 'cover_rage/stores/sqlite'
           CoverRage::Stores::Sqlite.new(uri.path)
+        when 'pstore'
+          require 'cover_rage/stores/pstore'
+          CoverRage::Stores::Pstore.new(uri.path)
+        else
+          raise "Unsupported store: #{uri.scheme}"
         end
       end
     end
 
-    def self.sleep_duration
-      @sleep_duration ||= begin
-        args =
-          ENV.fetch('COVER_RAGE_SLEEP_DURATION', '60:90').split(':').map!(&:to_i).first(2)
-        args.push(args.first.succ) if args.length < 2
-        Range.new(*args, true)
-      end
-    end
-
-    def self.disable?
-      @disable ||= ENV.key?('COVER_RAGE_DISABLE')
+    def self.interval
+      @interval ||= ENV.fetch('COVER_RAGE_INTERVAL', '60').to_i
     end
   end
 end

data/lib/cover_rage/fork_hook.rb

@@ -7,5 +7,12 @@ module CoverRage
       CoverRage::Launcher.start if pid.zero?
       pid
     end
+
+    def daemon(...)
+      CoverRage::Launcher.recorder.save(Coverage.result(stop: false))
+      returned = super
+      CoverRage::Launcher.start
+      returned
+    end
   end
 end

data/lib/cover_rage/launcher.rb

@@ -7,18 +7,17 @@ require 'coverage'
 
 module CoverRage
   class Launcher
+    singleton_class.attr_reader :recorder
+
     def self.start(**kwargs)
       if @recorder.nil?
         @recorder = CoverRage::Recorder.new(
           store: CoverRage::Config.store,
-          root_path: CoverRage::Config.root_path,
+          path_prefix: CoverRage::Config.path_prefix,
           **kwargs
         )
       end
       @recorder.start
-      return unless Process.respond_to?(:_fork)
-      return if Process.singleton_class < CoverRage::ForkHook
-
       Process.singleton_class.prepend(CoverRage::ForkHook)
     end
   end

data/lib/cover_rage/recorder.rb

@@ -6,13 +6,11 @@ require 'digest'
 
 module CoverRage
   class Recorder
-    SLEEP_DURATION = Config.sleep_duration
-    COVERAGE_STOP_STATES = %i[idle suspended].freeze
     attr_reader :store
 
-    def initialize(root_path:, store:)
+    def initialize(path_prefix:, store:)
       @store = store
-      @root_path = root_path.end_with?('/') ? root_path : "#{root_path}/"
+      @path_prefix = path_prefix.end_with?('/') ? path_prefix : "#{path_prefix}/"
       @digest = Digest::MD5.new
       @file_cache = {}
     end
@@ -20,27 +18,28 @@ module CoverRage
     def start
       return if @thread&.alive?
 
-      Coverage.start if COVERAGE_STOP_STATES.include?(Coverage.state)
+      unless Coverage.running?
+        Coverage.start
+        at_exit { save(Coverage.result) }
+      end
       @thread = Thread.new do
+        interval = Config.interval
+        jitter = 0.15
         loop do
-          sleep(rand(SLEEP_DURATION))
+          sleep(interval + rand * interval * jitter)
           save(Coverage.result(stop: false, clear: true))
         end
-      ensure
-        save(Coverage.result)
       end
     end
 
-    private
-
     def save(coverage_result)
       records = []
       coverage_result.map do |filepath, execution_count|
         filepath = File.expand_path(filepath) unless filepath.start_with?('/')
-        next unless filepath.start_with?(@root_path)
+        next unless filepath.start_with?(@path_prefix)
         next if execution_count.all? { _1.nil? || _1.zero? }
 
-        relative_path = filepath.delete_prefix(@root_path)
+        relative_path = filepath.delete_prefix(@path_prefix)
         revision, source = read_file_with_revision(filepath)
 
         records << Record.new(
@@ -53,6 +52,8 @@ module CoverRage
       @store.import(records) if records.any?
     end
 
+    private
+
     def read_file_with_revision(path)
       return @file_cache[path] if @file_cache.key?(path)
 

data/lib/cover_rage/stores/pstore.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'cover_rage/record'
+require 'pstore'
+
+module CoverRage
+  module Stores
+    class Pstore
+      def initialize(path)
+        @store = PStore.new(path, true)
+      end
+
+      def import(records)
+        @store.transaction do
+          persisted_records = @store.keys.map { @store[_1] }
+          records_to_save = Record.merge(persisted_records, records)
+          records_to_save.each { @store[_1.path] = _1 }
+        end
+      end
+
+      def find(path)
+        @store.transaction { @store[path] }
+      end
+
+      def list
+        @store.transaction do
+          @store.keys.map { @store[_1] }
+        end
+      end
+
+      def clear
+        @store.transaction do
+          @store.keys.each { @store.delete(_1) }
+        end
+      end
+    end
+  end
+end

data/lib/cover_rage/stores/redis.rb

@@ -22,13 +22,11 @@ module CoverRage
         loop do
           break if @redis.watch(KEY) do
             records_to_save = Record.merge(list, records)
-            if records_to_save.any?
-              arguments = []
-              records_to_save.each do |record|
-                arguments.push(record.path, JSON.dump(record.to_h))
-              end
-              @redis.multi { _1.hset(KEY, *arguments) }
+            arguments = []
+            records_to_save.each do |record|
+              arguments.push(record.path, JSON.dump(record.to_h))
             end
+            @redis.multi { _1.hset(KEY, *arguments) }
           end
         end
       end

data/lib/cover_rage/stores/sqlite.rb

@@ -17,27 +17,37 @@ module CoverRage
             execution_count text not null
           )
         SQL
+        process_ext = Module.new
+        process_ext.module_exec(self) do |store|
+          define_method :_fork do
+            store.instance_variable_get(:@db).close
+            pid = super()
+            store.instance_variable_set(:@db, SQLite3::Database.new(path))
+            pid
+          end
+        end
+        Process.singleton_class.prepend(process_ext)
       end
 
       def import(records)
-        @db.transaction do
+        @db.transaction(:exclusive) do
           records_to_save = Record.merge(list, records)
-          if records_to_save.any?
-            @db.execute(
-              "insert or replace into records (path, revision, source, execution_count) values #{
-                (['(?,?,?,?)'] * records_to_save.length).join(',')
-              }",
-              records_to_save.each_with_object([]) do |record, memo|
-                memo.push(
-                  record.path,
-                  record.revision,
-                  record.source,
-                  JSON.dump(record.execution_count)
-                )
-              end
-            )
-          end
+          @db.execute(
+            "insert or replace into records (path, revision, source, execution_count) values #{
+              (['(?,?,?,?)'] * records_to_save.length).join(',')
+            }",
+            records_to_save.each_with_object([]) do |record, memo|
+              memo.push(
+                record.path,
+                record.revision,
+                record.source,
+                JSON.dump(record.execution_count)
+              )
+            end
+          )
         end
+      rescue SQLite3::BusyException
+        retry
       end
 
       def find(path)
@@ -59,7 +69,7 @@ module CoverRage
       def list
         @db
           .execute('select path, revision, source, execution_count from records')
-          .map! do |(path, revision, source, execution_count)|
+          .map do |(path, revision, source, execution_count)|
             Record.new(
               path: path,
               revision: revision,

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: cover_rage
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Weihang Jian
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2024-12-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -25,25 +38,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.18'
+        version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.18'
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: |
-  A Ruby production code coverage tool designed to assist you in identifying unused code, offering the following features:
+  cover_rage is a Ruby code coverage tool designed to be simple and easy to use. It can be used not only for test coverage but also in production services to identify unused code.
+
+  Key features:
 
-  1. easy setup
-  2. minimal performance overhead
-  3. minimal external dependencies
+  1. Runs in continuous processes (e.g., Rails servers)
+  2. Zero dependencies
+  3. Supports forking and daemonization without additional setup
 email: tonytonyjan@gmail.com
 executables:
 - cover_rage
@@ -60,13 +89,13 @@ files:
 - lib/cover_rage/reporters/html_reporter.rb
 - lib/cover_rage/reporters/html_reporter/index.html.erb
 - lib/cover_rage/reporters/json_reporter.rb
+- lib/cover_rage/stores/pstore.rb
 - lib/cover_rage/stores/redis.rb
 - lib/cover_rage/stores/sqlite.rb
 homepage: https://github.com/tonytonyjan/cover_rage
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,15 +103,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
-summary: A Ruby production code coverage tool
+summary: cover_rage is a Ruby code coverage tool designed to be simple and easy to
+  use. It can be used not only for test coverage but also in production services to
+  identify unused code.
 test_files: []