hitimes 1.0.4-x86-mswin32

data/lib/hitimes/value_metric.rb

@@ -0,0 +1,72 @@
+#--
+# Copyright (c) 2008, 2009 Jeremy Hinegardner
+# All rights reserved.  See LICENSE and/or COPYING for details.
+#++
+
+require 'forwardable'
+require 'hitimes'
+module Hitimes
+  #
+  # A ValueMetric holds the data from measuring a single value over a period of
+  # time.  In most cases this may be a single measurement at a single point in
+  # time.
+  #
+  # A good example of a ValueMetric is measuring the number of items in a queue.
+  #
+  # A ValueMetric contains a Stats object, therefore ValueMetric has +count+, +max+, 
+  # +mean+, +min+, +stddev+, +sum+, +sumsq+ methods that delegate to that Stats
+  # object for convenience.
+  #
+  class ValueMetric < Metric
+
+    # holds all the statistics
+    attr_reader :stats
+    
+    #
+    # :call-seq:
+    #   ValueMetric.new( 'my_metric' ) -> ValueMetric
+    #   ValueMetric.new( 'my_metric', 'foo' => 'bar', 'this' => 42 ) -> ValueMetric
+    #
+    # Create a new ValueMetric giving it a name and additional data.
+    # +additional_data+ may be anything that follows the +to_hash+ protocol.
+    #
+    def initialize( name, additional_data = {} )
+      super( name, additional_data )
+      @stats = Stats.new
+    end
+
+    #
+    # :call-seq:
+    #   metric.measure( value ) -> Float
+    #
+    # Give the +value+ as the measurement to the metric.  The value is returned
+    #
+    def measure( value )
+      @sampling_start_time ||= self.utc_microseconds()
+      @sampling_start_interval ||= Interval.now
+
+      @stats.update( value )
+      
+      # update the length of time we have been sampling
+      @sampling_delta = @sampling_start_interval.duration_so_far
+    end
+
+    #
+    # :call-seq:
+    #   metric.to_hash -> Hash
+    #   
+    # Convert the metric to a hash
+    #
+    def to_hash
+      h = super
+      (Stats::STATS - %w[ rate ]).each do |s|
+        h[s] = self.send( s ) 
+      end
+      return h
+    end
+
+    # forward appropriate calls directly to the stats object
+    extend Forwardable
+    def_delegators :@stats, :count, :sum, :max, :mean, :min, :stddev, :sum, :sumsq
+ end
+end

data/lib/hitimes/version.rb

@@ -0,0 +1,57 @@
+#--
+# Copyright (c) 2008 Jeremy Hinegardner
+# All rights reserved.  See LICENSE and/or COPYING for details
+#++
+
+module Hitimes
+  #
+  # module containing all the version information about Hitimes
+  #
+  module Version
+
+    # Major version number
+    MAJOR   = 1
+
+    # Minor version number
+    MINOR   = 0
+
+    # Build number
+    BUILD   = 4
+
+    #
+    # :call-seq:
+    #   Version.to_a -> [ MAJOR, MINOR, BUILD ]
+    #
+    # Return the version as an array of Integers
+    #
+    def self.to_a
+      [MAJOR, MINOR, BUILD]
+    end
+
+    #
+    # :call-seq:
+    #   Version.to_s -> "MAJOR.MINOR.BUILD"
+    #
+    # Return the version as a String with dotted notation
+    #
+    def self.to_s
+      to_a.join(".")
+    end
+
+    #
+    # :call-seq:
+    #   Version.to_hash -> { :major => ..., :minor => ..., :build => ... }
+    #
+    # Return the version as a Hash
+    #
+    def self.to_hash
+      { :major => MAJOR, :minor => MINOR, :build => BUILD }
+    end
+
+    # The Version in MAJOR.MINOR.BUILD dotted notation
+    STRING = Version.to_s
+  end
+
+  # The Version in MAJOR.MINOR.BUILD dotted notation
+  VERSION = Version.to_s
+end

data/spec/interval_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes'
+
+describe Hitimes::Interval do
+  it "has a 0 duration when newly created" do
+    i = Hitimes::Interval.new   
+    i.duration == 0.0
+  end
+
+  it "knows if it has been started" do
+    i = Hitimes::Interval.new
+    i.should_not be_started
+
+    i.start
+    i.should be_started
+  end
+
+  it "knows if it has been stopped" do
+    i = Hitimes::Interval.new
+    i.start
+    i.should_not be_stopped
+    i.stop
+    i.should be_stopped
+  end
+
+  it "knows if it is currently running" do
+    i = Hitimes::Interval.new
+    i.should_not be_running
+    i.start
+    i.should be_running
+    i.stop
+    i.should_not be_running
+  end
+
+  it "can time a block of code" do
+    d = Hitimes::Interval.measure do
+      sleep 0.2
+    end
+    d.should be_close(0.2, 0.01)
+  end
+
+  it "raises an error if measure is called with no block" do
+    lambda{ Hitimes::Interval.measure }.should raise_error( Hitimes::Error )
+  end
+
+  it "creates an interval via #now" do
+    i = Hitimes::Interval.now
+    i.should be_started
+    i.should_not be_stopped
+  end
+
+  it "calling duration multiple times returns successivly grater durations" do
+    i = Hitimes::Interval.new
+    i.start
+    y = i.duration
+    z = i.duration
+    z.should > y
+  end
+
+  it "calling start multiple times on has no effect after the first call" do
+    i = Hitimes::Interval.new
+    i.start.should == true
+    x = i.start_instant
+    i.start_instant.should > 0
+    i.start.should == false
+    x.should == i.start_instant
+  end
+
+  it "returns the duration on the first call to stop" do
+    i = Hitimes::Interval.now
+    d = i.stop
+    d.should be_instance_of( Float )
+  end
+
+  it "calling stop multiple times on has no effect after the first call" do
+    i = Hitimes::Interval.new
+    i.start.should == true
+    i.stop
+
+    x = i.stop_instant
+    i.stop_instant.should > 0
+    i.stop.should == false
+    x.should == i.stop_instant
+
+  end
+
+  it "duration does not change after stop is calledd" do
+    i = Hitimes::Interval.new
+    i.start
+    x = i.stop
+    y = i.duration
+    i.stop.should == false
+
+    z = i.duration
+
+    x.should == y
+    x.should == z
+
+    y.should == z
+  end
+
+  it "can return how much time has elapsed from the start without stopping the interval" do
+    i = Hitimes::Interval.new
+    i.start
+    x = i.duration_so_far
+    i.should be_running
+    y = i.duration_so_far
+    i.stop
+    x.should < y
+    x.should < i.duration
+    y.should < i.duration
+  end
+
+  describe "#split" do
+
+    it "creates a new Interval object" do
+      i = Hitimes::Interval.new
+      i.start
+      i2 = i.split
+      i.object_id.should_not == i2.object_id
+    end
+
+    it "with the stop instant equivialent to the previous Interval's start instant" do
+      i = Hitimes::Interval.new
+      i.start
+      i2 = i.split
+      i.stop_instant.should == i2.start_instant
+    end
+  end
+
+end
+

data/spec/metric_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes/metric'
+
+describe Hitimes::Metric do
+  before( :each ) do
+    @metric = Hitimes::Metric.new( "testing" )
+  end
+
+  it 'has a name' do
+    @metric.name.should == "testing"
+  end
+
+  it "has associated data from initialization" do
+    m = Hitimes::Metric.new( "more-data", 'foo' => 'bar', 'this' => 'that' )
+    m.additional_data['foo'].should == 'bar'
+    m.additional_data['this'].should == 'that'
+    
+    m = Hitimes::Metric.new( "more-data", { 'foo' => 'bar', 'this' => 'that' } )
+    m.additional_data['foo'].should == 'bar'
+    m.additional_data['this'].should == 'that'
+  end
+
+  it "initially has no sampling times" do
+    @metric.sampling_start_time.should == nil
+    @metric.sampling_stop_time.should == nil
+  end
+end
+
+ 

data/spec/mutex_stats_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes'
+require 'hitimes/mutexed_stats'
+
+describe Hitimes::MutexedStats do
+  before( :each ) do
+    @threads = 5
+    @iters   = 10_000
+    @final_value = @threads * @iters
+  end
+
+  def run_with_scissors( stats, threads, iters )
+    spool = []
+    threads.times do |t|
+      spool << Thread.new { iters.times{ stats.update( 1 ) } }
+    end
+    spool.each { |t| t.join }
+    return stats
+  end
+
+  it "is unsafe normally" do
+    pending "not for MRI -- not interruptable in this C extension" do
+      stats = run_with_scissors( ::Hitimes::Stats.new, @threads, @iters )
+      stats.count.should_not == @final_value
+    end
+  end
+
+  it "has a threadsafe update" do
+    stats = run_with_scissors( ::Hitimes::MutexedStats.new, @threads, @iters )
+    stats.count.should == @final_value
+  end
+
+end

data/spec/paths_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes/paths'
+
+describe Hitimes::Paths do
+  it "can access the root dir of the project" do
+    Hitimes::Paths.root_dir.should == File.expand_path( File.join( File.dirname( __FILE__ ), ".." ) ) + ::File::SEPARATOR
+  end
+
+  it "can access the lib path of the project" do
+    Hitimes::Paths.lib_path.should == File.expand_path( File.join( File.dirname( __FILE__ ), "..", "lib" ) ) + ::File::SEPARATOR
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'spec'
+
+$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+

data/spec/stats_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes/stats'
+require 'json'
+
+describe Hitimes::Stats do
+  before( :each ) do
+    @stats = Hitimes::Stats.new
+    @full_stats = Hitimes::Stats.new
+    
+    [ 1, 2, 3].each { |i| @full_stats.update( i ) }
+  end
+
+  it "is initialized with 0 values" do
+    @stats.count.should == 0
+    @stats.min.should == 0.0
+    @stats.max.should == 0.0
+    @stats.sum.should == 0.0
+    @stats.rate.should == 0.0
+  end
+
+  it "calculates the mean correctly" do
+    @full_stats.mean.should == 2.0
+  end
+
+  it "calculates the rate correctly" do
+    @full_stats.rate.should == 0.5
+  end
+
+  it "tracks the maximum value" do
+    @full_stats.max.should == 3.0
+  end
+
+  it "tracks the minimum value" do
+    @full_stats.min.should == 1.0
+  end
+
+  it "tracks the count" do
+    @full_stats.count.should == 3
+  end
+  
+  it "tracks the sum" do
+    @full_stats.sum.should == 6.0
+  end
+
+  it "calculates the standard deviation" do
+    @full_stats.stddev.should == 1.0
+  end 
+
+  it "calculates the sum of squares " do
+    @full_stats.sumsq.should == 14.0
+  end 
+
+  describe "#to_hash " do
+    it "converts to a Hash" do
+      h = @full_stats.to_hash
+      h.size.should == ::Hitimes::Stats::STATS.size
+      h.keys.sort.should == ::Hitimes::Stats::STATS
+    end
+
+    it "converts to a limited Hash if given arguments" do
+      h = @full_stats.to_hash( "min", "max", "mean" )
+      h.size.should == 3
+      h.keys.sort.should == %w[ max mean min  ]
+
+      h = @full_stats.to_hash( %w[ count rate ] )
+      h.size.should == 2
+      h.keys.sort.should == %w[ count rate ]
+    end
+
+    it "raises NoMethodError if an invalid stat is used" do
+      lambda { @full_stats.to_hash( "wibble" ) }.should raise_error( NoMethodError )
+    end
+  end
+
+  describe "#to_json" do
+    it "converts to a json string" do
+      j = @full_stats.to_json
+      h = JSON.parse( j )
+      h.size.should == ::Hitimes::Stats::STATS.size
+      h.keys.sort.should == ::Hitimes::Stats::STATS
+    end
+
+    it "converts to a limited Hash if given arguments" do
+      j = @full_stats.to_json( "min", "max", "mean" )
+      h = JSON.parse( j )
+      h.size.should == 3
+      h.keys.sort.should == %w[ max mean min  ]
+
+      j = @full_stats.to_json( %w[ count rate ] )
+      h = JSON.parse( j )
+      h.size.should == 2
+      h.keys.sort.should == %w[ count rate ]
+    end
+
+    it "raises NoMethodError if an invalid stat is used" do
+      lambda { @full_stats.to_json( "wibble" ) }.should raise_error( NoMethodError )
+    end
+  end
+end