monotime 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 388a55af121b75e9a9ac06db8674e5a8a4b06ade0431a5cdd961f82426c87ade
-  data.tar.gz: 7d62a9b673252f01591769d8659c5a36b1026088724a2afc9694b41f633ca053
+  metadata.gz: 207159be0c76004c8676ac860106cd133344a29ca0021decbc14bc7448a17fab
+  data.tar.gz: 89c97583a40bfe82dd7c822cfd9a165be19c796cdf32396ee49ef861bbf7fb32
 SHA512:
-  metadata.gz: 14c7ede1fc2daa4fef854d3be58392f57849ff07c4f815c3e995f32073e14893fa7ad95f08e074199457517d262fc8c2942316b8039260b1e66e4045409bb6cf
-  data.tar.gz: b2c907ce1b4f3f92185ba4cb238c3809b465d40be7e34eb1c4a225779a4f6c156ae1d78742ddf24a467d59bfd3437c15be54d4f8bc91a9a9d06fa42ee5e5544a
+  metadata.gz: c3aa917f832adedaa98acca61c58858d9e4ce57922d3ba457921b2e2c8adc023875a328c308258555f38dbb482168da73f7488c6306bd9751089b3ef21f5e7b0
+  data.tar.gz: b340008fa59637177c6c3caad1d4f5816ba8626a533993d3cc8de615b4c12899b3939e4338f6dae04d66fa09c90e6d7de06667cd02af915c2717bef7fca9aa25

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.8.1] - 2023-09-18
+
+### Changed
+
+- After further consideration, return to defaulting to `CLOCK_MONOTONIC` instead
+  of the overly-elaborate auto-selection introduced in 0.8.0.
+
+### Removed
+
+- `Instant.clock_name`.  No I'm not incrementing to 0.9.  It's been a few hours,
+   you're not using it, shut up.
+
 ## [0.8.0] - 2023-09-17
 
 ### Added
@@ -165,8 +177,10 @@
 [0.6.1]: https://github.com/Freaky/monotime/commits/v0.6.1
 [0.7.0]: https://github.com/Freaky/monotime/commits/v0.7.0
 [0.7.1]: https://github.com/Freaky/monotime/commits/v0.7.0
-[0.8.0]: 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
 [issue #1]: https://github.com/Freaky/monotime/issues/1
+[Ruby #16740]: https://bugs.ruby-lang.org/issues/16740
 [@celsworth]: https://github.com/celsworth
 [@petergoldstein]: https://github.com/petergoldstein
-[@fig]: https://github.com/fig
+[@fig]: https://github.com/fig

data/lib/monotime/instant.rb

@@ -12,38 +12,16 @@ module Monotime
     include Comparable
 
     class << self
-      attr_writer :clock_id
-
-      # The symbolic name of the automatically-selected +Process.clock_gettime+
-      # clock id, if available.  This will *not* reflect a manually-set +clock_id+.
-      #
-      # @return [Symbol, nil]
-      attr_reader :clock_name
-
-      # The function used to create +Instant+ instances.
-      #
-      # This function must return a +Numeric+, monotonic count of nanoseconds
-      # since a fixed point in the past.
-      #
-      # Defaults to `lambda { Process.clock_gettime(clock_id, :nanosecond) }`.
-      #
-      # @overload monotonic_function=(function)
-      #   @param function [#call]
-      attr_accessor :monotonic_function
-
       # @overload clock_id
-      #   The configured or detected +Process.clock_getime+ clock identifier.
-      #
-      #   Raises +NotImplementedError+ if a suitable monotonic clock source cannot
-      #   be found and one has not been specified manually.
+      #   The +Process.clock_gettime+ clock id used to create +Instant+ instances
+      #   by the default monotonic function.
       #
       #   @return [Numeric]
       #
       # @overload clock_id=(id)
-      #   The +Process.clock_gettime+ clock id used to create +Instant+ instances
-      #   by the default monotonic function.
       #
-      #   Suggested options include but are not limited to:
+      #   Override the default +Process.clock_gettime+ clock id.  Some potential
+      #   choices include but are not limited to:
       #
       #   * +Process::CLOCK_MONOTONIC_RAW+
       #   * +Process::CLOCK_UPTIME_RAW+
@@ -55,54 +33,44 @@ module Monotime
       #   * +Process::CLOCK_MONOTONIC+
       #
       #   These are platform-dependant and may vary in resolution, performance,
-      #   and behaviour from NTP frequency skew and system suspend/resume.
+      #   and behaviour from NTP frequency skew and system suspend/resume, and
+      #   should be selected with care.
       #
       #   It is possible to set non-monotonic clock sources here.  You probably
       #   shouldn't.
       #
-      #   Defaults to auto-detect.
+      #   Defaults to +Process::CLOCK_MONOTONIC+.
       #
       #   @param id [Numeric]
-      def clock_id
-        @clock_id ||= detect_clock_id
-      end
+      attr_accessor :clock_id
+
+      # The function used to create +Instant+ instances.
+      #
+      # This function must return a +Numeric+, monotonic count of nanoseconds
+      # since a fixed point in the past.
+      #
+      # Defaults to +-> { Process.clock_gettime(clock_id, :nanosecond) }+.
+      #
+      # @overload monotonic_function=(function)
+      #   @param function [#call]
+      attr_accessor :monotonic_function
 
       # Return the claimed resolution of the given clock id or the configured
       # +clock_id+, as a +Duration+, or +nil+ if invalid.
       #
+      # 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.
-      def clock_getres(clock = @clock_id)
+      def clock_getres(clock = clock_id)
         Duration.from_nanos(Process.clock_getres(clock, :nanosecond))
       rescue SystemCallError
         # suppress errors
       end
-
-      private
-
-      def detect_clock_id
-        name, id, =
-          [
-            :CLOCK_MONOTONIC_RAW,     # Linux, not affected by NTP frequency adjustments
-            :CLOCK_UPTIME_RAW,        # macOS, not affected by NTP frequency adjustments
-            :CLOCK_UPTIME_PRECISE,    # FreeBSD, increments while system is running
-            :CLOCK_UPTIME,            # OpenBSD, increments while system is running
-            :CLOCK_MONOTONIC_PRECISE, # FreeBSD, precise monotonic clock
-            :CLOCK_MONOTONIC,         # Standard cross-platform monotonic clock
-          ]
-          .each_with_index # Used to force a stable sort in min_by
-          .filter { |name, _| Process.const_defined?(name) }
-          .map { |name, index| [name, Process.const_get(name), index] }
-          .filter_map { |clock| clock.insert(2, clock_getres(clock[1])) }
-          .min_by { |clock| clock[2..] } # find smallest resolution and index
-          .tap { |clock| raise NotImplementedError, 'No usable clock' unless clock }
-
-        @clock_name = name
-        id
-      end
     end
 
     self.monotonic_function = -> { Process.clock_gettime(clock_id, :nanosecond) }
-    clock_id # detect our clock_id early
+    self.clock_id = Process::CLOCK_MONOTONIC
 
     # 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.0'
+  MONOTIME_VERSION = '0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monotime
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Thomas Hurst
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-17 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: A sensible interface to the monotonic clock