benchmark-bigo 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 423aefb007643b70b3a3b6948ec4be73a699e39e
-  data.tar.gz: 58fb68d5bc09db75769948213ba3d7f493cdc433
+  metadata.gz: ddf502a4bf2a5eabc6ec0127d22f1ab16ee69eca
+  data.tar.gz: 43b1ce1e054c451c63a0d9597d73461d4b64be15
 SHA512:
-  metadata.gz: 5725e3a65ab19f74b6ebcb12a949247abf1d66cd22ebe8394da76e876ce1014a3628c1398e39daaab81597137f67976c88dcc564e07c4994c747bb47aaea311b
-  data.tar.gz: 674a6df9fa33fc2963906343d0f11dad96e4ab12345186743f6d5a3d0c3df40e82b9d318342e76917a2cdac3c7e1628add50bf296423cb1d6056c6346c5cecc3
+  metadata.gz: 6c73e84f56907153c5ff2ec84ecf4da9942431ed477a2408504b0d96e2c5d0be2c3aee8638a117fa5c5da29a76b4c4b150f2221b5362520b66d296201dc19fce
+  data.tar.gz: e7bbe74394cd62b596a51bc2002abe776f36c789ffb7b4a941dc88fb3e8c2fd2a4339dcc008c281e12264385b547fcfd91fd2d4c32a8e19d00405667eec57ea6

data/README.md

@@ -2,20 +2,28 @@
 
 # benchmark-bigo
 
-* http://github.com/davy/benchmark-bigo
+Benchmark objects to help calculate Big O behavior
 
-## DESCRIPTION:
+## Installation
 
-Benchmark objects to help calculate Big O behavior
+In your application's Gemfile:
+
+```ruby
+gem 'benchmark-bigo'
+```
 
-## SYNOPSIS:
+Or install it manually:
+
+```sh
+$ gem install benchmark-bigo
+```
+
+## Usage
 
 ```ruby
 require 'benchmark/bigo'
 
 report = Benchmark.bigo do |x|
-
-
   # increments is the total number of data points to collect
   x.increments = 6
 
@@ -23,8 +31,11 @@ report = Benchmark.bigo do |x|
   # example of an Array generator
   x.generator {|size| (0...size).to_a.shuffle }
 
+  # or you can use the built in array generator
+  # x.generate :array
+
   # specifies how the size of the object should grow
-  #   options: linear, logarithmic
+  #   options: linear, exponential
   #
   # specifies that arrays should grow linearly by 1000
   x.linear 1000
@@ -44,28 +55,27 @@ report = Benchmark.bigo do |x|
   # for each report, create a comparison chart showing the report
   # and scaled series for O(log n), O(n), O(n log n), and O(n squared)
   x.compare!
-
 end
 ```
 
-## REQUIREMENTS:
-
-* benchmark-ips (http://github.com/evanphx/benchmark-ips)
-
-## INSTALL:
-
-    $ gem install benchmark-bigo
+## Contributing
 
-## DEVELOPERS:
+After checking out the source, run the tests:
 
-After checking out the source, run:
+```
+$ git clone git@github.com:davy/benchmark-bigo.git
+$ cd benchmark-bigo
+$ bundle install
+$ bundle exec rake test
+```
 
-    $ rake newb
+You can also generate RDoc:
 
-This task will install any missing dependencies, run the tests/specs,
-and generate the RDoc.
+```
+$ bundle exec rdoc --main README.md
+```
 
-## LICENSE:
+## License
 
 (The MIT License)
 

data/lib/benchmark/bigo.rb

@@ -8,8 +8,6 @@ require 'benchmark/bigo/job'
 module Benchmark
 
   module BigO
-    VERSION = "0.0.1"
-
     def bigo
       suite = nil
 

data/lib/benchmark/bigo/job.rb

@@ -125,8 +125,8 @@ module Benchmark
         @logscale = false
       end
 
-      # logarithmic incrementer
-      def logarithmic base=10
+      # exponential incrementer
+      def exponential base=10
         @incrementer = Proc.new {|i| base ** (i-1) }
         @full_report.logscale!
         @logscale = true
@@ -190,7 +190,7 @@ module Benchmark
           end
         end
 
-        template_file = File.join File.dirname(__FILE__), 'chart.erb'
+        template_file = File.join File.dirname(__FILE__), 'templates/chart.erb'
         template = ERB.new(File.read(template_file))
 
         File.open @chart, 'w' do |f|

data/lib/benchmark/bigo/version.rb

@@ -0,0 +1,15 @@
+module Benchmark
+  module BigO
+    class Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH].compact.join('.')
+      end
+    end
+
+    VERSION = Version.to_s
+  end
+end

data/test/benchmark/test_bigo.rb

@@ -1,8 +1,156 @@
 require "minitest/autorun"
 require "benchmark/bigo"
 
-class TestBenchmark::TestBigo < MiniTest::Test
-  def test_sanity
-#    flunk "write tests or I will kneecap you"
+class TestBenchmarkBigo < MiniTest::Test
+  def setup
+    @old_stdout = $stdout
+    $stdout = StringIO.new
+  end
+
+  def teardown
+    $stdout = @old_stdout
+  end
+
+  def test_bigo
+    #skip('pass')
+
+    report = Benchmark.bigo do |x|
+      x.config(:time => 1, :warmup => 1, :increments => 2)
+      x.generate :array
+
+      x.report("#at") {|array, size| array.at rand(size) }
+      x.report("#index") {|array, size| array.index rand(size) }
+      x.report("sleep") { |a,b| sleep(0.25) }
+    end
+
+    assert_equal 3, report.entries.length
+
+    assert report.entries.keys.include?("#at")
+    assert report.entries.keys.include?("#index")
+    assert report.entries.keys.include?("sleep")
+
+    at_rep = report.entries["#at"]
+    index_rep = report.entries["#index"]
+    sleep_rep = report.entries["sleep"]
+
+    assert_equal 2, at_rep.size
+    assert_equal 2, index_rep.size
+    assert_equal 2, sleep_rep.size
+
+    assert_equal "#at 100", at_rep[0].label
+    assert_equal "#at 200", at_rep[1].label
+
+    assert_equal "#index 100", index_rep[0].label
+    assert_equal "#index 200", index_rep[1].label
+
+    assert_equal "sleep 100", sleep_rep[0].label
+    assert_equal "sleep 200", sleep_rep[1].label
+
+    assert_equal 4, sleep_rep[0].iterations
+    assert_in_delta 4.0, sleep_rep[0].ips, 0.2
+
+  end
+
+  def test_bigo_alternate_config
+    #skip('pass')
+    report = Benchmark.bigo do |x|
+      x.time = 1
+      x.warmup = 1
+      x.increments = 2
+      x.generate(:array)
+      x.report("sleep") { |a,b| sleep(0.25) }
+    end
+
+    rep = report.entries["sleep"]
+    assert_equal 2, rep.size
+
+    assert_equal "sleep 100", rep[0].label
+    assert_equal 4, rep[0].iterations
+    assert_in_delta 4.0, rep[0].ips, 0.2
+  end
+
+  def test_bigo_defaults
+    #skip('pass')
+    report = Benchmark.bigo do |x|
+      x.config(:time => 1, :warmup => 1)
+      x.generate :array
+      x.report("sleep") { |a,b| sleep(0.25) }
+    end
+
+    assert_equal 1, report.entries.keys.length
+    rep = report.entries["sleep"]
+
+    assert_equal 5, rep.size
+
+    assert_equal "sleep 100", rep[0].label
+    assert_equal "sleep 200", rep[1].label
+    assert_equal "sleep 300", rep[2].label
+    assert_equal "sleep 400", rep[3].label
+    assert_equal "sleep 500", rep[4].label
+
+    assert_equal 4, rep[0].iterations
+    assert_in_delta 4.0, rep[0].ips, 0.2
+  end
+
+  def test_bigo_exponential
+    #skip('pass')
+    report = Benchmark.bigo do |x|
+      x.config(:time => 1, :warmup => 1, :increments => 2)
+      x.generate :array
+      x.exponential
+      x.report("sleep") { |a,b| sleep(0.25) }
+    end
+
+    rep = report.entries["sleep"]
+
+    assert_equal "sleep 1", rep[0].label
+    assert_equal "sleep 10", rep[1].label
+    assert_equal 4, rep[0].iterations
+    assert_in_delta 4.0, rep[0].ips, 0.2
+  end
+
+  def test_bigo_increments_config
+    #skip('pass')
+    report = Benchmark.bigo do |x|
+      x.config(:time => 1, :warmup => 1, :increments => 3)
+      x.generate :array
+
+      x.report("#at") {|array, size| array.at rand(size) }
+    end
+
+    assert_equal 1, report.entries.length
+
+    assert report.entries.keys.include?("#at")
+
+    at_rep = report.entries["#at"]
+
+    assert_equal 3, at_rep.size
+
+    assert_equal "#at 100", at_rep[0].label
+    assert_equal "#at 200", at_rep[1].label
+    assert_equal "#at 300", at_rep[2].label
+  end
+
+  def test_bigo_increments_setter
+    #skip('pass')
+    report = Benchmark.bigo do |x|
+      x.config(:time => 1, :warmup => 1)
+      x.increments = 3
+      x.generate :array
+
+      x.report("#at") {|array, size| array.at rand(size) }
+    end
+
+    assert_equal 1, report.entries.length
+
+    assert report.entries.keys.include?("#at")
+
+    at_rep = report.entries["#at"]
+
+    assert_equal 3, at_rep.size
+
+    assert_equal "#at 100", at_rep[0].label
+    assert_equal "#at 200", at_rep[1].label
+    assert_equal "#at 300", at_rep[2].label
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-bigo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Davy Stevenson
@@ -14,121 +14,110 @@ dependencies:
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: chartkick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.2.4
 - !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: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: hoe
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 description: Benchmark objects to help calculate Big O behavior
 email:
 - davy.stevenson@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- History.txt
-- Manifest.txt
 - README.md
 files:
-- History.txt
-- Manifest.txt
 - README.md
-- Rakefile
 - lib/benchmark/bigo.rb
-- lib/benchmark/bigo/report.rb
 - lib/benchmark/bigo/job.rb
-- lib/benchmark/bigo/chart.erb
+- lib/benchmark/bigo/report.rb
+- lib/benchmark/bigo/templates/chart.erb
+- lib/benchmark/bigo/version.rb
 - test/benchmark/test_bigo.rb
-- .gemtest
 homepage: http://github.com/davy/benchmark-bigo
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.md
 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Benchmark objects to help calculate Big O behavior

data/History.txt

@@ -1,6 +0,0 @@
-=== 0.0.1 / 2014-05-12
-
-* 1 major enhancement
-
-  * Birthday!
-

data/Manifest.txt

@@ -1,8 +0,0 @@
-History.txt
-Manifest.txt
-README.md
-Rakefile
-lib/benchmark/bigo.rb
-lib/benchmark/bigo/report.rb
-lib/benchmark/bigo/job.rb
-lib/benchmark/bigo/chart.erb

data/Rakefile

@@ -1,20 +0,0 @@
-# -*- ruby -*-
-
-require "rubygems"
-require "hoe"
-
-Hoe.plugin :minitest
-
-Hoe.spec "benchmark-bigo" do
-
-  developer("Davy Stevenson", "davy.stevenson@gmail.com")
-
-  extra_deps << ["benchmark-ips", '~> 2.0']
-  extra_deps << ["chartkick", '~> 1.2', '>= 1.2.4']
-
-  self.readme_file = 'README.md'
-
-  license "MIT" # this should match the license in the README
-end
-
-# vim: syntax=ruby