peeek 1.0.3 → 1.0.4

data/README.md

@@ -3,6 +3,18 @@ Peeek
 
 Peeek peeks at calls of a method
 
+Get started quickly
+-------------------
+
+Peeek has command line interface, you can get started quickly after installed.
+
+    $ gem install peeek
+    $ peeek -H'String#%' -e 'puts "%s (%d)" % ["Koyomi", 18]'
+    Koyomi (18)
+    String#% from "%s (%d)" with ["Koyomi", 18] returned "Koyomi (18)" in -e at 1
+
+See at the details on using by `peeek -h`.
+
 Installation
 ------------
 

data/TODO.md

@@ -0,0 +1,2 @@
+* Implement Peeek::Readily#peeek_lazily
+* Can hook methods that is using in Peeek::Hook#call (e.g. UnboundMethod#bind)

data/lib/peeek.rb

@@ -3,6 +3,7 @@ require 'peeek/hook'
 require 'peeek/hooks'
 require 'peeek/supervisor'
 require 'peeek/calls'
+require 'peeek/lazy'
 
 class Peeek
 
@@ -89,6 +90,8 @@ class Peeek
   #
   # @see Peeek::Hook.create
   def hook(object, *method_specs, &process)
+    object = object.take if object.is_a?(Lazy) and object.defined?
+
     hooks = method_specs.map do |method_spec|
       Hook.create(object, method_spec, &process).tap do |hook|
         if hook.defined?
@@ -137,10 +140,26 @@ class Peeek
     # @yieldparam [Peeek::Call] call a call to the methods
     #
     # @see Peeek#hook
+    # @see Peeek::Readily#peeek_lazily
     def peeek(*method_specs, &process)
       Peeek.current.hook(self, *method_specs, &process)
     end
 
+    # Register a hook to methods of an object to the current Peeek object. The
+    # object is that is pointed by self, work well even if the object isn't
+    # defined when called this method.
+    #
+    # @param [Array<String, Array<Symbol>] method_specs method specifiers of
+    #   the object. see also examples of {Peeek::Hook.create}
+    # @yield [call] process a call to the methods. give optionally
+    # @yieldparam [Peeek::Call] call a call to the methods
+    #
+    # @see Peeek#hook
+    # @see Peeek::Readily#peeek
+    def peeek_lazily(*method_specs, &process)
+      Lazy.new(self).peeek(*method_specs, &process)
+    end
+
   end
 
   Object.__send__(:include, Readily)

data/lib/peeek/call.rb

@@ -7,14 +7,16 @@ class Peeek
     # @param [Array<String>] backtrace backtrace the call occurred
     # @param [Module, Class, Object] receiver object that received the call
     # @param [Array] arguments arguments at the call
+    # @param [Proc] block block at the call
     # @param [Peeek::Call::Result] result result of the call
-    def initialize(hook, backtrace, receiver, arguments, result)
+    def initialize(hook, backtrace, receiver, arguments, block, result)
       raise ArgumentError, 'invalid as result' unless result.is_a?(Result)
       @hook = hook
       @backtrace = backtrace
       @file, @line = extract_file_and_line(backtrace.first)
       @receiver = receiver
       @arguments = arguments
+      @block = block
       @result = result
     end
 
@@ -42,6 +44,10 @@ class Peeek
     # @return [Array] arguments at the call
     attr_reader :arguments
 
+    # @attribute [r] block
+    # @return [Proc] block at the call
+    attr_reader :block
+
     # @attribute [r] result
     # @return [Peeek::Call::Result] result of the call
     attr_reader :result
@@ -84,6 +90,11 @@ class Peeek
         parts << "with (#{@arguments.map(&:inspect) * ', '})"
       end
 
+      if @block
+        conjunction = @arguments.empty? ? 'with' : 'and'
+        parts << "#{conjunction} a block"
+      end
+
       if returned?
         parts << "returned #{return_value.inspect}"
       elsif raised?

data/lib/peeek/hook.rb

@@ -171,19 +171,23 @@ class Peeek
       private :parse
     end
 
-    def call(backtrace, receiver, args)
+    def call(backtrace, receiver, args, block)
       method = @original_method.is_a?(UnboundMethod) ? @original_method.bind(receiver) : @original_method
 
       result = begin
                  Call::ReturnValue.new(method[*args])
-               rescue => e
+               rescue Exception => e
                  e.set_backtrace(backtrace)
                  Call::Exception.new(e)
                end
 
-      call = Call.new(self, backtrace, receiver, args, result)
-      @calls << call
-      @process[call] if @process
+      call = Call.new(self, backtrace, receiver, args, block, result)
+
+      unless call.file =~ %r(lib/peeek(?:\.rb|/))
+        @calls << call
+        @process[call] if @process
+      end
+
       raise call.exception if call.raised?
       call.return_value
     end

data/lib/peeek/hook/instance.rb

@@ -33,7 +33,7 @@ class Peeek
       # @yieldreturn [Object] return value of the original method
       def link
         raise ArgumentError, 'block not supplied' unless block_given?
-        define_method { |*args| yield caller, self, args }
+        define_method { |*args, &block| yield caller, self, args, block }
       end
 
       # Unlink the hook from the instance method.

data/lib/peeek/hook/singleton.rb

@@ -33,7 +33,7 @@ class Peeek
       # @yieldreturn [Object] return value of the original method
       def link
         raise ArgumentError, 'block not supplied' unless block_given?
-        define_method { |*args| yield caller, self, args }
+        define_method { |*args, &block| yield caller, self, args, block }
       end
 
       # Unlink the hook from the method.

data/lib/peeek/version.rb

@@ -1,3 +1,3 @@
 class Peeek
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/spec/peeek/call_spec.rb

@@ -3,8 +3,9 @@ require 'peeek/call'
 def sample_call(attrs = {})
   hook   = attrs[:hook] || stub('Peeek::Hook', :to_s => 'String#%')
   args   = attrs[:args] || ['Koyomi', 18]
+  block  = attrs.key?(:block) ? attrs[:block] : lambda { }
   result = attrs[:result] || Peeek::Call::ReturnValue.new('Koyomi (18)')
-  Peeek::Call.new(hook, sample_backtrace, '%s (%d)', args, result)
+  Peeek::Call.new(hook, sample_backtrace, '%s (%d)', args, block, result)
 end
 
 def sample_backtrace
@@ -19,39 +20,68 @@ def sample_exception
   Peeek::Call::Exception.new(:exception)
 end
 
-describe Peeek::Call do
-  describe '#initialize' do
-    it do
-      expect {
-        described_class.new(:hook, ["koyomi.rb:7:in `print'"], '%s (%d)', ['Koyomi', 18], :result)
-      }.to raise_error(ArgumentError, 'invalid as result')
-    end
+describe Peeek::Call, '#initialize' do
+  it 'raises ArgumentError if the result is invalid' do
+    lambda { sample_call(:result => :result) }.should raise_error(ArgumentError, 'invalid as result')
   end
+end
 
-  context 'basic instance attributes' do
-    subject {
-      described_class.new(
-        :hook,
-        ["koyomi.rb:7:in `print'", "koyomi.rb:21:in `<main>'"],
-        '%s (%d)',
-        ['Koyomi', 18],
-        Peeek::Call::ReturnValue.new('Koyomi (18)')
-      )
-    }
+describe Peeek::Call, '#hook' do
+  it 'returns the value when constructed the call' do
+    hook = :hook
+    call = sample_call(:hook => hook)
+    call.hook.should == hook
+  end
+end
 
-    its(:hook)      { should == :hook }
-    its(:backtrace) { should == ["koyomi.rb:7:in `print'", "koyomi.rb:21:in `<main>'"] }
-    its(:file)      { should == 'koyomi.rb' }
-    its(:line)      { should == 7 }
-    its(:receiver)  { should == '%s (%d)' }
-    its(:arguments) { should == ['Koyomi', 18] }
-    its(:result)    { should == Peeek::Call::ReturnValue.new('Koyomi (18)') }
+describe Peeek::Call, '#backtrace' do
+  it 'returns the value when constructed the call' do
+    call = sample_call
+    call.backtrace.should == sample_backtrace
   end
 end
 
-describe Peeek::Call, '#initialize' do
-  it 'raises ArgumentError if the result is invalid' do
-    lambda { sample_call(:result => :result) }.should raise_error(ArgumentError, 'invalid as result')
+describe Peeek::Call, '#file' do
+  it 'returns name of top file on the backtrace' do
+    call = sample_call
+    call.file.should == 'koyomi.rb'
+  end
+end
+
+describe Peeek::Call, '#line' do
+  it 'returns top line number on the backtrace' do
+    call = sample_call
+    call.line.should == 7
+  end
+end
+
+describe Peeek::Call, '#receiver' do
+  it 'returns the value when constructed the call' do
+    call = sample_call
+    call.receiver.should == '%s (%d)'
+  end
+end
+
+describe Peeek::Call, '#arguments' do
+  it 'returns the value when constructed the call' do
+    call = sample_call
+    call.arguments.should == ['Koyomi', 18]
+  end
+end
+
+describe Peeek::Call, '#block' do
+  it 'returns the value when constructed the call' do
+    block = lambda { }
+    call = sample_call(:block => block)
+    call.block.should == block
+  end
+end
+
+describe Peeek::Call, '#result' do
+  it 'returns the value when constructed the call' do
+    result = sample_return_value
+    call = sample_call(:result => result)
+    call.result.should == result
   end
 end
 
@@ -107,35 +137,49 @@ describe Peeek::Call, '#to_s' do
   context 'with no arguments' do
     it 'returns the stringified call' do
       call = sample_call(:args => [])
-      call.to_s.should == 'String#% from "%s (%d)" returned "Koyomi (18)" in koyomi.rb at 7'
+      call.to_s.should == 'String#% from "%s (%d)" with a block returned "Koyomi (18)" in koyomi.rb at 7'
     end
   end
 
   context 'with an argument' do
     it 'returns the stringified call' do
       call = sample_call(:args => [:arg])
-      call.to_s.should == 'String#% from "%s (%d)" with :arg returned "Koyomi (18)" in koyomi.rb at 7'
+      call.to_s.should == 'String#% from "%s (%d)" with :arg and a block returned "Koyomi (18)" in koyomi.rb at 7'
     end
   end
 
   context 'with multiple arguments' do
     it 'returns the stringified call' do
       call = sample_call(:args => [:arg1, :arg2])
-      call.to_s.should == 'String#% from "%s (%d)" with (:arg1, :arg2) returned "Koyomi (18)" in koyomi.rb at 7'
+      call.to_s.should == 'String#% from "%s (%d)" with (:arg1, :arg2) and a block returned "Koyomi (18)" in koyomi.rb at 7'
+    end
+  end
+
+  context 'with no block' do
+    it 'returns the stringified call' do
+      call = sample_call(:block => nil)
+      call.to_s.should == 'String#% from "%s (%d)" with ("Koyomi", 18) returned "Koyomi (18)" in koyomi.rb at 7'
+    end
+  end
+
+  context 'with a block' do
+    it 'returns the stringified call' do
+      call = sample_call(:block => lambda { })
+      call.to_s.should == 'String#% from "%s (%d)" with ("Koyomi", 18) and a block returned "Koyomi (18)" in koyomi.rb at 7'
     end
   end
 
   context 'with a return value result' do
     it 'returns the stringified call' do
       call = sample_call(:result => sample_return_value)
-      call.to_s.should == 'String#% from "%s (%d)" with ("Koyomi", 18) returned :return_value in koyomi.rb at 7'
+      call.to_s.should == 'String#% from "%s (%d)" with ("Koyomi", 18) and a block returned :return_value in koyomi.rb at 7'
     end
   end
 
   context 'with an exception result' do
     it 'returns the stringified call' do
       call = sample_call(:result => sample_exception)
-      call.to_s.should == 'String#% from "%s (%d)" with ("Koyomi", 18) raised :exception in koyomi.rb at 7'
+      call.to_s.should == 'String#% from "%s (%d)" with ("Koyomi", 18) and a block raised :exception in koyomi.rb at 7'
     end
   end
 end

data/spec/peeek/hook/instance_spec.rb

@@ -16,7 +16,7 @@ describe Peeek::Hook::Instance, '#target_method' do
     linker = sample_instance_linker
     method = linker.target_method
     method.owner.should == String
-    method.name.should == :%
+    method.name.to_sym.should == :%
   end
 end
 

data/spec/peeek/hook/singleton_spec.rb

@@ -16,7 +16,7 @@ describe Peeek::Hook::Singleton, '#target_method' do
     linker = sample_singleton_linker
     method = linker.target_method
     method.receiver.should == Regexp
-    method.name.should == :quote
+    method.name.to_sym.should == :quote
   end
 end
 

data/spec/peeek/hook_spec.rb

@@ -175,7 +175,7 @@ describe Peeek::Hook, '#link' do
 
   it "calls #{described_class}::Linker#link with the block" do
     @linker.should_receive(:link).with { }.and_return do |&block|
-      block.arity.should == 3
+      block.arity.should == 4
       @original_method
     end
 
@@ -319,12 +319,14 @@ describe 'recording of a call by', Peeek::Hook do
   end
 
   it 'sets attributes to the call' do
-    line = __LINE__; '%s (%d)' % ['Koyomi', 18]
+    block = lambda { }
+    line = __LINE__; '%s (%d)'.%(['Koyomi', 18], &block)
     call = @hook.calls.first
     call.file.should == __FILE__
     call.line.should == line
     call.receiver.should == '%s (%d)'
     call.arguments.should == [['Koyomi', 18]]
+    call.block.should eq(block)
   end
 
   context 'if a value returned' do
@@ -357,6 +359,22 @@ describe 'recording of a call by', Peeek::Hook do
       exception.should equal(call.exception)
     end
 
+    it 'handles critical exception (inherited Exception)' do
+      hook = Peeek::Hook.create(Kernel, :require)
+      hook.link
+
+      exception = begin
+                    require 'undefined_library'
+                  rescue LoadError => e
+                    e
+                  end
+
+      call = hook.calls.first
+      exception.should equal(call.exception)
+
+      hook.unlink
+    end
+
     it 'raises the exception with valid backtrace' do
       line = __LINE__; exception = '%s (%d)' % ['Koyomi'] rescue $!
       exception.backtrace.first.should be_start_with("#{__FILE__}:#{line}")

metadata

@@ -1,41 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: peeek
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
+  prerelease: 
 platform: ruby
 authors:
 - Takahiro Kondo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-17 00:00:00.000000000 Z
 dependencies:
 - !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'
 - !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'
 description: Peek at calls of a method
@@ -52,6 +57,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/peeek
 - lib/peeek.rb
 - lib/peeek/call.rb
@@ -84,26 +90,27 @@ files:
 homepage: https://github.com/takkkun/peeek
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Peek at calls of a method
 test_files:
 - spec/peeek/call_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 4cf3690abfc7e18ba772e5813bd248c6e8f77e31
-  data.tar.gz: 97b35ef5d8c535fc08db01336fbc0ee319be02f9
-SHA512:
-  metadata.gz: 19ddd27a103fe0c1c52484f1525e73743ed7755bdfbc323a3de52263bc4ba2aee2694280ac50ccdeb0d5fbac44d412812c3d745c44c560c81a594c1ed2fd767d
-  data.tar.gz: 31f272cd92df1acf44b5e16877a30c1c7975e0fec030322c7cb8308449b69ef421153af4b0cf8048eff5c9f4fa967b2e2eebc18f0c5793ce9be78d06bcf45b5a