hitimes 1.3.1 → 3.0.0

data/lib/hitimes/timed_value_metric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2008, 2009 Jeremy Hinegardner
 # All rights reserved.  See LICENSE and/or COPYING for details.
@@ -10,7 +12,7 @@ module Hitimes
   #
   #   tm = TimedValueMetric.new( 'my-batch-method' )
   #
-  #   42.times do 
+  #   42.times do
   #     tm.start
   #     number_of_items_processed = do_something
   #     tm.stop( number_of_items_processed )
@@ -40,10 +42,10 @@ module Hitimes
       #
       # Return a TimedValueMetric that has been started
       #
-      def now( name, additional_data = {} )
-        t = TimedValueMetric.new( name, additional_data )
-        t.start
-        return t
+      def now(name, additional_data = {})
+        tvm = TimedValueMetric.new(name, additional_data)
+        tvm.start
+        tvm
       end
     end
 
@@ -55,8 +57,8 @@ module Hitimes
     # Create a new TimedValueMetric 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)
       @timed_stats      = Stats.new
       @value_stats      = Stats.new
       @current_interval = Interval.new
@@ -72,17 +74,17 @@ module Hitimes
       @current_interval.running?
     end
 
-    # 
+    #
     # :call-seq:
     #   timed_value_metric.start -> nil
     #
     # Start the current timer, if the current timer is already started, then
-    # this is a noop.  
+    # this is a noop.
     #
     def start
-      if not @current_interval.running? then
+      unless @current_interval.running?
         @current_interval.start
-        @sampling_start_time ||= self.utc_microseconds() 
+        @sampling_start_time ||= utc_microseconds
         @sampling_start_interval ||= Interval.now
       end
       nil
@@ -101,21 +103,21 @@ module Hitimes
     # the current interval. If the metric is stopped then the duration of the
     # last Interval is returned.  If the metric was already stopped before this
     # call, then false is returned and no stats are updated.
-    # 
     #
-    def stop( value )
-      if @current_interval.running? then
-        d = @current_interval.stop
-        @timed_stats.update( d )
+    #
+    def stop(value)
+      if @current_interval.running?
+        duration = @current_interval.stop
+        @timed_stats.update(duration)
         @current_interval = Interval.new
-        @value_stats.update( value )
+        @value_stats.update(value)
 
         # update the lenght of time we have been sampling
         @sampling_delta = @sampling_start_interval.duration_so_far
 
-        return d
+        return duration
       end
-      return false
+      false
     end
 
     #
@@ -126,15 +128,15 @@ module Hitimes
     # The return value is the return value of the block.  A value must be passed
     # into +measure+ to update the +value_stats+ portion of the TimedValueMetric.
     #
-    def measure( value, &block )
+    def measure(value)
       return_value = nil
       begin
         start
         return_value = yield
       ensure
-        stop( value )
+        stop(value)
       end
-      return return_value
+      return_value
     end
 
     #
@@ -148,19 +150,19 @@ module Hitimes
     #
     # If the metric is running, then split returns the duration of the previous
     # interval, i.e. the split-time.  If the metric is not running, nothing
-    # happens, no stats are updated, and false is returned.  
+    # happens, no stats are updated, and false is returned.
     #
     #
-    def split( value )
-      if @current_interval.running? then 
+    def split(value)
+      if @current_interval.running?
         next_interval = @current_interval.split
-        d = @current_interval.duration
-        @timed_stats.update( d )
-        @value_stats.update( value )
-        @current_interval = next_interval 
-        return d
-      end 
-      return false
+        duration = @current_interval.duration
+        @timed_stats.update(duration)
+        @value_stats.update(value)
+        @current_interval = next_interval
+        return duration
+      end
+      false
     end
 
     #
@@ -192,7 +194,7 @@ module Hitimes
     # associated with a quantity of things done during that unit of time.  So
     # the +rate+ for a TimedValueMetric is the (sum of all quantities sampled) /
     # ( sum of all durations measured )
-    # 
+    #
     # For example, say you were measuring, using a TimedValueMetric batch jobs
     # that had individual units of work.
     #
@@ -208,7 +210,7 @@ module Hitimes
     # At this point the rate of units per second is calculated as ( 12 + 42 ) / ( duration1 + duration2 )
     #
     #   some_batch_rate = tvm.rate # returns ( 34 / ( duration1+duration2 ) )
-    # 
+    #
     def rate
       @value_stats.sum / @timed_stats.sum
     end
@@ -216,18 +218,16 @@ module Hitimes
     #
     # :call-seq:
     #   metric.to_hash -> Hash
-    #   
+    #
     # Convert the metric to a hash
     #
     def to_hash
-      h = super
-      h['timed_stats'] = @timed_stats.to_hash
-      h['value_stats'] = @value_stats.to_hash( Stats::STATS - %w[ rate ] )
-      h['rate'] = self.rate
-      h['unit_count'] = self.unit_count
-      return h
+      result = super
+      result["timed_stats"] = @timed_stats.to_hash
+      result["value_stats"] = @value_stats.to_hash(Stats::STATS - %w[rate])
+      result["rate"] = rate
+      result["unit_count"] = unit_count
+      result
     end
-
-
   end
 end

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 = "1.3.1"
+  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,44 +25,15 @@ module Hitimes
     Hitimes::Interval.measure(&block)
   end
 end
-require 'hitimes/paths'
-require 'hitimes/version'
-
-# Load the binary extension, try loading one for the specific version of ruby
-# and if that fails, then fall back to one in the top of the library.
-# this is the method recommended by rake-compiler
-
-attempts = [
-  "hitimes/#{RUBY_VERSION.sub(/\.\d+$/,'')}/hitimes",
-  "hitimes/hitimes"
-]
-loaded = false
-
-path_exceptions = []
-attempts.each do |path|
-  begin
-    require path
-    loaded = true
-    break
-  rescue LoadError => load_error
-    full_path = File.expand_path(path)
-    path_exceptions << [ full_path, load_error.message ]
-  end
-end
-
-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'
-
-require 'hitimes/metric'
-require 'hitimes/value_metric'
-require 'hitimes/timed_metric'
-require 'hitimes/timed_value_metric'
-
+require "hitimes/paths"
+require "hitimes/version"
+require "hitimes/instant"
+require "hitimes/interval"
+
+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,148 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: hitimes
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Jeremy Hinegardner
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !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: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler-dock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-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`
+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:
-- ext/hitimes/c/extconf.rb
+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
-- 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
+- hitimes.gemspec
 - lib/hitimes.rb
+- lib/hitimes/initialize.rb
+- lib/hitimes/instant.rb
+- lib/hitimes/interval.rb
 - lib/hitimes/metric.rb
 - lib/hitimes/mutexed_stats.rb
 - lib/hitimes/paths.rb
@@ -151,25 +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/extension.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
@@ -181,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.1
-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,28 +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.0')
-  spec.add_development_dependency( 'minitest'     , '~> 5.5' )
-  spec.add_development_dependency( 'rdoc'         , '~> 5.0'  )
-  spec.add_development_dependency( 'json'         , '~> 2.0' )
-  spec.add_development_dependency( 'rake-compiler', '~> 1.0' )
-  spec.add_development_dependency( 'rake-compiler-dock', '~> 0.6' )
-  spec.add_development_dependency( 'simplecov'    , '~> 0.14' )
-
-  spec.extensions.concat This.extension_conf_files
-  spec.license = "ISC"
-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'