cutoff 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d00ff1f831beec4fed582b5faa9ed42c350c13b32217bdcab0b850445ba9c358
-  data.tar.gz: 77d466db54a822240d2d27cfdb120f98aa7f7435ec62ae15191292702580de79
+  metadata.gz: d13746c455ac05f8491ccd8e5f8834370c0e4d41b77b440a2ee33f7c9bafb9db
+  data.tar.gz: 883490b2c6661605d81cf299f809175cadfd1e51b4c68bb218dfa8f996af23cc
 SHA512:
-  metadata.gz: 9821d7010a4663ce25497a129c5a04166b5f701bd30d1d7a20f183cd274444605f3ac14099857c22117d45ac980056f4ccbaf09e8b65403e83a93abc923ced90
-  data.tar.gz: ec1f98a8885f8938ba421d87cb82f7f16a79161a778d2e4c230204f2243009b001e4c5de8c95ca1153746a8eebb90f969ca5efe80390cd08f901ee943a06581f
+  metadata.gz: e544dff1eb63defd93d8f1f260c12e843bb3178a1a523d63b327ea76ddea533bcd6ce7c68c2b697d859ad795ad62f8048549ae82997c0d6c9edbee92089de6c0
+  data.tar.gz: a1612206aaf0400aa50988b32b35fd7e27418d047e5aab6d7919dfedd30efeaa3675e97f9b6134233f13a54794c01ff7d8868ac892ebf711fc42ef2a65388de5

data/CHANGELOG.md

@@ -7,22 +7,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2022-08-10
+
+### Changed
+
+- Use CLOCK_MONOTONIC instead of CLOCK_MONOTONIC_RAW #10 justinhoward
+- Change CutoffExceededError to inherit from Timeout::Error #9 justinhoward
+
+### Breaking
+
+PR #9 changes the parent class of `Cutoff::CutoffExceededError` from `CutoffError`
+to `Timeout::Error`. `CutoffError` changes from a class to a module.
+
 ## [0.4.2] - 2021-10-14
 
+### Added
+
 - Add sidekiq middleware
 - Select checkpoints to enable or disable
 
 ## [0.4.1] - 2021-10-02
 
+### Fixed
+
 - Fix Net::HTTP patch to override timeouts given to start
 
 ## [0.4.0] - 2021-10-01
 
+### Added
+
 - Add benchmarks and slight performance improvements
 - Add Rails controller integration
 
 ## [0.3.0] - 2021-08-20
 
+### Added
+
 - Allow timers to be disabled globally with `Cutoff.disable!`
 
 ## [0.2.0] - 2021-07-22
@@ -38,7 +58,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Cutoff class
 - Mysql2 patch
 
-[Unreleased]: https://github.com/justinhoward/cutoff/compare/v0.4.1...HEAD
+[Unreleased]: https://github.com/justinhoward/cutoff/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/justinhoward/cutoff/compare/v0.4.2...v0.5.0
 [0.4.2]: https://github.com/justinhoward/cutoff/compare/v0.4.1...v0.4.2
 [0.4.1]: https://github.com/justinhoward/cutoff/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/justinhoward/cutoff/compare/v0.3.0...v0.4.0

data/lib/cutoff/error.rb

@@ -2,7 +2,7 @@
 
 class Cutoff
   # The Cutoff base error class
-  class CutoffError < StandardError
+  module CutoffError
     private
 
     def message_with_meta(message, **meta)
@@ -15,7 +15,9 @@ class Cutoff
   end
 
   # Raised by {Cutoff#checkpoint!} if the time has been exceeded
-  class CutoffExceededError < CutoffError
+  class CutoffExceededError < Timeout::Error
+    include CutoffError
+
     attr_reader :cutoff
 
     def initialize(cutoff)

data/lib/cutoff/timer.rb

@@ -2,18 +2,17 @@
 
 class Cutoff
   module Timer
-    if defined?(Process::CLOCK_MONOTONIC_RAW)
-      # The current time
+    if defined?(Process::CLOCK_MONOTONIC)
+      # The current relative time
       #
       # If it is available, this will use a monotonic clock. This is a clock
-      # that always moves forward in time. If that is not available on this
-      # system, `Time.now` will be used
+      # that always moves forward in time and starts at an arbitrary point
+      # (such as system startup time). If that is not available on this system,
+      # `Time.now` will be used.
       #
-      # @return [Float] The current time as a float
-      def now
-        Process.clock_gettime(Process::CLOCK_MONOTONIC_RAW)
-      end
-    elsif defined?(Process::CLOCK_MONOTONIC)
+      # This does not represent current real time
+      #
+      # @return [Float] The current relative time as a float
       def now
         Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end

data/lib/cutoff/version.rb

@@ -3,6 +3,6 @@
 class Cutoff
   # @return [Gem::Version] The current version of the cutoff gem
   def self.version
-    Gem::Version.new('0.4.2')
+    Gem::Version.new('0.5.0')
   end
 end

data/lib/cutoff.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal:true
 
 require 'set'
+require 'timeout'
 
 require 'cutoff/version'
 require 'cutoff/error'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cutoff
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -112,7 +112,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/justinhoward/cutoff/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.4.2
+  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.5.0
 post_install_message: 
 rdoc_options: []
 require_paths: