cutoff 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64171df8b5550b99b603ba4bae4874174cc5e4bcce2632318be777ecc932dce3
-  data.tar.gz: 39ee62f1f743fdce6d9dd3e873bd3acf4d7efd09907d0f9e265e98c786cb7dc9
+  metadata.gz: 8010fa3d0714c498fdb4ec4d34ea2dbf9fe4b05f534521d029adf370a51300bc
+  data.tar.gz: 1ba8ed1d6b3c544ab72bc549be87b70c0e9b23c0594bcf74319e828abe0834a0
 SHA512:
-  metadata.gz: bb41605b534178706b45f3e6921aad80ff0ff50606038d95d9d50267910a590df59969cb77b1c7879d0b2cd429c60205a418e1ff590b1dd7b4e7f4394b0f4f3c
-  data.tar.gz: 713d75df722a2f82414373d482d4a981e9a579069de55262afe12004287abdd5b6f2e7e09052130a3b0ce875658e8177ce519bdadb549dbb92dc8970f9cd0813
+  metadata.gz: ee6ada9ba95a71a0717e79f1e0ab113910b4693ad285452dd0852a36d7f6613f57878d9272ae9d088334e2571c3b06a68d01dc0a2d8d92b1d835aec33858def8
+  data.tar.gz: 14021607c75f24f0a8bbbeb711adb42f2d93c526ea30ba76386b972b108818fcb05a23bc4b4035659a76791fdeff4cf821478e95d0e4107af65ffe03a38f1f5d

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2021-08-20
+
+- Allow timers to be disabled globally with `Cutoff.disable!`
+
 ## [0.2.0] - 2021-07-22
 
 ### Added
@@ -20,6 +24,7 @@ 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.2.0...HEAD
+[Unreleased]: https://github.com/justinhoward/cutoff/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/justinhoward/cutoff/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/justinhoward/cutoff/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/justinhoward/cutoff/releases/tag/v0.1.0

data/README.md

@@ -250,6 +250,22 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+Disabling Cutoff for Testing and Development
+------------
+
+When testing or debugging an application that uses Cutoff, you may want to
+disable Cutoff entirely. These methods are not thread-safe and not intended for
+production.
+
+```ruby
+# This disables all cutoff timers, for both global and local instances
+Cutoff.disable!
+Cutoff.disabled? # => true
+
+# Re-enable cutoff
+Cutoff.enable!
+```
+
 Multi-threading
 -----------------
 

data/lib/cutoff.rb

@@ -3,11 +3,14 @@
 require_relative 'cutoff/version'
 require_relative 'cutoff/error'
 require_relative 'cutoff/patch'
+require_relative 'cutoff/timer'
 
 class Cutoff
   CURRENT_STACK_KEY = 'cutoff_deadline_stack'
   private_constant :CURRENT_STACK_KEY
 
+  extend Timer
+
   class << self
     # Get the current {Cutoff} if one is set
     def current
@@ -85,31 +88,29 @@ class Cutoff
       cutoff.checkpoint!
     end
 
-    if defined?(Process::CLOCK_MONOTONIC_RAW)
-      # The current 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
-      #
-      # @return [Float] The current time as a float
-      def now
-        Process.clock_gettime(Process::CLOCK_MONOTONIC_RAW)
-      end
-    elsif defined?(Process::CLOCK_MONOTONIC)
-      def now
-        Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      end
-    elsif Gem.loaded_specs['concurrent-ruby']
-      require 'concurrent-ruby'
-
-      def now
-        Concurrent.monotonic_time
-      end
-    else
-      def now
-        Time.now.to_f
-      end
+    # Disable Cutoff globally. Useful for testing and debugging
+    #
+    # Should not be used in production
+    #
+    # @return [void]
+    def disable!
+      @disabled = true
+    end
+
+    # Enable Cutoff globally if it has been disabled
+    #
+    # Should not be used in production
+    #
+    # @return [void]
+    def enable!
+      @disabled = false
+    end
+
+    # True if cutoff was disabled with {#disable!}
+    #
+    # @return [Boolean] True if disabled
+    def disabled?
+      @disabled == true
     end
   end
 
@@ -144,6 +145,8 @@ class Cutoff
   #
   # @return [Float] The number of seconds
   def elapsed_seconds
+    return 0 if Cutoff.disabled?
+
     Cutoff.now - @start_time
   end
 

data/lib/cutoff/timer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal:true
+
+class Cutoff
+  module Timer
+    if defined?(Process::CLOCK_MONOTONIC_RAW)
+      # The current 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
+      #
+      # @return [Float] The current time as a float
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC_RAW)
+      end
+    elsif defined?(Process::CLOCK_MONOTONIC)
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    elsif Gem.loaded_specs['concurrent-ruby']
+      require 'concurrent-ruby'
+
+      def now
+        Concurrent.monotonic_time
+      end
+    else
+      def now
+        Time.now.to_f
+      end
+    end
+  end
+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.2.0')
+    Gem::Version.new('0.3.0')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cutoff
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -88,13 +88,14 @@ files:
 - lib/cutoff/patch.rb
 - lib/cutoff/patch/mysql2.rb
 - lib/cutoff/patch/net_http.rb
+- lib/cutoff/timer.rb
 - lib/cutoff/version.rb
 homepage: https://github.com/justinhoward/cutoff
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/justinhoward/cutoff/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.2.0
+  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.3.0
 post_install_message: 
 rdoc_options: []
 require_paths: