memprof2 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d9b55a50f67161cea84ebdc89645374630660569
-  data.tar.gz: 35e0293167a9dfe44204fc2a13bf0422db6181cb
+SHA256:
+  metadata.gz: c9ce828abc8d8a17b915fee8fa2ab9cbc146e94b60266110440c5b2be6ea5002
+  data.tar.gz: 4b27bd87a42decfcf2a0c09ec650e266a6c23f5ca2cb49a14dc135e41c807850
 SHA512:
-  metadata.gz: 596133c5b056bff18425149e7562a169087341e4a785c0f888f40f50a3b7984fb90da034c75995cd4acbb9627eb976b207c9a14234db4b85cedc9ae1ffb04dd8
-  data.tar.gz: d303b970902c1d2eb53b8f8bf5612a0af967d2d2a7a9a9ae878f004dce7598a0cb471b6b088887ce2471d277eb2eb538d03122370d73b84ed0c81e1cbd3ea496
+  metadata.gz: 45454dcdf9079e9c1fc66f3da0b4fdde5f86741930dc415c05975030738a5c9c532e380475c4d15ff4b34a69cdcea1e07c6304b41711e8023ec851da1cf830cc
+  data.tar.gz: 5b5978fadb7f0293ace9ec32435ee6fe4ba753a522f636d5083503269e75f6dfc5b17e65ca9ea89fe0422f8617a10725946a57023571632cf55861ef03297107

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.1.2 (2018/10/05)
+
+Enhancements:
+
+* Add `Memprof2.run_with_report` (thanks to @takkanm)
+
 # 0.1.1 (2015/10/10)
 
 Changes

data/README.md

@@ -68,9 +68,19 @@ After `GC.start`, only the very last instance of `"abc"` will still exist:
 
 *Note*: Use `Memprof2.report!` to clear out tracking data after printing out results.
 
+Use `trace` and `ignore` options to restrict files to report. You can write patterns by regular expressions:
+
+```
+Memprof2.start
+10.times{ $last_str = "abc" }
+GC.start
+Memprof2.report!(trace: /file\.rb/, ignore: /ignore_me/, out: "/path/to/file")
+Memprof2.stop
+```
+
 ## Memprof2.run
 
-Simple wrapper for `Memprof2.start/stop` that will start/stop memprof around a given block of ruby code.
+A shorthand for `Memprof2.start/stop` that will start/stop memprof around a given block of ruby code.
 
 ```ruby
 Memprof2.run do
@@ -91,6 +101,20 @@ For the block of ruby code, print out file:line:class pairs for ruby objects cre
 
 *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).
 
+## Memprof2.run_with_report
+
+A shorthand for `Memprof2.start/report/stop`.
+
+Following codes work exactly same with the above example.
+
+```ruby
+Memprof2.run_with_report(out: "/path/to/file") do
+  100.times{ "abc" }
+  100.times{ 1.23 + 1 }
+  100.times{ Module.new }
+end
+```
+
 ## ChangeLog
 
 See [CHANGELOG.md](CHANGELOG.md) for details.

data/example.rb

@@ -27,3 +27,10 @@ Memprof2.run do
   100.times{ Module.new }
   Memprof2.report(out: "example.out")
 end
+
+############
+Memprof2.run_with_report(out: "example.out") do
+  100.times{ "abc" }
+  100.times{ 1.23 + 1 }
+  100.times{ Module.new }
+end

data/lib/memprof2.rb

@@ -26,6 +26,14 @@ class Memprof2
       report(opts)
       ObjectSpace.trace_object_allocations_clear
     end
+
+    def run_with_report(opts = {}, &block)
+      start
+      yield
+      report(opts)
+    ensure
+      stop
+    end
   end
 
   def report(opts={})

data/memprof2.gemspec

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

data/test/test_memprof2.rb

@@ -50,4 +50,12 @@ class TestMemprof2 < Test::Unit::TestCase
     assert_match("test/test_memprof2.rb:46:String\n", File.read(opts_bang[:out]))
     assert_match("", File.read(opts[:out]))
   end
+
+  def test_run_with_result
+    opts = {out: "tmp/test_run_with_report.out"}
+    Memprof2.run_with_report(opts) do
+      a = "abc"
+    end
+    assert_match("test/test_memprof2.rb:57:String\n", File.read(opts[:out]))
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memprof2
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2018-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby memory profiler for >= Ruby 2.1.0