whysoslow 0.0.2 → 1.0.0

data/.gitignore

@@ -1,6 +1,19 @@
-pkg/*
-.bundle
 *.gem
 *.log
-.rvmrc
-.rbenv-version
+*.rbc
+.rbx/
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -1,6 +1,6 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Specify dependencies in whysoslow.gemspec
 gemspec
 
-gem 'rake', '~>0.9.2'
+gem 'rake'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012-Present Kelly Redding
+
+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,52 @@
+# Whysoslow
+
+## Description
+
+Whysoslow is a little runner/printer I wrote to benchmark my Ruby code.  It runs a block of code, collects run time measurements, and can snapshot memory usage information at various points during execution.
+
+It has no tests, shockingly sparse docs, and is more of an experiment at this point.  It comes as is for now so use if you see fit.  I will happily accept any pull requests for documentation, tests, extensions, and improvements.
+
+## Usage
+
+```ruby
+require 'whysoslow'
+
+printer = Whysoslow::DefaultPrinter.new({
+  :title => "Bench Report Title",
+  :verbose => true
+})
+
+runner = Whysoslow::Runner.new(@printer)
+
+runner.run do
+  # ... some long running script or loop
+  runner.snapshot("mem usage during run")
+  # ... some more long running script or loop
+end
+```
+
+## Output: DefaultPrinter
+
+The DefaultPrinter outputs to an io stream ($stdout by default).  It uses Ansi to output columned memory usage snapshot data and measurement data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'whysoslow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whysoslow
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,7 +1 @@
-require 'assert/rake_tasks'
-Assert::RakeTasks.for(:test)
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-task :default => :build
+require "bundler/gem_tasks"

data/lib/whysoslow.rb

@@ -1,4 +1,6 @@
-module Whysoslow; end
-
-require 'whysoslow/runner'
+require 'whysoslow/version'
 require 'whysoslow/default_printer'
+require 'whysoslow/runner'
+
+module Whysoslow
+end

data/lib/whysoslow/memory_profile.rb

@@ -1,9 +1,6 @@
 module Whysoslow
-
   class MemoryProfile
 
-    class Snapshot; end
-
     attr_reader :snapshots, :divider
     attr_accessor :units
 
@@ -21,26 +18,23 @@ module Whysoslow
     end
 
     def snapshot(label)
-      Snapshot.new(label, @divider).tap { |snap| @snapshots.push(snap) }
+      Snapshot.new(label, @divider).tap{ |snap| @snapshots.push(snap) }
     end
 
-  end
-
-  class MemoryProfile::Snapshot
-
-    attr_reader :label, :memory
+    class Snapshot
+      attr_reader :label, :memory
 
-    def initialize(label, divider)
-      @label = label
-      @memory = capture_memory_usage(divider)
-    end
+      def initialize(label, divider)
+        @label = label
+        @memory = capture_memory_usage(divider)
+      end
 
-    protected
+      protected
 
-    def capture_memory_usage(divider)
-      ((`ps -o rss= -p #{$$}`.to_i) / divider.to_f)
+      def capture_memory_usage(divider)
+        ((`ps -o rss= -p #{$$}`.to_i) / divider.to_f)
+      end
     end
 
   end
-
 end

data/lib/whysoslow/runner.rb

@@ -1,7 +1,6 @@
 require 'whysoslow/results'
 
 module Whysoslow
-
   class Runner
 
     attr_accessor :desc, :verbose, :time_unit, :memory_unit
@@ -27,7 +26,10 @@ module Whysoslow
     end
 
     def snapshot(*args)
-      raise RuntimeError, "no active results being gathered - be sure and call snapshot during a run session" if @results.nil?
+      if @results.nil?
+        raise RuntimeError, "no active results being gathered"\
+                            " - be sure and call snapshot during a run session"
+      end
       @results.snapshot(*args)
       @printer.print :snapshot
     end

data/lib/whysoslow/version.rb

@@ -1,3 +1,3 @@
 module Whysoslow
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/test/helper.rb

@@ -1,5 +1,8 @@
-# this file is automatically required in when you require 'assert' in your tests
-# put test helpers here
+# this file is automatically required when you run `assert`
+# put any test helpers here
 
-# add root dir to the load path
+# add the root dir to the load path
 $LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
+
+# require pry for debugging (`binding.pry`)
+require 'pry'

data/test/unit/whysoslow_test.rb

@@ -0,0 +1,17 @@
+require 'assert'
+require 'whysoslow'
+
+module Whysoslow
+
+  class UnitTests < Assert::Context
+    desc "Whysoslow"
+
+    # no tests right now - all this does is make sure you can load it
+
+    should "load" do
+      assert_equal false, require('whysoslow')
+    end
+
+  end
+
+end

data/whysoslow.gemspec

@@ -1,23 +1,25 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "whysoslow/version"
 
-Gem::Specification.new do |s|
-  s.name        = "whysoslow"
-  s.version     = Whysoslow::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Kelly Redding"]
-  s.email       = ["kelly@kellyredding.com"]
-  s.homepage    = "http://github.com/kellyredding/whysoslow"
-  s.summary     = %q{A little runner/printer to benchmark Ruby code blocks}
-  s.description = %q{A little runner/printer to benchmark Ruby code blocks}
+Gem::Specification.new do |gem|
+  gem.name        = "whysoslow"
+  gem.version     = Whysoslow::VERSION
+  gem.authors     = ["Kelly Redding"]
+  gem.email       = ["kelly@kellyredding.com"]
+  gem.description = %q{A little runner/printer to benchmark Ruby code blocks}
+  gem.summary     = %q{A little runner/printer to benchmark Ruby code blocks}
+  gem.homepage    = "http://github.com/kellyredding/whysoslow"
+  gem.license     = 'MIT'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  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_development_dependency("assert", ["~> 2.0"])
+
+  gem.add_dependency("ansi", ["~> 1.4"])
 
-  s.add_development_dependency("bundler")
-  s.add_development_dependency("assert")
-  s.add_dependency("ansi", "~> 1.4")
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whysoslow
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -15,40 +15,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-20 00:00:00 Z
+date: 2013-07-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: assert
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
+        - 2
         - 0
-        version: "0"
+        version: "2.0"
+  type: :development
   version_requirements: *id001
-  name: bundler
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: ansi
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id002
-  name: assert
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -58,8 +45,8 @@ dependencies:
         - 1
         - 4
         version: "1.4"
-  version_requirements: *id003
-  name: ansi
+  type: :runtime
+  version_requirements: *id002
 description: A little runner/printer to benchmark Ruby code blocks
 email: 
 - kelly@kellyredding.com
@@ -72,8 +59,8 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
-- README.rdoc
+- LICENSE.txt
+- README.md
 - Rakefile
 - lib/whysoslow.rb
 - lib/whysoslow/default_printer.rb
@@ -83,12 +70,11 @@ files:
 - lib/whysoslow/runner.rb
 - lib/whysoslow/version.rb
 - test/helper.rb
-- test/irb.rb
-- test/whysoslow_test.rb
+- test/unit/whysoslow_test.rb
 - whysoslow.gemspec
 homepage: http://github.com/kellyredding/whysoslow
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []
 
@@ -115,11 +101,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A little runner/printer to benchmark Ruby code blocks
 test_files: 
 - test/helper.rb
-- test/irb.rb
-- test/whysoslow_test.rb
+- test/unit/whysoslow_test.rb

data/Gemfile.lock

@@ -1,26 +0,0 @@
-PATH
-  remote: .
-  specs:
-    whysoslow (0.0.2)
-      ansi (~> 1.4)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    ansi (1.4.2)
-    assert (0.7.3)
-      assert-view (~> 0.5)
-    assert-view (0.5.0)
-      ansi (~> 1.3)
-      undies (~> 2.0)
-    rake (0.9.2.2)
-    undies (2.2.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  assert
-  bundler
-  rake (~> 0.9.2)
-  whysoslow!

data/README.rdoc

@@ -1,59 +0,0 @@
-= Whysoslow
-
-== Description
-
-Whysoslow is a little runner/printer I wrote to benchmark my Ruby code.  It runs a block of code, collects run time measurements, and can snapshot memory usage information at various points during execution.
-
-It has no tests, shockingly sparse docs, and is more of an experiment at this point.  It comes as is for now so use if you see fit.
-
-I will happily accept any pull requests for documentation, tests, extensions, and improvements.
-
-== Installation
-
-    gem install whysoslow
-
-== Usage
-
-    require 'whysoslow'
-
-    printer = Whysoslow::DefaultPrinter.new({
-      :title => "Bench Report Title",
-      :verbose => true
-    })
-
-    runner = Whysoslow::Runner.new(@printer)
-
-    runner.run do
-      # ... some long running script or loop
-      runner.snapshot("mem usage during run")
-      # ... some more long running script or loop
-    end
-
-== Output: DefaultPrinter
-
-The DefaultPrinter outputs to an io stream ($stdout by default).  It uses Ansi to output columned memory usage snapshot data and measurement data.
-
-== License
-
-Copyright (c) 2012 Kelly Redding
-
-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/test/irb.rb

@@ -1,9 +0,0 @@
-require 'assert/setup'
-
-# this file is required in when the 'irb' rake test is run.
-# b/c 'assert/setup' is required above, the test helper will be
-# required in as well.
-
-# put any IRB setup code here
-
-require 'whysoslow'

data/test/whysoslow_test.rb

@@ -1,4 +0,0 @@
-require "assert"
-
-class WhysoslowTest < Assert::Context
-end