hotch 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a8f4b895fb76ef2998f7d51ce4a1725723649839b655a46e261e6b5d8bbd7a7
-  data.tar.gz: 55e5919e466022d1427d607d12fc8929248ceb4ad9c6716d0cfba9bc1cafe11e
+  metadata.gz: 3eb97e655dfb1434f9daca5881a176396784567b38767a4b0565ae5de04dfe89
+  data.tar.gz: c213f3fb8ffa21cf24ee59bab49f726ca79dfeac8b72c336cee3dc865b3e1714
 SHA512:
-  metadata.gz: 21af11cc4cdfbab13d13cbe882cfc0bd28aecc72a746ae613c21031911d07d386cf2bc328ac165861517501681db221564b971b8f3658c354ffb7ac6633f7f0d
-  data.tar.gz: 6f43595863fb4975d6fd3fd632e7c920d1628d5a659349f433ec9b16b003d43c4de187ac25011a71d2f0c44bf6591ec4b03f6c9bc0d36ec47685fd9dc0904fec
+  metadata.gz: 463f7514b9afb0cea840fec91bf08d410380ef08fbe08040b50ee59ad90ff31186fe0185f124cb1db7042def01818ac215ae66fa922a995dfc47b5f193d25b16
+  data.tar.gz: 64994356dbfb2bfad732eeaf42b4e698bf002409de0a943b6fa2af31fc5de9a42c9ad3627f95250369d69adecbbb76a256fc69370dc13aabc9e125f468a10ea8

data/.github/workflows/examples.yml

@@ -0,0 +1,32 @@
+name: Test examples
+on:
+  - push
+  - pull_request
+jobs:
+  run:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+        runs-on:
+          - ubuntu-latest
+    name: ${{ matrix.ruby-version}} on ${{ matrix.runs-on }}
+    runs-on: ${{ matrix.runs-on }}
+    steps:
+      - uses: actions/checkout@master
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install system dependencies
+        run: |
+          sudo apt install --yes graphviz
+      - name: Install dependencies
+        run: |
+          bundle install
+      - name:
+        run: |
+          bundle exec rake test:examples

data/.github/workflows/rubocop.yml

@@ -0,0 +1,27 @@
+name: RuboCop
+on:
+  - push
+  - pull_request
+jobs:
+  run:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - "3.1"
+        runs-on:
+          - ubuntu-latest
+    name: ${{ matrix.ruby-version}} on ${{ matrix.runs-on }}
+    runs-on: ${{ matrix.runs-on }}
+    steps:
+      - uses: actions/checkout@master
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: |
+          bundle install
+      - name:
+        run: |
+          bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,33 @@
+---
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+Layout/ArrayAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Style/Documentation:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-12-12 12:04:13 UTC using RuboCop version 1.38.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/StructNewOverride:
+  Exclude:
+    - 'lib/hotch/memory.rb'
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 2
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Exclude:
+    - 'lib/hotch.rb'
+    - 'lib/hotch/memory.rb'

data/Gemfile

@@ -1,6 +1,8 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in hotch.gemspec
 gemspec
 
-gem 'stackprof'
+gem "minitest"

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.6.0'
+gem 'hotch', '~> 0.7.0'
 ```
 
 And then execute:
@@ -209,9 +209,9 @@ Load `hotch/memory/minitest` in your `test/test_helper.rb` like this:
 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
+Hotch::Memory::Minitest.run
+Hotch::Memory::Minitest.run(name: "my name")
+Hotch::Memory::Minitest.run(disable_gc: false) # on by default
 ```
 
 

data/Rakefile

@@ -1,8 +1,27 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
-task :default => :test
+task default: :test
 
 desc "Run tests. Not yet..."
 task :test do
   abort "No tests yet. Sorry :-("
 end
+
+desc "Run examples"
+namespace :test do
+  desc "Run files in examples/"
+  task :examples do
+    chdir "examples" do
+      ENV["HOTCH_VIEWER"] = nil
+
+      Dir.glob("*.rb").sort.each do |file|
+        puts "=" * 80
+        sh "bundle", "exec", "ruby", file
+
+        puts
+      end
+    end
+  end
+end

data/examples/bundler.rb

@@ -1,4 +1,6 @@
-require 'bundler'
-require 'hotch'
+# frozen_string_literal: true
+
+require "bundler"
+require "hotch"
 
 # run via ruby -rhotch/run bundler.rb

data/examples/example_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "hotch/minitest"
+require "hotch/memory/minitest"
+
+Hotch::Minitest.run
+Hotch::Memory::Minitest.run
+
+class ExampleTest < Minitest::Test
+  def foo
+    "x" * 23
+  end
+
+  def bar
+    ["x"] * 23
+  end
+
+  def test_hotch
+    10_000.times do
+      foo
+      bar
+    end
+
+    assert true
+  end
+end

data/examples/memory_at_exit.rb

@@ -1,4 +1,6 @@
-require 'hotch/memory'
+# frozen_string_literal: true
+
+require "hotch/memory"
 
 ary = []
 

data/examples/memory_inline_report.rb

@@ -1,4 +1,6 @@
-require 'hotch/memory'
+# frozen_string_literal: true
+
+require "hotch/memory"
 
 ary = []
 

data/examples/simple.rb

@@ -1,6 +1,8 @@
-require 'hotch'
+# frozen_string_literal: true
 
-COUNT = ENV.fetch('COUNT', 10_000)
+require "hotch"
+
+COUNT = ENV.fetch("COUNT", 1_000_000)
 
 def foo
   "x" * 23
@@ -16,7 +18,7 @@ Hotch(aggregate: false) do
   end
 end
 
-Hotch() do
+Hotch(mode: :cpu) do
   COUNT.times do
     bar
   end

data/hotch.gemspec

@@ -1,26 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+# frozen_string_literals: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hotch/version'
+require "hotch/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "hotch"
   spec.version       = Hotch::VERSION
   spec.authors       = ["Peter Leitzen"]
   spec.email         = ["peter@leitzen.de"]
-  spec.summary       = %q{Profile helper}
-  spec.description   = %q{Callstack and memory profiler}
+  spec.summary       = "Profile helper"
+  spec.description   = "Callstack and memory profiler"
   spec.homepage      = "https://github.com/splattael/hotch"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "stackprof", "~> 0.2.15"
+  spec.required_ruby_version = ">= 2.7.0"
+
   spec.add_runtime_dependency "allocation_tracer", "~> 0.6.3"
+  spec.add_runtime_dependency "stackprof", "~> 0.2.15"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-minitest"
+  spec.add_development_dependency "rubocop-rake"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/hotch/memory/minitest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hotch/memory"
 
 class Hotch

data/lib/hotch/memory/run.rb

@@ -1,3 +1,5 @@
-require 'hotch/memory'
+# frozen_string_literal: true
 
-Hotch.memory(name: $0)
+require "hotch/memory"
+
+Hotch.memory(name: $PROGRAM_NAME)

data/lib/hotch/memory.rb

@@ -1,7 +1,10 @@
-require 'allocation_tracer'
+# frozen_string_literal: true
+
+require "allocation_tracer"
+require "stringio"
 
 class Hotch
-  def self.memory(name: $0, aggregate: true, &block)
+  def self.memory(name: $PROGRAM_NAME, aggregate: true, &block)
     memory = if aggregate
                $hotch_memory ||= Memory.new(name)
              else
@@ -29,19 +32,23 @@ class Hotch
     end
 
     def self.report(name, **args, &block)
-      new(name, **args).run(&block).report
+      hotch = new(name, **args)
+      hotch.run(&block)
+      hotch.report
     end
 
     def start
       return if @started
+
       GC.disable if @disable_gc
-      ObjectSpace::AllocationTracer.setup [:path, :line, :type]
+      ObjectSpace::AllocationTracer.setup %i[path line type]
       ObjectSpace::AllocationTracer.start
       @started = true
     end
 
     def stop
       return unless @started
+
       results = ObjectSpace::AllocationTracer.stop
       @started = nil
       GC.enable if @disable_gc
@@ -51,13 +58,12 @@ class Hotch
     def run
       start
       yield
-      self
     ensure
       stop
     end
 
     def report
-      # TODO make it persistent (as CSV)
+      # TODO: make it persistent (as CSV)
       report = @reports.inject(:+)
       @reports.clear
 
@@ -85,7 +91,7 @@ class Hotch
     private
 
     def name
-      @name.gsub(/\W+/, '_')
+      @name.gsub(/\W+/, "_")
     end
 
     class Report
@@ -99,9 +105,9 @@ class Hotch
       end
 
       def +(other)
-        by_key = Hash[@lines.map { |line| [line.key, line] }]
+        by_key = @lines.to_h { |line| [line.key, line] }
         other.lines.each do |line|
-          if existing = by_key[line.key]
+          if (existing = by_key[line.key])
             existing.sum(line)
           else
             by_key[line.key] = line
@@ -112,7 +118,7 @@ class Hotch
       end
 
       def format
-        # TODO refactor
+        # TODO: refactor
         max_lengths = Array.new(Line.members.size, 0)
         ([@header, @total] + @lines).each do |line|
           line.lengths.each.with_index do |length, i|
@@ -136,17 +142,11 @@ class Hotch
         io.string
       end
 
-      private def total!
-        return if defined? @total
-
-        @total = Line::Total.new
-        @lines.each do |line|
-          @total.sum(line)
-        end
-      end
-
+      # rubocop:disable Style/StructInheritance
       class Line < Struct.new(:filename, :type, :count, :old_count, :total_age,
                               :min_age, :max_age, :total_memsize)
+        # rubocop:enable Style/StructInheritance
+
         # [
         #   [path, lineno, type],
         #   [count, old_count, total_age, min_age, max_age, total_memsize]
@@ -154,7 +154,8 @@ 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
 
@@ -177,15 +178,15 @@ class Hotch
           end
         end
 
-        private
-
         MAX_PATH_LENGTH = 50
         def self.strip_path(path)
+          return "?" unless path
+
           strip = %r{#{Regexp.union($LOAD_PATH)}/?}
           path.gsub!(strip, "")
           if path.size > MAX_PATH_LENGTH + 3
-            # TODO Refactor
-            "..." + path[-MAX_PATH_LENGTH..-1]
+            # TODO: Refactor
+            "...#{path[-MAX_PATH_LENGTH..]}"
           else
             path
           end
@@ -197,6 +198,17 @@ class Hotch
           end
         end
       end
+
+      private
+
+      def total!
+        return if defined? @total
+
+        @total = Line::Total.new
+        @lines.each do |line|
+          @total.sum(line)
+        end
+      end
     end
   end
 end

data/lib/hotch/minitest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hotch"
 
 class Hotch

data/lib/hotch/run.rb

@@ -1,6 +1,8 @@
-require 'hotch'
+# frozen_string_literal: true
 
-hotch = Hotch.new($0, viewer: ENV['HOTCH_VIEWER'], filter: ENV['HOTCH_FILTER'])
+require "hotch"
+
+hotch = Hotch.new($PROGRAM_NAME, viewer: ENV.fetch("HOTCH_VIEWER", nil), filter: ENV.fetch("HOTCH_FILTER", nil))
 hotch.start
 
 hotch.report_at_exit

data/lib/hotch/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Hotch
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/hotch.rb

@@ -1,33 +1,39 @@
-require 'stackprof'
-require 'tmpdir'
+# frozen_string_literal: true
 
-require 'hotch/version'
+require "stackprof"
+require "tmpdir"
+
+require "hotch/version"
 
 class Hotch
-  attr_reader :name, :viewer, :filter, :options
+  attr_reader :viewer, :filter, :options
 
-  def initialize(name, viewer: nil, filter: nil, options: {})
+  def initialize(name, viewer: nil, mode: :wall, filter: nil, options: {})
     @name = name
     @viewer = viewer
     @options = options
     @reports = []
+    @mode = mode
 
     @options[:filter] = Regexp.new(filter) if filter
   end
 
-  def start(*args)
-    StackProf.start(*args) unless StackProf.running?
+  def start(**options)
+    return if StackProf.running?
+
+    stackprof = { mode: @mode }.merge(options)
+    StackProf.start(**stackprof)
   end
 
   def stop
-    if StackProf.running?
-      StackProf.stop
-      @reports << StackProf::Report.new(results)
-    end
+    return unless StackProf.running?
+
+    StackProf.stop
+    @reports << StackProf::Report.new(results)
   end
 
-  def run(*args)
-    start(*args)
+  def run(...)
+    start(...)
     yield
   ensure
     stop
@@ -48,11 +54,9 @@ class Hotch
 
     @reports.clear
 
-    if block_given?
-      yield report, svg
-    else
-      return report, svg
-    end
+    return report, svg unless block_given?
+
+    yield report, svg
   end
 
   def report_at_exit
@@ -77,7 +81,7 @@ class Hotch
   private
 
   def name
-    @name.gsub(/\W+/, '_')
+    @name.gsub(/\W+/, "_")
   end
 
   def report_dump(report, dir, file)
@@ -98,26 +102,25 @@ class Hotch
     svg
   end
 
-  def write_file(dir, file)
+  def write_file(dir, file, &block)
     path = File.join(dir, file)
-    File.open(path, 'wb') do |fh|
-      yield fh
-    end
+    File.open(path, "wb", &block)
     path
   end
 end
 
-def Hotch(name: $0, aggregate: true, viewer: ENV['HOTCH_VIEWER'], filter: ENV['HOTCH_FILTER'], options: {})
+# rubocop:disable Naming/MethodName
+def Hotch(name: $PROGRAM_NAME, aggregate: true, viewer: ENV.fetch("HOTCH_VIEWER", nil), mode: :wall,
+  filter: ENV.fetch("HOTCH_FILTER", nil), options: {}, &block)
   hotch = if aggregate
-    $hotch ||= Hotch.new(name, viewer: viewer, filter: filter, options: options)
-  else
-    caller = Kernel.caller_locations(1).first
-    name = "#{name}:#{caller.path}:#{caller.lineno}"
-    Hotch.new(name, viewer: viewer, filter: filter, options: options)
-  end
+            $hotch ||= Hotch.new(name, viewer: viewer, mode: mode, filter: filter, options: options)
+          else
+            caller = Kernel.caller_locations(1).first
+            name = "#{name}:#{caller.path}:#{caller.lineno}"
+            Hotch.new(name, viewer: viewer, filter: filter, options: options)
+          end
 
   hotch.report_at_exit
-  hotch.run do
-    yield
-  end
+  hotch.run(&block)
 end
+# rubocop:enable Naming/MethodName

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hotch
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Peter Leitzen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-22 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: stackprof
+  name: allocation_tracer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.15
+        version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.15
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
-  name: allocation_tracer
+  name: stackprof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.2.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.2.15
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,58 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Callstack and memory profiler
 email:
 - peter@leitzen.de
@@ -73,12 +115,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/examples.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - examples/bundler.rb
+- examples/example_test.rb
 - examples/memory_at_exit.rb
 - examples/memory_inline_report.rb
 - examples/simple.rb
@@ -95,7 +142,8 @@ files:
 homepage: https://github.com/splattael/hotch
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -104,14 +152,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Profile helper