peekaboo 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1,3 @@
+.yardoc/*
+doc/*
+coverage/*

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+require 'rcov/rcovtask'
+require 'yard'
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.warning = true
+  t.verbose = true
+end
+
+Rcov::RcovTask.new(:rcov) do |t|
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.files = ["lib/**/*.rb", "-", "CHANGELOG.md"]
+end

data/lib/peekaboo/version.rb

@@ -2,7 +2,7 @@ module Peekaboo
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 1
+    PATCH = 2
     
     STRING = [MAJOR, MINOR, PATCH].join('.')
   end

data/peekaboo.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift lib unless $:.include? lib
+
+require 'peekaboo/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = "peekaboo"
+  gem.version     = Peekaboo::Version::STRING
+  gem.summary     = %{Beautiful "mixin" magic for tracing Ruby method calls.}
+  gem.description = "Allows you to log method call information ( input arguments, class/method name, and return value ) without being overly intrusive."
+  gem.email       = "sonny.ruben@gmail.com"
+  gem.homepage    = "http://github.com/sgarcia/peekaboo"
+  gem.authors     = ["Sonny Ruben Garcia"]
+  
+  gem.add_development_dependency "rspec", "1.3.0"
+  gem.add_development_dependency "rcov",  "0.9.9"
+  gem.add_development_dependency "yard",  "0.6.1"
+  
+  gem.files      = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- spec/*`.split("\n")
+end

data/spec/peekaboo/configuration_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Peekaboo::Configuration do
+  
+  before(:each) do
+    @config = Peekaboo::Configuration.new
+  end
+  
+  context "#tracer (default)" do
+    it "should initialize tracing" do
+      @config.tracer.should_not be_nil
+    end
+    
+    it "should adhere to the standard 'Logger' interface" do
+      [ :debug, :info, :warn, :error, :fatal, :unknown ].each { |logger_msg|
+        @config.tracer.should respond_to(logger_msg)
+      }
+    end
+  end
+  
+  context "#trace_with" do
+    it "should set a new tracer for use" do
+      new_tracer = Logger.new STDOUT
+      
+      @config.trace_with new_tracer
+      @config.tracer.should == new_tracer
+    end
+    
+    it "should enforce that new tracer adheres to the standard 'Logger' interface" do
+      lambda {
+        @config.trace_with 'garbage value' 
+      }.should raise_exception('Tracer must respond to debug(), info(), warn(), error(), fatal(), and unknown()')
+    end
+  end
+  
+end

data/spec/peekaboo_spec.rb

@@ -0,0 +1,106 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Peekaboo do
+
+  context ".configuration" do
+    it "should hold a reference to the current configuration" do
+      Peekaboo.configuration.should be_an_instance_of(Peekaboo::Configuration)
+    end
+  end
+  
+  context ".configure" do
+    it "should yield the current configuration" do
+      yielded_object = nil
+      Peekaboo.configure { |x| yielded_object = x }
+      Peekaboo.configuration.should == yielded_object
+    end
+  end
+  
+  context ".enable_tracing_on" do
+    before(:each) do
+      @test_class = new_test_class
+      @test_class.instance_eval { include Peekaboo }
+    end
+    
+    it "should be a singleton method added to any including class" do
+      @test_class.should respond_to(:enable_tracing_on)
+    end
+    
+    it "should store a list of methods to trace on any including class" do
+      methods_to_trace = [:method_no_args, :method_one_arg]
+      @test_class.enable_tracing_on *methods_to_trace
+      @test_class::PEEKABOO_METHOD_LIST.should == methods_to_trace
+    end
+    
+    it "should raise an exception when trying to add a method that is already being traced" do
+      @test_class.enable_tracing_on :some_method
+      lambda {
+        @test_class.enable_tracing_on :some_method
+      }.should raise_exception("Already tracing `some_method'")
+    end
+  end
+  
+  context "instance method tracing" do
+    before(:all) do
+      @test_class = new_test_class
+      @test_class.instance_eval do
+        include Peekaboo
+        enable_tracing_on :method_no_args, :method_one_arg, :method_two_args, :method_optional_args, :method_variable_args, :method_raises
+      end
+      
+      @test_instance = @test_class.new
+      @tracer = Peekaboo.configuration.tracer
+    end
+    
+    it "should not take place on unlisted methods" do
+      @tracer.should_not_receive(:info)
+      @test_instance.method_no_tracing
+    end
+    
+    it "should show listed methods with no arguments" do
+      @tracer.should_receive(:info).with trace_message "Invoking: #{@test_class}#method_no_args with [] ==> Returning: nil"
+      @test_instance.method_no_args
+    end
+    
+    it "should show listed methods with standard arguments" do
+      @tracer.should_receive(:info).
+        with trace_message %{Invoking: #{@test_class}#method_one_arg with ["one"] ==> Returning: nil}
+      @test_instance.method_one_arg 'one'
+      
+      @tracer.should_receive(:info).
+        with trace_message %{Invoking: #{@test_class}#method_two_args with ["one", "two"] ==> Returning: nil}
+      @test_instance.method_two_args 'one', 'two'
+    end
+    
+    it "should show methods with optional arguments" do
+      @tracer.should_receive(:info).
+        with trace_message %{Invoking: #{@test_class}#method_optional_args with [] ==> Returning: nil}
+      @test_instance.method_optional_args
+      
+      @tracer.should_receive(:info).
+        with trace_message %{Invoking: #{@test_class}#method_optional_args with ["override"] ==> Returning: nil}
+      @test_instance.method_optional_args 'override'
+    end
+    
+    it "should show methods with variable arguments" do
+      @tracer.should_receive(:info).
+        with trace_message %{Invoking: #{@test_class}#method_variable_args with [] ==> Returning: nil}
+      @test_instance.method_variable_args
+      
+      @tracer.should_receive(:info).
+        with trace_message %{Invoking: #{@test_class}#method_variable_args with ["one"] ==> Returning: nil}
+      @test_instance.method_variable_args 'one'
+      
+      @tracer.should_receive(:info).
+        with trace_message %{Invoking: #{@test_class}#method_variable_args with ["one", "two"] ==> Returning: nil}
+      @test_instance.method_variable_args 'one', 'two'
+    end
+    
+    it "should show methods that raise an exception" do
+      @tracer.should_receive(:info).
+        with trace_message %{Invoking: #{@test_class}#method_raises with [] !!! Raising: "something went wrong"}
+      lambda { @test_instance.method_raises }.should raise_exception
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'peekaboo'
+require 'ruby-debug'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  def new_test_class
+    Class.new do
+      def method_no_tracing
+      end
+
+      def method_no_args
+      end
+
+      def method_one_arg arg1
+      end
+
+      def method_two_args arg1, arg2
+      end
+
+      def method_optional_args optional = 'default'
+      end
+
+      def method_variable_args *args
+      end
+
+      def method_raises
+        raise 'something went wrong'
+      end
+    end
+  end
+  
+  def trace_message contents, offset = 1
+    file_and_line = caller(1)[0]
+    file, line = file_and_line.split(':')
+    line = line.to_i + offset
+    "#{file}:#{line}\n\t( #{contents} )"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: peekaboo
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Sonny Ruben Garcia
@@ -75,11 +75,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README.md
+- .gitignore
 - CHANGELOG.md
+- README.md
+- Rakefile
 - lib/peekaboo.rb
 - lib/peekaboo/configuration.rb
 - lib/peekaboo/version.rb
+- peekaboo.gemspec
+- spec/peekaboo/configuration_spec.rb
+- spec/peekaboo_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/sgarcia/peekaboo
 licenses: []
@@ -114,5 +121,8 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Beautiful "mixin" magic for tracing Ruby method calls.
-test_files: []
-
+test_files: 
+- spec/peekaboo/configuration_spec.rb
+- spec/peekaboo_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb