bixby-bench 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddb5ddd19287c016ab80556daecb287bbb89bfe9
+  data.tar.gz: c872f84980204c7f93c3b7af836427486c07edbf
+SHA512:
+  metadata.gz: f48055b85cc14e416c590fc3d73795b9538816f499c6180af1d47f28ca15f81ac9cdd389a8740d34afbacb1f6a863d121377e8c0040e2e89d8a98d9b15004f97
+  data.tar.gz: d997e91901da5e10556b90c5a325df1fde6c805d13109601676be5435bf3a7c349b2999b046edc5ab6b67826d208ee11083c52e43dca753517e1b35a791e0ebe

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "allocation_stats"
+
+group :development do
+  gem "yard", "~> 0.7"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    allocation_stats (0.1.5)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.1)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    thread_safe (0.3.4)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  allocation_stats
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Chetan Sarva
+
+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/README.md

@@ -0,0 +1,38 @@
+# bixby-bench
+
+A simple wrapper around the stdlib Benchmark with allocation tracing mixed in
+
+## Installation and Usage
+
+```bash
+gem install bixby-bench
+```
+
+Usage is very similar to `Benchmark.bm`:
+
+```ruby
+Bixby::Bench.run(10_000) do |b| # 10,000 = number of sample runs
+  b.sample('test_method') do
+    Test.method()
+  end
+  b.divider
+  b.sample('test_method2') do
+    Test.method2()
+  end
+end
+```
+
+## Contributing to bixby-bench
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Chetan Sarva. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "bixby-bench"
+  gem.homepage = "http://github.com/chetan/bixby-bench"
+  gem.license = "MIT"
+  gem.summary = %Q{Benchmarking utilities}
+  gem.description = %Q{Simple benchmarking utilities that just work, right out of the box}
+  gem.email = "chetan@pixelcop.net"
+  gem.authors = ["Chetan Sarva"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bixby-bench.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: bixby-bench 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "bixby-bench"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Chetan Sarva"]
+  s.date = "2014-11-07"
+  s.description = "Simple benchmarking utilities that just work, right out of the box"
+  s.email = "chetan@pixelcop.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bixby-bench.gemspec",
+    "lib/bixby-bench.rb",
+    "lib/bixby/bench.rb",
+    "lib/bixby/bench/divider.rb",
+    "lib/bixby/bench/report.rb",
+    "lib/bixby/bench/sample.rb"
+  ]
+  s.homepage = "http://github.com/chetan/bixby-bench"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.2"
+  s.summary = "Benchmarking utilities"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<allocation_stats>, [">= 0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<allocation_stats>, [">= 0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<allocation_stats>, [">= 0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+  end
+end
+

data/lib/bixby-bench.rb

@@ -0,0 +1,2 @@
+
+require "bixby/bench"

data/lib/bixby/bench.rb

@@ -0,0 +1,87 @@
+
+require "benchmark"
+require "allocation_stats"
+
+require "bixby/bench/divider"
+require "bixby/bench/sample"
+require "bixby/bench/report"
+
+module Bixby
+  class Bench
+
+    def self.run(sample_size, memory=true)
+      bench = Bench.new(sample_size, memory)
+      yield(bench)
+
+      # now that we have all samples, run the thing
+      sync_stdout { bench.run_all }
+
+      bench
+    end
+
+    def self.sync_stdout
+      begin
+        old_sync = STDOUT.sync
+        STDOUT.sync = true
+        yield
+      ensure
+        STDOUT.sync = old_sync unless old_sync.nil?
+      end
+    end
+
+    def initialize(sample_size, memory=true)
+      @sample_size = sample_size
+      @memory = memory
+      @samples = []
+    end
+
+    def sample(label, &block)
+      @samples << Sample.new(label, block, @sample_size, @memory)
+    end
+    alias_method :report, :sample
+
+    def divider
+      @samples << Divider.new
+    end
+    alias_method :add_divider, :divider
+
+    def label_width
+      if !@label_width then
+        @label_width = @samples.find_all{ |s| Sample === s }.
+                          max{ |a, b| a.label.length <=> b.label.length }.
+                          label.length + 1
+
+        @label_width = 40 if @label_width < 40
+      end
+
+      return @label_width
+    end
+
+    def divider_width
+      @divider_width ||= (label_width + (@memory ? 75 : 45))
+    end
+
+    def print_header
+      caption = Benchmark::CAPTION
+      if @memory then
+        caption = caption.gsub(/\n$/, '') + "       allocations      memsize\n"
+      end
+      print ' '*label_width + caption
+    end
+
+    def run_all
+      print_header
+
+      @samples.each do |sample|
+        if Divider === sample then
+          sample.print(divider_width)
+          next
+        end
+
+        print sample.label.ljust(label_width)
+        sample.measure.print
+      end
+    end
+
+  end
+end

data/lib/bixby/bench/divider.rb

@@ -0,0 +1,10 @@
+
+module Bixby
+  class Bench
+    class Divider
+      def print(width)
+        puts '-'*width
+      end
+    end
+  end
+end

data/lib/bixby/bench/report.rb

@@ -0,0 +1,19 @@
+
+module Bixby
+  class Bench
+    class Report
+      attr_accessor :tms, :allocation_stats
+
+      def print
+        if @allocation_stats then
+          format = Benchmark::FORMAT.gsub(/\n$/, '') + " %16d %12d\n"
+          allocations = allocation_stats.allocations.all.size
+          memsize = allocation_stats.allocations.bytes.to_a.inject(&:+)
+          puts @tms.format(format, allocations, memsize)
+        else
+          puts @tms
+        end
+      end
+    end
+  end
+end

data/lib/bixby/bench/sample.rb

@@ -0,0 +1,32 @@
+
+module Bixby
+  class Bench
+    class Sample
+
+      attr_reader :label, :block
+
+      def initialize(label, block, sample_size, memory)
+        @label       = label
+        @block       = block
+        @sample_size = sample_size
+        @memory      = memory
+      end
+
+      def call
+        @block.call
+      end
+
+      def measure
+        report = Report.new
+        report.tms = Benchmark.measure { @sample_size.times { self.call } }
+
+        if @memory then
+          report.allocation_stats = AllocationStats.new(burn: 5).trace { self.call }
+        end
+
+        return report
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: bixby-bench
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chetan Sarva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: allocation_stats
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Simple benchmarking utilities that just work, right out of the box
+email: chetan@pixelcop.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bixby-bench.gemspec
+- lib/bixby-bench.rb
+- lib/bixby/bench.rb
+- lib/bixby/bench/divider.rb
+- lib/bixby/bench/report.rb
+- lib/bixby/bench/sample.rb
+homepage: http://github.com/chetan/bixby-bench
+licenses:
+- MIT
+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.2
+signing_key: 
+specification_version: 4
+summary: Benchmarking utilities
+test_files: []