kgb 0.9.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.junk
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 by David Albert, http://dave.is/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+KGB
+===
+
+KGB spies on your classes and tells you what methods are being called. I wrote it to let me see what methods were being called on the `socket` library while writing [Eventless](http://github.com/davidbalbert/eventless).
+
+##How it works
+
+Tell KGB what you want it to watch, and it reports back after the program has run:
+
+```ruby
+# kgb_test.rb
+
+require 'kgb'
+
+class Winston
+  def pretend_to_be_a_sheep
+    puts "Big Brother knows best"
+  end
+
+  def think_for_yourself!
+    puts "Freedom is the freedom to say two plus two equals four"
+  end
+end
+
+KGB.spy_on(Winston)
+
+winston = Winston.new
+winston.pretend_to_be_a_sheep
+winston.pretend_to_be_a_sheep
+winston.pretend_to_be_a_sheep
+winston.think_for_yourself!
+winston.pretend_to_be_a_sheep
+```
+
+```
+$ ruby kgb_test.rb
+Big Brother knows best
+Big Brother knows best
+Big Brother knows best
+Freedom is the freedom to say two plus two equals four
+Big Brother knows best
+
+Winston:
+
+method                    invocations
+pretend_to_be_a_sheep     4
+think_for_yourself!       1
+```
+
+KGB prints to standard error so you can isolate it's output from the rest of the program:
+
+```
+$ ruby kgb_test.rb >/dev/null
+
+Winston:
+
+method                    invocations
+pretend_to_be_a_sheep     4
+think_for_yourself!       1
+```
+
+KGB only tracks calls to instance methods defined on the object itself, not it's parents. Thus if you want to watch all of the `Socket` methods, you would want to do something like this:
+
+```ruby
+KGB.spy_on(Socket, BasicSocket, IO)
+```
+
+##Install
+
+```
+$ gem install kgb
+```
+
+##Contributing
+
+1. Fork
+2. Branch
+3. Write code
+4. Commit
+5. Push
+6. Create Pull Request
+7. ...
+8. Profit!
+
+##License
+
+KGB is licensed under the MIT License. See LICENSE for more information.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kgb.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kgb/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kgb"
+  s.version     = KGB::VERSION
+  s.authors     = ["David Albert"]
+  s.email       = ["davidbalbert@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A little library for counting method invocations}
+  s.description = %q{A little library for spying on your classes and counting method invocations}
+
+  s.rubyforge_project = "kgb"
+
+  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 "rcapture"
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/kgb/version.rb

@@ -0,0 +1,3 @@
+module KGB
+  VERSION = "0.9.0"
+end

data/lib/kgb.rb

@@ -0,0 +1,57 @@
+require "kgb/version"
+require 'rcapture'
+
+module KGB
+  def self.spy_on(*classes)
+    @agents ||= []
+    classes.each do |klass|
+      @agents << Agent.new(klass)
+    end
+
+    nil
+  end
+
+  def self.print_reports
+    @agents.each { |agent| agent.report }
+  end
+
+  PADDING = 4
+
+  class Agent
+    def initialize(klass)
+      @invocations = {}
+
+      @class = klass
+      @class.class_eval do
+        include RCapture::Interceptable
+      end
+
+      @class.capture :methods => @class.instance_methods(false) do |info|
+        @invocations[info.method] ||= 0
+        @invocations[info.method] += 1
+      end
+    end
+
+    def report
+      max_length = @invocations.keys.map { |key| key.length }.max
+      max_length = 6 if max_length < "method".length
+
+      say
+      say "#{@class}:"
+      say
+
+      say "method" + " " * (max_length - 6 + PADDING) + "invocations"
+      @invocations.sort { |a, b| b[1] <=> a[1] }.each do |method, times|
+        say method.to_s + " " * (max_length - method.length + PADDING) + times.to_s
+      end
+    end
+  end
+end
+
+END {
+  KGB.print_reports
+}
+
+def say(*args)
+  STDERR.puts(*args)
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: kgb
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- David Albert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rcapture
+  requirement: &70150658171700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70150658171700
+description: A little library for spying on your classes and counting method invocations
+email:
+- davidbalbert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kgb.gemspec
+- lib/kgb.rb
+- lib/kgb/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: kgb
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A little library for counting method invocations
+test_files: []