squeal 1.0.0

data/README.textile

@@ -0,0 +1,69 @@
+h1. Squeal
+
+A simple object instantiation counter.
+
+Inspired by oink (http://github.com/noahd1/oink).
+I needed a non-rails one for my search engine project Picky (http://github.com/floere/picky), but oink did not fit well.
+
+Note: It reports cumulatively until @Squeal.reset@ is called.
+
+Only works on certain Ruby classes yet (not String, for example).
+
+h1. Examples
+
+h2. Installation
+
+  gem install squeal
+
+h2. On a single class.
+
+  require 'squeal'
+   
+  TestClass.squeal do
+    TestClass.new
+    TestClass.new
+    Object.new
+    String.new
+  end
+  TestClass.new
+   
+  Squeal.report # => 'TestClass: 2'
+
+h2. On multiple classes
+
+  require 'squeal'
+   
+  # Aliased as Squeal.record
+  #
+  Squeal.squeal(Object, TestClass) do
+    TestClass.new
+    String.new
+    Object.new
+    TestClass.new
+    String.new
+  end
+  Object.new
+  TestClass.new
+   
+  Squeal.report # => 'Object: 1, TestClass: 2'
+
+h2. Without a block
+
+  require 'squeal'
+   
+  # Aliased as Squeal.squeal
+  #
+  Squeal.record Object, TestClass
+  
+  TestClass.new
+  String.new
+  Object.new
+  TestClass.new
+  String.new
+  
+  Squeal.stop
+  
+  Object.new
+  TestClass.new
+   
+  Squeal.report # => 'Object: 1, TestClass: 2'

data/lib/extensions/class.rb

@@ -0,0 +1,15 @@
+class Class
+  
+  # Record this or the given classes.
+  #
+  def squeal &block
+    Squeal.record self, &block
+  end
+  
+  # Increments this class' instantiation counter by one.
+  #
+  def squeal_increment
+    Squeal.increment self
+  end
+  
+end

data/lib/squeal.rb

@@ -0,0 +1,2 @@
+require File.expand_path "../extensions/class", __FILE__
+require File.expand_path "../squeal/squeal", __FILE__

data/lib/squeal/squeal.rb

@@ -0,0 +1,78 @@
+class Squeal
+  
+  module InitializeWrapper
+    
+    alias_method :initialize_before_squeal, :initialize
+    
+    def initialize *args, &block
+      instance = initialize_before_squeal *args, &block
+      self.class.squeal_increment
+      instance
+    end
+    
+  end
+  
+  class << self
+    
+    # Increment the counter for the given class.
+    #
+    def increment klass
+      return unless @recording && @counters[klass]
+      @counters[klass] += 1
+    end
+    
+    # Install and reset for the given class.
+    #
+    def reset_for klass
+      install_on klass
+      @counters ||= {}
+      @counters[klass] ||= 0
+      self
+    end
+    
+    # Installs squeal on the given class if it isn't yet installed.
+    #
+    def install_on klass
+      klass.send :include, InitializeWrapper unless klass.include?(InitializeWrapper)
+    end
+    
+    # Record the given classes for the duration of the block.
+    #
+    def record *klasses
+      @recording = true
+      klasses.each { |klass| reset_for klass }
+      if block_given?
+        yield
+        stop
+      end
+      self
+    end
+    alias squeal record
+    
+    # Stop recording.
+    #
+    def stop
+      @recording = false
+    end
+    
+    # Returns a string with the current instantiation count.
+    #
+    # Example:
+    # * SomeClass: 2, SomeOtherClass: 10
+    #
+    def report
+      result = []
+      @counters.each_pair do |klass, number|
+        result << "#{klass}: #{number}"
+      end
+      result.sort.join(', ')
+    end
+    
+    # Resets the counters.
+    #
+    def reset
+      @counters = {}
+    end
+  end
+  
+end

data/spec/lib/squeal/squeal_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Squeal do
+  before(:each) do
+    Object.send :remove_const, :TestClass if Object.const_defined?(:TestClass)
+    TestClass = Class.new
+  end
+  after(:each) do
+    Squeal.reset
+  end
+  it 'allows a proxy object' do
+    lambda { TestClass.squeal }.should_not raise_error
+  end
+  it 'records with a block' do
+    TestClass.squeal do
+      TestClass.new
+      TestClass.new
+      Object.new
+      String.new
+    end
+    TestClass.new
+    
+    Squeal.report.should == 'TestClass: 2'
+  end
+  it 'records all mentioned classes with a block' do
+    Squeal.squeal(Object, TestClass) do
+      TestClass.new
+      String.new
+      Object.new
+      TestClass.new
+      String.new
+    end
+    Object.new
+    TestClass.new
+    
+    Squeal.report.should == 'Object: 1, TestClass: 2'
+  end
+  it 'records the class it is used on with a block' do
+    TestClass.squeal do
+      TestClass.new
+      Hash.new
+      TestClass.new
+      Object.new
+      Hash.new
+    end
+    TestClass.new
+    
+    Squeal.report.should == 'TestClass: 2'
+  end
+  it 'does not record if squeal.record has not been called' do
+    Hash.new
+    TestClass.new
+    
+    Squeal.report.should == ''
+  end
+  it 'reports cumulatively until reset' do
+    Hash.new
+    TestClass.new
+    
+    Squeal.report.should == ''
+    
+    TestClass.squeal do
+      TestClass.new
+      Hash.new
+      TestClass.new
+      Object.new
+      Hash.new
+    end
+    
+    Squeal.report.should == 'TestClass: 2'
+    
+    Squeal.record(Object, TestClass) do
+      TestClass.new
+      String.new
+      Object.new
+      TestClass.new
+      String.new
+    end
+    Object.new
+    TestClass.new
+    
+    Squeal.report.should == 'Object: 1, TestClass: 4'
+    
+    Squeal.reset
+    
+    Squeal.report.should == ''
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: squeal
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Florian Hanke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-14 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Simple object instantiation recorder.
+email: florian.hanke+squeal@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- lib/extensions/class.rb
+- lib/squeal/squeal.rb
+- lib/squeal.rb
+- README.textile
+- spec/lib/squeal/squeal_spec.rb
+has_rdoc: true
+homepage: http://github.com/floere/squeal
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Records object instantiations.
+test_files: 
+- spec/lib/squeal/squeal_spec.rb