hitimes 0.2.0 → 0.2.1

data/HISTORY

@@ -1,4 +1,10 @@
 = Changelog
+
+== Version 0.2.1
+
+* added Timer#rate method
+* switched to darkfish rdoc
+
 == Version 0.2.0
 
 * Performance improvements

data/README

@@ -47,6 +47,11 @@ Use a Hitimes::Timer to calculate statistics about an iterative operation
   puts timer.min
   puts timer.stddev
 
+
+== CHANGES
+
+Read the HISTORY file.
+
 == CREDITS
 
 * Bruce Williams for suggesting the idea

data/ext/hitimes_stats.c

@@ -86,6 +86,29 @@ VALUE hitimes_stats_mean( VALUE self )
     return rb_float_new( mean );
 }
 
+
+/**
+ * call-seq:
+ *    stat.rate -> Float
+ * 
+ * Return the count per seconds ( rate ) rate stat.  If no values have passed
+ * through the stats object then 0.0 is returned.
+ */
+VALUE hitimes_stats_rate( VALUE self )
+{
+    hitimes_stats_t *stats;
+    double           rate = 0.0;
+
+    Data_Get_Struct( self, hitimes_stats_t, stats );
+
+    if ( stats->sum > 0.0 ) {
+      rate = stats->count / stats->sum;
+    }
+
+    return rb_float_new( rate );
+}
+
+
 /**
  * call-seq:
  *    stat.max -> Float
@@ -208,6 +231,7 @@ void Init_hitimes_stats()
 
     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, "max", hitimes_stats_max, 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 */

data/lib/hitimes/timer.rb

@@ -170,6 +170,16 @@ module Hitimes
       stats.mean
     end
 
+    #
+    # :call-seq:
+    #   timer.rate -> Float
+    #
+    # Return the rate of the states, which is the count / duration
+    #
+    def rate
+      stats.rate
+    end
+
     #
     # :call-seq:
     #   timer.stddev -> Float

data/lib/hitimes/version.rb

@@ -11,7 +11,7 @@ module Hitimes
 
     MAJOR   = 0
     MINOR   = 2
-    BUILD   = 0
+    BUILD   = 1
 
     # 
     # :call-seq:

data/spec/stats_spec.rb

@@ -21,6 +21,10 @@ describe Hitimes::Stats 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

data/spec/timer_spec.rb

@@ -50,6 +50,13 @@ describe Hitimes::Timer do
     t.mean.should > 0.04
   end
 
+  it "calculates the rate of the counts " do
+    t = Hitimes::Timer.new
+    5.times { t.start ; sleep 0.05 ; t.stop }
+    t.rate.should > 19.0
+  end
+
+
   it "calculates the stddev of the durations" do
     t = Hitimes::Timer.new
     2.times { t.start ; sleep 0.05 ; t.stop }

data/tasks/announce.rake

@@ -16,6 +16,8 @@ namespace :announce do
       mail.puts "Subject: [ANN] #{info[:subject]}"
       mail.puts
       mail.puts info[:title]
+      mail.puts 
+      mail.puts "  gem install #{Hitimes::GEM_SPEC.name}"
       mail.puts
       mail.puts info[:urls]
       mail.puts 
@@ -25,7 +27,6 @@ namespace :announce do
       mail.puts 
       mail.puts info[:release_notes]
       mail.puts
-      mail.puts info[:urls]
     end 
     puts "Created the following as email.txt:"
     puts "-" * 72

data/tasks/config.rb

@@ -83,7 +83,7 @@ Configuration.for('rdoc') {
   files       Configuration.for('packaging').files.rdoc
   main_page   files.first
   title       Configuration.for('project').name
-  options     %w[ --line-numbers --inline-source ]
+  options     %w[ --line-numbers --inline-source -f darkfish ]
   output_dir  "doc"
 }
 

data/tasks/documentation.rake

@@ -9,6 +9,8 @@ if rdoc_config = Configuration.for_if_exist?('rdoc') then
   namespace :doc do
 
     require 'rake/rdoctask'
+    gem 'darkfish-rdoc'
+    require 'darkfish-rdoc'
 
     # generating documentation locally
     Rake::RDocTask.new do |rdoc|

data/tasks/rubyforge.rake

@@ -42,6 +42,7 @@ if rf_conf = Configuration.for_if_exist?("rubyforge") then
     task :rubyforge do
       info = Utils.announcement
       rubyforge = RubyForge.new
+      rubyforge.configure
       rubyforge.login
       rubyforge.post_news(rf_conf.project, info[:subject], "#{info[:title]}\n\n#{info[:urls]}\n\n#{info[:release_notes]}")
       puts "Posted to rubyforge"

data/tasks/utils.rb

@@ -54,7 +54,7 @@ module Utils
     #
     def release_notes_from(history_file)
       releases = {}
-      File.read(history_file).split(/^(?==)/).each do |section|
+      File.read(history_file).split(/^(?=== Version)/).each do |section|
         lines = section.split("\n")
         md = %r{Version ((\w+\.)+\w+)}.match(lines.first)
         next unless md

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hitimes
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jeremy Hinegardner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-14 00:00:00 -06:00
+date: 2008-09-28 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,6 +103,8 @@ post_install_message:
 rdoc_options: 
 - --line-numbers
 - --inline-source
+- -f
+- darkfish
 - --main
 - README
 require_paths: