staircase 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Prins
+
+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,66 @@
+# Staircase
+
+Staircase lets you write code inside a block and it automatically outputs the duration of the block. It also supports nesting blocks and outputting generic info.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'staircase'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install staircase
+
+## Usage
+
+Call `Staircase.run` with a block and it will automatically output runtime information:
+
+```ruby
+Staircase.run 'Some elaborate process' do
+  sleep(5)
+end
+```
+which will output
+
+```
+Some elaborate process (5002.34 ms)
+```
+
+Or for something a little more complex:
+
+```ruby
+Staircase.run 'Find some objects' do
+  SomeObject.find_all(criteria).tap do |thing|
+    Staircase.run "Opening #{thing}" do
+      thing.open do |contents|
+        Staircase.info "Found #{contents}"
+      end
+    end
+  end
+end
+```
+
+which could output something like:
+
+```
+Find some objects (123.45 ms)
+  Opening a square box... (14.0 ms)
+    Found an interesting object
+  Opening a puzzle box... (89.32 ms)
+    Found a glinting stone
+  Opening a satchel... (18.84 ms)
+    Found nothing in particular
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/staircase.rb

@@ -0,0 +1,37 @@
+require 'staircase/version'
+require 'tree'
+
+module Staircase
+  def self.run(description = '')
+    $performance_tree ||= Tree::TreeNode.new 'Staircase'
+
+    local_node = Tree::TreeNode.new description
+    ($performance_current_node || $performance_tree) << local_node
+    $performance_current_node = local_node
+
+    started_at = Time.now
+    yield
+    ended_at = Time.now
+
+    local_node.content = (ended_at - started_at) * 1000
+    $performance_current_node = $performance_current_node.parent unless $performance_current_node == $performance_tree
+
+    if $performance_current_node == $performance_tree
+      $performance_tree.each do |node|
+        unless node.is_root?
+          if node.content
+            puts "#{'  ' * (node.level - 1)}#{node.name} (#{'%.2f' % node.content} ms)"
+          else
+            puts "#{'  ' * (node.level - 1)}#{node.name}"
+          end
+        end
+      end
+      $performance_tree = nil
+    end
+  end
+
+  def self.info(description)
+    $performance_tree ||= Tree::TreeNode.new 'Staircase'
+    ($performance_current_node || $performance_tree) << Tree::TreeNode.new(description)
+  end
+end

data/lib/staircase/version.rb

@@ -0,0 +1,3 @@
+module Staircase
+  VERSION = '1.0.0'
+end

data/staircase.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'staircase/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'staircase'
+  spec.version       = Staircase::VERSION
+  spec.authors       = ['Michael Prins']
+  spec.email         = ['michael.prins@me.com']
+  spec.description   = %q{Block-driven duration reporting}
+  spec.summary       = %q{Staircase lets you write code inside a block and it automatically outputs the duration of the block. It also supports nesting blocks and outputting generic info.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+
+  spec.files         = `git ls-files`.split($/)
+  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 'rubytree', '~> 0.8.3'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: staircase
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Prins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubytree
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Block-driven duration reporting
+email:
+- michael.prins@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/staircase.rb
+- lib/staircase/version.rb
+- staircase.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 149558528855715135
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 149558528855715135
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Staircase lets you write code inside a block and it automatically outputs
+  the duration of the block. It also supports nesting blocks and outputting generic
+  info.
+test_files: []