hitimes 1.1.1 → 1.2.0

data/spec/timed_value_metric_spec.rb

@@ -1,6 +1,4 @@
-require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
-
-require 'hitimes/timed_value_metric'
+require 'spec_helper'
 
 describe Hitimes::TimedValueMetric do
   before( :each ) do
@@ -19,97 +17,98 @@ describe Hitimes::TimedValueMetric do
     @tm.start
     d = @tm.split( 1 )
     @tm.should be_running
-    d.should > 0
-    @tm.value_stats.count.should == 1
-    @tm.timed_stats.count.should == 1
-    @tm.duration.should == d
+    d.should be > 0
+    @tm.value_stats.count.should be == 1
+    @tm.timed_stats.count.should be == 1
+    @tm.duration.should be == d
   end
 
   it "#stop returns false if called more than once in a row" do
     @tm.start
-    @tm.stop( 1 ).should > 0
-    @tm.stop( 1 ).should == false
+    @tm.stop( 1 ).should be > 0
+    @tm.stop( 1 ).should be == false
   end
 
   it "does not count a currently running interval as an interval in calculations" do
     @tm.start
-    @tm.value_stats.count.should == 0
-    @tm.timed_stats.count.should == 0
+    @tm.value_stats.count.should be == 0
+    @tm.timed_stats.count.should be == 0
     @tm.split( 1 )
-    @tm.value_stats.count.should == 1
-    @tm.timed_stats.count.should == 1
+    @tm.value_stats.count.should be == 1
+    @tm.timed_stats.count.should be == 1
   end
 
   it "#split called on a stopped timer does nothing" do
     @tm.start
     @tm.stop( 1 )
-    @tm.split( 1 ).should == false
+    @tm.split( 1 ).should be == false
   end
 
   it "calculates the mean of the durations" do
     3.times { |x| @tm.start ; sleep 0.05 ; @tm.stop(x) }
-    @tm.timed_stats.mean.should be_close( 0.05, 0.01 )
-    @tm.value_stats.mean.should == 1.00
+    @tm.timed_stats.mean.should be_within(0.01).of(0.05)
+    @tm.value_stats.mean.should be == 1.00
   end
 
   it "calculates the rate of the counts " do
     5.times { |x| @tm.start ; sleep 0.05 ; @tm.stop( x ) }
-    @tm.rate.should be_close( 40.0, 0.2)
+    @tm.rate.should be_within(1.0).of(40.0)
   end
 
 
   it "calculates the stddev of the durations" do
-    3.times { |x| @tm.start ; sleep (0.05 * x) ; @tm.stop(x) }
-    @tm.timed_stats.stddev.should be_close( 0.05, 0.001) 
-    @tm.value_stats.stddev.should == 1.0
+    3.times { |x| @tm.start ; sleep(0.05 * x) ; @tm.stop(x) }
+    @tm.timed_stats.stddev.should be_within(0.001).of(0.05)
+    @tm.value_stats.stddev.should be == 1.0
   end
 
   it "returns 0.0 for stddev if there is no data" do
-    @tm.timed_stats.stddev.should == 0.0
-    @tm.value_stats.stddev.should == 0.0
+    @tm.timed_stats.stddev.should be == 0.0
+    @tm.value_stats.stddev.should be == 0.0
   end
 
   it "keeps track of the min value" do
     3.times { |x| @tm.start ; sleep 0.05 ; @tm.stop( x ) }
-    @tm.timed_stats.min.should be_close( 0.05, 0.001 )
-    @tm.value_stats.min.should == 0
+    @tm.timed_stats.min.should be_within( 0.003 ).of(0.05)
+    @tm.value_stats.min.should be == 0
   end
 
   it "keeps track of the max value" do
     3.times { |x| @tm.start ; sleep 0.05 ; @tm.stop( x ) }
-    @tm.timed_stats.max.should be_close( 0.05, 0.001) 
-    @tm.value_stats.max.should == 2
+    @tm.timed_stats.max.should be_within(0.003).of( 0.05 )
+    @tm.value_stats.max.should be == 2
   end
 
   it "keeps track of the sum value" do
     3.times { |x| @tm.start ; sleep 0.05 ; @tm.stop( x ) }
-    @tm.timed_stats.sum.should be_close( 0.15, 0.01 )
-    @tm.value_stats.sum.should == 3
+    @tm.timed_stats.sum.should be_within(0.01).of(0.15)
+    @tm.value_stats.sum.should be == 3
   end
   
   it "keeps track of the sum of squares value" do
     3.times { |x| @tm.start ; sleep 0.05 ; @tm.stop( x ) }
-    @tm.timed_stats.sumsq.should be_close( 0.0075, 0.0001 )
-    @tm.value_stats.sumsq.should == 5
+    @tm.timed_stats.sumsq.should be_within(0.0005).of(0.0075)
+    @tm.value_stats.sumsq.should be == 5
   end
 
   it "keeps track of the minimum start time of all the intervals" do
     f1 = Time.now.gmtime.to_f * 1000000
     5.times { @tm.start ; sleep 0.05 ; @tm.stop( 1 ) }
     f2 = Time.now.gmtime.to_f * 1000000
-    @tm.sampling_start_time.should >= f1
-    @tm.sampling_start_time.should < f2
+    @tm.sampling_start_time.should be >= f1
+    @tm.sampling_start_time.should be < f2
     # distance from now to start time should be greater than the distance from
     # the start to the min start_time
     (f2 - @tm.sampling_start_time).should > ( @tm.sampling_start_time - f1 )
   end
 
   it "keeps track of the last stop time of all the intervals" do
-    f1 = Time.now.gmtime.to_f * 1000000
+    f1 = Time.now.gmtime.to_f * 1_000_000
     5.times { @tm.start ; sleep 0.05 ; @tm.stop( 1 ) }
-    f2 = Time.now.gmtime.to_f * 1000000
-    @tm.sampling_stop_time.should > f1
-    @tm.sampling_stop_time.should <= f2
+    sleep 0.05
+    f2 = Time.now.gmtime.to_f * 1_000_000
+    @tm.sampling_stop_time.should be > f1
+    @tm.sampling_stop_time.should be <= f2
     # distance from now to max stop time time should be less than the distance
     # from the start to the max stop time
     (f2 - @tm.sampling_stop_time).should < ( @tm.sampling_stop_time - f1 )
@@ -123,41 +122,41 @@ describe Hitimes::TimedValueMetric do
   it "can measure a block of code from an instance" do
     t = Hitimes::TimedValueMetric.new( 'measure a block' )
     3.times { t.measure( 1 ) { sleep 0.05 } }
-    t.duration.should be_close( 0.15, 0.001 )
-    t.timed_stats.count.should == 3
-    t.value_stats.count.should == 3
+    t.duration.should be_within(0.004).of(0.15)
+    t.timed_stats.count.should be == 3
+    t.value_stats.count.should be == 3
   end
 
   it "returns the value of the block when measuring" do
     t = Hitimes::TimedValueMetric.new( 'measure a block' )
     x = t.measure( 42 ) { sleep 0.05; 42 }
-    t.duration.should be_close( 0.05, 0.001 )
-    x.should == 42
+    t.duration.should be_within(0.002).of(0.05)
+    x.should be == 42
   end
 
   describe "#to_hash" do
 
     it "has name value" do
       h = @tm.to_hash
-      h['name'].should == "test-timed-value-metric"
+      h['name'].should be == "test-timed-value-metric"
     end
 
     it "has an empty has for additional_data" do
       h = @tm.to_hash
-      h['additional_data'].should == Hash.new
-      h['additional_data'].size.should == 0
+      h['additional_data'].should be == Hash.new
+      h['additional_data'].size.should be == 0
     end
 
     it "has a rate" do
       5.times { |x| @tm.start ; sleep 0.05 ; @tm.stop( x ) }
       h = @tm.to_hash
-      h['rate'].should be_close( 40.0, 0.3 )
+      h['rate'].should be_within(1.0  ).of(40.0)
     end
 
     it "has a unit_count" do
       5.times { |x| @tm.start ; sleep 0.05 ; @tm.stop( x ) }
       h = @tm.to_hash
-      h['unit_count'].should ==  10
+      h['unit_count'].should be ==  10
     end
 
     fields = %w[ name additional_data sampling_start_time sampling_stop_time value_stats timed_stats rate unit_count ]

data/spec/value_metric_spec.rb

@@ -1,6 +1,4 @@
-require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
-
-require 'hitimes/value_metric'
+require 'spec_helper'
 
 describe Hitimes::ValueMetric do
   before( :each ) do
@@ -9,21 +7,21 @@ describe Hitimes::ValueMetric do
   end
 
   it 'has a name' do
-    @metric.name.should == "testing"
+    @metric.name.should be == "testing"
   end
 
   it "has associated data from initialization" do
     m = Hitimes::ValueMetric.new( "more-data", 'foo' => 'bar', 'this' => 'that' )
-    m.additional_data['foo'].should == 'bar'
-    m.additional_data['this'].should == 'that'
+    m.additional_data['foo'].should be == 'bar'
+    m.additional_data['this'].should be == 'that'
     
     m = Hitimes::ValueMetric.new( "more-data", { 'foo' => 'bar', 'this' => 'that' } )
-    m.additional_data['foo'].should == 'bar'
-    m.additional_data['this'].should == 'that'
+    m.additional_data['foo'].should be == 'bar'
+    m.additional_data['this'].should be == 'that'
   end
 
   it "calculates the mean of the measurements" do
-    @metric.mean.should == 4.5
+    @metric.mean.should be == 4.5
   end
 
   it "calculates the stddev of the measurements" do
@@ -32,27 +30,27 @@ describe Hitimes::ValueMetric do
 
   it "returns 0.0 for stddev if there is no data" do
     m = Hitimes::ValueMetric.new('0-data')
-    m.stddev.should == 0.0
+    m.stddev.should be == 0.0
   end
 
   it "keeps track of the sum of data" do
-    @metric.sum.should == 45.0
+    @metric.sum.should be == 45.0
   end
 
   it "keeps track of the sum of squars of data" do
-    @metric.sumsq.should == 285.0
+    @metric.sumsq.should be == 285.0
   end
 
   it "retuns 0.0 for mean if there is no data" do
-    Hitimes::ValueMetric.new('0-data').mean.should == 0.0
+    Hitimes::ValueMetric.new('0-data').mean.should be == 0.0
   end
 
   it "keeps track of the min value" do
-    @metric.min.should == 0
+    @metric.min.should be == 0
   end
 
   it "keeps track of the max value" do
-    @metric.max.should == 9
+    @metric.max.should be == 9
   end
 
   it "keeps track of the first start time of all the measurements" do
@@ -60,8 +58,8 @@ describe Hitimes::ValueMetric do
     f1 = Time.now.gmtime.to_f * 1_000_000
     10.times{ |x| m.measure( x ); sleep 0.1 }
     f2 = Time.now.gmtime.to_f * 1_000_000
-    m.sampling_start_time.should >= f1
-    m.sampling_start_time.should < f2
+    m.sampling_start_time.should be >= f1
+    m.sampling_start_time.should be < f2
     # distance from now to start time should be greater than the distance from
     # the start to the min start_time
     (f2 - m.sampling_start_time).should > ( m.sampling_start_time - f1 )
@@ -72,8 +70,8 @@ describe Hitimes::ValueMetric do
     f1 = Time.now.gmtime.to_f * 1_000_000
     10.times {|x| m.measure( x ); sleep 0.1  }
     f2 = Time.now.gmtime.to_f * 1_000_000
-    m.sampling_stop_time.should > f1
-    m.sampling_stop_time.should <= f2
+    m.sampling_stop_time.should be > f1
+    m.sampling_stop_time.should be <= f2
     # distance from now to max stop time time should be less than the distance
     # from the start to the max stop time
     (f2 - m.sampling_stop_time).should < ( m.sampling_stop_time - f1 )
@@ -83,18 +81,18 @@ describe Hitimes::ValueMetric do
 
     it "has name value" do
       h = @metric.to_hash
-      h['name'].should == "testing"
+      h['name'].should be == "testing"
     end
 
     it "has an empty has for additional_data" do
       h = @metric.to_hash
-      h['additional_data'].should == Hash.new
-      h['additional_data'].size.should == 0
+      h['additional_data'].should be == Hash.new
+      h['additional_data'].size.should be == 0
     end
 
     it "has the right sum" do
       h = @metric.to_hash
-      h['sum'].should == 45
+      h['sum'].should be == 45
     end
 
     fields = ::Hitimes::Stats::STATS.dup + %w[ name additional_data sampling_start_time sampling_stop_time ]

data/spec/version_spec.rb

@@ -1,33 +1,7 @@
-require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper" ) )
+require "spec_helper"
 
 describe "Hitimes::Version" do
-    it "should have a major numbers that is >= 0" do
-        Hitimes::Version::MAJOR.should >= 0
-    end 
-
-    it "should have a minor number that is >= 0" do
-        Hitimes::Version::MINOR.should >= 0
-    end 
-
-    it "should have a tiny number that is >= 0" do
-        Hitimes::Version::BUILD.should >= 0
-    end 
-
-    it "should have an array representation" do
-        Hitimes::Version.to_a.should have(3).items
-    end 
-
-    it "should have a string representation" do
-        Hitimes::Version.to_s.should match(/\d+\.\d+\.\d+/)
-    end 
-
-    it "should have a hash representation" do
-      [ :major, :minor, :build ].each do |k|
-        Hitimes::Version.to_hash[k].should_not be_nil
-      end
-    end
-
-    it "should be accessable as a constant" do
-        Hitimes::VERSION.should match(/\d+\.\d+\.\d+/)
-    end 
+  it "should be accessable as a constant" do
+    Hitimes::VERSION.should match(/\d+\.\d+\.\d+/)
+  end
 end

data/tasks/default.rake

@@ -0,0 +1,267 @@
+# vim: syntax=ruby
+require 'rake/clean'
+#------------------------------------------------------------------------------
+# If you want to Develop on this project just run 'rake develop' and you'll
+# have all you need to get going. If you want to use bundler for development,
+# then run 'rake develop:using_bundler'
+#------------------------------------------------------------------------------
+namespace :develop do
+
+  # Install all the development and runtime dependencies of this gem using the
+  # gemspec.
+  task :default do
+    require 'rubygems/dependency_installer'
+    installer = Gem::DependencyInstaller.new
+
+    This.set_coverage_gem
+
+    puts "Installing gem depedencies needed for development"
+    This.platform_gemspec.dependencies.each do |dep|
+      if dep.matching_specs.empty? then
+        puts "Installing : #{dep}"
+        installer.install dep
+      else
+        puts "Skipping   : #{dep} -> already installed #{dep.matching_specs.first.full_name}"
+      end
+    end
+    puts "\n\nNow run 'rake test'"
+  end
+
+  # Create a Gemfile that just references the gemspec
+  file 'Gemfile' => :gemspec do
+    File.open( "Gemfile", "w+" ) do |f|
+      f.puts 'source :rubygems'
+      f.puts 'gemspec'
+    end
+  end
+
+  desc "Create a bundler Gemfile"
+  task :using_bundler => 'Gemfile' do
+    puts "Now you can 'bundle'"
+  end
+
+  # Gemfiles are build artifacts
+  CLOBBER << FileList['Gemfile*']
+end
+desc "Boostrap development"
+task :develop => "develop:default"
+
+#------------------------------------------------------------------------------
+# Minitest - standard TestTask
+#------------------------------------------------------------------------------
+begin
+  require 'rake/testtask'
+  Rake::TestTask.new( :test ) do |t|
+    t.ruby_opts    = %w[ -w -rubygems ]
+    t.libs         = %w[ lib spec ]
+    t.pattern      = "spec/**/*_spec.rb"
+  end
+
+  task :test_requirements
+  task :test => :test_requirements
+  task :default => :test
+rescue LoadError
+  This.task_warning( 'test' )
+end
+
+#------------------------------------------------------------------------------
+# RDoc - standard rdoc rake task, although we must make sure to use a more
+#        recent version of rdoc since it is the one that has 'tomdoc' markup
+#------------------------------------------------------------------------------
+begin
+  gem 'rdoc' # otherwise we get the wrong task from stdlib
+  require 'rdoc/task'
+  RDoc::Task.new do |t|
+    t.markup   = 'tomdoc'
+    t.rdoc_dir = 'doc'
+    t.main     = 'README.rdoc'
+    t.title    = "#{This.name} #{This.version}"
+    t.rdoc_files.include( '*.rdoc', 'lib/**/*.rb' )
+  end
+rescue LoadError => le
+  This.task_warning( 'rdoc' )
+end
+
+#------------------------------------------------------------------------------
+# Coverage - optional code coverage, rcov for 1.8 and simplecov for 1.9, so
+#            for the moment only rcov is listed.
+#------------------------------------------------------------------------------
+if RUBY_VERSION < "1.9.0"
+  begin
+   require 'rcov/rcovtask'
+   Rcov::RcovTask.new( 'coverage' ) do |t|
+     t.libs      << 'spec'
+     t.pattern   = 'spec/**/*_spec.rb'
+     t.verbose   = true
+     t.rcov_opts << "-x ^/"           # remove all the global files
+     t.rcov_opts << "--sort coverage" # so we see the worst files at the top
+   end
+  rescue LoadError
+   This.task_warning( 'rcov' )
+  end
+else
+  begin
+    require 'simplecov'
+    desc 'Run tests with code coverage'
+    task :coverage do
+      ENV['COVERAGE'] = 'true'
+      Rake::Task[:test].execute
+    end
+    CLOBBER << FileList["coverage"]
+  rescue LoadError
+    This.task_warning( 'simplecov' )
+  end
+end
+
+#------------------------------------------------------------------------------
+# Manifest - We want an explicit list of thos files that are to be packaged in
+#            the gem. Most of this is from Hoe.
+#------------------------------------------------------------------------------
+namespace 'manifest' do
+  desc "Check the manifest"
+  task :check => :clean do
+    files = FileList["**/*", ".*"].exclude( This.exclude_from_manifest ).to_a.sort
+    files = files.select{ |f| File.file?( f ) }
+
+    tmp = "Manifest.tmp"
+    File.open( tmp, 'w' ) do |f|
+      f.puts files.join("\n")
+    end
+
+    begin
+      sh "diff -du Manifest.txt #{tmp}"
+    ensure
+      rm tmp
+    end
+    puts "Manifest looks good"
+  end
+
+  desc "Generate the manifest"
+  task :generate => :clean do
+    files = %x[ git ls-files ].split("\n").sort
+    files.reject! { |f| f =~ This.exclude_from_manifest }
+    File.open( "Manifest.txt", "w" ) do |f|
+      f.puts files.join("\n")
+    end
+  end
+end
+
+#------------------------------------------------------------------------------
+# Fixme - look for fixmes and report them
+#------------------------------------------------------------------------------
+namespace :fixme do
+  task :default => 'manifest:check' do
+    This.manifest.each do |file|
+      next if file == __FILE__
+      next unless file =~ %r/(txt|rb|md|rdoc|css|html|xml|css)\Z/
+      puts "FIXME: Rename #{file}" if file =~ /fixme/i
+      IO.readlines( file ).each_with_index do |line, idx|
+        prefix = "FIXME: #{file}:#{idx+1}".ljust(42)
+        puts "#{prefix} => #{line.strip}" if line =~ /fixme/i
+      end
+    end
+  end
+
+  def fixme_project_root
+    This.project_path( '../fixme' )
+  end
+
+  def fixme_project_path( subtree )
+    fixme_project_root.join( subtree )
+  end
+
+  def local_fixme_files
+    This.manifest.select { |p| p =~ %r|^tasks/| }
+  end
+
+  def outdated_fixme_files
+    local_fixme_files.reject do |local|
+      upstream     = fixme_project_path( local )
+      Digest::SHA256.file( local ) == Digest::SHA256.file( upstream )
+    end
+  end
+
+  def fixme_up_to_date?
+    outdated_fixme_files.empty?
+  end
+
+  desc "See if the fixme tools are outdated"
+  task :outdated => :release_check do
+    if fixme_up_to_date? then
+      puts "Fixme files are up to date."
+    else
+      outdated_fixme_files.each do |f|
+        puts "#{f} is outdated"
+      end
+    end
+  end
+
+  desc "Update outdated fixme files"
+  task :update => :release_check do
+    if fixme_up_to_date? then
+      puts "Fixme files are already up to date."
+    else
+      puts "Updating fixme files:"
+      outdated_fixme_files.each do |local|
+        upstream = fixme_project_path( local )
+        puts "  * #{local}"
+        FileUtils.cp( upstream, local )
+      end
+      puts "Use your git commands as appropriate."
+    end
+  end
+end
+desc "Look for fixmes and report them"
+task :fixme => "fixme:default"
+
+#------------------------------------------------------------------------------
+# Gem Specification
+#------------------------------------------------------------------------------
+# Really this is only here to support those who use bundler
+desc "Build the #{This.name}.gemspec file"
+task :gemspec do
+  File.open( This.gemspec_file, "wb+" ) do |f|
+    f.write This.platform_gemspec.to_ruby
+  end
+end
+
+# the gemspec is also a dev artifact and should not be kept around.
+CLOBBER << This.gemspec_file.to_s
+
+# The standard gem packaging task, everyone has it.
+require 'rubygems/package_task'
+Gem::PackageTask.new( This.platform_gemspec ) do
+  # nothing
+end
+
+#------------------------------------------------------------------------------
+# Release - the steps we go through to do a final release, this is pulled from
+#           a compbination of mojombo's rakegem, hoe and hoe-git
+#
+# 1) make sure we are on the master branch
+# 2) make sure there are no uncommitted items
+# 3) check the manifest and make sure all looks good
+# 4) build the gem
+# 5) do an empty commit to have the commit message of the version
+# 6) tag that commit as the version
+# 7) push master
+# 8) push the tag
+# 7) pus the gem
+#------------------------------------------------------------------------------
+task :release_check do
+  unless `git branch` =~ /^\* master$/
+    abort "You must be on the master branch to release!"
+  end
+  unless `git status` =~ /^nothing to commit/m
+    abort "Nope, sorry, you have unfinished business"
+  end
+end
+
+desc "Create tag v#{This.version}, build and push #{This.platform_gemspec.full_name} to rubygems.org"
+task :release => [ :release_check, 'manifest:check', :gem ] do
+  sh "git commit --allow-empty -a -m 'Release #{This.version}'"
+  sh "git tag -a -m 'v#{This.version}' v#{This.version}"
+  sh "git push origin master"
+  sh "git push origin v#{This.version}"
+  sh "gem push pkg/#{This.platform_gemspec.full_name}.gem"
+end