cutoff 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d13746c455ac05f8491ccd8e5f8834370c0e4d41b77b440a2ee33f7c9bafb9db
-  data.tar.gz: 883490b2c6661605d81cf299f809175cadfd1e51b4c68bb218dfa8f996af23cc
+  metadata.gz: 7ab1dba25fcad8b3f65d816d1740dbd2c2e1b6102f4009e19fa36fd0baf8236c
+  data.tar.gz: 7a86b6dbf5c0d0bd6631281687c674ec21dc19102097bee351b8e13a3b2a53c3
 SHA512:
-  metadata.gz: e544dff1eb63defd93d8f1f260c12e843bb3178a1a523d63b327ea76ddea533bcd6ce7c68c2b697d859ad795ad62f8048549ae82997c0d6c9edbee92089de6c0
-  data.tar.gz: a1612206aaf0400aa50988b32b35fd7e27418d047e5aab6d7919dfedd30efeaa3675e97f9b6134233f13a54794c01ff7d8868ac892ebf711fc42ef2a65388de5
+  metadata.gz: e23dcd3d2fa5b44bcc3630aa4976cff12eef9771f4c1010a2cd12cc820ef5caabf1e54b0dba83de60af1ce2142eea4d53bae7c79e5c02ac34ec91d1e07cfba62
+  data.tar.gz: bfc01027499784eaeaf89f5bc4114483bf89bc41eb2db6668a297ace172b58136ae58b214df6f0929a027729aff417ff56b9fb4dfacd45cb979d280b675f3868

data/.yardopts

@@ -1,3 +1,4 @@
 --markup markdown
 --markup-provider redcarpet
 --no-private
+--no-api

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.1] - 2022-09-06
+
+### Changed
+
+- Upgrade rubocop to latest version #12 justinhoward
+- Add codecov.io code coverage #11 justinhoward
+- Complete yard documentation and fix warnings #13 justinhoward
+
+### Fixed
+
+- Pull cutoff option from job, not worker #14 mperham
+
 ## [0.5.0] - 2022-08-10
 
 ### Changed
@@ -58,7 +70,8 @@ to `Timeout::Error`. `CutoffError` changes from a class to a module.
 - Cutoff class
 - Mysql2 patch
 
-[Unreleased]: https://github.com/justinhoward/cutoff/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/justinhoward/cutoff/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/justinhoward/cutoff/compare/v0.5.0...v0.5.1
 [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

data/README.md

@@ -4,7 +4,7 @@ Cutoff
 [![Gem Version](https://badge.fury.io/rb/cutoff.svg)](https://badge.fury.io/rb/cutoff)
 [![CI](https://github.com/justinhoward/cutoff/workflows/CI/badge.svg)](https://github.com/justinhoward/cutoff/actions?query=workflow%3ACI+branch%3Amaster)
 [![Code Quality](https://app.codacy.com/project/badge/Grade/2748da79ec294f909996a56f11caac4a)](https://www.codacy.com/gh/justinhoward/cutoff/dashboard?utm_source=github.com&utm_medium=referral&utm_content=justinhoward/cutoff&utm_campaign=Badge_Grade)
-[![Code Coverage](https://app.codacy.com/project/badge/Coverage/2748da79ec294f909996a56f11caac4a)](https://www.codacy.com/gh/justinhoward/cutoff/dashboard?utm_source=github.com&utm_medium=referral&utm_content=justinhoward/cutoff&utm_campaign=Badge_Coverage)
+[![Code Coverage](https://codecov.io/gh/justinhoward/cutoff/branch/master/graph/badge.svg?token=COVM3D2PTG)](https://codecov.io/gh/justinhoward/cutoff)
 [![Inline docs](http://inch-ci.org/github/justinhoward/cutoff.svg?branch=master)](http://inch-ci.org/github/justinhoward/cutoff)
 
 A deadlines library for Ruby inspired by Shopify and

data/lib/cutoff/patch/mysql2.rb

@@ -167,4 +167,9 @@ class Cutoff
   end
 end
 
-Mysql2::Client.prepend(Cutoff::Patch::Mysql2)
+# @api external
+module Mysql2
+  class Client
+    prepend Cutoff::Patch::Mysql2
+  end
+end

data/lib/cutoff/patch/net_http.rb

@@ -8,21 +8,26 @@ class Cutoff
     # to the remaining cutoff time. You can select this patch with
     # `exclude` or `only` using the checkpoint name `:net_http`.
     module NetHttp
-      def self.gen_timeout_method(name)
-        <<~RUBY
-          if #{name}.nil? || #{name} > remaining
-            self.#{name} = cutoff.seconds_remaining
-          end
-        RUBY
-      end
+      class << self
+        private
+
+        def gen_timeout_method(name)
+          <<~RUBY
+            if #{name}.nil? || #{name} > remaining
+              self.#{name} = cutoff.seconds_remaining
+            end
+          RUBY
+        end
 
-      def self.use_write_timeout?
-        Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.6')
+        def use_write_timeout?
+          Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.6')
+        end
       end
 
       # Same as the original start, but adds a checkpoint for starting HTTP
       # requests and sets network timeouts to the remaining time
       #
+      # @method start
       # @see Net::HTTP#start
       module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
         def start
@@ -41,4 +46,9 @@ class Cutoff
   end
 end
 
-Net::HTTP.prepend(Cutoff::Patch::NetHttp)
+# @api external
+module Net
+  class HTTP
+    prepend Cutoff::Patch::NetHttp
+  end
+end

data/lib/cutoff/rails/controller.rb

@@ -3,6 +3,7 @@
 require 'action_controller'
 
 class Cutoff
+  # Cutoff Rails extensions
   module Rails
     # Rails controller integration
     module Controller
@@ -45,4 +46,9 @@ class Cutoff
   end
 end
 
-ActionController::Base.extend(Cutoff::Rails::Controller)
+# @api external
+module ActionController
+  class Base
+    extend Cutoff::Rails::Controller
+  end
+end

data/lib/cutoff/sidekiq.rb

@@ -3,6 +3,7 @@
 require 'sidekiq'
 
 class Cutoff
+  # Cutoff sidekiq extensions
   module Sidekiq
     # Add an option `cutoff` for sidekiq workers
     #
@@ -17,14 +18,14 @@ class Cutoff
     #     end
     #   end
     class ServerMiddleware
-      # @param worker [Object] the worker instance
-      # @param _job [Hash] the full job payload
+      # @param _worker [Object] the worker instance
+      # @param job [Hash] the full job payload
       # @param _queue [String] queue the name of the queue the job was pulled
       #   from
       # @yield the next middleware in the chain or worker `perform` method
       # @return [void]
-      def call(worker, _job, _queue)
-        allowed_seconds = worker.class.sidekiq_options['cutoff']
+      def call(_worker, job, _queue)
+        allowed_seconds = job['cutoff']
         return yield if allowed_seconds.nil?
 
         Cutoff.wrap(allowed_seconds) { yield }

data/lib/cutoff/timer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal:true
 
 class Cutoff
+  # Tracks the current time for cutoff
   module Timer
     if defined?(Process::CLOCK_MONOTONIC)
       # The current relative time

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.5.0')
+    Gem::Version.new('0.5.1')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cutoff
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,34 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.81.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.81.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.38.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.38.1
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +84,8 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/justinhoward/cutoff/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.5.0
+  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.5.1
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: