rails-rfc6570 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1024d8d48a4b71d05fef63d55be57a7615070e7e337f55ab46b4e5f7f2bebe3
-  data.tar.gz: 5af240717ecd2ce3231c51f9162bb938b0880228728103d6f3cbf2f180dad475
+  metadata.gz: 591b65ab2b36b6be29b602386b19553c4a7718390ebc01eaaf328e8efa0059ee
+  data.tar.gz: 015d4b67acce29b894225cfba3d4964630e7f2c407d1dfc552cb08ce33b43748
 SHA512:
-  metadata.gz: d5585791e180636510de263564a9f1104fb888b4455efaed5351d848288eabecb45a4e58df6ff4354e7a4fce28203d154ec8bb129bfcbb8f8ebb1aae3bbc0770
-  data.tar.gz: 5518b0541f5c7331202383b5fd9686e358ddf7fc66820b8c2932e0f6b7fbc45470d3fe9eff1d38b63f06ba3626362c63dbeae1af84baf415f7b0be8a7aa16da9
+  metadata.gz: 825329ae62f18baebc5475d3a213404efb6fa00827c933f21698996bbff457908d590926b75987cddbcb8f466fb5408bdd9447d32b19c27dac153473affdc7bd
+  data.tar.gz: 314f22c74f95539e4e6d1c933d31276069c0fe84852b58a6976aa7d40edfee50291de23e5c2b90c9fb37cb5f5f594c32a3703653f5493c20bdfce74796bad4ef

data/CHANGELOG.md

@@ -15,6 +15,31 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a Ch
 
 ### Breaks
 
+## 3.5.0 - (2025-09-26)
+
+---
+
+### New
+
+- Support `*_path_rfc6570` to include Rails Engines mount point.
+
+## 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/formatter.rb

@@ -21,23 +21,20 @@ module Rails
 
           if controller.present? && action.present?
             params = ::Rails::RFC6570.params_for(controller, action)
-            parts << ("{?#{params.join(',')}}") if params&.any?
+            parts << "{?#{params.join(',')}}" if params&.any?
           end
         end
 
-        if kwargs.fetch(:path_only, false)
-          ::Addressable::Template.new parts.join
-        else
-          options = ctx.url_options.merge(kwargs)
-          options[:path] = parts.join
+        options = ctx.url_options.merge(kwargs)
+        options[:path] = parts.join
+        options[:only_path] = kwargs.fetch(:path_only, false)
 
-          if (osn = options.delete(:original_script_name))
-            options[:script_name] = osn + options[:script_name]
-          end
-
-          ::Addressable::Template.new \
-            ActionDispatch::Http::URL.url_for(options)
+        if (osn = options.delete(:original_script_name))
+          options[:script_name] = osn + options[:script_name]
         end
+
+        ::Addressable::Template.new \
+          ActionDispatch::Http::URL.url_for(options)
       end
 
       def symbol(node, prefix: nil, suffix: nil)

data/lib/rails/rfc6570/patches.rb

@@ -16,7 +16,7 @@ module Addressable
     end
 
     def as_json(*)
-      pattern
+      to_s
     end
   end
 end

data/lib/rails/rfc6570/version.rb

@@ -4,7 +4,7 @@ module Rails
   module RFC6570
     module VERSION
       MAJOR = 3
-      MINOR = 3
+      MINOR = 5
       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/rails/rfc6570_spec.rb

@@ -6,6 +6,28 @@ ActiveSupport::Inflector.inflections(:en) do |inflect|
   inflect.acronym 'API'
 end
 
+module DummyEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace DummyEngine
+
+    routes.draw do
+      get '/action' => 'engine#action', as: :action
+    end
+  end
+
+  class EngineController < ActionController::API
+    rfc6570_params action: %i[param3]
+    def action
+      render json: {
+        ref: action_path,
+        template: action_rfc6570,
+        template_url: action_url_rfc6570,
+        template_path: action_path_rfc6570,
+      }
+    end
+  end
+end
+
 Dummy::Application.routes.draw do
   get '/' => 'api#index', as: :root
 
@@ -20,6 +42,8 @@ Dummy::Application.routes.draw do
   get '/path/*capture/:title' => 'api#index', as: :test4
   get '/path(/*capture)/:title' => 'api#index', as: :test5
   get '/path(/*capture)(/:title)' => 'api#index', as: :test6
+
+  mount DummyEngine::Engine => '/dummy_engine'
 end
 
 class APIController < ApplicationController
@@ -58,7 +82,7 @@ describe Rails::RFC6570, type: :request do
 
     it 'returns list of all parsed and named routes' do
       expect(json.keys).to match_array \
-        %w[root action test1 test2 test3 test4 test5 test6]
+        %w[root action test1 test2 test3 test4 test5 test6 dummy_engine]
     end
 
     it 'includes known parameters' do
@@ -88,6 +112,10 @@ describe Rails::RFC6570, type: :request do
     it 'parses splash operator (III)' do
       expect(json['test6']).to eq "#{host}/path{/capture*}{/title}"
     end
+
+    it 'includes the engine mount point root only' do
+      expect(json['dummy_engine']).to eq "#{host}/dummy_engine"
+    end
   end
 
   context 'action' do
@@ -134,4 +162,24 @@ describe Rails::RFC6570, type: :request do
       end
     end
   end
+
+  context 'mounted Rails engine' do
+    before { get '/dummy_engine/action', headers: headers }
+
+    it 'includes URL helpers' do
+      expect(response).to have_http_status :ok
+    end
+
+    it 'allows to return and render templates' do
+      expect(json['template']).to eq "#{host}/dummy_engine/action{?param3}"
+    end
+
+    it 'allows to return and render url templates' do
+      expect(json['template_url']).to eq "#{host}/dummy_engine/action{?param3}"
+    end
+
+    it 'allows to return and render path templates' do
+      expect(json['template_path']).to eq '/dummy_engine/action{?param3}'
+    end
+  end
 end

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-3bcd2110ca87/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-3bcd2110ca87/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', tag: 'v13', require: false
+```
+
+```yaml
+# .rubocop.yml
+
+inherit_gem:
+  rubocop-config: default.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+  SuggestExtensions: False
+  NewCops: enable
+```

data/vendor/bundle/ruby/3.4.0/bundler/gems/rubocop-config-3bcd2110ca87/rubocop-config.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+# stub: rubocop-config 14.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "rubocop-config".freeze
+  s.version = "14.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 = "1980-01-02"
+  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.9".freeze
+  s.summary = "Shared rubocop config".freeze
+
+  s.installed_by_version = "3.6.9".freeze
+
+  s.specification_version = 4
+
+  s.add_runtime_dependency(%q<rubocop>.freeze, ["~> 1.75.2".freeze])
+  s.add_runtime_dependency(%q<rubocop-capybara>.freeze, ["~> 2.22.1".freeze])
+  s.add_runtime_dependency(%q<rubocop-factory_bot>.freeze, ["~> 2.27.1".freeze])
+  s.add_runtime_dependency(%q<rubocop-performance>.freeze, ["~> 1.25.0".freeze])
+  s.add_runtime_dependency(%q<rubocop-rspec>.freeze, ["~> 3.5.0".freeze])
+  s.add_runtime_dependency(%q<rubocop-rspec_rails>.freeze, ["~> 2.31.0".freeze])
+end