diffbench 0.1.1 → 0.2.0

data/Gemfile

@@ -1,11 +1,10 @@
 source "http://rubygems.org"
 
 gem "git"
+gem "rainbow"
 group :development do
   gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
-  gem "cucumber", ">= 0"
   gem "bundler", "~> 1.1.0"
   gem "jeweler", "~> 1.8.3"
-  gem "rcov", ">= 0"
+  gem "debugger"
 end

data/README.md

@@ -1,15 +1,20 @@
 # Diffbench
 
-Diffbench is tool the I end up during many many performance patches to:
+Diffbench is a tool I end up during many performance patches to:
 
 * Rails
   * ActiveRecord - [#5467](https://github.com/rails/rails/pull/5467)
   * ActiveModel - [#5431](https://github.com/rails/rails/pull/5431)
   * ActiveSupport - [#4493](https://github.com/rails/rails/pull/4493)
+  * ActionPack - [#5957](https://github.com/rails/rails/pull/5957)
 * Mail - [#396](https://github.com/mikel/mail/pull/369), [#366](https://github.com/mikel/mail/pull/366)
 
 It runs a same benchmark code before and after applying a patch.
 
+## Requirements
+
+* Git
+
 ## Installation
 
 ``` sh
@@ -76,3 +81,10 @@ Before patch:   0.000000   0.000000   0.000000 (  0.002354)
 ```
 
 
+## Self-Promotion
+
+Like diffbench?
+
+Follow the [repository on GitHub](https://github.com/bogdan/diffbench).
+
+Read [author blog](http://gusiev.com).

data/Rakefile

@@ -37,17 +37,6 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-require 'cucumber/rake/task'
-Cucumber::Rake::Task.new(:features)
 
 task :default => :spec
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "diffbench #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/diffbench.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "diffbench"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2012-03-27"
+  s.date = "2012-05-22"
   s.description = "Diffbench is gem designed to benchmark the performance patches. It can run specified benchmark file before and after some changes made and show performance comparation result"
   s.email = "agresso@gmail.com"
   s.executables = ["diffbench"]
@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -33,6 +32,8 @@ Gem::Specification.new do |s|
     "features/support/env.rb",
     "lib/diff_bench.rb",
     "lib/diffbench.rb",
+    "lib/diffbench/bm.rb",
+    "lib/diffbench/encoder.rb",
     "spec/bench.rb",
     "spec/code.rb",
     "spec/diffbench_spec.rb",
@@ -41,7 +42,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/bogdan/diffbench"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.11"
   s.summary = "Benchmark your before and after some changes made"
 
   if s.respond_to? :specification_version then
@@ -49,29 +50,26 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<git>, [">= 0"])
+      s.add_runtime_dependency(%q<rainbow>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<debugger>, [">= 0"])
     else
       s.add_dependency(%q<git>, [">= 0"])
+      s.add_dependency(%q<rainbow>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<cucumber>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<debugger>, [">= 0"])
     end
   else
     s.add_dependency(%q<git>, [">= 0"])
+    s.add_dependency(%q<rainbow>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<cucumber>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<debugger>, [">= 0"])
   end
 end
 

data/lib/diffbench/bm.rb

@@ -0,0 +1,20 @@
+class DiffBench
+  class Bm
+    def initialize(&block)
+      @measures = {}
+      if block.arity == -1 || block.arity > 0
+        block.call(self)
+      else
+        instance_eval(&block)
+      end
+
+      print Encoder.encode(@measures)
+    end
+
+    def report(label)
+      @measures[label] = Benchmark.measure do
+        yield
+      end
+    end
+  end
+end

data/lib/diffbench/encoder.rb

@@ -0,0 +1,13 @@
+class DiffBench
+  class Encoder
+    class << self
+      def encode(object)
+        "diffbench:#{Base64.encode64(object.to_yaml).gsub!("\n", "")}"
+      end
+
+      def decode(string)
+        YAML.load(Base64.decode64(string.split(":").last))
+      end
+    end
+  end
+end

data/lib/diffbench.rb

@@ -2,10 +2,15 @@ require "yaml"
 require "benchmark"
 require "git"
 require "base64"
+require "rainbow"
+require "diffbench/encoder"
+require "diffbench/bm"
 
 class DiffBench
 
   class Runner
+    COLORS = {red: 31, green: 32}
+
     def initialize(file, *args)
       @file = file
       unless @file
@@ -14,39 +19,69 @@ class DiffBench
     end
 
     def run
-      puts "Running benchmark with current working tree"
+      output "Running benchmark with current working tree"
       first_run = run_file
       if tree_dirty?
-        puts "Stashing changes"
+        output "Stashing changes"
         git_run "stash"
-        puts "Running benchmark with clean working tree"
+        output "Running benchmark with clean working tree"
         begin
           second_run = run_file
         ensure
-          puts "Applying stashed changes back"
+          output "Applying stashed changes back"
           git_run "stash pop"
         end
       elsif branch = current_head
-        puts "Checkout HEAD^"
+        output "Checkout HEAD^"
         git_run "checkout 'HEAD^'"
-        puts "Running benchmark with HEAD^"
+        output "Running benchmark with HEAD^"
         begin
           second_run = run_file
         ensure
-          puts "Checkout to previous HEAD again"
+          output "Checkout to previous HEAD again"
           git_run "checkout #{branch}"
         end
       else
         raise Error, "No current branch."
       end
-      puts ""
+      output ""
       caption = "Before patch: ".gsub(/./, " ") +  Benchmark::Tms::CAPTION
-      puts caption
+      output caption
       first_run.keys.each do |test|
-        puts ("-"* (caption.size - test.size)) + test
-        puts "After patch:  #{first_run[test].format}"
-        puts "Before patch: #{second_run[test].format}"
-        puts ""
+        output ("-"* (caption.size - test.size)) + test
+        before_patch = second_run[test]
+        after_patch = first_run[test]
+        improvement = improvement_percentage(before_patch, after_patch)
+        color_string = result_color(improvement)
+        output "After patch:  #{after_patch.format}"
+        output "Before patch: #{before_patch.format}"
+        if color_string
+          output self.class.color("Improvement: #{improvement}%", color_string).strip
+        end
+        output ""
+      end
+    end
+
+    def improvement_percentage(before_patch, after_patch)
+      (((before_patch.real - after_patch.real).to_f / before_patch.real) * 100).round
+    end
+
+    def self.color(text, color_string)
+      code = COLORS[color_string]
+      self.color_enabled? ? "\e[#{code}m#{text}\e[0m" : text
+    end
+    
+    def self.color_enabled?
+      true
+    end
+
+    protected
+
+    def result_color(improvement)
+      if (-5..5).include?(improvement)
+        nil
+      else
+        improvement > 0 ? :green : :red
       end
     end
 
@@ -66,7 +101,7 @@ class DiffBench
         if line.start_with?("diffbench:")
           true
         else
-          puts line
+          output line
         end
       end
       if $?.to_i > 0
@@ -105,6 +140,10 @@ class DiffBench
       status = git.status
       status.deleted.any? || status.changed.any?
     end
+
+    def output(string)
+      puts string
+    end
   end
 
   class << self
@@ -118,37 +157,6 @@ class DiffBench
 
   end
 
-  class Bm
-    def initialize(&block)
-      @measures = {}
-      if block.arity == -1 || block.arity > 0
-        block.call(self)
-      else
-        instance_eval(&block)
-      end
-
-      print Encoder.encode(@measures)
-    end
-
-
-
-    def report(label)
-      @measures[label] = Benchmark.measure do
-        yield
-      end
-    end
-  end
-
-  class Encoder
-    class << self
-      def encode(object)
-        "diffbench:#{Base64.encode64(object.to_yaml).gsub!("\n", "")}"
-      end
 
-      def decode(string)
-        YAML.load(Base64.decode64(string.split(":").last))
-      end
-    end
-  end
   class Error < StandardError; end
 end

data/spec/diffbench_spec.rb

@@ -2,6 +2,11 @@ require 'spec_helper'
 require "fileutils"
 
 describe DiffBench do
+
+  def to_regexp(output)
+    Regexp.compile(Regexp.escape(output).gsub("NUM", "[0-9]+")) 
+  end
+
   let(:repo) do
     "#{File.dirname(__FILE__)}/repo"
   end
@@ -26,7 +31,28 @@ describe DiffBench do
     end
 
     it "should run benchmark with dirty tree and clean tree" do
-      puts `cd #{repo}; ./../../bin/diffbench bench.rb`
+      output =  `cd #{repo}; ./../../bin/diffbench bench.rb`
+      output.should =~ to_regexp(<<-OUT)
+Running benchmark with current working tree
+--> Sleeping
+--> Sleeping
+Stashing changes
+Running benchmark with clean working tree
+--> Sleeping
+--> Sleeping
+Applying stashed changes back
+
+                    user     system      total        real
+--------------------------------------------------Sleeper 1
+After patch:    0.000000   0.000000   0.000000 (  0.100NUM)
+Before patch:   0.000000   0.000000   0.000000 (  0.200NUM)
+#{DiffBench::Runner.color("Improvement: 50%", :green)}
+
+--------------------------------------------------Sleeper 2
+After patch:    0.000000   0.000000   0.000000 (  0.100NUM)
+Before patch:   0.000000   0.000000   0.000000 (  0.200NUM)
+#{DiffBench::Runner.color("Improvement: 50%", :green)}
+OUT
     end
 
     describe "when changes got commit" do
@@ -37,7 +63,28 @@ describe DiffBench do
       end
 
       it "should run benchmark with HEAD and HEAD^" do
-        puts `cd #{repo}; ./../../bin/diffbench bench.rb`
+        output = `cd #{repo}; ./../../bin/diffbench bench.rb`
+        output.should =~ to_regexp(<<-OUT)
+Running benchmark with current working tree
+--> Sleeping
+--> Sleeping
+Checkout HEAD^
+Running benchmark with HEAD^
+--> Sleeping
+--> Sleeping
+Checkout to previous HEAD again
+
+                    user     system      total        real
+--------------------------------------------------Sleeper 1
+After patch:    0.000000   0.000000   0.000000 (  0.100NUM)
+Before patch:   0.000000   0.000000   0.000000 (  0.200NUM)
+#{DiffBench::Runner.color("Improvement: 50%", :green)}
+
+--------------------------------------------------Sleeper 2
+After patch:    0.000000   0.000000   0.000000 (  0.100NUM)
+Before patch:   0.000000   0.000000   0.000000 (  0.200NUM)
+#{DiffBench::Runner.color("Improvement: 50%", :green)}
+OUT
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffbench
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-27 00:00:00.000000000 Z
+date: 2012-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &8469000 !ruby/object:Gem::Requirement
+  requirement: &16634260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,43 +21,32 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8469000
+  version_requirements: *16634260
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &8467980 !ruby/object:Gem::Requirement
+  name: rainbow
+  requirement: &16633400 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
-  version_requirements: *8467980
+  version_requirements: *16633400
 - !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &8466960 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &16632500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: *8466960
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: &8466160 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *8466160
+  version_requirements: *16632500
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &8465060 !ruby/object:Gem::Requirement
+  requirement: &16631500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +54,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *8465060
+  version_requirements: *16631500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &8480380 !ruby/object:Gem::Requirement
+  requirement: &16649140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +65,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *8480380
+  version_requirements: *16649140
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &8479640 !ruby/object:Gem::Requirement
+  name: debugger
+  requirement: &16647760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8479640
+  version_requirements: *16647760
 description: Diffbench is gem designed to benchmark the performance patches. It can
   run specified benchmark file before and after some changes made and show performance
   comparation result
@@ -102,7 +91,6 @@ files:
 - .document
 - .rspec
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -114,6 +102,8 @@ files:
 - features/support/env.rb
 - lib/diff_bench.rb
 - lib/diffbench.rb
+- lib/diffbench/bm.rb
+- lib/diffbench/encoder.rb
 - spec/bench.rb
 - spec/code.rb
 - spec/diffbench_spec.rb
@@ -133,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1579437980307483478
+      hash: -784782752232548335
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -142,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Benchmark your before and after some changes made

data/Gemfile.lock

@@ -1,45 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    builder (3.0.0)
-    cucumber (1.1.9)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.2)
-      gherkin (~> 2.9.0)
-      json (>= 1.4.6)
-      term-ansicolor (>= 1.0.6)
-    diff-lcs (1.1.3)
-    gherkin (2.9.0)
-      json (>= 1.4.6)
-    git (1.2.5)
-    jeweler (1.8.3)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.6.5)
-    rake (0.9.2.2)
-    rcov (0.9.9)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    term-ansicolor (1.0.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.1.0)
-  cucumber
-  git
-  jeweler (~> 1.8.3)
-  rcov
-  rdoc (~> 3.12)
-  rspec (~> 2.8.0)