hometown 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6faccd91b19c91bb38e978cae748c863bb1997c0
-  data.tar.gz: c7d57e8b40777dbadfa4c6e7171c0a7ff240e74b
+  metadata.gz: ef3bf9cd07fd65698dbf269368f59acf0e8af42c
+  data.tar.gz: 4e911e6a515e81f1009bf40afd6673dceb00fde9
 SHA512:
-  metadata.gz: 7cde03cef004ca7e1121d7cc6e15cfdb51753fe663f66e63239ab45ac0315866d3b293bf70565f647102faaf608a48394efc163cdb68906bec87cdee56fa654d
-  data.tar.gz: df5d5a65aaa19c4efd14f6a9da712ad699c477d223551ffc901247ffa634587a5c752a53980776dd87ebdd89d74138429fb2767202524d21f0c8c061927601ce
+  metadata.gz: 2c0c696f52311f61a9d46ca615014f7d1c748bf33670aca6575e17e8ad96f26543c2504be435ab118476044f414d7fbca0a93f5c1a481ddda0067cc7c65a83fd
+  data.tar.gz: b9d13e4fffd22bac7677d67cdce2ae4c6b28540430047970cef33fb87d7fdf639c8b33a91fe90163d83fc5a2e821fefe41698fb169d163db4feb88a566762c17

data/README.md

@@ -56,6 +56,8 @@ Hometown can help track down these leaks. To watch a class of objects to ensure
 created instances are disposed, call `Hometown.watch_for_disposal` on the
 class. `Hometown.undisposed` returns you objects indicating--with stack traces
 --all the locations where an object was created but not released.
+`Hometown.undisposed_report` will give a formatted output of the undisposed
+objects.
 
 ```
 # dispose.rb
@@ -73,12 +75,13 @@ Hometown.watch_for_disposal(Disposable, :dispose)
 # Creating initial object
 disposable = Disposable.new
 puts "Still there!"
-p Hometown.undisposed()
+p Hometown.undisposed
+puts
 
 # All done!
 disposable.dispose
 puts "Properly disposed"
-p Hometown.undisposed()
+puts Hometown.undisposed_report
 
 
 $ ruby examples/dispose.rb
@@ -87,7 +90,12 @@ Still there!
 { #<Hometown::Trace:0x007f9aa516ec88 ...> => 1 }
 
 Properly disposed!
-{ #<Hometown::Trace:0x007f9aa516ec88 ...> => 0 }
+Undisposed Resources:
+[Disposable] => 0
+	examples/dispose.rb:13:in `<main>'
+
+Undiposed Totals:
+[Disposable] => 0
 ```
 
 ## Contributing

data/Rakefile

@@ -11,3 +11,16 @@ Rake::TestTask.new do |test|
   test.test_files = FileList['test/**/*_test.rb']
 end
 
+if Rake::Task.task_defined?("release:source_control_push")
+  puts "Found release:source_control_push task... overwriting to support push.default=nothing"
+
+  Rake::Task['release:source_control_push'].clear
+  task 'release:source_control_push' do
+    `git push origin master`
+
+    version = Bundler::GemHelper.gemspec.version
+    version_tag = "v#{version}"
+    `git tag -a -m \"Version #{version}\" #{version_tag}`
+    `git push --tags`
+  end
+end

data/examples/dispose.rb

@@ -8,13 +8,17 @@ end
 
 # Watch Disposable and track calls to dispose
 Hometown.watch_for_disposal(Disposable, :dispose)
+Hometown.undisposed_report_at_exit
 
 # Creating initial object
 disposable = Disposable.new
+Disposable.new
 puts "Still there!"
-p Hometown.undisposed()
+puts "*" * 30
+puts Hometown.undisposed_report
+puts
 
-# All done!
+# Dispose of one, and at_exit hook will show the results!
 disposable.dispose
-puts "Properly disposed"
-p Hometown.undisposed()
+puts "Final undisposed report!"
+puts "*" * 30

data/lib/hometown.rb

@@ -7,12 +7,8 @@ module Hometown
   @creation_tracer = Hometown::CreationTracer.new
   @disposal_tracer = Hometown::DisposalTracer.new
 
-  def self.creation_tracer
-    @creation_tracer
-  end
-
-  def self.disposal_tracer
-    @disposal_tracer
+  class << self
+    attr_accessor :creation_tracer, :disposal_tracer
   end
 
   def self.watch(clazz)
@@ -28,6 +24,16 @@ module Hometown
   end
 
   def self.undisposed
-    @disposal_tracer.undisposed()
+    @disposal_tracer.undisposed
+  end
+
+  def self.undisposed_report
+    @disposal_tracer.undisposed_report
+  end
+
+  def self.undisposed_report_at_exit
+    at_exit do
+      puts Hometown.undisposed_report
+    end
   end
 end

data/lib/hometown/disposal_tracer.rb

@@ -1,10 +1,12 @@
 module Hometown
   class DisposalTracer
-    attr_reader :undisposed
+    attr_reader :undisposed, :untraced_disposals
 
     def initialize
-      @undisposed      = Hash.new(0)
       @tracing_classes = {}
+
+      @undisposed         = Hash.new(0)
+      @untraced_disposals = Hash.new(0)
     end
 
     def patch(clazz, disposal_method)
@@ -41,7 +43,59 @@ module Hometown
 
     def notice_disposed(instance)
       trace = Hometown.for(instance)
-      @undisposed[trace] -= 1 if @undisposed[trace]
+      if trace
+        @undisposed[trace] -= 1
+      else
+        trace = Trace.new(instance.class, caller)
+        @untraced_disposals[trace] += 1
+      end
+    end
+
+    UNDISPOSED_HEADING = "Undisposed Resources"
+    UNTRACED_HEADING   = "Untraced Disposals"
+    UNDISPOSED_TOTALS_HEADING = "Undisposed Totals"
+    UNTRACED_TOTALS_HEADING   = "Untraced Disposals Totals"
+
+    def undisposed_report
+      result  = format_trace_hash(UNDISPOSED_HEADING, @undisposed)
+      result += format_trace_hash(UNTRACED_HEADING, @untraced_disposals)
+
+      result += format_totals(UNDISPOSED_TOTALS_HEADING, @undisposed)
+      result += format_totals(UNTRACED_TOTALS_HEADING, @untraced_disposals)
+
+      result
+    end
+
+    def format_trace_hash(heading, hash)
+      result = ""
+      hash.each do |trace, count|
+        if count > 0
+          result += "[#{trace.traced_class}] => #{count}\n"
+          result += "\t#{trace.backtrace.join("\n\t")}\n\n"
+        end
+      end
+
+      add_heading_if_needed(heading, result)
+    end
+
+    def format_totals(heading, hash)
+      result = ""
+      hash.group_by { |trace, _| trace.traced_class }.each do |clazz, counts|
+        count = counts.map { |count| count.last }.inject(0, &:+)
+        if count > 0
+          result += "[#{clazz}] => #{count}"
+        end
+      end
+
+      add_heading_if_needed(heading, result)
+    end
+
+    def add_heading_if_needed(heading, result)
+      if result.empty?
+        ""
+      else
+        "#{heading}:\n#{result}"
+      end
     end
   end
 end

data/lib/hometown/version.rb

@@ -1,3 +1,3 @@
 module Hometown
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
 end

data/test/hometown/disposal_tracer_test.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "test_helper"))
+require 'hometown'
+require 'hometown/disposal_tracer'
+
+module Hometown
+  class DisposalTracerTest < Minitest::Test
+    def setup
+      @tracer = DisposalTracer.new
+      @original_tracer = Hometown.disposal_tracer
+      Hometown.disposal_tracer = @tracer
+    end
+
+    def teardown
+      Hometown.disposal_tracer = @original_tracer
+    end
+
+    def test_empty_report
+      assert_empty @tracer.undisposed_report
+    end
+
+    def test_traces_disposal
+      clazz = new_class
+      @tracer.patch(clazz, :dispose)
+
+      instance = clazz.new
+      trace = Hometown.for(instance)
+      assert_equal 1, @tracer.undisposed[trace]
+
+      instance.dispose
+      assert_equal 0, @tracer.undisposed[trace]
+    end
+
+    def test_undisposed_report
+      clazz = new_class
+      @tracer.patch(clazz, :dispose)
+
+      instance = clazz.new
+      report = @tracer.undisposed_report
+
+      assert_match DisposalTracer::UNDISPOSED_HEADING, report
+      assert_match DisposalTracer::UNDISPOSED_TOTALS_HEADING, report
+      assert_match clazz.to_s, report
+      assert_match __FILE__, report
+      assert_match /#{clazz.to_s}.*1/, report
+    end
+
+    def test_empty_report_if_all_disposed
+      clazz = new_class
+      @tracer.patch(clazz, :dispose)
+
+      instance = clazz.new
+      instance.dispose
+
+      assert_empty @tracer.undisposed_report
+    end
+
+    def test_safely_disposes_already_created_objects
+      clazz = new_class
+      instance = clazz.new
+      @tracer.patch(clazz, :dispose)
+
+      instance.dispose
+
+      assert_empty @tracer.undisposed
+      assert_equal 1, @tracer.untraced_disposals.count
+    end
+
+    def test_untraced_disposals_show_up_in_report
+      clazz = new_class
+      instance = clazz.new
+      @tracer.patch(clazz, :dispose)
+
+      instance.dispose
+      report = @tracer.undisposed_report
+
+      assert_match DisposalTracer::UNTRACED_HEADING, report
+      assert_match DisposalTracer::UNTRACED_TOTALS_HEADING, report
+      assert_match clazz.to_s, report
+      assert_match __FILE__, report
+      assert_match /#{clazz.to_s}.*1/, report
+    end
+
+    def new_class
+      Class.new do
+        define_method(:dispose) do
+        end
+      end
+    end
+  end
+end

data/test/hometown_test.rb

@@ -158,4 +158,19 @@ class HometownTest < Minitest::Test
     result = Hometown.undisposed
     assert_equal 1, result[trace]
   end
+
+  def test_undisposed_report
+    clazz = Class.new do
+      define_method(:dispose) do
+      end
+    end
+
+    Hometown.watch_for_disposal(clazz, :dispose)
+    instance = clazz.new
+
+    report = Hometown.undisposed_report
+    assert_kind_of String, report
+    assert_includes report, clazz.to_s
+    assert_includes report, __FILE__
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hometown
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Jason R. Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,7 @@ files:
 - lib/hometown/disposal_tracer.rb
 - lib/hometown/trace.rb
 - lib/hometown/version.rb
+- test/hometown/disposal_tracer_test.rb
 - test/hometown/trace_test.rb
 - test/hometown_test.rb
 - test/test_helper.rb
@@ -172,7 +173,7 @@ signing_key:
 specification_version: 4
 summary: Track object creation
 test_files:
+- test/hometown/disposal_tracer_test.rb
 - test/hometown/trace_test.rb
 - test/hometown_test.rb
 - test/test_helper.rb
-has_rdoc: