hitimes 1.1.0-java

data/spec/timed_value_metric_spec.rb

@@ -0,0 +1,172 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes/timed_value_metric'
+
+describe Hitimes::TimedValueMetric do
+  before( :each ) do
+    @tm = Hitimes::TimedValueMetric.new( 'test-timed-value-metric' )
+  end
+
+  it "knows if it is running or not" do
+    @tm.should_not be_running
+    @tm.start
+    @tm.should be_running
+    @tm.stop( 1 )
+    @tm.should_not be_running
+  end
+
+  it "#split returns the last duration and the timer is still running" 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
+  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
+  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.split( 1 )
+    @tm.value_stats.count.should == 1
+    @tm.timed_stats.count.should == 1
+  end
+
+  it "#split called on a stopped timer does nothing" do
+    @tm.start
+    @tm.stop( 1 )
+    @tm.split( 1 ).should == 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
+  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)
+  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
+  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
+  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
+  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
+  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
+  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
+  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
+    # 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
+    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
+    # 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 )
+  end
+
+  it "can create an already running timer" do
+    t = Hitimes::TimedValueMetric.now( 'already-running' )
+    t.should be_running
+  end
+
+  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
+  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
+  end
+
+  describe "#to_hash" do
+
+    it "has name value" do
+      h = @tm.to_hash
+      h['name'].should == "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
+    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 )
+    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
+    end
+
+    fields = %w[ name additional_data sampling_start_time sampling_stop_time value_stats timed_stats rate unit_count ]
+    fields.each do |f|
+      it "should have a value for #{f}" do
+        3.times { |x| @tm.measure(x) { sleep 0.001 } }
+        h = @tm.to_hash
+        h[f].should_not be_nil
+      end
+    end
+  end 
+end

data/spec/value_metric_spec.rb

@@ -0,0 +1,110 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes/value_metric'
+
+describe Hitimes::ValueMetric do
+  before( :each ) do
+    @metric = Hitimes::ValueMetric.new( "testing" )
+    10.times { |x| @metric.measure( x ) }
+  end
+
+  it 'has a name' do
+    @metric.name.should == "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 = Hitimes::ValueMetric.new( "more-data", { 'foo' => 'bar', 'this' => 'that' } )
+    m.additional_data['foo'].should == 'bar'
+    m.additional_data['this'].should == 'that'
+  end
+
+  it "calculates the mean of the measurements" do
+    @metric.mean.should == 4.5
+  end
+
+  it "calculates the stddev of the measurements" do
+    @metric.stddev.should > 0.0
+  end
+
+  it "returns 0.0 for stddev if there is no data" do
+    m = Hitimes::ValueMetric.new('0-data')
+    m.stddev.should == 0.0
+  end
+
+  it "keeps track of the sum of data" do
+    @metric.sum.should == 45.0
+  end
+
+  it "keeps track of the sum of squars of data" do
+    @metric.sumsq.should == 285.0
+  end
+
+  it "retuns 0.0 for mean if there is no data" do
+    Hitimes::ValueMetric.new('0-data').mean.should == 0.0
+  end
+
+  it "keeps track of the min value" do
+    @metric.min.should == 0
+  end
+
+  it "keeps track of the max value" do
+    @metric.max.should == 9
+  end
+
+  it "keeps track of the first start time of all the measurements" do
+    m = Hitimes::ValueMetric.new( "first-start-time" )
+    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
+    # 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 )
+  end
+
+  it "keeps track of the last stop time of all the intervals" do
+    m = Hitimes::ValueMetric.new( "last-stop-time" )
+    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
+    # 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 )
+  end
+
+  describe "#to_hash" do
+
+    it "has name value" do
+      h = @metric.to_hash
+      h['name'].should == "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
+    end
+
+    it "has the right sum" do
+      h = @metric.to_hash
+      h['sum'].should == 45
+    end
+
+    fields = ::Hitimes::Stats::STATS.dup + %w[ name additional_data sampling_start_time sampling_stop_time ]
+    fields = fields - [ 'rate' ]
+    fields.each do |f|
+      it "should have a value for #{f}" do
+        h = @metric.to_hash
+        h[f].should_not be_nil
+      end
+    end
+  end
+end
+

data/spec/version_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "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 
+end

data/tasks/announce.rake

@@ -0,0 +1,42 @@
+require 'tasks/config'
+#-------------------------------------------------------------------------------
+# announcement methods
+#-------------------------------------------------------------------------------
+
+proj_config = Configuration.for('project')
+namespace :announce do
+  desc "create email for ruby-talk"
+  task :email do
+    info = Utils.announcement
+
+    File.open("email.txt", "w") do |mail|
+      mail.puts "From: #{proj_config.author} <#{proj_config.email}>"
+      mail.puts "To: ruby-talk@ruby-lang.org"
+      mail.puts "Date: #{Time.now.rfc2822}"
+      mail.puts "Subject: [ANN] #{info[:subject]}"
+      mail.puts
+      mail.puts info[:title]
+      mail.puts 
+      mail.puts "{{ Release notes for Version #{Hitimes::VERSION} }}"
+      mail.puts
+      mail.puts info[:release_notes]
+      mail.puts
+      mail.puts "    #{info[:urls]}"
+      mail.puts 
+      mail.puts "=== Installation"
+      mail.puts
+      mail.puts "  gem install #{Hitimes::GEM_SPEC.name}"
+      mail.puts 
+      mail.puts "=== Description"
+      mail.puts
+      mail.puts info[:description]
+    end 
+    puts "Created the following as email.txt:"
+    puts "-" * 72
+    puts File.read("email.txt")
+    puts "-" * 72
+  end 
+
+  CLOBBER << "email.txt"
+end
+

data/tasks/config.rb

@@ -0,0 +1,109 @@
+require 'configuration'
+
+require 'rake'
+require 'tasks/utils'
+require 'yaml'
+
+#-----------------------------------------------------------------------
+# General project configuration
+#-----------------------------------------------------------------------
+Configuration.for('project') {
+  name          "hitimes"
+  version       Hitimes::Version.to_s
+  author        "Jeremy Hinegardner"
+  email         "jeremy at copiousfreetime dot org"
+  homepage      "http://copiousfreetime.rubyforge.org/hitimes/"
+  description   Utils.section_of("README", "description")
+  summary       description.split(".").first
+  history       "HISTORY"
+  license       FileList["LICENSE"]
+  readme        "README"
+}
+
+#-----------------------------------------------------------------------
+# Packaging 
+#-----------------------------------------------------------------------
+Configuration.for('packaging') {
+  # files in the project 
+  proj_conf = Configuration.for('project')
+  files {
+    bin       FileList["bin/*"]
+    ext       FileList["ext/hitimes/*.{c,h,rb}"]
+    examples  FileList["examples/*.rb"]
+    lib       FileList["lib/**/*.rb"]
+    test      FileList["spec/**/*.rb", "test/**/*.rb"]
+    data      FileList["data/**/*"]
+    tasks     FileList["tasks/**/*.r{ake,b}"]
+    rdoc      FileList[proj_conf.readme, proj_conf.history,
+                       proj_conf.license] + lib + FileList["ext/*.c"]
+    all       bin + examples + ext + lib + test + data + rdoc + tasks  + FileList["Rakefile"]
+  }
+
+  # ways to package the results
+  formats {
+    tgz true
+    zip true
+    rubygem Configuration::Table.has_key?('gem')
+  }
+}
+
+#-----------------------------------------------------------------------
+# Gem packaging
+#-----------------------------------------------------------------------
+Configuration.for("gem") {
+  spec "gemspec.rb"
+  Configuration.for('packaging').files.all << spec
+}
+
+#-----------------------------------------------------------------------
+# Testing
+#   - change mode to 'testunit' to use unit testing
+#-----------------------------------------------------------------------
+Configuration.for('test') {
+  mode      "spec"
+  files     Configuration.for("packaging").files.test
+  options   %w[ --format specdoc --color ]
+  ruby_opts %w[  ]
+}
+
+#-----------------------------------------------------------------------
+# Rcov 
+#-----------------------------------------------------------------------
+Configuration.for('rcov') {
+  output_dir  "coverage"
+  libs        %w[ lib ]
+  rcov_opts   %w[ --html ]
+  ruby_opts   %w[  ]
+  test_files  Configuration.for('packaging').files.test
+}
+
+#-----------------------------------------------------------------------
+# Rdoc 
+#-----------------------------------------------------------------------
+Configuration.for('rdoc') {
+  files       Configuration.for('packaging').files.rdoc
+  main_page   files.first
+  title       Configuration.for('project').name
+  options     %w[ --line-numbers ]
+  output_dir  "doc"
+}
+
+#-----------------------------------------------------------------------
+# Extension
+#-----------------------------------------------------------------------
+Configuration.for('extension') {
+  configs   Configuration.for('packaging').files.ext.find_all { |x| %w[ mkrf_conf.rb extconf.rb ].include?(File.basename(x)) }
+  cross_rbconfig ::YAML::load_file( File.expand_path("~/.rake-compiler/config.yml"))
+}
+
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "copiousfreetime"
+  user          "jjh"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}/hitimes"
+}
+
+