cutoff 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8010fa3d0714c498fdb4ec4d34ea2dbf9fe4b05f534521d029adf370a51300bc
-  data.tar.gz: 1ba8ed1d6b3c544ab72bc549be87b70c0e9b23c0594bcf74319e828abe0834a0
+  metadata.gz: 630a704243a3bd8c2196e0be8bba735eb8f2afb185c3db7ba68f3c8bed242041
+  data.tar.gz: 1922fbb0c382c62fd894cd8d2f0bfa2d21ef5bbf2cdb5f7b128d9de582c14344
 SHA512:
-  metadata.gz: ee6ada9ba95a71a0717e79f1e0ab113910b4693ad285452dd0852a36d7f6613f57878d9272ae9d088334e2571c3b06a68d01dc0a2d8d92b1d835aec33858def8
-  data.tar.gz: 14021607c75f24f0a8bbbeb711adb42f2d93c526ea30ba76386b972b108818fcb05a23bc4b4035659a76791fdeff4cf821478e95d0e4107af65ffe03a38f1f5d
+  metadata.gz: 7dcb206df1a3dc2ce265e0b78f0d93a8c3ddfe1f92b52945ff06cc87fa20ecfcaf2f4f9636555966b7c5cd9b624a498be788bd8fdf3d6c67cd9c5ffbd35aa393
+  data.tar.gz: 8178c8dd01267bc67b96eef6b2ff103f90a9e47954c55d10b33f1c21a39f36701bfb2bfd0e6896f6975a210e66c09611cd8cf419d9ea62b2cf489603dcff8808

data/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2021-10-01
+
+- Add benchmarks and slight performance improvements
+- Add Rails controller integration
+
 ## [0.3.0] - 2021-08-20
 
 - Allow timers to be disabled globally with `Cutoff.disable!`
@@ -24,7 +29,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.3.0...HEAD
+[Unreleased]: https://github.com/justinhoward/cutoff/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/justinhoward/cutoff/compare/v0.3.0...v0.4.0
 [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

@@ -220,25 +220,52 @@ end
 Timing a Rails Controller
 ---------------------------
 
-One use of a cutoff is to add a deadline to a Rails controller action.
+One use of a cutoff is to add a deadline to a Rails controller action. This is
+typically preferable to approaches like `Rack::Timeout` that use the dangerous
+`Timeout` class.
+
+Cutoff includes a built-in integration for this purpose. If Rails is installed,
+the `#cutoff` class method is available in your controllers.
 
 ```ruby
-around_action { |_controller, action| Cutoff.wrap(2.5) { action.call } }
+class ApplicationController < ActionController::Base
+  # You may want to set a long global cutoff, but it's not required
+  cutoff 30
+end
+
+class UsersController < ApplicationController
+  cutoff 5.0
+
+  def index
+    # Now in your action, you can call `checkpoint!`, or if you're using the
+    # patches, checkpoints will be added automatically
+    Cutoff.checkpoint!
+  end
+end
 ```
 
-Now in your action, you can call `checkpoint!`, or if you're using the Mysql2
-patch, checkpoints will be added automatically.
+Just like with controller filters, you can use filters with the cutoff method.
 
 ```ruby
-def index
-  # Do thing one
-  Cutoff.checkpoint!
+class UsersController < ApplicationController
+  # For example, use an :only filter
+  cutoff 5.0, only: :index
+
+  # Multiple calls work just fine. Last match wins
+  cutoff 2.5, only: :show
 
-  # Do something else
+  def index
+    # ...
+  end
+
+  def show
+    # ...
+  end
 end
 ```
 
-Consider adding a global error handler for the `Cutoff::CutoffExceededError`
+Consider adding a global error handler for the `Cutoff::CutoffExceededError` in
+case you want to display a nice error page for timeouts.
 
 ```ruby
 class ApplicationController < ActionController::Base

data/lib/cutoff/patch/mysql2.rb

@@ -45,8 +45,8 @@ class Cutoff
 
           # Loop through tokens like "WORD " or "/* "
           while @scanner.scan(/(\S+)\s+/)
-            # Get the word part. None of our tokens care about case
-            handle_token(@scanner[1].downcase)
+            # Get the word part
+            handle_token(@scanner[1])
           end
 
           return @scanner.string unless @found_select
@@ -68,7 +68,7 @@ class Cutoff
             hint_comment
           elsif token.start_with?('/*')
             block_comment
-          elsif token.start_with?('select')
+          elsif token.match?(/^select/i)
             select
           else
             other

data/lib/cutoff/rails/controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'action_controller'
+
+class Cutoff
+  module Rails
+    # Rails controller integration
+    module Controller
+      # Set a cutoff for the controller
+      #
+      # Can be called multiple times with different options to configure
+      # cutoffs for various conditions. If multiple conditions match a given
+      # controller, the last applied cutoff "wins".
+      #
+      # @example
+      #   class ApplicationController
+      #     # Apply a global maximum
+      #     cutoff 30
+      #   end
+      #
+      #   class UsersController < ApplicationController
+      #     # Override the base time limit
+      #     cutoff 5.0
+      #     cutoff 3.0, only: :show
+      #     cutoff 7, if: :signed_in
+      #   end
+      #
+      # @param seconds [Float, Integer] The allowed seconds for a controller
+      #   action
+      # @param options [Hash] Options to pass to `around_action`. For example,
+      #   pass `:only`, `:except`, `:if`, to limit the scope of the cutoff.
+      def cutoff(seconds, options = {})
+        prepend_around_action(options) do |_controller, action|
+          next action.call if @cutoff_wrapped
+
+          begin
+            @cutoff_wrapped = true
+            Cutoff.wrap(seconds, &action)
+          ensure
+            @cutoff_wrapped = false
+          end
+        end
+      end
+    end
+  end
+end
+
+ActionController::Base.extend(Cutoff::Rails::Controller)

data/lib/cutoff/rails.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Namespace for Rails integration
+module Rails
+end
+
+require 'cutoff/rails/controller' if Gem.loaded_specs['actionpack']

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

data/lib/cutoff.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal:true
 
-require_relative 'cutoff/version'
-require_relative 'cutoff/error'
-require_relative 'cutoff/patch'
-require_relative 'cutoff/timer'
+require 'cutoff/version'
+require 'cutoff/error'
+require 'cutoff/patch'
+require 'cutoff/timer'
+require 'cutoff/rails'
 
 class Cutoff
   CURRENT_STACK_KEY = 'cutoff_deadline_stack'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cutoff
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,8 @@ files:
 - lib/cutoff/patch.rb
 - lib/cutoff/patch/mysql2.rb
 - lib/cutoff/patch/net_http.rb
+- lib/cutoff/rails.rb
+- lib/cutoff/rails/controller.rb
 - lib/cutoff/timer.rb
 - lib/cutoff/version.rb
 homepage: https://github.com/justinhoward/cutoff
@@ -95,7 +111,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/justinhoward/cutoff/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.3.0
+  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.4.0
 post_install_message: 
 rdoc_options: []
 require_paths: