monotime 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88bca715126cabf9bf5ea1af377e16d43da5ecc06ee45f98dad584360eaa15b
-  data.tar.gz: 8f741d6219cfe4b9050f892f2df905ed603f859e4a79f930a4eb954c213bf639
+  metadata.gz: 8a9395967e506d690912041251bc7b6afd1a373aa49d0b4425ec08ca611e5238
+  data.tar.gz: '09ec6a1e96c9ce434d4847d275d85f7514c4a9bb3d9c71d205b04ab0f06e6d5b'
 SHA512:
-  metadata.gz: 5ed67631407691f935ffdd30727c4054b3fa7f5964a9cdcb0db0f94e1a2aecddb83eac4b1e4a8e032cd3c57145152e6649ddf14093643329ff23b5d43348000f
-  data.tar.gz: f38b77609652866fa4c1b7bfee164977a7f7895feeb0f76d8dd5e71a05da31b0cda24c680f5b2aef19c3f5c7787da237f580ee56ccb86e456dae576fc95d0e89
+  metadata.gz: a68a338484a8534a8953abf5bec0a98a6b7a2dc6a506cd1f5fb1e3b29e1b534fa0d41e4175aa81598273ee5d706d16caeb60ce1b89a92b5e8192f87a960265f3
+  data.tar.gz: f9f329d74339eccc1b4c50007d2cb93cc87132ce6a5841faa327d4db48dfb347df8faee3f9777551cb686e90001def65d72c8a77c6b6df4dfed1d847598ac685

data/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.5', '2.6', '2.7', '3.0', jruby, truffleruby]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   Exclude:
     - "bin/*"
     - "test/*"
@@ -6,7 +7,7 @@ AllCops:
     - "Rakefile"
     - "Gemfile"
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 96
 
 Metrics/ClassLength:
@@ -20,3 +21,18 @@ Style/AccessModifierDeclarations:
 
 Style/FormatStringToken:
   Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.7.1 - 2021-10-22
+### Added
+ - `simplecov` introduced to test suite.
+ - `monotime/include.rb` to auto-include types globally.
+
+### Changed
+ - All `Instant` and `Duration` instances are now frozen.
+ - Migrate from Travis CI to Github Actions
+ - Update development dependency on `rake`.
+
 ## [0.7.0] - 2019-04-24
 ### Added
  - `Duration.with_measure`, which yields and returns an array containing its

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/monotime.svg)](https://badge.fury.io/rb/monotime)
-[![Build Status](https://travis-ci.org/Freaky/monotime.svg?branch=master)](https://travis-ci.org/Freaky/monotime)
+![Build Status](https://github.com/Freaky/monotime/actions/workflows/ci.yml/badge.svg)
 [![Inline docs](http://inch-ci.org/github/Freaky/monotime.svg?branch=master)](http://inch-ci.org/github/Freaky/monotime)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/monotime)
 
@@ -23,10 +23,17 @@ Or install it yourself as:
 
     $ gem install monotime
 
-`Monotime` is tested on Ruby 2.4—2.6 and recent JRuby 9.x releases.
+`Monotime` is tested on Ruby 2.5—3.0 and recent JRuby 9.x releases.
 
 ## Usage
 
+```ruby
+require 'monotime'
+# or, to automatically include Monotime::* in the global scope,
+# as used by these examples:
+require 'monotime/include'
+```
+
 `Monotime` offers a `Duration` type for describing spans of time, and an
 `Instant` type for describing points in time.  Both operate at nanosecond
 resolution to the limits of whatever your Ruby implementation supports.
@@ -36,8 +43,6 @@ start point, perform the action and then ask for the `Duration` that has elapsed
 since:
 
 ```ruby
-include Monotime
-
 start = Instant.now
 do_something
 elapsed = start.elapsed
@@ -47,9 +52,7 @@ Or use a convenience method:
 
 ```ruby
 elapsed = Duration.measure { do_something }
-
 # or
-
 return_value, elapsed = Duration.with_measure { compute_something }
 ```
 
@@ -98,34 +101,37 @@ is not yet implemented):
 ```ruby
 # Equivalent
 sleep(Duration.secs(1).secs)  # => 1
-
-Duration.secs(1).sleep           # => 1
+Duration.secs(1).sleep        # => 1
 ```
 
 So can `Instant`, taking a `Duration` and sleeping until the given `Duration`
-past the time the `Instant` was created, if any.  This may be useful if you wish
-to maintain an approximate interval while performing work in between:
+past the time the `Instant` was created, if any. This can be useful for
+maintaining a precise candence between tasks:
 
 ```ruby
-poke_duration = Duration.secs(60)
+interval = Duration.secs(60)
+start = Instant.now
 loop do
-  start = Instant.now
-  poke_my_api(api_to_poke, what_to_poke_it_with)
-  start.sleep(poke_duration) # sleeps 60 seconds minus how long poke_my_api took
-  # alternative: start.sleep_secs(60)
+  do_stuff
+  start.sleep(interval)
+  start += interval
 end
 ```
 
-Or you can declare a future `Instant` and ask to sleep until it passes:
+Or you can declare an `Instant` in the future and sleep to that point:
 
 ```ruby
-next_minute = Instant.now + Duration.secs(60)
-do_stuff
-next_minute.sleep # => sleeps any remaining seconds
+interval = Duration.secs(60)
+deadline = Instant.now + interval
+loop do
+  do_stuff
+  deadline.sleep
+  deadline += interval
+end
 ```
 
 `Instant#sleep` returns a `Duration` which was slept, or a negative `Duration`
-if the desired sleep period has passed.
+indicating that the desired sleep point was in the past.
 
 ## Duration duck typing
 
@@ -174,5 +180,3 @@ depending on platform.
 which also includes a variety of features for gathering statistics about
 measurements, and may offer higher precision on some platforms.
 
-Note until [#73](https://github.com/copiousfreetime/hitimes/pull/73) is closed it
-depends on compiled C/Java extensions.

data/lib/monotime/duration.rb

@@ -14,6 +14,7 @@ module Monotime
     # @see #from_nanos
     def initialize(nanos = 0)
       @ns = Integer(nanos)
+      freeze
     end
 
     class << self

data/lib/monotime/include.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'monotime'
+
+include Monotime

data/lib/monotime/instant.rb

@@ -19,6 +19,7 @@ module Monotime
     # @see #now
     def initialize(nanos = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond))
       @ns = Integer(nanos)
+      freeze
     end
 
     # An alias to +new+, and generally preferred over it.

data/lib/monotime/version.rb

@@ -2,5 +2,5 @@
 
 module Monotime
   # Try to avoid blatting existing VERSION constants when we're included.
-  MONOTIME_VERSION = '0.7.0'
+  MONOTIME_VERSION = '0.7.1'
 end

data/monotime.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov", "~> 0.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monotime
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Thomas Hurst
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,16 +52,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+description:
 email:
 - tom@hur.st
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -71,6 +85,7 @@ files:
 - bin/setup
 - lib/monotime.rb
 - lib/monotime/duration.rb
+- lib/monotime/include.rb
 - lib/monotime/instant.rb
 - lib/monotime/version.rb
 - monotime.gemspec
@@ -79,7 +94,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,9 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A sensible interface to the monotonic clock
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-  - jruby-9.2.7.0
-before_install: gem install bundler -v "~> 2"