memory_profiler 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3f841c1bfcbaecdaccf8359aa37a7d42605c485
-  data.tar.gz: 599119026dfb887ffc810d81da2b17a9e71f29cf
+  metadata.gz: 87e903eb12fc8a885066fe621d8254a4297555fa
+  data.tar.gz: 179a6ccb31c2b71ae9d1ef620be16ce1fa9b4d70
 SHA512:
-  metadata.gz: ac957555ecad713d83c891c87bf118f1a00dcf0633d1f18b3d38181b472f654db5218eb3c6494d66ae7b3a5da8bdd9425a4457a3c5e77f69514d8628490cba98
-  data.tar.gz: 54eb5dc1456d906452b152b000abcaca1d6b229d70e259ca54b2bad36476d69a94edbb2666daa603595a174f468ea7edf619e8afe6554ad3e2606443fbd1d11a
+  metadata.gz: ac3255e9b9623c580c3c7cdba776a530907936f8d4ff1c78b46ce42b3d7f97b446082d190c74d7a7f050ec7036d2c662f6736ce1db104ccd0cf17cc466f0ad67
+  data.tar.gz: c490d5aa5e024119839aaf8948c27d992c6b40325f8ded2447c228d726145c5668d9ee29d3ac13f8f7d0a8d9c0bc064130fcf67209103e493ad8e4ad5acb73ad

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.9.8
+- Add optional start/stop sematics to memory profiler api @nicklamuro @dgynn
+
 ## 0.9.7
 - Improved class name detection for proxy objects, BasicObject objects, and
  other edge cases @inossidabile @Hamdiakoguz @dgynn

data/README.md

@@ -33,6 +33,22 @@ end
 report.pretty_print
 ```
 
+Or, you can use the `.start`/`.stop` API as well:
+
+```ruby
+require 'memory_profiler'
+
+MemoryProfiler.start
+
+# run your code
+
+report = MemoryProfiler.stop
+report.pretty_print
+```
+
+**NOTE:**  `.start`/`.stop` can only be run once per report, and `.stop` will
+be the only time you can retrieve the report using this API.
+
 ## Options
 
 The report method can take a few options:

data/lib/memory_profiler.rb

@@ -10,9 +10,21 @@ require "memory_profiler/reporter"
 
 module MemoryProfiler
   def self.report(opts={},&block)
-    opts[:top] ||= 50
     Reporter.report(opts,&block)
   end
+
+  def self.start(opts={})
+    unless Reporter.current_reporter
+      Reporter.current_reporter = Reporter.new(opts)
+      Reporter.current_reporter.start
+    end
+  end
+
+  def self.stop
+    Reporter.current_reporter.stop if Reporter.current_reporter
+  ensure
+    Reporter.current_reporter = nil
+  end
 end
 
 

data/lib/memory_profiler/reporter.rb

@@ -7,7 +7,11 @@ module MemoryProfiler
   #     5.times { "foo" }
   #   end
   class Reporter
-    attr_reader :top, :trace
+    class << self
+      attr_accessor :current_reporter
+    end
+
+    attr_reader :top, :trace, :generation, :report_results
 
     def initialize(opts = {})
       @top          = opts[:top] || 50
@@ -27,16 +31,16 @@ module MemoryProfiler
       self.new(opts).run(&block)
     end
 
-    # Collects object allocation and memory of ruby code inside of passed block.
-    def run(&block)
-
+    def start
       GC.start
       GC.disable
 
-      generation = GC.count
-      ObjectSpace.trace_object_allocations do
-        block.call
-      end
+      @generation = GC.count
+      ObjectSpace.trace_object_allocations_start
+    end
+
+    def stop
+      ObjectSpace.trace_object_allocations_stop
       allocated = object_list(generation)
       retained = StatHash.new.compare_by_identity
 
@@ -53,9 +57,15 @@ module MemoryProfiler
       end
       ObjectSpace.trace_object_allocations_clear
 
-      results = Results.new
-      results.register_results(allocated, retained, top)
-      results
+      @report_results = Results.new
+      @report_results.register_results(allocated, retained, top)
+    end
+
+    # Collects object allocation and memory of ruby code inside of passed block.
+    def run(&block)
+      start
+      block.call
+      stop
     end
 
     private

data/lib/memory_profiler/version.rb

@@ -1,3 +1,3 @@
 module MemoryProfiler
-  VERSION = "0.9.7"
+  VERSION = "0.9.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory_profiler
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies: []
 description: Memory profiling routines for Ruby 2.1+
 email:
@@ -50,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Memory profiling routines for Ruby 2.1+