monotime 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 207159be0c76004c8676ac860106cd133344a29ca0021decbc14bc7448a17fab
-  data.tar.gz: 89c97583a40bfe82dd7c822cfd9a165be19c796cdf32396ee49ef861bbf7fb32
+  metadata.gz: fa145221981b5ff0adb6d1cd3aa77a7e9e9a32942ab9a849a2f83a0d434e245d
+  data.tar.gz: c86e6a4ca11e2e9569089574662e96d2cf0ef1b2216ee638832099a5570cd5da
 SHA512:
-  metadata.gz: c3aa917f832adedaa98acca61c58858d9e4ce57922d3ba457921b2e2c8adc023875a328c308258555f38dbb482168da73f7488c6306bd9751089b3ef21f5e7b0
-  data.tar.gz: b340008fa59637177c6c3caad1d4f5816ba8626a533993d3cc8de615b4c12899b3939e4338f6dae04d66fa09c90e6d7de06667cd02af915c2717bef7fca9aa25
+  metadata.gz: 78a3a8dc8817cc0f99b67d2839d341e01259815c1fefce78ad0d619f2a4c2739414896a98322a2dd620d105b3b1636f6d355d2250deb71920e3a444d970bc0c4
+  data.tar.gz: 5408bc28e13df38a04228eedd325371f7136c036c6ab57c0775c7adc401d4e516acae375502bf16d1f5e3945fe2aaf9b60e6e8549d57570a16d4ec59b10a5b99

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.8.2] - 2023-09-22
+
+### Added
+
+- `Instant.clock_name` is back and now tracks `clock_id` using reflection.
+- Explicit minimum Ruby version in gemspec (2.7.0).
+
+### Changed
+
+- Clock auto-selection redux. We choose the first available from:
+
+  1. `CLOCK_UPTIME_RAW` on macOS, faster and higher resolution, also used by Rust
+  2. `CLOCK_MONOTONIC`
+  3. `CLOCK_REALTIME`, a non-monotonic fallback that issues a warning on startup
+
+- Slight performance bump for `Duration.measure` on Ruby <= 3.1
+
 ## [0.8.1] - 2023-09-18
 
 ### Changed
@@ -179,6 +196,7 @@
 [0.7.1]: https://github.com/Freaky/monotime/commits/v0.7.0
 [0.8.0]: https://github.com/Freaky/monotime/commits/v0.8.0
 [0.8.1]: https://github.com/Freaky/monotime/commits/v0.8.1
+[0.8.2]: https://github.com/Freaky/monotime/commits/v0.8.2
 [issue #1]: https://github.com/Freaky/monotime/issues/1
 [Ruby #16740]: https://bugs.ruby-lang.org/issues/16740
 [@celsworth]: https://github.com/celsworth

data/README.md

@@ -171,11 +171,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ### Core Ruby
 
 For a zero-dependency alternative upon which `monotime` is based, see
-[`Process.clock_gettime`](https://ruby-doc.org/core-2.6.3/Process.html#method-c-clock_gettime).
+[`Process.clock_gettime`](https://www.rubydoc.info/stdlib/core/Process:clock_gettime).
 
-`Process::CLOCK_MONOTONIC` is a safe default, but other options may offer better
-behaviour in face of NTP frequency skew or suspend/resume and should be evaluated
-carefully.
+`Process::CLOCK_MONOTONIC` is a safe default, but other options may offer higher
+resolution or alternative behaviour in light of system suspend/resume or NTP
+frequency skew.
 
 ### Other Gems
 

data/lib/monotime/duration.rb

@@ -106,7 +106,9 @@ module Monotime
       #
       # @return [Duration]
       def measure
-        Instant.now.tap { yield }.elapsed
+        start = Instant.now
+        yield
+        start.elapsed
       end
 
       # Return the result of the yielded block alongside a +Duration+.

data/lib/monotime/instant.rb

@@ -31,17 +31,24 @@ module Monotime
       #   * +Process::CLOCK_MONOTONIC_PRECISE+
       #   * +Process::CLOCK_MONOTONIC_FAST+
       #   * +Process::CLOCK_MONOTONIC+
+      #   * +:MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC+
+      #   * +:TIMES_BASED_CLOCK_MONOTONIC+
       #
-      #   These are platform-dependant and may vary in resolution, performance,
-      #   and behaviour from NTP frequency skew and system suspend/resume, and
-      #   should be selected with care.
+      #   These are platform-dependant and may vary in resolution, accuracy,
+      #   performance, and behaviour in light of system suspend/resume and NTP
+      #   frequency skew.  They should be selected carefully based on your specific
+      #   needs and environment.
       #
       #   It is possible to set non-monotonic clock sources here.  You probably
       #   shouldn't.
       #
-      #   Defaults to +Process::CLOCK_MONOTONIC+.
+      #   Defaults to auto-selection from whatever is available from:
       #
-      #   @param id [Numeric]
+      #   * +CLOCK_UPTIME_RAW+ (if running under macOS)
+      #   * +CLOCK_MONOTONIC+
+      #   * +CLOCK_REALTIME+ (non-monotonic fallback, issues a run-time warning)
+      #
+      #   @param id [Numeric, Symbol]
       attr_accessor :clock_id
 
       # The function used to create +Instant+ instances.
@@ -61,16 +68,48 @@ module Monotime
       # Note per Ruby issue #16740, the practical usability of this method is
       # dubious and non-portable.
       #
-      # @param clock [Numeric] Optional clock id instead of default.
+      # @param clock [Numeric, Symbol] Optional clock id instead of default.
       def clock_getres(clock = clock_id)
         Duration.from_nanos(Process.clock_getres(clock, :nanosecond))
       rescue SystemCallError
         # suppress errors
       end
+
+      # The symbolic name of the currently-selected +clock_id+, if available.
+      #
+      # @return [Symbol, nil]
+      def clock_name
+        return clock_id if clock_id.is_a? Symbol
+
+        Process.constants.find do |c|
+          c.to_s.start_with?('CLOCK_') && Process.const_get(c) == clock_id
+        end
+      end
+
+      private
+
+      def select_clock_id
+        if RUBY_PLATFORM.include?('darwin') && Process.const_defined?(:CLOCK_UPTIME_RAW)
+          # Offers nanosecond resolution and appears to be slightly faster on two
+          # different Macs (M1 and x64)
+          #
+          # There is also :MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC which calls
+          # mach_absolute_time() directly, but documentation for that recommends
+          # CLOCK_UPTIME_RAW, and the performance difference is minimal.
+          Process::CLOCK_UPTIME_RAW
+        elsif Process.const_defined?(:CLOCK_MONOTONIC)
+          Process::CLOCK_MONOTONIC
+        else
+          # There is also :TIMES_BASED_CLOCK_MONOTONIC, but having seen it just return
+          # 0 instead of an error on a MSVC build this may be the safer option.
+          warn 'No monotonic clock source detected, falling back to CLOCK_REALTIME'
+          Process::CLOCK_REALTIME
+        end
+      end
     end
 
     self.monotonic_function = -> { Process.clock_gettime(clock_id, :nanosecond) }
-    self.clock_id = Process::CLOCK_MONOTONIC
+    self.clock_id = select_clock_id
 
     # Create a new +Instant+ from an optional nanosecond measurement.
     #

data/lib/monotime/version.rb

@@ -2,5 +2,5 @@
 
 module Monotime
   # Version of the `monotime` gem
-  MONOTIME_VERSION = '0.8.1'
+  MONOTIME_VERSION = '0.8.2'
 end

data/monotime.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/Freaky/monotime"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.7.0'
+
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monotime
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Thomas Hurst
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="