action_controller-stashed_redirects 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48ec4248e68dd1601b20102049942417dd5fb85a6411b3e23940457653cb7bf8
-  data.tar.gz: 6e94e481bd7777dee9dc8f418aca0ffba90211058ac5c674585c582c5d133573
+  metadata.gz: cf64ad8ee2fb60526d8517bb26be521de7952bcfd87ed860bfe5ce2fe8a0deb0
+  data.tar.gz: ce4550656d8f30fc4629f72329229542c457403e95803177260fbe575e9ab51a
 SHA512:
-  metadata.gz: d917ddb4a35845beb4b4dc57db8dc276e9017b0b5156c7dd3f321af6c17ecd050c468a6ad4cef51181a50c8c103a677d56762b328de5508862400f992b3519c2
-  data.tar.gz: cda0947e46c98f256995b240cbd4aded5771e8ae34352e1f228e6b65010664dd408e23f080f587fad1df6ff0c71dd6022018a7f7a14c98f0e8ced4bc85c20f19
+  metadata.gz: f4188865c205f58bf080d879f50ad818716bac84145b568db85324ea5cbb1aa0f2afe1df87a8e9f2cb29be276ed66dfdceb9ca359e58292e7f11cfff5163c76e
+  data.tar.gz: 2ab7965676ca7d50f881f26ae8fb5bdac89624a02642303feeab5db5191065d73aa7af578533d98fa7b61eb72f8d34c33e8c2f6ad686aaf2a44d07ba32659f75

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    action_controller-stashed_redirects (0.2.0)
+    action_controller-stashed_redirects (0.2.2)
       actionpack (>= 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.2)
-      actionview (= 7.1.2)
-      activesupport (= 7.1.2)
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4)
@@ -17,13 +17,13 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.2)
-      activesupport (= 7.1.2)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.2)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -34,42 +34,41 @@ GEM
       mutex_m
       tzinfo (~> 2.0)
     base64 (0.2.0)
-    bigdecimal (3.1.5)
-    builder (3.2.4)
-    concurrent-ruby (1.2.2)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     crass (1.0.6)
-    debug (1.9.1)
+    debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    drb (2.2.0)
-      ruby2_keywords
-    erubi (1.12.0)
-    i18n (1.14.1)
+    drb (2.2.1)
+    erubi (1.13.0)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    io-console (0.7.1)
-    irb (1.11.0)
-      rdoc
-      reline (>= 0.3.8)
+    io-console (0.7.2)
+    irb (1.13.2)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (5.20.0)
+    minitest (5.24.1)
     mutex_m (0.2.0)
-    nokogiri (1.16.0-aarch64-linux)
+    nokogiri (1.16.6-aarch64-linux)
       racc (~> 1.4)
-    nokogiri (1.16.0-arm-linux)
+    nokogiri (1.16.6-arm-linux)
       racc (~> 1.4)
-    nokogiri (1.16.0-arm64-darwin)
+    nokogiri (1.16.6-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.0-x86-linux)
+    nokogiri (1.16.6-x86-linux)
       racc (~> 1.4)
-    nokogiri (1.16.0-x86_64-linux)
+    nokogiri (1.16.6-x86_64-linux)
       racc (~> 1.4)
     psych (5.1.2)
       stringio
-    racc (1.7.3)
-    rack (3.0.8)
+    racc (1.8.0)
+    rack (3.1.6)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -84,26 +83,25 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.2)
-      actionpack (= 7.1.2)
-      activesupport (= 7.1.2)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       irb
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
-    rake (13.1.0)
-    rdoc (6.6.2)
+    rake (13.2.1)
+    rdoc (6.7.0)
       psych (>= 4.0.0)
-    reline (0.4.2)
+    reline (0.5.9)
       io-console (~> 0.5)
-    ruby2_keywords (0.0.5)
-    stringio (3.1.0)
-    thor (1.3.0)
+    stringio (3.1.1)
+    thor (1.3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     webrick (1.8.1)
-    zeitwerk (2.6.12)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   arm64-darwin-20
@@ -118,4 +116,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.5.4
+   2.5.14

data/README.md

@@ -65,10 +65,8 @@ end
 ```ruby
 # app/controllers/concerns/sudo/examination.rb
 module Sudo::Examination
-  extend ActiveSupport::Concern
-
-  class_methods do
-    def require_sudo_on(*actions, **options) = require_sudo(only: *actions, **options)
+  def self.included(klass) = klass.singleton_class.class_eval do
+    def require_sudo_on(*actions, **) = require_sudo(only: *actions, **)
     def require_sudo(...) = before_action(:require_sudo, ...)
   end
 
@@ -76,7 +74,7 @@ module Sudo::Examination
     def require_sudo
       if sudo.exam_needed?
         raise "Non-get: can't redirect back here, make sure you do …something with an interstitial page?" unless request.get?
-        redirect_to new_sudo_authentications_url(redirect_url: request.url)
+        redirect_to new_sudo_exams_url(redirect_url: request.url)
       end
     end
 
@@ -89,7 +87,7 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-Notice how in `redirect_to new_sudo_authentications_url(redirect_url: request.original_url)` we're passing the `redirect_url:` along that `ActionController::StashedRedirects` will need.
+Notice how in `redirect_to new_sudo_exams_url(redirect_url: request.url)` we're passing the `redirect_url:` along that `ActionController::StashedRedirects` will need.
 It's pointing back to the page we're on, which required sudo authentication, so we can redirect back to it after the sudo exam has been passed.
 
 Next up, we can add an in-memory PORO model to give the behavior some better names:
@@ -108,11 +106,11 @@ class Sudo < Data.define(:store)
 end
 ```
 
-Finally, we can add the authenticating sudo controller itself, where `stash_redirect_for` will use the `redirect_url:` from earlier:
+Next, we can add the authenticating sudo controller itself, where `stash_redirect_for` will use the `redirect_url:` from earlier:
 
 ```ruby
-# app/controllers/sudo/authentications_controller.rb
-class Sudo::AuthenticationsController < ApplicationController
+# app/controllers/sudo/exams_controller.rb
+class Sudo::ExamsController < ApplicationController
   stash_redirect_for :sudo, on: :new
 
   def new
@@ -129,14 +127,18 @@ class Sudo::AuthenticationsController < ApplicationController
   end
   private def pass_sudo_exam? = Current.user.authenticate_password(params[:password])
 end
+```
 
+Finally, we mount the routes for the controller:
+
+```ruby
 # config/routes.rb
 namespace :sudo do
-  resources :authentications
+  resources :exams
 end
 ```
 
-Users can now fill-in their password, which will hit `sudo/authentications#create` and redirect them back to the edit form on the
+Users can now fill-in their password, which will hit `sudo/exams#create` and redirect them back to the edit form on the
 credit cards flow if it's the correct password.
 
 ## Installation

data/lib/action_controller/stashed_redirects/version.rb

@@ -2,6 +2,6 @@
 
 module ActionController
   module StashedRedirects
-    VERSION = "0.2.0"
+    VERSION = "0.2.2"
   end
 end

data/lib/action_controller/stashed_redirects.rb

@@ -83,12 +83,18 @@ module ActionController::StashedRedirects
       end
     end
 
-    # Looks up a redirect URL from `params[:redirect_url]` using
-    # `url_from` as the protection mechanism to ensure it's a valid internal redirect.
+    # Syntactic sugar for redirecting to `redirect_url` with a fallback.
     #
-    # Can be passed to `redirect_to` with a fallback:
+    #   redirect_forward_or_to root_url # => redirect_to redirect_url || root_url
+    def redirect_forward_or_to(fallback_url)
+      redirect_to redirect_url || fallback_url
+    end
+
+    # Looks up a redirect URL from `params[:redirect_url]` using
+    # Rails' `url_from` as the protection mechanism to ensure it's a valid internal redirect.
+    # See the `url_from` docs: https://api.rubyonrails.org/classes/ActionController/Redirecting.html#method-i-url_from
     #
-    #   redirect_to redirect_url || users_url
+    # You probably want to use `redirect_forward_or_to`.
     def redirect_url = url_from(params[:redirect_url])
 
     DEFAULT_URL = Object.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_controller-stashed_redirects
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Kasper Timm Hansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-08 00:00:00.000000000 Z
+date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack