memprof2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70b0b317e5659917d244b780e9c03035c1c06792
-  data.tar.gz: 10d94aa32210670aecb272e61fa1264cbde82446
+  metadata.gz: 8f7d49694ae39d219aa3825bdbdf5a5dffbae4ea
+  data.tar.gz: cf598a824cdbf2d424062f7b0a94e790ba8beacc
 SHA512:
-  metadata.gz: 7605deeb9ea4cbdabdd69c00eeee95e827f3ee138d6618945641a8dd29c5317fcdafc7f8c1307acb88b1543648a8f0355c5cbd83e5aaf6b2e3cd22b0916abf01
-  data.tar.gz: 80dfd4f07fe669765e2f983961cae0b517289d69203d64303cb8c3cd68496e5acff0252e26a056f025e595d83d9cc9505fb919fe6676cd04d8e7f1d73c2f5abd
+  metadata.gz: e31eaf801bff2ec8f2d39da44554be1c65f661d3eb46d53debff04243db77945b3883be0dd7af90a2ae64a24f1e292fd86126bd329566e57f8ce546ac338150d
+  data.tar.gz: 470ce1c09df87bc05f5635f532f1b9fadf692ae863115cdebad5c896331f8934cc4864ad013327d88d65eb6c3a70a571201726958de3b062082e25d5fd4be45f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.0.2 (2014/12/12)
+
+Enhancements
+
+* Add `Memprof2.report!` to clear out tracking data after printing out results.
+
 # 0.0.1
 
 Initial version

data/README.md

@@ -28,35 +28,43 @@ $ bundle
 
 ## Memprof2.report
 
-    Memprof2.start
-    12.times{ "abc" }
-    Memprof2.report(out: "/path/to/file")
-    Memprof2.stop
+```ruby
+Memprof2.start
+12.times{ "abc" }
+Memprof2.report(out: "/path/to/file")
+Memprof2.stop
+```
 
 Start tracking file/line memory size (bytes) information for objects created after calling `Memprof2.start`, and print out a summary of file:line:class pairs created.
 
-    480 file.rb:2:String
+```
+480 file.rb:2:String
+```
 
 *Note*: Call `Memprof2.report` again after `GC.start` to see which objects are cleaned up by the garbage collector:
 
-    Memprof2.start
-    10.times{ $last_str = "abc" }
+```ruby
+Memprof2.start
+10.times{ $last_str = "abc" }
 
-    puts '=== Before GC'
-    Memprof2.report
+puts '=== Before GC'
+Memprof2.report
 
-    puts '=== After GC'
-    GC.start
-    Memprof2.report
+puts '=== After GC'
+GC.start
+Memprof2.report
 
-    Memprof2.stop
+Memprof2.stop
+```
 
 After `GC.start`, only the very last instance of `"abc"` will still exist:
 
-    === Before GC
-         400 file.rb:2:String
-    === After GC
-          40 file.rb:2:String
+```
+=== Before GC
+400 file.rb:2:String
+=== After GC
+40 file.rb:2:String
+```
 
 *Note*: Use `Memprof2.report!` to clear out tracking data after printing out results.
 
@@ -64,18 +72,22 @@ After `GC.start`, only the very last instance of `"abc"` will still exist:
 
 Simple wrapper for `Memprof2.start/stop` that will start/stop memprof around a given block of ruby code.
 
-    Memprof2.run do
-      100.times{ "abc" }
-      100.times{ 1.23 + 1 }
-      100.times{ Module.new }
-      Memprof2.report(out: "/path/to/file")
-    end
+```ruby
+Memprof2.run do
+  100.times{ "abc" }
+  100.times{ 1.23 + 1 }
+  100.times{ Module.new }
+  Memprof2.report(out: "/path/to/file")
+end
+```
 
 For the block of ruby code, print out file:line:class pairs for ruby objects created.
 
-    4000  file.rb:2:String
-    4000  file.rb:3:Float
-    4000  file.rb:4:Module
+```
+4000  file.rb:2:String
+4000  file.rb:3:Float
+4000  file.rb:4:Module
+```
 
 *Note*: You can call GC.start at the end of the block to print out only objects that are 'leaking' (i.e. objects that still have inbound references).
 

data/lib/memprof2.rb

@@ -1,6 +1,6 @@
 require 'objspace'
 
-module Memprof2
+class Memprof2
   class << self
     def start
       ObjectSpace.trace_object_allocations_start
@@ -15,38 +15,57 @@ module Memprof2
       ObjectSpace.trace_object_allocations(&block)
     end
 
-    def report(opts={})
+    def report(opts = {})
       ObjectSpace.trace_object_allocations_stop
-      @rvalue_size = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
-      if @trace = opts[:trace]
-        raise ArgumentError, "`trace` option must be a Regexp object" unless @trace.is_a?(Regexp)
-      end
-      if @ignore = opts[:ignore]
-        raise ArgumentError, "`trace` option must be a Regexp object" unless @ignore.is_a?(Regexp)
-      end
-      results = {}
-      ObjectSpace.each_object do |o|
-        next unless (file = ObjectSpace.allocation_sourcefile(o))
-        next if file == __FILE__
-        next if (@trace  and @trace !~ file)
-        next if (@ignore and @ignore =~ file)
-        line = ObjectSpace.allocation_sourceline(o)
-        memsize  = ObjectSpace.memsize_of(o) + @rvalue_size
-        memsize = @rvalue_size if memsize > 100_000_000_000 # compensate for API bug
-        klass = o.class.name rescue "BasicObject"
-        location = "#{file}:#{line}:#{klass}"
-        results[location] ||= 0
-        results[location] += memsize
-      end
-      @out = opts[:out] || "/dev/stdout"
-      File.open(@out, 'w') do |io|
-        results.each do |location, memsize|
-          io.puts "#{memsize} #{location}"
-        end
-      end
+      self.new.report(opts)
     ensure
       ObjectSpace.trace_object_allocations_start
     end
+
+    def report!(opts = {})
+      report(opts)
+      ObjectSpace.trace_object_allocations_clear
+    end
+  end
+
+  def report(opts={})
+    configure(opts)
+    results = collect_info
+    File.open(@out, 'w') do |io|
+      results.each do |location, memsize|
+        io.puts "#{memsize} #{location}"
+      end
+    end
+  end
+
+  def configure(opts = {})
+    @rvalue_size = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
+    if @trace = opts[:trace]
+      raise ArgumentError, "`trace` option must be a Regexp object" unless @trace.is_a?(Regexp)
+    end
+    if @ignore = opts[:ignore]
+      raise ArgumentError, "`ignore` option must be a Regexp object" unless @ignore.is_a?(Regexp)
+    end
+    @out = opts[:out] || "/dev/stdout"
+    self
+  end
+
+  def collect_info
+    results = {}
+    ObjectSpace.each_object do |o|
+      next unless (file = ObjectSpace.allocation_sourcefile(o))
+      next if file == __FILE__
+      next if (@trace  and @trace !~ file)
+      next if (@ignore and @ignore =~ file)
+      line = ObjectSpace.allocation_sourceline(o)
+      memsize = ObjectSpace.memsize_of(o) + @rvalue_size
+      memsize = @rvalue_size if memsize > 100_000_000_000 # compensate for API bug
+      klass = o.class.name rescue "BasicObject"
+      location = "#{file}:#{line}:#{klass}"
+      results[location] ||= 0
+      results[location] += memsize
+    end
+    results
   end
 end
 

data/memprof2.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "memprof2"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["Naotoshi Seo"]
   spec.email         = ["sonots@gmail.com"]
   spec.description   = %q{Ruby memory profiler for >= Ruby 2.1.0}

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'memprof2'

data/test/test_memprof2.rb

@@ -0,0 +1,53 @@
+require_relative 'helper'
+
+class TestMemprof2 < Test::Unit::TestCase
+  def rvalue_size
+    GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
+  end
+
+  def find(results, key_match)
+    results.find {|k, v| k =~ key_match }.last
+  end
+
+  def test_start_stop
+    memprof = Memprof2.new.configure({})
+    Memprof2.start
+    a = "abc"
+    12.times{ "abc" }
+    results = memprof.collect_info
+    Memprof2.stop
+    assert_equal(rvalue_size, find(results, /test_memprof2.rb:15:String/))
+    assert_equal(rvalue_size * 12, find(results, /test_memprof2.rb:16:String/))
+  end
+
+  def test_run
+    memprof = Memprof2.new.configure({})
+    results = nil
+    Memprof2.run do
+      a = "abc"
+      results = memprof.collect_info
+    end
+    assert_equal(rvalue_size, find(results, /test_memprof2.rb:27:String/))
+  end
+
+  def test_report_out
+    opts = {out: "tmp/test_report.out"}
+    Memprof2.start
+    a = "abc"
+    Memprof2.report(opts)
+    Memprof2.stop
+    assert_match("test/test_memprof2.rb:36:String\n", File.read(opts[:out]))
+  end
+
+  def test_report!
+    opts_bang = {out: "tmp/test_report_bang.out"}
+    opts = {out: "tmp/test_report.out"}
+    Memprof2.start
+    a = "abc"
+    Memprof2.report!(opts_bang) # clear
+    Memprof2.report(opts)
+    Memprof2.stop
+    assert_match("test/test_memprof2.rb:46:String\n", File.read(opts_bang[:out]))
+    assert_match("", File.read(opts[:out]))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memprof2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -55,6 +55,9 @@ files:
 - example.rb
 - lib/memprof2.rb
 - memprof2.gemspec
+- test/helper.rb
+- test/test_memprof2.rb
+- tmp/.gitkeep
 homepage: https://github.com/sonots/memprof2
 licenses:
 - MIT
@@ -79,4 +82,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby memory profiler for >= Ruby 2.1.0
-test_files: []
+test_files:
+- test/helper.rb
+- test/test_memprof2.rb