ruby-monotonic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1bd6d1ef5ec2b7bd902ba4fb93414ac2ffc23a502e647254bcdac6d5404d00ff
+  data.tar.gz: d39a17873611114952bf1e30c8f4c3ebe4abfa157c35a3a8a51b122f64514501
+SHA512:
+  metadata.gz: a5521c12d14d03a8c37d1290afcb433ef756de407c567a115cf85de4caac8c615ffb725e461ddcdef9d2cffa690b8a676bed647ae2034487df8f6ce331e44afd
+  data.tar.gz: 3b631a8bb8221a4bec7d5ee9ec99ec7510340e51f2ab84991da77b6e1efd03c5604a4dba1e406d79748b2d490d4994153f9277a915b42949c103d818bccb0b3f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Richard Marbach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Monotonic
+
+Provide a cross-platform monotonic time for ruby even across system suspense.
+The timer starts from 0 on system boot and will reset on system reboot.
+
+The monotonic timer is useful as a measure of passing time and shouldn't compared with time from other sources.
+The timestamps are also only safely compared when sourced from the same thread.
+
+## Usage
+
+```ruby
+Monotonic.monotonic_time
+# => 91226002327716
+```
+
+## Why?
+
+The state of cross-platform time keeping is a mess. 
+In Linux alone, there are 11 different clocks.
+The usual recommendation is to use `Process::CLOCK_MONOTONIC` for a monotonic time. 
+
+In a lot of cases `CLOCK_MONOTONIC` works fine, but the clock stops on system suspense.
+If you're attempting to bound the running time with for example `Timeout`, then it's important to be aware that `CLOCK_MONOTONIC` may not timeout in the desired time when compared to "real" time:
+
+```ruby
+Timeout.timeout(5) do
+    # Do Work
+    # System is supsended for 15 minutes
+    # Continue working as if nothing happened
+end
+# Total running time 15 minutes
+```
+
+Currently, there's no good option for getting a suspense-aware cross-platform monotonic timestamp. 
+On Linux/FreeBSD it's possible to use `CLOCK_BOOTTIME`.
+
+However, Ruby hasn't implemented the MacOS equivalent of `mach_continous_time`.
+Windows also has a poor story regarding high precision timers, with the only option being `QueryPerformanceCounter` for a high resolution time stamp.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add ruby-monotonic
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ruby-monotonic
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/richardmarbach/monotonic.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task :build do
+  cd "ext/" do
+    ruby "extconf.rb"
+    sh "make"
+  end
+end
+
+task default: %i[rubocop build]

data/ext/.gitignore

@@ -0,0 +1,3 @@
+*.bundle
+*.o
+Makefile

data/ext/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+create_makefile "monotonic"

data/ext/monotonic.c

@@ -0,0 +1,49 @@
+#include "ruby.h"
+
+#if defined(__APPLE__)
+#include <mach/mach_time.h>
+#elif defined(_WIN32)
+#include <profileapi.h>
+#include <winnt.h>
+#define COMMON_QPF 10000000LL
+#else
+#include <time.h>
+#endif
+
+#define S_IN_NS 1000000000LL
+
+long long monotonic_get_monotonic_time() {
+#if defined(__APPLE__)
+  return mach_continuous_time();
+#elif defined(_WIN32)
+
+  LARGE_INTEGER qpf;
+  QueryPerformanceFrequency(&qpf);
+
+  LARGE_INTEGER qpc;
+  QueryPerformanceCounter(&qpc);
+
+  // https://github.com/microsoft/STL/blob/785143a0c73f030238ef618890fd4d6ae2b3a3a0/stl/inc/chrono#L694-L701
+  if (qpf.QuadPart == COMMON_QPF) {
+    return qpc.QuadPart * (S_IN_NS / COMMON_QPF);
+  }
+
+  long long nanoseconds = qpc.QuadPart * S_IN_NS;
+  nanoseconds /= qpf.QuadPart;
+  return nanoseconds;
+#else
+  struct timespec ts;
+  clock_gettime(CLOCK_BOOTTIME, &ts);
+  return ts.tv_sec * S_IN_NS + ts.tv_nsec;
+#endif
+}
+
+VALUE monotonic_get_monotonic_time_ext() {
+  return LL2NUM(monotonic_get_monotonic_time());
+}
+
+void Init_monotonic() {
+  VALUE mod = rb_define_module("Monotonic");
+  rb_define_singleton_method(mod, "monotonic_time",
+                             monotonic_get_monotonic_time_ext, 0);
+}

data/lib/monotonic/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Monotonic
+  VERSION = "0.1.0"
+end

data/lib/monotonic.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Monotonic
+module Monotonic
+  require_relative "monotonic/version"
+
+  ext = case RUBY_PLATFORM
+        when /linux/
+          "so"
+        when /darwin/
+          "bundle"
+        when /mingw|mswin/
+          "dll"
+        else
+          raise "Unsupported platform: #{RUBY_PLATFORM}"
+        end
+
+  require_relative File.expand_path("../ext/monotonic.#{ext}", __dir__)
+end

data/sig/monotonic.rbs

@@ -0,0 +1,3 @@
+module Monotonic
+  VERSION: String
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: ruby-monotonic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Marbach
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-17 00:00:00.000000000 Z
+dependencies: []
+description: Get nanosecond precision monotonic time that is not affected by system
+  suspense.
+email:
+- richard@viaeurope.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/.gitignore
+- ext/extconf.rb
+- ext/monotonic.c
+- lib/monotonic.rb
+- lib/monotonic/version.rb
+- sig/monotonic.rbs
+homepage: https://github.com/richardmarbach/ruby-monotonic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/richardmarbach/ruby-monotonic
+  source_code_uri: https://github.com/richardmarbach/ruby-monotonic
+  changelog_uri: https://github.com/richardmarbach/ruby-monotonic
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: True monotonic time for Ruby
+test_files: []