memory_leak_helper 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kasper Johansen
+
+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.rdoc

@@ -0,0 +1,19 @@
+= memory_leak_helper
+
+Description goes here.
+
+== Contributing to memory_leak_helper
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "memory_leak_helper"
+  gem.homepage = "http://github.com/kaspernj/memory_leak_helper"
+  gem.license = "MIT"
+  gem.summary = %Q{A gem to track memory leaks in Ruby.}
+  gem.description = %Q{A gem to track memory leaks in Ruby by tracking which stacktraces creates objects that never gets unset again.}
+  gem.email = "k@spernj.org"
+  gem.authors = ["Kasper Johansen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "memory_leak_helper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/memory_leak_helper.rb

@@ -0,0 +1,97 @@
+require "monitor"
+
+class Memory_leak_helper
+  attr_reader :objects_alive
+  
+  #Constructor. Spawns used hashes.
+  def initialize
+    @objects_alive = {}
+    @objects_data = {}
+    @mutex = Monitor.new
+  end
+  
+  #Registers the object in the leak-helper hash.
+  def register_object(args)
+    @mutex.synchronize do
+      return nil if !@objects_alive
+      
+      obj, backtrace_arr = args[:obj], args[:caller]
+      obj_id = obj.__id__
+      
+      class_name = obj.class.name
+      backtrace_str = backtrace_arr.join("___")
+      
+      #Increase count of object-callback.
+      @objects_alive[class_name] = {} if !@objects_alive.key?(class_name)
+      @objects_alive[class_name][backtrace_str] = {:count => 0, :backtrace => backtrace_arr} if !@objects_alive[class_name].key?(backtrace_str)
+      @objects_alive[class_name][backtrace_str][:count] += 1
+      
+      #Spawn some data to help unsetting it again.
+      @objects_data[obj_id] = {:backtrace_str => backtrace_str, :class_name => class_name}
+      
+      ObjectSpace.define_finalizer(obj, self.method(:object_finalized))
+    end
+  end
+  
+  #Called when an object is finalized. This helps decrease the object-count of a callback.
+  def object_finalized(obj_id)
+    @mutex.synchronize do
+      return nil if !@objects_data.key?(obj_id)
+      
+      backtrace_str = @objects_data[obj_id][:backtrace_str]
+      class_name = @objects_data[obj_id][:class_name]
+      @objects_data.delete(obj_id)
+      
+      @objects_alive[class_name][backtrace_str][:count] -= 1
+      @objects_alive[class_name].delete(backtrace_str) if @objects_alive[class_name][backtrace_str][:count] <= 0
+    end
+  end
+  
+  #Returns an array of possible leaks.
+  def possible_leaks(args = nil)
+    if args and args[:minimum]
+      minimum = args[:minimum]
+    else
+      minimum = 40
+    end
+    
+    @mutex.synchronize do
+      leaks = []
+      @objects_alive.clone.each do |class_name, backtrace_strs|
+        backtrace_strs.each do |backtrace_str, data|
+          if data[:count] >= minimum
+            leaks << {
+              :classname => class_name,
+              :backtrace => data[:backtrace],
+              :count => data[:count]
+            }
+          end
+        end
+      end
+      
+      leaks.sort! do |ele1, ele2|
+        ele2[:count] <=> ele1[:count]
+      end
+      
+      return leaks
+    end
+  end
+  
+  #Only one instance is needed. Define that as a constant.
+  INSTANCE = Memory_leak_helper.new
+end
+
+#Hack the 'Class'-class in order to get callbacks when objects are created.
+class ::Class
+  #Alias the original new-method to a method that hopefully will never be found.
+  alias __memory_leak_helper_original_new new
+  
+  #Make a new method that will be called whenever an object is created. Register that object with 'Memory_leak_helper' and return it as it normally would.
+  def new(*args, &blk)
+    mlh = Memory_leak_helper::INSTANCE
+    obj = __memory_leak_helper_original_new(*args, &blk)
+    mlh.register_object(:obj => obj, :caller => caller) if mlh
+    
+    return obj
+  end
+end

data/memory_leak_helper.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "memory_leak_helper"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kasper Johansen"]
+  s.date = "2013-03-25"
+  s.description = "A gem to track memory leaks in Ruby by tracking which stacktraces creates objects that never gets unset again."
+  s.email = "k@spernj.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/memory_leak_helper.rb",
+    "memory_leak_helper.gemspec",
+    "spec/memory_leak_helper_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kaspernj/memory_leak_helper"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "A gem to track memory leaks in Ruby."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/spec/memory_leak_helper_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "MemoryLeakHelper" do
+  it "should work" do
+    require "rubygems"
+    require "memory_leak_helper"
+    require "knjrbfw"
+    
+    objs = []
+    
+    1.upto(100) do
+      objs << String.new("Kasper Johansen")
+    end
+    
+    found = false
+    Memory_leak_helper::INSTANCE.objects_alive["String"].each do |callback_str, data|
+      found = true if data[:count] == 100
+    end
+    
+    raise "Expected a callback to have 100 alive strings." if !found
+    
+    1.upto(50) do
+      objs.shift
+    end
+    
+    GC.start
+    some_str = "Hmm"
+    GC.start
+    
+    found = false
+    Memory_leak_helper::INSTANCE.objects_alive["String"].each do |callback_str, data|
+      found = true if data[:count] == 50
+    end
+    
+    raise "Expected a callback to have 100 alive strings." if !found
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'memory_leak_helper'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: memory_leak_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kasper Johansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: A gem to track memory leaks in Ruby by tracking which stacktraces creates
+  objects that never gets unset again.
+email: k@spernj.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/memory_leak_helper.rb
+- memory_leak_helper.gemspec
+- spec/memory_leak_helper_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kaspernj/memory_leak_helper
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2772518127105610913
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A gem to track memory leaks in Ruby.
+test_files: []