hitimes 2.0.0 → 3.0.0

data/lib/hitimes/value_metric.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2008, 2009 Jeremy Hinegardner
 # All rights reserved.  See LICENSE and/or COPYING for details.
 #++
 
-require 'forwardable'
+require "forwardable"
 module Hitimes
   #
   # A ValueMetric holds the data from measuring a single value over a period of
@@ -12,15 +14,14 @@ module Hitimes
   #
   # A good example of a ValueMetric is measuring the number of items in a queue.
   #
-  # A ValueMetric contains a Stats object, therefore ValueMetric has +count+, +max+, 
+  # A ValueMetric contains a Stats object, therefore ValueMetric has +count+, +max+,
   # +mean+, +min+, +stddev+, +sum+, +sumsq+ methods that delegate to that Stats
   # object for convenience.
   #
   class ValueMetric < Metric
-
     # holds all the statistics
     attr_reader :stats
-    
+
     #
     # :call-seq:
     #   ValueMetric.new( 'my_metric' ) -> ValueMetric
@@ -29,8 +30,8 @@ module Hitimes
     # Create a new ValueMetric giving it a name and additional data.
     # +additional_data+ may be anything that follows the +to_hash+ protocol.
     #
-    def initialize( name, additional_data = {} )
-      super( name, additional_data )
+    def initialize(name, additional_data = {})
+      super(name, additional_data)
       @stats = Stats.new
     end
 
@@ -40,12 +41,12 @@ module Hitimes
     #
     # Give the +value+ as the measurement to the metric.  The value is returned
     #
-    def measure( value )
-      @sampling_start_time ||= self.utc_microseconds()
+    def measure(value)
+      @sampling_start_time ||= utc_microseconds
       @sampling_start_interval ||= Interval.now
 
-      @stats.update( value )
-      
+      @stats.update(value)
+
       # update the length of time we have been sampling
       @sampling_delta = @sampling_start_interval.duration_so_far
     end
@@ -53,15 +54,15 @@ module Hitimes
     #
     # :call-seq:
     #   metric.to_hash -> Hash
-    #   
+    #
     # Convert the metric to a hash
     #
     def to_hash
-      h = super
-      (Stats::STATS - %w[ rate ]).each do |s|
-        h[s] = self.send( s ) 
+      result = super
+      (Stats::STATS - %w[rate]).each do |stat|
+        result[stat] = send(stat)
       end
-      return h
+      result
     end
 
     # forward appropriate calls directly to the stats object

data/lib/hitimes/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2008 Jeremy Hinegardner
 # All rights reserved.  See LICENSE and/or COPYING for details
 #++
 
 module Hitimes
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

data/lib/hitimes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2008 Jeremy Hinegardner
 # All rights reserved.  See LICENSE and/or COPYING for details.
@@ -23,16 +25,15 @@ module Hitimes
     Hitimes::Interval.measure(&block)
   end
 end
-require 'hitimes/paths'
-require 'hitimes/version'
-require 'hitimes/instant'
-require 'hitimes/interval'
-
-require 'hitimes/stats'
-require 'hitimes/mutexed_stats'
+require "hitimes/paths"
+require "hitimes/version"
+require "hitimes/instant"
+require "hitimes/interval"
 
-require 'hitimes/metric'
-require 'hitimes/value_metric'
-require 'hitimes/timed_metric'
-require 'hitimes/timed_value_metric'
+require "hitimes/stats"
+require "hitimes/mutexed_stats"
 
+require "hitimes/metric"
+require "hitimes/value_metric"
+require "hitimes/timed_metric"
+require "hitimes/timed_value_metric"

metadata

@@ -1,105 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: hitimes
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jeremy Hinegardner
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.5'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.2'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-description: A fast, high resolution timer library for recording peformance metrics.
-  * (http://github.com/copiousfreetime/hitimes) * (http://github.com/copiousfreetime/hitimes)
-  * email jeremy at copiousfreetime dot org * `git clone url git://github.com/copiousfreetime/hitimes.git`
+date: 2024-05-01 00:00:00.000000000 Z
+dependencies: []
+description: A fast, high resolution timer library for recording performance metrics.
 email: jeremy@copiousfreetime.org
 executables: []
 extensions: []
 extra_rdoc_files:
 - CONTRIBUTING.md
 - HISTORY.md
+- LICENSE.txt
 - Manifest.txt
 - README.md
 files:
 - CONTRIBUTING.md
 - HISTORY.md
-- LICENSE
+- LICENSE.txt
 - Manifest.txt
 - README.md
-- Rakefile
-- examples/benchmarks.rb
-- examples/stats.rb
+- hitimes.gemspec
 - lib/hitimes.rb
 - lib/hitimes/initialize.rb
 - lib/hitimes/instant.rb
@@ -112,24 +39,15 @@ files:
 - 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/this.rb
 homepage: http://github.com/copiousfreetime/hitimes
 licenses:
 - ISC
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/copiousfreetime/hitimes/issues
+  changelog_uri: https://github.com/copiousfreetime/hitimes/blob/master/HISTORY.md
+  homepage_uri: https://github.com/copiousfreetime/hitimes
+  source_code_uri: https://github.com/copiousfreetime/hitimes
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -141,26 +59,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
-summary: A fast, high resolution timer library for recording peformance metrics.
-test_files:
-- 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
+summary: A fast, high resolution timer library for recording performance metrics.
+test_files: []

data/Rakefile

@@ -1,19 +0,0 @@
-# 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'         , '~> 12.3')
-  spec.add_development_dependency( 'minitest'     , '~> 5.5' )
-  spec.add_development_dependency( 'rdoc'         , '~> 6.2' )
-  spec.add_development_dependency( 'json'         , '~> 2.2' )
-  spec.add_development_dependency( 'simplecov'    , '~> 0.17' )
-
-  spec.license = "ISC"
-end
-
-load 'tasks/default.rake'

data/examples/benchmarks.rb

@@ -1,113 +0,0 @@
-require 'benchmark'
-require 'time'
-
-#
-# this is all here in case this example is run from the examples directory
-#
-begin
-  require 'hitimes'
-rescue LoadError => le
-  ext_path = File.expand_path( File.join( File.dirname( __FILE__ ), "..", "ext" ) )
-  lib_path = File.expand_path( File.join( File.dirname( __FILE__ ), "..", "lib" ) )
-  if $:.include?( ext_path ) then
-    raise le
-  end
-  $: << ext_path
-  $: << lib_path
-  retry
-end
-
-#----------------------------------------------------------------------
-# test program to look at the performance sampling time durations using
-# different methods
-#----------------------------------------------------------------------
-
-include Benchmark
-
-#
-# Normal apprach to Interval usage
-#
-def hitimes_duration_i1
-  i = Hitimes::Interval.new
-  i.start
-  i.stop
-end
-
-#
-# Use the easy access method to start stop an interval
-#
-def hitimes_duration_i2
-  Hitimes::Interval.now.stop
-end
-
-#
-# Use a new timer each time
-#
-def hitimes_duration_t1
-  Hitimes::TimedMetric.now('duration_t1').stop
-end
-
-#
-# reuse the same timer over and over
-#
-HT2= Hitimes::TimedMetric.new( 'duration_t2' )
-def hitimes_duration_t2
-  HT2.start
-  HT2.stop
-end
-
-HT3 = Hitimes::TimedMetric.new( 'duration_t3' )
-def hitimes_duration_t3
-  HT3.measure { nil }
-end
-
-#
-# Check out the speed of the TimedValueMetric too
-#
-def hitimes_duration_tv1
-  Hitimes::TimedValueMetric.now( 'duration_tv1' ).stop( 42 )
-end
-
-HTV2 = Hitimes::TimedValueMetric.new( 'duration_tv2' )
-def hitimes_duration_tv2
-  HTV2.start
-  HTV2.stop( 42 )
-end
-
-HTV3 = Hitimes::TimedValueMetric.new( 'duration_tv3' )
-def hitimes_duration_tv3
-  HTV3.measure( 42 ) { nil }
-end
-
-#
-# use the Struct::Tms values and return  the difference in User time between 2 
-# successive calls
-#
-def process_duration
-  t1 = Process.times.utime
-  Process.times.utime - t1
-end
-
-#
-# Take 2 times and subtract one from the other
-#
-def time_duration
-  t1 = Time.now.to_f
-  Time.now.to_f - t1
-end
-  
-
-puts "Testing time sampling 100,000 times"
-
-bm(30) do |x|
-  x.report("Process")                     { 100_000.times { process_duration } }
-  x.report("Time")                        { 100_000.times { time_duration    } }
-  x.report("Hitimes::TimedMetric 1")      { 100_000.times { hitimes_duration_t1 } }
-  x.report("Hitimes::TimedMetric 2")      { 100_000.times { hitimes_duration_t2 } }
-  x.report("Hitimes::TimedMetric 3")      { 100_000.times { hitimes_duration_t3 } }
-  x.report("Hitimes::Interval 1")         { 100_000.times { hitimes_duration_i1 } }
-  x.report("Hitimes::Interval 2")         { 100_000.times { hitimes_duration_i2 } }
-  x.report("Hitimes::TimedValueMetric 1") { 100_000.times { hitimes_duration_tv1 } }
-  x.report("Hitimes::TimedValueMetric 2") { 100_000.times { hitimes_duration_tv2 } }
-  x.report("Hitimes::TimedValueMetric 3") { 100_000.times { hitimes_duration_tv3 } }
-end

data/examples/stats.rb

@@ -1,31 +0,0 @@
-#
-# this is all here in case this example is run from the examples directory
-#
-begin
-  require 'hitimes'
-rescue LoadError => le
-  %w[ ext lib ].each do |p|
-    path = File.expand_path( File.join( File.dirname( __FILE__ ), "..", p ) )
-    if $:.include?( path ) then
-      raise le
-    end
-    $: << path
-  end
-  retry
-end
-
-s = Hitimes::Stats.new
-dir = ARGV.shift || Dir.pwd
-Dir.entries( dir ).each do |entry|
-  fs = File.stat( entry )
-  if fs.file? then
-    s.update( fs.size )
-  end
-end
-
-Hitimes::Stats::STATS.each do |m|
-  puts "#{m.rjust(6)} : #{s.send( m ) }"
-end
-
-puts s.to_hash.inspect
-

data/spec/hitimes_spec.rb

@@ -1,24 +0,0 @@
-require 'spec_helper'
-
-describe Hitimes do
-  it "can time a block of code" do
-    d = Hitimes.measure do
-      sleep 0.2
-    end
-    _(d).must_be_close_to(0.2, 0.002)
-  end
-
-  it "raises an error if measure is called with no block" do
-    _(lambda{ Hitimes.measure }).must_raise( Hitimes::Error )
-  end
-
-  it "has the raw instant value" do
-    v = Hitimes.raw_instant
-    _(v).must_be :>, 0
-  end
-
-  it "has access to the instant conversion factor" do
-    f = Hitimes::INSTANT_CONVERSION_FACTOR
-    _(f).must_be :>, 0
-  end
-end

data/spec/interval_spec.rb

@@ -1,136 +0,0 @@
-require "spec_helper"
-
-describe Hitimes::Interval do
-  it "raises an error if duration is called on a non-started interval" do
-    i = Hitimes::Interval.new
-    _(lambda{ i.duration }).must_raise( Hitimes::Error, /\AAttempt to report a duration on an interval that has not started\Z/ )
-  end
-
-  it "raises an error if stop is called on a non-started interval" do
-    i = Hitimes::Interval.new
-    _(lambda { i.stop }).must_raise( Hitimes::Error, /\AAttempt to stop an interval that has not started\Z/ )
-  end
-
-  it "knows if it has been started" do
-    i = Hitimes::Interval.new
-    _(i.started?).must_equal false
-
-    i.start
-    _(i.started?).must_equal true
-  end
-
-  it "knows if it has been stopped" do
-    i = Hitimes::Interval.new
-    i.start
-    _(i.stopped?).must_equal false
-    i.stop
-    _(i.stopped?).must_equal true
-  end
-
-  it "knows if it is currently running" do
-    i = Hitimes::Interval.new
-    _(i.running?).must_equal false
-    i.start
-    _(i.running?).must_equal true
-    i.stop
-    _(i.running?).must_equal false
-  end
-
-  it "can time a block of code" do
-    d = Hitimes::Interval.measure do
-      sleep 0.2
-    end
-    _(d).must_be_close_to(0.2, 0.002)
-  end
-
-  it "raises an error if measure is called with no block" do
-    _(lambda{ Hitimes::Interval.measure }).must_raise( Hitimes::Error, /\ANo block given to Interval.measure\Z/ )
-  end
-
-  it "creates an interval via #now" do
-    i = Hitimes::Interval.now
-    _(i.started?).must_equal true
-    _(i.stopped?).must_equal false
-  end
-
-  it "calling duration multiple times returns successivly grater durations" do
-    i = Hitimes::Interval.new
-    i.start
-    y = i.duration
-    z = i.duration
-    _(z).must_be :>, y
-  end
-
-  it "calling start multiple times on has no effect after the first call" do
-    i = Hitimes::Interval.new
-    _(i.start).must_equal true
-    x = i.start_instant
-    _(i.start_instant).must_be :>, 0
-    _(i.start).must_equal false
-    _(x).must_equal i.start_instant
-  end
-
-  it "returns the duration on the first call to stop" do
-    i = Hitimes::Interval.now
-    d = i.stop
-    _(d).must_be_instance_of( Float )
-  end
-
-  it "calling stop multiple times on has no effect after the first call" do
-    i = Hitimes::Interval.new
-    _(i.start).must_equal true
-    i.stop
-
-    x = i.stop_instant
-    _(i.stop_instant).must_be :>, 0
-    _(i.stop).must_equal false
-    _(x).must_equal i.stop_instant
-
-  end
-
-  it "duration does not change after stop is calledd" do
-    i = Hitimes::Interval.new
-    i.start
-    x = i.stop
-    y = i.duration
-    _(i.stop).must_equal false
-
-    z = i.duration
-
-    _(x).must_equal y
-    _(x).must_equal z
-
-    _(y).must_equal z
-  end
-
-  it "can return how much time has elapsed from the start without stopping the interval" do
-    i = Hitimes::Interval.new
-    i.start
-    x = i.duration_so_far
-    _(i.running?).must_equal true
-    y = i.duration_so_far
-    i.stop
-    _(x).must_be :<, y
-    _(x).must_be :<, i.duration
-    _(y).must_be :<, i.duration
-  end
-
-  describe "#split" do
-
-    it "creates a new Interval object" do
-      i = Hitimes::Interval.new
-      i.start
-      i2 = i.split
-      _(i.object_id).wont_equal i2.object_id
-    end
-
-    it "with the stop instant equivialent to the previous Interval's start instant" do
-      i = Hitimes::Interval.new
-      i.start
-      i2 = i.split
-      _(i.stop_instant).must_equal i2.start_instant
-    end
-  end
-
-end
-

data/spec/metric_spec.rb

@@ -1,28 +0,0 @@
-require "spec_helper"
-
-describe Hitimes::Metric do
-  before( :each ) do
-    @metric = Hitimes::Metric.new( "testing" )
-  end
-
-  it 'has a name' do
-    _(@metric.name).must_equal "testing"
-  end
-
-  it "has associated data from initialization" do
-    m = Hitimes::Metric.new( "more-data", 'foo' => 'bar', 'this' => 'that' )
-    _(m.additional_data['foo']).must_equal 'bar'
-    _(m.additional_data['this']).must_equal 'that'
-    
-    m = Hitimes::Metric.new( "more-data", { 'foo' => 'bar', 'this' => 'that' } )
-    _(m.additional_data['foo']).must_equal 'bar'
-    _(m.additional_data['this']).must_equal 'that'
-  end
-
-  it "initially has no sampling times" do
-    _(@metric.sampling_start_time).must_be_nil
-    _(@metric.sampling_stop_time).must_be_nil
-  end
-end
-
- 

data/spec/mutex_stats_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-
-describe Hitimes::MutexedStats do
-  before( :each ) do
-    @threads = 5
-    @iters   = 10_000
-    @final_value = @threads * @iters
-  end
-
-  def run_with_scissors( stats, threads, iters )
-    spool = []
-    threads.times do |t|
-      spool << Thread.new { iters.times{ stats.update( 1 ) } }
-    end
-    spool.each { |t| t.join }
-    return stats
-  end
-
-  it "Hitimes::Stats is threadsafe" do
-    stats = run_with_scissors( ::Hitimes::Stats.new, @threads, @iters )
-    _(stats.count).must_equal @final_value
-  end
-
-  it "has a threadsafe update" do
-    stats = run_with_scissors( ::Hitimes::MutexedStats.new, @threads, @iters )
-    _(stats.count).must_equal @final_value
-  end
-
-end

data/spec/paths_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe Hitimes::Paths do
-  it "can access the root dir of the project" do
-    _(Hitimes::Paths.root_dir).must_equal File.expand_path( File.join( File.dirname( __FILE__ ), ".." ) ) + ::File::SEPARATOR
-  end
-
-  it "can access the lib path of the project" do
-    _(Hitimes::Paths.lib_path).must_equal File.expand_path( File.join( File.dirname( __FILE__ ), "..", "lib" ) ) + ::File::SEPARATOR
-  end
-end