gctime 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 005b9e06310decdc1c0fb6db3c4bd4a12eb1ef09f76d2ff3fb3bc95fda6ee470
-  data.tar.gz: 7df3592962b65d76c7c8dd4015e3918e1499a63ff7a878c84b57399778b18517
+  metadata.gz: 415713b61297b0808196eb07372db20deda2723a58c449ad2b9b9f5692a619c2
+  data.tar.gz: 7f0ffe0e2cc8f5472a5ddc4239bf5fb2eceb6d1a81a14088a00fc5b4546052b2
 SHA512:
-  metadata.gz: 10e639bbc964593d78fd0cd3a6e74acc634d38d110e7563d0f9d797229015dffa33f3412cde819a3703caf654f92241ebcf1a4a3cfecd3b3c1c99f1a73d0a679
-  data.tar.gz: 9a337cdebcb677659f4725ab67fb9d536167bd84ce2bb58a0a59021e70bd2f797ac7148dc674aa4d29b4852314a2ac7db89f1e634e13808dc1685121f305ef3e
+  metadata.gz: b92fba315640ddfdb3a3edded95fdf52886e0d546c32d8e985b1c8653fd598382eded803094271e7af3509a33e647c89ed36bf364bbfcd642e3317a7969eef75
+  data.tar.gz: 83521f8200beea897272f42b622dff0f54e335364ed9452aad3661ce2ed5640f2a551f76e92b222570e07aa06f266e3919a1e676c4865d1406c59422940e5d76

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ ruby-head, '3.0', '2.7', '2.6', '2.5', 'truffleruby' ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run test
+        run: rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gctime (0.1.0)
+    gctime (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +10,7 @@ GEM
     rake (13.0.6)
 
 PLATFORMS
+  ruby
   x86_64-darwin-20
 
 DEPENDENCIES

data/README.md

@@ -29,11 +29,13 @@ require 'gctime'
 >> 4.times { GC.start }
 => 4
 >> GCTime.total_time
-=> 0.12742100000000012
+=> 127.42100000000012 # ms
 >> GCTime.disable
 => nil
 ```
 
+`GCTime.total_time` returns a `Float` representing the total number of milliseconds spent in GC.
+
 ## Incompatibilities
 
 `CGTime` relies on the built-in [`GC::Profiler`](https://ruby-doc.org/core-3.0.0/GC/Profiler.html) which is a stateful datastructure. Which mean any other gem or application code using it
@@ -43,6 +45,8 @@ Known incompatible gems are:
 
   - [`newrelic_rpm`](https://github.com/newrelic/newrelic-ruby-agent/blob/4baffe79b87e6ec725dfae9f5e76113a1f1d01ba/lib/new_relic/agent/vm/monotonic_gc_profiler.rb#L22-L38)
 
+If you suspect that one of your gem might be using `GC::Profiler.clear`, you can check with `grep -R 'GC::Profiler.clear' $(bundle show --paths)`.
+
 ## Memory Leak
 
 It is important to note that the underlying `GC::Profiler` keeps internal records of all GC triggers. Every time `GCTime.total_time` is called the datastructure is reset,

data/lib/gctime.rb

@@ -6,23 +6,39 @@ module GCTime
   @mutex = Mutex.new
   @total_time = 0.0
 
-  class << self
-    def enable
-      GC::Profiler.enable
-    end
+  begin
+    GC.stat(:time) # Implemented on JRuby and TruffleRuby
+    class << self
+      def enable
+      end
+
+      def disable
+      end
 
-    def disable
-      GC::Profiler.disable
+      def total_time
+        GC.stat(:time).to_f
+      end
     end
+  rescue ArgumentError
+    # MRI Implementation
+    class << self
+      def enable
+        GC::Profiler.enable
+      end
+
+      def disable
+        GC::Profiler.disable
+      end
 
-    def total_time
-      if GC::Profiler.total_time > 0.0
-        @mutex.synchronize do
-          @total_time += GC::Profiler.total_time
-          GC::Profiler.clear
+      def total_time
+        if GC::Profiler.total_time > 0.0
+          @mutex.synchronize do
+            @total_time += GC::Profiler.total_time * 1_000.0
+            GC::Profiler.clear
+          end
         end
+        @total_time
       end
-      @total_time
     end
   end
 end

data/lib/gctime/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GCTime
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gctime
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock