hitimes 0.4.0 → 0.4.1

data/HISTORY

@@ -1,4 +1,9 @@
 = Changelog
+== Version 0.4.1 2009-02-19
+
+* change to ISC License
+* fix bug in compilation on gentoo
+
 == Version 0.4.0 2008-12-20
 
 * Added new stat 'rate'

data/LICENSE

@@ -1,19 +1,13 @@
 Copyright (c) 2008 Jeremy Hinegardner
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README

@@ -57,24 +57,18 @@ Read the HISTORY file.
 
 * Bruce Williams for suggesting the idea
 
-== MIT LICENSE
+== ISC License
 
 Copyright (c) 2008 Jeremy Hinegardner
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/ext/hitimes_instant_clock_gettime.c

@@ -3,6 +3,11 @@
 #include "hitimes_interval.h"
 
 #include <sys/time.h>
+#ifndef CLOCK_MONOTONIC
+# ifdef __linux__
+#    include <linux/time.h>
+# endif
+#endif
 
 hitimes_instant_t hitimes_get_current_instant( )
 {

data/ext/hitimes_stats.c

@@ -91,8 +91,11 @@ VALUE hitimes_stats_mean( VALUE self )
  * 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.
+ * Return the count per sum.  In many cases when Stats#update( _value_ ) is
+ * called, the _value_ is a unit of time, typically seconds.  #rate 
+ * is a convenience for those times.  In the most common case, where _value_ 
+ * is in seconds, then #rate returns the count / second.
+ *
  */
 VALUE hitimes_stats_rate( VALUE self )
 {
@@ -203,7 +206,7 @@ VALUE hitimes_stats_stddev ( VALUE self )
  * modeled after the RFuzz::Sampler class, but implemented in C.  For general use
  * you allocate a new Stats object, and then update it with new values.  The
  * Stats object will keep track of the _min_, _max_, _count_ and _sum_ and when
- * you want you may also retrieve the _mean_ and _stddev_.
+ * you want you may also retrieve the _mean_, _stddev_ and _rate_.
  *
  * this contrived example shows getting a list of all the files in a directory
  * and running stats on file sizes.

data/lib/hitimes/mutexed_stats.rb

@@ -2,6 +2,11 @@ require 'hitimes'
 require 'thread'
 
 module Hitimes
+  #
+  # MutexedStats is the start of a threadsafe Stats class.  Currently, on MRI
+  # Ruby the Stats object is already threadsafe, so there is no need to use
+  # MutexedStats.
+  #
   class MutexedStats < Stats
     def initialize
       @mutex = Mutex.new

data/lib/hitimes/paths.rb

@@ -17,12 +17,11 @@ module Hitimes
     # is guaranteed.
     #   
     def self.root_dir
-      unless @root_dir
+      @root_dir ||=(
         path_parts = ::File.expand_path(__FILE__).split(::File::SEPARATOR)
         lib_index  = path_parts.rindex("lib")
         @root_dir = path_parts[0...lib_index].join(::File::SEPARATOR) + ::File::SEPARATOR
-      end 
-      return @root_dir
+      )
     end 
 
     # 

data/lib/hitimes/version.rb

@@ -11,15 +11,15 @@ module Hitimes
 
     MAJOR   = 0
     MINOR   = 4
-    BUILD   = 0
+    BUILD   = 1
 
-    # 
+    #
     # :call-seq:
     #   Version.to_a -> [ MAJOR, MINOR, BUILD ]
     #
     # Return the version as an array of Integers
     #
-    def to_a 
+    def to_a
       [MAJOR, MINOR, BUILD]
     end
 

data/spec/paths_spec.rb

@@ -10,5 +10,4 @@ describe Hitimes::Paths do
   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/tasks/config.rb

@@ -62,7 +62,7 @@ Configuration.for('test') {
   mode      "spec"
   files     Configuration.for("packaging").files.test
   options   %w[ --format specdoc --color ]
-  ruby_opts %w[ ]
+  ruby_opts %w[  ]
 }
 
 #-----------------------------------------------------------------------
@@ -72,7 +72,7 @@ Configuration.for('rcov') {
   output_dir  "coverage"
   libs        %w[ lib ]
   rcov_opts   %w[ --html ]
-  ruby_opts   %w[ ]
+  ruby_opts   %w[  ]
   test_files  Configuration.for('packaging').files.test
 }
 

data/tasks/documentation.rake

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hitimes
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Jeremy Hinegardner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-20 00:00:00 -07:00
+date: 2009-02-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency