debug_timer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 214a4308350f211e2e5e65095f27d2e6a35acf55
+  data.tar.gz: 4e9221eae9d9abcc136f0d411eb0afa4f3bc9805
+SHA512:
+  metadata.gz: fa1ca0cb8ae667c050e49e75b6f7cc27796f690c2e401d9637a69610f924a36f745e272f6c9c741ec9be5ea7121257517a3f3b7f3e1442ddeefb7fa7b6ea9e36
+  data.tar.gz: bd4b0beede7e6a8cdce1ffe6130b9149c89d3ebacc8fda5fae8c5cfb6f3deea1a8e0e8412fc720862549abade8581461f6e55d8ab311dddf0c71b44119f49735

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format progress
+--require spec_helper
+--pattern "spec/**/*_spec.rb"

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.5
+  - 2.2.0
+  - 2.3.1
+  - 2.4.0

data/Changelog.rdoc

@@ -0,0 +1,2 @@
+ === 0.1.0
+  - Adding the ability to output gc_stats

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in debug_timer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Austin Fonacier
+
+MIT License
+
+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,140 @@
+# DebugTimer
+
+This gem is to help debug slow portions of the code.  When RubyProf isn't enough and you need to get deeper into the code base this is the solution.  The output will look like this:
+
+```
+ 1.8040 └── search
+ 1.0554    └── 1st
+ 0.0033        └── config
+ 0.0001        └── 1.1
+ 0.6579        └── 1.2
+ 0.0087            └── 1.2.1
+ 0.0075            └── 1.2.2
+ 0.6416            └── set_custom_variable
+ 0.3941        └── 1.3
+ 0.3938            └── 1.3.1
+ 0.0002            └── 1.3.2
+ 0.1487    └── 2nd
+ 0.5999    └── 3rd
+ 0.0133        └── presenter
+ 0.0023        └── serialize
+ 0.5843        └── respond_to
+ 0.5842            └── render
+ 0.1506                └── presenter.view
+
+ ```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'debug_timer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install debug_timer
+
+### Configuration
+
+You can add your logger instance if you want:
+
+```ruby
+# Straight assignment
+DebugTimer.logger = Logger.new('asdf')
+DebugTimer.object_allocations = true
+
+# or config assignment
+DebugTimer.config do |config|
+  config.logger = Logger.new('asdf')
+  config.object_allocations = true
+end
+
+```
+
+## Usage
+
+To use DebugTimer simply wrap the code you want to time in a block.
+
+```ruby
+DebugTimer.start('search function') do
+  Search.searchysearchsearch('search query')
+  SomeOtherCode.DoWhatever?
+
+  IhazFunction?
+end
+```
+
+When you run that piece of code you will see in your log.  The number on the left is the time that block of code took to run
+
+```
+1.8040 └── search function
+```
+
+### Nesting
+
+You can nest blocks within blocks.
+
+```ruby
+DebugTimer.start('search function') do
+  Search.searchysearchsearch('search query')
+
+  DebugTimer.start('Some other code') do
+    SomeOtherCode.DoWhatever?
+  end
+
+  IhazFunction?
+end
+```
+
+And the output will look like:
+
+```
+ 1.8040 └── search function
+ 1.0554    └── Some other code
+```
+
+### Object Allocations
+```ruby
+
+# Enable it
+DebugTimer.object_allocations = true
+
+# Time
+DebugTimer.start('search function') do
+  Search.todo('in here')
+end
+```
+
+And the output will look like:
+```
+INFO -- : 0.0036 | T_OBJECT: 1 | FREE: -91  └── search function
+```
+
+The second pipe is the is ObjectSpace's T_OBJECT change
+
+The third pipe is the ObjectSpace's :FREE change
+
+
+## Running Specs
+
+```
+> rake
+
+Finished in 0.00926 seconds (files took 0.11604 seconds to load)
+5 examples, 0 failures
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/debug_timer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+task :test => :spec

data/debug_timer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'debug_timer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "debug_timer"
+  spec.version       = DebugTimer::VERSION
+  spec.authors       = ["Jorge Urias", "Austin Fonacier"]
+  spec.email         = ["jurias@spokeo.com", "austinrf@gmail.com"]
+  spec.summary       = "When RubyProf has failed you, time your individual code components."
+  spec.description   = "Nest code blocks and time them easily to grab a greater insight on what is happening to your code."
+  spec.homepage      = "https://github.com/austinrfnd/debug_timer"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.3.0"
+end

data/lib/debug_timer.rb

@@ -0,0 +1,42 @@
+require 'logger'
+require "debug_timer/version"
+require "debug_timer/config"
+require "debug_timer/logger"
+require "debug_timer/node"
+require "debug_timer/node_printer"
+
+module DebugTimer
+  def self.start(name = '---', &block)
+    parent = @current_node
+
+    @current_node = Node.new(name)
+    result = yield
+    @current_node.stop()
+
+    if parent
+      parent.children << @current_node
+    else
+      print_tree(@current_node)
+    end
+
+    result
+    ensure
+      @current_node = parent
+  end
+
+  private
+
+  def self.gather_nodes(node, depth = 0)
+    nodes = []
+    nodes << node.print(depth: depth)
+    node.children.each do |node|
+      nodes = nodes + gather_nodes(node, depth+1)
+    end
+    nodes
+  end
+
+  def self.print_tree(node)
+    nodes_output = gather_nodes(node, 0).join("\n")
+    logger.info(nodes_output)
+  end
+end

data/lib/debug_timer/config.rb

@@ -0,0 +1,15 @@
+module DebugTimer
+  @@object_allocations = false
+
+  def self.configure
+    yield self
+  end
+
+  def self.object_allocations=(object_allocations)
+    @@object_allocations = object_allocations
+  end
+
+  def self.object_allocations?
+    @@object_allocations
+  end
+end

data/lib/debug_timer/logger.rb

@@ -0,0 +1,9 @@
+module DebugTimer
+  def self.logger=(logger)
+    @@logger = logger
+  end
+
+  def self.logger
+    @@logger ||= Logger.new($stdout)
+  end
+end

data/lib/debug_timer/node.rb

@@ -0,0 +1,38 @@
+module DebugTimer
+  class Node
+    attr_reader :name, :children, :start_time, :parent, :time_elapsed, :start_gc_stats, :end_gc_stats
+    def initialize(name)
+      @name = name
+      @children = []
+      if DebugTimer.object_allocations?
+        grab_object_allocations(true)
+      end
+      @start_time = Time.now
+    end
+
+    def stop
+      @time_elapsed = Time.now - start_time
+      if DebugTimer.object_allocations?
+        grab_object_allocations(false)
+      end
+    end
+
+    def print(depth:)
+      NodePrinter.new(self).print(depth)
+    end
+
+    private
+
+    def grab_object_allocations(start)
+      if start
+        # GC.disable
+        # puts ObjectSpace.count_objects.inspect
+        @start_gc_stats = ObjectSpace.count_objects
+      else
+        # puts ObjectSpace.count_objects.inspect
+        @end_gc_stats = ObjectSpace.count_objects
+        # GC.enable
+      end
+    end
+  end
+end

data/lib/debug_timer/node_printer.rb

@@ -0,0 +1,35 @@
+module DebugTimer
+  class NodePrinter
+    def initialize(node)
+      @node = node
+    end
+
+    # Should return a string of the printed
+    def print(depth)
+      spaces = "    ".freeze * depth
+      "#{left_stats} #{spaces} └── #{@node.name}"
+    end
+
+    private
+    def left_stats
+      stats = [seconds_elapsed]
+      if DebugTimer.object_allocations?
+        stats << "T_OBJECT: #{total_objects_allocated}"
+        stats << "FREE: #{total_free_count}"
+      end
+      stats.join(" | ")
+    end
+
+    def total_objects_allocated
+      @node.end_gc_stats[:T_OBJECT] - @node.start_gc_stats[:T_OBJECT]
+    end
+
+    def total_free_count
+      @node.end_gc_stats[:FREE] - @node.start_gc_stats[:FREE]
+    end
+
+    def seconds_elapsed
+      [0.0001, @node.time_elapsed].max.round(4).to_s.ljust(6, '0'.freeze)
+    end
+  end
+end

data/lib/debug_timer/version.rb

@@ -0,0 +1,3 @@
+module DebugTimer
+  VERSION = "0.1.0"
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,14 @@
+describe "DebugTimer configure" do
+  it "should default object_allocations to false" do
+    expect(DebugTimer.object_allocations?).to be_falsey
+  end
+
+  context 'configure' do
+    it "should return set object_allocations" do
+      DebugTimer.configure do |config|
+        config.object_allocations = true
+      end
+      expect(DebugTimer.object_allocations?).to be_truthy
+    end
+  end
+end

data/spec/lib/debug_timer_spec.rb

@@ -0,0 +1,20 @@
+describe DebugTimer do
+  context 'start' do
+    it "should yield the block" do
+      DebugTimer.object_allocations = true
+      yielded = DebugTimer.start("yo ho yo ho a pirate's life for me") do
+        DebugTimer.start('pirate insider') do
+          "Black"
+        end
+        attr = []
+        8.times do |x|
+          attr << "foobar#{x}"
+          attr << Array.new(1_000_000/8)
+        end
+        'Jack'
+      end
+      expect(yielded).to eql("Jack")
+      DebugTimer.object_allocations = false
+    end
+  end
+end

data/spec/lib/node_printer_spec.rb

@@ -0,0 +1,34 @@
+describe DebugTimer::NodePrinter do
+  let :node do
+    DebugTimer::Node.new('asdf')
+  end
+  context 'object_allocations set to true' do
+    before :each do
+      DebugTimer.object_allocations = true
+    end
+
+    it "should print a string" do
+      node.stop
+      printer = DebugTimer::NodePrinter.new(node)
+      expect(printer.print(1)).to be_kind_of(String)
+    end
+
+    it "should include data allocation output" do
+      node.stop
+      printer = DebugTimer::NodePrinter.new(node)
+      expect(printer.print(1)).to match(/T_OBJECT/)
+    end
+  end
+
+  context "object_allocations set to false" do
+    before :each do
+      DebugTimer.object_allocations = false
+    end
+
+    it "should not include data allocation output" do
+      node.stop
+      printer = DebugTimer::NodePrinter.new(node)
+      expect(printer.print(1)).to_not match(/T_OBJECT/)
+    end
+  end
+end

data/spec/lib/node_spec.rb

@@ -0,0 +1,32 @@
+describe DebugTimer::Node do
+  let :node do
+    n = DebugTimer::Node.new('asdf')
+    'asdf'
+    n.stop
+    n
+  end
+
+  describe 'initialize' do
+    it "should a name" do
+      expect(node.name).to eql('asdf')
+    end
+
+    it "should initialize with empty children" do
+      expect(node.children).to eql([])
+    end
+
+    it "should have a start_time" do
+      k = Time.now
+      expect(Time).to receive(:now) { k }
+      node = DebugTimer::Node.new('asdf2')
+      expect(node.start_time).to eql(k)
+    end
+  end
+
+  context 'stop' do
+    it "should set @time_elapsed" do
+      node.stop
+      expect(node.time_elapsed).to_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'debug_timer'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: debug_timer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jorge Urias
+- Austin Fonacier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: Nest code blocks and time them easily to grab a greater insight on what
+  is happening to your code.
+email:
+- jurias@spokeo.com
+- austinrf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- debug_timer.gemspec
+- lib/debug_timer.rb
+- lib/debug_timer/config.rb
+- lib/debug_timer/logger.rb
+- lib/debug_timer/node.rb
+- lib/debug_timer/node_printer.rb
+- lib/debug_timer/version.rb
+- spec/lib/config_spec.rb
+- spec/lib/debug_timer_spec.rb
+- spec/lib/node_printer_spec.rb
+- spec/lib/node_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/austinrfnd/debug_timer
+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.6.11
+signing_key: 
+specification_version: 4
+summary: When RubyProf has failed you, time your individual code components.
+test_files:
+- spec/lib/config_spec.rb
+- spec/lib/debug_timer_spec.rb
+- spec/lib/node_printer_spec.rb
+- spec/lib/node_spec.rb
+- spec/spec_helper.rb