gestalt 0.0.1 → 0.0.2

data/README.rdoc

@@ -26,10 +26,15 @@ You have a feeling that it could do better with single, so check to see what hap
   end
 
 This will give you output in the following format:
-  duration method file
-    duration method file
+  percentage times method file
+    percentage times method file
 
-The duration on the outermost call is the total for all nested calls, and the duration of the indented lines show how long the individual parts took.
+percentage is the percent of the parent that these calls account for
+times is how many times the thing was called
+method tells you what was called
+and file tells you where it was called from
+
+Indents means nesting, durations for outer calls include inner calls and the times for inner calls happened for each of the outer calls.
 
 You can also get a summary after the fact:
 

data/Rakefile

@@ -1,49 +1,147 @@
 require 'rubygems'
 require 'rake'
+require 'date'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "gestalt"
-    gem.summary = %Q{Simple Ruby profiling}
-    gem.description = %Q{Simple Ruby profiling}
-    gem.email = "wbeary@engineyard.com"
-    gem.homepage = "http://github.com/geemus/gestalt"
-    gem.authors = ["geemus (Wesley Beary)"]
-    gem.add_dependency "formatador", ">= 0.0.12"
-    gem.add_development_dependency "shindo", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
 end
 
-require 'shindo/rake'
-Shindo::Rake.new
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |tests|
-    tests.libs << 'tests'
-    tests.pattern = 'tests/**/*_tests.rb'
-    tests.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: gem install spicycode-rcov"
-  end
+def date
+  Date.today.to_s
 end
 
-task :tests => :check_dependencies
+def rubyforge_project
+  name
+end
 
-task :default => :tests
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "gestalt #{version}"
+  rdoc.title = "#{name} #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "sudo gem install pkg/#{name}-#{version}.gem"
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/gestalt.gemspec

@@ -1,54 +1,76 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
 Gem::Specification.new do |s|
-  s.name = %q{gestalt}
-  s.version = "0.0.1"
-
+  s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["geemus (Wesley Beary)"]
-  s.date = %q{2010-04-12}
-  s.description = %q{Simple Ruby profiling}
-  s.email = %q{wbeary@engineyard.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    ".gitignore",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "gestalt.gemspec",
-    "lib/gestalt.rb",
-    "lib/gestalt/call.rb",
-    "tests/gestalt_tests.rb",
-    "tests/tests_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/geemus/gestalt}
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'gestalt'
+  s.version           = '0.0.2'
+  s.date              = '2010-04-26'
+  s.rubyforge_project = 'gestalt'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Simple Ruby profiling and tracing."
+  s.description = "Simple Ruby profiling and tracing."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["geemus (Wesley Beary)"]
+  s.email    = 'geemus@gmail.com'
+  s.homepage = 'http://github.com/geemus/NAME'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## This sections is only necessary if you have C extensions.
+  # s.require_paths << 'ext'
+  # s.extensions = %w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  # s.executables = ["name"]
+  # s.default_executable = 'name'
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
   s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Simple Ruby profiling}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<formatador>, [">= 0.0.12"])
-      s.add_development_dependency(%q<shindo>, [">= 0"])
-    else
-      s.add_dependency(%q<formatador>, [">= 0.0.12"])
-      s.add_dependency(%q<shindo>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<formatador>, [">= 0.0.12"])
-    s.add_dependency(%q<shindo>, [">= 0"])
-  end
-end
+  s.extra_rdoc_files = %w[README.rdoc]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency("formatador", ">= 0.0.12")
 
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency("shindo", ">= 0")
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.rdoc
+    Rakefile
+    gestalt.gemspec
+    lib/gestalt.rb
+    lib/gestalt/call.rb
+    tests/gestalt_tests.rb
+    tests/tests_helper.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^[spec|tests]\/.*_[spec|tests]\.rb/ }
+end

data/lib/gestalt/call.rb

@@ -2,7 +2,7 @@ class Gestalt
 
   class Call
 
-    attr_accessor :children
+    attr_accessor :children, :durations
     attr_accessor :action, :finished_at, :location, :started_at
 
     def initialize(attributes = {})
@@ -11,19 +11,48 @@ class Gestalt
         send("#{key}=", value)
       end
       @children ||= []
+      @durations ||= []
     end
 
-    def display(formatador = Formatador.new)
-      formatador.display_line("#{format("%.6f",duration)}  [bold]#{action}[/]  [light_black]#{location}[/]")
+    def ==(other)
+      action == other.action && location == other.location && children == other.children
+    end
+
+    def display(total, formatador = Formatador.new)
+      data = []
+      data << format("[bold]%.1f%%[/]", (duration / total) * 100.0)
+      if durations.length > 1
+        data << "[light_black]#{durations.length}x[/]"
+      end
+      data << "[bold]#{action}[/]"
+      data << "[light_black]#{location}[/]"
+      condensed = []
+      total = 0.0
+      for call in children
+        if condensed.last && condensed.last == call
+          condensed.last.durations.concat(call.durations)
+        else
+          condensed << call
+        end
+        total += call.duration
+      end
+      formatador.display_line(data.join('  '))
       formatador.indent do
-        for child in children
-          child.display(formatador)
+        for child in condensed
+          child.display(total, formatador)
         end
       end
     end
 
     def duration
-      finished_at - started_at
+      durations.inject(0.0) {|memo, duration| duration + memo}
+    end
+
+    def durations
+      if @durations.empty?
+        @durations << finished_at - started_at
+      end
+      @durations
     end
 
     def finish

data/lib/gestalt.rb

@@ -5,7 +5,9 @@ require 'formatador'
 
 class Gestalt
 
-  attr_accessor :calls
+  VERSION = '0.0.2'
+
+  attr_accessor :calls, :formatador
 
   def initialize
     @calls = []
@@ -14,11 +16,21 @@ class Gestalt
   end
 
   def display_calls
-    Formatador.display_line
+    formatador.display_line
+    condensed = []
+    total = 0.0
     for call in @calls
-      call.display
+      if condensed.last && condensed.last == call
+        condensed.last.durations.concat(call.durations)
+      else
+        condensed << call
+      end
+      total += call.duration
+    end
+    for call in condensed
+      call.display(total, formatador)
     end
-    Formatador.display_line
+    formatador.display_line
   end
 
   def display_profile
@@ -29,16 +41,19 @@ class Gestalt
     table = []
     for key, value in @totals
       table << {
-        '#' => value[:occurances],
-        :action => key,
+        :action => "#{value[:occurances]}x #{key}",
         :duration => format("%.6f", value[:duration])
       }
     end
     table = table.sort {|x,y| y[:duration] <=> x[:duration]}
 
-    Formatador.display_line
-    Formatador.display_table(table)
-    Formatador.display_line
+    formatador.display_line
+    formatador.display_table(table)
+    formatador.display_line
+  end
+
+  def formatador
+    @formatador ||= Formatador.new
   end
 
   def run(&block)
@@ -68,6 +83,7 @@ class Gestalt
       end
     )
     yield
+    rescue StandardError, Interrupt
     Kernel.set_trace_func(nil)
     @stack.pop # pop Kernel#set_trace_func(nil)
     unless @stack.empty?
@@ -107,15 +123,26 @@ end
 
 if __FILE__ == $0
 
+  Gestalt.trace do
+    raise StandardError.new('exception')
+    slow = Slow.new
+    slow.slowing
+  end
+
   class Slow
 
-    def single
-      'slow' << 'er'
+    def slow(est = false)
+      unless est
+        'slow' << 'e' << 'r'
+      else
+        'slow' << 'e' << 's' << 't'
+      end
     end
 
-    def double
-      single
-      single
+    def slowing
+      slow
+      slow
+      slow(true)
     end
 
   end
@@ -123,14 +150,14 @@ if __FILE__ == $0
   Gestalt.trace do
 
     slow = Slow.new
-    slow.single
+    slow.slowing
 
   end
 
   Gestalt.profile do
 
     slow = Slow.new
-    slow.double
+    slow.slowing
 
   end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - geemus (Wesley Beary)
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-12 00:00:00 -07:00
+date: 2010-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,29 +43,25 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: Simple Ruby profiling
-email: wbeary@engineyard.com
+description: Simple Ruby profiling and tracing.
+email: geemus@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.rdoc
 files: 
-- .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - gestalt.gemspec
 - lib/gestalt.rb
 - lib/gestalt/call.rb
 - tests/gestalt_tests.rb
 - tests/tests_helper.rb
 has_rdoc: true
-homepage: http://github.com/geemus/gestalt
+homepage: http://github.com/geemus/NAME
 licenses: []
 
 post_install_message: 
@@ -89,10 +85,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: gestalt
 rubygems_version: 1.3.6
 signing_key: 
-specification_version: 3
-summary: Simple Ruby profiling
+specification_version: 2
+summary: Simple Ruby profiling and tracing.
 test_files: []
 

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,39 +0,0 @@
-# rcov generated
-coverage
-
-# rdoc generated
-rdoc
-
-# yard generated
-doc
-.yardoc
-
-# jeweler generated
-pkg
-
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
-#
-# * Create a file at ~/.gitignore
-# * Include files you want ignored
-# * Run: git config --global core.excludesfile ~/.gitignore
-#
-# After doing this, these files will be ignored in all your git projects,
-# saving you from having to 'pollute' every project you touch with them
-#
-# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
-#
-# For MacOS:
-#
-#.DS_Store
-#
-# For TextMate
-#*.tmproj
-#tmtags
-#
-# For emacs:
-#*~
-#\#*
-#.\#*
-#
-# For vim:
-#*.swp

data/VERSION

@@ -1 +0,0 @@
-0.0.1