benchmark-bigo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 423aefb007643b70b3a3b6948ec4be73a699e39e
+  data.tar.gz: 58fb68d5bc09db75769948213ba3d7f493cdc433
+SHA512:
+  metadata.gz: 5725e3a65ab19f74b6ebcb12a949247abf1d66cd22ebe8394da76e876ce1014a3628c1398e39daaab81597137f67976c88dcc564e07c4994c747bb47aaea311b
+  data.tar.gz: 674a6df9fa33fc2963906343d0f11dad96e4ab12345186743f6d5a3d0c3df40e82b9d318342e76917a2cdac3c7e1628add50bf296423cb1d6056c6346c5cecc3

data/History.txt

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

data/Manifest.txt

@@ -0,0 +1,8 @@
+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/README.md

@@ -0,0 +1,91 @@
+[![Build Status](https://secure.travis-ci.org/davy/benchmark-bigo.png)](http://travis-ci.org/davy/benchmark-bigo)
+
+# benchmark-bigo
+
+* http://github.com/davy/benchmark-bigo
+
+## DESCRIPTION:
+
+Benchmark objects to help calculate Big O behavior
+
+## SYNOPSIS:
+
+```ruby
+require 'benchmark/bigo'
+
+report = Benchmark.bigo do |x|
+
+
+  # increments is the total number of data points to collect
+  x.increments = 6
+
+  # generator should construct a test object of the given size
+  # example of an Array generator
+  x.generator {|size| (0...size).to_a.shuffle }
+
+  # specifies how the size of the object should grow
+  #   options: linear, logarithmic
+  #
+  # specifies that arrays should grow linearly by 1000
+  x.linear 1000
+
+  # report takes a label and a block.
+  # block is passed in the generated object and the size of that object
+  x.report("#at") {|generated, size| generated.at rand(size) }
+  x.report("#index") {|generated, size| generated.index rand(size) }
+  x.report("#empty-index") {|generated, size| generated.index 'foo' }
+
+  # save results in JSON format
+  x.data! 'chart_array_simple.json'
+
+  # generate HTML chart using ChartKick
+  x.chart! 'chart_array_simple.html'
+
+  # 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
+
+## DEVELOPERS:
+
+After checking out the source, run:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2014 Davy Stevenson
+
+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/Rakefile

@@ -0,0 +1,20 @@
+# -*- 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

data/lib/benchmark/bigo.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'erb'
+require 'chartkick'
+require 'benchmark/ips'
+require 'benchmark/bigo/report'
+require 'benchmark/bigo/job'
+
+module Benchmark
+
+  module BigO
+    VERSION = "0.0.1"
+
+    def bigo
+      suite = nil
+
+      sync, $stdout.sync = $stdout.sync, true
+
+      if defined? Benchmark::Suite and Suite.current
+        suite = Benchmark::Suite.current
+      end
+
+      quiet = suite && !suite.quiet?
+
+      job = Job.new({:suite => suite,
+                     :quiet => quiet
+      })
+
+      yield job
+
+      $stdout.puts "Calculating -------------------------------------" unless quiet
+
+      job.run_warmup
+
+      $stdout.puts "-------------------------------------------------" unless quiet
+
+      job.run
+
+      if job.data?
+        job.generate_data
+      end
+
+      if job.chart?
+        job.generate_chart
+      end
+
+      $stdout.sync = sync
+
+      return job.full_report
+    end
+  end
+
+  extend Benchmark::BigO
+end

data/lib/benchmark/bigo/chart.erb

@@ -0,0 +1,17 @@
+<html>
+  <head>
+    <script src="http://code.jquery.com/jquery-2.1.1.min.js"></script>
+    <script src="http://www.google.com/jsapi"></script>
+    <script src="http://code.highcharts.com/highcharts.js"></script>
+    <script src="http://chartkick.com/chartkick.js"></script>
+  </head>
+  <body>
+
+  <% for chart in charts %>
+    <h1><%= chart[:name] %></h1>
+
+    <%= line_chart chart[:data], chart[:opts] %>
+  <% end %>
+  </body>
+</html>
+

data/lib/benchmark/bigo/job.rb

@@ -0,0 +1,204 @@
+module Benchmark
+
+  module BigO
+    class Job < IPS::Job
+
+      class Entry < IPS::Job::Entry
+
+        def initialize label, action, generated, size
+          super label, action
+
+          if @as_action
+            raise "as_action not supported yet"
+          else
+            raise ArgumentError if action.arity != 2
+            @call_loop = false
+          end
+
+          # these objects can be very large, do not want
+          # them to be displayed as part of inspect
+          define_singleton_method(:generated) { generated }
+          define_singleton_method(:size) { size }
+        end
+
+        def call_times(times)
+          act = @action
+
+          i = 0
+          while i < times
+            act.call generated, size
+            i += 1
+          end
+        end
+
+      end
+
+      include Chartkick::Helper
+
+      # how many total increments are being measured
+      attr_accessor :increments
+
+      # whether to graph the results on a log scale
+      attr_accessor :logscale
+
+      # whether to generate a chart of the results
+      # if nil, do not generate chart
+      # else string is name of file to write chart out to
+      attr_reader :chart
+
+      def initialize opts={}
+        super
+
+        @full_report = Report.new
+        @generator = nil
+
+        # defaults
+        linear
+        @increments = 5
+        @logscale = false
+        @chart = nil
+        @data_file = nil
+      end
+
+      def config opts
+        super
+        @increments = opts[:increments] if opts[:increments]
+        @logscale = opts[:logscale] if opts[:logscale]
+        @full_report.logscale! if @logscale
+      end
+
+      def chart?
+        @chart
+      end
+
+      def chart! filename='chart.html'
+        @chart = filename
+      end
+
+      def data?
+        @data_file
+      end
+
+      def data! filename='data.json'
+        @data_file = filename
+      end
+
+      def logscale= val
+        @logscale = val
+        @full_report.logscale! if @logscale
+      end
+
+      def generator &blk
+        @generator = blk
+
+        raise ArgumentError, "no block" unless @generator
+      end
+
+
+      # use a generator that creates a randomized object
+      # represented by the symbol passed to the method
+      def generate sym
+
+        case sym
+
+        # generates an Array containing shuffled integer values from 0 to size
+        when :array
+          @generator = Proc.new{|size| (0...size).to_a.shuffle }
+
+        # when :string
+          # to do
+
+        else
+          raise "#{sym} is not a supported object type"
+        end
+      end
+
+      # custom incrementer
+      def incrementer &blk
+        @incrementer = blk
+        raise ArgumentError, "no block" unless @incrementer
+      end
+
+      # linear incrementer
+      def linear increments=100
+        @incrementer = Proc.new {|i| i * increments }
+        @logscale = false
+      end
+
+      # logarithmic incrementer
+      def logarithmic base=10
+        @incrementer = Proc.new {|i| base ** (i-1) }
+        @full_report.logscale!
+        @logscale = true
+      end
+
+      def sizes
+        (1..@increments).collect do |idx|
+          @incrementer.call(idx).to_i
+        end
+      end
+
+      def item label="", str=nil, &blk # :yield:
+        if blk and str
+          raise ArgumentError, "specify a block and a str, but not both"
+        end
+
+        action = str || blk
+        raise ArgumentError, "no block or string" unless action
+
+        for size in sizes
+          generated = @generator.call(size)
+
+          label_size = "#{label} #{size}"
+          @list.push Entry.new(label_size, action, generated, size)
+        end
+
+        self
+      end
+      alias_method :report, :item
+
+      def run_warmup
+        super
+
+        max_timing = @timing.values.max
+        @full_report.per_iterations = 10**Math.log10(max_timing).ceil
+      end
+
+      def generate_data
+        return if @data_file.nil?
+
+        all_data = @full_report.chart_data
+
+        File.open @data_file, 'w' do |f|
+          f.write JSON.pretty_generate(all_data)
+        end
+      end
+
+      def generate_chart
+        return if @chart.nil?
+
+        all_data = @full_report.chart_data
+
+        charts = []
+        charts << { name: 'Growth Chart', data: all_data, opts: @full_report.chart_opts(all_data) }
+
+        if compare?
+          all_sizes = sizes
+          for chart_data in all_data
+            comparison_data = @full_report.comparison_chart_data chart_data, all_sizes
+            charts << { name: chart_data[:name], data: comparison_data, opts: @full_report.chart_opts(chart_data) }
+          end
+        end
+
+        template_file = File.join File.dirname(__FILE__), 'chart.erb'
+        template = ERB.new(File.read(template_file))
+
+        File.open @chart, 'w' do |f|
+          f.write template.result(binding)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/benchmark/bigo/report.rb

@@ -0,0 +1,130 @@
+module Benchmark
+
+  module BigO
+    class Report
+
+      attr_accessor :per_iterations
+      attr_reader :entries
+
+      def initialize
+        @per_iterations = 0
+        @entries = {}
+        @logscale = false
+      end
+
+      def logscale?
+        @logscale
+      end
+
+      def logscale!
+        @logscale = true
+      end
+
+      def add_entry label, microseconds, iters, ips, ips_sd, measurement_cycle
+        group_label = label.split(' ').first
+
+        @entries[group_label] ||= []
+        @entries[group_label] << Benchmark::IPS::Report::Entry.new(label, microseconds, iters, ips, ips_sd, measurement_cycle)
+        @entries[group_label].last
+      end
+
+      def scaled_iterations
+        (@per_iterations.to_f * 50 )
+      end
+
+      def chart_hash group_label
+        @entries[group_label].collect do |report|
+          size = report.label.split(' ').last.to_i
+          seconds_per_scaled_iters = scaled_iterations / report.ips.to_f
+
+          {label: size,
+           seconds_per_scaled_iters: seconds_per_scaled_iters,
+           ips: report.ips
+          }
+        end
+      end
+
+      def chart_for group_label
+        chart_hash = chart_hash group_label
+        Hash[chart_hash.collect{|h| [h[:label], h[:seconds_per_scaled_iters]]}]
+      end
+
+      def chart_data
+        @entries.keys.map do |k|
+          data = chart_for k
+          {name: k, data: data }
+        end
+      end
+
+      def chart_opts chart_data
+
+        axis_type = logscale? ? 'logarithmic' : 'linear'
+
+        if chart_data.is_a? Array
+          min = chart_data.collect{|d| d[:data].values.min}.min
+          max = chart_data.collect{|d| d[:data].values.max}.max
+
+        elsif chart_data.is_a? Hash
+          min = chart_data[:data].values.min
+          max = chart_data[:data].values.max
+        end
+
+        orange = "#f0662d"
+        purple = "#8062a6"
+        light_green = "#7bc545"
+        med_blue = "#0883b2"
+        yellow = "#ffaa00"
+
+        {
+          discrete: true,
+          width: "800px",
+          height: "500px",
+          min: (min * 0.8).floor,
+          max: (max * 1.2).ceil,
+          library: {
+            colors: [orange, purple, light_green, med_blue, yellow],
+            xAxis: {type: axis_type, title: {text: "Size"}},
+            yAxis: {type: axis_type, title: {text: "Seconds per #{scaled_iterations.to_i} Iterations"}}
+          }
+        }
+      end
+
+      def comparison_chart_data chart_data, sizes
+        sample_size = sizes.first
+
+        # can't take log of 1,
+        # so it can't be used as the sample
+        if sample_size == 1
+          sample_size = sizes[1]
+        end
+
+        sample = chart_data[:data][sample_size]
+
+        logn_sample = sample/Math.log10(sample_size)
+        n_sample = sample/sample_size
+        nlogn_sample = sample/(sample_size * Math.log10(sample_size))
+        n2_sample = sample/(sample_size * sample_size)
+
+        logn_data = {}
+        n_data = {}
+        nlogn_data = {}
+        n2_data = {}
+
+        sizes.each do |n|
+          logn_data[n] = Math.log10(n) * logn_sample
+          n_data[n] = n * n_sample
+          nlogn_data[n] = n * Math.log10(n) * nlogn_sample
+          n2_data[n] = n * n * n2_sample
+        end
+
+        comparison_data = []
+        comparison_data << chart_data
+        comparison_data << {name: 'log n', data: logn_data}
+        comparison_data << {name: 'n', data: n_data}
+        comparison_data << {name: 'n log n', data: nlogn_data}
+        comparison_data << {name: 'n_sq', data: n2_data}
+        comparison_data
+      end
+    end
+  end
+end

data/test/benchmark/test_bigo.rb

@@ -0,0 +1,8 @@
+require "minitest/autorun"
+require "benchmark/bigo"
+
+class TestBenchmark::TestBigo < MiniTest::Test
+  def test_sanity
+#    flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: benchmark-bigo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Davy Stevenson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+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
+- test/benchmark/test_bigo.rb
+- .gemtest
+homepage: http://github.com/davy/benchmark-bigo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --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
+signing_key: 
+specification_version: 4
+summary: Benchmark objects to help calculate Big O behavior
+test_files:
+- test/benchmark/test_bigo.rb