rails-rfc6570 2.0.0 → 2.5.0

data/spec/rails/rfc6570/visitor_spec.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Rails::RFC6570::Visitor do
+  subject(:accept) { visitor.accept(node) }
+
+  let(:visitor) { described_class.new }
+  let(:node) { ::ActionDispatch::Journey::Parser.new.parse(path) }
+
+  describe '/' do
+    let(:path) { '/' }
+
+    it { is_expected.to eq %w[/] }
+  end
+
+  describe '/path/path' do
+    let(:path) { '/path/path' }
+
+    it { is_expected.to eq %w[/ path / path] }
+  end
+
+  describe '/:title' do
+    let(:path) { '/:title' }
+
+    it { is_expected.to eq %w[/ {title}] }
+  end
+
+  describe '/:title(.:format)' do
+    let(:path) { '/:title(.:format)' }
+
+    it { is_expected.to eq %w[/ {title} {.format}] }
+  end
+
+  describe '/path/:title' do
+    let(:path) { '/path/:title' }
+
+    it { is_expected.to eq %w[/ path / {title}] }
+  end
+
+  describe '/path/pre-(:id)-post' do
+    let(:path) { '/path/pre-(:id)-post' }
+
+    it { is_expected.to eq %w[/ path / pre- {id} -post] }
+  end
+
+  describe '/path(/:title)' do
+    let(:path) { '/path(/:title)' }
+
+    it { is_expected.to eq %w[/ path {/title}] }
+  end
+
+  describe '/path/*capture/:title' do
+    let(:path) { '/path/*capture/:title' }
+
+    it { is_expected.to eq %w[/ path {/capture*} / {title}] }
+  end
+
+  describe '/path(/*capture)/:title' do
+    let(:path) { '/path(/*capture)/:title' }
+
+    it { is_expected.to eq %w[/ path {/capture*} / {title}] }
+  end
+
+  describe '/path(/*capture)(/:title)' do
+    let(:path) { '/path(/*capture)(/:title)' }
+
+    it { is_expected.to eq %w[/ path {/capture*} {/title}] }
+  end
+
+  describe '*a/path/*b' do
+    let(:path) { '*a/path/*b' }
+
+    it { is_expected.to eq %w[{/a*} / path {/b*}] }
+  end
+
+  describe 'path/*a/path/*b' do
+    let(:path) { 'path/*a/path/*b' }
+
+    it { is_expected.to eq %w[path {/a*} / path {/b*}] }
+  end
+
+  describe 'path/*a/*b' do
+    let(:path) { 'path/*a/*b' }
+
+    it { is_expected.to eq %w[path {/a*} {/b*}] }
+  end
+
+  describe 'path/*a/:title' do
+    let(:path) { 'path/*a/:title' }
+
+    it { is_expected.to eq %w[path {/a*} / {title}] }
+  end
+
+  describe 'path/*a(/:title)' do
+    let(:path) { 'path/*a(/:title)' }
+
+    it { is_expected.to eq %w[path {/a*} {/title}] }
+  end
+
+  describe '/(:title)' do
+    let(:path) { '/(:title)' }
+
+    it { is_expected.to eq %w[/ {title}] }
+  end
+
+  describe '(/:title)' do
+    let(:path) { '(/:title)' }
+
+    it { is_expected.to eq %w[{/title}] }
+  end
+
+  describe '(/:title/)' do
+    let(:path) { '(/:title/)' }
+
+    it { is_expected.to eq %w[{/title} /] }
+  end
+
+  describe '(/:a(/:b))' do
+    let(:path) { '(/:a(/:b))' }
+
+    it { is_expected.to eq %w[{/a} {/b}] }
+  end
+
+  describe '(/a)|(/b)' do
+    let(:path) { '(/a)|(/b)' }
+
+    it do
+      expect { accept }.to \
+        raise_error 'OR nodes cannot be serialized to URI templates'
+    end
+  end
+end

data/spec/{rfc6570_spec.rb → rails/rfc6570_spec.rb}

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 ActiveSupport::Inflector.inflections(:en) do |inflect|
   inflect.acronym 'API'
 end
 
-
 Dummy::Application.routes.draw do
   get '/' => 'api#index', as: :root
 
-  get '/path/to/unnamed' => 'api#index', as: nil # Unnamed routes should be ignored
+  # Unnamed routes should be ignored
+  get '/path/to/unnamed' => 'api#index', as: nil
 
   get '/action' => 'api#action', as: :action
 
@@ -25,16 +27,26 @@ class APIController < ApplicationController
     render json: rfc6570_routes
   end
 
-  rfc6570_params action: [:param1, :param2]
+  rfc6570_params action: %i[param1 param2]
   def action
     render json: {
+      ref: action_url,
       template: action_rfc6570,
       template_url: action_url_rfc6570,
       template_path: action_path_rfc6570,
       partial: test6_rfc6570.partial_expand(title: 'TITLE'),
-      expand: test6_rfc6570.expand(capture: %w(a b), title: 'TITLE')
+      ignore: test6_rfc6570(ignore: %w[title]),
+      expand: test6_rfc6570.expand(capture: %w[a b], title: 'TITLE')
     }
   end
+
+  def default_url_options
+    if (root = request.headers['__OSN']).present?
+      super.merge original_script_name: root
+    else
+      super
+    end
+  end
 end
 
 describe Rails::RFC6570, type: :request do
@@ -44,64 +56,82 @@ describe Rails::RFC6570, type: :request do
   context 'root' do
     before { get '/' }
 
-    it 'should return list of all parsed and named routes' do
-      expect(json.keys).to match_array %w(root action test1 test2 test3 test4 test5 test6)
+    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]
     end
 
-    it 'should include known parameters' do
+    it 'includes known parameters' do
       expect(json['action']).to eq "#{host}/action{?param1,param2}"
     end
 
-    it 'should parse capture symbols' do
+    it 'parses capture symbols' do
       expect(json['test1']).to eq "#{host}/path/{title}"
     end
 
-    it 'should parse capture group' do
+    it 'parses capture group' do
       expect(json['test2']).to eq "#{host}/path/pp-{title}-abc"
     end
 
-    it 'should parse capture group with slash included' do
+    it 'parses capture group with slash included' do
       expect(json['test3']).to eq "#{host}/path{/title}"
     end
 
-    it 'should parse splash operator (I)' do
+    it 'parses splash operator (I)' do
       expect(json['test4']).to eq "#{host}/path{/capture*}/{title}"
     end
 
-    it 'should parse splash operator (II)' do
+    it 'parses splash operator (II)' do
       expect(json['test5']).to eq "#{host}/path{/capture*}/{title}"
     end
 
-    it 'should parse splash operator (III)' do
+    it 'parses splash operator (III)' do
       expect(json['test6']).to eq "#{host}/path{/capture*}{/title}"
     end
   end
 
   context 'action' do
-    before { get '/action' }
+    before { get '/action', headers: headers }
 
-    it 'should include URL helpers' do
+    it 'includes URL helpers' do
       expect(response.status).to eq 200
     end
 
-    it 'should allow to return and render templates' do
+    it 'allows to return and render templates' do
       expect(json['template']).to eq "#{host}/action{?param1,param2}"
     end
 
-    it 'should allow to return and render url templates' do
+    it 'allows to return and render url templates' do
       expect(json['template_url']).to eq "#{host}/action{?param1,param2}"
     end
 
-    it 'should allow to return and render path templates' do
-      expect(json['template_path']).to eq "/action{?param1,param2}"
+    it 'allows to return and render path templates' do
+      expect(json['template_path']).to eq '/action{?param1,param2}'
     end
 
-    it 'should allow to return and render partial expanded templates' do
+    it 'allows to return and render partial expanded templates' do
       expect(json['partial']).to eq "#{host}/path{/capture*}/TITLE"
     end
 
-    it 'should allow to return and render expanded templates' do
+    it 'allows to return and render expanded templates (I)' do
+      expect(json['ignore']).to eq "#{host}/path{/capture*}{.format}"
+    end
+
+    it 'allows to return and render expanded templates (II)' do
       expect(json['expand']).to eq "#{host}/path/a/b/TITLE"
     end
+
+    context 'with origin_script_name' do
+      let(:headers) { {'__OSN' => '/fuubar'} }
+
+      before do
+        # Consistency check with normal URL helper
+        expect(json['ref']).to eq "#{host}/fuubar/action"
+      end
+
+      it 'prefixes origin script name' do
+        expect(json['template']).to eq "#{host}/fuubar/action{?param1,param2}"
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,23 +1,29 @@
+# frozen_string_literal: true
+
 # Coverage
-require 'coveralls'
-Coveralls.wear! do
-  add_filter 'spec'
+require 'simplecov'
+SimpleCov.start
+
+if ENV['CI']
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 
-#
 ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path('../dummy/config/environment', __FILE__)
+require File.expand_path('dummy/config/environment', __dir__)
 require 'rspec/rails'
 
 Rails.backtrace_cleaner.remove_silencers!
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+Dir[File.expand_path('support/**/*.rb', __dir__)].sort.each {|f| require f }
 
 # Checks for pending migrations before tests are run.
 # If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration) && Rails::VERSION::MAJOR >= 4
+if defined?(ActiveRecord::Migration) && Rails::VERSION::MAJOR >= 4
+  ActiveRecord::Migration.check_pending!
+end
 
 RSpec.configure do |config|
   config.order = 'random'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-rfc6570
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -19,7 +19,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -48,19 +48,19 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
-description: Pragmatical access to your Rails routes as RFC6570 URI templates.
+        version: '0'
+description: 
 email:
-- jg@altimos.de
+- jgraichen@altimos.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -69,8 +69,10 @@ files:
 - LICENSE.txt
 - README.md
 - lib/rails/rfc6570.rb
+- lib/rails/rfc6570/formatter.rb
 - lib/rails/rfc6570/patches.rb
 - lib/rails/rfc6570/version.rb
+- lib/rails/rfc6570/visitor.rb
 - rails-rfc6570.gemspec
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -101,7 +103,8 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/rfc6570_spec.rb
+- spec/rails/rfc6570/visitor_spec.rb
+- spec/rails/rfc6570_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jgraichen/rails-rfc6570
 licenses:
@@ -122,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Pragmatical access to your Rails routes as RFC6570 URI templates.
@@ -157,5 +159,6 @@ test_files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/rfc6570_spec.rb
+- spec/rails/rfc6570/visitor_spec.rb
+- spec/rails/rfc6570_spec.rb
 - spec/spec_helper.rb