leaks 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mario Visic
+
+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,60 @@
+# Leaks
+
+Leaks loops your rpsec tests and monitors process RAM usage to detect memory leaks. Processes with continiously growing usage could protentially have a leak in them.
+I was inspired to create leaks after reading [a blog post by Timothy Elliott](http://holymonkey.com/how-to-find-and-fix-a-memory-leak-in-a-ruby-c-extension.html) about a technique for hunting down memory leaks in rails apps.
+
+## Compatability
+
+- Works with RSpec (patches for minitest and test unit are welcome)
+- Works on OSX and Linux (Patches for Windows welcome)
+- Tested on Ruby MRI 1.9.3 (patches for other ruby interpreters welcome)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'leaks'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Rails
+
+After adding leaks to your gemfile, fire up the rails console in a test environment:
+
+```
+rails c test
+```
+
+Now simply point leaks to a given spec directory (leave blank to use your entire test suite):
+
+```
+Leaks::Runner.run
+# or
+Leaks::Runner.run('/path/to/spec')
+```
+
+You can pass a single folder, or even an array of folders, for example:
+
+```
+Leaks::Runner.run(['spec/models', 'spec/controllers'])
+```
+
+You can run leaks in verbose mode to see the output of your tests (careful it can get noisy):
+
+```
+Leaks::Runner.run('spec', true)
+```
+
+Now watch the output, the RAM usage will most likely grow for a while. If after a few minutes it's still growing it could be an indication of a problem. Please take note of your test suite size, if your test suite takes 10 minutes to run then be sure to let it run through once or twice before verifying the output.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/leaks.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leaks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "leaks"
+  gem.version       = Leaks::VERSION
+  gem.authors       = ["Mario Visic"]
+  gem.email         = ["mario@mariovisic.com"]
+  gem.description   = %q{Leaks loops your rpsec tests and monitors process RAM usage to detect any memory leaks. Processes with continiously growing usage could protentially have a leak in them.}
+  gem.summary       = %q{Find memory leaks using your rspec tests}
+  gem.homepage      = "https://github.com/mariovisic/leaks"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+
+  gem.add_runtime_dependency 'rspec-core', '~> 2.0'
+end

data/lib/leaks.rb

@@ -0,0 +1,6 @@
+require 'leaks/printer'
+require 'leaks/ram_usage'
+require 'leaks/rspec_runner'
+require 'leaks/runner'
+require 'leaks/spinner'
+require 'leaks/version'

data/lib/leaks/printer.rb

@@ -0,0 +1,19 @@
+module Leaks
+  module Printer
+    def self.run
+      loop { print_status; sleep 0.1 }
+    end
+
+    def self.print_status
+      print "#{13.chr}#{Spinner} "
+
+      status = "Runs: #{Runner.runs} #{Runner.ram_usage} Stable: #{Runner.ram_usage.stable_for} sec    "
+
+      if Runner.ram_usage.increased?
+        print "\033[31m#{status}\033[0m"
+      else
+        print "\033[32m#{status}\033[0m"
+      end
+    end
+  end
+end

data/lib/leaks/ram_usage.rb

@@ -0,0 +1,37 @@
+module Leaks
+  class RAMUsage
+    def initialize
+      @previous = kilobytes_used
+      @current  = @previous
+      @stable   = Time.now
+    end
+
+    def increased?
+      if current > @previous
+        @stable = Time.now
+        true
+      else
+        false
+      end
+    end
+
+    def current
+      @previous = @current
+      @current  = kilobytes_used
+    end
+
+    def to_s
+      "Usage: #{current}KB"
+    end
+
+    def stable_for
+      (Time.now - @stable).to_i
+    end
+
+    private
+
+    def kilobytes_used
+      `ps -o vsz= -p #{$$}`.to_i
+    end
+  end
+end

data/lib/leaks/rspec_runner.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+
+module Leaks
+  class RSpecRunner < RSpec::Core::Runner
+    def self.run(args, err, out)
+      trap_interrupt
+      options = RSpec::Core::ConfigurationOptions.new(args)
+      options.parse_options
+
+      unless RSpec::Core::CommandLine.new(options).run(err, out) == 0
+        raise RSpecError.new("A test has failed, quitting now. Run again in verbose mode to diagnose the problem")
+      end
+    end
+  end
+end

data/lib/leaks/runner.rb

@@ -0,0 +1,30 @@
+module Leaks
+  class RSpecError < StandardError; end
+
+  module Runner
+    class << self
+      attr_reader :ram_usage
+      attr_reader :runs
+    end
+
+    def self.run(path = 'spec', verbose=false)
+      @ram_usage = RAMUsage.new
+      @paths     = Array(path)
+      @out       = verbose ? $stdout : nil
+      @err       = $stderr
+      @runs      = 0
+      @printer   = Thread.new { Printer.run }
+
+      if defined?(ActiveRecord::Base)
+        ActiveRecord::Base.logger = nil
+      end
+
+      RSpecRunner.run(@paths, @err, @out)
+
+      loop do
+        RSpecRunner.run([], @err, @out)
+        @runs +=1
+      end
+    end
+  end
+end

data/lib/leaks/spinner.rb

@@ -0,0 +1,10 @@
+module Leaks
+  module Spinner
+    @chars = [ '|', '/', '-', '\\' ]
+
+    def self.to_s
+      @chars.push @chars.shift
+      @chars[0]
+    end
+  end
+end

data/lib/leaks/version.rb

@@ -0,0 +1,3 @@
+module Leaks
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: leaks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mario Visic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Leaks loops your rpsec tests and monitors process RAM usage to detect
+  any memory leaks. Processes with continiously growing usage could protentially have
+  a leak in them.
+email:
+- mario@mariovisic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- leaks.gemspec
+- lib/leaks.rb
+- lib/leaks/printer.rb
+- lib/leaks/ram_usage.rb
+- lib/leaks/rspec_runner.rb
+- lib/leaks/runner.rb
+- lib/leaks/spinner.rb
+- lib/leaks/version.rb
+homepage: https://github.com/mariovisic/leaks
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Find memory leaks using your rspec tests
+test_files: []