stack_tracy 0.1.0

data/lib/stack_tracy/core_ext/kernel.rb

@@ -0,0 +1,24 @@
+module Kernel
+
+  def stack_tracy(arg = nil, options = {})
+    if arg.is_a?(Hash)
+      options = arg
+      arg = nil
+    end
+    StackTracy.start options
+    yield
+    StackTracy.stop
+    if arg == :print
+      StackTracy.print
+    elsif arg == :dump
+      StackTracy.dump
+    elsif arg == :open
+      file = StackTracy.dump Dir::tmpdir
+      StackTracy.open file, true
+    elsif arg.is_a? String
+      StackTracy.dump arg
+    end
+    nil
+  end
+
+end

data/lib/stack_tracy/event_info.rb

@@ -0,0 +1,72 @@
+# See http://stackoverflow.com/questions/9607554/ruby-invalid-byte-sequence-in-utf-8
+
+# encoding: UTF-8
+
+module StackTracy
+  class EventInfo
+    attr_reader :event, :file, :line, :singleton, :object, :method, :nsec
+
+    def self.to_hashes(csv)
+      CSV.parse(csv.force_encoding("ISO-8859-1").encode("utf-8", replace: nil), :headers => true, :col_sep => ";").collect do |row|
+        {
+          :event => row[0]     , :file => row[1]     , :line => row[2].to_i, :singleton => row[3] == "true", :object   => row[4]      , :method => row[5],
+          :nsec  => row[6].to_f, :time => row[7].to_f, :call => row[8]     , :depth     => row[9].to_i     , :duration => row[10].to_f
+        }
+      end
+    end
+
+    def call?
+      !!event.match(/call$/)
+    end
+
+    def return?
+      !!event.match(/return$/)
+    end
+
+    def matches?(arg)
+      case arg.class.name
+      when "StackTracy::EventInfo"
+        matches? arg.call
+      when "String"
+        if call == arg
+          true
+        else
+          captures = arg.match(/^([\w:]*\*?)?(\.|\#)?(\w*\*?)?$/).captures
+          object_match?(captures[0]) && singleton_match?(captures[1]) && method_match?(captures[2])
+        end
+      else
+        false
+      end
+    end
+
+    def -(other)
+      nsec - other.nsec if other.is_a? EventInfo
+    end
+
+    def to_hash(first = nil)
+      {
+        :event => event, :file => file, :line => line, :singleton => singleton, :object => object,
+        :method => method, :nsec => nsec, :time => (first ? self - first : nil), :call => call
+      }
+    end
+
+    def call
+      "#{object}#{singleton ? "." : "#"}#{method}"
+    end
+
+  private
+
+    def object_match?(arg)
+      (arg.to_s == "") || (object.name =~ /^#{arg.gsub("*", "#{"\\w*" if arg == "*"}(::\\w*)*")}$/)
+    end
+
+    def singleton_match?(arg)
+      arg.nil? || ((singleton ? "." : "#") == arg)
+    end
+
+    def method_match?(arg)
+      (arg.to_s == "") || (method =~ /^#{arg.gsub("*", "\\w*")}$/)
+    end
+
+  end
+end

data/lib/stack_tracy/sinatra.rb

@@ -0,0 +1,36 @@
+module StackTracy
+  class Sinatra
+
+    def initialize(app, arg = nil, options = {}, &before_filter)
+      @app = app
+      @arg = arg
+      @options = options
+      @before_filter = before_filter if block_given?
+    end
+
+    def call(env)
+      request = ::Sinatra::Request.new env
+      if request.path.match /^\/tracy-?(.*)?/
+        return open($1)
+      end
+
+      if @before_filter.nil? || !!@before_filter.call(request.path, request.params)
+        result = nil
+        stack_tracy @arg || Dir::tmpdir, @options do
+          result = @app.call(env)
+        end
+        result
+      else
+        @app.call(env)
+      end
+    end
+
+  private
+
+    def open(match)
+      StackTracy.open match.to_s.empty? ? nil : match, (match.to_s.empty? && @arg.to_s != "dump" && !StackTracy.stack_trace.empty?)
+      [200, {"Content-Type" => "text/html;charset=utf-8", "Content-Length" => Rack::Utils.bytesize("").to_s}, ""]
+    end
+
+  end
+end

data/lib/stack_tracy/version.rb

@@ -0,0 +1,7 @@
+module StackTracy #:nodoc:
+  MAJOR = 0
+  MINOR = 1
+  TINY  = 0
+
+  VERSION = [MAJOR, MINOR, TINY].join(".")
+end

data/script/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+`cd ext/stack_tracy && ruby extconf.rb`
+`cd ext/stack_tracy && make`
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :gem_default, :gem_development
+
+puts "Loading development environment (StackTracy #{StackTracy::VERSION})"
+
+Pry.start

data/stack_tracy.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Engel"]
+  gem.email         = ["paul.engel@holder.nl"]
+  gem.summary       = %q{Investigate and detect slow methods within the stack trace of your Ruby (optionally Sinatra) application}
+  gem.description   = %q{Investigate and detect slow methods within the stack trace of your Ruby (optionally Sinatra) application}
+  gem.homepage      = "https://github.com/archan937/stack_tracy"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.extensions    = ["ext/stack_tracy/extconf.rb"]
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "stack_tracy"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.1.0"
+
+  gem.add_dependency "rich_support", "~> 0.1.2"
+  gem.add_dependency "launchy", "2.1.0"
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler"
+
+require "minitest/unit"
+require "minitest/autorun"
+
+Bundler.require :gem_default, :gem_test

data/test/unit/test_kernel.rb

@@ -0,0 +1,13 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+module Unit
+  class TestKernel < MiniTest::Unit::TestCase
+
+    describe Kernel do
+      it "should respond to stack_tracy and behave as expected" do
+        assert Kernel.respond_to?(:stack_tracy)
+      end
+    end
+
+  end
+end

data/test/unit/test_tracy.rb

@@ -0,0 +1,261 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+module Unit
+  class TestTracy < MiniTest::Unit::TestCase
+
+    describe StackTracy do
+      after do
+        StackTracy.config do |c|
+          c.only = nil
+          c.exclude = nil
+        end
+      end
+
+      it "should respond to methods as expected" do
+        assert StackTracy.respond_to?(:config)
+        assert StackTracy.respond_to?(:start)
+        assert StackTracy.respond_to?(:stop)
+        assert StackTracy.respond_to?(:stack_trace)
+        assert StackTracy.respond_to?(:select)
+        assert StackTracy.respond_to?(:print)
+        assert StackTracy.respond_to?(:dump)
+        assert StackTracy.respond_to?(:open)
+      end
+
+      it "should be configurable" do
+        StackTracy.config do |c|
+          assert_equal true, c.is_a?(Struct)
+          assert_equal [:dump_dir, :only, :exclude], c.members
+          c.only = "Kernel"
+          c.exclude = ["IO", "String"]
+        end
+
+        assert_equal({:only => "Kernel", :exclude => ["IO", "String"]}, StackTracy.send(:merge_options))
+        assert_equal({:only => "Object", :exclude => ["IO", "String"]}, StackTracy.send(:merge_options, {:only => "Object"}))
+        assert_equal({:only => "Object", :exclude => nil}, StackTracy.send(:merge_options, {:only => "Object", :exclude => nil}))
+        assert_equal({:only => "Paul", :exclude => "Foo"}, StackTracy.send(:merge_options, {"only" => "Paul", "exclude" => "Foo"}))
+        assert_equal({:only => nil, :exclude => nil}, StackTracy.send(:merge_options, {:only => nil, :exclude => nil}))
+
+        assert_equal(
+          "Array BasicObject Enumerable Fixnum Float Foo Hash IO Integer Kernel Module Mutex Numeric Object Rational String Symbol Thread Time",
+          StackTracy.send(:mod_names, [:core, "Foo"])
+        )
+
+        assert_equal(
+          "ActiveRecord::Base",
+          StackTracy.send(:mod_names, :active_record)
+        )
+
+        assert_equal(
+          "DataMapper::Resource",
+          StackTracy.send(:mod_names, :data_mapper)
+        )
+      end
+
+      it "should have the expected stack trace" do
+        stack_tracy do
+          puts "testing"
+        end
+        file, line = __FILE__, __LINE__ - 2
+
+        assert_equal [
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts" , :call => "Kernel#puts"},
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => IO    , :method => "puts" , :call => "IO#puts"    },
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   },
+          {:event => "c-return", :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   },
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   },
+          {:event => "c-return", :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   },
+          {:event => "c-return", :file => file, :line => line, :singleton => false, :object => IO    , :method => "puts" , :call => "IO#puts"    },
+          {:event => "c-return", :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts" , :call => "Kernel#puts"}
+        ], StackTracy.stack_trace.collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            hash.delete(:time)
+          end
+        }
+
+        assert StackTracy.stack_trace.first.call?
+        assert !StackTracy.stack_trace.last.call?
+
+        assert !StackTracy.stack_trace.first.return?
+        assert StackTracy.stack_trace.last.return?
+
+        StackTracy.config do |c|
+          c.exclude = ["IO"]
+        end
+        stack_tracy do
+          puts "testing"
+        end
+        file, line = __FILE__, __LINE__ - 2
+
+        assert_equal [
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts" , :call => "Kernel#puts"},
+          {:event => "c-return", :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts" , :call => "Kernel#puts"}
+        ], StackTracy.stack_trace.collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            hash.delete(:time)
+          end
+        }
+
+        StackTracy.config do |c|
+          c.exclude = :core
+        end
+        stack_tracy do
+          puts "testing"
+        end
+
+        assert_equal true, StackTracy.stack_trace.empty?
+      end
+
+      it "should return a printable version of the stack trace" do
+        stack_tracy do
+          puts "testing"
+        end
+        file, line = __FILE__, __LINE__ - 2
+
+        assert_equal [
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts" , :call => "Kernel#puts", :depth => 0},
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => IO    , :method => "puts" , :call => "IO#puts"    , :depth => 1},
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   , :depth => 2},
+          {:event => "c-call"  , :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   , :depth => 2}
+        ], StackTracy.select.collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+      end
+
+      it "should filter methods as expected" do
+        stack_tracy do
+          puts "testing"
+        end
+        file, line = __FILE__, __LINE__ - 2
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts" , :call => "Kernel#puts", :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO    , :method => "puts" , :call => "IO#puts"    , :depth => 1},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   , :depth => 2},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   , :depth => 2}
+        ], StackTracy.select("*").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts", :call => "Kernel#puts", :depth => 0}
+        ], StackTracy.select("Kernel").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "puts" , :call => "IO#puts" , :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 1},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 1}
+        ], StackTracy.select("IO").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "puts" , :call => "IO#puts" , :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 1},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 1}
+        ], StackTracy.select("IO*").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+        ], StackTracy.select("I*").collect{ |event_info|
+          event_info.to_hash
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "puts" , :call => "IO#puts" , :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 1},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 1}
+        ], StackTracy.select("IO#").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 0}
+        ], StackTracy.select("IO#w*").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO, :method => "write", :call => "IO#write", :depth => 0}
+        ], StackTracy.select("IO#write").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts", :call => "Kernel#puts", :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO    , :method => "puts", :call => "IO#puts"    , :depth => 1}
+        ], StackTracy.select("*#puts").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts" , :call => "Kernel#puts", :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   , :depth => 1},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   , :depth => 1}
+        ], StackTracy.select(%w(Kernel #write)).collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+
+        assert_equal [
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => Kernel, :method => "puts" , :call => "Kernel#puts", :depth => 0},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   , :depth => 1},
+          {:event => "c-call", :file => file, :line => line, :singleton => false, :object => IO    , :method => "write", :call => "IO#write"   , :depth => 1}
+        ], StackTracy.select("Kernel IO#write").collect{ |event_info|
+          event_info.to_hash.tap do |hash|
+            assert hash.delete(:nsec)
+            assert hash.delete(:duration)
+            hash.delete(:time)
+          end
+        }
+      end
+    end
+
+  end
+end