benchpress 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9528aae3490907cc35b0cdf0ea6386495b6b422e
-  data.tar.gz: 9996fddc495f27ef2e07465899324104a6fd9296
+  metadata.gz: 38edc94e8271789d69bf667ddd3b7ee3f50694c4
+  data.tar.gz: 5c5814779e8c63a1c664216033945d21c2e914ed
 SHA512:
-  metadata.gz: f889f17220a46a3ce1bf4affd855984335f7ac5337fb012254468eee0331bbc2d25bf45bb1356af1f976f2bfe61bed7c03caa3dfee745cb1c5cf533e4802d9de
-  data.tar.gz: f9b4ba4793df4fb12d4b26ccc4e1bf5f9bc174e1b67a37a0dc8f510e1063b276e34db3e27646fdb5516f3c034d3705090c8c35a226af3d561b3407b42a51d842
+  metadata.gz: 166dd6357b3d57e2a803ae4c348d9482fd10e18f329da92ef025e5f14bfbd75ed0a6576903b6a053a9d8028d0b08fe0bea243bdb480379b3ce1f1081e78d90b8
+  data.tar.gz: 55c0ea8a9f44679627c9c8636dfb89fd7cd680fd57f662fc3848688372ba45e9e8efadd39b0566a0e10291be3b300aad70f90337a629e2c447e851377fd5d4d7

data/README.md

@@ -1,10 +1,36 @@
 Benchpress
 ==========
 
-Pit a few ruby methods against eachother, and chart it for great glory
-
-Fair warning, this is super alpha one hour quick hack type material here. I intend to make it prettier later among other things, but I find it at least partially useful at this stage.
+Pit a few ruby methods against eachother, and chart it for great glory.
 
 Props to the folks at Gruff (https://github.com/topfunky/gruff) for making this simpler to do, and to the Ruby team behind Benchmark.
 
-![ruby type benchmark](http://i40.tinypic.com/a9oemx.png "Benchmark of Ruby Types")
+## How to Benchpress
+
+We're going to need to define a chart.
+
+```ruby
+c = Benchpress::Chart.new(
+  entities: {
+    string: -> { 'string' },
+    symbol: -> { :symbol  }
+  },
+  min: 10_000,               # Minimum times to run. Default: 0
+  max: 100_000,              # Maximum times to run. Default: 1_000
+  step: 10_000,              # Step rate for next benchmark. Default: 1
+  name: 'string_vs_symbol',  # File name. Default: 'Time.now.strftime '%Y-%m-%d-%H:%M:%S''
+  format: 'png'              # File format. Default: png
+)
+```
+
+and then render it:
+```ruby
+c.render # Line chart
+
+c.render :line # Line chart
+c.render :bar  # Bar chart
+```
+
+![](new pic url)
+
+Voila! Instant chart with realtime benchmarks to demonstrate complexities of methods everywhere! Supports an arbitrary number of entities.

data/RELEASE.md

@@ -0,0 +1,17 @@
+# v0.0.1
+
+Initial release
+
+# v1.0.0
+
+## Bug Fixes
+
+* Data points accumulating between runs on same entities
+
+## Changes
+
+* Entities are no longer directly instantiated
+  * Entities are passed as a hash, in which the keys are the entities name, and the values are methods.
+* Increase in rendering options
+  * Can now render bar charts.
+* More efficient stepping algorithm, decreases runtime.

data/benchpress.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Brandon Weaver"]
   spec.email         = ["keystonelemur@gmail.com"]
   spec.description   = %q{Pit Ruby methods against eachother in benchmark, and chart for great glory}
-  spec.summary       = %q{Ruby Benchmark + Gruff to auto-gen charts}
+  spec.summary       = %q{Ruby Benchmark + Gruff to auto-gen charts for method profiline}
   spec.homepage      = "https://github.com/baweaver/Benchpress"
-  spec.license       = "BSD"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "gruff"
+  spec.add_runtime_dependency "gruff"
 end

data/lib/benchpress/chart.rb

@@ -1,47 +1,90 @@
+require 'pry'
+
 module Benchpress
   class Chart
-    # step - increment
-    # min - minimum # of profiles to run
-    # max - maximum # of profiles to run
+
+    # format   - format of the file
+    # max      - maximum # of profiles to run
+    # min      - minimum # of profiles to run
+    # name     - name of the file
+    # step     - increment rate
+    # theme    - theme of the chart
     # entities - data methods to run against
     def initialize(opts = {})
-      @step = opts[:step] || 1
-      @min  = opts[:min]  || 0
-      @max  = opts[:max]  || 1000
-      @entities = opts[:entities]
-      @name = opts[:name] || "#{Time.now.strftime '%Y-%m-%d-%H:%M:%S'}"
-      @format = opts[:format] || 'png'
-      @theme = opts[:theme] || Gruff::Themes::THIRTYSEVEN_SIGNALS
+      @format   = opts[:format] || 'png'
+      @max      = opts[:max]    || 1000
+      @min      = opts[:min]    || 0
+      @name     = opts[:name]   || "#{Time.now.strftime '%Y-%m-%d-%H:%M:%S'}"
+      @step     = opts[:step]   || 1
+      @theme    = opts[:theme]  || Gruff::Themes::THIRTYSEVEN_SIGNALS
+      @entities = parse_entities opts[:entities]
+    end
+
+    # Lets you parse in entities by passing a hash in.
+    #
+    #   Benchpress::Chart.new(
+    #     entities: {
+    #       string: -> { 'string' }
+    #       symbol: -> { :symbol  }
+    #     }
+    #   )
+    def parse_entities(entities)
+      raise 'Must have entities' unless entities
+      @entities = entities.each_pair.reduce([]) { |ary, (name, method)| ary << Entity.new(name => method) }
     end
 
+    # file_name.ext
     def image_name
       @name + '.' + @format
     end
 
+    # Calculates Step Points
+    #
+    # (min / step) will render 0 unless min is greater than the step rate, giving the floor of the range
+    # (max / step) will render the maximum amount of times step will fit in the max wholly
+    #
+    # Caveat - If the max % step != 0, it will not render to the max. This is intended behavior.
     def step_points
-      @step_points ||= (@min..@max).select { |i| i % @step == 0 }
+      raise 'Cannot have larger step than max' if @step > @max
+      @step_points ||= ((@min / @step)..(@max / @step)).reduce([]) { |steps, i| steps << @step * i }
     end
 
-    def calculate_data_points
-      @entities.each do |entity|
-        step_points.each do |n|
-          entity.data_points << Benchmark.measure { n.times { entity.method.call } }.real
-        end
-      end
+    # Only grab labels for every other run, so as to space them out a bit more.
+    def even_labels
+      step_points.each_with_index.reduce({}) { |hash, (val, i)| i.odd? ? hash : hash.merge!({ i => val.to_s }) }
     end
 
-    def render
-      calculate_data_points
+    # Get labels for every point
+    def all_labels
+      step_points.each_with_index.reduce({}) { |hash, (val, index)| hash.merge!({ index => val.to_s }) }
+    end
 
-      Gruff::Line.new.tap { |g|
-        g.labels = step_points.each_with_index.reduce({}) { |hash, (val, index)|
-          index.odd? ? hash : hash.merge!({ index => val.to_s })
-        }
+    # Render the entities data for the chart
+    def calculate_method_data_points
+      @entities.each { |entity| entity.render_data(step_points) }
+    end
+
+    # Render dispatcher. Note to refactor a tinge later.
+    def render(type = :line)
+      calculate_method_data_points
+
+      create_chart_data_for(
+        case type
+        when :line then Gruff::Line.new
+        when :bar  then Gruff::Bar.new
+        end
+      ).write image_name
+    end
+
+    def create_chart_data_for(chart)
+      chart.tap { |g|
+        g.labels = all_labels
         g.theme = @theme
-        @entities.each { |entity| g.data entity.name.to_sym, entity.data_points }
-        g.x_axis_label = 'Times (n)'
+        g.x_axis_label = 'Times Run (n)'
         g.y_axis_label = 'Length (seconds)'
-      }.write image_name
+
+        @entities.each { |entity| g.data *entity.data }
+      }
     end
   end
 end

data/lib/benchpress/entity.rb

@@ -3,12 +3,25 @@ module Benchpress
     attr_reader :method, :name
     attr_accessor :data_points
 
-    # color - line color
-    # method - what are we benchmarking?
+    # Pass in the name of the entity as a symbol, and its method as a lambda
+    #
+    # Ex:
+    #   Benchpress::Entity.new(string: -> { 'string' })
+    #
+    # Warning: Direct instantiation has been deprecated, read the
     def initialize(opts = {})
-      @method = opts[:method]
-      @name   = opts[:name] || ''
+      raise 'Invalid formatting! Use "name: -> { method }"' unless opts.keys.length == 1
+      @name, @method = *opts.flatten
       @data_points = []
     end
+
+    def render_data(step_points)
+      @data_points.clear
+      step_points.each { |n| @data_points << Benchmark.measure { n.times { @method.call } }.real }
+    end
+
+    def data
+      [@name.to_s, @data_points]
+    end
   end
 end

data/lib/benchpress/version.rb

@@ -1,3 +1,3 @@
 module Benchpress
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchpress
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Brandon Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,7 +45,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -64,6 +64,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASE.md
 - Rakefile
 - benchpress.gemspec
 - lib/benchpress.rb
@@ -73,7 +74,7 @@ files:
 - lib/benchpress/version.rb
 homepage: https://github.com/baweaver/Benchpress
 licenses:
-- BSD
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -94,5 +95,5 @@ rubyforge_project:
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: Ruby Benchmark + Gruff to auto-gen charts
+summary: Ruby Benchmark + Gruff to auto-gen charts for method profiline
 test_files: []