profiler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58258bcebbf6b14691ad6d8341420b5dd937b72a
+  data.tar.gz: 92c30edb79f42cee34c2a37722a3755fab371c4b
+SHA512:
+  metadata.gz: dafdc17bd578221193b2ea2847e4db54827580d9e08c34377a2f7802aae1b1fa0d0c1fac80297f55df2b0bfeee0efdd7862c6e9ca133fdc82874077b3b961337
+  data.tar.gz: 7c31053d492a2cc7aae9d197bf52b51d1bfee8efbab38b989ef2e037260d54ef180b415036968eeaead037179a1b368c771149d1ae3e399bba8bf1c9b80e8e0e

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+Gemfile.lock
+*.gem
+log/*.log
+.bundle/
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Tom Benner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+Profiler
+========
+Easy, targeted Ruby profiling
+
+Overview
+--------
+
+Profiler lets you easily measure the time spent in specified code paths.
+
+If a certain code path is taking some time, call `Profiler.start` before it, `Profiler.stop` after it, and `Profiler.check` at significant checkpoints throughout it. Profiler will print information about all of the edges (between the nodes that are specified by `Profiler.check`) that run:
+
+```ruby
+class MyClass
+  def initialize
+    Profiler.start
+    do_something
+    Profiler.stop
+  end
+
+  def do_something
+    # ...
+    Profiler.check
+    # ...
+    Profiler.check
+    # ...
+    100.times do
+      Profiler.check
+      # ...
+    end
+  end
+end
+```
+
+```
+Time      Calls Path
+5.0e-05   1      -> my_class.rb:3:in `initialize'
+0.00015   1     my_class.rb:3:in `initialize' -> my_class.rb:62:in `do_something'
+0.0001    1     my_class.rb:62:in `do_something' -> my_class.rb:75:in `do_something'
+0.01509   1     my_class.rb:75:in `do_something' -> my_class.rb:84:in `block in do_something'
+0.0126    100   my_class.rb:84:in `block in do_something' -> my_class.rb:84:in `block in do_something'
+0.00027   1     my_class.rb:84:in `block in do_something' -> my_class.rb:111:in `do_something'
+Total time: 0.028271198272705078
+```
+
+License
+-------
+
+Profiler is released under the MIT License. Please see the MIT-LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/profiler.rb

@@ -0,0 +1,31 @@
+directory = File.dirname(File.absolute_path(__FILE__))
+Dir.glob("#{directory}/profiler/*.rb") { |file| require file }
+Dir.glob("#{directory}/profiler/printers/*.rb") { |file| require file }
+
+module Profiler
+  class << self
+    attr_accessor :profile, :is_paused
+
+    def start
+      self.profile = Profile.new
+      self.is_paused = false
+    end
+
+    def pause
+      self.is_paused = true
+    end
+
+    def resume
+      self.is_paused = false
+    end
+
+    def check(caller_offset=0)
+      return if is_paused
+      profile.check(caller_offset)
+    end
+
+    def stop
+      profile.stop
+    end
+  end
+end

data/lib/profiler/printers/abstract_printer.rb

@@ -0,0 +1,23 @@
+module Profiler
+  class AbstractPrinter
+    attr_accessor :result
+
+    def initialize(result)
+      self.result = result
+    end
+
+    def print(options={})
+      defaults = {
+        output: STDOUT
+      }
+      options = defaults.merge(options)
+      print_result(options)
+    end
+
+    private
+
+    def print_result
+      raise NotImplementedError
+    end
+  end
+end

data/lib/profiler/printers/flat_printer.rb

@@ -0,0 +1,71 @@
+module Profiler
+  class FlatPrinter < AbstractPrinter
+    private
+
+    def print_result(options)
+      string = result_to_string
+      options[:output].puts(string)
+    end
+
+    def result_to_string
+      lines = []
+      lines << get_header
+      lines += get_body
+      lines << get_footer
+      lines.join("\n")
+    end
+
+    def get_header
+      columns_to_line([
+        'Time',
+        'Calls',
+        'Path'
+      ])
+    end
+
+    def get_body
+      column_lengths = get_column_lengths
+      result.paths_durations.map do |path, duration|
+        count = result.paths_counts[path]
+        columns = [
+          duration.round(5),
+          count,
+          path_to_displayed_path(path)
+        ]
+        columns_to_line(columns)
+      end
+    end
+
+    def get_footer
+      ["Total time: #{result.paths_durations.values.reduce(&:+)}"]
+    end
+
+    def columns_to_line(columns)
+      columns = columns.map.with_index do |column, index|
+        column.to_s.ljust(column_lengths[index])
+      end
+      columns.join(' ')
+    end
+
+    def column_lengths
+      @column_lengths ||= get_column_lengths
+    end
+
+    def get_column_lengths
+      [
+        9,
+        5,
+        get_longest_path_length + 1
+      ]
+    end
+
+    def get_longest_path_length
+      result.paths_durations.keys.map { |path| path_to_displayed_path(path).length }.sort.last
+    end
+
+    # For example, convert 'results_html_haml___3582891738431186295_70358606312040' to 'results_html_haml'
+    def path_to_displayed_path(path)
+      path.gsub(/___[\d_]+/, '')
+    end
+  end
+end

data/lib/profiler/profile.rb

@@ -0,0 +1,28 @@
+module Profiler
+  class Profile
+    attr_accessor :previous_line, :previous_time, :paths_counts, :paths_durations
+
+    def initialize
+      self.paths_counts = Hash.new(0)
+      self.paths_durations = Hash.new(0)
+      self.previous_line = nil
+      self.previous_time = Time.now.to_f
+    end
+
+    def check(caller_offset=0)
+      now = Time.now.to_f
+      line = caller[caller_offset + 1].split("/")[-1]
+      path = "#{self.previous_line} -> #{line}"
+      self.paths_counts[path] += 1
+      self.paths_durations[path] += now - self.previous_time
+      self.previous_line = line.freeze
+      self.previous_time = now
+    end
+
+    def stop
+      result = Result.new(self)
+      FlatPrinter.new(result).print
+      result
+    end
+  end
+end

data/lib/profiler/result.rb

@@ -0,0 +1,14 @@
+module Profiler
+  class Result
+    attr_accessor :paths_counts, :paths_durations
+
+    def initialize(profile)
+      self.paths_counts = profile.paths_counts.dup
+      self.paths_durations = profile.paths_durations.dup
+    end
+
+    def paths
+      self.paths_counts.keys
+    end
+  end
+end

data/lib/profiler/version.rb

@@ -0,0 +1,3 @@
+module Profiler
+  VERSION = '0.0.1'
+end

data/profiler.gemspec

@@ -0,0 +1,16 @@
+require File.expand_path('../lib/profiler/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = ['Tom Benner']
+  s.email         = ['tombenner@gmail.com']
+  s.description = s.summary = %q{Easy, targeted Ruby profiling}
+  s.homepage      = 'https://github.com/tombenner/profiler'
+
+  s.files         = `git ls-files`.split($\)
+  s.name          = 'profiler'
+  s.require_paths = ['lib']
+  s.version       = Profiler::VERSION
+  s.license       = 'MIT'
+
+  s.add_development_dependency 'rspec'
+end

data/spec/profiler_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Profiler do
+  describe "profiling" do
+    before :each do
+      expect(STDOUT).to receive(:puts)
+    end
+
+    it "records one path" do
+      Profiler.start
+      Profiler.check
+      result = Profiler.stop
+      expect(result.paths.length).to eq(1)
+    end
+
+    it "records two paths" do
+      Profiler.start
+      Profiler.check
+      Profiler.check
+      result = Profiler.stop
+      expect(result.paths.length).to eq(2)
+    end
+
+    it "records one call" do
+      Profiler.start
+      Profiler.check
+      result = Profiler.stop
+      expect(result.paths_counts.values).to eq([1])
+    end
+
+    it "records multiple calls" do
+      Profiler.start
+      5.times do
+        Profiler.check
+      end
+      result = Profiler.stop
+      expect(result.paths_counts.values).to eq([1, 4])
+    end
+
+    it "records paths" do
+      Profiler.start
+      Profiler.check
+      result = Profiler.stop
+      expect(result.paths.length).to eq(1)
+      expect(result.paths.first).to start_with(' -> profiler_spec.rb:')
+    end
+
+    it "records durations" do
+      Profiler.start
+      Profiler.check
+      result = Profiler.stop
+      expect(result.paths_durations.length).to eq(1)
+      expect(result.paths_durations.values.first).to be_between(0, 0.1)
+    end
+
+    it "pauses and resumes" do
+      Profiler.start
+      Profiler.check
+      Profiler.pause
+      Profiler.check
+      Profiler.resume
+      Profiler.check
+      result = Profiler.stop
+      expect(result.paths.length).to eq(2)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'profiler'
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: profiler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Benner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Easy, targeted Ruby profiling
+email:
+- tombenner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/profiler.rb
+- lib/profiler/printers/abstract_printer.rb
+- lib/profiler/printers/flat_printer.rb
+- lib/profiler/profile.rb
+- lib/profiler/result.rb
+- lib/profiler/version.rb
+- profiler.gemspec
+- spec/profiler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tombenner/profiler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Easy, targeted Ruby profiling
+test_files: []
+has_rdoc: