rails-rfc6570 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1024d8d48a4b71d05fef63d55be57a7615070e7e337f55ab46b4e5f7f2bebe3
-  data.tar.gz: 5af240717ecd2ce3231c51f9162bb938b0880228728103d6f3cbf2f180dad475
+  metadata.gz: 9da33d88750739a23961a9f48f5b26c2bb5e979a38a73f7646407ce41437a599
+  data.tar.gz: f8083a5cbcda1e9fe0b8bea8417161a9ae9940d784098f1507e7cbcf52a73f32
 SHA512:
-  metadata.gz: d5585791e180636510de263564a9f1104fb888b4455efaed5351d848288eabecb45a4e58df6ff4354e7a4fce28203d154ec8bb129bfcbb8f8ebb1aae3bbc0770
-  data.tar.gz: 5518b0541f5c7331202383b5fd9686e358ddf7fc66820b8c2932e0f6b7fbc45470d3fe9eff1d38b63f06ba3626362c63dbeae1af84baf415f7b0be8a7aa16da9
+  metadata.gz: 4342753841b8c3e94054412f1a275fc67be3ac6d2cde95fe16731e5d920a4e7b5e833c6dd4cb3a9b54f3f33be1ffda3a17a7f4be21e91fac8c5f3e192093da71
+  data.tar.gz: 5891d48dd9cbb1fe6a7b9a98b0cee339794d5f1da49cd7fa2e14e4314b22ed9729d1b8e3bd6c50fdfa136a777f8c3f21e3f484391b40d046cbba0059b2dad699

data/CHANGELOG.md

@@ -11,10 +11,32 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a Ch
 
 ### Changes
 
+- Optimize named `*_rfc6570` helpers by removing unnecessary indirection
+- Optimize `#rfc6570_routes` and `#rfc6570_route` helpers
+
 ### Fixes
 
+- Fix up `RouteSet#to_rfc6570` and `NamedRouteCollection#to_rfc6570`
+
 ### Breaks
 
+## 3.4.0 - (2025-01-31)
+
+---
+
+### New
+
+- Support for Ruby 3.4
+
+### Changes
+
+- Optimize named `*_rfc6570` helpers by removing unnecessary indirection
+- Optimize `#rfc6570_routes` and `#rfc6570_route` helpers
+
+### Fixes
+
+- Fix up `RouteSet#to_rfc6570` and `NamedRouteCollection#to_rfc6570`
+
 ## 3.3.0 - (2024-11-25)
 
 ---

data/README.md

@@ -3,7 +3,9 @@
 [![Gem Version](https://img.shields.io/gem/v/rails-rfc6570?logo=ruby)](https://rubygems.org/gems/rails-rfc6570)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/jgraichen/rails-rfc6570/test.yml?logo=github)](https://github.com/jgraichen/rails-rfc6570/actions/workflows/test.yml)
 
-Pragmatic access to your Rails routes as RFC6570 URI templates. Tested with Rails 6.1, 7.0, 7.1, 7.2 and Ruby 2.7, 3.0, 3.1, 3.2, 3.3.
+Pragmatic access to your Rails routes as RFC6570 URI templates.
+
+Tested with Rails 6.1, 7.0, 7.1, 7.2 and Ruby 2.7, 3.0, 3.1, 3.2, 3.3, and 3.4.
 
 ## Installation
 

data/lib/rails/rfc6570/version.rb

@@ -4,7 +4,7 @@ module Rails
   module RFC6570
     module VERSION
       MAJOR = 3
-      MINOR = 3
+      MINOR = 4
       PATCH = 0
       STAGE = nil
 

data/lib/rails/rfc6570.rb

@@ -32,14 +32,14 @@ module Rails
 
     module Extensions
       module RouteSet
-        def to_rfc6570(opts = {})
-          routes.map {|r| r.to_rfc6570(opts) }
+        def to_rfc6570(**opts)
+          named_routes.to_rfc6570(**opts)
         end
       end
 
       module NamedRouteCollection
-        def to_rfc6570(opts = {})
-          routes.to_h {|n, r| [n, r.to_rfc6570(opts)] }
+        def to_rfc6570(**opts)
+          routes.to_h {|name, route| [name, route.to_rfc6570(**opts)] }
         end
 
         def define_rfc6570_helpers(name, route, mod, set)
@@ -53,25 +53,15 @@ module Rails
 
           mod.module_eval do
             define_method(rfc6570_name) do |**opts|
-              ::Rails::RFC6570.build_url_template(self, route, **opts)
+              route.to_rfc6570(**opts, ctx: self)
             end
 
             define_method(rfc6570_url_name) do |**opts|
-              ::Rails::RFC6570.build_url_template(
-                self,
-                route,
-                **opts,
-                path_only: false,
-              )
+              route.to_rfc6570(**opts, ctx: self, path_only: false)
             end
 
             define_method(rfc6570_path_name) do |**opts|
-              ::Rails::RFC6570.build_url_template(
-                self,
-                route,
-                **opts,
-                path_only: true,
-              )
+              route.to_rfc6570(**opts, ctx: self, path_only: true)
             end
           end
 
@@ -98,16 +88,11 @@ module Rails
 
     module Helper
       def rfc6570_routes(**opts)
-        routes = {}
-        Rails.application.routes.named_routes.names.each do |key|
-          routes[key] = rfc6570_route(key, **opts)
-        end
-
-        routes
+        _routes.named_routes.to_rfc6570(**opts, ctx: self)
       end
 
       def rfc6570_route(name, **opts)
-        route = Rails.application.routes.named_routes[name]
+        route = _routes.named_routes[name]
         raise KeyError.new "No named routed for `#{name}'." unless route
 
         route.to_rfc6570(**opts, ctx: self)
@@ -130,15 +115,11 @@ module Rails
 
     def params_for(controller, action)
       ctr = "#{controller.camelize}Controller".constantize
-      ctr.rfc6570_defs[action.to_sym] if ctr.respond_to?(:rfc6570_defs)
+      ctr.rfc6570_params_for(action.to_sym) if ctr.respond_to?(:rfc6570_params_for)
     rescue NameError
       nil
     end
 
-    def build_url_template(ctx, route, **kwargs)
-      route.to_rfc6570(ctx: ctx, **kwargs)
-    end
-
     extend self # rubocop:disable Style/ModuleFunction
   end
 end

data/spec/dummy/config/application.rb

@@ -1,5 +1,10 @@
 require File.expand_path('../boot', __FILE__)
 
+# Workaround for missing require "logger" in some Rails versions.
+#
+# See https://github.com/rails/rails/pull/54264.
+require 'logger'
+
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
@@ -19,4 +24,3 @@ module Dummy
     # config.i18n.default_locale = :de
   end
 end
-

data/spec/dummy/config/environments/test.rb

@@ -21,7 +21,7 @@ Dummy::Application.configure do
   config.action_controller.perform_caching = false
 
   # Raise exceptions instead of rendering exception templates.
-  config.action_dispatch.show_exceptions = false
+  config.action_dispatch.show_exceptions = :none
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false

data/spec/rails/rfc6570/extensions/route_set_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Rails::RFC6570::Extensions::RouteSet do
+  subject(:route_set) do
+    ActionDispatch::Routing::RouteSet.new.tap do |routes|
+      routes.draw do
+        get '/path/:id', to: 'controller#action', as: :test1
+      end
+    end
+  end
+
+  let(:ctx) do
+    Class.new do
+      def url_options
+        {host: 'www.example.org'}
+      end
+    end.new
+  end
+
+  describe '#to_rfc6570' do
+    it 'returns dictionary of all named routes' do
+      expect(route_set.to_rfc6570(ctx: ctx)).to eq({
+        test1: Addressable::Template.new('http://www.example.org/path/{id}'),
+      })
+    end
+  end
+end

data/spec/rails/rfc6570/helper_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Rails::RFC6570::Helper do
+  subject(:helper) do
+    routes = self.routes
+
+    Class.new do
+      def url_options
+        {host: 'www.example.org'}
+      end
+
+      include routes.url_helpers
+      include Rails::RFC6570::Helper
+    end.new
+  end
+
+  let(:routes) do
+    ActionDispatch::Routing::RouteSet.new.tap do |routes|
+      routes.draw do
+        get '/path/:id', to: 'controller#action', as: :test1
+      end
+    end
+  end
+
+  describe '#rfc6570_routes' do
+    it 'returns dictionary of all named routes' do
+      expect(helper.rfc6570_routes).to eq({
+        test1: Addressable::Template.new('http://www.example.org/path/{id}'),
+      })
+    end
+  end
+
+  describe '#rfc6570_route' do
+    it 'returns template for named route' do
+      expect(helper.rfc6570_route(:test1)).to eq Addressable::Template.new('http://www.example.org/path/{id}')
+    end
+
+    it 'raise KeyError with unknown named route' do
+      expect { helper.rfc6570_route(:not_found) }.to raise_error KeyError
+    end
+  end
+end

data/spec/rails/rfc6570/visitor_spec.rb

@@ -20,12 +20,24 @@ RSpec.describe Rails::RFC6570::Visitor do
     it { is_expected.to eq %w[/ path / path] }
   end
 
+  describe '/path.:format' do
+    let(:path) { '/path.:format' }
+
+    it { is_expected.to eq %w[/ path . {format}] }
+  end
+
   describe '/:title' do
     let(:path) { '/:title' }
 
     it { is_expected.to eq %w[/ {title}] }
   end
 
+  describe '/:title.html' do
+    let(:path) { '/:title.html' }
+
+    it { is_expected.to eq %w[/ {title} . html] }
+  end
+
   describe '/:title(.:format)' do
     let(:path) { '/:title(.:format)' }
 

data/spec/spec_helper.rb

@@ -30,4 +30,10 @@ end
 
 RSpec.configure do |config|
   config.order = 'random'
+
+  # Use the GitHub Annotations formatter for CI
+  if ENV['GITHUB_ACTIONS'] == 'true'
+    require 'rspec/github'
+    config.add_formatter RSpec::Github::Formatter
+  end
 end

data/vendor/bundle/ruby/3.4.0/bundler/gems/rubocop-config-67802c9d1826/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jan Graichen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/vendor/bundle/ruby/3.4.0/bundler/gems/rubocop-config-67802c9d1826/README.md

@@ -0,0 +1,23 @@
+# Shared Rubocop Configuration
+
+Shared rubocop configuration and defaults for my libraries and projects.
+
+## Usage
+
+```ruby
+# Gemfile
+
+gem 'rubocop-config', github: 'jgraichen/rubocop-config', ref: 'v11', require: false
+```
+
+```yaml
+# .rubocop.yml
+
+inherit_gem:
+  rubocop-config: default.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: False
+  NewCops: enable
+```

data/vendor/bundle/ruby/3.4.0/bundler/gems/rubocop-config-67802c9d1826/rubocop-config.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+# stub: rubocop-config 13.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "rubocop-config".freeze
+  s.version = "13.0.0".freeze
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.metadata = { "allowed_push_host" => ".", "rubygems_mfa_required" => "true" } if s.respond_to? :metadata=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Jan Graichen".freeze]
+  s.date = "2025-01-31"
+  s.email = ["jgraichen@altimos.de".freeze]
+  s.files = ["LICENSE".freeze, "README.md".freeze, "default.yml".freeze]
+  s.homepage = "https://github.com/jgraichen/rubocop-config".freeze
+  s.licenses = ["MIT".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.7.0".freeze)
+  s.rubygems_version = "3.6.2".freeze
+  s.summary = "Shared rubocop config".freeze
+
+  s.installed_by_version = "3.6.2".freeze
+
+  s.specification_version = 4
+
+  s.add_runtime_dependency(%q<rubocop>.freeze, ["~> 1.70.0".freeze])
+  s.add_runtime_dependency(%q<rubocop-capybara>.freeze, ["~> 2.21.0".freeze])
+  s.add_runtime_dependency(%q<rubocop-factory_bot>.freeze, ["~> 2.26.1".freeze])
+  s.add_runtime_dependency(%q<rubocop-performance>.freeze, ["~> 1.23.0".freeze])
+  s.add_runtime_dependency(%q<rubocop-rspec>.freeze, ["~> 3.3.0".freeze])
+  s.add_runtime_dependency(%q<rubocop-rspec_rails>.freeze, ["~> 2.30.0".freeze])
+end

data/vendor/bundle/ruby/3.4.0/gems/actionpack-8.0.1/CHANGELOG.md

@@ -0,0 +1,205 @@
+## Rails 8.0.1 (December 13, 2024) ##
+
+*   Add `ActionDispatch::Request::Session#store` method to conform Rack spec.
+
+    *Yaroslav*
+
+
+## Rails 8.0.0.1 (December 10, 2024) ##
+
+*   Add validation to content security policies to disallow spaces and semicolons.
+    Developers should use multiple arguments, and different directive methods instead.
+
+    [CVE-2024-54133]
+
+    *Gannon McGibbon*
+
+
+## Rails 8.0.0 (November 07, 2024) ##
+
+*   No changes.
+
+
+## Rails 8.0.0.rc2 (October 30, 2024) ##
+
+*   Fix routes with `::` in the path.
+
+    *Rafael Mendonça França*
+
+*   Maintain Rack 2 parameter parsing behaviour.
+
+    *Matthew Draper*
+
+
+## Rails 8.0.0.rc1 (October 19, 2024) ##
+
+*   Remove `Rails.application.config.action_controller.allow_deprecated_parameters_hash_equality`.
+
+    *Rafael Mendonça França*
+
+*   Improve `ActionController::TestCase` to expose a binary encoded `request.body`.
+
+    The rack spec clearly states:
+
+    > The input stream is an IO-like object which contains the raw HTTP POST data.
+    > When applicable, its external encoding must be “ASCII-8BIT” and it must be opened in binary mode.
+
+    Until now its encoding was generally UTF-8, which doesn't accurately reflect production
+    behavior.
+
+    *Jean Boussier*
+
+*   Update `ActionController::AllowBrowser` to support passing method names to `:block`
+
+    ```ruby
+    class ApplicationController < ActionController::Base
+      allow_browser versions: :modern, block: :handle_outdated_browser
+
+      private
+        def handle_outdated_browser
+          render file: Rails.root.join("public/custom-error.html"), status: :not_acceptable
+        end
+    end
+    ```
+
+    *Sean Doyle*
+
+*   Raise an `ArgumentError` when invalid `:only` or `:except` options are passed into `#resource` and `#resources`.
+
+    *Joshua Young*
+
+## Rails 8.0.0.beta1 (September 26, 2024) ##
+
+*   Fix non-GET requests not updating cookies in `ActionController::TestCase`.
+
+    *Jon Moss*, *Hartley McGuire*
+
+*   Update `ActionController::Live` to use a thread-pool to reuse threads across requests.
+
+    *Adam Renberg Tamm*
+
+*   Introduce safer, more explicit params handling method with `params#expect` such that
+    `params.expect(table: [ :attr ])` replaces `params.require(:table).permit(:attr)`
+
+    Ensures params are filtered with consideration for the expected
+    types of values, improving handling of params and avoiding ignorable
+    errors caused by params tampering.
+
+    ```ruby
+    # If the url is altered to ?person=hacked
+    # Before
+    params.require(:person).permit(:name, :age, pets: [:name])
+    # raises NoMethodError, causing a 500 and potential error reporting
+
+    # After
+    params.expect(person: [ :name, :age, pets: [[:name]] ])
+    # raises ActionController::ParameterMissing, correctly returning a 400 error
+    ```
+
+    You may also notice the new double array `[[:name]]`. In order to
+    declare when a param is expected to be an array of parameter hashes,
+    this new double array syntax is used to explicitly declare an array.
+    `expect` requires you to declare expected arrays in this way, and will
+    ignore arrays that are passed when, for example, `pet: [:name]` is used.
+
+    In order to preserve compatibility, `permit` does not adopt the new
+    double array syntax and is therefore more permissive about unexpected
+    types. Using `expect` everywhere is recommended.
+
+    We suggest replacing `params.require(:person).permit(:name, :age)`
+    with the direct replacement `params.expect(person: [:name, :age])`
+    to prevent external users from manipulating params to trigger 500
+    errors. A 400 error will be returned instead, using public/400.html
+
+    Usage of `params.require(:id)` should likewise be replaced with
+    `params.expect(:id)` which is designed to ensure that `params[:id]`
+    is a scalar and not an array or hash, also requiring the param.
+
+    ```ruby
+    # Before
+    User.find(params.require(:id)) # allows an array, altering behavior
+
+    # After
+    User.find(params.expect(:id)) # expect only returns non-blank permitted scalars (excludes Hash, Array, nil, "", etc)
+    ```
+
+    *Martin Emde*
+
+*   System Testing: Disable Chrome's search engine choice by default in system tests.
+
+    *glaszig*
+
+*   Fix `Request#raw_post` raising `NoMethodError` when `rack.input` is `nil`.
+
+    *Hartley McGuire*
+
+*   Remove `racc` dependency by manually writing `ActionDispatch::Journey::Scanner`.
+
+    *Gannon McGibbon*
+
+*   Speed up `ActionDispatch::Routing::Mapper::Scope#[]` by merging frame hashes.
+
+    *Gannon McGibbon*
+
+*   Allow bots to ignore `allow_browser`.
+
+    *Matthew Nguyen*
+
+*   Deprecate drawing routes with multiple paths to make routing faster.
+    You may use `with_options` or a loop to make drawing multiple paths easier.
+
+    ```ruby
+    # Before
+    get "/users", "/other_path", to: "users#index"
+
+    # After
+    get "/users", to: "users#index"
+    get "/other_path", to: "users#index"
+    ```
+
+    *Gannon McGibbon*
+
+*   Make `http_cache_forever` use `immutable: true`
+
+    *Nate Matykiewicz*
+
+*   Add `config.action_dispatch.strict_freshness`.
+
+    When set to `true`, the `ETag` header takes precedence over the `Last-Modified` header when both are present,
+    as specified by RFC 7232, Section 6.
+
+    Defaults to `false` to maintain compatibility with previous versions of Rails, but is enabled as part of
+    Rails 8.0 defaults.
+
+    *heka1024*
+
+*   Support `immutable` directive in Cache-Control
+
+    ```ruby
+    expires_in 1.minute, public: true, immutable: true
+    # Cache-Control: public, max-age=60, immutable
+    ```
+
+    *heka1024*
+
+*   Add `:wasm_unsafe_eval` mapping for `content_security_policy`
+
+    ```ruby
+    # Before
+    policy.script_src "'wasm-unsafe-eval'"
+
+    # After
+    policy.script_src :wasm_unsafe_eval
+    ```
+
+    *Joe Haig*
+
+*   Add `display_capture` and `keyboard_map` in `permissions_policy`
+
+    *Cyril Blaecke*
+
+*   Add `connect` route helper.
+
+    *Samuel Williams*
+
+Please check [7-2-stable](https://github.com/rails/rails/blob/7-2-stable/actionpack/CHANGELOG.md) for previous changes.

data/vendor/bundle/ruby/3.4.0/gems/actionpack-8.0.1/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/vendor/bundle/ruby/3.4.0/gems/actionpack-8.0.1/README.rdoc

@@ -0,0 +1,57 @@
+= Action Pack -- From request to response
+
+Action Pack is a framework for handling and responding to web requests. It
+provides mechanisms for *routing* (mapping request URLs to actions), defining
+*controllers* that implement actions, and generating responses. In short, Action Pack
+provides the controller layer in the MVC paradigm.
+
+It consists of several modules:
+
+* Action Dispatch, which parses information about the web request, handles
+  routing as defined by the user, and does advanced processing related to HTTP
+  such as MIME-type negotiation, decoding parameters in POST, PATCH, or PUT bodies,
+  handling HTTP caching logic, cookies and sessions.
+
+* Action Controller, which provides a base controller class that can be
+  subclassed to implement filters and actions to handle requests. The result
+  of an action is typically content generated from views.
+
+With the Ruby on \Rails framework, users only directly interface with the
+Action Controller module. Necessary Action Dispatch functionality is activated
+by default and Action View rendering is implicitly triggered by Action
+Controller. However, these modules are designed to function on their own and
+can be used outside of \Rails.
+
+You can read more about Action Pack in the {Action Controller Overview}[https://guides.rubyonrails.org/action_controller_overview.html] guide.
+
+== Download and installation
+
+The latest version of Action Pack can be installed with RubyGems:
+
+  $ gem install actionpack
+
+Source code can be downloaded as part of the \Rails project on GitHub:
+
+* https://github.com/rails/rails/tree/main/actionpack
+
+
+== License
+
+Action Pack is released under the MIT license:
+
+* https://opensource.org/licenses/MIT
+
+
+== Support
+
+API documentation is at:
+
+* https://api.rubyonrails.org
+
+Bug reports for the Ruby on \Rails project can be filed here:
+
+* https://github.com/rails/rails/issues
+
+Feature requests should be discussed on the rails-core mailing list here:
+
+* https://discuss.rubyonrails.org/c/rubyonrails-core