benchmark_color 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6376a133153b1187337c43619b703f952df86a9e
+  data.tar.gz: e8a17b237dddf672622e413569532e6c5aa5691b
+SHA512:
+  metadata.gz: 2f76a87fe18fb4d11a7eddc30c50ab078a9439e51fbe344d2add8390bf5b0876047554029fbf667df19ad2ad0e39c45749f5adf0fdea93994e5e9cc29d13b8f5
+  data.tar.gz: a213ed1eb9aed1826f0e7ce270cdcd8b6c60a180bb1cb7f3e062010bec01c3321ff53ddd74dab6f40b18093110591b6978e3b1fc99dbba2f40f96d7fb685e5aa

data/.document

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

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+#
+gem "colorize"
+
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    colorize (0.6.0)
+    descendants_tracker (0.0.3)
+    docile (1.1.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    mini_portile (0.5.2)
+    minitest (5.2.2)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.2.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  colorize
+  jeweler (~> 2.0.1)
+  minitest
+  rdoc (~> 3.12)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Matthew Sullivan
+
+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,84 @@
+## benchmark_color
+
+This is a simple realtime benchmark tool in color! 
+
+####Installation
+
+	gem install 'benchmark_color'
+
+#### Getting Started
+In the top of your file or in irb.
+	
+	require 'benchmark_color'
+	
+Create a new Benchmark object 
+
+	b = Benchmark.new
+
+Measure a block of code
+	
+	n = 10000
+	b.measure("some-label:")	{n.times.do ; x = 1; end}
+	
+Use the Compare method to recieve an output
+
+    b.compare
+
+The whole thing together will look something like this. 
+
+	b = Benchmark.new
+	b.measure("some-label:") { YOUR BLOCK OF CODE} 
+	b.compare
+	   
+You can measure as many blocks of code to be compared to one another as the same Benchmark object. For example.
+
+	....
+	b = Benchmark.new
+	b.measure("some-label":) {YOUR BLOCK OF CODE}
+	b.measure("some-label:") {YOUR BLOCK OF CODE}
+    b.compare
+       
+####Customizing colors
+When you create a Benchmark object just include the colors you prefer.
+benchmark_color uses the awesome 'colorize ' gem so the colors need to be a symbol. 
+By default the fastest block of code will be green and the slowest red.
+Therfore winner: :green, loser: :red.
+
+    b = Benchmark.new winner: :cyan, loser: :magenta, option: :yellow
+     
+The option: color argument is for the blocks of code that were neither fastest or slowest. 
+
+Colorize is an extension to the String class.  To see a list of all the colors
+just use:
+	
+	String.colors
+
+####Screen Shots
+File Setup
+
+![file](http://i.imgur.com/MdQPkHR.png)	
+	
+Output
+
+![output](http://i.imgur.com/Tr2oib3.png)
+
+####Future Features
++ Process:Tms integration
++ More customizations
+	
+	
+####Contributing to benchmark_color
+ 
+* 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 Matthew Sullivan. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# 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 = "benchmark_color"
+  gem.homepage = "http://github.com/hayduke19us/benchmark_color"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple realtime benchmark for ruby --> in Color!}
+  gem.description = %Q{Customize the output with your own colors.}
+  gem.email = "hayduke19us@gmail.com"
+  gem.authors = ["Matthew Sullivan"]
+  # 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 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "benchmark_color #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/benchmark_color.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: benchmark_color 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "benchmark_color"
+  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 = ["Matthew Sullivan"]
+  s.date = "2014-04-22"
+  s.description = "Customize the output with your own colors."
+  s.email = "hayduke19us@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "benchmark_color.gemspec",
+    "lib/benchmark_color.rb",
+    "test/helper.rb",
+    "test/test_benchmark_color.rb"
+  ]
+  s.homepage = "http://github.com/hayduke19us/benchmark_color"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "A simple realtime benchmark for ruby --> in Color!"
+
+  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<colorize>, [">= 0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<colorize>, [">= 0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<colorize>, [">= 0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/benchmark_color.rb

@@ -0,0 +1,113 @@
+require "colorize"
+
+module Abacus
+
+  def self.block_time
+    measure {yield}
+  end
+
+  def self.measure
+    #to add Process::Tms object in future
+    start_process, before = Process.times, Time.now
+    yield
+    end_process, after = Process.times, Time.now
+    ((after - before) * 1000) 
+  end
+end
+
+module Report
+  $stdout.sync = true
+
+  def self.output block_hash, winner, loser, option
+    unless block_hash.count == 1
+      block_array = block_hash.sort_by {|k, v| v}
+      first = block_array.shift
+      last = block_array.pop
+      Report.format first, last, block_array, winner, loser, option
+    else
+      block_hash = block_hash.flatten.join(' ')
+      Report.seperator
+      puts 
+      puts "#{Report.arrow}" "#{block_hash.colorize(color: winner)}"
+      puts
+      Report.seperator
+    end
+
+  end
+
+  def self.format first, last, block_array, winner, loser, option
+    puts Report.seperator
+    puts "#{Report.arrow}" "#{ first.join(' ').colorize(color: winner)}"
+    block_array.each do |block|
+      puts "#{Report.small_arrow}" "#{block.join(' ').colorize(color: option)}"
+    end
+    puts "#{Report.arrow}" "#{ last.join(' ').colorize(color: loser)}"
+    puts
+    puts Report.seperator
+  end
+
+  def self.arrow
+    " -----------------------> ".colorize(color: :light_blue)
+  end
+
+  def self.small_arrow
+    " ----> ".colorize(color: :light_blue)
+  end
+
+  def self.seperator
+   puts "=-=-=-=-=-=--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-"
+  end
+
+end
+
+class Benchmark
+
+  attr_reader :block_hash
+  attr_accessor :winner, :loser, :option
+
+  include Abacus
+  include Report
+
+  def initialize args={}
+    @winner = args.fetch(:winner, :green)
+    @loser = args.fetch(:loser, :red)
+    @option = args.fetch(:option, :light_blue)
+    @block_hash ||= {}
+  end
+
+  def measure label = ""
+    if block_given?
+      block = Abacus.block_time {yield}
+      @block_hash[label] = block
+      true
+    else
+      puts instructions
+      false
+    end
+  end
+
+  def compare
+    Report.output @block_hash, winner, loser, option
+  end
+
+  def instructions
+    %{You must supply a block of code like this:
+
+     b = Benchmark.new
+     b.measure("some-label:") { n.times do; x = 1 + 3; end}
+     b.compare #to get your results
+
+     Or this:
+
+     n = 1000
+     b = Benchmark.new
+     b.measure("some-label:") do
+       n.times do 
+         x = 1 + 3
+       end
+     end
+     b.compare #to get your results}
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,36 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+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 'minitest/autorun'
+require 'minitest/pride'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'benchmark_color'
+
+class MiniTest::Test
+end
+
+MiniTest.autorun

data/test/test_benchmark_color.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class TestBenchmark < MiniTest::Test
+
+  def setup
+    @bench = Benchmark.new
+    @color = Benchmark.new(winner: :blue, loser: :yellow)
+  end
+
+  def test_if_no_winner_color_is_present_the_default_is_green
+    assert_equal :green, @bench.winner
+  end
+
+  def test_if_no_loser_color_is_present_the_default_is_red
+    assert_equal :red, @bench.loser
+  end
+
+  def test_if_no_option_is_set_the_default_is_light_blue
+    assert_equal :light_blue, @bench.option
+  end
+
+  def test_a_user_sets_a_color_that_color_is_present
+    assert_equal :blue, @color.winner
+  end
+
+  def test_the_colors_can_be_set_after_object_is_written
+    @color.winner = :yellow
+    assert_equal :yellow, @color.winner
+  end
+
+  def test_if_a_label_is_the_same_it_wont_repeat_the_test
+    @bench.measure {}
+    @bench.measure {}
+    assert_equal 1, @bench.block_hash.count
+  end
+
+  def test_if_the_labels_are_different_block_will_be_added_to_block_hash
+    @bench.measure("something") {}
+    @bench.measure {}
+    assert_equal 2, @bench.block_hash.count
+  end
+
+  def test_the_colors_can_be_changed_half_way_thru_the_benchmark_process
+    n = 5000
+    x = 1000
+    @bench.measure("something") {n.times do; a = 1; end;}
+    @bench.measure("else") {x.times do; a = 1; end;}
+    @bench.winner = :cyan
+    @bench.loser = :light_black
+    @bench.measure("new_something") {n.times do; a = 1 + 4; end;}
+    @bench.measure("new_else") {x.times do; a = 1 + 4; end;}
+    @bench.compare
+  end
+
+  def test_if_block_is_given_return_true
+    assert_equal true, @bench.measure {}
+  end
+
+  def test_if_no_block_is_given_user_gets_instructions
+    assert_equal false,  @bench.measure
+  end
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: benchmark_color
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Sullivan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: minitest
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !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
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Customize the output with your own colors.
+email: hayduke19us@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- benchmark_color.gemspec
+- lib/benchmark_color.rb
+- test/helper.rb
+- test/test_benchmark_color.rb
+homepage: http://github.com/hayduke19us/benchmark_color
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple realtime benchmark for ruby --> in Color!
+test_files: []