grape-path-helpers 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5de62b3e52c6df10f69653f7aad9f4c81a64298c4ad74eb0085b06985a98474
-  data.tar.gz: bc29c3966d9f85de40b845d9e071fce2bc869d73776ce95078816c6f553a0494
+  metadata.gz: b434b7d1b56cd5b639816b364d237e3bd658b0cfe03c0d516c3135794a02bca6
+  data.tar.gz: 4d2958b9bb94e83fa61bb465ef564b100e1e1ff63dbb8748dbc821f4240b88e8
 SHA512:
-  metadata.gz: 04bb77b1e0ee4b792ca6edc6ce1dfd1a18f9af85bc828f2e5f384f621f5ad42a7ad16e2712e9dfb50c8f8e2e8229e5947279122888169eeaeaf12d78860d64fc
-  data.tar.gz: 0bfc95924b6ed43d02c39c6f77123c047122d2cfebc762745362273c837950e568fb22894008cd729de90a17373ea48d2dd933a8e9b85d5b7acdfab156aa836d
+  metadata.gz: dd5def728204b01e35b74e86d9c3b5115864b8e2ac1d1e912b0a7d6a623fda80a1ccbd855464f6cea73159280867eef46b33891aab34e883429dcb56051849be
+  data.tar.gz: d3c3dd5cace700e833448314055f7253ab93bf02af69ed70a4384f7e5176ac3914056cdf37000b3b1662fc9b0d23d5c1d8ab20d2bd147acb727edf7e41733958

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.2.0
+
+* [Add wildcard segments support](https://gitlab.com/gitlab-org/grape-path-helpers/merge_requests/16)
+
 ## 1.1.0
 
 * [Relax dependency on ActiveSupport](https://gitlab.com/gitlab-org/grape-path-helpers/merge_requests/12)

data/lib/grape-path-helpers/decorated_route.rb

@@ -4,6 +4,9 @@ module GrapePathHelpers
     attr_reader :route, :helper_names, :helper_arguments,
                 :extension, :route_options
 
+    PATH_SEGMENTS_REGEXP = %r{\(/?\.:?\w+\)|/(?!\))|(?<=\))|\??\*}
+    PATH_SEGMENTS_WITH_WILDCARDS_REGEXP = %r{\(/?\.:?\w+\)|/(?!\))|(?<=\))|\?}
+
     def self.sanitize_method_name(string)
       string.gsub(/\W|^[0-9]/, '_')
     end
@@ -40,12 +43,12 @@ module GrapePathHelpers
 
     def define_path_helper(method_name, route_attributes)
       method_body = <<-RUBY
-        def #{method_name}(attributes = {})
+        def #{method_name}(attributes = {}, include_wildcard_segments = false)
           attrs = #{route_attributes}.merge(attributes)
 
           query_params = attrs.delete(:params)
           content_type = attrs.delete(:format)
-          path = '/' + path_segments_with_values(attrs).join('/')
+          path = '/' + path_segments_with_values(attrs, include_wildcard_segments).join('/')
 
           path + content_type + query_string(query_params)
         end
@@ -99,13 +102,19 @@ module GrapePathHelpers
       end
     end
 
-    def path_segments_with_values(opts)
-      segments = path_segments.map { |s| segment_to_value(s, opts) }
+    def path_segments_with_values(opts, include_wildcard_segments = false)
+      segments = path_segments(include_wildcard_segments).map do |s|
+        segment_to_value(s, opts)
+      end
       segments.reject(&:blank?)
     end
 
-    def path_segments
-      pattern = %r{\(/?\.:?\w+\)|/(?!\))|(?<=\))|\??\*}
+    def path_segments(include_wildcard_segments = false)
+      pattern = if include_wildcard_segments
+                  PATH_SEGMENTS_WITH_WILDCARDS_REGEXP
+                else
+                  PATH_SEGMENTS_REGEXP
+                end
       route_path.split(pattern).reject(&:blank?)
     end
 
@@ -117,7 +126,7 @@ module GrapePathHelpers
     end
 
     def dynamic_segment?(segment)
-      segment.start_with?(':')
+      segment.start_with?(':', '*')
     end
 
     def optional_segment?(segment)

data/lib/grape-path-helpers/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module GrapePathHelpers
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/spec/grape_path_helpers/decorated_route_spec.rb

@@ -19,7 +19,7 @@ describe GrapePathHelpers::DecoratedRoute do
   end
 
   let(:catch_all_route) do
-    routes.detect { |route| route.route_path =~ /\*/ }
+    routes.detect { |route| route.route_path =~ /\*path/ }
   end
 
   let(:custom_route) do
@@ -34,6 +34,10 @@ describe GrapePathHelpers::DecoratedRoute do
     routes.detect { |route| route.route_path =~ /optional/ }
   end
 
+  let(:wildcard_route) do
+    routes.detect { |route| route.route_path =~ /\*owner_ids/ }
+  end
+
   describe '#sanitize_method_name' do
     it 'removes characters that are illegal in Ruby method names' do
       illegal_names = ['beta-1', 'name_with_+', 'name_with_(']
@@ -51,6 +55,53 @@ describe GrapePathHelpers::DecoratedRoute do
     end
   end
 
+  describe '#define_path_helper' do
+    context 'with only static segments' do
+      let(:route) { ping_route }
+
+      subject { route.api_v1_ping_path }
+
+      it { is_expected.to eq '/api/v1/ping.json' }
+    end
+
+    context 'with optional segments' do
+      let(:route) { optional_route }
+
+      subject { route.api_v1_cats______optional_path }
+
+      it { is_expected.to eq '/api/v1/cats/(-/)/optional.json' }
+    end
+
+    context 'with dynamic segments' do
+      let(:route) { show_route }
+
+      subject { route.api_v1_cats_path(id: 1) }
+
+      it { is_expected.to eq '/api/v1/cats/1.json' }
+    end
+
+    context 'with wildcard segments' do
+      let(:route) { wildcard_route }
+
+      context 'including them' do
+        subject do
+          route.api_v1_cats_owners_owner_ids_cats_path(
+            { owner_ids: 'foobar' },
+            true
+          )
+        end
+
+        it { is_expected.to eq '/api/v1/cats/owners/foobar/cats.json' }
+      end
+
+      context 'excluding them' do
+        subject { route.api_v1_cats_owners_owner_ids_cats_path }
+
+        it { is_expected.to eq '/api/v1/cats/owners/owner_ids/cats.json' }
+      end
+    end
+  end
+
   describe '#helper_names' do
     context 'when a route is given a custom helper name' do
       it 'uses the custom name instead of the dynamically generated one' do
@@ -119,7 +170,7 @@ describe GrapePathHelpers::DecoratedRoute do
 
   describe '#path_segments_with_values' do
     context 'when path has dynamic segments' do
-      it 'replaces segments with corresponding values found in @options' do
+      it 'replaces segments with corresponding values found in options' do
         opts = { id: 1 }
         result = show_route.path_segments_with_values(opts)
         expect(result).to include(1)
@@ -133,6 +184,74 @@ describe GrapePathHelpers::DecoratedRoute do
         end
       end
     end
+
+    context 'when path has wildcard segments' do
+      context 'with regex excluding them' do
+        it "doesn't replaces wildcard segments" do
+          opts = { version: 4, id: 34, owner_ids: 'foobar' }
+
+          result = wildcard_route.path_segments_with_values(opts)
+          expect(result).to include(4)
+          expect(result).to include(34)
+          expect(result).to include('owner_ids')
+          expect(result).not_to include('foobar')
+        end
+
+        it "doesn't blank wildcard segments" do
+          opts = { version: 4, id: 34, owner_ids: '' }
+
+          result = wildcard_route.path_segments_with_values(opts)
+          expect(result).to include(4)
+          expect(result).to include(34)
+          expect(result).to include('owner_ids')
+        end
+      end
+
+      context 'with regex including them' do
+        context 'replaces segments' do
+          it 'with static text' do
+            opts = { version: 4, id: 34, owner_ids: 'foobar' }
+
+            result = wildcard_route.path_segments_with_values(opts, true)
+            expect(result).to include(4)
+            expect(result).to include(34)
+            expect(result).to include('foobar')
+            expect(result).not_to include('owner_ids')
+          end
+
+          it 'with additional segments' do
+            opts = { version: 4, id: 34, owner_ids: 'foo/bar/baz' }
+
+            result = wildcard_route.path_segments_with_values(opts, true)
+            expect(result).to include(4)
+            expect(result).to include(34)
+            expect(result).to include('foo/bar/baz')
+            expect(result).not_to include('owner_ids')
+          end
+        end
+
+        it 'blanks wildcard segments' do
+          opts = { version: 4, id: 34, owner_ids: '' }
+
+          result = wildcard_route.path_segments_with_values(opts, true)
+          expect(result).to include(4)
+          expect(result).to include(34)
+          expect(result).not_to include('owner_ids')
+        end
+
+        context 'when options contains string keys' do
+          it 'replaces segments' do
+            opts = { 'version' => 4, 'id' => 34, 'owner_ids' => 'foobar' }
+
+            result = wildcard_route.path_segments_with_values(opts, true)
+            expect(result).to include(4)
+            expect(result).to include(34)
+            expect(result).to include('foobar')
+            expect(result).not_to include('owner_ids')
+          end
+        end
+      end
+    end
   end
 
   describe '#path_helper_name' do
@@ -165,6 +284,13 @@ describe GrapePathHelpers::DecoratedRoute do
         expect(result).to eq('api_v1_path_path')
       end
     end
+
+    context 'when the path has a wildcard segment' do
+      it 'returns a name without the glob star' do
+        result = wildcard_route.path_helper_name
+        expect(result).to eq('api_v1_cats_owners_owner_ids_cats_path')
+      end
+    end
   end
 
   describe '#segment_to_value' do

data/spec/support/api.rb

@@ -36,6 +36,10 @@ module Spec
         get ':id/owners/:owner_id' do
           'owner'
         end
+
+        get ':id/owners/*owner_ids/cats' do
+          %w[cats cats cats]
+        end
       end
 
       route :any, '*path' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-path-helpers
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Drew Blessing
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2020-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Route path helpers for Grape