memory_profiler 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6f50e313b79d97881748e82320ba77ba9ba837a
-  data.tar.gz: 06eef05f9dd835ea1cd95f7f794b6345aed60022
+  metadata.gz: 4b6b21cb4cecfbff39a58884f5c67e379ee246db
+  data.tar.gz: 17fc4f5587f41ce22ebd0445d4a8b207388447b0
 SHA512:
-  metadata.gz: 62046435ace9583f49c43519aeb6d07fe8ca8486fc198e2cd739dbed60bfacafd51ccc935b0ac966fddf9b34f15f031c3bf26274967d5c148c8ab925dae8b9c5
-  data.tar.gz: eb925c93cc41951be2510590860ae507da6e5a2eb7bd7702b53193558f820826e3ff8e7131ba53692ca6c29f943a77fc689ec6c67690f0394edcc7532529171b
+  metadata.gz: 842bfb7550e047af23d8db0ac5522da9bf14b39e82d88a332627d679ea6fecd39ba445971656f4758ad0194f30a91f45cbf81d0641934f89f7fba01d7ead7d8e
+  data.tar.gz: 754a46b32d671bcee62ea5704a8c636e7d1f20b2d4981cd1f376dc9d1f5156ce54a46469e68eede880d3e2801e5dcf0a6e293dc78eb9d125cb6e95bfcfa44569

data/README.md

@@ -1,9 +1,13 @@
 # MemoryProfiler
 
-A memory profiler for Ruby 2.1.0
+A memory profiler for Ruby 
 
 [![Build Status](https://travis-ci.org/SamSaffron/memory_profiler.png?branch=master)](https://travis-ci.org/SamSaffron/memory_profiler)
 
+## Requirements 
+
+Ruby(MRI) Version 2.1.0 and above. 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,7 +33,59 @@ end
 report.pretty_print
 ```
 
-Example Session:
+## Options
+
+You can use `allow_files` option for displaying only lines which contain string or array with strings:
+
+```
+pry> require 'memory_profiler'
+pry> MemoryProfiler.report(allow_files: 'rubygems'){ require 'mime-types' }.pretty_print
+Total allocated 82375
+Total retained 22618
+
+allocated memory by gem
+-----------------------------------
+rubygems x 305879
+
+allocated memory by file
+-----------------------------------
+/home/sam/.rbenv/versions/2.1.0-github/lib/ruby/2.1.0/rubygems/core_ext/kernel_require.rb x 285433
+/home/sam/.rbenv/versions/2.1.0-github/lib/ruby/2.1.0/rubygems/basic_specification.rb x 18597
+/home/sam/.rbenv/versions/2.1.0-github/lib/ruby/2.1.0/rubygems.rb x 2218
+/home/sam/.rbenv/versions/2.1.0-github/lib/ruby/2.1.0/rubygems/specification.rb x 1169
+/home/sam/.rbenv/versions/2.1.0-github/lib/ruby/2.1.0/rubygems/defaults.rb x 520
+/home/sam/.rbenv/versions/2.1.0-github/lib/ruby/2.1.0/rubygems/core_ext/kernel_gem.rb x 80
+/home/sam/.rbenv/versions/2.1.0-github/lib/ruby/2.1.0/rubygems/version.rb x 80
+
+. . .
+```
+
+Also you can print report to file. For this use `pretty_print` method with `to_file` option and `path_to_your_log_file` string:
+```
+$ pry
+pry> require 'memory_profiler'
+pry> MemoryProfiler.report(allow_files: 'rubygems'){ require 'mime-types' }.pretty_print(to_file: 'path_to_your_log_file')
+
+$ less my_report.txt
+Total allocated 82375
+Total retained 22618
+
+allocated memory by gem
+-----------------------------------
+rubygems x 305879
+
+. . .
+```
+
+Other options include:
+
+* `top`: maximum number of entries to display in a report
+* `trace`: an array of classes for which you explicitly want to trace object allocations
+* `ignore_files`: a regular expression used to exclude certain files from tracing (opposite of `allow_files`)
+
+Check out `Reporter#new` for more details.
+
+## Example Session
 
 You can easily use memory_profiler to profile require impact of a gem, for example:
 
@@ -316,7 +372,7 @@ Memory profiler also performs some String analysis to help you find strings that
 
 
 ### 0.0.4
-- Added compatability with released version of Ruby 2.1.0
+- Added compatibility with released version of Ruby 2.1.0
 - Cleanup to use latest APIs available in 2.1.0
 
 ### 0.0.3

data/lib/memory_profiler/reporter.rb

@@ -14,6 +14,7 @@ module MemoryProfiler
       @top          = opts[:top] || 50
       @trace        = opts[:trace]
       @ignore_files = opts[:ignore_files]
+      @allow_files = Array(opts[:allow_files])
     end
 
     # Helper for generating new reporter and running against block
@@ -73,6 +74,11 @@ module MemoryProfiler
       @ignore_files && @ignore_files =~ file
     end
 
+    def allow_file?(file)
+      return true if @allow_files.empty?
+      !/#{@allow_files.join('|')}/.match(file).to_s.empty?
+    end
+
     # Iterates through objects in memory of a given generation.
     # Stores results along with meta data of objects collected.
     def object_list(generation, rvalue_size)
@@ -93,7 +99,7 @@ module MemoryProfiler
 
       objs.each do |obj|
         file = ObjectSpace.allocation_sourcefile(obj)
-        next if ignore_file?(file)
+        next if !allow_file?(file) || ignore_file?(file)
 
         line       = ObjectSpace.allocation_sourceline(obj)
         class_path = ObjectSpace.allocation_class_path(obj)

data/lib/memory_profiler/results.rb

@@ -68,15 +68,17 @@ module MemoryProfiler
     def string_report(data, top)
       data
           .reject { |id, stat| stat.class_name != "String" }
-          .map { |id, stat| [ObjectSpace._id2ref(id), "#{stat.file}:#{stat.line}"] }
+          .map { |id, stat| [begin; ObjectSpace._id2ref(id); rescue "__UNKNOWN__"; end, "#{stat.file}:#{stat.line}"] }
           .group_by { |string, location| string }
           .sort_by { |string, list| -list.count }
           .first(top)
           .map { |string, list| [string, list.group_by { |str, location| location }
-                                             .map { |location, locations| [location, locations.count] }] }
+          .map { |location, locations| [location, locations.count] }] }
     end
 
-    def pretty_print(io = STDOUT, options = {})
+    def pretty_print(io = STDOUT, **options)
+      io = File.open(options[:to_file], "w") if options[:to_file]
+
       color_output = options.fetch(:color_output) { io.respond_to?(:isatty) && io.isatty }
       @colorize = color_output ? Polychrome.new : Monochrome.new
 
@@ -87,14 +89,15 @@ module MemoryProfiler
           .product(["memory", "objects"])
           .product(["gem", "file", "location"])
           .each do |(type, metric), name|
-        dump "#{type} #{metric} by #{name}", self.send("#{type}_#{metric}_by_#{name}"), io
-      end
+            dump "#{type} #{metric} by #{name}", self.send("#{type}_#{metric}_by_#{name}"), io
+          end
 
       io.puts
       dump_strings(io, "Allocated", strings_allocated)
       io.puts
       dump_strings(io, "Retained", strings_retained)
-      nil
+
+      io.close if io.is_a? File
     end
 
     private

data/lib/memory_profiler/version.rb

@@ -1,3 +1,3 @@
 module MemoryProfiler
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory_profiler
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler