rails-rfc6570 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8526615ae06cd6c8ca8cde71ea61249827646e1fabf6b655c05706062be3e4d2
-  data.tar.gz: 37cfb563a826b507523997b6aadd02580a844e573211bfc7f80b3caa42d90c66
+  metadata.gz: e7e8a03b1cefe0054439f9582d9d8befbba54e09c4d01ccc170f8e4be3d49295
+  data.tar.gz: f45beb2b71490f95993245b3c34b9ff56724dd889486353ac763d1f373cc6346
 SHA512:
-  metadata.gz: 74bf6d20d7e6aa3f8cf1b366a70b1397d1e42cdf28fc4e12b0f33fbb37078818b6a4dc7f36a581c5dab45f43242345d541d62611aba2190d942b1233d2f62730
-  data.tar.gz: 4f4a6eeb5297a1771c865e070fd3c7728fa6b41ac44251ed2d8e002985e60aee4734c49f4f32a6b93c43b5bc239a5dd3e09d30f36adcf74e160730ffe0add461
+  metadata.gz: 3d52809f1e00ac16f94dd1254601955b722456c23d4cd0c4eb0e322e1e618842ac2c7336acbc7b73f1c35a17cc80d62659dc3d2a94f39fea99f0d15bf8faf5c9
+  data.tar.gz: f82e393910a7a48f9606de6a79439f35a267be250dd2d3c6eb2dd2efdf087393e7d1ddc87ed31b8ea4947b588b92f732ef1a748a88a4e33093279e553cf832dd

data/CHANGELOG.md

@@ -3,8 +3,8 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a Changelog](http://keepachangelog.com/).
 
-
 ## Unreleased
+
 ---
 
 ### New
@@ -15,63 +15,97 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a Ch
 
 ### Breaks
 
+## 3.0.0 - (2023-09-04)
+
+---
+
+### New
+
+- Add Ruby 3.1 and 3.2 to test matrix
+
+### Changes
+
+- Drop Ruby < 2.7 from test matrix
+- Drop Rails < 6.1 from test matrix
+
+### Breaks
+
+- Require Ruby 2.7+
+
+## 2.6.0 - (2021-12-16)
+
+---
+
+### New
+
+- Support for Rails 7
 
 ## 2.5.0 - (2020-12-13)
+
 ---
 
 ### New
-* Add support for Rails 6.1
 
+- Add support for Rails 6.1
 
 ## 2.4.0
+
 ---
 
-* Add support for Rails 6.0
+- Add support for Rails 6.0
 
 ## 2.3.0
+
 ---
 
-* Newly written visitor and formatter to improve performance (#3)
-* Nested groups are expanded into a list of groups
+- Newly written visitor and formatter to improve performance (#3)
+- Nested groups are expanded into a list of groups
 
 ## 2.2.0
+
 ---
 
-* Add support to Rails 5.2 to gemspec
+- Add support to Rails 5.2 to gemspec
 
 ## 2.1.0
+
 ---
 
-* Add emulation for Rails' routing behavior with original script name
+- Add emulation for Rails' routing behavior with original script name
 
 ## 2.0.0
+
 ---
 
-* Add support for Rails 5.1
-* Drop support for Rails < 4.2
+- Add support for Rails 5.1
+- Drop support for Rails < 4.2
 
 ## 1.1.1
+
 ---
 
-* Fix full URL generation to not use `root_url` helper to avoid depending on that and to improve compatibility with e.g. rails engines.
+- Fix full URL generation to not use `root_url` helper to avoid depending on that and to improve compatibility with e.g. rails engines.
 
 ## 1.1.0
+
 ---
 
-* Added support for Rails 5.0
+- Added support for Rails 5.0
 
 ## 1.0.0
+
 ---
 
-* No changes just bumping version to a production release
+- No changes just bumping version to a production release
 
 ## 0.3.0
+
 ---
 
-* Added Rails 4.2 support
+- Added Rails 4.2 support
 
 ## 0.2.0
----
 
-* Added `_path_rfc6570` and `_url_rfc6570` helpers (#2)
+---
 
+- Added `_path_rfc6570` and `_url_rfc6570` helpers (#2)

data/README.md

@@ -1,28 +1,22 @@
 # Rails::RFC6570
 
-[![Build Status](https://github.com/jgraichen/rails-rfc6570/workflows/Build/badge.svg?event=push)](https://github.com/jgraichen/rails-rfc6570/actions?query=workflow%3ABuild)
+[![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 5.0, 5.1, 5.2, 6.0 and Ruby 2.5, 2.6, 2.7.
+Pragmatic access to your Rails routes as RFC6570 URI templates. Tested with Rails 6.1, 7.0 and Ruby 2.7, 3.0, 3.1, 3.2.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'rails-rfc6570', '~> 2.0'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rails-rfc6570
+```ruby
+gem 'rails-rfc6570', '~> 3.0'
+```
 
 ## Usage
 
 **Rails::RFC6570** gives you direct access to your Rails routes as RFC6570 URI templates using the [addressable](https://github.com/sporkmonger/addressable) gem. It further patches `Addressable::Template` with a `#as_json` and `#to_s` so that you can simply pass the template objects or even partial expanded templates to your render call, decorator or serializer.
 
-This examples print a JSON index resource just like https://api.github.com:
+The following examples print a JSON index resource just like `https://api.github.com`:
 
 ```ruby
 class ApplicationController < ActionController::API
@@ -34,9 +28,9 @@ end
 
 **Pro Tip**: Append `_url` to the route names: `rfc6570_routes.transform_keys {|k| "#{k}_url" }`.
 
-By default the `format` placeholder is ignored and the HTTP host will be included in the URI template.
+By default, the `format` placeholder is ignored and the HTTP host will be included in the URI template.
 
-Additionally you can specify a list of query parameters in your controllers:
+Additionally, you can specify a list of query parameters in your controllers:
 
 ```ruby
 class UserController < ApplicationController
@@ -67,9 +61,9 @@ the root action will return something similar to the following JSON:
 
 ```json
 {
-"users": "http://localhost:3000/users{?query,email,active}",
-"user": "http://localhost:3000/users/{id}",
-"root": "http://localhost:3000/"
+  "users": "http://localhost:3000/users{?query,email,active}",
+  "user": "http://localhost:3000/users/{id}",
+  "root": "http://localhost:3000/"
 }
 ```
 
@@ -114,7 +108,7 @@ end
 
 ## Contributing
 
-1. Fork it (http://github.com/jgraichen/rails-routes/fork)
+1. [Fork it](http://github.com/jgraichen/rails-routes/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Add specs
 4. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/rails/rfc6570/formatter.rb

@@ -10,7 +10,7 @@ module Rails
         @parts = Visitor.new(factory: method(:symbol)).accept(route.path.spec)
       end
 
-      def evaluate(ignore: %w[format], ctx:, **kwargs)
+      def evaluate(ctx:, ignore: %w[format], **kwargs)
         parts = @parts.reject do |part|
           part.is_a?(Subst) && ignore.include?(part.name)
         end
@@ -21,7 +21,7 @@ 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
 

data/lib/rails/rfc6570/version.rb

@@ -3,12 +3,12 @@
 module Rails
   module RFC6570
     module VERSION
-      MAJOR = 2
-      MINOR = 5
+      MAJOR = 3
+      MINOR = 0
       PATCH = 0
       STAGE = nil
 
-      STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze
+      STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.').freeze
 
       def self.to_s
         STRING

data/lib/rails/rfc6570.rb

@@ -13,9 +13,6 @@ module Rails
         initializer 'rails-rfc6570', group: :all do |_app|
           require 'rails/rfc6570/patches'
 
-          MAJOR = Rails::VERSION::MAJOR
-          MINOR = Rails::VERSION::MINOR
-
           ::ActionDispatch::Routing::RouteSet.include \
             Rails::RFC6570::Extensions::RouteSet
 
@@ -42,7 +39,7 @@ module Rails
 
       module NamedRouteCollection
         def to_rfc6570(opts = {})
-          Hash[routes.map {|n, r| [n, r.to_rfc6570(opts)] }]
+          routes.to_h {|n, r| [n, r.to_rfc6570(opts)] }
         end
 
         def define_rfc6570_helpers(name, route, mod, set)
@@ -64,7 +61,7 @@ module Rails
                 self,
                 route,
                 **opts,
-                path_only: false
+                path_only: false,
               )
             end
 
@@ -73,7 +70,7 @@ module Rails
                 self,
                 route,
                 **opts,
-                path_only: true
+                path_only: true,
               )
             end
           end

data/rails-rfc6570.gemspec

@@ -14,16 +14,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jgraichen/rails-rfc6570'
   spec.license       = 'MIT'
 
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
+
   spec.files         = Dir['**/*'].grep(%r{^(
       (bin|lib|test|spec|features)/|
       (.*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)
     )}x)
   spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'actionpack', '>= 4.2', '< 6.2'
-  spec.add_runtime_dependency 'addressable', '~> 2.3'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_development_dependency 'bundler'
+  spec.add_runtime_dependency 'actionpack', '>= 4.2', '< 7.1'
+  spec.add_runtime_dependency 'addressable', '~> 2.3'
 end

data/spec/dummy/config/boot.rb

@@ -1,5 +1,5 @@
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)