grape-route-helpers 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70edfbe7fe2afd10d2030ffbfec49dc642f57b40
-  data.tar.gz: 86b00458bc103bbd7c953bf4842ccedae8d4f9cd
+  metadata.gz: 7faecd03e24a18fca8562818d59b4013fd20e7a0
+  data.tar.gz: 59813a8cd72952eed995fe2b4e5111a64ad7312e
 SHA512:
-  metadata.gz: 5c98fd40561face8eb970ce8ac4d7de721835999a137f3ca6f25fd2761ac96160833d2c996f9d497a41202e8d51ea4c2cc7f95b17a13469d53c4f152c4b5dc8b
-  data.tar.gz: d6519d1439e8e86d67469d3cbac343d7f033123dd673a488469e800f3fa2567a152f6225b993a28d719f6ee68ce278ddbd4085a8648c131193fae90a544f82c0
+  metadata.gz: d2412a7a01687166ba0730618233df42c34efb7f90500183543acd4fe09195879421e4029c34610e8cb64448e2bf338fe54fc73c6728571aede71fa0f46f8909
+  data.tar.gz: 13d916287f03d1a7b3656c3e669786cda7ef8dd28fd827681d3ae3c71b97aeb11b37aef85c70d11ec5b0ab68ae956636b1c054039f571f42c2ca660036de6f88

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## June 28 2015
+
+Release 1.0.1
+
+* Rename rake task from `grape:routes` to `grape:route_helpers`
+
+* If a Grape::Route has a specific format (json, etc.) in its route_path attribute, the helper will return a path with this extension at the end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape-route-helpers (1.0.0)
+    grape-route-helpers (1.0.1)
       activesupport
       grape
       rake

data/README.md

@@ -87,13 +87,13 @@ You'd have the following methods available inside your Grape API actions:
 
 ```ruby
 # specifying the version when using Grape's "path" versioning strategy
-api_v1_ping_path # => '/api/v1/ping'
+api_v1_ping_path # => '/api/v1/ping.json'
 
 # specifying the format
-api_v1_cats_path(format: 'xml') # => '/api/v1/cats.xml'
+api_v1_cats_path(format: '.xml') # => '/api/v1/cats.xml'
 
 # passing in values required to build a path
-api_v1_cats_path(id: 1) # => '/api/v1/cats/1'
+api_v1_cats_path(id: 1) # => '/api/v1/cats/1.json'
 
 # catch-all paths have helpers
 api_v1_anything_path # => '/api/v1/*anything'

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

@@ -1,18 +1,31 @@
 module GrapeRouteHelpers
   # wrapper around Grape::Route that adds a helper method
   class DecoratedRoute
-    attr_reader :route, :helper_names, :helper_arguments
+    attr_reader :route, :helper_names, :helper_arguments, :extension
 
     def initialize(route)
       @route = route
       @helper_names = []
       @helper_arguments = required_helper_segments
+      @extension = default_extension
       define_path_helpers
     end
 
+    def default_extension
+      pattern = /\((\.\:?\w+)\)$/
+      match = route_path.match(pattern)
+      return '' unless match
+      ext = match.captures.first
+      if ext == '.:format'
+        ''
+      else
+        ext
+      end
+    end
+
     def define_path_helpers
       route_versions.each do |version|
-        route_attributes = { version: version }
+        route_attributes = { version: version, format: extension }
         method_name = path_helper_name(route_attributes)
         @helper_names << method_name
         define_path_helper(method_name, route_attributes)
@@ -28,9 +41,8 @@ module GrapeRouteHelpers
 
           content_type = attrs.delete(:format)
           path = '/' + path_segments_with_values(attrs).join('/')
-          extension = content_type ? '.' + content_type : ''
 
-          path + extension
+          path + content_type
         end
       RUBY
       instance_eval method_body

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

@@ -1,4 +1,4 @@
 # Gem version
 module GrapeRouteHelpers
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/tasks/grape_route_helpers.rake

@@ -1,6 +1,6 @@
 namespace :grape do
   desc 'Print route helper methods.'
-  task routes: :environment do
+  task route_helpers: :environment do
     GrapeRouteHelpers::RouteDisplayer.new.display
   end
 end

data/spec/grape_route_helpers/decorated_route_spec.rb

@@ -132,10 +132,18 @@ describe GrapeRouteHelpers::DecoratedRoute do
   end
 
   describe 'path helper method' do
+    # handle different Grape::Route#route_path formats in Grape 0.12.0
+    context 'when route_path contains a specific format' do
+      it 'returns the correct path with the correct format' do
+        path = index_route.api_v1_cats_path
+        expect(path).to eq('/api/v1/cats.json')
+      end
+    end
+
     context 'when helper does not require arguments' do
       it 'returns the correct path' do
         path = index_route.api_v1_cats_path
-        expect(path).to eq('/api/v1/cats')
+        expect(path).to eq('/api/v1/cats.json')
       end
     end
 
@@ -143,7 +151,7 @@ describe GrapeRouteHelpers::DecoratedRoute do
       context 'when not missing arguments' do
         it 'returns the correct path' do
           path = show_route.api_v1_cats_path(id: 1)
-          expect(path).to eq('/api/v1/cats/1')
+          expect(path).to eq('/api/v1/cats/1.json')
         end
       end
     end
@@ -154,14 +162,14 @@ describe GrapeRouteHelpers::DecoratedRoute do
       end
 
       it 'returns a path for each version' do
-        expect(index_route.api_v1_cats_path).to eq('/api/v1/cats')
-        expect(index_route.api_v2_cats_path).to eq('/api/v2/cats')
+        expect(index_route.api_v1_cats_path).to eq('/api/v1/cats.json')
+        expect(index_route.api_v2_cats_path).to eq('/api/v2/cats.json')
       end
     end
 
     context 'when a format is given' do
       it 'returns the path with a correct extension' do
-        path = show_route.api_v1_cats_path(id: 1, format: 'xml')
+        path = show_route.api_v1_cats_path(id: 1, format: '.xml')
         expect(path).to eq('/api/v1/cats/1.xml')
       end
     end

data/spec/grape_route_helpers/named_route_matcher_spec.rb

@@ -123,7 +123,7 @@ describe GrapeRouteHelpers::NamedRouteMatcher do
         api
 
         path = api_v1_ping_path
-        expect(path).to eq('/api/v1/ping')
+        expect(path).to eq('/api/v1/ping.json')
       end
 
       context 'when argument to the helper is not a hash' do
@@ -154,10 +154,10 @@ describe GrapeRouteHelpers::NamedRouteMatcher do
         api
 
         show_path = api_v1_cats_path('id' => 1)
-        expect(show_path).to eq('/api/v1/cats/1')
+        expect(show_path).to eq('/api/v1/cats/1.json')
 
         index_path = api_v1_cats_path
-        expect(index_path).to eq('/api/v1/cats')
+        expect(index_path).to eq('/api/v1/cats.json')
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-route-helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Harper Henn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-28 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -102,6 +102,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rubocop.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt