tinytimer 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Rakefile

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

data/lib/TODO

@@ -0,0 +1,3 @@
+pretty time format
+ascii color
+rake

data/lib/tiny_timer.rb

@@ -0,0 +1,6 @@
+require "tiny_timer/version"
+
+require "tiny_timer/timer"
+require "tiny_timer/dsl"
+
+self.extend TinyTimer::DSL

data/lib/tiny_timer/dsl.rb

@@ -0,0 +1,24 @@
+module TinyTimer
+  # User Interface (global convenience methods)
+  module DSL
+    
+    private
+    
+    def timer(desc=nil, &block)
+      TinyTimer::Timer.run_timer(desc, &block)
+    end
+
+    def step(desc='', &block)
+      timer = TinyTimer::Timer.current_timer
+      # TODO: raise exeption if timer is nil
+      timer.step(desc,&block) if timer
+    end
+  
+    def comment(desc='')
+      timer = TinyTimer::Timer.current_timer
+      # TODO: raise exeption if timer is nil
+      timer.comment(desc) if timer
+    end
+    
+  end
+end

data/lib/tiny_timer/timer.rb

@@ -0,0 +1,65 @@
+module TinyTimer
+  TIMER_CHARS = '*** '
+  LEADING_CHARS = TIMER_CHARS
+  STEP_CHARS = TIMER_CHARS + '  '
+
+  class Timer
+    @@timers = []
+    @@leading = ''
+
+    class << self
+      def run_timer(desc=nil, &block)
+        # desc ||= Rake.application.last_description
+        new_timer = self.new
+        @@timers.push(new_timer)
+        @@leading += LEADING_CHARS if self.count > 1 # 4 whitespaces
+        puts "#{@@leading}#{TIMER_CHARS}Started: #{desc}" #TODO: ANSI color for Started
+        yield
+        puts "#{@@leading}#{TIMER_CHARS}Finished. Total running time: #{Time.now - new_timer.start_time} seconds"
+        @@leading.sub!(/.{#{LEADING_CHARS.size}}$/,'') if self.count > 1
+        @@timers.pop
+      end
+
+      def count
+        @@timers.size
+      end
+
+      def current_timer
+        @@timers.last
+      end
+    end
+
+    attr_reader :start_time, :real_running_time
+
+    def initialize
+      @start_time = Time.now
+      @step_count = 0
+      @real_running_time = 0 # sum of the running time of all steps
+    end
+
+    # if no block given, should do nothing
+    def step(desc='')
+      if block_given?
+        if @block_flag
+          yield
+        else
+          @step_count += 1
+          puts "#{@@leading}#{STEP_CHARS}#{@step_count}. #{desc} ... "
+          @block_flag = true
+          start = Time.now
+          yield
+          running_time = Time.now - start
+          @block_flag = false
+          @real_running_time += running_time
+          puts "#{@@leading}#{STEP_CHARS}-- finished in #{running_time} seconds"
+        end
+      end
+    end
+    
+    # use this method if you only want to print out something, do not create an empty step or timer
+    def comment(desc='')
+      puts "#{@@leading}#{STEP_CHARS}[ #{desc} ]" if desc.length > 0
+    end
+  end
+
+end

data/lib/tiny_timer/version.rb

@@ -0,0 +1,3 @@
+module TinyTimer
+  VERSION = "0.0.1"
+end

data/test/examples.rb

@@ -0,0 +1,44 @@
+# since I'm too naive to know how to test with the $stdout, this is a sample ruby script playing with tiny_timer :-p
+$:.push File.expand_path("../../lib", __FILE__)
+require 'tiny_timer'
+
+def nested_1
+  timer "(nested_1) yielding some block" do
+    step 'do something first' do
+      10000.times do |i|
+        i + 2
+      end
+    end
+    yield
+    step 'do something afterwards' do
+      step 'a nested step will be neglected, although the code in the block will still run' do # do not do this!
+        puts 'another screwing output'
+      end
+      10000.times do |i|
+        i + 2
+      end
+    end
+  end
+end
+
+# a normal piece of code
+timer 'how long does 10000 calculations take ?' do
+  step 'plusing' do
+    10000.times do |i|
+      i + 2
+    end
+  end
+  step 'multipying' do
+    10000.times do |i|
+      i*33
+    end
+  end
+  step 'dividing' do
+    10000.times do |i|
+      1000/(i+1)
+    end
+  end
+  step 'if no block passed, should not crash and should print nothing'
+  nested_1 { puts "if any code prints something, it will screw things up"}
+  comment 'should be the end?'
+end

data/tiny_timer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tiny_timer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tinytimer"
+  s.version     = TinyTimer::VERSION
+  s.authors     = ["Tao Zhang"]
+  s.email       = ["birdbluebloc@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{ a very simple gem to print elapsed time for pieces of code or rake tasks }
+  s.description = %q{ with handy global methods, print out the running time as your codes run }
+  s.license     = 'MIT'
+
+  # s.rubyforge_project = "tiny_timer"
+
+  s.add_dependency('rake', ">= 0.8.7")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: tinytimer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tao Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-26 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id001
+description: " with handy global methods, print out the running time as your codes run "
+email: 
+- birdbluebloc@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/TODO
+- lib/tiny_timer.rb
+- lib/tiny_timer/dsl.rb
+- lib/tiny_timer/timer.rb
+- lib/tiny_timer/version.rb
+- test/examples.rb
+- tiny_timer.gemspec
+has_rdoc: true
+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 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: a very simple gem to print elapsed time for pieces of code or rake tasks
+test_files: 
+- test/examples.rb