hitimes 1.0.3-x86-mswin32-60 → 1.2.2-x86-mswin32-60

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx

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.md

@@ -0,0 +1,97 @@
+# Hitimes Changelog
+
+## Version 1.2.2 2014-07-09
+
+* fix compilation issue with clock_gettime in libc (reported by eradman and virtualfunction)
+* Switch to minispec for tests
+
+## Version 1.2.1 2013-03-12
+
+* Update dependencies
+* Ruby 2.0 fixes
+* Switch to Markdown, Yeah RDoc 4.0!
+
+## 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
+
+## Version 1.1.0 2010-07-28
+
+* Add a pure java extension so hitimes may be used in jruby with the same API
+
+## Version 1.0.5 2010-07-20
+
+* Fix 'circular require considered harmful' warnings in 1.9.x (reported by Roger Pack)
+* Fix 'method redefined' warnings in 1.9.x (reported by Roger Pack)
+
+## Version 1.0.4 2009-08-01
+
+* Add in support for x86-mingw32 gem
+* Add version subdirectory for extension on all platforms
+
+## Version 1.0.3 2009-06-28
+
+* Fix bug with time.h on linode (reported by Roger Pack) 
+* Fix potential garbage collection issue with Interval class
+* Windows gem is now a fat binary to support installing in 1.8 or 1.9 from the
+  same gem
+
+## Version 1.0.1 2009-06-12
+
+* Fix examples
+* performance tuning, new Hitimes::Metric derived classes are faster than old Timer class
+
+## Version 1.0.0 2009-06-12
+
+* Major version bump with complete refactor of the metric collection API
+* 3 types of metrics now instead of just 1 Timer
+    * Hitimes::ValueMetric
+    * Hitimes::TimedMetric
+    * Hitimes::TimedValueMetric
+* The ability to convert all metrics #to_hash
+* Updated documentation with examples using each metric type
+
+## 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'
+* Added new stat method to_hash
+* Added Hitimes::MutexedStats class for threadsafe stats collection 
+    - not needed when used in MRI 1.8.x
+* remove stale dependency on mkrf
+
+## Version 0.3.0
+
+* switched to extconf for building extensions
+* first release of windows binary gem
+* reverted back to normal rdoc
+
+## Version 0.2.1
+
+* added Timer#rate method
+* switched to darkfish rdoc
+
+## Version 0.2.0
+
+* Performance improvements
+* Added Hitimes::Stats class
+
+## Version 0.1.0
+
+* Initial completion

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,45 @@
+.travis.yml
+CONTRIBUTING.md
+HISTORY.md
+LICENSE
+Manifest.txt
+README.md
+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.md

@@ -0,0 +1,163 @@
+## hitimes
+
+* [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`
+
+## INSTALL
+
+* `gem install hitimes`
+
+## DESCRIPTION
+
+Hitimes is a fast, high resolution timer library for recording
+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:
+
+* any system with the POSIX call `clock_gettime()`
+* 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
+using `Process.times`. 
+
+## SYNOPSIS
+
+### Interval
+
+Use Hitimes::Interval to calculate only the duration of a block of code
+
+``` ruby
+duration = Hitimes::Interval.measure do
+             # some operation ...
+           end
+
+puts duration
+```
+
+### TimedMetric
+
+Use a Hitimes::TimedMetric to calculate statistics about an iterative operation
+
+``` ruby
+timed_metric = Hitimes::TimedMetric.new('operation on items')
+```
+
+Explicitly use `start` and `stop`:
+
+``` ruby
+collection.each do |item|
+  timed_metric.start
+  # .. do something with item
+  timed_metric.stop
+end
+```
+
+Or use the block.  In TimedMetric the return value of +measure+ is the return
+value of the block
+
+``` ruby
+collection.each do |item|
+  result_of_do_something = timed_metric.measure { do_something( item ) }
+end
+```
+And then look at the stats
+
+``` ruby
+puts timed_metric.mean
+puts timed_metric.max
+puts timed_metric.min
+puts timed_metric.stddev
+puts timed_metric.rate
+```
+### ValueMetric 
+
+Use a Hitimes::ValueMetric to calculate statistics about measured samples
+
+``` ruby
+value_metric = Hitimes::ValueMetric.new( 'size of thing' )
+loop do
+  # ... do stuff changing sizes of 'thing'
+  value_metric.measure( thing.size )
+  # ... do other stuff that may change size of thing
+end
+
+puts value_metric.mean
+puts value_metric.max
+puts value_metric.min
+puts value_metric.stddev
+puts value_metric.rate
+```
+
+### TimedValueMetric
+
+Use a Hitimes::TimedValueMetric to calculate statistics about batches of samples
+
+``` ruby
+timed_value_metric = Hitimes::TimedValueMetric.new( 'batch times' )
+loop do 
+  batch = ... # get a batch of things
+  timed_value_metric.start
+  # .. do something with batch
+  timed_value_metric.stop( batch.size )
+end
+
+puts timed_value_metric.rate
+
+puts timed_value_metric.timed_stats.mean
+puts timed_value_metric.timed_stats.max
+puts timed_value_metric.timed_stats.min
+puts timed_value_metric.timed_stats.stddev
+
+puts timed_value_metric.value_stats.mean
+puts timed_value_metric.value_stats.max
+puts timed_value_metric.value_stats.min
+puts timed_value_metric.value_stats.stddev
+```
+
+## CHANGES
+
+Read the HISTORY.md 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 2.0.0@hitimes
+% rake-compiler cross-ruby VERSION=2.0.0-p0 # or latest
+% 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:2.0.0
+```
+
+## CREDITS
+
+* [Bruce Williams](https://github.com/bruce) for suggesting the idea
+
+## ISC License
+
+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.

data/Rakefile

@@ -1,66 +1,27 @@
-#--
-# 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.4')
+  spec.add_development_dependency( 'minitest'     , '~> 5.5' )
+  spec.add_development_dependency( 'rdoc'         , '~> 4.2'  )
+  spec.add_development_dependency( 'json'         , '~> 1.8' )
+  spec.add_development_dependency( 'rake-compiler', '~> 0.9' )
+  spec.add_development_dependency( 'simplecov'    , '~> 0.9' )
+
+  spec.extensions.concat This.extension_conf_files
+  spec.license = "ISC"
 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
+  spec.files << "lib/hitimes/hitimes.jar"
 end
 
+load 'tasks/default.rake'
+load 'tasks/extension.rake'