monotime 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8f48959572be85d87513cfc071e48eea56af6c15e62d7c8d2b253fecf1b23d2
+  data.tar.gz: 73f63a474ba0949c4ddc2e665e9102f89524ab9031c52476a3420b49cb3656e2
+SHA512:
+  metadata.gz: e03126c84a579e4096b28c56afd93eab7099bc782ea9c6ec0f2be8a9d8375e1ed90ce8efc3b22f59a93356c104b76c0945f18fd36bae0232cc0cf0f65fb68f98
+  data.tar.gz: 1f74dd4465f686198e4e1fc098d04387528a7cc99d78ba850773cc137c99a3ab62e23b34c5424c9c6d03e7bb34ee9f383d2a6173c196a857eff31df25c62c108

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in monotime.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    monotime (0.1.0)
+      dry-equalizer
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dry-equalizer (0.2.1)
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  monotime!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Thomas Hurst
+
+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,92 @@
+# Monotime
+
+A sensible interface to Ruby's monotonic clock, inspired by Rust.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monotime'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install monotime
+
+## Usage
+
+The typical way everyone does "correct" elapsed-time measurements in Ruby is
+this pile of nonsense:
+
+```ruby
+start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+do_something
+elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+```
+
+Not only is it long-winded, it's imprecise, converting to floating point instead
+of working off precise timestamps.
+
+`Monotime` offers this alternative:
+
+```ruby
+include Monotime
+
+start = Instant.now
+do_something
+elapsed = start.elapsed
+
+# or
+elapsed = Duration.measure { do_something }
+```
+
+`elapsed` is not a dimensionless `Float`, but a `Duration` type, and internally
+both `Instant` and `Duration` operate in *nanoseconds* to most closely match
+the native timekeeping types used by most operating systems.
+
+`Duration` knows how to format itself:
+
+```ruby
+Duration.from_millis(42).to_s       # => "42ms"
+Duration.from_nanos(12345).to_s     # => "12.345μs"
+Duration.from_secs(1.12345).to_s(2) # => "1.12s"
+```
+
+And how to do basic maths on itself:
+
+```ruby
+(Duration.from_millis(42) + Duration.from_secs(1)).to_s  # => "1.042s"
+(Duration.from_millis(42) - Duration.from_secs(-1)).to_s # => "-958ms"
+```
+
+`Instant` does some simple maths too:
+
+```ruby
+# Instant - Duration => Instant
+(Instant.now - Duration.from_secs(1)).elapsed.to_s # => "1.000014627s"
+
+# Instant - Instant => Duration
+(Instant.now - Instant.now).to_s                   # => "3.439μs"
+```
+
+`Duration` and `Instant` are also `Comparable` with other instances of their
+type, and support `#hash` for use in, er, hashes.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/Freaky/monotime.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "monotime"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/monotime/version.rb

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

data/lib/monotime.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'monotime/version'
+
+require 'dry-equalizer'
+
+module Monotime
+  class Instant
+    attr_reader :ns
+
+    include Dry::Equalizer(:ns)
+    include Comparable
+
+    def initialize(ns = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond))
+      raise TypeError, 'Not an Integer' unless ns.is_a? Integer
+
+      @ns = ns
+    end
+
+    def self.now
+      new
+    end
+
+    def duration_since(earlier)
+      case earlier
+      when Instant then self - earlier
+      else raise TypeError, 'Not an Instant'
+      end
+    end
+
+    def elapsed
+      duration_since(self.class.now)
+    end
+
+    def +(other)
+      case other
+      when Duration then Instant.new(self.ns + other.ns)
+      when Integer then Instant.new(self.ns + other)
+      else raise TypeError, 'Not a Duration or Integer'
+      end
+    end
+
+    def -(other)
+      case other
+      when Instant then Duration.new(other.ns - self.ns)
+      when Duration then Instant.new(self.ns - other.ns)
+      when Integer then Instant.new(self.ns - other)
+      else raise TypeError, 'Not an Instant, Duration or Integer'
+      end
+    end
+
+    def <=>(other)
+      case other
+      when self.class then self.ns <=> other.ns
+      else raise TypeError, 'Not a #{self.class}'
+      end
+    end
+  end
+
+  class Duration
+    attr_reader :ns
+
+    include Dry::Equalizer(:ns)
+    include Comparable
+
+    def initialize(ns = 0)
+      raise TypeError, 'Not an Integer' unless ns.is_a? Integer
+
+      @ns = ns
+    end
+
+    class << self
+      def from_secs(secs)
+        new(Integer(Float(secs) * 1_000_000_000))
+      end
+
+      def from_millis(millis)
+        new(Integer(Float(millis) * 1_000_000))
+      end
+
+      def from_micros(micros)
+        new(Integer(Float(micros) * 1_000))
+      end
+
+      def from_nanos(nanos)
+        new(Integer(nanos))
+      end
+
+      def measure
+        Instant.now.tap { yield }.elapsed
+      end
+    end
+
+    def +(other)
+      case other
+      when Duration then Duration.new(self.ns + other.ns)
+      when Numeric then Duration.new(self.ns + other)
+      else raise TypeError, 'Not a Duration or Numeric'
+      end
+    end
+
+    def -(other)
+      case other
+      when Duration then Duration.new(self.ns - other.ns)
+      when Numeric then Duration.new(self.ns - other)
+      else raise TypeError, 'Not a Duration or Numeric'
+      end
+    end
+
+    def <=>(other)
+      case other
+      when self.class then self.ns <=> other.ns
+      else raise TypeError, "Not a #{self.class}"
+      end
+    end
+
+    def to_secs
+      @ns / 1_000_000_000
+    end
+
+    def to_millis
+      @ns / 1_000_000
+    end
+
+    def to_micros
+      @ns * 1_000
+    end
+
+    def to_nanos
+      @ns
+    end
+
+    def to_s(precision = 9)
+      postfix = 's'
+      ns = self.ns.abs
+      num = "#{'-' if self.ns < 0}%.#{precision}f" % if ns >= 1_000_000_000
+        ns / 1_000_000_000.0
+      elsif ns >= 1_000_000
+        postfix = 'ms'
+        ns / 1_000_000.0
+      elsif ns >= 1_000
+        postfix = 'μs'
+        ns / 1_000.0
+      else
+        postfix = 'ns'
+        ns
+      end
+      num.sub(/\.?0*$/, '') << postfix
+    end
+  end
+end

data/monotime.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "monotime/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "monotime"
+  spec.version       = Monotime::VERSION
+  spec.authors       = ["Thomas Hurst"]
+  spec.email         = ["tom@hur.st"]
+
+  spec.summary       = %q{A sensible interface to the monotonic clock}
+  spec.homepage      = "https://github.com/Freaky/monotime"
+  spec.license       = "MIT"
+
+  # 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)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-equalizer", '~> 0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: monotime
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Hurst
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+description: 
+email:
+- tom@hur.st
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/monotime.rb
+- lib/monotime/version.rb
+- monotime.gemspec
+homepage: https://github.com/Freaky/monotime
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A sensible interface to the monotonic clock
+test_files: []