benchmark-plot 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 114e9d216ecac8f1ff8af12dc422bbdbb37b7bf5
+  data.tar.gz: 7d3e52515be9d788f46ee623e32981a6239829dc
+SHA512:
+  metadata.gz: 7880f2edf6bf4698847951bd230400496efcf472d8377ac745c714569d006d081b47f3e68cbdd58013a9bdc11ec53d56352ee029959f91590def4144b3b8836a
+  data.tar.gz: e7166e9ce00753a6725ea5a58adff933fe2d711c3dde657687702b2447bf27f9c549e134c0fce03b1d00063623877afbfbd222920c9fe44a9b9e4ae42b835a45

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/HISTORY.md

@@ -0,0 +1,3 @@
+# 0.1
+
+* First gem release. Support for basic args and options.

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2016, Sameer Deshmukh
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of benchmark-plot nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,6 @@
+# benchmark-plot
+A Ruby benchmark extension to allow comparative plotting of benchmarks.
+
+# Acknowledgements
+
+@tgxworld for providing the co-working space during the Open Source Breakfast Hack during Red Dot Ruby Conf 2016 where this gem was built.

data/benchmark-plot.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'benchmark/plot/version.rb'
+
+Benchmark::Plot::DESCRIPTION = <<MSG
+benchmark-plot is an extension to the Ruby standard benchmarking library.
+
+It let's you easily create plots in the form of PNG images of any code that you
+want to benchmark over a varied number of inputs. It also supports comparative
+benchmarking.
+MSG
+
+Gem::Specification.new do |spec|
+  spec.name          = 'benchmark-plot'
+  spec.version       = Benchmark::Plot::VERSION
+  spec.authors       = ['Sameer Deshmukh']
+  spec.email         = ['sameer.deshmukh93@gmail.com']
+  spec.summary       = %q{benchmark-plot}
+  spec.description   = Benchmark::Plot::DESCRIPTION
+  spec.homepage      = "http://github.com/v0dro/benchmark-plot"
+  spec.license       = 'BSD-2'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'gruff'
+end

data/examples/flat_vs_flat_map.rb

@@ -0,0 +1,26 @@
+require 'benchmark/plot'
+
+class TestArray
+  attr_reader :arr
+
+  def initialize arr
+    @arr = arr
+  end
+
+  def to_s
+    @arr.size.to_s
+  end
+end
+
+test_data = [5, 25, 50, 75, 100, 125, 150, 175, 200,250,300]
+test_data.map! {|e| TestArray.new(Array.new(e) {|i| i}) }
+
+Benchmark.plot(test_data) do |x|
+  x.report("map.flatten") do |data|
+    data.arr.map { [nil]  }.flatten
+  end
+
+  x.report("flat_map") do |data|
+    data.arr.flat_map { [nil] }
+  end
+end

data/examples/mapflat_vs_flat_map/flat_vs_flat_map.rb

@@ -0,0 +1,12 @@
+test_data = [5, 25, 50, 75, 100, 125, 150, 175, 200,250,300]
+test_data.map! {|e| Array.new(e) {|i| i} }
+
+Benchmark.plot(test_data) do |x|
+  x.report("map.flatten") do |data|
+    data.map { [nil]  }.flatten
+  end
+
+  x.report("flat_map") do |data|
+    data.flat_map { [nil] }
+  end
+end

data/examples/matrix_benchmarks.rb

@@ -0,0 +1,14 @@
+require 'nmatrix'
+require 'matrix'
+
+test_data = [5,10,15,20,25,30,35]
+
+Benchmark.plot(test_data) do |x, data|
+  x.report("nmatrix creation") do
+    Array.new(data) { |i|  i }
+  end
+
+  x.report("matrix creation") do
+    Array.new(data) { |i|  i }
+  end
+end

data/lib/benchmark/plot.rb

@@ -0,0 +1,17 @@
+require 'benchmark'
+require 'gruff'
+
+require 'benchmark/plot/plotter'
+require 'benchmark/plot/report_maker'
+require 'benchmark/plot/version'
+
+module Benchmark
+  def self.plot test_data, opts={}, &block
+    include Benchmark::Plot
+
+    reporter = ReportMaker.new(test_data)
+    yield(reporter)
+    plotter = Plotter.new reporter, test_data, opts
+    plotter.plot
+  end
+end

data/lib/benchmark/plot/plotter.rb

@@ -0,0 +1,35 @@
+module Benchmark
+  module Plot
+    class Plotter
+      def initialize reporter, test_data, opts
+        @reporter  = reporter
+        @file_name = opts[:file_name] || :benchmark_plot_graph
+        @title     = opts[:title] || :Benchmarks
+        @time      = opts[:time] || :real
+        @x_labels  = opts[:x_labels] || true
+        @test_data = test_data
+      end
+
+      def plot
+        plot = Gruff::Line.new
+        plot.title = @title.to_s
+        reports = @reporter.reports
+
+        reports.each do |label, report|
+          time_data = report.map do |tms|
+            tms.send(@time)
+          end
+          plot.data label, time_data
+        end
+        positions = Array.new(@test_data.size) { |i| i }
+        puts positions.zip(@test_data.map(&:to_s)).to_h
+        plot.labels = positions.zip(@test_data.map(&:to_s)).to_h if @x_labels
+        plot.write("#{@file_name}.png")
+      end
+
+      def all_labels
+        @reporter.reports.keys
+      end
+    end
+  end
+end

data/lib/benchmark/plot/report_maker.rb

@@ -0,0 +1,21 @@
+module Benchmark
+  module Plot
+    class ReportMaker
+      def initialize data
+        @data = data
+        @reports = {}
+      end
+
+      def report(label,&block)
+        results_array = @data.each_with_object([]) do |d, results|
+          lmb = lambda { block.call(d) }
+          results << Benchmark.measure(label, &lmb)
+        end
+        @reports[label] = results_array
+      end
+
+      # An array of Benchmark::Tms objects representing each item.
+      attr_reader :reports
+    end
+  end
+end

data/lib/benchmark/plot/version.rb

@@ -0,0 +1,5 @@
+module Benchmark
+  module Plot
+    VERSION = "0.1"
+  end
+end

data/spec/benchmark_plot_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Benchmark do
+  context ".plot" do
+    # TODO: write tests
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'benchmark/plot'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: benchmark-plot
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Sameer Deshmukh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gruff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  benchmark-plot is an extension to the Ruby standard benchmarking library.
+
+  It let's you easily create plots in the form of PNG images of any code that you
+  want to benchmark over a varied number of inputs. It also supports comparative
+  benchmarking.
+email:
+- sameer.deshmukh93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- HISTORY.md
+- LICENSE
+- README.md
+- benchmark-plot.gemspec
+- examples/flat_vs_flat_map.rb
+- examples/mapflat_vs_flat_map/benchmark_plot_graph.png
+- examples/mapflat_vs_flat_map/flat_vs_flat_map.rb
+- examples/matrix_benchmarks.rb
+- lib/benchmark/plot.rb
+- lib/benchmark/plot/plotter.rb
+- lib/benchmark/plot/report_maker.rb
+- lib/benchmark/plot/version.rb
+- spec/benchmark_plot_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/v0dro/benchmark-plot
+licenses:
+- BSD-2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: benchmark-plot
+test_files:
+- spec/benchmark_plot_spec.rb
+- spec/spec_helper.rb
+has_rdoc: