rails-rfc6570 2.0.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 46e9cd70b9c5de2feb4f4fab318ba72c8662018e
-  data.tar.gz: 2b22c3ed75ae6b6a164c4f13ff447cf855818a69
+SHA256:
+  metadata.gz: 8526615ae06cd6c8ca8cde71ea61249827646e1fabf6b655c05706062be3e4d2
+  data.tar.gz: 37cfb563a826b507523997b6aadd02580a844e573211bfc7f80b3caa42d90c66
 SHA512:
-  metadata.gz: e7ed81f8d4c160778a41c485918b6d04831bbe3b1112fdf5170a8718c7746600dce32909554802ff6885b1bd35664a4d2047b3ec059fdfa3ba7236095fbb14e2
-  data.tar.gz: aa39e93e031d4f5631a1a2d50fa44f545d0e337ca9330fcdf2605d817c138ecbe4bea3067dd535ba61a8c38200b70250637754e9f4340cd60585ba9fcd90c4d6
+  metadata.gz: 74bf6d20d7e6aa3f8cf1b366a70b1397d1e42cdf28fc4e12b0f33fbb37078818b6a4dc7f36a581c5dab45f43242345d541d62611aba2190d942b1233d2f62730
+  data.tar.gz: 4f4a6eeb5297a1771c865e070fd3c7728fa6b41ac44251ed2d8e002985e60aee4734c49f4f32a6b93c43b5bc239a5dd3e09d30f36adcf74e160730ffe0add461

data/CHANGELOG.md

@@ -1,27 +1,77 @@
 # Changelog
 
+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
+
+### Changes
+
+### Fixes
+
+### Breaks
+
+
+## 2.5.0 - (2020-12-13)
+---
+
+### New
+* Add support for Rails 6.1
+
+
+## 2.4.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
+
+## 2.2.0
+---
+
+* Add support to Rails 5.2 to gemspec
+
+## 2.1.0
+---
+
+* 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
 
 ## 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.
 
 ## 1.1.0
+---
 
 * Added support for Rails 5.0
 
 ## 1.0.0
+---
 
 * No changes just bumping version to a production release
 
 ## 0.3.0
+---
 
 * Added Rails 4.2 support
 
 ## 0.2.0
+---
 
 * Added `_path_rfc6570` and `_url_rfc6570` helpers (#2)
 

data/README.md

@@ -1,8 +1,8 @@
 # Rails::RFC6570
 
-[![Build Status](https://travis-ci.org/jgraichen/rails-rfc6570.svg?branch=master)](https://travis-ci.org/jgraichen/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)
 
-Pragmatic access to your Rails 4.2, 5.0, 5.1 routes as RFC6570 URI templates. Ruby 2.0+ is required.
+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.
 
 ## Installation
 
@@ -32,7 +32,7 @@ class ApplicationController < ActionController::API
 end
 ```
 
-**Pro Tip**: Append `_url` to the route names: `rfc6570_routes.map{|n,r| ["#{n}_url", r]}.to_h`.
+**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.
 
@@ -93,7 +93,7 @@ class UserDecorator < Draper::Decorator
 end
 ```
 
-This gem does not support every construct possible with route matchers especially nested groups cannot be expressed in URI templates. It also makes some assumptions when converting splat matchers like swallowing a multiple slashes.
+This gem does not support every construct possible with route matchers especially nested groups cannot be expressed in URI templates. They are expanded into separate groups. It also makes some assumptions when converting splat matchers like swallowing a multiple slashes. An error is raised when routes with OR-clauses are tried to be converted.
 
 You can also combine **Rails::RFC6570** with [rack-link_headers](https://github.com/jgraichen/rack-link_headers) and provide hypermedia linking everywhere!
 

data/lib/rails/rfc6570.rb

@@ -1,185 +1,30 @@
-require 'rails/rfc6570/version'
-
-module ActionDispatch
-  module Journey
-    module Visitors
-      class RFC6570 < Visitor
-        DISPATCH_CACHE = {}
-
-        def initialize(opts = {})
-          super()
-
-          @opts        = opts
-          @stack       = []
-          @group_depth = 0
-        end
-
-        def ignore
-          @opts.fetch(:ignore) { %w(format) }
-        end
-
-        def route
-          @route ||= @opts[:route]
-        end
-
-        def accept(node)
-          str = visit(node)
-
-          if @opts.fetch(:params, true) && route
-            controller = route.defaults[:controller].to_s
-            action     = route.defaults[:action].to_s
-
-            if controller.present? && action.present?
-              params = Rails::RFC6570.params_for(controller, action)
-              str += '{?' + params.join(',') + '}' if params && params.any?
-            end
-          end
-
-          str
-        end
-
-        def visit(node)
-          @stack.unshift node.type
-          send DISPATCH_CACHE.fetch(node.type), node
-        ensure
-          @stack.shift
-        end
-
-        def symbol_name(node)
-          name = node.to_s.tr '*:', ''
-
-          if ignore.include?(name)
-            nil
-          else
-            name
-          end
-        end
-
-        def placeholder(node, prefix = nil, suffix = nil, pretext = nil)
-          name = symbol_name node
-          if name
-            "#{pretext}{#{prefix}#{name}#{suffix}}"
-          else
-            ''
-          end
-        end
-
-        def binary(node)
-          case [node.left.type, node.right.type]
-            when [:DOT, :SYMBOL]
-              if @stack[0..1] == [:CAT, :GROUP]
-                placeholder node.right, '.'
-              else
-                placeholder(node.right, nil, nil, '.')
-              end
-            when [:SLASH, :SYMBOL]
-              if @stack[0..1] == [:CAT, :GROUP]
-                placeholder(node.right, '/')
-              else
-                placeholder(node.right, nil, nil, '/')
-              end
-            when [:SLASH, :STAR]
-              placeholder node.right, '/', '*'
-            when [:SLASH, :CAT]
-              if node.right.left.type == :STAR
-                placeholder(node.right.left, '/', '*') + visit(node.right.right)
-              else
-                [visit(node.left), visit(node.right)].join
-              end
-            when [:CAT, :STAR]
-              visit(node.left).to_s.gsub(/\/+$/, '') + placeholder(node.right, '/', '*')
-            else
-              [visit(node.left), visit(node.right)].join
-          end
-        end
-
-        def terminal(node)
-          node.left
-        end
-
-        def nary(node)
-          node.children.each { |c| visit(c) }
-        end
-
-        def unary(node)
-          visit(node.left)
-        end
-
-        def visit_CAT(node)
-          binary(node)
-        end
-
-        def visit_SYMBOL(node)
-          terminal(node)
-        end
-
-        def visit_LITERAL(node)
-          terminal(node)
-        end
-
-        def visit_SLASH(node)
-          terminal(node)
-        end
+# frozen_string_literal: true
 
-        def visit_DOT(node)
-          terminal(node)
-        end
-
-        def visit_SYMBOL(node)
-          placeholder(node)
-        end
-
-        def visit_OR(node)
-          nary(node)
-        end
+require 'action_dispatch/journey'
 
-        def visit_STAR(node)
-          unary(node)
-        end
-
-        def visit_GROUP(node)
-          if @group_depth >= 1
-            raise RuntimeError.new 'Cannot transform nested groups.'
-          else
-            @group_depth += 1
-            visit node.left
-          end
-        ensure
-          @group_depth -= 1
-        end
-
-        instance_methods(true).each do |meth|
-          next unless meth =~ /^visit_(.*)$/
-          DISPATCH_CACHE[$1.to_sym] = meth
-        end
-      end
-    end
-  end
-end
+require 'rails/rfc6570/formatter'
+require 'rails/rfc6570/version'
+require 'rails/rfc6570/visitor'
 
 module Rails
   module RFC6570
     if defined?(::Rails::Railtie)
       class Railtie < ::Rails::Railtie # :nodoc:
-        initializer 'rails-rfc6570', :group => :all do |app|
+        initializer 'rails-rfc6570', group: :all do |_app|
           require 'rails/rfc6570/patches'
-          require 'action_dispatch/journey'
 
           MAJOR = Rails::VERSION::MAJOR
           MINOR = Rails::VERSION::MINOR
 
-          ::ActionDispatch::Routing::RouteSet.send :include,
+          ::ActionDispatch::Routing::RouteSet.include \
             Rails::RFC6570::Extensions::RouteSet
 
-          ::ActionDispatch::Routing::RouteSet::NamedRouteCollection.send \
-            :prepend, Rails::RFC6570::Extensions::NamedRouteCollection
+          ::ActionDispatch::Routing::RouteSet::NamedRouteCollection.prepend \
+            Rails::RFC6570::Extensions::NamedRouteCollection
 
-          ::ActionDispatch::Journey::Route.send :include,
+          ::ActionDispatch::Journey::Route.include \
             Rails::RFC6570::Extensions::JourneyRoute
 
-          ::ActionDispatch::Journey::Nodes::Node.send :include,
-            Rails::RFC6570::Extensions::JourneyNode
-
           ::ActiveSupport.on_load(:action_controller) do
             include Rails::RFC6570::Helper
             extend Rails::RFC6570::ControllerExtension
@@ -191,13 +36,13 @@ module Rails
     module Extensions
       module RouteSet
         def to_rfc6570(opts = {})
-          routes.map{|r| r.to_rfc6570(opts) }
+          routes.map {|r| r.to_rfc6570(opts) }
         end
       end
 
       module NamedRouteCollection
         def to_rfc6570(opts = {})
-          Hash[routes.map{|n, r| [n, r.to_rfc6570(opts)] }]
+          Hash[routes.map {|n, r| [n, r.to_rfc6570(opts)] }]
         end
 
         def define_rfc6570_helpers(name, route, mod, set)
@@ -210,16 +55,26 @@ module Rails
           end
 
           mod.module_eval do
-            define_method(rfc6570_name) do |opts = {}|
-              ::Rails::RFC6570::build_url_template(self, route, opts)
+            define_method(rfc6570_name) do |**opts|
+              ::Rails::RFC6570.build_url_template(self, route, **opts)
             end
 
-            define_method(rfc6570_url_name) do |opts = {}|
-              send rfc6570_name, opts.merge(path_only: false)
+            define_method(rfc6570_url_name) do |**opts|
+              ::Rails::RFC6570.build_url_template(
+                self,
+                route,
+                **opts,
+                path_only: false
+              )
             end
 
-            define_method(rfc6570_path_name) do |opts = {}|
-              send rfc6570_name, opts.merge(path_only: true)
+            define_method(rfc6570_path_name) do |**opts|
+              ::Rails::RFC6570.build_url_template(
+                self,
+                route,
+                **opts,
+                path_only: true
+              )
             end
           end
 
@@ -233,46 +88,38 @@ module Rails
           define_rfc6570_helpers name, route, @url_helpers_module, @url_helpers
         end
 
-        alias_method :[]=, :add
+        alias []= add
       end
 
       module JourneyRoute
-        def to_rfc6570(opts = {})
-          path.spec.to_rfc6570 opts.merge(route: self)
-        end
-      end
-
-      module JourneyNode
-        def to_rfc6570(opts = {})
-          ::Addressable::Template.new \
-            ::ActionDispatch::Journey::Visitors::RFC6570.new(opts).accept(self)
+        def to_rfc6570(**opts)
+          @rfc6570_formatter ||= RFC6570::Formatter.new(self)
+          @rfc6570_formatter.evaluate(**opts)
         end
       end
     end
 
     module Helper
-      def rfc6570_routes(opts = {})
+      def rfc6570_routes(**opts)
         routes = {}
         Rails.application.routes.named_routes.names.each do |key|
-          routes[key] = rfc6570_route(key, opts)
+          routes[key] = rfc6570_route(key, **opts)
         end
 
         routes
       end
 
-      def rfc6570_route(name, opts = {})
-        route    = Rails.application.routes.named_routes[name]
-        unless route
-          raise KeyError.new "No named routed for `#{name}'."
-        end
+      def rfc6570_route(name, **opts)
+        route = Rails.application.routes.named_routes[name]
+        raise KeyError.new "No named routed for `#{name}'." unless route
 
-        ::Rails::RFC6570::build_url_template(self, route, opts)
+        route.to_rfc6570(**opts, ctx: self)
       end
     end
 
     module ControllerExtension
       def rfc6570_defs
-        @__rfc6570_defs ||= {}
+        @rfc6570_defs ||= {}
       end
 
       def rfc6570_params(defs)
@@ -284,27 +131,17 @@ module Rails
       end
     end
 
-    def build_url_template(t, route, options)
-      template = route.to_rfc6570(options)
-
-      if options.fetch(:path_only, false)
-        template
-      else
-        options = t.url_options.merge(options)
-        options[:path] = template.pattern
-
-        url     = ActionDispatch::Http::URL.url_for options
-
-        ::Addressable::Template.new url
-      end
-    end
-
     def params_for(controller, action)
       ctr = "#{controller.camelize}Controller".constantize
       ctr.rfc6570_defs[action.to_sym] if ctr.respond_to?(:rfc6570_defs)
     rescue NameError
       nil
     end
-    extend self
+
+    def build_url_template(ctx, route, **kwargs)
+      route.to_rfc6570(ctx: ctx, **kwargs)
+    end
+
+    extend self # rubocop:disable Style/ModuleFunction
   end
 end