tick 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+*.sw*

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree@tick

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    tick (0.0.1)
+      rainbow
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    linecache (0.43)
+    rainbow (1.1)
+    rr (1.0.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  rainbow
+  rr
+  rspec
+  ruby-debug
+  tick!

data/README.md

@@ -0,0 +1,71 @@
+Tick
+=====
+
+About 
+------
+
+Tick benchmark your method and print benchmark in color  
+
+
+Installation 
+-------
+
+    gem install tick 
+
+
+Usge 
+--------
+
+    def foo 
+    end 
+    tick :foo  
+
+
+Configuration 
+-------------
+
+By default you don't need any configuration.
+
+
+Enable tick:
+
+    Tick.enabled = true 
+
+default: true
+
+Whether print benchmark in color 
+
+    Tick.color = true 
+
+default: true
+
+Logger:
+    
+    Tick.logger = Logger.new(STDOUT) 
+
+default: Rails.logger if in Rails environment otherwise Logger.new(STDOUT)
+
+Customize messages:
+
+    Tick.desc_message = lambda { |class_name, method_name| "TIME c:#{class_name} m:#{method_name}" }
+    Tick.time_message = lambda { |sec| "COST (#{sec})" }
+
+Default: 
+* desc_message: "TICK: method '#{method_name.to_s}' in class '#{self.class.name}'" 
+* time_message: "(#{sec.to_s} ms)"
+
+
+Set 256 color:
+
+    Tick.desc_color = "#FFC482"
+    Tick.time_color = "#FFC482"
+
+Default:
+*  desc_color: yellow 
+*  time_color: cyan
+
+
+Special Thanks To
+-----------------
+
+* sickill's rainbow gem 

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/autotest/discover.rb

@@ -0,0 +1,2 @@
+Autotest.add_discovery { "rspec2" }
+

data/lib/tick/version.rb

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

data/lib/tick.rb

@@ -0,0 +1,132 @@
+require 'logger'
+require 'benchmark'
+require 'rainbow'
+
+module Tick
+
+  Sickill::Rainbow.enabled = true
+
+  def self.included(base)
+    base.extend(ClassMethods)    
+    base.send(:include, InstanceMethods)    
+  end 
+
+  def self.logger
+    return @logger if @logger
+
+    if defined?(Rails)
+      Rails.logger
+    else 
+      Logger.new(STDOUT)
+    end
+  end
+
+  def self.logger=(logger) 
+    @logger = logger
+  end
+
+  def self.color=(is_turn_on)
+    return unless is_turn_on.kind_of?(TrueClass) || is_turn_on.kind_of?(FalseClass)
+    Sickill::Rainbow.enabled = is_turn_on
+  end
+
+  def self.enabled 
+    @enabled = true if @enabled.nil?
+    @enabled
+  end
+
+  def self.enabled=(is_turn_on) 
+    @enabled = is_turn_on
+  end
+
+  def self.desc_message
+    @desc_message
+  end
+
+  def self.desc_message=(block)
+    return @desc_message = nil if block.nil?
+    raise ArgumentError.new("wrong number of arguments (#{block.arity} for 2)") if block.arity != 2
+    @desc_message = block
+  end
+
+  def self.desc_color 
+    @desc_color
+  end
+
+  def self.desc_color=(color) 
+    @desc_color = color
+  end
+
+  def self.time_message
+    @time_message
+  end
+
+  def self.time_message=(block)
+    return @time_message = nil if block.nil?
+    raise ArgumentError.new("wrong number of arguments (#{block.arity} for 1)") if block.arity != 1
+    @time_message = block
+  end
+
+  def self.time_color
+    @time_color
+  end
+
+  def self.time_color=(color) 
+    @time_color = color
+  end
+
+  def self.reset 
+    self.enabled = true 
+    self.color = true 
+    @desc_message = nil 
+    @time_message = nil 
+    @desc_color = nil 
+    @time_color = nil
+  end
+
+
+  module ClassMethods 
+    def tick(method_name)
+      alias_method "#{method_name}_without_tick", method_name  
+      define_method method_name do
+        result = nil 
+        if Tick.enabled 
+          sec = Benchmark.realtime  { result = self.send("#{method_name}_without_tick") } 
+          _log_benchmark(method_name, sec)
+        else  
+          result = self.send("#{method_name}_without_tick")
+        end
+        result
+      end
+    end
+  end
+
+  module InstanceMethods 
+    def _log_benchmark(method_name, sec)
+      desc = Tick.desc_message.nil? ? "TICK: method '#{method_name.to_s}' in class '#{self.class.name}'" : Tick.desc_message.call(self.class.name, method_name)
+      time = Tick.time_message.nil? ? "(#{sec.to_s} ms)" : Tick.time_message.call(sec)
+      message = self._colorize_desc(desc)
+      message << "  "
+      message << self._colorize_time(time)
+      Tick.logger.debug(message)
+    end
+
+    def _colorize_desc(str) 
+      if Tick.desc_color 
+        str.color(Tick.desc_color)
+      else
+        str.bright.foreground(:yellow)
+      end
+    end
+
+    def _colorize_time(str)
+      if Tick.time_color 
+        str.color(Tick.time_color)
+      else
+        str.underline.foreground(:cyan).bright
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'..','lib'))
+
+require 'tick'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+  config.after(:each) do 
+    Tick.reset
+  end
+end
+
+

data/spec/tick_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+require 'logger'
+
+describe Tick do 
+  it "will use Rails logger if Rails defined" do 
+    module Rails; end
+    default_logger = Logger.new(STDOUT)
+    mock(Rails).logger  { default_logger }
+    Tick.logger.should == default_logger
+    Object.send(:remove_const, :Rails)
+  end
+
+  it "will create new logger if no Rails defined" do 
+    Tick.logger.should be_kind_of(Logger)
+  end
+
+  it "can set logger" do 
+    logger = Logger.new(STDOUT)
+    Tick.logger = logger 
+    Tick.logger.should == logger
+  end
+
+  it "turn on color by default" do 
+    Sickill::Rainbow.enabled.should be true
+  end
+
+  it "can turn off color" do 
+    Tick.color = false 
+    Sickill::Rainbow.enabled.should be false
+  end
+
+  it "can not set color to value which is not boolean" do 
+    old_value = Sickill::Rainbow.enabled
+    Tick.color = "asdasdas"
+    Sickill::Rainbow.enabled.should be old_value
+  end
+
+  it "is turn on by default" do 
+    Tick.enabled.should be true
+  end
+
+  it "can be turn off" do 
+    Tick.enabled = false
+    Tick.enabled.should be false
+  end
+
+  it "can set custom desc color" do 
+    Tick.desc_color = "#FFC482" 
+    Tick.desc_color.should == "#FFC482"
+  end
+
+  it "can set custom time color" do 
+    Tick.time_color = "#FFC482" 
+    Tick.time_color.should == "#FFC482"
+  end
+
+  it "can set custom desc message" do 
+    a_proc = lambda { |class_name, method_name| "TIME c:#{class_name} m:#{method_name}" }
+    Tick.desc_message = a_proc
+    Tick.desc_message.should be a_proc
+  end
+
+  it "will raise exception if desc_message lambda arg number dones't match" do 
+    a_proc = lambda { |class_name| "TIME c:#{class_name}" }
+    lambda {Tick.desc_message = a_proc}.should raise_error(ArgumentError, "wrong number of arguments (1 for 2)")
+  end
+
+  it "will raise exception if desc_message lambda arg number dones't match" do 
+    a_proc = lambda { |a, b|"COST (0.1)" }
+    lambda {Tick.time_message = a_proc}.should raise_error(ArgumentError, "wrong number of arguments (2 for 1)")
+  end
+
+  it "can set custom time message" do 
+    a_proc = lambda { |sec| "COST (#{sec})" }
+    Tick.time_message = a_proc
+    Tick.time_message.should be a_proc
+  end
+end
+
+describe "A class include Tick" do
+  before do 
+    @klass = Class.new 
+    @klass.send(:include, Tick)
+  end
+
+  it "should have class method tick" do 
+    @klass.should respond_to :tick
+  end
+
+  it "should not have logger method" do 
+    @klass.should_not respond_to :logger
+    @klass.new.should_not respond_to :logger
+  end
+
+  it "should raise exception if passing wrong method name" do 
+    lambda {@klass.send(:tick, :xxx)}.should raise_error
+  end
+
+  describe "tick on :default method" do 
+    before do 
+      @klass.class_eval do  
+        def default
+          sleep 0.5
+        end
+      end
+
+      @klass.send(:tick, :default) 
+      @instance = @klass.new 
+      @instance.should respond_to :default
+    end
+
+    it "should log time when default method be called" do 
+      mock(@instance)._log_benchmark(:default, numeric)
+      @instance.default
+    end
+
+    it "should not do benchmark if Tick is turn off" do 
+      dont_allow(Benchmark).realtime(anything)
+      old_value = Tick.enabled
+      Tick.enabled = false
+      @instance.default
+      Tick.enabled = old_value
+    end
+  end
+
+  describe "#_log_benchmark" do 
+    before do 
+      @instance = @klass.new
+      mock(@instance)._colorize_desc(anything) do  |desc| 
+        desc
+      end
+      mock(@instance)._colorize_time(anything) do |time| 
+        time
+      end
+    end
+
+    it "log sec in color" do 
+      desc = "TICK: method 'default' in class ''"
+      time = "(0.1 ms)"
+      message = ""
+      message << desc
+      message << "  "
+      message << time
+      mock(Tick.logger).debug(message)
+      @instance._log_benchmark(:default, 0.1)    
+    end
+
+    it "should print custom message if set custom message" do 
+      Tick.desc_message = lambda {|class_name, method_name| "c:#{class_name} m:#{method_name}" }
+      Tick.time_message = lambda {|sec| "cost #{sec}" }
+      desc = "c: m:default"
+      time = "cost 0.1"
+      message = ""
+      message << desc
+      message << "  "
+      message << time
+      mock(Tick.logger).debug(message)
+      @instance._log_benchmark(:default, 0.1)    
+    end
+  end
+
+  describe "#colorize" do 
+    it "should set desc color if desc color is set" do 
+      str = "a" 
+      color = "#FFC482"
+      Tick.desc_color = color
+      @klass.new._colorize_desc(str).should == str.color(color)
+    end
+
+    it "should set time color if time color is set" do 
+      str = "a" 
+      color = "#FFC482"
+      Tick.time_color = color
+      @klass.new._colorize_time(str).should == str.color(color)
+    end
+
+  end
+
+
+end

data/spec.opts

@@ -0,0 +1,11 @@
+--colour
+--format
+document
+--loadby
+mtime
+--reverse
+--timeout
+20
+--diff
+--backtrace
+

data/tick.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tick/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tick"
+  s.version     = Tick::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["allenwei"]
+  s.email       = ["digruby@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/tick"
+  s.summary     = %q{Tick benchmark your method and print it in color}
+
+  s.rubyforge_project = "tick"
+
+  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"]
+
+  s.add_dependency('rainbow')
+
+  s.add_development_dependency('rspec') 
+  s.add_development_dependency('rr') 
+  s.add_development_dependency('autotest') 
+  s.add_development_dependency('ruby-debug') 
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: tick
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- allenwei
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-01 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: 
+email: 
+- digruby@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/tick.rb
+- lib/tick/version.rb
+- spec.opts
+- spec/spec_helper.rb
+- spec/tick_spec.rb
+- tick.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/tick
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: tick
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tick benchmark your method and print it in color
+test_files: 
+- spec/spec_helper.rb
+- spec/tick_spec.rb