hometown 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 138e3de444e2c7c0364c252e37a411f6139257d3
+  data.tar.gz: 82ae1b18916e8845d8a625501194b7eeee20d95c
+SHA512:
+  metadata.gz: 75a8cb0ac1dcbb0bfb720845fc8cbe9c6de45dc562651229a0b4a84a595af900bec66f7e045fa66c4ca221616202549f56639131c093af23f0849b5565eaa130
+  data.tar.gz: ae6b198008255b5a3a88bf5035368249f7eaa1b2c2c929b03c9dbd305b00bdf5a4461f801c4e1565950e565ef049f1771d1f3e24cfa0136e4e508d1f633b43a0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest, :test_folders => ['test'], :all_after_pass => true do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^lib/.*\.rb$})       { |m| "test/hometown_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jason R. Clark
+
+MIT License
+
+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,76 @@
+# Hometown
+
+Track object creation to stamp out pesky leaks.
+
+## Requirements
+Currently I'm testing against Ruby 2.1, but will be extending that in the future. I expect to allow back to 1.9.x, JRuby and Rubinius.
+
+## Installation
+
+    $ gem install hometown
+
+## Usage
+
+Find where an object was created:
+
+```
+# examples/example.rb
+require 'hometown'
+
+# Start watching Array instantiations
+Hometown.watch(Array)
+
+# Output the trace for a specific Array's creation
+p Hometown.for(Array.new)
+
+
+$ ruby examples/example.rb
+
+#<Hometown::Trace:0x007fcd9c95ca10
+  @traced_class=Array,
+  @backtrace=["script:4:in `<main>'"]>
+```
+
+
+Track disposal of an object:
+
+```
+# dispose.rb
+require 'hometown'
+
+class Disposable
+  def dispose
+    # always be disposing
+  end
+end
+
+# Watch Disposable and track calls to dispose
+Hometown.watch_for_disposal(Disposable, :dispose)
+
+# Creating initial object
+disposable = Disposable.new
+puts "Still there!"
+p Hometown.undisposed()
+
+# All done!
+disposable.dispose
+puts "Properly disposed"
+p Hometown.undisposed()
+
+
+$ ruby examples/dispose.rb
+
+Still there!
+{ #<Hometown::Trace:0x007f9aa516ec88 ...> => 1 }
+
+Properly disposed!
+{ #<Hometown::Trace:0x007f9aa516ec88 ...> => 0 }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hometown/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.verbose = true
+  test.libs << "test"
+  test.libs << "lib"
+  test.test_files = FileList['test/**/*_test.rb']
+end
+

data/examples/dispose.rb

@@ -0,0 +1,20 @@
+require 'hometown'
+
+class Disposable
+  def dispose
+    # always be disposing
+  end
+end
+
+# Watch Disposable and track calls to dispose
+Hometown.watch_for_disposal(Disposable, :dispose)
+
+# Creating initial object
+disposable = Disposable.new
+puts "Still there!"
+p Hometown.undisposed()
+
+# All done!
+disposable.dispose
+puts "Properly disposed"
+p Hometown.undisposed()

data/examples/example.rb

@@ -0,0 +1,7 @@
+require 'hometown'
+
+# Start watching Array instantiations
+Hometown.watch(Array)
+
+# Output the trace for a specific Array's creation
+p Hometown.for(Array.new)

data/hometown.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hometown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hometown"
+  spec.version       = Hometown::VERSION
+  spec.authors       = ["Jason R. Clark"]
+  spec.email         = ["jason@jasonrclark.com"]
+  spec.summary       = %q{Track object creation}
+  spec.description   = %q{Track object creation to stamp out pesky leaks.}
+  spec.homepage      = "http://github.com/jasonrclark/hometown"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake",    "~> 10.2"
+  spec.add_development_dependency "minitest","~> 5.3"
+  spec.add_development_dependency "pry",     "~> 0.9"
+  spec.add_development_dependency "pry-nav", "~> 0.2"
+  spec.add_development_dependency "guard",   "~> 2.6"
+  spec.add_development_dependency "guard-minitest", "~> 1.3"
+end

data/lib/hometown/hooks.rb

@@ -0,0 +1,17 @@
+module Hometown
+  class Hooks
+    def initialize
+      @hooks = []
+    end
+
+    def <<(hook)
+      @hooks << hook
+    end
+
+    def run_on(instance)
+      @hooks.each do |hook|
+        hook.call(instance)
+      end
+    end
+  end
+end

data/lib/hometown/trace.rb

@@ -0,0 +1,19 @@
+module Hometown
+  class Trace
+    attr_reader :traced_class, :backtrace
+
+    def initialize(traced_class, backtrace)
+      @traced_class = traced_class
+      @backtrace    = backtrace
+    end
+
+    def eql?(b)
+      @traced_class == b.traced_class &&
+        @backtrace  == b.backtrace
+    end
+
+    def hash
+      [@traced_class, @backtrace].hash
+    end
+  end
+end

data/lib/hometown/version.rb

@@ -0,0 +1,3 @@
+module Hometown
+  VERSION = "0.0.1"
+end

data/lib/hometown/watch.rb

@@ -0,0 +1,25 @@
+module Hometown
+  module Watch
+    def self.patch(clazz)
+      clazz.instance_eval do
+        @hooks = Hooks.new
+
+        class << self
+          def new_traced(*args, &blk)
+            trace = Hometown.create_trace(self, caller)
+
+            instance = new_original(*args, &blk)
+            instance.instance_variable_set(HOMETOWN_TRACE_ON_INSTANCE, trace)
+            instance.class.instance_variable_get(:@hooks).run_on(instance)
+
+            instance
+          end
+
+          alias_method :new_original, :new
+          alias_method :new, :new_traced
+        end
+
+      end
+    end
+  end
+end

data/lib/hometown/watch_for_disposal.rb

@@ -0,0 +1,30 @@
+module Hometown
+  module WatchForDisposal
+    def self.patch(clazz, disposal_method)
+      add_disposal_hooks(clazz)
+      patch_disposal_method(clazz, disposal_method)
+    end
+
+    def self.add_disposal_hooks(clazz)
+      hooks = clazz.instance_variable_get(:@hooks)
+      hooks << Proc.new do |instance|
+        Hometown.mark_for_disposal(instance)
+      end
+    end
+
+    def self.patch_disposal_method(clazz, disposal_method)
+      traced   = "#{disposal_method}_traced"
+      original = "#{disposal_method}_original"
+
+      clazz.class_eval do
+        define_method(traced) do |*args, &blk|
+          Hometown.mark_disposed(self)
+          self.send(original, *args, &blk)
+        end
+
+        alias_method original, disposal_method
+        alias_method disposal_method, traced
+      end
+    end
+  end
+end

data/lib/hometown.rb

@@ -0,0 +1,60 @@
+require "hometown/hooks"
+require "hometown/trace"
+require "hometown/version"
+require "hometown/watch"
+require "hometown/watch_for_disposal"
+
+module Hometown
+  HOMETOWN_TRACE_ON_INSTANCE = :@__hometown_creation_backtrace
+
+  @undisposed      = {}
+  @watch_patches   = {}
+  @dispose_patches = {}
+
+  def self.watch(clazz)
+    return if @watch_patches.include?(clazz)
+
+    @watch_patches[clazz] = true
+    Watch.patch(clazz)
+  end
+
+  def self.watch_for_disposal(clazz, disposal_method)
+    return if @dispose_patches.include?(clazz)
+
+    watch(clazz)
+
+    @dispose_patches[clazz] = true
+    WatchForDisposal.patch(clazz, disposal_method)
+  end
+
+  def self.already_patched?(clazz)
+    @patched.include?(clazz)
+  end
+
+  def self.for(instance)
+    instance.instance_variable_get(HOMETOWN_TRACE_ON_INSTANCE)
+  end
+
+  def self.undisposed()
+    @undisposed
+  end
+
+  def self.create_trace(clazz, backtrace)
+    Trace.new(clazz, backtrace)
+  end
+
+  def self.mark_for_disposal(instance)
+    trace = Hometown.for(instance)
+
+    @undisposed[trace] ||= 0
+    @undisposed[trace]  += 1
+  end
+
+  def self.mark_disposed(instance)
+    trace = Hometown.for(instance)
+
+    if @undisposed[trace]
+      @undisposed[trace] -= 1
+    end
+  end
+end

data/test/hometown/trace_test.rb

@@ -0,0 +1,27 @@
+require 'minitest/autorun'
+require 'hometown/trace'
+
+module Hometown
+  class TraceTest < Minitest::Test
+    def test_equality
+      trace1 = Trace.new(self.class, ["boo"])
+      trace2 = Trace.new(self.class, ["boo"])
+
+      assert trace1.eql?(trace2)
+    end
+
+    def test_inequality
+      trace1 = Trace.new(self.class, ["boo"])
+      trace2 = Trace.new(self.class, ["HOO"])
+
+      refute trace1.eql?(trace2)
+    end
+
+    def test_hash
+      trace1 = Trace.new(self.class, ["boo"])
+      trace2 = Trace.new(self.class, ["boo"])
+
+      assert_equal trace1.hash, trace2.hash
+    end
+  end
+end

data/test/hometown_test.rb

@@ -0,0 +1,161 @@
+require 'minitest/autorun'
+require 'hometown'
+
+class HometownTest < Minitest::Test
+  class Traced
+  end
+
+  class Untraced
+  end
+
+  class TracedWithBlock
+    def initialize(&blk)
+      blk.call
+    end
+  end
+
+  class Disposable
+    def dispose
+    end
+  end
+
+  class DisposableArguments
+    def dispose(a,b,c)
+      if block_given?
+        yield a, b, c
+      else
+        [a,b,c]
+      end
+    end
+  end
+
+  def teardown
+    Hometown.undisposed.clear
+  end
+
+  def test_untraced_class
+    traced_object = Untraced.new
+    assert_nil Hometown.for(traced_object)
+  end
+
+  def test_tracing_includes_classname
+    Hometown.watch(Traced)
+    traced_object = Traced.new
+
+    result = Hometown.for(traced_object)
+    assert_equal Traced, result.traced_class
+  end
+
+  def test_tracing_includes_this_file
+    Hometown.watch(Traced)
+    traced_object = Traced.new
+
+    result = Hometown.for(traced_object)
+    assert_includes result.backtrace.join("\n"), __FILE__
+  end
+
+  def test_initialize_with_block
+    Hometown.watch(TracedWithBlock)
+    traced_object = TracedWithBlock.new do
+      i = 1
+    end
+
+    result = Hometown.for(traced_object)
+    assert_equal TracedWithBlock, result.traced_class
+  end
+
+  def test_class_with_overridden_new
+    Hometown.watch(::Thread)
+    thread = Thread.new { sleep 1 }
+
+    result = Hometown.for(thread)
+    assert_equal ::Thread, result.traced_class
+  end
+
+  def test_doesnt_mark_for_disposal
+    Hometown.watch(TracedWithBlock)
+    traced_object = TracedWithBlock.new do
+      i = 1
+    end
+
+    result = Hometown.undisposed
+    trace = Hometown.for(traced_object)
+    assert_nil result[trace]
+  end
+
+  def test_marks_for_disposal
+    Hometown.watch_for_disposal(Disposable, :dispose)
+    dispose = Disposable.new
+
+    result = Hometown.undisposed
+    trace = Hometown.for(dispose)
+    assert_equal 1, result[trace]
+  end
+
+  def test_multiples_marked_for_disposal
+    Hometown.watch_for_disposal(Disposable, :dispose)
+    latest_disposed = nil
+    2.times do
+      latest_disposed = Disposable.new
+    end
+
+    result = Hometown.undisposed
+    trace = Hometown.for(latest_disposed)
+    assert_equal 2, result[trace]
+  end
+
+  def test_actually_disposing
+    Hometown.watch_for_disposal(Disposable, :dispose)
+    dispose_me = Disposable.new
+
+    result = Hometown.undisposed
+    trace = Hometown.for(dispose_me)
+    assert_equal 1, result[trace]
+
+    dispose_me.dispose
+    assert_equal 0, result[trace]
+  end
+
+  def test_actually_disposing_with_arguments
+    Hometown.watch_for_disposal(DisposableArguments, :dispose)
+    dispose_me = DisposableArguments.new
+
+    result = Hometown.undisposed
+    trace = Hometown.for(dispose_me)
+    assert_equal 1, result[trace]
+
+    disposable = dispose_me.dispose(1,2,3)
+    assert_equal [1,2,3], disposable
+    assert_equal 0, result[trace]
+  end
+
+  def test_actually_disposing_with_arguments_and_block
+    Hometown.watch_for_disposal(DisposableArguments, :dispose)
+    dispose_me = DisposableArguments.new
+
+    result = Hometown.undisposed
+    trace = Hometown.for(dispose_me)
+    assert_equal 1, result[trace]
+
+    disposable = dispose_me.dispose(1,2,3) do |a, b, c|
+      a + b + c
+    end
+    assert_equal 6, disposable
+    assert_equal 0, result[trace]
+  end
+
+  def test_updating_watch_for_disposal
+    clazz = Class.new do
+      define_method(:dispose) do
+      end
+    end
+
+    Hometown.watch(clazz)
+    Hometown.watch_for_disposal(clazz, :dispose)
+    instance = clazz.new
+    trace = Hometown.for(instance)
+
+    result = Hometown.undisposed
+    assert_equal 1, result[trace]
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: hometown
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason R. Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Track object creation to stamp out pesky leaks.
+email:
+- jason@jasonrclark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/dispose.rb
+- examples/example.rb
+- hometown.gemspec
+- lib/hometown.rb
+- lib/hometown/hooks.rb
+- lib/hometown/trace.rb
+- lib/hometown/version.rb
+- lib/hometown/watch.rb
+- lib/hometown/watch_for_disposal.rb
+- test/hometown/trace_test.rb
+- test/hometown_test.rb
+homepage: http://github.com/jasonrclark/hometown
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Track object creation
+test_files:
+- test/hometown/trace_test.rb
+- test/hometown_test.rb
+has_rdoc: