cutter 0.6.0 → 0.8.0

data/{README.rdoc → README.textile}

@@ -1,14 +1,21 @@
-= cutter
+h1. Cutter
+
+Two-methods-gem I use a lot for simple debugging & performance measuring purposes.
 
-For now it is two-methods-gem I use a lot for simple debugging & performance measuring purposes.
 Include it into Gemfile:
-  gem 'cutter'
 
-Methods are:
+<pre>
+<code>
+gem 'cutter'
+</code>
+</pre>
 
-==I) #inspect! 
+h2. I) #inspect! 
 
 Insert #inspect! method into any of your methods:
+
+<pre>
+<code>
   def your_method *your_args
     inspect! {} # this string exactly!    
     ...
@@ -19,9 +26,13 @@ Insert #inspect! method into any of your methods:
   method `your_method'
     variables: 
       args: [1, "foo", :bar]
+</code>
+</pre>
 
 or in more rigorous way:
 
+<pre>
+<code>
   def your_another_method(first, second, third, &block)
     inspect!(binding)
   end
@@ -34,12 +45,15 @@ or in more rigorous way:
       second: "foo"
       third: :bar
       block: 
-
+</code>
+</pre>
 
 Gives simple but nice trace for inspection: method's name and args that were passed to method
 
 With :inspect => true we have self#inspect of class to which method belongs to:
 
+<pre>
+<code>
   def method_self_inspect
     ...
     inspect!(:inspect => true) {}
@@ -55,9 +69,13 @@ With :inspect => true we have self#inspect of class to which method belongs to:
       block: 
     self inspection:
       #<SelfInspectDemo:0x82be488 @variable="I'm variable">
+</code>
+</pre>
 
 And finally :level => N gives caller methods chain (N + 1 caller methods):
 
+<pre>
+<code>
   def method_caller_chain
     ...
     inspect!(:level => 2)
@@ -75,59 +93,97 @@ And finally :level => N gives caller methods chain (N + 1 caller methods):
       /home/stanislaw/_work_/gems/cutter/spec/inspection/demo_spec.rb:33:in `method_caller_chain'
       /home/stanislaw/_work_/gems/cutter/spec/inspection/demo_spec.rb:40:in `block (3 levels) in <top (required)>' 
       /home/stanislaw/.rvm/gems/ruby-1.9.2-p180@310/gems/rspec-core-2.6.4/lib/rspec/core/example.rb:48:in `instance_eval'
+</code>
+</pre>
 
 If you want all #inspect! methods fall silent at once, use
-  Cutter::Inspection.quiet!
+  @Cutter::Inspection.quiet!@
 To make them sound again do
-  Cutter::Inspection.loud!
+  @Cutter::Inspection.loud!@
 
 You can clone it and try 
   
-  bundle exec rspec spec/inspection/demo_spec.rb
+  @bundle exec rspec spec/inspection/demo_spec.rb@
   
 Very! Very simple!
 
-==II) #stamper
-    def your_method
-      stamper("testing pieces of code") do
-        piece_of_code #1
-        stamp("piece #1 performed!")
-        piece_of_code #2
-        stamp("piece #2 performed!")
-        pirce_of_code #3
-      end
-    end
-
-    your_method => 
-    ~ testing pieces of code 
-    ~ testing: start
-    ~ testing: piece #1 performed!, 10ms
-    ~ testing: piece #2 performed!, 231ms
-    ~ testing: end (247ms)
-
-    
-    or simply:
-    def test_method
-      stamper {
-        piece of code
-      }
-    end
+h2. II) #stamper
+
+<pre>
+<code>
+Stamper.scope :stan => "testing test_method" do |stan|
+  stan.msg _1: 'stamp1'
+  stan.msg _2: 'stamp2'
+  stan.msg _3: 'stamp3'
+end
+
+Stamper.scope :hello => "testing hello part" do |stan|
+  stan.msg _1: 'hello stan'
+  stan.msg _2: 'nice to see you'
+end
+
+v = 32
+
+stamper :stan do |s|
+  s.stamp
+  s.stamp :_1
+  sleep 0.1
+  s.stamp :_2
+  s.stamp :hello_world
+  stamper :hello do |s|
+    s.stamp :_1
+    sleep 0.1
+    s.stamp :_2
+  end
+  sleep 0.1
+  s.stamp "hello world: #{v}" # access var before block
+  s.stamp :_3
+  sleep 0.1
+end
+
+ => 
+
+------------------------------
+~ START "testing test_method"
+  ~ stamp:       0 ms   
+  ~ stamp:       0 ms   stamp1
+  ~ stamp:     101 ms   stamp2
+  ~ stamp:     101 ms   Hello world
+  ------------------------------
+  ~ START "testing hello part"
+    ~ stamp:       0 ms   hello stan
+    ~ stamp:     101 ms   nice to see you
+  ~ END   "testing hello part"  
+  [101ms]
+  ------------------------------
+  ~ stamp:     305 ms   Hello world: 32
+  ~ stamp:     305 ms   stamp3
+~ END   "testing test_method"  
+[406ms]
+------------------------------
+</code>
+</pre>
+
+or simply:
+<pre>
+<code>
+def test_method
+  stamper {
+    piece of code
+  }
+end
+</code>
+</pre>
 
 Acts as self.benchmark{} (in Rails) or Benchmark.measure{} (common Ruby) but with stamps in any position in block executed.
 It is much simpler to write it quickly than all these Measure-dos.
 
-== Contributing to cutter
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+h2. Contributors
+
+* Stanislaw Pankevich
+* Kristian Mandrup
 
-== Copyright
+h2. Copyright
 
-Copyright (c) 2011 Stanislaw Pankevich. See LICENSE.txt for
-further details.
+Copyright (c) 2011 Stanislaw Pankevich
 

data/lib/cutter.rb

@@ -1,4 +1,7 @@
 require 'cutter/array'
 require 'cutter/railtie' if defined?(Rails)
+
+require 'cutter/colored_outputs'
 require 'cutter/stamper'
 require 'cutter/inspection'
+

data/lib/cutter/colored_outputs.rb

@@ -0,0 +1,61 @@
+require 'colorize'
+class Object
+  
+  def line sp = ""
+    log_coloured sp, "------------------------------", color(:line)
+  end
+
+
+  def log_coloured sp, msg, color = :default
+    message = sp + msg
+    message = color != :default ? message.send(color) : message
+    puts message
+  end
+end
+
+module Cutter
+  module ColoredOutputs
+    module ClassMethods
+      def turn_colors state = :on
+        @colors_state = state
+      end
+
+      def colors?
+        @colors_state ||= :on
+        @colors_state == :on
+      end
+
+      def colors &block
+        yield colors_config
+      end
+
+      def colors_config
+        @colors ||= {:line => :blue, 
+                     :time => :light_blue,
+
+                     # Colors for #inspect!
+                     #:called_from => :light_magenta,
+                     #:class_name => :red,
+                     #:method => :blue,
+                     #:method_name => :green,
+                     #:lv => :blue,
+                     #:lv_names => :magenta,
+                     #:lv_values => :light_red,
+                     #:iv => :cyan,
+                     #:iv_names => :light_cyan,
+                     #:iv_values => :light_blue,
+                     #:self_inspection => :red,
+                     #:self_inspection_trace => :blue,
+                     #:caller_methods => :light_cyan,
+                     #:caller_method => :green
+                    }
+      end
+    end
+
+    extend ClassMethods
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end

data/lib/cutter/inspection.rb

@@ -24,6 +24,15 @@ class Object
   def inspect! *options, &block
     return true if Cutter::Inspection.quiet?
 
+    def __colors
+      Cutter::ColoredOutputs.colors_config
+    end
+
+    def to_cs obj
+      color = __colors[obj] || :default
+      color != :default ? to_s.send(color) : to_s
+    end
+
     # Getting binding
     _binding = options.first if options.first.class == Binding
     raise ArgumentError, "Try inspect(binding) or inspect! {}", caller if (!block_given? && !_binding)
@@ -41,40 +50,45 @@ class Object
     self_inspection = eval('self.inspect', _binding) if options[:inspect]
 
     # Basic info
-    puts %|\nmethod: `#{eval('__method__', _binding)}' #{'(maximal tracing)' if max}|
-    puts %|  called from class: #{eval('self.class', _binding)}|
+    method_name = eval('__method__', _binding)
+    class_name = eval('self.class', _binding)
+    
+    puts "\n%s `%s' %s" % ['method:'.to_cs(:method), method_name.to_cs(:method_name), ('(maximal tracing)' if max)]
+    puts "  %s %s" % ['called from class:'.to_cs(:called_from), class_name.to_cs(:class_name)]
 
+    # Local Variables
     lvb = eval('local_variables',_binding)
-    puts %|  local_variables: #{"[]" if lvb.empty?}|
+    puts "  %s %s" % ['local_variables:'.to_cs(:lv), ("[]" if lvb.empty?)]
 
     lvb.map do |lv|
       local_variable = eval(lv.to_s, _binding)
       local_variable = (max ? local_variable.inspect : local_variable.to_real_string)
 
-      puts %|    #{lv}: #{local_variable}| 
+      puts "    %s: %s" % [lv.to_cs(:lv_names), local_variable.to_cs(:lv_values)] 
     end if lvb
 
     ivb = eval('instance_variables',_binding)
-    puts %|  instance_variables: #{"[]" if ivb.empty?}|
     
-    ivb.map do |lv|
-      instance_variable = eval(lv.to_s, _binding)
+    puts "  %s %s" % ["instance_variables:".to_cs(:iv), ("[]" if ivb.empty?)]
+    
+    ivb.map do |iv|
+      instance_variable = eval(iv.to_s, _binding)
       instance_variable = (max ? instance_variable.inspect : instance_variable.to_real_string)
      
-      puts %|    #{lv}: #{instance_variable}| 
+      puts "    %s: %s" % [iv.to_cs(:iv_names), instance_variable.to_cs(:iv_values)] 
     end if ivb
 
     # Self inspection 
     begin
-      puts %|  self inspection:|
-      puts %|    #{self_inspection}|
+      puts "  self inspection:".to_cs(:self_inspection)
+      puts "    %s" % self_inspection.to_cs(:self_inspection_trace)
     end if self_inspection
 
     # Caller methods chain
     begin
-    puts %|  caller methods: |
+    puts "  caller methods: ".to_cs(:caller_methods)
     0.upto(level).each {|index|
-      puts %|    #{_caller[index]}|
+      puts "    %s" % _caller[index].to_cs(:caller_method)
     }
     end if level
    

data/lib/cutter/stamper.rb

@@ -1,32 +1,75 @@
 require 'set'
+require 'active_support/core_ext/string/inflections.rb'
 
 class Object
   def time_now
     Time.now.strftime("%s%L").to_i
   end
 
-  def stamper name, &block
+  def stamper name = nil, &block
+
+    def log_time sp, msg
+      log_coloured sp, msg, color(:time)
+    end
+
+    def color type
+      Stamper.colors_config[type] if Stamper.colors?
+    end
+
+    return if Stamper.off?
     scope = Stamper[name] || Stamper[:default]
+    scope.indent = Stamper.last ? Stamper.last.indent + 1 : 0
+    Stamper.push scope
+
     msg = 'no msg'
     if scope
       message = scope.label.values.first
     end
-
-    puts("~ #{message}")
-    puts("~ testing: start")
+    spaces = "  " * scope.indent
+    line spaces
+    log_coloured spaces, "~ START " << "#{message}"
     scope.time_initial = time_now
     yield scope
+    scope.indent -= 1 if scope.indent > 0
+    Stamper.pop
     time_passed = time_now - scope.time_initial
-    puts("~ testing: end (#{time_passed}ms)")
+    log_coloured spaces, "~ END " << "#{message}"
+    log_time spaces, "[#{time_passed}ms]"
+    line spaces
   end
 end
 
 class Stamper
-  attr_reader :label
+  attr_reader   :label
   attr_accessor :time_initial
+  attr_writer   :indent
+
+  include Cutter::ColoredOutputs
 
   def initialize label
     @label = label
+    @indent = 0
+  end
+
+  def self.turn state = :on
+    @state = state
+  end
+
+  def self.on?
+    @state ||= :on
+    @state == :on
+  end
+
+  def self.off?
+    !on?
+  end
+
+  def indent
+    @indent ||= 0
+  end
+
+  def nindent
+    @indent +1
   end
 
   def msg label
@@ -44,30 +87,53 @@ class Stamper
   end
 
   def stamp lbl = nil
-    message = messages[lbl] || lbl
+    return if Stamper.off?
+    message = messages[lbl] || lbl.to_s.humanize
     time_passed = time_now - time_initial
+    print "  " * nindent
     printf("~ stamp: %7d ms   #{message}\n", time_passed)
   end
 
   module ClassMethods
+
     def scope label, &block
       raise ArgumentError, "Must have hash, was: #{label}" if !label.kind_of? Hash
       raise ArgumentError, "Must have block" if !block
       stamper = Stamper.new(label)
       stampers[label.keys.first] = stamper
       yield stamper
+      stamper_stack.pop
       stamper
     end
 
+    def last
+      stamper_stack.last
+    end
+
+    def push stamper
+      stamper_stack.push stamper
+    end
+
+    def pop
+      stamper_stack.pop
+    end
+
     def [] key
       stampers[key]
     end
 
     protected
 
+    def stamper_stack
+      @stamper_stack ||= []
+    end
+
     def stampers
       @stampers ||= {}
     end
   end
   extend ClassMethods
 end
+
+Stamper.scope :default => nil do |default|
+end

metadata

@@ -2,7 +2,7 @@
 name: cutter
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - stanislaw
@@ -10,75 +10,64 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-07 00:00:00 +03:00
+date: 2011-08-08 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activesupport
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.3.5
   type: :runtime
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec-rails
+  name: colorize
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: "0.5"
   type: :runtime
   prerelease: false
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: shoulda
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 1.0.0
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 1.6.2
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id005
 description: longer description of your gem
 email: s.pankevich@gmail.com
 executables: []
@@ -87,15 +76,16 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.textile
 files: 
 - lib/cutter.rb
 - lib/cutter/array.rb
+- lib/cutter/colored_outputs.rb
 - lib/cutter/inspection.rb
 - lib/cutter/railtie.rb
 - lib/cutter/stamper.rb
 - LICENSE.txt
-- README.rdoc
+- README.textile
 has_rdoc: true
 homepage: http://github.com/stanislaw/cutter
 licenses: 
@@ -110,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1041591087
+      hash: 800208499
       segments: 
       - 0
       version: "0"