hotch 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cddf426d75da3636d92f176d184821f53d22e7e
-  data.tar.gz: a2c6938c26820426a7bbae6bb608546694375b82
+  metadata.gz: 0b46853925c0b06868a85c1f41b6464304d64c89
+  data.tar.gz: 2a75ea05ef514b527dc058de2252808b5074811d
 SHA512:
-  metadata.gz: 44e05ae09f915021df7ba163b68831be51f3cdeffbe839ccca9aee326caf494d2d0b705ea8f5f0f0e899b05f0b7bcf2c1d630be24f17118c30dfc0ef5ad314b9
-  data.tar.gz: 879ef47c33c0e7843846970e6b9e50e28663a229f5d7da307a66b71807549e5f213a87f75143605045a862105babc836f76644f9a49d7a174ed2ba49db081eb9
+  metadata.gz: 6419725e1737e5d1c662ff5ea6b2741817b041033c95f6961376d5427f3331ce05c18e8502b62299ce43b2b71616c9e96153ccc0327383da7815a983dc82b8a8
+  data.tar.gz: a2b344453ac3f59902b521dcb5066e5c98d40e0f1ead60c4d5a3c21534cf97f75be5eb6301483e87770444972ace8e3e68cbac45e72163f021117eb18d0836a0

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.2'
+gem 'hotch', '~> 0.5.0'
 ```
 
 And then execute:
@@ -162,9 +162,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 +171,29 @@ 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
+```
+
+### 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
 ```
 
 

data/lib/hotch/memory.rb

@@ -1,10 +1,14 @@
 require 'allocation_tracer'
 
 class Hotch
-  def self.memory(name: $0, &block)
-    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
 
@@ -16,15 +20,17 @@ class Hotch
   end
 
   class Memory
-    def initialize(name, ignore_paths: [])
+    def initialize(name, ignore_paths: [], disable_gc: true)
       @name = name
       @ignore_paths = Array(ignore_paths || [])
       @reports = []
       @started = nil
+      @disable_gc = disable_gc
     end
 
     def start
       return if @started
+      GC.disable if @disable_gc
       ObjectSpace::AllocationTracer.setup [:path, :line, :type]
       ObjectSpace::AllocationTracer.start
       @started = true
@@ -34,6 +40,7 @@ class Hotch
       return unless @started
       results = ObjectSpace::AllocationTracer.stop
       @started = nil
+      GC.enable if @disable_gc
       @reports << Report.new(results, @ignore_paths)
     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/version.rb

@@ -1,3 +1,3 @@
 class Hotch
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotch
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Peter Suschlik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stackprof
@@ -85,6 +85,7 @@ files:
 - images/dry-validation.profile_schema_call_valid.svg
 - lib/hotch.rb
 - lib/hotch/memory.rb
+- lib/hotch/memory/minitest.rb
 - lib/hotch/minitest.rb
 - lib/hotch/run.rb
 - lib/hotch/version.rb
@@ -108,9 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Profile helper
 test_files: []
-has_rdoc: