monotime 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbb84fdd4db4d629ca5d4cc847c47d9003f4553f010b575364f7ad562c16bb4d
-  data.tar.gz: 40729463ba3970e77110c2ae92620f4d6ca08b6d9997776272a3d0a05a03b595
+  metadata.gz: e0df6ca1dab7d99066d318178d9bb7c6300b4e2cd3f28aa90b5027c0e000930b
+  data.tar.gz: 4e3448b26720601704cd8788d102e1a6bd5e4dfe13e198111d4be7f0fd3c3543
 SHA512:
-  metadata.gz: 2916513d7d5dada28d18855d7644055cf82ddd6d2ad66ebd27c7a73d9ae2c88cde94887e7769d007372768c7acbcac32d8210308f9bc2ba2256b150126f29d9b
-  data.tar.gz: cff3a4bd7be443460f7dfc65432da3f3d30fef62433e5caa73c932497d490fdc5641b34659f18d8790bb0797449d93b9019f46678c0489b3aa9756c871222bd1
+  metadata.gz: 3947fc4c751704def4c92a07a4761dc04c44c1c6a33184c032eff8930f679d604f6e2d58c3f960b81f5d8316bd9ce6e8bd3044654d778f025b5f376812f50afb
+  data.tar.gz: 3c1c6986817e620b1175c5affd9f708f1f5f45e81eba32e48cedf146a54a6f90c94be54576bd96b6bc5901a58f5a8c816749eeaf7ea9ec767c7660f608539fdc

data/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+## [0.6.0] - 2018-10-26
+### Added
+ - This `CHANGELOG.md` by request of [@celsworth].
+ - Aliases for `Duration.from_*` and `Duration#to_*` without the prefix.  e.g.
+   `Duration.from_secs(42).to_secs == 42` can now be written as
+   `Duration.secs(42).secs == 42`.
+ - `Duration#nonzero?`.
+ - `Instant#in_past?` and `Instant#in_future?`.
+
+## [0.5.0] - 2018-10-13
+### Added
+ - `Duration#abs` to make a `Duration` positive.
+ - `Duration#-@` to invert the sign of a `Duration`.
+ - `Duration#positive?`
+ - `Duration#negative?`
+ - `Duration#zero?`
+
+### Changed
+ - `Instant#sleep` with no argument now sleeps until the `Instant`.
+ - `Duration.from_*` no longer coerce their argument to `Float`.
+ - `Duration#==` checks value via `#to_nanos`, not type.
+ - `Duration#eql?` checks value and type.
+ - `Duration#<=>` compares value via `#to_nanos`.
+
+## [0.4.0] - 2018-10-09
+### Added
+ - `Instant#sleep` - sleep to a given `Duration` past an `Instant`.
+ - `Instant#sleep_secs` and `Instant#sleep_millis` convenience methods.
+ - `Duration#sleep` - sleep for the `Duration`.
+ - `Duration#*` - multiply a `Duration` by a number.
+ - `Duration#/` - divide a `Duration` by a number.
+
+### Changed
+- More `#to_nanos` `Duration` duck-typing.
+
+## [0.3.0] - 2018-10-04
+### Added
+ - `#to_nanos` is now used to duck-type `Duration` everywhere.
+
+### Changed
+ - Make `<=>` return nil on invalid types, rather than raising a `TypeError`.
+
+### Removed
+ - Dependency on `dry-equalizer`.
+
+## [0.2.0] - 2018-10-03
+### Added
+ - `Instant#to_s` as an alias for `#elapsed.to_s`
+ - `Duration#to_nanos`, with some limited duck-typing.
+
+### Changed
+ - Switch to microseconds internally.
+ - `Duration#to_{secs,millis,micros}` now return a `Float`.
+ - `Instant#ns` is now `protected`.
+
+### Fixed
+ - `Duration#to_s` zero-stripping with precision=0.
+ - `Instant#-` argument ordering with other `Instant`.
+ - `Duration#to_micros` returns microseconds, not picoseconds.
+
+### Removed
+ - `Instant` and `Duration` maths methods no longer support passing an `Integer`
+   number of nanoseconds.
+
+## [0.1.0] - 2018-10-02
+### Added
+ - Initial release
+
+
+[0.1.0]: https://github.com/Freaky/monotime/commits/v0.1.0
+[0.2.0]: https://github.com/Freaky/monotime/commits/v0.2.0
+[0.3.0]: https://github.com/Freaky/monotime/commits/v0.3.0
+[0.4.0]: https://github.com/Freaky/monotime/commits/v0.4.0
+[0.5.0]: https://github.com/Freaky/monotime/commits/v0.5.0
+[0.6.0]: https://github.com/Freaky/monotime/commits/v0.6.0
+[@celsworth]: https://github.com/celsworth

data/README.md

@@ -5,6 +5,46 @@
 
 A sensible interface to Ruby's monotonic clock, inspired by Rust.
 
+## Synopsis
+
+Monotonic clocks are what you use to measure elapsed time: unlike the system
+clock they're guaranteed to always move forward.
+
+This is perfectly valid behaviour:
+
+```ruby
+start = Time.new
+do_something
+elapsed = Time.new - start # -3599.421234
+```
+
+Monotonic clocks never do this.  Typically you'd avoid this by using
+`Process#clock_gettime` with the appropriate arguments:
+
+```ruby
+start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+do_something
+elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+```
+
+But this isn't very Rubyish - it's a thin veneer over the POSIX C API.
+
+`monotime` offers this alternative, similar to that found in Rust:
+
+```ruby
+include Monotime
+
+start = Instant.now
+do_something
+elapsed = start.elapsed
+
+# or
+elapsed = Duration.measure { do_something }
+```
+
+Where `elapsed` is a dedicated type for measuring durations, with conversion
+and formatting methods.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/monotime/version.rb

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

data/lib/monotime.rb

@@ -47,6 +47,24 @@ module Monotime
       duration_since(self.class.now)
     end
 
+    # Return whether this +Instant+ is in the past.
+    #
+    # @return [Boolean]
+    def in_past?
+      elapsed.positive?
+    end
+
+    alias past? in_past?
+
+    # Return whether this +Instant+ is in the future.
+    #
+    # @return [Boolean]
+    def in_future?
+      elapsed.negative?
+    end
+
+    alias future? in_future?
+
     # Sleep until this +Instant+, plus an optional +Duration+, returning a +Duration+
     # that's either positive if any time was slept, or negative if sleeping would
     # require time travel.
@@ -154,7 +172,7 @@ module Monotime
 
     # Generate a hash for this type and value.
     #
-    # @return [Fixnum]
+    # @return [Integer]
     def hash
       self.class.hash ^ @ns.hash
     end
@@ -184,6 +202,8 @@ module Monotime
         new(Integer(secs * 1_000_000_000))
       end
 
+      alias secs from_secs
+
       # Generate a new +Duration+ measuring the given number of milliseconds.
       #
       # @param millis [Numeric]
@@ -192,6 +212,8 @@ module Monotime
         new(Integer(millis * 1_000_000))
       end
 
+      alias millis from_millis
+
       # Generate a new +Duration+ measuring the given number of microseconds.
       #
       # @param micros [Numeric]
@@ -200,6 +222,8 @@ module Monotime
         new(Integer(micros * 1_000))
       end
 
+      alias micros from_micros
+
       # Generate a new +Duration+ measuring the given number of nanoseconds.
       #
       # @param nanos [Numeric]
@@ -208,6 +232,8 @@ module Monotime
         new(Integer(nanos))
       end
 
+      alias nanos from_nanos
+
       # Return a +Duration+ measuring the elapsed time of the yielded block.
       #
       # @example
@@ -320,7 +346,7 @@ module Monotime
 
     # Generate a hash for this type and value.
     #
-    # @return [Fixnum]
+    # @return [Integer]
     def hash
       self.class.hash ^ to_nanos.hash
     end
@@ -332,6 +358,8 @@ module Monotime
       to_nanos / 1_000_000_000.0
     end
 
+    alias secs to_secs
+
     # Return this +Duration+ in milliseconds.
     #
     # @return [Float]
@@ -339,6 +367,8 @@ module Monotime
       to_nanos / 1_000_000.0
     end
 
+    alias millis to_millis
+
     # Return this +Duration+ in microseconds.
     #
     # @return [Float]
@@ -346,6 +376,8 @@ module Monotime
       to_nanos / 1_000.0
     end
 
+    alias micros to_micros
+
     # Return this +Duration+ in nanoseconds.
     #
     # @return [Integer]
@@ -353,6 +385,8 @@ module Monotime
       @ns
     end
 
+    alias nanos to_nanos
+
     # Return true if this +Duration+ is positive.
     #
     # @return [Boolean]
@@ -374,6 +408,13 @@ module Monotime
       to_nanos.zero?
     end
 
+    # Return true if this +Duration+ is non-zero.
+    #
+    # @return [Boolean]
+    def nonzero?
+      to_nanos.nonzero?
+    end
+
     # Sleep for the duration of this +Duration+.  Equivalent to
     # +Kernel.sleep(duration.to_secs)+.
     #

data/monotime.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov", "~> 0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monotime
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Thomas Hurst
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-13 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - tom@hur.st
@@ -62,6 +76,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md