hitimes 1.1.1 → 1.2.0

data/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Hi there!
+
+I see you are interested in contributing. That is wonderful. I love
+contributions.
+
+I guarantee that there are bugs in this software. And I guarantee that there is
+a feature you want that is not in here yet. As such, any and all bugs reports
+are gratefully accepted, bugfixes even more so. Helping out with bugs is the
+easiest way to contribute.
+
+
+## The Quick Version
+
+* Have a [GitHub Account][].
+* Search the [GitHub Issues][] and see if your issue already present. If so
+  add your comments, :thumbsup:, etc.
+* Issue not there? Not a problem, open up a [new issue][].
+    * **Bug reports** please be as detailed as possible. Include:
+        * full ruby engine and version: `ruby -e 'puts RUBY_DESCRIPTION'`
+        * operating system and version
+        * version of hitimes `ruby -rubygems -e "require 'hitimes'; puts Hitimes::VERSION"`
+        * as much detail about the bug as possible so I can replicated it. Feel free
+          to link in a [gist][]
+    * **New Feature**
+        * What the new feature should do.
+        * What benefit the new feature brings to the project.
+* Fork the [repo][].
+* Create a new branch for your issue: `git checkout -b issue/my-issue`
+* Lovingly craft your contribution:
+    * `rake develop` to get started, or if you prefer bundler `rake develop:using_bunder && bundle`.
+    * `rake test` to run tests
+* Make sure that `rake test` passes. Its important, I said it twice.
+* Add yourself to the contributors section below.
+* Submit your [pull request][].
+
+# Contributors
+
+* Jeremy Hinegardner
+
+[GitHub Account]: https://github.com/signup/free "GitHub Signup"
+[GitHub Issues]:  https://github.com/copiousfreetime/hitimes/issues "Hitimes Issues"
+[new issue]:      https://github.com/copiousfreetime/hitimes/issues/new "New Hitimes Issue"
+[gist]:           https://gist.github.com/ "New Gist"
+[repo]:           https://github.com/copiousfreetime/hitimes "hitimes Repo"
+[pull request]:   https://help.github.com/articles/using-pull-requests "Using Pull Requests"

data/{HISTORY → HISTORY.rdoc}

@@ -1,4 +1,17 @@
-= Changelog
+= Hitimes Changelog
+
+== Version 1.2.0 2013-02-09
+
+* Update dependencies
+* Documentation cleanup
+* Fix use of deprecated JRuby API in java extension
+* Fix use of deprecated OSX system calls in C extension
+* Make hitimes -w clean
+* Fix ambiguity of calling duration on non-started Interval
+* Use RbConfig instead of Config (eregon)
+* Added Hitimes.measure
+* Switch to using rake-compiler for cross compilation of gems
+
 == Version 1.1.1 2010-09-04
 
 * Remove the unnecessary dependencies that should be development dependencies

data/LICENSE

@@ -1,13 +1,16 @@
-Copyright (c) 2008 Jeremy Hinegardner
+ISC LICENSE - http://opensource.org/licenses/isc-license.txt
+
+Copyright (c) 2008-2012 Jeremy Hinegardner
 
 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.
+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/Manifest.txt

@@ -0,0 +1,44 @@
+CONTRIBUTING.md
+HISTORY.rdoc
+LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+examples/benchmarks.rb
+examples/stats.rb
+ext/hitimes/c/extconf.rb
+ext/hitimes/c/hitimes.c
+ext/hitimes/c/hitimes_instant_clock_gettime.c
+ext/hitimes/c/hitimes_instant_osx.c
+ext/hitimes/c/hitimes_instant_windows.c
+ext/hitimes/c/hitimes_interval.c
+ext/hitimes/c/hitimes_interval.h
+ext/hitimes/c/hitimes_stats.c
+ext/hitimes/c/hitimes_stats.h
+ext/hitimes/java/src/hitimes/Hitimes.java
+ext/hitimes/java/src/hitimes/HitimesInterval.java
+ext/hitimes/java/src/hitimes/HitimesService.java
+ext/hitimes/java/src/hitimes/HitimesStats.java
+lib/hitimes.rb
+lib/hitimes/metric.rb
+lib/hitimes/mutexed_stats.rb
+lib/hitimes/paths.rb
+lib/hitimes/stats.rb
+lib/hitimes/timed_metric.rb
+lib/hitimes/timed_value_metric.rb
+lib/hitimes/value_metric.rb
+lib/hitimes/version.rb
+spec/hitimes_spec.rb
+spec/interval_spec.rb
+spec/metric_spec.rb
+spec/mutex_stats_spec.rb
+spec/paths_spec.rb
+spec/spec_helper.rb
+spec/stats_spec.rb
+spec/timed_metric_spec.rb
+spec/timed_value_metric_spec.rb
+spec/value_metric_spec.rb
+spec/version_spec.rb
+tasks/default.rake
+tasks/extension.rake
+tasks/this.rb

data/{README → README.rdoc}

@@ -1,9 +1,9 @@
 == hitimes
 
-* Homepage[http://copiousfreetime.rubyforge.org/hitimes] 
-* {Rubyforge project}[http://rubyforge.org/projects/copiousfreetime/]
+* Homepage[http://github.com/copiousfreetime/hitimes]
+* {Github project}[http://github.com.org/copiousfreetime/hitimes]
 * email jeremy at copiousfreetime dot org
-* git clone url git://github.com/copiousfreetime/hitimes.git
+* `git clone url git://github.com/copiousfreetime/hitimes.git`
 
 == INSTALL
 
@@ -12,7 +12,7 @@
 == DESCRIPTION
 
 Hitimes is a fast, high resolution timer library for recording
-performance metrics.  It uses the appropriate C method calls for each
+performance metrics.  It uses the appropriate low method calls for each
 system to get the highest granularity time increments possible.  
 
 It currently supports any of the following systems:
@@ -20,6 +20,7 @@ It currently supports any of the following systems:
 * any system with the POSIX call <tt>clock_gettime()</tt>,
 * Mac OS X
 * Windows
+* JRuby
 
 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
@@ -35,7 +36,7 @@ Use Hitimes::Interval to calculate only the duration of a block of code
                # some operation ...
              end
 
-  puts duration   
+  puts duration
 
 === TimedMetric
 
@@ -113,13 +114,26 @@ Use a Hitimes::TimedValueMetric to calculate statistics about batches of samples
 
 Read the HISTORY file.
 
+== BUILDING FOR WINDOWS
+
+{rake-compiler}(https://github.com/luislavena/rake-compiler) is use for building
+the windows version. For me, on OSX to cross compile the process is:
+
+  % gem install rake-compiler # in each rvm instance, 1.8.7, 1.9.3
+  % rvm use 1.9.3@hitimes
+  % rake-compiler cross-ruby VERSION=1.9.3-p374 # or latest
+  % rvm use 1.8.7@hitimes
+  % rake-compiler cross-ruby VERSION=1.8.7-p371
+
+  # This only works via 1.8.7 at the current moment
+  % rake cross native gem RUBY_CC_VERSION=1.8.7:1.9.3
 == CREDITS
 
 * Bruce Williams for suggesting the idea
 
 == ISC License
 
-Copyright (c) 2008 Jeremy Hinegardner
+Copyright (c) 2008-2012 Jeremy Hinegardner
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

data/Rakefile

@@ -1,66 +1,24 @@
-#--
-# Copyright (c) 2008 Jeremy Hinegardner
-# All rights reserved.  See LICENSE and/or COPYING for details.
-#++
-
-#-------------------------------------------------------------------------------
-# make sure our project's top level directory and the lib directory are added to
-# the ruby search path.
-#-------------------------------------------------------------------------------
-$: << File.expand_path(File.join(File.dirname(__FILE__),"ext"))
-$: << File.expand_path(File.join(File.dirname(__FILE__),"lib"))
-$: << File.expand_path(File.dirname(__FILE__))
-
-
-#-------------------------------------------------------------------------------
-# load the global project configuration and add in the top level clean and
-# clobber tasks so that other tasks can utilize those constants if necessary
-# This loads up the defaults for the whole project configuration
-#-------------------------------------------------------------------------------
-require 'rubygems'
-require 'tasks/config.rb'
-require 'rake/clean'
-
-#-------------------------------------------------------------------------------
-# Main configuration for the project, these overwrite the items that are in
-# tasks/config.rb
-#-------------------------------------------------------------------------------
-require 'hitimes/version'
-require 'hitimes/paths'
-
-Configuration.for("project") {
-  name      "hitimes"
-  version   Hitimes::VERSION
-  author    "Jeremy Hinegardner"
-  email     "jeremy@copiousfreetime.org"
-  homepage  "http://copiousfreetime.rubyforge.org/hitimes/"
-}
-
-#-------------------------------------------------------------------------------
-# load up all the project tasks and setup the default task to be the
-# test:default task.
-#-------------------------------------------------------------------------------
-Configuration.for("packaging").files.tasks.each do |tasklib|
-  import tasklib
+# vim: syntax=ruby
+load 'tasks/this.rb'
+
+This.name     = "hitimes"
+This.author   = "Jeremy Hinegardner"
+This.email    = "jeremy@copiousfreetime.org"
+This.homepage = "http://github.com/copiousfreetime/#{ This.name }"
+
+This.ruby_gemspec do |spec|
+  spec.add_development_dependency( 'rake'         , '~> 10.0.3')
+  spec.add_development_dependency( 'rspec'        , '~> 2.12.0' )
+  spec.add_development_dependency( 'rdoc'         , '~> 3.12'   )
+  spec.add_development_dependency( 'json'         , '~> 1.7.6' )
+  spec.add_development_dependency( 'rake-compiler', '~> 0.8.1' )
+
+  spec.extensions.concat This.extension_conf_files
 end
-task :default => 'test:default'
 
-#-------------------------------------------------------------------------------
-# Finalize the loading of all pending imports and update the top level clobber
-# task to depend on all possible sub-level tasks that have a name like
-# ':clobber'  in other namespaces.  This allows us to say:
-#
-#   rake clobber
-#
-# and it will get everything.
-#-------------------------------------------------------------------------------
-Rake.application.load_imports
-Rake.application.tasks.each do |t| 
-  if t.name =~ /:clobber/ then
-    task :clobber => [t.name] 
-  end 
-  if t.name =~ /:clean/ then
-    task :clean => [t.name]
-  end
+This.java_gemspec( This.ruby_gemspec ) do |spec|
+  spec.extensions.clear
 end
 
+load 'tasks/default.rake'
+load 'tasks/extension.rake'

data/ext/hitimes/{extconf.rb → c/extconf.rb}

@@ -1,10 +1,10 @@
 require 'rbconfig'
 require 'mkmf'
 
-if Config::CONFIG['host_os'] =~ /darwin/ then
+if RbConfig::CONFIG['host_os'] =~ /darwin/ then
   $CFLAGS += " -DUSE_INSTANT_OSX=1 -Wall"
   $LDFLAGS += " -framework CoreServices"
-elsif Config::CONFIG['host_os'] =~ /win32/ or Config::CONFIG['host_os'] =~ /mingw/ then
+elsif RbConfig::CONFIG['host_os'] =~ /win32/ or RbConfig::CONFIG['host_os'] =~ /mingw/ then
   $CFLAGS += " -DUSE_INSTANT_WINDOWS=1"
 else
   if have_library("rt", "clock_gettime") then
@@ -14,4 +14,4 @@ end
 
 # put in a different location if on windows so we can have fat binaries
 subdir = RUBY_VERSION.gsub(/\.\d$/,'')
-create_makefile("hitimes/#{subdir}/hitimes_ext")
+create_makefile("hitimes/#{subdir}/hitimes")

data/ext/hitimes/{hitimes_ext.c → c/hitimes.c}

@@ -10,7 +10,7 @@ VALUE eH_Error;     /* class  Hitimes::Error     */
  *
  * General error class for the Hitimes module
  */
-void Init_hitimes_ext( )
+void Init_hitimes( )
 {
     mH = rb_define_module("Hitimes");
      

data/ext/hitimes/c/hitimes_instant_osx.c

@@ -0,0 +1,45 @@
+#ifdef USE_INSTANT_OSX
+
+#include "hitimes_interval.h"
+#include <mach/mach.h>
+#include <mach/mach_time.h>
+
+/* All this OSX code is adapted from http://developer.apple.com/library/mac/#qa/qa1398/_index.html */
+
+/*
+ * returns the conversion factor, this value is used to convert
+ * the value from hitimes_get_current_instant() into seconds
+ */
+long double hitimes_instant_conversion_factor()
+{
+    static mach_timebase_info_data_t  s_timebase_info;
+    static long double                conversion_factor;
+    static uint64_t                   nano_conversion;
+
+    /**
+     * If this is the first time we've run, get the timebase.
+     * We can use denom == 0 to indicate that s_timebase_info is
+     * uninitialised because it makes no sense to have a zero
+     * denominator is a fraction.
+     */
+
+    if ( s_timebase_info.denom == 0 ) {
+        mach_timebase_info(&s_timebase_info);
+        nano_conversion   = s_timebase_info.numer / s_timebase_info.denom;
+        conversion_factor = (long double) (nano_conversion) * (1e9l);
+    }
+
+    return conversion_factor;
+}
+
+/*
+ * returns the mach absolute time, which has no meaning outside of a conversion
+ * factor.
+ */
+hitimes_instant_t hitimes_get_current_instant()
+{
+    return mach_absolute_time();
+}
+
+
+#endif

data/ext/hitimes/{hitimes_interval.c → c/hitimes_interval.c}

@@ -39,7 +39,7 @@ VALUE hitimes_interval_alloc(VALUE klass)
  *
  * Create an interval that has already started
  */
-VALUE hitimes_interval_now( VALUE self )
+VALUE hitimes_interval_now( )
 {
     VALUE obj;
     hitimes_interval_t *i = xmalloc( sizeof( hitimes_interval_t ) );
@@ -59,7 +59,7 @@ VALUE hitimes_interval_now( VALUE self )
  *
  * Times the execution of the block returning the number of seconds it took
  */
-VALUE hitimes_interval_measure( VALUE self )
+VALUE hitimes_interval_measure( )
 {
     hitimes_instant_t before;
     hitimes_instant_t after;
@@ -68,7 +68,7 @@ VALUE hitimes_interval_measure( VALUE self )
     if ( !rb_block_given_p() ) {
         rb_raise(eH_Error, "No block given to Interval.measure" );
     }
-    
+
     before = hitimes_get_current_instant( );
     rb_yield( Qnil );
     after  = hitimes_get_current_instant( );
@@ -105,7 +105,7 @@ VALUE hitimes_interval_split( VALUE self )
 
 /**
  * call-seq:
- *    interval.start -> boolean 
+ *    interval.start -> boolean
  *
  * mark the start of the interval.  Calling start on an already started
  * interval has no effect.  An interval can only be started once.  If the
@@ -144,7 +144,7 @@ VALUE hitimes_interval_stop( VALUE self )
 
     Data_Get_Struct( self, hitimes_interval_t, i );
     if ( 0L == i->start_instant )  {
-        rb_raise(eH_Error, "Attempt to stop an interval that has not started.\n" );
+        rb_raise(eH_Error, "Attempt to stop an interval that has not started" );
     }
 
     if ( 0L == i->stop_instant ) {
@@ -281,6 +281,8 @@ VALUE hitimes_interval_stop_instant( VALUE self )
  * Returns the Float value of the interval, the value is in seconds.  If the
  * interval has not had stop called yet, it will report the number of seconds
  * in the interval up to the current point in time.
+ *
+ * Raises Error if duration is called on an interval that has not started yet.
  */
 VALUE hitimes_interval_duration ( VALUE self )
 {
@@ -288,7 +290,13 @@ VALUE hitimes_interval_duration ( VALUE self )
 
     Data_Get_Struct( self, hitimes_interval_t, i );
 
-    /** 
+    /* raise an error if the internval is not started */
+    if ( 0L == i->start_instant )  {
+        rb_raise(eH_Error, "Attempt to report a duration on an interval that has not started" );
+    }
+
+
+    /**
      * if stop has not yet been called, then return the amount of time so far
      */
     if ( 0L == i->stop_instant ) {
@@ -296,7 +304,7 @@ VALUE hitimes_interval_duration ( VALUE self )
         hitimes_instant_t now = hitimes_get_current_instant( );
         d = ( now - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
         return rb_float_new( d );
-    } 
+    }
 
     /*
      * stop has been called, calculate the duration and save the result

data/ext/hitimes/{hitimes_interval.h → c/hitimes_interval.h}

@@ -16,8 +16,8 @@
 #    define HITIMES_U64INT unsigned long long int
 #    define HITIMES_INSTANT_CONVERSION_FACTOR 1e9l
 #elif USE_INSTANT_OSX
-#    define HITIMES_U64INT unsigned long long int
-#    define HITIMES_INSTANT_CONVERSION_FACTOR 1e9l
+#    define HITIMES_U64INT uint64_t
+#    define HITIMES_INSTANT_CONVERSION_FACTOR hitimes_instant_conversion_factor()
 #elif USE_INSTANT_WINDOWS
 #    define HITIMES_U64INT unsigned __int64
 #    define HITIMES_INSTANT_CONVERSION_FACTOR hitimes_instant_conversion_factor()
@@ -37,7 +37,7 @@ typedef struct hitimes_interval {
     long double       duration;
 } hitimes_interval_t;
 
-/* all the backends must define this method */
+/* all the backends must define these methods */
 hitimes_instant_t hitimes_get_current_instant( );
 long double hitimes_instant_conversion_factor( );
 
@@ -58,8 +58,8 @@ extern VALUE cH_Interval;  /* class  Hitimes::Interval  */
 
 VALUE hitimes_interval_free(hitimes_interval_t* i) ;
 VALUE hitimes_interval_alloc(VALUE klass);
-VALUE hitimes_interval_now( VALUE self );
-VALUE hitimes_interval_measure( VALUE self );
+VALUE hitimes_interval_now( );
+VALUE hitimes_interval_measure( );
 VALUE hitimes_interval_split( VALUE self );
 VALUE hitimes_interval_start( VALUE self );
 VALUE hitimes_interval_stop( VALUE self );