baseline 0.1.0

data/README.md

@@ -0,0 +1,47 @@
+baseline
+===========
+
+(C) John Mair (banisterfiend) 2010
+
+_arrange benchmarks into contexts_
+
+* Install the [gem](https://rubygems.org/gems/baseline): `gem install baseline`
+* Read the [documentation](http://rdoc.info/github/banister/baseline/master/file/README.md)
+* See the [source code](http://github.com/banister/baseline)
+
+Features and limitations
+-------------------------
+
+* Arranges benchmarks into contexts
+
+Contact
+-------
+
+Problems or questions contact me at [github](http://github.com/banister)
+
+
+License
+-------
+
+(The MIT License) 
+
+Copyright (c) 2011 John Mair (banisterfiend)
+
+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,68 @@
+dlext = Config::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+PROJECT_NAME = "baseline"
+
+require 'rake/clean'
+require 'rake/gempackagetask'
+require "#{direc}/lib/#{PROJECT_NAME}/version"
+
+CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
+CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
+              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
+
+def apply_spec_defaults(s)
+  s.name = PROJECT_NAME
+  s.summary = "FIX ME"
+  s.version = Baseline::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.author = "John Mair (banisterfiend)"
+  s.email = 'jrmair@gmail.com'
+  s.description = s.summary
+  s.require_path = 'lib'
+  s.homepage = "http://banisterfiend.wordpress.com"
+  s.has_rdoc = 'yard'
+  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
+                     "test/*.rb", "HISTORY", "README.md", "Rakefile"]
+end
+
+desc "run tests"
+task :test do
+  sh "bacon -k #{direc}/test/test.rb"
+end
+
+namespace :ruby do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)        
+    s.platform = Gem::Platform::RUBY
+  end
+  
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+
+desc "build all platform gems at once"
+task :gems => [:clean, :rmgems, "ruby:gem"]
+
+desc "remove all platform gems"
+task :rmgems => ["ruby:clobber_package"]
+
+desc "build and push latest gems"
+task :pushgems => :gems do
+  chdir("#{direc}/pkg") do
+    Dir["*.gem"].each do |gemfile|
+      sh "gem push #{gemfile}"
+    end
+  end
+end
+              
+

data/lib/baseline.rb

@@ -0,0 +1,167 @@
+# (C) John Mair (banisterfiend) 2011
+# MIT License
+
+direc = File.dirname(__FILE__)
+
+require 'benchmark'
+require "#{direc}/baseline/output_format"
+
+module Baseline
+  TIME_MODE_DEFAULT = :total
+  REPEAT_DEFAULT = 1
+  
+  @time_mode = TIME_MODE_DEFAULT
+  @repeat = REPEAT_DEFAULT
+  @output_format = OutputFormat.new
+  
+  class << self
+    attr_accessor :time_mode, :output_format, :repeat
+  end
+
+  class BenchContext
+    attr_reader :total_time, :bench_count,
+    :subcontext_count, :repeat
+    
+    def initialize(repeat, nest_level, before, after)
+      @repeat = repeat
+      @total_time = 0
+      @nest_level = nest_level
+      @before = Array(before).dup
+      @after =  Array(after).dup
+      @results = {}
+      @bench_count = @subcontext_count = 0
+    end
+
+    def before(&block)
+      @before.push(block)
+    end
+
+    def after(&block)
+      @after.unshift(block)
+    end
+
+    def exec_hooks(hooks)
+      hooks.each do |b|
+        instance_eval(&b) 
+      end 
+    end
+
+    def wrap_with_hooks(options={}, &block)
+      exec_hooks(options[:before])
+      yield
+      exec_hooks(options[:after])
+    end
+
+    def time_mode
+      Baseline.time_mode
+    end
+
+    def output_format
+      Baseline.output_format
+    end
+
+    def exec_bench(name, new_repeat, &block)
+      repeat = new_repeat || @repeat
+      bm_block = proc { repeat.times { yield } }
+      
+      time = 0
+      wrap_with_hooks(:before => @before, :after => @after) do
+        time = Benchmark.measure(&bm_block).send(time_mode)
+        @total_time += time
+      end
+
+      @results[name] = time
+      @bench_count += 1
+      
+      [name, time, new_repeat, :with_own_block]
+    end
+
+    def show(bench_data, &block)
+      case bench_data.last
+      when :without_own_block
+        name, new_repeat  = bench_data
+        show exec_bench(name, new_repeat, &block)
+      when :with_own_block
+        name, time, new_repeat = bench_data
+        output_format.bench_output(name, time, new_repeat, @repeat, @nest_level)
+      end
+    end
+    
+    def bench(name, options={},  &block)
+      
+      # if no block then assume block is provided by show method and
+      # pass along requisite data so show can do its thing
+      if !block_given?
+        [name, options[:repeat], :without_own_block]
+      else
+        exec_bench(name, options[:repeat], &block)
+      end
+    end
+
+    def context(name, options={}, &block)
+      return output_format.context_skip(name) if options[:skip]
+      
+      repeat = options[:repeat] || @repeat
+      
+      bc = BenchContext.new(repeat, @nest_level + 1, @before, @after)
+      bench_count = subcontext_count = 0
+      output_format.context_output_header(name, options[:repeat], @repeat, @nest_level)
+      
+      @total_time += time = bc.tap do |v|
+        v.instance_eval(&block)
+        bench_count = v.bench_count
+        subcontext_count = v.subcontext_count
+      end.
+        total_time
+
+      output_format.context_output_footer(name, time, bench_count, subcontext_count, @nest_level)
+      @results[name] = time
+      @subcontext_count += 1
+      @total_time
+    end
+
+    def compare(bench1, bench2)
+      benches = [bench1, bench2]
+      winner, loser = benches.sort_by! { |v| @results[v] }
+      time_diff = @results[loser] - @results[winner]
+      time_ratio = @results[loser] / @results[winner].to_f
+
+      output_format.compare_output(winner, loser, time_diff, time_ratio, @nest_level)
+    end
+  
+    def rank(*names)
+      ranking = names.sort_by! { |v| @results[v] }
+      output_format.rank_output(ranking, @nest_level)
+    end
+end
+
+  module ObjectExtensions
+    private
+    def context(name, options={}, &block)
+      return output_format.top_level_context_skip(name) if options[:skip]
+      
+      repeat = options[:repeat] || Baseline.repeat
+      time_mode = Baseline.time_mode
+      output_format = Baseline.output_format
+
+      output_format.top_level_context_output_header(name, options[:repeat], Baseline.repeat, 0)
+      bench_count = subcontext_count = 0
+      
+      top_level_context_time = Baseline::BenchContext.new(repeat, 1, nil, nil).
+        tap do |v|
+        v.instance_eval(&block)
+        bench_count = v.bench_count
+        subcontext_count = v.subcontext_count
+      end.
+        total_time
+
+      output_format.context_output_footer(name, top_level_context_time, bench_count, subcontext_count, 0)
+
+      top_level_context_time
+    end
+  end
+end
+
+class Object
+  include Baseline::ObjectExtensions
+end

data/lib/baseline/output_format.rb

@@ -0,0 +1,58 @@
+module Baseline
+  class OutputFormat
+    def indenter(nest_level)
+      " " * 2 * nest_level
+    end
+    
+    def bench_output(name, time, new_repeat, orig_repeat, nest_level)
+      repeat = new_repeat || orig_repeat
+      repeat_text = new_repeat ? "(repeat: #{repeat})" : ""
+      puts "#{indenter(nest_level)}#{name}: %0.2f seconds #{repeat_text}" % time
+    end
+    
+    def context_output_header(name, new_repeat, orig_repeat,  nest_level)
+      repeat = new_repeat || orig_repeat
+      repeat_text = new_repeat ? "(repeat: #{repeat})" : ""
+      puts "#{indenter(nest_level)}"
+      puts "#{indenter(nest_level)}Benching #{name}: #{repeat_text}"
+    end
+    
+    def context_output_footer(name, time, bench_count, subcontext_count, nest_level)
+      puts "#{indenter(nest_level)}Total time: %0.2f seconds for #{name} " \
+      "[#{bench_count} benches and #{subcontext_count} subcontexts]" % time
+      puts "#{indenter(nest_level)}"
+    end
+
+    def context_skip(name)
+      puts "[Skipping #{name}]"
+    end
+
+    def top_level_context_skip(name)
+      puts "All Benchmarks disabled."
+    end
+
+    def top_level_context_output_header(name, new_repeat, orig_repeat, nest_level)
+      repeat = new_repeat || orig_repeat
+      time_mode = Baseline.time_mode
+      time_mode_text = time_mode != Baseline::TIME_MODE_DEFAULT ? "(time mode: #{time_mode})" : ""
+
+      repeat_text = new_repeat ? "(repeat: #{repeat})" : ""
+      puts "#{indenter(nest_level)}"
+      puts "#{indenter(nest_level)}Benching #{name}: #{repeat_text} #{time_mode_text}"      
+    end
+
+    def rank_output(ranking, nest_level)
+      quoted_ranking = ranking.map.with_index { |v, i| "#{i + 1}. \"#{v}\"" }.join(", ")
+      puts "#{indenter(nest_level)}Rankings: #{quoted_ranking}"
+    end
+
+    def compare_output(winner, loser, time_diff, time_ratio, nest_level)
+      if time_diff != 0
+        puts "#{indenter(nest_level)}Comparison: \"#{winner}\" is faster than \"#{loser}\"" \
+        " by %0.2f seconds (%0.2f times faster)" % [time_diff, time_ratio]
+      else
+        puts "#{indenter(nest_level)}Comparison: \"#{winner}\" is the same speed as \"#{loser}\"" 
+      end
+    end
+  end
+end

data/lib/baseline/version.rb

@@ -0,0 +1,3 @@
+module Baseline
+  VERSION = "0.1.0"
+end     

data/test/test.rb

@@ -0,0 +1,12 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/baseline"
+require 'bacon'
+
+puts "Testing baseline version #{Baseline::VERSION}..." 
+puts "Ruby version: #{RUBY_VERSION}"
+
+describe Baseline do
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: baseline
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Mair (banisterfiend)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-30 00:00:00 +13:00
+default_executable: 
+dependencies: []
+
+description: FIX ME
+email: jrmair@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/baseline/output_format.rb
+- lib/baseline/version.rb
+- lib/baseline.rb
+- test/test.rb
+- HISTORY
+- README.md
+- Rakefile
+has_rdoc: yard
+homepage: http://banisterfiend.wordpress.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: FIX ME
+test_files: []
+