benchpress 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38edc94e8271789d69bf667ddd3b7ee3f50694c4
-  data.tar.gz: 5c5814779e8c63a1c664216033945d21c2e914ed
+  metadata.gz: 1216b498d6b488f9dcf0f151afcd6311cbd85b2d
+  data.tar.gz: e3562fd92362931090207aadbb62f4e653bbfc2a
 SHA512:
-  metadata.gz: 166dd6357b3d57e2a803ae4c348d9482fd10e18f329da92ef025e5f14bfbd75ed0a6576903b6a053a9d8028d0b08fe0bea243bdb480379b3ce1f1081e78d90b8
-  data.tar.gz: 55c0ea8a9f44679627c9c8636dfb89fd7cd680fd57f662fc3848688372ba45e9e8efadd39b0566a0e10291be3b300aad70f90337a629e2c447e851377fd5d4d7
+  metadata.gz: ba6098bad45a269fdb1820fe318fc6b9a74d1f78ebf879d304aa5ddb426137ddebc31e872f6ae6e1fef0d57c30fb37b6951502a7f5ee33b63c02dd20db2075bb
+  data.tar.gz: 0d4beb74448cdb36ea4a6b51830fd66cf7c8a046aa3af3ce9cd5fa7058bdf2f3d996553592489e97b68d477f32dcaadf9a45cd434790980fa2329b13747e3fec

data/.gitignore

@@ -1,3 +1,5 @@
+*.png
+*.json
 *.gem
 *.rbc
 .bundle

data/README.md

@@ -1,6 +1,8 @@
 Benchpress
 ==========
 
+[![Code Climate](https://codeclimate.com/github/baweaver/Benchpress.png)](https://codeclimate.com/github/baweaver/Benchpress)
+
 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.
@@ -15,9 +17,10 @@ c = Benchpress::Chart.new(
     string: -> { 'string' },
     symbol: -> { :symbol  }
   },
-  min: 10_000,               # Minimum times to run. Default: 0
+  min: 50_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
+  step: 10_000,              # Step rate for next benchmark. Default: 250
+  cycles: 3,                 # How many times to repeat, so as to get an average. Default: 1
   name: 'string_vs_symbol',  # File name. Default: 'Time.now.strftime '%Y-%m-%d-%H:%M:%S''
   format: 'png'              # File format. Default: png
 )
@@ -31,6 +34,27 @@ c.render :line # Line chart
 c.render :bar  # Bar chart
 ```
 
-![](new pic url)
+![](http://i42.tinypic.com/24oc0mo.png)
+
+![](http://i42.tinypic.com/2uj2xio.png)
 
 Voila! Instant chart with realtime benchmarks to demonstrate complexities of methods everywhere! Supports an arbitrary number of entities.
+
+Want something a tinge more beefy and realistic? How about parsing 9 megs of JSON?
+
+```ruby
+c = Benchpress::Chart.new(
+  entities: {
+    oj: -> { Oj.load json },
+    json: -> { JSON.load json}
+  },
+  max: 10,
+  step: 2,
+  name: '9m-json-bar'
+)
+
+c.render :bar
+
+```
+
+![](http://i40.tinypic.com/v4xpwg.png)

data/RELEASE.md

@@ -15,3 +15,7 @@ Initial release
 * Increase in rendering options
   * Can now render bar charts.
 * More efficient stepping algorithm, decreases runtime.
+
+# v1.1.0
+
+* Added Cycling, for more steady data

data/benchpress.gemspec

@@ -20,5 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
   spec.add_runtime_dependency "gruff"
 end

data/lib/benchpress/chart.rb

@@ -1,5 +1,3 @@
-require 'pry'
-
 module Benchpress
   class Chart
 
@@ -11,26 +9,24 @@ module Benchpress
     # theme    - theme of the chart
     # entities - data methods to run against
     def initialize(opts = {})
+      @cycles   = opts[:cycles] || 1
       @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
+      @step     = opts[:step]   || 250
       @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) }
+    # Render dispatcher. Note to refactor a tinge later.
+    def render(type = :line)
+      create_chart_data_for(
+        case type
+        when :line then Gruff::Line.new
+        when :bar  then Gruff::Bar.new
+        end
+      ).write image_name
     end
 
     # file_name.ext
@@ -46,34 +42,31 @@ module Benchpress
     # Caveat - If the max % step != 0, it will not render to the max. This is intended behavior.
     def step_points
       raise 'Cannot have larger step than max' if @step > @max
+
       @step_points ||= ((@min / @step)..(@max / @step)).reduce([]) { |steps, i| steps << @step * i }
     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
+    private
 
     # Get labels for every point
     def all_labels
       step_points.each_with_index.reduce({}) { |hash, (val, index)| hash.merge!({ index => val.to_s }) }
     end
 
-    # 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
+    # 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
 
-      create_chart_data_for(
-        case type
-        when :line then Gruff::Line.new
-        when :bar  then Gruff::Bar.new
-        end
-      ).write image_name
+      @entities = entities.reduce([]) { |ary, (name, method)| 
+        ary << Entity.new(step_points, @cycles, name => method) 
+      }
     end
 
     def create_chart_data_for(chart)

data/lib/benchpress/entity.rb

@@ -9,19 +9,33 @@ module Benchpress
     #   Benchpress::Entity.new(string: -> { 'string' })
     #
     # Warning: Direct instantiation has been deprecated, read the
-    def initialize(opts = {})
+    def initialize(steps, cycles, opts = {})
       raise 'Invalid formatting! Use "name: -> { method }"' unless opts.keys.length == 1
+      @cycles        = cycles
+      @steps         = steps
       @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 }
+    def data
+      [@name.to_s, flatten_data(cycle_data)]
     end
 
-    def data
-      [@name.to_s, @data_points]
+    private
+
+    def cycle_data
+      @cycles.times.reduce([]) { |table, _| table << measure_realtime }
     end
+
+    def measure_realtime
+      @steps.reduce([]) { |data, n| data << Benchmark.measure { n.times { @method.call } }.real }
+    end
+
+    def flatten_data(table)
+      if table.length == 1
+        table.flatten
+      else
+        table.transpose.reduce([]) { |ary, data| ary << (data.reduce(:+) / data.length) }
+      end
+    end 
   end
 end

data/lib/benchpress/version.rb

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

data/spec/chart_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+chart = Benchpress::Chart.new(
+  entities: {
+    string: -> { 'string' },
+    symbol: -> { :symbol  }
+  },
+  min: 50_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
+)
+
+step_points = [50000, 60000, 70000, 80000, 90000, 100000]
+
+describe 'Benchpress::Chart' do
+  describe '#image_name' do
+    it 'will return a file name' do
+      expect(chart.image_name).to eq('string_vs_symbol.png')
+    end
+  end
+
+  describe '#step_points' do
+    it 'will return an array of step points' do
+      expect(chart.step_points).to eq(step_points)
+    end
+  end
+end

data/spec/entity_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+
+# No need for let or ivar if I don't intend to mutate.
+step_points   = [1,2,3,4]
+cycled_entity = Benchpress::Entity.new(step_points, 3, string: -> {'s'})
+entity        = Benchpress::Entity.new(step_points, 1, string: -> {'s'})
+
+describe 'Benchpress::Entity' do
+  describe '#data' do
+    it 'returns an array with the method name and data points' do
+      name, data = entity.data
+
+      expect(name).to eq('string')
+      expect(data.length).to eq(4)
+    end
+
+    it 'does the same for a cycled entity' do
+      name, data = cycled_entity.data
+
+      expect(name).to eq('string')
+      expect(data.length).to eq(4)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'benchpress'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchpress
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brandon Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gruff
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +86,9 @@ files:
 - lib/benchpress/entity.rb
 - lib/benchpress/themes.rb
 - lib/benchpress/version.rb
+- spec/chart_spec.rb
+- spec/entity_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/baweaver/Benchpress
 licenses:
 - MIT
@@ -92,8 +109,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby Benchmark + Gruff to auto-gen charts for method profiline
-test_files: []
+test_files:
+- spec/chart_spec.rb
+- spec/entity_spec.rb
+- spec/spec_helper.rb