hitimes 0.3.0 → 0.4.0

data/HISTORY

@@ -1,4 +1,11 @@
 = Changelog
+== Version 0.4.0 2008-12-20
+
+* Added new stat 'rate'
+* Added new stat method to_hash
+* Added MutexedStats class for threadsafe stats collection 
+  - not needed when used in MRI 1.8.x
+* remove stale dependency on mkrf
 
 == Version 0.3.0
 

data/README

@@ -11,16 +11,16 @@
 
 == DESCRIPTION
 
-Hitimes is a fast, high resolution timer library for recording performance
-metrics.  It uses the appropriate C method calls for each system to get the
-highest granularity time increments possible.  
+Hitimes is a fast, high resolution timer library for recording
+performance metrics.  It uses the appropriate C method calls for each
+system to get the highest granularity time increments possible.  
 
-It currently supports any system with the POSIX call clock_gettime() and OSX.
-Windows is in the works.
+It currently supports any system with the POSIX call clock_gettime(),
+Mac OS X and Windows.
 
-Using Hitimes can be faster than using a series of Time.new calls, and it will
-have a much higher granularity.   It is definitely faster than using
-Process.times. 
+Using Hitimes can be faster than using a series of Time.new calls, and
+it will have a much higher granularity.   It is definitely faster than
+using Process.times. 
 
 == SYNOPSIS
 
@@ -46,6 +46,7 @@ Use a Hitimes::Timer to calculate statistics about an iterative operation
   puts timer.max
   puts timer.min
   puts timer.stddev
+  puts timer.rate
 
 
 == CHANGES

data/ext/extconf.rb

@@ -2,7 +2,7 @@ require 'rbconfig'
 require 'mkmf'
 
 if Config::CONFIG['host_os'] =~ /darwin/ then
-  $CFLAGS += " -DUSE_INSTANT_OSX=1"
+  $CFLAGS += " -DUSE_INSTANT_OSX=1 -Wall"
   $LDFLAGS += " -framework CoreServices"
 elsif Config::CONFIG['host_os'] =~ /win32/ or Config::CONFIG['host_os'] =~ /mingw/ then
   $CFLAGS += " -DUSE_INSTANT_WINDOWS=1"

data/ext/hitimes_ext.c

@@ -1,4 +1,5 @@
 #include <ruby.h>
+#include "hitimes_interval.h"
 
 /* Module and Classes */
 VALUE mH;           /* module Hitimes            */

data/ext/hitimes_stats.c

@@ -217,7 +217,7 @@ VALUE hitimes_stats_stddev ( VALUE self )
  *        end
  *     end
  *
- *     %w[ count min max mean sum stddev ].each do |m|
+ *     %w[ count min max mean sum stddev rate ].each do |m|
  *       puts "#{m.rjust(6)} : #{s.send( m ) }"
  *     end
  */
@@ -230,11 +230,12 @@ void Init_hitimes_stats()
     rb_define_alloc_func( cH_Stats, hitimes_stats_alloc );
 
     rb_define_method( cH_Stats, "update", hitimes_stats_update, 1 ); /* in hitimes_stats.c */
-    rb_define_method( cH_Stats, "mean", hitimes_stats_mean, 0 ); /* in hitimes_stats.c */
-    rb_define_method( cH_Stats, "rate", hitimes_stats_rate, 0 ); /* in hitimes_stats.c */
+    
+    rb_define_method( cH_Stats, "count", hitimes_stats_count, 0 ); /* in hitimes_stats.c */
     rb_define_method( cH_Stats, "max", hitimes_stats_max, 0 ); /* in hitimes_stats.c */
+    rb_define_method( cH_Stats, "mean", hitimes_stats_mean, 0 ); /* in hitimes_stats.c */
     rb_define_method( cH_Stats, "min", hitimes_stats_min, 0 ); /* in hitimes_stats.c */
-    rb_define_method( cH_Stats, "count", hitimes_stats_count, 0 ); /* in hitimes_stats.c */
+    rb_define_method( cH_Stats, "rate", hitimes_stats_rate, 0 ); /* in hitimes_stats.c */
     rb_define_method( cH_Stats, "sum", hitimes_stats_sum, 0 ); /* in hitimes_stats.c */
     rb_define_method( cH_Stats, "stddev", hitimes_stats_stddev, 0 ); /* in hitimes_stats.c */
 }

data/ext/rbconfig-mingw.rb

@@ -111,7 +111,7 @@ module Config
   CONFIG["STRIP"] = "strip"
   CONFIG["EXTSTATIC"] = ""
   CONFIG["setup"] = "Setup"
-  CONFIG["MINIRUBY"] = "ruby -I/Users/jeremy/pkgs/ruby-1.8.6-p114 -rfake"
+  CONFIG["MINIRUBY"] = "ruby -I#{ENV['HOME']}/pkgs/ruby-1.8.6-p114 -rfake"
   CONFIG["PREP"] = "fake.rb"
   CONFIG["RUNRUBY"] = "$(MINIRUBY) -I`cd $(srcdir)/lib; pwd`"
   CONFIG["EXTOUT"] = ".ext"
@@ -142,7 +142,7 @@ module Config
   CONFIG["arch"] = "i386-mingw32"
   CONFIG["sitearch"] = "i386-msvcrt"
   CONFIG["sitedir"] = "$(prefix)/lib/ruby/site_ruby"
-  CONFIG["configure_args"] = " '--host=i386-mingw32' '--target=i386-mingw32' '--build=i686-darwin9.2.2' '--prefix=/Users/jeremy/ruby-mingw32' 'build_alias=i686-darwin9.2.2' 'host_alias=i386-mingw32' 'target_alias=i386-mingw32'"
+  CONFIG["configure_args"] = " '--host=i386-mingw32' '--target=i386-mingw32' '--build=i686-darwin9.2.2' '--prefix=#{ENV['HOME']}/ruby-mingw32' 'build_alias=i686-darwin9.2.2' 'host_alias=i386-mingw32' 'target_alias=i386-mingw32'"
   CONFIG["NROFF"] = "/usr/bin/nroff"
   CONFIG["MANTYPE"] = "doc"
   CONFIG["ruby_version"] = "$(MAJOR).$(MINOR)"

data/ext/rbconfig.rb

@@ -111,7 +111,7 @@ module Config
   CONFIG["STRIP"] = "strip"
   CONFIG["EXTSTATIC"] = ""
   CONFIG["setup"] = "Setup"
-  CONFIG["MINIRUBY"] = "ruby -I/Users/jeremy/pkgs/ruby-1.8.6-p114 -rfake"
+  CONFIG["MINIRUBY"] = "ruby -I#{ENV['HOME']}/pkgs/ruby-1.8.6-p114 -rfake"
   CONFIG["PREP"] = "fake.rb"
   CONFIG["RUNRUBY"] = "$(MINIRUBY) -I`cd $(srcdir)/lib; pwd`"
   CONFIG["EXTOUT"] = ".ext"
@@ -142,7 +142,7 @@ module Config
   CONFIG["arch"] = "i386-mingw32"
   CONFIG["sitearch"] = "i386-msvcrt"
   CONFIG["sitedir"] = "$(prefix)/lib/ruby/site_ruby"
-  CONFIG["configure_args"] = " '--host=i386-mingw32' '--target=i386-mingw32' '--build=i686-darwin9.2.2' '--prefix=/Users/jeremy/ruby-mingw32' 'build_alias=i686-darwin9.2.2' 'host_alias=i386-mingw32' 'target_alias=i386-mingw32'"
+  CONFIG["configure_args"] = " '--host=i386-mingw32' '--target=i386-mingw32' '--build=i686-darwin9.2.2' '--prefix=#{ENV['HOME']}/ruby-mingw32' 'build_alias=i686-darwin9.2.2' 'host_alias=i386-mingw32' 'target_alias=i386-mingw32'"
   CONFIG["NROFF"] = "/usr/bin/nroff"
   CONFIG["MANTYPE"] = "doc"
   CONFIG["ruby_version"] = "$(MAJOR).$(MINOR)"

data/gemspec.rb

@@ -22,7 +22,6 @@ Hitimes::GEM_SPEC = Gem::Specification.new do |spec|
   # add dependencies here
   spec.add_dependency("rake", ">= 0.8.1")
   spec.add_dependency("configuration", ">= 0.0.5")
-  spec.add_dependency("mkrf", ">= 0.2.3")
 
   if ext_conf = Configuration.for_if_exist?("extension") then
     spec.extensions <<  ext_conf.configs

data/lib/hitimes.rb

@@ -18,4 +18,7 @@ module Hitimes
 end
 require 'hitimes/paths'
 require 'hitimes/version'
+require 'hitimes/stats'
+require 'hitimes/mutexed_stats'
 require 'hitimes/timer'
+

data/lib/hitimes/mutexed_stats.rb

@@ -0,0 +1,23 @@
+require 'hitimes'
+require 'thread'
+
+module Hitimes
+  class MutexedStats < Stats
+    def initialize
+      @mutex = Mutex.new
+    end
+
+    # call-seq:
+    #   mutex_stat.update( val ) -> nil
+    # 
+    # Update the running stats with the new value in a threadsafe manner.
+    #
+    def update( value )
+      @mutex.synchronize do
+        super( value )
+      end
+    end
+  end
+end
+
+

data/lib/hitimes/stats.rb

@@ -0,0 +1,29 @@
+module Hitimes
+  class Stats
+    # A list of the available stats
+    STATS = %w[ count max mean min rate stddev sum ]
+
+    # 
+    # call-seq:
+    #   stat.to_hash   -> Hash
+    #   stat.to_hash( %w[ count max mean ]) -> Hash
+    #
+    # return a hash of the stats.  By default this returns a hash of all stats
+    # but passing in an array of items will limit the stats returned to only
+    # those in the Array. 
+    #
+    # If passed in an empty array or nil to to_hash then STATS is assumed to be
+    # the list of stats to return in the hash.
+    #
+    def to_hash( *args )
+      h = {}
+      args = [ args ].flatten
+      args = STATS if args.empty?
+      args.each do |meth|
+        h[meth] = self.send( meth )
+      end
+      return h
+    end
+
+  end
+end

data/lib/hitimes/version.rb

@@ -10,7 +10,7 @@ module Hitimes
   module Version
 
     MAJOR   = 0
-    MINOR   = 3
+    MINOR   = 4
     BUILD   = 0
 
     # 

data/spec/mutex_stats_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes_ext'
+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/stats_spec.rb

@@ -15,6 +15,7 @@ describe Hitimes::Stats do
     @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
@@ -45,4 +46,27 @@ describe Hitimes::Stats do
     @full_stats.stddev.should == 1.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
+
 end

data/tasks/config.rb

@@ -42,7 +42,7 @@ Configuration.for('packaging') {
   formats {
     tgz true
     zip true
-    gem Configuration::Table.has_key?('gem')
+    rubygem Configuration::Table.has_key?('gem')
   }
 }
 

data/tasks/rubyforge.rake

@@ -11,7 +11,7 @@ if rf_conf = Configuration.for_if_exist?("rubyforge") then
 
   namespace :dist do
     desc "Release files to rubyforge"
-    task :rubyforge => [:clean, :package] do
+    task :rubyforge => [:clean, :package, :package_win] do
 
       rubyforge = RubyForge.new
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hitimes
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Jeremy Hinegardner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-11 00:00:00 -06:00
+date: 2008-12-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,17 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.5
     version: 
-- !ruby/object:Gem::Dependency 
-  name: mkrf
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.2.3
-    version: 
-description: Hitimes is a fast, high resolution timer library for recording performance metrics.  It uses the appropriate C method calls for each system to get the highest granularity time increments possible.    It currently supports any system with the POSIX call clock_gettime() and OSX. Windows is in the works.  Using Hitimes can be faster than using a series of Time.new calls, and it will have a much higher granularity.   It is definitely faster than using Process.times.
+description: Hitimes is a fast, high resolution timer library for recording performance metrics.  It uses the appropriate C method calls for each system to get the highest granularity time increments possible.    It currently supports any system with the POSIX call clock_gettime(), Mac OS X and Windows.  Using Hitimes can be faster than using a series of Time.new calls, and it will have a much higher granularity.   It is definitely faster than using Process.times.
 email: jeremy@copiousfreetime.org
 executables: []
 
@@ -52,7 +42,9 @@ extra_rdoc_files:
 - README
 - HISTORY
 - LICENSE
+- lib/hitimes/mutexed_stats.rb
 - lib/hitimes/paths.rb
+- lib/hitimes/stats.rb
 - lib/hitimes/timer.rb
 - lib/hitimes/version.rb
 - lib/hitimes.rb
@@ -76,11 +68,14 @@ files:
 - ext/extconf.rb
 - ext/rbconfig-mingw.rb
 - ext/rbconfig.rb
+- lib/hitimes/mutexed_stats.rb
 - lib/hitimes/paths.rb
+- lib/hitimes/stats.rb
 - lib/hitimes/timer.rb
 - lib/hitimes/version.rb
 - lib/hitimes.rb
 - spec/interval_spec.rb
+- spec/mutex_stats_spec.rb
 - spec/paths_spec.rb
 - spec/spec_helper.rb
 - spec/stats_spec.rb
@@ -125,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: copiousfreetime
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Hitimes is a fast, high resolution timer library for recording performance metrics