hitimes 1.2.0-java → 1.2.1-java

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,6 +1,12 @@
-= Hitimes Changelog
+# Hitimes Changelog
 
-== Version 1.2.0 2013-02-09
+## 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
@@ -12,75 +18,75 @@
 * Added Hitimes.measure
 * Switch to using rake-compiler for cross compilation of gems
 
-== Version 1.1.1 2010-09-04
+## Version 1.1.1 2010-09-04
 
 * Remove the unnecessary dependencies that should be development dependencies
 
-== Version 1.1.0 2010-07-28
+## 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
+## 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
+## 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
+## 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
+## 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
+## 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
+    * 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
+## Version 0.4.1 2009-02-19
 
 * change to ISC License
 * fix bug in compilation on gentoo
 
-== Version 0.4.0 2008-12-20
+## 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
+    - not needed when used in MRI 1.8.x
 * remove stale dependency on mkrf
 
-== Version 0.3.0
+## 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
+## Version 0.2.1
 
 * added Timer#rate method
 * switched to darkfish rdoc
 
-== Version 0.2.0
+## Version 0.2.0
 
 * Performance improvements
 * Added Hitimes::Stats class
 
-== Version 0.1.0
+## Version 0.1.0
 
 * Initial completion

data/Manifest.txt

@@ -1,8 +1,8 @@
 CONTRIBUTING.md
-HISTORY.rdoc
+HISTORY.md
 LICENSE
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
 examples/benchmarks.rb
 examples/stats.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

@@ -8,10 +8,10 @@ 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.add_development_dependency( 'rspec'        , '~> 2.13.0' )
+  spec.add_development_dependency( 'rdoc'         , '~> 4.0'   )
+  spec.add_development_dependency( 'json'         , '~> 1.7.7' )
+  spec.add_development_dependency( 'rake-compiler', '~> 0.8.3' )
 
   spec.extensions.concat This.extension_conf_files
 end

data/lib/hitimes/version.rb

@@ -4,5 +4,5 @@
 #++
 
 module Hitimes
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/tasks/default.rake

@@ -74,9 +74,10 @@ begin
   RDoc::Task.new do |t|
     t.markup   = 'tomdoc'
     t.rdoc_dir = 'doc'
-    t.main     = 'README.rdoc'
+    t.main     = 'README.md'
     t.title    = "#{This.name} #{This.version}"
-    t.rdoc_files.include( '*.rdoc', 'lib/**/*.rb' )
+    t.rdoc_files.include( FileList['*.{rdoc,md,txt}'], FileList['ext/**/*.c'],
+                          FileList['lib/**/*.rb'] )
   end
 rescue LoadError => le
   This.task_warning( 'rdoc' )
@@ -228,6 +229,9 @@ end
 # the gemspec is also a dev artifact and should not be kept around.
 CLOBBER << This.gemspec_file.to_s
 
+# .rbc files from ruby 2.0
+CLOBBER << FileList["**/*.rbc"]
+
 # The standard gem packaging task, everyone has it.
 require 'rubygems/package_task'
 Gem::PackageTask.new( This.platform_gemspec ) do

data/tasks/extension.rake

@@ -35,4 +35,4 @@ rescue LoadError
 end
 
 CLOBBER << FileList["lib/**/*.{jar,so,bundle}"]
-CLOBBER << FileList["lib/#{This.name}/1.{8,9}/"]
+CLOBBER << FileList["lib/#{This.name}/{1.8,1.9,2.0}/"]

data/tasks/this.rb

@@ -54,7 +54,7 @@ class ThisProject
   #
   # Retuns the text of the section as an array of paragrphs.
   def section_of( file, section_name )
-    re    = /^=+ (.*)$/
+    re    = /^[=#]+ (.*)$/
     sectional = project_path( file )
     parts = sectional.read.split( re )[1..-1]
     parts.map! { |p| p.strip }
@@ -137,8 +137,8 @@ class ThisProject
       spec.executables = spec.files.grep(/^bin/) { |f| File.basename(f) }
       spec.test_files  = spec.files.grep(/^spec/)
 
-      spec.extra_rdoc_files += spec.files.grep(/(txt|rdoc)$/)
-      spec.rdoc_options = [ "--main"  , 'README.rdoc',
+      spec.extra_rdoc_files += spec.files.grep(/(txt|rdoc|md)$/)
+      spec.rdoc_options = [ "--main"  , 'README.md',
                             "--markup", "tomdoc" ]
     end
   end
@@ -187,7 +187,7 @@ class ThisProject
 
   # Internal: Return the DESCRIPTION section of the README.rdoc file
   def description_section
-    section_of( 'README.rdoc', 'DESCRIPTION')
+    section_of( 'README.md', 'DESCRIPTION')
   end
  
  # Internal: Return the summary text from the README 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hitimes
 version: !ruby/object:Gem::Version
+  version: 1.2.1
   prerelease:
-  version: 1.2.0
 platform: java
 authors:
 - Jeremy Hinegardner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-02-09 00:00:00.000000000 Z
+date: 2013-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -33,13 +33,13 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
     none: false
   prerelease: false
   type: :development
@@ -49,13 +49,13 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '4.0'
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '4.0'
     none: false
   prerelease: false
   type: :development
@@ -65,13 +65,13 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: 1.7.7
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: 1.7.7
     none: false
   prerelease: false
   type: :development
@@ -81,36 +81,36 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.3
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.3
     none: false
   prerelease: false
   type: :development
 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 <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 using
-  +Process.times+.'
+  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`.'
 email: jeremy@copiousfreetime.org
 executables: []
 extensions: []
 extra_rdoc_files:
-- HISTORY.rdoc
+- CONTRIBUTING.md
+- HISTORY.md
 - Manifest.txt
-- README.rdoc
+- README.md
 files:
 - CONTRIBUTING.md
-- HISTORY.rdoc
+- HISTORY.md
 - LICENSE
 - Manifest.txt
-- README.rdoc
+- README.md
 - Rakefile
 - examples/benchmarks.rb
 - examples/stats.rb
@@ -156,7 +156,7 @@ licenses: []
 post_install_message:
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
 - "--markup"
 - tomdoc
 require_paths:

data/README.rdoc

@@ -1,148 +0,0 @@
-== 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 <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
-using +Process.times+. 
-
-== SYNOPSIS
-
-=== Interval
-
-Use Hitimes::Interval to calculate only the duration of a block of code
-
-  duration = Hitimes::Interval.measure do
-               # some operation ...
-             end
-
-  puts duration
-
-=== TimedMetric
-
-Use a Hitimes::TimedMetric to calculate statistics about an iterative operation
-
-  timed_metric = Hitimes::TimedMetric.new('operation on items')
-
-Explicitly use +start+ and +stop+:
-
-  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
-
-  collection.each do |item|
-    result_of_do_something = timed_metric.measure { do_something( item ) }
-  end
-
-And then look at the stats
-
-  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
-
-  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
-
-  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 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-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.