simple-benchmark 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1aebdb166875ed2fa9e2268bb849394d0133e861
+  data.tar.gz: 38557edfbb82cec26453b87c0ac64f5be1ccb41c
+SHA512:
+  metadata.gz: 4109d128a70c0e07bfe7436e17a8800e2cabdb6ea4f6f0275c380d579a43e1faa74ea0378a7738aa2bc885aaf41553d48a4ed9fe7a07e19522ad97f277aee9fd
+  data.tar.gz: 00be7e7fd2260e14e6f20fd58034443b1f00a9a0f0a760980d209e8bdf042b82b93065ca0ec1e427bf1d8233b31854ca16b7edef6bd3290eae56485b611c0397

data/lib/simple-benchmark.rb

@@ -0,0 +1 @@
+require 'simple_benchmark'

data/lib/simple_benchmark.rb

@@ -0,0 +1,48 @@
+require 'benchmark'
+require 'logger'
+
+require 'simple_benchmark/version'
+
+class SimpleBenchmark
+  autoload :Helper, 'simple_benchmark/helper'
+  
+  class << self
+    attr_writer :logger, :enabled
+  end
+
+  self.enabled = true
+
+  def self.logger
+    @logger ||= default_logger
+  end
+  
+  def self.enabled?
+    @enabled == true
+  end
+
+  def initialize(description, logger = nil)
+    @description = description
+    @logger      = logger
+  end
+
+  def run(&block)
+    result = nil
+    report = Benchmark.measure do
+      result = block.call
+    end
+
+    logger.info("#{@description}: #{report.real} second(s)")
+    result
+  end
+  
+  private
+  
+  def self.default_logger
+    defined?(Rails) ? Rails.logger : Logger.new('benchmark.log')
+  end
+  
+  def logger
+    @logger ||= self.class.logger
+  end
+  
+end

data/lib/simple_benchmark/helper.rb

@@ -0,0 +1,12 @@
+class SimpleBenchmark
+  module Helper
+    def log_execution_for(description, options = {}, &block)
+      if SimpleBenchmark.enabled?
+        benchmark = SimpleBenchmark.new(description, options[:logger])
+        benchmark.run(&block)
+      else
+        block.call
+      end
+    end
+  end
+end

data/lib/simple_benchmark/version.rb

@@ -0,0 +1,3 @@
+class SimpleBenchmark
+  VERSION = "1.0.0"
+end

data/spec/simple_benchmark/helper_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+class Example
+  include SimpleBenchmark::Helper
+  
+  def do_a_thing
+    log_execution_for('something') do
+      sleep(0.1)
+      'done'
+    end
+  end
+  
+  def do_a_thing_with_another_logger(logger)
+    log_execution_for('something else', :logger => logger) do
+      'done'
+    end
+  end
+end
+
+describe SimpleBenchmark::Helper do
+  describe "#log_execution_for" do
+    let(:benchmarker) { double(:benchmarker) }
+    
+    subject { Example.new }
+    
+    it "logs execution for the code block" do
+      benchmarker.should_receive(:run)
+      
+      SimpleBenchmark.stub(:new).with('something', nil).and_return(benchmarker)
+      
+      subject.do_a_thing
+    end
+    
+    it "returns the value of the block" do
+      subject.do_a_thing.should == 'done'
+    end
+    
+    it "passes in a custom logger" do
+      benchmarker.stub(:run)
+      logger = 'logger'
+      
+      SimpleBenchmark.should_receive(:new).with('something else', 'logger').and_return(benchmarker)
+      
+      subject.do_a_thing_with_another_logger('logger')
+    end
+    
+    context "when benchmarking is disabled" do
+      before { SimpleBenchmark.enabled = false }
+      after  { SimpleBenchmark.enabled = true  }
+    
+      it "does not log execution" do
+        SimpleBenchmark.should_receive(:new).never
+      
+        subject.do_a_thing
+      end
+      it "returns the value of the block" do
+        subject.do_a_thing.should == 'done'
+      end
+    end
+  end
+end

data/spec/simple_benchmark_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe SimpleBenchmark do
+  def remove_log_files(*names)
+    names.each {|n| FileUtils.rm_f(n) }
+  end
+  
+  def log_lines(filename)
+    File.read(filename).split(/\n+/)
+  end
+  
+  def reset_global_logger
+    described_class.instance_variable_set(:@logger, nil)
+  end
+    
+  
+  describe ".enabled?" do
+    it "is true by default" do
+      described_class.enabled?.should be(true)
+    end
+    
+    it "is false when set to false" do
+      described_class.enabled = false
+      described_class.enabled?.should be(false)
+    end
+  end
+  
+  describe ".logger" do
+    before { reset_global_logger }
+    after  { reset_global_logger }
+    
+    it "uses a default file" do
+      Logger.stub(:new).with('benchmark.log').and_return('logger')
+      described_class.logger.should == 'logger'
+    end
+    
+    it "uses the Rails logger if available" do
+      Rails = Class.new { def self.logger; 'rails logger'; end }
+      
+      described_class.logger.should == 'rails logger'
+      
+      Object.send(:remove_const, :Rails)
+    end
+    
+    it "uses the user-provided logger" do
+      described_class.logger = 'logger'
+      described_class.logger.should == 'logger'
+    end
+  end
+  
+  describe "#run" do
+    let(:log_files) { %w(benchmark.log alternate.log) }
+    
+    before { remove_log_files(*log_files) }
+    after  { remove_log_files(*log_files) }
+    
+    let(:loggable) { lambda { 'done' } }
+    
+    it "logs the response time" do
+      subject  = described_class.new('code')
+      subject.run { sleep(0.1) }
+      
+      lines = log_lines('benchmark.log')
+
+      lines.length.should == 2
+      lines.last.should match(/code:\s+\d+\.\d+\s+second\(s\)/)
+    end
+    
+    it "returns the value of the original block" do
+      subject = described_class.new('code')
+      subject.run { 'done' }.should == 'done'
+    end
+    
+    it "uses an alternate logger when requested" do
+      logger  = Logger.new('alternate.log')
+      subject = described_class.new('alternate', logger)
+
+      expect { subject.run { 'done' } }.to change { log_lines('alternate.log').length }.by(1)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'simple_benchmark'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: simple-benchmark
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Patrick Reagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: 
+email:
+- reaganpr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/simple-benchmark.rb
+- lib/simple_benchmark/helper.rb
+- lib/simple_benchmark/version.rb
+- lib/simple_benchmark.rb
+- spec/simple_benchmark/helper_spec.rb
+- spec/simple_benchmark_spec.rb
+- spec/spec_helper.rb
+homepage: http://viget.com/extend
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A simple benchmarking tool for Ruby apps.
+test_files:
+- spec/simple_benchmark/helper_spec.rb
+- spec/simple_benchmark_spec.rb
+- spec/spec_helper.rb