dike 0.0.2 → 0.0.3

data/README

@@ -26,95 +26,193 @@ DESCRIPTION
 
 EXAMPLES
 
-  PURE RUBY
+  ### PURE RUBY
 
-    require 'dike'
+   ## just dumping sequential snapshots to stderr
 
-    Dike.log STDERR # the default
+    # cfp:~ > cat sample/a.rb
+        require 'dike'
 
-    Thread.new do
-      sleep 4.2 and Dike.finger
-    end
+        Leaks = Array.new
 
-    Main.start
+        loop do
+          Leaks << String.new('leak' * 1024)
+          Dike.finger
+          sleep 1
+        end
 
 
-  RAILS
+    # cfp:~ > ruby sample/a.rb | less
+        ...
+
+        - class: String
+          count: 2 
+          trace:
+          - sample/a.rb:6
+          - sample/a.rb:5:in `loop'
+          - sample/a.rb:5
+
+        ...
+
+        - class: String
+          count: 10 
+          trace:
+          - sample/a.rb:6
+          - sample/a.rb:5:in `loop'
+          - sample/a.rb:5
+
+        ...
+
+        - class: String
+          count: 42 
+          trace:
+          - sample/a.rb:6
+          - sample/a.rb:5:in `loop'
+          - sample/a.rb:5
+
+
+   ## dumping sequential snapshots using Dike.logfactory and then using the 'dike'
+      command line tool to do comparisons of the dumped snapshots
+
+    # cfp:~ > cat sample/b.rb
+        require 'dike'
+
+        Leaks = Array.new
+
+        class Leak
+          def initialize
+            @leak = 42.chr * (2 ** 20)
+          end
+        end
+
+        Dike.logfactory './log/'
+
+        Dike.finger
+
+        3.times{ Leaks << Leak.new  }
+
+        Dike.finger
 
-    file:RAILS_ROOT/config/environment.rb
+        2.times{ Leaks << Leak.new  }
+
+        Dike.finger
+
+    # cfp:~ > ruby sample/b.rb
+
+    # cfp:~ > ls log/
+        0       1       2
+
+    # cfp:~ > dike log/
+        --- 
+        - class: Leak
+          count: 3
+          trace: 
+          - sample/b.rb:15
+          - sample/b.rb:15:in `times'
+          - sample/b.rb:15
+        - class: Leak
+          count: 2
+          trace: 
+          - sample/b.rb:19
+          - sample/b.rb:19:in `times'
+          - sample/b.rb:19
+
+    # cfp:~ > dike log/0 log/1
+        --- 
+        - class: Leak
+          count: 3
+          trace: 
+          - sample/b.rb:15
+          - sample/b.rb:15:in `times'
+          - sample/b.rb:15
+
+    # cfp:~ > dike log/1 log/2
+        --- 
+        - class: Leak
+          count: 2
+          trace: 
+          - sample/b.rb:19
+          - sample/b.rb:19:in `times'
+          - sample/b.rb:19
+
+
+  ### RAILS
+
+    # cfp:~ > cat ./config/environment.rb
       ...
       require 'dike'
+      Dike.on :rails
+
+    # cfp:~ > ./script/server
+
+    # cfp:~ > curl --silent http://localhost:3000 >/dev/null
+
+    # cfp:~ > cat ./log/dike/0
+      ---
+      - class: String
+        count: 90769
+        trace: []
+      - class: Array
+        count: 18931
+        trace: []
+      - class: Class
+        count: 2
+        trace:
+        - votelink.com/public/../config/../lib/widgets.rb:222:in `class_factory'
+        - votelink.com/public/../config/../lib/widgets.rb:220:in `each'
+        - votelink.com/public/../config/../lib/widgets.rb:220:in `class_factory'
+        - votelink.com/public/../config/../lib/widgets.rb:248:in `Widget'
+        - votelink.com/public/../config/../lib/widgets/page/base.rb:1
+        - votelink.com/public/../config/../lib/widgets.rb:31:in `require'
+        - votelink.com/public/../config/../lib/widgets.rb:31:in `load'
+        - votelink.com/public/../config/../lib/widgets.rb:16:in `for_controller'
+        - votelink.com/public/../config/../lib/widgets.rb:243:in `widget'
+        - votelink.com/public/../config/../app/controllers/application.rb:150
+      ...
+
+    # cfp:~ > curl --silent http://localhost:3000 >/dev/null
+
+    # cfp:~ > cat ./log/dike/1
+      ---
+      - class: String
+        count: 100769
+        trace: []
+      - class: Array
+        count: 19931
+        trace: []
+      - class: Class
+        count: 5
+        trace:
+        - votelink.com/public/../config/../lib/widgets.rb:222:in `class_factory'
+        - votelink.com/public/../config/../lib/widgets.rb:220:in `each'
+        - votelink.com/public/../config/../lib/widgets.rb:220:in `class_factory'
+        - votelink.com/public/../config/../lib/widgets.rb:248:in `Widget'
+        - votelink.com/public/../config/../lib/widgets/page/base.rb:1
+        - votelink.com/public/../config/../lib/widgets.rb:31:in `require'
+        - votelink.com/public/../config/../lib/widgets.rb:31:in `load'
+        - votelink.com/public/../config/../lib/widgets.rb:16:in `for_controller'
+        - votelink.com/public/../config/../lib/widgets.rb:243:in `widget'
+        - votelink.com/public/../config/../app/controllers/application.rb:150
+      ...
+
+    # cfp:~ > dike ./log/dike
+      ...
+      - class: Class
+        count: 3
+        trace:
+        - votelink.com/public/../config/../lib/widgets.rb:222:in `class_factory'
+        - votelink.com/public/../config/../lib/widgets.rb:220:in `each'
+        - votelink.com/public/../config/../lib/widgets.rb:220:in `class_factory'
+        - votelink.com/public/../config/../lib/widgets.rb:248:in `Widget'
+        - votelink.com/public/../config/../lib/widgets/page/base.rb:1
+        - votelink.com/public/../config/../lib/widgets.rb:31:in `require'
+        - votelink.com/public/../config/../lib/widgets.rb:31:in `load'
+        - votelink.com/public/../config/../lib/widgets.rb:16:in `for_controller'
+        - votelink.com/public/../config/../lib/widgets.rb:243:in `widget'
+        - votelink.com/public/../config/../app/controllers/application.rb:150
+      ...
 
-    shell: ./script/server
-
-    shell: curl --silent http://localhost:3000 >/dev/null
-
-    shell: cat ./log/dike/0
-    ---
-    - class: String
-      count: 90769
-      trace: []
-    - class: Array
-      count: 18931
-      trace: []
-    - class: Class
-      count: 2
-      trace:
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:222:in `class_factory'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `each'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `class_factory'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:248:in `Widget'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets/page/base.rb:1
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `require'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `load'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:16:in `for_controller'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:243:in `widget'
-      - /Users/ahoward/site/votelink.com/public/../config/../app/controllers/application.rb:150
-    ...
-
-    shell: curl --silent http://localhost:3000 >/dev/null
-
-    shell: cat ./log/dike/1
-    ---
-    - class: String
-      count: 100769
-      trace: []
-    - class: Array
-      count: 19931
-      trace: []
-    - class: Class
-      count: 5
-      trace:
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:222:in `class_factory'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `each'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `class_factory'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:248:in `Widget'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets/page/base.rb:1
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `require'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `load'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:16:in `for_controller'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:243:in `widget'
-      - /Users/ahoward/site/votelink.com/public/../config/../app/controllers/application.rb:150
-    ...
-
-    shell: dike ./log/dike
-    ...
-    - class: Class
-      count: 3
-      trace:
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:222:in `class_factory'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `each'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:220:in `class_factory'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:248:in `Widget'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets/page/base.rb:1
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `require'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:31:in `load'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:16:in `for_controller'
-      - /Users/ahoward/site/votelink.com/public/../config/../lib/widgets.rb:243:in `widget'
-      - /Users/ahoward/site/votelink.com/public/../config/../app/controllers/application.rb:150
-    ...
-
-SUMMARY
+NOTES
 
   * the 'Dike.finger' method dumps it's log in a format showing
 
@@ -170,7 +268,13 @@ SUMMARY
 
 LIMITATIONS
 
-  not all object creation can be tracked and not all leaks are reported.
+  not all object creation can be tracked. not all leaks are reported. some
+  reported leaks are not. dike shows you where in the source objects are being
+  created that cannot be reclaimed - these are not always leaks as this line
+
+    class C; end
+
+  shows.  the class 'C' cannot be reclaimed and is not a leak.
 
 AUTHOR
 

data/gemspec.rb

@@ -18,7 +18,8 @@ Gem::Specification::new do |spec|
 
   spec.has_rdoc = File::exist? "doc" 
   spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
-  #spec.add_dependency 'lib', '>= version'
+  spec.add_dependency 'attributes', '>= 3.6.0'
+  spec.add_dependency 'orderedhash', '>= 0.0.2'
 
   spec.extensions << "extconf.rb" if File::exists? "extconf.rb"
 

data/lib/dike.rb

@@ -29,8 +29,8 @@ module Dike
     Objects = Hash.new
 
     def mark_birth object, stacktrace
-      return if Objects[object_id]
       object_id = Object::Methods["object_id"].bind(object).call
+      return if Objects[object_id]
       Objects[object_id] = stacktrace
       ObjectSpace.define_finalizer object, &mark_birth_finalizer(object_id)
     end
@@ -78,12 +78,17 @@ module Dike
     attribute("threshold"){ Struct.new(:class, :code, :object)[42, 42, 1] }
     attribute("log"){ STDERR }
     attribute("logfactory"){ nil }
+    
+    def logfactory= value
+      @logfactory =
+        LogFactory === value ? value : LogFactory.new(value)
+    end
 
     def finger options = {} 
       Thread.critical = true
 
       begin
-        GC.start
+        42.times{ GC.start }
 
         count, code = :remembered 
 
@@ -253,12 +258,19 @@ end
 
 
 if defined? Rails 
-  Dike.logfactory Dike::LogFactory.new(File.join(RAILS_ROOT, "log", "dike"))
-
-  ActionController::Base.module_eval do
-    after_filter do |controller|
-      Dike.finger
-      true
+  module Dike
+    def self.on which = :rails
+      case which.to_s
+        when %r/^rails$/i 
+          Dike.logfactory File.join(RAILS_ROOT, "log", "dike")
+
+          ActionController::Base.module_eval do
+            after_filter do |controller|
+              Dike.finger
+              true
+            end
+          end
+      end
     end
   end
 end

data/sample/a.rb

@@ -0,0 +1,9 @@
+require 'dike'
+
+Leaks = Array.new
+
+loop do
+  Leaks << String.new('leak' * 1024)
+  Dike.finger
+  sleep 1
+end

data/sample/b.rb

@@ -0,0 +1,22 @@
+require 'dike'
+
+Leaks = Array.new
+
+class Leak
+  def initialize
+    @leak = 42.chr * (2 ** 20)
+  end
+end
+
+Dike.logfactory './log/'
+
+Dike.finger
+
+3.times{ Leaks << Leak.new  }
+
+Dike.finger
+
+2.times{ Leaks << Leak.new  }
+
+Dike.finger
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: dike
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-09-27 00:00:00 -06:00
+  version: 0.0.3
+date: 2007-09-29 00:00:00 -06:00
 summary: dike
 require_paths: 
 - lib
@@ -31,11 +31,15 @@ authors:
 files: 
 - bin
 - bin/dike
+- dike-0.0.3.gem
 - gemspec.rb
 - install.rb
 - lib
 - lib/dike.rb
 - README
+- sample
+- sample/a.rb
+- sample/b.rb
 test_files: []
 
 rdoc_options: []
@@ -48,5 +52,22 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: attributes
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.6.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: orderedhash
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.2
+    version: