hotch 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b5d9d923cc25d830ae5bdf7c250767e5c036d9a
-  data.tar.gz: 2600d46dd7b9c7b2554fe3a28e20fe2ed9ac26b6
+  metadata.gz: 38cc02398ab2755f8c90da8ae6ea973db46de9b7
+  data.tar.gz: 938117da7ad53717ba52d5507c9b4b8575317068
 SHA512:
-  metadata.gz: f1f8a1519c968110d4696b7476a98dd0444a3681ec8d93b7c103d34de1f0817925661c9868907fa6f3b85095d7efdc2bb119ff0f39e163e778795e6eade66091
-  data.tar.gz: a46d658d2b27f15889c0a936c0d8abdb6896d31c54a66aa525fadc0f0d1cfce48784d7e9536119d99bdf7039b83d4c2ab6e058e982c7d1b3180b15d3e01e916e
+  metadata.gz: 91eaa4af1f66add4591182e39b47192325b5842e7bb87176aba19491e071880394d6421288590943683f2103e970e143f07bd535b3eb758fc393ba1919187f17
+  data.tar.gz: 485b40654f50784ec3e08483fac13b4b01b41fefa47790e8d25abf9cf99d32ab720f49169517cda9b662de3ddd72128415c52054b28f1c0850b2313be4e1a8c2

data/README.md

@@ -27,10 +27,40 @@ Or install it yourself as:
 
 ## Usage
 
-    $ ruby -rhotch my_program.rb
+### Profile complete program
+
+    $ ruby -rhotch/run my_program.rb
     Profile SVG: /tmp/hotch.my_program20150104-17330-18t4171/profile.svg
     $ view /tmp/hotch.my_program20150104-17330-18t4171/profile.svg
 
+### Profile blocks in your program
+
+```ruby
+require 'hotch'
+
+def expensive_method
+  # ...
+end
+
+Hotch() do
+  1000.times do
+    expensive_method
+  end
+end
+
+Hotch(aggregate: false) do
+  1000.times do
+    # this run is not aggregated
+  end
+end
+
+Hotch() do
+  1000.times do
+    # aggregated again
+  end
+end
+```
+
 ### Auto-view
 
 Set envvar `HOTCH_VIEWER` to enable auto-view after profiling.

data/examples/simple.rb

@@ -0,0 +1,23 @@
+require 'hotch'
+
+COUNT = ENV.fetch('COUNT', 10_000)
+
+def foo
+  "x" * 23
+end
+
+def bar
+  ["x"] * 23
+end
+
+Hotch(aggregate: false) do
+  COUNT.times do
+    foo
+  end
+end
+
+Hotch() do
+  COUNT.times do
+    bar
+  end
+end

data/lib/hotch.rb

@@ -1,32 +1,92 @@
 require 'stackprof'
 require 'tmpdir'
 
-HOTCH_VIEWER = ENV['HOTCH_VIEWER']
+class Hotch
+  attr_reader :name
 
-NAME = $0.gsub(/\W/, '_')
+  def initialize(name)
+    @name = name
+    @reports = []
+  end
 
-StackProf.start
+  def start(*args)
+    StackProf.start(*args) unless StackProf.running?
+  end
 
-def system!(*args)
-  system(*args) or raise "system call failed: #{args.join(' ')}"
-end
+  def stop
+    if StackProf.running?
+      StackProf.stop
+      @reports << StackProf::Report.new(results)
+    end
+  end
+
+  def run(*args)
+    start(*args)
+    yield
+  ensure
+    stop
+  end
+
+  def results
+    StackProf.results
+  end
+
+  def report
+    report = @reports.inject(:+) or return
+
+    dir = Dir.mktmpdir("hotch.#{name}.")
+    dump = File.open(File.join(dir, "profile.dump"), "wb")
+    svg = File.join(File.join(dir, "profile.svg"))
+
+
+    report.print_graphviz(nil, dump)
 
-at_exit do
-  StackProf.stop
+    dump.close
 
-  dir = Dir.mktmpdir("hotch.#{NAME}")
-  dump = File.open(File.join(dir, "profile.dump"), "wb")
-  svg = File.join(File.join(dir, "profile.svg"))
+    system! "dot", "-Tsvg", "-o", svg, dump.path
 
-  StackProf::Report.new(StackProf.results).print_graphviz(nil, dump)
+    yield svg
+  end
+
+  def system!(*args)
+    Kernel.system(*args) or raise "system call failed: #{args.join(' ')}"
+  end
+
+  def report_at_exit(viewer=ENV['HOTCH_VIEWER'])
+    return if defined? @at_exit_installed
+
+    at_exit do
+      stop
+
+      report do |svg|
+        puts "Profile SVG: #{svg}"
 
-  dump.close
+        if viewer
+          system viewer, svg
+        end
+      end
+    end
 
-  system! "dot", "-Tsvg", "-o", svg, dump.path
+    @at_exit_installed = true
+  end
+
+  private
+
+  def name
+    @name.gsub(/\W+/, '_')
+  end
+end
 
-  puts "Profile SVG: #{svg}"
+def Hotch(aggregate: true)
+  hotch = if aggregate
+    $hotch ||= Hotch.new($0)
+  else
+    caller = Kernel.caller_locations(1).first
+    Hotch.new("#$0:#{caller.path}:#{caller.lineno}")
+  end
 
-  if viewer = HOTCH_VIEWER
-    system! viewer, svg
+  hotch.report_at_exit
+  hotch.run do
+    yield
   end
 end

data/lib/hotch/run.rb

@@ -0,0 +1,8 @@
+require 'hotch'
+
+viewer = ENV['HOTCH_VIEWER']
+
+hotch = Hotch.new($0)
+hotch.start
+
+hotch.report_at_exit(viewer)

data/lib/hotch/version.rb

@@ -1,3 +1,3 @@
 module Hotch
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Peter Suschlik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-04 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stackprof
@@ -64,8 +64,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/simple.rb
 - hotch.gemspec
 - lib/hotch.rb
+- lib/hotch/run.rb
 - lib/hotch/version.rb
 homepage: https://github.com/splattael/hotch
 licenses:
@@ -87,9 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Profile helper
 test_files: []
-has_rdoc: