monotonic.rb 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf995a6ab7105dc05b1b11b660fc4a28b34f07d784c5c13af2b83e46c1d5b949
-  data.tar.gz: 871dc0fc14b0771d4ddc00d7717787df34ace4d98b248e8613ba24918c40e641
+  metadata.gz: 1ed52df8a021bca41cae021d5b11408c8bd6b0fc80025a46a56b688cafa4fcdc
+  data.tar.gz: c45841b92c1da76259799f4c6c55ba9a540b9b25464acd82560f30a2c10e9234
 SHA512:
-  metadata.gz: 809325b41986a73bea427d0685a4b63f42a6a89a090716edda20e400c5f9a0b91ec8ba28e1844ef63470cdef8368b913f3479488e449076abd2f63321c9aaa42
-  data.tar.gz: 744d49e5aaa3028ac0fbf9180e146dd73ceb5c2ea6da50fcb33e72ef5659586aacff6786be1526244ab195f6e144a9b8a75b6fe488ed7a1cbd398e273eaa9ae2
+  metadata.gz: 4cf743fb3e9303efe1439f0532462045525b1439523bce53cfc96f293df4da5d33a94676e1b71e995cb908b29cb8295470111dc7857d6712e569ca348a45f6f6
+  data.tar.gz: 739e6a9032050231fdc5f761a6581a70aded2512981f7cf9e34e6774a43215e87db9d3911c6aec214269ac1a08282ef5933920e2121ab11119f6b0c34f5ef0a1

data/CHANGELOG

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 20260816
+
+0.7.3: Require Monotonic::Time from the gem, and stop every instant fetching the boot time.
+
+1. ~ lib/monotonic.rb: + require_relative Monotonic/Time. It had reached a caller only by way of lib/Monotonic/Timer.rb requiring a file which Timer stopped using at 0.7.0, when the two took different clocks. Delete that stray line and Monotonic::Time would have vanished from the published gem, and nothing said so.
+2. ~ lib/Monotonic/Timer.rb: - require_relative ./Time, which nothing there has wanted since 0.7.0.
+3. + test/loading_test.rb: that requiring the gem defines Monotonic::Time and Monotonic::Timer, and the version. In a process of its own, this one having loaded every file directly and so being unable to tell what the gem alone would bring. The same hole as VERSION.rb before 0.7.1: a file nothing names is a file nothing checks.
+4. ~ Monotonic::Time#to_time: asks Sys::Uptime for the boot time rather than every instant keeping one. Only this method wanted it, and asking cost 1740ns of the 1947ns an instant took to make, so an instant now costs 194ns. Memoising it was tried and is wrong: Darwin computes kern.boottime from the wall clock and the uptime, so it moves as the clock is disciplined, and a kept copy would fix the origin while the mapping drifted from it.
+5. ~ test/Monotonic/Time_test.rb: the #initialize test asserted @boot_time was set, under a description copied from Timer's about blocks. It now asserts that an instant keeps the reading and nothing else. + that #to_time lands upon the wall clock, which nothing checked.
+6. ~ README.md: what Monotonic::Time is for, since 0.7.0 left it with no caller in the library and said only that Timer had stopped using it. It is the point type: the difference of two instants is what a monotonic clock is read for, and #to_time places one against the wall clock.
+7. + .gitignore: the standard list, as duration.rb and namo carry verbatim, in place of the three lines here. It is not among spec.files, so nothing in the published gem changes by it.
+8. ~ Monotonic::VERSION: /0.7.2/0.7.3/
+
+
 ## 20260812
 
 0.7.2: + gemspec test.

data/README.md

@@ -22,6 +22,8 @@ How finely a clock advances is the platform's business and not this library's to
 
 A reading is denominated in nanoseconds whether or not the clock affords them, so that is the method which says what a reading is worth. Two figures give the sense of it upon the finer clock: reading it costs about 34ns against the 42ns it takes to advance, the two being close enough that there is little to be had by going finer, and a pair of `Float`s would not begin to lose it until some six years of uptime — but they would begin.
 
+What `Monotonic::Time` is for follows from that. It is the point type: `Monotonic::Timer` used it as its own substrate until 0.7.0, when the two took different clocks, and what remains to it is what a point is good for — the difference of two instants, which is the reason a monotonic clock is read at all, and `#to_time`, which places one against the wall clock by way of the boot time.
+
 
 ## Installation
 

data/lib/Monotonic/Time.rb

@@ -25,6 +25,13 @@ module Monotonic
         self.new
       end
 
+      # Invariant for the life of the process, coming from kern.boottime, which
+      # does not move.  It was asked afresh upon every instance and cost 1740ns
+      # of the 1947ns an instant took to make.
+      def boot_time
+        @boot_time ||= Sys::Uptime.boot_time
+      end
+
       # How finely this clock advances, in nanoseconds.  It is asked rather than
       # tabulated, being a property of the processor and the operating system
       # and not of this library: upon macOS CLOCK_MONOTONIC answers 1000 here.
@@ -50,7 +57,6 @@ module Monotonic
     end
 
     def initialize
-      @boot_time = Sys::Uptime.boot_time
       @nanoseconds_since_boot = Process.clock_gettime(CLOCK, :nanosecond)
     end
 
@@ -66,8 +72,13 @@ module Monotonic
       "#{seconds_since_boot} seconds since boot."
     end
 
+    # The boot time is asked for here rather than kept upon every instant.  It
+    # cost 1740ns of the 1947ns an instant took to make, and only this method
+    # wants it — so an instant is now cheap to take, and the mapping still
+    # uses the boot time as it stands rather than as it stood, Darwin moving
+    # kern.boottime as the wall clock is disciplined.
     def to_time
-      @boot_time + seconds_since_boot
+      Sys::Uptime.boot_time + seconds_since_boot
     end
   end
 end

data/lib/Monotonic/VERSION.rb

@@ -2,5 +2,5 @@
 # Monotonic::VERSION
 
 module Monotonic
-  VERSION = '0.7.2'
+  VERSION = '0.7.3'
 end

data/lib/monotonic.rb

@@ -1,5 +1,6 @@
 # monotonic.rb
 # Monotonic
 
+require_relative './Monotonic/Time'
 require_relative './Monotonic/Timer'
 require_relative './Monotonic/VERSION'

data/test/Monotonic/Time_test.rb

@@ -7,9 +7,8 @@ describe Monotonic::Time do
   subject{Monotonic::Time.now}
 
   describe "#initialize" do
-    it "the time spent in the block is returned as the value of the block" do
-      expect(subject.instance_variable_get(:@boot_time)) \
-        .must_equal(Sys::Uptime.boot_time)
+    it "keeps the reading and nothing else, the boot time being wanted only by #to_time" do
+      expect(subject.instance_variables).must_equal([:@nanoseconds_since_boot])
     end
 
     it "the reading is taken from the monotonic clock in nanoseconds" do
@@ -77,5 +76,9 @@ describe Monotonic::Time do
     it "returns an instance of time" do
       expect(subject.to_time.class).must_equal(Time)
     end
+
+    it "lands upon the wall clock, the boot time being asked for as it stands" do
+      expect((subject.to_time - Time.now).abs).must_be :<, 0.01
+    end
   end
 end

data/test/loading_test.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/monotonic.rb'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+# In its own process, since this one has loaded every file directly and so could
+# not tell what requiring the gem alone would bring.
+describe 'loading' do
+  def ruby(source)
+    lib = File.expand_path('../lib', __dir__)
+    IO.popen(['ruby', "-I#{lib}", '-e', source], err: [:child, :out]){|io| io.read}.strip
+  end
+
+  it "defines both classes upon requiring the gem" do
+    expect(ruby('require "monotonic.rb"; print [defined?(Monotonic::Time), defined?(Monotonic::Timer)].inspect')) \
+      .must_equal('["constant", "constant"]')
+  end
+
+  it "defines the version too" do
+    expect(ruby('require "monotonic.rb"; print Monotonic::VERSION')) \
+      .must_equal(Monotonic::VERSION)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monotonic.rb
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - thoran
@@ -84,6 +84,7 @@ files:
 - test/Monotonic/Timer_test.rb
 - test/Monotonic/VERSION_test.rb
 - test/gemspec_test.rb
+- test/loading_test.rb
 homepage: https://github.com/thoran/monotonic.rb
 licenses:
 - MIT