hitimes 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67f73e078163efeb8791898a667d8ad447520cce
-  data.tar.gz: 234afc5cb57d3a3e2db68e72c809888ceab0c1d7
+  metadata.gz: 531b3a608c4a150a0d13e0312aeada44fdccb22e
+  data.tar.gz: adf7a50da04dde4b9d527da636ca4a19559071b2
 SHA512:
-  metadata.gz: 06b8f4f43947563014bd3b941da25181d6deb9a58cf6efcb915e327a326bb52828f4c6d5098e1008d521e001deafd5a7e476bc8174c45f8d6b273423a39aeb20
-  data.tar.gz: 1f9a2f236f9b6d98dce3822c36f3fba7f0c2844b21a509ec281d631cf605638f387ede6d10aebe595600b204cd7ac7c69d8292ec010423434486c58dc9712d9a
+  metadata.gz: 340a336031ea96199111ec0ec432aad9016db68f06280d34b80b49000af427dcad0f0b7d125c7b9999c4a3bea2207401cb1be899f210c74d2963e15b335a4be4
+  data.tar.gz: c133b362a5d5384a1b7dff9cb681e2d3ebf2a85aa47ff4a6e156cb2f9c94b6f505156b043e7351a1bb104ff5318e901c0dc32a6afa76d80f4527d9e416647038

data/CONTRIBUTING.md

@@ -27,15 +27,27 @@ easiest way to contribute.
 * 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 develop` to get started
     * `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][].
 
+## Building Windows Binaries
+
+This is done using https://github.com/rake-compiler/rake-compiler-dock
+
+1. have VirtualBox installed
+2. have Docker Machine installed (https://docs.docker.com/engine/installation/)
+3. `gem install rake-compiler-dock`
+4. `rake-compiler-dock` (this could take a while)
+5. `bundle`
+6. `rake cross native gem`
+
 # Contributors
 
 * Jeremy Hinegardner
+* Wojciech Piekutowski
 
 [GitHub Account]: https://github.com/signup/free "GitHub Signup"
 [GitHub Issues]:  https://github.com/copiousfreetime/hitimes/issues "Hitimes Issues"

data/HISTORY.md

@@ -1,5 +1,11 @@
 # Hitimes Changelog
 
+## Version 1.2.4 2016-05-01
+
+* Fix finding the extension on ruby 2.1.10 (thanks @wpiekutowski)
+* Add more readable load error (thanks @mbautin)
+* Update README with what versions of ruby are supported.
+
 ## Version 1.2.3 2015-09-13
 
 * Release new fatbinary version for windows

data/README.md

@@ -1,39 +1,52 @@
-## hitimes
+# Hitimes
+
+A fast, high resolution timer library for recording peformance metrics.
 
 * [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
+## Table of Contents
 
-* `gem install hitimes`
+* [Requirements](#requirements)
+* [Usage](#usage)
+* [Contributing](#contributing)
+* [Support](#support)
+* [License](#license)
 
-## DESCRIPTION
+## Requirements
 
-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.
+Hitimes requires the following to run:
 
-It currently supports any of the following systems:
+  * Ruby
 
-* any system with the POSIX call `clock_gettime()`
-* Mac OS X
-* Windows
-* JRuby
+## Usage
+
+Hitimes easiest to use when installed with `rubygems`:
+
+```sh
+gem install hitimes
+```
+
+Or as part of your bundler `Gemfile`:
+
+```ruby
+gem 'hitimes'
+```
 
-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`. 
+You can load it with the standard ruby require statement.
 
-## SYNOPSIS
+```ruby
+require 'hitimes'
+```
 
 ### Interval
 
-Use Hitimes::Interval to calculate only the duration of a block of code. Returns
-the time as seconds.
+Use `Hitimes::Interval` to calculate only the duration of a block of code.
+Returns the time as seconds.
 
-``` ruby
+```ruby
 duration = Hitimes::Interval.measure do
              1_000_000.times do |x|
                2 + 2
@@ -45,15 +58,15 @@ puts duration  # => 0.047414297 (seconds)
 
 ### TimedMetric
 
-Use a Hitimes::TimedMetric to calculate statistics about an iterative operation
+Use a `Hitimes::TimedMetric` to calculate statistics about an iterative operation
 
-``` ruby
+```ruby
 timed_metric = Hitimes::TimedMetric.new('operation on items')
 ```
 
 Explicitly use `start` and `stop`:
 
-``` ruby
+```ruby
 collection.each do |item|
   timed_metric.start
   # .. do something with item
@@ -61,26 +74,26 @@ collection.each do |item|
 end
 ```
 
-Or use the block.  In TimedMetric the return value of +measure+ is the return
-value of the block
+Or use the block. In `TimedMetric` the return value of `measure` is the return
+value of the block.
 
-``` ruby
+```ruby
 collection.each do |item|
   result_of_do_something = timed_metric.measure { do_something( item ) }
 end
 ```
 And then look at the stats
 
-``` ruby
+```ruby
 puts timed_metric.mean
 puts timed_metric.max
 puts timed_metric.min
 puts timed_metric.stddev
 puts timed_metric.rate
 ```
-### ValueMetric 
+### ValueMetric
 
-Use a Hitimes::ValueMetric to calculate statistics about measured samples
+Use a `Hitimes::ValueMetric` to calculate statistics about measured samples.
 
 ``` ruby
 value_metric = Hitimes::ValueMetric.new( 'size of thing' )
@@ -99,7 +112,7 @@ puts value_metric.rate
 
 ### TimedValueMetric
 
-Use a Hitimes::TimedValueMetric to calculate statistics about batches of samples
+Use a `Hitimes::TimedValueMetric` to calculate statistics about batches of samples.
 
 ``` ruby
 timed_value_metric = Hitimes::TimedValueMetric.new( 'batch times' )
@@ -123,28 +136,51 @@ puts timed_value_metric.value_stats.min
 puts timed_value_metric.value_stats.stddev
 ```
 
-## CHANGES
+### Implementation details
 
-Read the HISTORY.md file.
+Hitimes use the appropriate low-level system call for each operating system to
+get the highest granularity time increment possible. Generally this is
+nanosecond resolution, or whatever the hardware chip in the CPU supports.
+
+It currently supports any of the following systems:
 
-## BUILDING FOR WINDOWS
+* any system with the POSIX call `clock_gettime()`
+* Mac OS X
+* Windows
+* JRuby
 
-This is done using https://github.com/rake-compiler/rake-compiler-dock
+## Support
 
-1. have VirtualBox installed
-2. Install boot2docker `brew install boot2docker`
-3. `gem install rake-compiler-dock`
-4. `rake-compiler-dock`
-5. `bundle`
-6 `rake cross native gem`
+Hitimes is supported on whatever versions of ruby are currently supported.
+Hitimes also follows [semantic versioning](http://semver.org/).
 
-## CREDITS
+The current officially supported versions of Ruby are:
+
+* MRI Ruby 2.2, 2.3
+* JRuby 1.7.25, 9.0.5.0
+
+Unofficially supported versions, they have been supported in the past when they
+were the primary rubies around. In all likelihood they still work, but are not
+supported.
+
+* MRI Ruby - everything from 1.8.7 to 2.1
+* JRuby - I think everything back to 1.4
+* Rubinius
+
+## Contributing
+
+Please read the [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## Credits
 
 * [Bruce Williams](https://github.com/bruce) for suggesting the idea
 
-## ISC License
+## License
+
+Hitimes is licensed under the [ISC](https://opensource.org/licenses/ISC)
+license.
 
-Copyright (c) 2008-2015 Jeremy Hinegardner
+Copyright (c) 2008-2016 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

@@ -12,6 +12,7 @@ This.ruby_gemspec do |spec|
   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( 'rake-compiler-dock', '~> 0.4' )
   spec.add_development_dependency( 'simplecov'    , '~> 0.9' )
 
   spec.extensions.concat This.extension_conf_files

data/ext/hitimes/c/extconf.rb

@@ -20,5 +20,5 @@ _
 end
 
 # put in a different location if on windows so we can have fat binaries
-subdir = RUBY_VERSION.gsub(/\.\d$/,'')
+subdir = RUBY_VERSION.gsub(/\.\d+$/,'')
 create_makefile("hitimes/#{subdir}/hitimes")

data/lib/hitimes.rb

@@ -31,19 +31,30 @@ require 'hitimes/version'
 # this is the method recommended by rake-compiler
 
 attempts = [
-  "hitimes/#{RUBY_VERSION.sub(/\.\d$/,'')}/hitimes",
+  "hitimes/#{RUBY_VERSION.sub(/\.\d+$/,'')}/hitimes",
   "hitimes/hitimes"
 ]
 loaded = false
 
+path_exceptions = []
 attempts.each do |path|
   begin
     require path
     loaded = true
-  rescue LoadError
+    break
+  rescue LoadError => load_error
+    full_path = File.expand_path(path)
+    path_exceptions << [ full_path, load_error.message ]
   end
 end
-raise LoadError, "Unable to find binary extension, was hitimes installed correctly?" unless loaded
+
+if !loaded then
+  msg = ["Unable to find binary extension, was hitimes installed correctly? The following paths were tried."]
+  path_exceptions.each do |path, message|
+    msg << "#{path} : #{message}"
+  end
+  raise LoadError, msg.join("\n")
+end
 
 require 'hitimes/stats'
 require 'hitimes/mutexed_stats'

data/lib/hitimes/version.rb

@@ -4,5 +4,5 @@
 #++
 
 module Hitimes
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/tasks/default.rake

@@ -29,7 +29,7 @@ namespace :develop do
     end
   end
 end
-desc "Boostrap development"
+desc "Bootstrap development"
 task :develop => "develop:default"
 
 #------------------------------------------------------------------------------

data/tasks/this.rb

@@ -180,7 +180,7 @@ class ThisProject
 
   # Internal: Return the DESCRIPTION section of the README.rdoc file
   def description_section
-    section_of( 'README.md', 'DESCRIPTION')
+    section_of( 'README.md', 'Hitimes')
   end
 
   # Internal: Return the summary text from the README

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hitimes
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Jeremy Hinegardner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler-dock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,12 +108,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-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`.'
+description: A fast, high resolution timer library for recording peformance metrics.
+  * (http://github.com/copiousfreetime/hitimes) * (http://github.com.org/copiousfreetime/hitimes)
+  * email jeremy at copiousfreetime dot org * `git clone url git://github.com/copiousfreetime/hitimes.git`
 email: jeremy@copiousfreetime.org
 executables: []
 extensions:
@@ -178,12 +189,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
-summary: 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.
+summary: A fast, high resolution timer library for recording peformance metrics.
 test_files:
 - spec/hitimes_spec.rb
 - spec/interval_spec.rb