hitimes 0.3.0-x86-mswin32-60

data/lib/hitimes/version.rb

@@ -0,0 +1,42 @@
+#--
+# 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   = 0
+    MINOR   = 3
+    BUILD   = 0
+
+    # 
+    # :call-seq:
+    #   Version.to_a -> [ MAJOR, MINOR, BUILD ]
+    #
+    # Return the version as an array of Integers
+    #
+    def to_a 
+      [MAJOR, MINOR, BUILD]
+    end
+
+    #
+    # :call-seq:
+    #   Version.to_s -> MAJOR.MINOR.BUILD
+    #
+    # Return the version as a String with dotted notation
+    #
+    def to_s
+      to_a.join(".")
+    end
+
+    module_function :to_a
+    module_function :to_s
+
+    STRING = Version.to_s
+  end
+  VERSION = Version.to_s
+end

data/spec/interval_spec.rb

@@ -0,0 +1,115 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes_ext'
+
+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 "only calculates duration once after stop is called" do
+    i = Hitimes::Interval.new
+    i.start
+    i.stop
+    x = i.duration
+    y = i.duration
+    x.object_id.should == y.object_id
+  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/paths_spec.rb

@@ -0,0 +1,14 @@
+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,6 @@
+require 'rubygems'
+require 'spec'
+
+$: << File.expand_path(File.join(File.dirname(__FILE__),"..","ext"))
+$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+

data/spec/stats_spec.rb

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

data/spec/timer_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'hitimes/timer'
+
+describe Hitimes::Timer do
+
+  it "knows if it is running or not" do
+    t = Hitimes::Timer.new
+    t.should_not be_running
+    t.start
+    t.should be_running
+    t.stop
+    t.should_not be_running
+  end
+
+  it "#split returns the last duration and the timer is still running" do
+    t = Hitimes::Timer.now
+    d = t.split
+    t.should be_running
+    d.should > 0
+    t.count.should == 1
+    t.duration.should == d
+  end
+
+  it "#stop returns false if called more than once in a row" do
+    t = Hitimes::Timer.new
+    t.start
+    t.stop.should > 0
+    t.stop.should == false
+  end
+
+  it "does not count a currently running interval as an interval in calculations" do
+    t = Hitimes::Timer.new
+    t.start
+    t.count.should == 0
+    t.split
+    t.count.should == 1
+  end
+
+  it "#split called on a stopped timer does nothing" do
+    t = Hitimes::Timer.new
+    t.start
+    t.stop
+    t.split.should == false
+  end
+
+  it "calculates the mean of the durations" do
+    t = Hitimes::Timer.new
+    2.times { t.start ; sleep 0.05 ; t.stop }
+    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 }
+    t.stddev.should > 0.0
+  end
+
+  it "returns 0.0 for stddev if there is no data" do
+    t = Hitimes::Timer.new
+    t.stddev.should == 0.0
+  end
+
+  it "retuns 0.0 for mean if there is no data" do
+    Hitimes::Timer.new.mean.should == 0.0
+  end
+
+  it "keeps track of the min value" do
+    t = Hitimes::Timer.new
+    2.times { t.start ; sleep 0.05 ; t.stop }
+    t.min.should > 0
+  end
+
+  it "keeps track of the max value" do
+    t = Hitimes::Timer.new
+    2.times { t.start ; sleep 0.05 ; t.stop }
+    t.max.should > 0
+  end
+
+  it "can create an already running timer" do
+    t = Hitimes::Timer.now
+    t.should be_running
+  end
+
+  it "can measure a block of code's execution time" do
+    dur = Hitimes::Timer.measure { sleep 0.05 }
+    dur.should > 0.025
+  end
+
+  it "can measuer a block of code from an instance" do
+    t = Hitimes::Timer.new
+    3.times { t.measure { sleep 0.05 } }
+    t.duration.should > 0.14
+    t.count.should == 3
+  end
+
+end
+

data/spec/version_spec.rb

@@ -0,0 +1,27 @@
+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 be accessable as a constant" do
+        Hitimes::VERSION.should match(/\d+\.\d+\.\d+/)
+    end 
+end

data/tasks/announce.rake

@@ -0,0 +1,39 @@
+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 "  gem install #{Hitimes::GEM_SPEC.name}"
+      mail.puts
+      mail.puts info[:urls]
+      mail.puts 
+      mail.puts info[:description]
+      mail.puts 
+      mail.puts "{{ Release notes for Version #{Hitimes::VERSION} }}"
+      mail.puts 
+      mail.puts info[:release_notes]
+      mail.puts
+    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,107 @@
+require 'configuration'
+
+require 'rake'
+require 'tasks/utils'
+
+#-----------------------------------------------------------------------
+# 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/*.{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
+    gem 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 --inline-source ]#-f darkfish ]
+  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)) }
+}
+
+#-----------------------------------------------------------------------
+# Rubyforge 
+#-----------------------------------------------------------------------
+Configuration.for('rubyforge') {
+  project       "copiousfreetime"
+  user          "jjh"
+  host          "rubyforge.org"
+  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}/hitimes"
+}
+
+