hotch 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c35cd590d82f32eb2e073d78b2dcf3a59f9dac26
-  data.tar.gz: 0043e7a301ab0c4ede090e614723ca40657f172e
+SHA256:
+  metadata.gz: 8a8f4b895fb76ef2998f7d51ce4a1725723649839b655a46e261e6b5d8bbd7a7
+  data.tar.gz: 55e5919e466022d1427d607d12fc8929248ceb4ad9c6716d0cfba9bc1cafe11e
 SHA512:
-  metadata.gz: 85a612b48a755637431d2827db351df62ca9667837de967ffe1d7b71b9895b054a5bc46245d1d4432dbfa048a42a1381941c38edf92e77b955458cc8be6f31eb
-  data.tar.gz: 540d85864f5f6c3a88b6f3de0a04ade4af677d317d2799fc01a8b93de1aa423014ff4b66df68125006b4e90451dd9a585797358c55308f8e5a049a09dd8c1051
+  metadata.gz: 21af11cc4cdfbab13d13cbe882cfc0bd28aecc72a746ae613c21031911d07d386cf2bc328ac165861517501681db221564b971b8f3658c354ffb7ac6633f7f0d
+  data.tar.gz: 6f43595863fb4975d6fd3fd632e7c920d1628d5a659349f433ec9b16b003d43c4de187ac25011a71d2f0c44bf6591ec4b03f6c9bc0d36ec47685fd9dc0904fec

data/LICENSE.txt

@@ -1,4 +1,5 @@
 Copyright (c) 2015 Peter Suschlik
+Copyright (c) 2017 Peter Leitzen (Suschlik)
 
 MIT License
 

data/README.md

@@ -62,7 +62,7 @@ dry/struct/class_interface.rb:77 T_OBJECT  2000         0         0       0
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'hotch', '~> 0.4.0'
+gem 'hotch', '~> 0.6.0'
 ```
 
 And then execute:
@@ -138,6 +138,10 @@ Hotch::Minitest.run(options: { limit: 200 })
 
 ### Memory profiler
 
+Shell usage:
+
+    $ ruby -rhotch/memory/run my_program.rb
+
 Require `hotch/memory` and use `Hotch.memory { ... }` as in:
 
 ```ruby
@@ -162,9 +166,7 @@ module Types
   end
 end
 
-# For more stable results
-GC.disable
-
+# For more stable results the GC is disabled by default during runs.
 Hotch.memory do
   1000.times do
     Types::Success.new(
@@ -173,6 +175,43 @@ Hotch.memory do
     )
   end
 end
+
+# In order to prevent disabling the GC during runs do:
+Hotch.memory(disable_gc: false) do
+  # ...
+end
+
+# Disable aggregation between runs:
+Hotch.memory(aggregate: false) do
+  # this run is not aggregated
+end
+```
+
+#### Inline reporting
+
+This prints two ASCII tables showing the object alloctions two calls:
+
+```ruby
+puts Hotch::Memory.report("memory") {
+  # ...
+}
+
+puts Hotch::Memory.report("another") {
+  # ...
+}
+```
+
+### Minitest integration for the memory profiler
+
+Load `hotch/memory/minitest` in your `test/test_helper.rb` like this:
+
+```ruby
+require 'minitest/autorun'
+require 'hotch/memory/minitest'
+
+Hotch::Minitest.run
+Hotch::Minitest.run(name: "my name")
+Hotch::Minitest.run(disable_gc: false) # on by default
 ```
 
 
@@ -198,5 +237,5 @@ Follow these steps to release this gem:
     edit lib/hotch/version.rb
     edit README.md
     # Commit
-    git commit -m "Release vX.Y.Z"
+    git commit -am "Release vX.Y.Z"
     rake release

data/examples/memory_at_exit.rb

@@ -0,0 +1,15 @@
+require 'hotch/memory'
+
+ary = []
+
+Hotch.memory do
+  ary << "string"
+end
+
+Hotch.memory do
+  ary << "another"
+end
+
+Hotch.memory do
+  ary.join(" ")
+end

data/examples/memory_inline_report.rb

@@ -0,0 +1,15 @@
+require 'hotch/memory'
+
+ary = []
+
+puts Hotch::Memory.report("1") {
+  ary << "string"
+}
+
+puts Hotch::Memory.report("2") {
+  ary << "another"
+}
+
+puts Hotch::Memory.report("3") {
+  ary.join(" ")
+}

data/hotch.gemspec

@@ -6,10 +6,10 @@ require 'hotch/version'
 Gem::Specification.new do |spec|
   spec.name          = "hotch"
   spec.version       = Hotch::VERSION
-  spec.authors       = ["Peter Suschlik"]
-  spec.email         = ["peter@suschlik.de"]
+  spec.authors       = ["Peter Leitzen"]
+  spec.email         = ["peter@leitzen.de"]
   spec.summary       = %q{Profile helper}
-  spec.description   = %q{Stackprofs your program, generates/display call-stack profile as SVG}
+  spec.description   = %q{Callstack and memory profiler}
   spec.homepage      = "https://github.com/splattael/hotch"
   spec.license       = "MIT"
 
@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "stackprof", "~> 0.2.10"
+  spec.add_runtime_dependency "stackprof", "~> 0.2.15"
   spec.add_runtime_dependency "allocation_tracer", "~> 0.6.3"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/hotch.rb

@@ -1,6 +1,8 @@
 require 'stackprof'
 require 'tmpdir'
 
+require 'hotch/version'
+
 class Hotch
   attr_reader :name, :viewer, :filter, :options
 
@@ -44,7 +46,13 @@ class Hotch
     dot = report_dot(report, dir, "profile.dot")
     svg = convert_svg(dir, dot, "profile.svg")
 
-    yield svg
+    @reports.clear
+
+    if block_given?
+      yield report, svg
+    else
+      return report, svg
+    end
   end
 
   def report_at_exit
@@ -53,7 +61,7 @@ class Hotch
     at_exit do
       stop
 
-      report do |svg|
+      report do |_, svg|
         if viewer
           puts "Profile SVG: #{svg}"
           Kernel.system viewer, svg
@@ -86,7 +94,7 @@ class Hotch
 
   def convert_svg(dir, dot, file)
     svg = File.join(dir, file)
-    system("dot", "-Tsvg", "-o", svg, dot) or raise "dot failed"
+    system("dot", "-Tsvg", "-o", svg, dot) or raise "dot: command not found. Please install graphviz"
     svg
   end
 

data/lib/hotch/memory.rb

@@ -1,26 +1,40 @@
 require 'allocation_tracer'
 
 class Hotch
-  def self.memory(name: $0)
-    caller = Kernel.caller_locations(1).first
-    name = "#{name}:#{caller.path}:#{caller.lineno}"
-    memory = Memory.new(name)
+  def self.memory(name: $0, aggregate: true, &block)
+    memory = if aggregate
+               $hotch_memory ||= Memory.new(name)
+             else
+               caller = Kernel.caller_locations(1).first
+               name = "#{name}:#{caller.path}:#{caller.lineno}"
+               Memory.new(name)
+             end
 
     memory.report_at_exit
-    memory.run do
-      yield
+
+    if block
+      memory.run(&block)
+    else
+      memory.start
     end
   end
 
   class Memory
-    def initialize(name, ignore_paths: [])
+    def initialize(name, ignore_paths: [], disable_gc: true)
       @name = name
       @ignore_paths = Array(ignore_paths || [])
-      @report = nil
+      @reports = []
       @started = nil
+      @disable_gc = disable_gc
+    end
+
+    def self.report(name, **args, &block)
+      new(name, **args).run(&block).report
     end
 
     def start
+      return if @started
+      GC.disable if @disable_gc
       ObjectSpace::AllocationTracer.setup [:path, :line, :type]
       ObjectSpace::AllocationTracer.start
       @started = true
@@ -30,19 +44,28 @@ class Hotch
       return unless @started
       results = ObjectSpace::AllocationTracer.stop
       @started = nil
-      @report = Report.new(results, @ignore_paths)
+      GC.enable if @disable_gc
+      @reports << Report.new(results, @ignore_paths)
     end
 
     def run
       start
       yield
+      self
     ensure
       stop
     end
 
     def report
       # TODO make it persistent (as CSV)
-      yield @report
+      report = @reports.inject(:+)
+      @reports.clear
+
+      if block_given?
+        yield report
+      else
+        report
+      end
     end
 
     def report_at_exit
@@ -66,17 +89,28 @@ class Hotch
     end
 
     class Report
+      attr_reader :lines
+
       def initialize(results, ignore_paths)
         @header = Line.new(*Line.members)
-        @total = Line::Total.new
         @lines = results.map do |result|
-          if line = Line.from_result(result, ignore_paths)
-            @total.sum(line)
-            line
-          end
+          Line.from_result(result, ignore_paths)
         end.compact
       end
 
+      def +(other)
+        by_key = Hash[@lines.map { |line| [line.key, line] }]
+        other.lines.each do |line|
+          if existing = by_key[line.key]
+            existing.sum(line)
+          else
+            by_key[line.key] = line
+            @lines << line
+          end
+        end
+        self
+      end
+
       def format
         # TODO refactor
         max_lengths = Array.new(Line.members.size, 0)
@@ -89,12 +123,28 @@ class Hotch
       end
 
       def puts(io)
+        total!
         fmt = format
         @header.puts(io, fmt)
         @lines.sort_by(&:count).each { |line| line.puts(io, fmt) }
         @total.puts(io, fmt)
       end
 
+      def to_s
+        io = StringIO.new
+        puts(io)
+        io.string
+      end
+
+      private def total!
+        return if defined? @total
+
+        @total = Line::Total.new
+        @lines.each do |line|
+          @total.sum(line)
+        end
+      end
+
       class Line < Struct.new(:filename, :type, :count, :old_count, :total_age,
                               :min_age, :max_age, :total_memsize)
         # [
@@ -104,10 +154,14 @@ class Hotch
         def self.from_result(result, ignore_paths)
           path, line, *args = result.flatten(1)
           return if ignore_paths.any? { |ip| ip == path || ip === path }
-          filename = "#{strip_path(path)}:#{line}"
+          filename = "#{strip_path(path || "?")}:#{line}"
           new(filename, *args)
         end
 
+        def key
+          [filename, type]
+        end
+
         def puts(io, fmt)
           send = method(:send)
           io.puts fmt % members.map(&send)
@@ -117,6 +171,12 @@ class Hotch
           members.map { |member| self[member].to_s.size }
         end
 
+        def sum(other)
+          other.to_a.each.with_index do |value, i|
+            self[i] += value if Numeric === value
+          end
+        end
+
         private
 
         MAX_PATH_LENGTH = 50
@@ -135,12 +195,6 @@ class Hotch
           def initialize
             super("TOTAL", "", 0, 0, 0, 0, 0, 0)
           end
-
-          def sum(other)
-            other.to_a.each.with_index do |value, i|
-              self[i] += value if Numeric === value
-            end
-          end
         end
       end
     end

data/lib/hotch/memory/minitest.rb

@@ -0,0 +1,28 @@
+require "hotch/memory"
+
+class Hotch
+  class Memory
+    module Minitest
+      # Usage in test/test_helper.rb:
+      #
+      #     require 'hotch/memory/minitest'
+      #
+      #     Hotch::Memory::Minitest.run
+      #     Hotch::Memory::Minitest.run(name: "my name")
+      def self.run(**options)
+        ::Minitest.singleton_class.prepend Hotch::Memory::Minitest.aggregate(**options)
+      end
+
+      def self.aggregate(**options)
+        Module.new do
+          define_method(:run_one_method) do |*args|
+            options[:aggregate] = true
+            Hotch.memory(**options) do
+              super(*args)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hotch/memory/run.rb

@@ -0,0 +1,3 @@
+require 'hotch/memory'
+
+Hotch.memory(name: $0)

data/lib/hotch/version.rb

@@ -1,3 +1,3 @@
 class Hotch
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotch
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
-- Peter Suschlik
+- Peter Leitzen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2020-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stackprof
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.10
+        version: 0.2.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.10
+        version: 0.2.15
 - !ruby/object:Gem::Dependency
   name: allocation_tracer
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,9 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Stackprofs your program, generates/display call-stack profile as SVG
+description: Callstack and memory profiler
 email:
-- peter@suschlik.de
+- peter@leitzen.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -79,12 +79,16 @@ files:
 - README.md
 - Rakefile
 - examples/bundler.rb
+- examples/memory_at_exit.rb
+- examples/memory_inline_report.rb
 - examples/simple.rb
 - hotch.gemspec
 - images/dry-validation.profile_schema_call_valid.png
 - images/dry-validation.profile_schema_call_valid.svg
 - lib/hotch.rb
 - lib/hotch/memory.rb
+- lib/hotch/memory/minitest.rb
+- lib/hotch/memory/run.rb
 - lib/hotch/minitest.rb
 - lib/hotch/run.rb
 - lib/hotch/version.rb
@@ -107,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Profile helper