cutter 0.8.2 → 0.8.3

data/README.md

@@ -0,0 +1,157 @@
+# Cutter
+
+Two-methods-gem I use a lot for simple debugging & performance measuring purposes.
+
+Include it into Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'cutter'
+end
+```
+
+## I) #inspect! (or #iii - it is an alias)
+
+Insert #inspect! method into any of your methods:
+
+```ruby
+  def your_method *your_args
+    inspect! {} # curly braces are important!    
+    ...
+  end
+
+  # your_method(1,"foo",:bar) => 
+  
+  # method `your_method'
+  #   variables: 
+  #     your_args: [1, "foo", :bar]
+```
+
+It gives simple but nice trace for inspection: method's name and args that were passed to method.
+
+With ```inspect!(:instance){}``` we also see instance variables:
+
+```ruby
+  def instance_demo a, b 
+    @instance_var = "blip!"
+    inspect!(:instance){}
+  end
+
+  # instance_demo 1, 2
+  # method: `instance_demo' 
+  #   called from class: RSpec::Core::ExampleGroup::Nested_1::Nested_1
+  #   local_variables: 
+  #     a: 1
+  #     b: 2
+  #   instance_variables: 
+  #     @instance_var: blip!
+```
+
+With ```inspect!(:self){}``` we have self#inspect of class to which method belongs to:
+
+```ruby  
+  def method_self_inspect name, *args
+    # ...
+    inspect!(:self) {}
+  end
+
+  # method_self_inspect(1,2,3,4,5) =>
+  
+  # method: `method_self_inspect'
+  #   called from class: SelfInspectDemo
+  #   variables: 
+  #     name: 1
+  #     args: [2, 3, 4, 5]
+  #     block: 
+  #   self inspection:
+  #     #<SelfInspectDemo:0x82be488 @variable="I'm variable">
+```
+
+Option :caller gives us caller methods chain:
+
+```ruby  
+  def method_caller_chain name, *args
+    # ...
+    inspect!(:caller)
+  end
+
+  # method_caller_chain(1,2,3,4,5) => 
+  
+  # method: `method_caller_chain'
+  #   called from class: RSpec::Core::ExampleGroup::Nested_1::Nested_1
+  #   variables: 
+  #     name: 1
+  #     args: [2, 3, 4, 5]
+  #     block: 
+  #   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'
+```
+
+And finally ```inspect!(:max){}``` produces maximum information: options
+:instance, :self, :caller are included + Ruby's ordinary #inspect method
+is called on every variable.
+
+```ruby
+  def maximal
+    inspect!(:max){}
+  end
+
+  # maximal(1, :two, "three", :four => 5) =>
+  #
+  # method: `maximal' (maximal tracing)
+  #   called from class: RSpec::Core::ExampleGroup::Nested_1::Nested_1
+  #   local_variables: 
+  #   args: [1, :two, "three", {:four=>5}]
+  #   instance_variables: 
+  #     @example: #<RSpec::Core::Example:0xa1d378 >
+  #     ...
+  #   self inspection:
+  #   #<RSpec::Core::ExampleGroup::Nested_1::Nested_1:0x9e5f8f4
+  #   ...
+  #   caller methods: 
+  #   /home/stanislaw/work/gems/cutter/spec/inspection/demo_spec.rb:28:in `maximal'
+  #   /home/stanislaw/work/gems/cutter/spec/inspection/demo_spec.rb:54:in `block (3 levels) in <top (required)>'
+  #   ...
+```
+
+If you want all #inspect! methods fall silent at once, use
+
+```ruby
+Cutter::Inspection.quiet!
+```
+
+To make them sound again do
+
+```ruby
+Cutter::Inspection.loud!
+```
+
+You can clone it and try 
+
+```ruby
+bundle exec rspec spec/inspection/demo_spec.rb
+```  
+
+Very! Very simple!
+
+### Notes
+1. Instead of #inspect! you can use #iii - just an alias more convenient for typing.
+2. #inspect! colorizes its output. If somebody suggests even better color scheme, I will be thankful.
+
+## II) #stamper
+
+Description is coming...
+
+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.
+
+## Contributors
+
+* Stanislaw Pankevich
+* Kristian Mandrup
+
+## Copyright
+
+Copyright (c) 2011 Stanislaw Pankevich

data/lib/cutter.rb

@@ -1,3 +1,5 @@
+require 'cutter/version'
+
 require 'cutter/array'
 require 'cutter/railtie' if defined?(Rails)
 

data/lib/cutter/colored_outputs.rb

@@ -29,28 +29,30 @@ module Cutter
       end
 
       def colors_config
-        @colors ||= {:line => :blue, 
-                     :time => :light_blue,
+        @colors ||= {
+                      :line => :blue, 
+                      :time => :light_blue,
 
-                     :message_name => :cyan,
-                     :message_line => :cyan,
-                     :total_line => :yellow,
-                     :total_count => :yellow
-                     # 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
+                      :message_name => :cyan,
+                      :message_line => :cyan,
+                      :total_line => :yellow,
+                      :total_count => :yellow,
+                     
+                      # Colors for #inspect!
+                      #  :called_from => :light_magenta,
+                      :class_name => :light_green,
+                      :method => :red,
+                      :method_name => :yellow,
+                      # :lv => :blue,
+                      # :lv_names => :magenta,
+                      # :lv_values => :light_red,
+                      # :iv => :cyan,
+                      :iv_names => :cyan,
+                      :iv_values => :light_blue,
+                      :self_inspection => :red,
+                      :self_inspection_trace => :blue,
+                      :caller_methods => :red,
+                      :caller_method => :green
                     }
       end
     end

data/lib/cutter/inspection.rb

@@ -29,92 +29,102 @@ class Object
     raise ArgumentError, "Try inspect(binding) or inspect! {}", caller if (!block_given? && !_binding)
     _binding ||= block.binding
     
-    options = options.extract_options! 
-    
-    max = options[:max]
-    options.maximize_options! if max 
-
-    # Want caller methods chain to be traced? - pass option :level to inspect!
-    level = options[:level]
-    _caller = caller
+    max = true if options.include? :max
+    options << :instance << :max << :self << :caller if max
+    options.uniq!
+ 
+    iv = true if options.include? :instance
+
+    # Want caller methods chain to be traced? - pass option :caller to #inspect!
+    _caller = true if options.include? :caller
    
-    self_inspection = eval('self.inspect', _binding) if options[:inspect]
+    self_inspection = eval('self.inspect', _binding) if options.include? :self
 
     # Basic info
     method_name = eval('__method__', _binding)
     class_name = eval('self.class', _binding)
     
-    puts "\n%s `%s' %s" % ['method:'.__cs(:method), method_name.__cs(:method_name), ('(maximal tracing)' if max)]
-    puts "  %s %s" % ['called from class:'.__cs(:called_from), class_name.__cs(:class_name)]
+    puts "\n%s `%s' %s" % ['method:'.to_colorized_string(:method), method_name.to_colorized_string(:method_name), ('(maximal tracing)' if max)]
+    puts "  %s %s" % ['called from class:'.to_colorized_string(:called_from), class_name.to_colorized_string(:class_name)]
 
     # Local Variables
     lvb = eval('local_variables',_binding)
-    puts "  %s %s" % ['local_variables:'.__cs(:lv), ("[]" if lvb.empty?)]
+    puts "  %s %s" % ['local_variables:'.to_colorized_string(:lv), ("[]" if lvb.empty?)]
 
     lvb.map do |lv|
       local_variable = eval(lv.to_s, _binding)
-      local_variable = (max ? local_variable.inspect : local_variable.__rs)
+      local_variable = (max ? local_variable.inspect : local_variable.to_real_string)
 
-      puts "    %s: %s" % [lv.__cs(:lv_names), local_variable.__cs(:lv_values)] 
+      puts "    %s: %s" % [lv.to_colorized_string(:lv_names), local_variable.to_colorized_string(:lv_values)] 
     end if lvb
 
     # Instance Variables
-    ivb = eval('instance_variables',_binding)
-    
-    puts "  %s %s" % ["instance_variables:".__cs(:iv), ("[]" if ivb.empty?)]
-    
-    ivb.map do |iv|
-      instance_variable = eval(iv.to_s, _binding)
-      instance_variable = (max ? instance_variable.inspect : instance_variable.__rs)
-     
-      puts "    %s: %s" % [iv.__cs(:iv_names), instance_variable.__cs(:iv_values)] 
-    end if ivb
+    begin
+      ivb = eval('instance_variables',_binding)
+      
+      puts "  %s %s" % ["instance_variables:".to_colorized_string(: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 "    %s: %s" % [iv.to_colorized_string(:iv_names), instance_variable.to_colorized_string(:iv_values)] 
+      end if ivb
+    end if iv
 
     # Self inspection 
     begin
-      puts "  self inspection:".__cs(:self_inspection)
-      puts "    %s" % self_inspection.__cs(:self_inspection_trace)
+      puts "  self inspection:".to_colorized_string(:self_inspection)
+      puts "  %s" % self_inspection.to_colorized_string(:self_inspection_trace)
     end if self_inspection
 
     # Caller methods chain
     begin
-    puts "  caller methods: ".__cs(:caller_methods)
-    0.upto(level).each {|index|
-      puts "    %s" % _caller[index].__cs(:caller_method)
-    }
-    end if level
+      puts "  caller methods: ".to_colorized_string(:caller_methods)
+      caller.each do |meth|
+        puts "  %s" % meth.to_colorized_string(:caller_method)
+      end
+    end if _caller
    
     puts "\n"
+    
     # Yield mysterious things if they exist in block.
-    yield if block_given? 
+    yield if block_given?
   end
 
-  protected
+  alias :iii :inspect!
 
-  def caller_method_name(level = 1)
-    caller[level][/`([^']*)'/,1].to_sym
-  end
-
-  def maximize_options!
-    self.merge!({:max => true, :inspect => true, :level => 2})
-  end
+  protected
 
-  # ("real string") Now used to print Symbols with colons
-  def __rs
+  # "Real string". It is now used to print Symbols with colons
+  def to_real_string
     return ":#{self.to_s}" if self.class == Symbol
-    self
+    to_s
   end
 
-  def __cs obj
-    color = __colors[obj] || :default
+  def to_colorized_string obj
+    colors = Cutter::ColoredOutputs.colors_config
+    color = colors[obj] || :default
     color != :default ? to_s.send(color) : to_s
   end
+end
 
-  private
+class Object
+  def rrr object = nil
+    raise object.inspect
+  end
 
-  def __colors
-    Cutter::ColoredOutputs.colors_config
+  def ppp object = nil 
+    puts object.inspect
   end
 
+  def lll object = nil
+    Rails.logger.info object.inspect
+  end if defined? Rails
 end
 
+# def caller_method_name(level = 1)
+#   caller[level][/`([^']*)'/,1].to_sym
+# end
+
+

data/lib/cutter/version.rb

@@ -0,0 +1,3 @@
+module Cutter
+  VERSION="0.8.3"
+end

metadata

@@ -1,121 +1,123 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cutter
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.8.3
   prerelease: 
-  version: 0.8.2
 platform: ruby
-authors: 
+authors:
 - stanislaw
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-09 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.5"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.6.2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id005
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: longer description of your gem
 email: s.pankevich@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.textile
-files: 
+- README.md
+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
+- lib/cutter/version.rb
 - LICENSE.txt
-- README.textile
-has_rdoc: true
+- README.md
 homepage: http://github.com/stanislaw/cutter
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -202257491
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -579611375
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: one-line summary of your gem
 test_files: []
-

data/README.textile

@@ -1,189 +0,0 @@
-h1. Cutter
-
-Two-methods-gem I use a lot for simple debugging & performance measuring purposes.
-
-Include it into Gemfile:
-
-<pre>
-<code>
-gem 'cutter'
-</code>
-</pre>
-
-h2. I) #inspect! 
-
-Insert #inspect! method into any of your methods:
-
-<pre>
-<code>
-  def your_method *your_args
-    inspect! {} # this string exactly!    
-    ...
-  end
-
-  your_method(1,"foo",:bar) => 
-  
-  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
-  
-  your_another_method(1,"foo",:bar) => 
-  
-  method `your_another_method'
-    variables: 
-      first: 1
-      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) {}
-  end
-
-  method_self_inspect(1,2,3,4,5) =>
-  
-  method: `method_self_inspect'
-    called from class: SelfInspectDemo
-    variables: 
-      name: 1
-      args: [2, 3, 4, 5]
-      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)
-  end
-
-  method_caller_chain(1,2,3,4,5) => 
-  
-  method: `method_caller_chain'
-    called from class: RSpec::Core::ExampleGroup::Nested_1::Nested_1
-    variables: 
-      name: 1
-      args: [2, 3, 4, 5]
-      block: 
-    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!@
-To make them sound again do
-  @Cutter::Inspection.loud!@
-
-You can clone it and try 
-  
-  @bundle exec rspec spec/inspection/demo_spec.rb@
-  
-Very! Very simple!
-
-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.
-
-h2. Contributors
-
-* Stanislaw Pankevich
-* Kristian Mandrup
-
-h2. Copyright
-
-Copyright (c) 2011 Stanislaw Pankevich
-