grape-route-helpers 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c89b2de6b727ea2d4e1953bca91338051e68e86
-  data.tar.gz: e2706efbbd654e9b1e19cb9f43fa2dee2e03bd5d
+  metadata.gz: 7ac7c28ada79f5622bae6ba7893bb199e7b33fcb
+  data.tar.gz: 06ef83ad1b9cf2cb508f5fe113295cbb20673992
 SHA512:
-  metadata.gz: 55a16e85e81fb667b224884f7d54a2e9c833728d62b37862769123e90f2caa4cbd5b123329efe83235c0de6e2b010bea93e8ceba7d6a2152a36b84ad2bb2fb10
-  data.tar.gz: 50d1900fb057a31219f2fe58b7f2aaf683f5ed717391e6bd4428fd766f69925e2433feb1e221a5dc2ff3909a34b381e214a7243f316ce644af2b5c83bd23c6cc
+  metadata.gz: 3be39b62345e43228f2088b6b9728c14e709b8a0aca5a8e5d5b794b69a8fe02301266790a7cda1670fd90f820e205064401d0906cfe1d706425c76f07785e3d4
+  data.tar.gz: a91eb07644365db63eafbd180f13dedf13c76e2e18750ed5deb9b827891748f2d4ba012631aef99fb9180a2440c9361201ebbc6febb130df64f7a96eb86a98f9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## October 11 2015
+
+* Release 1.2.1
+* Fixed issue #4
+
 ## September 27 2015
 
 * Release 1.2.0

data/Gemfile.lock

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

data/README.md

@@ -56,6 +56,13 @@ To see which methods correspond to which paths, and which options you can pass t
 $ rake grape:route_helpers
 ```
 
+#### Use Helpers in IRB/Pry
+
+You can use helper methods in your REPL session by including a module:
+
+```ruby
+[1] pry(main)> include GrapeRouteHelpers::NamedRouteMatcher
+```
 #### Use Helpers in Your API
 
 Use the methods inside your Grape API actions. Given this example API:

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

@@ -4,6 +4,10 @@ module GrapeRouteHelpers
     attr_reader :route, :helper_names, :helper_arguments,
                 :extension, :route_options
 
+    def self.sanitize_method_name(string)
+      string.gsub(/\W|^[0-9]/, '_')
+    end
+
     def initialize(route)
       @route = route
       @route_options = route.instance_variable_get(:@options)
@@ -80,7 +84,8 @@ module GrapeRouteHelpers
                end
       end
 
-      name + '_path'
+      sanitized_name = self.class.sanitize_method_name(name)
+      sanitized_name + '_path'
     end
 
     def segment_to_value(segment, opts = {})

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

@@ -4,6 +4,7 @@ module GrapeRouteHelpers
   # helper function name
   module NamedRouteMatcher
     def method_missing(method_id, *arguments)
+      super unless method_id.to_s.match(/_path$/)
       segments = arguments.first || {}
 
       route = Grape::API.decorated_routes.detect do |r|

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

@@ -1,4 +1,4 @@
 # Gem version
 module GrapeRouteHelpers
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/spec/grape_route_helpers/all_routes.rb

@@ -5,7 +5,7 @@ describe GrapeRouteHelpers::AllRoutes do
 
   describe '#all_routes' do
     context 'when API is mounted within another API' do
-      let(:mounting_api) { Spec::Support::RouteMatcherHelpers.mounting_api }
+      let(:mounting_api) { Spec::Support::MountedAPI }
 
       it 'does not include the same route twice' do
         mounting_api
@@ -20,7 +20,7 @@ describe GrapeRouteHelpers::AllRoutes do
         end
 
         expect(duplicates).to be_empty
-        expect(all_route_options.size).to eq(5)
+        expect(all_route_options.size).to eq(6)
       end
     end
   end

data/spec/grape_route_helpers/decorated_route_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe GrapeRouteHelpers::DecoratedRoute do
-  let(:api) { Spec::Support::RouteMatcherHelpers.api }
+  let(:api) { Spec::Support::API }
 
   let(:routes) do
     api.routes.map do |route|
@@ -25,6 +25,27 @@ describe GrapeRouteHelpers::DecoratedRoute do
     routes.detect { |route| route.route_path =~ /custom_name/ }
   end
 
+  let(:ping_route) do
+    routes.detect { |route| route.route_path =~ /ping/ }
+  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_(']
+      sanitized = illegal_names.map do |name|
+        described_class.sanitize_method_name(name)
+      end
+      expect(sanitized).to match_array(%w(beta_1 name_with__ name_with__))
+    end
+
+    it 'only replaces integers if they appear at the beginning' do
+      illegal_name = '1'
+      legal_name = 'v1'
+      expect(described_class.sanitize_method_name(illegal_name)).to eq('_')
+      expect(described_class.sanitize_method_name(legal_name)).to eq('v1')
+    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
@@ -40,15 +61,11 @@ describe GrapeRouteHelpers::DecoratedRoute do
     end
 
     context 'when an API has multiple versions' do
-      let(:api_versions) { %w(beta alpha v1) }
-
-      before do
-        api.version api_versions
-      end
+      let(:api) { Spec::Support::APIWithMultipleVersions }
 
       it "returns the route's helper name for each version" do
-        helper_names = show_route.helper_names
-        expect(helper_names.size).to eq(api_versions.size)
+        helper_names = ping_route.helper_names
+        expect(helper_names.size).to eq(api.version.size)
       end
     end
 
@@ -191,13 +208,12 @@ describe GrapeRouteHelpers::DecoratedRoute do
     end
 
     context "when a route's API has multiple versions" do
-      before(:each) do
-        api.version %w(v1 v2)
-      end
+      let(:api) { Spec::Support::APIWithMultipleVersions }
 
       it 'returns a path for each version' do
-        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')
+        expect(ping_route.alpha_ping_path).to eq('/alpha/ping')
+        expect(ping_route.beta_ping_path).to eq('/beta/ping')
+        expect(ping_route.v1_ping_path).to eq('/v1/ping')
       end
     end
 

data/spec/grape_route_helpers/named_route_matcher_spec.rb

@@ -3,16 +3,13 @@ require 'spec_helper'
 describe GrapeRouteHelpers::NamedRouteMatcher do
   include described_class
 
-  let(:api) { Spec::Support::RouteMatcherHelpers.api }
-
   let(:routes) do
-    api
     Grape::API.decorated_routes
   end
 
   let(:ping_route) do
     routes.detect do |route|
-      route.route_path =~ /ping/
+      route.route_path =~ /ping/ && route.route_version == 'v1'
     end
   end
 
@@ -120,16 +117,12 @@ describe GrapeRouteHelpers::NamedRouteMatcher do
   describe '#method_missing' do
     context 'when method name matches a Grape::Route path helper name' do
       it 'returns the path for that route object' do
-        api
-
         path = api_v1_ping_path
         expect(path).to eq('/api/v1/ping.json')
       end
 
       context 'when argument to the helper is not a hash' do
         it 'raises an ArgumentError' do
-          api
-
           expect do
             api_v1_ping_path(1234)
           end.to raise_error(ArgumentError)
@@ -139,8 +132,6 @@ describe GrapeRouteHelpers::NamedRouteMatcher do
 
     context 'when method name does not match a Grape::Route path helper name' do
       it 'raises a NameError' do
-        api
-
         expect do
           some_method_name
         end.to raise_error(NameError)
@@ -151,8 +142,6 @@ describe GrapeRouteHelpers::NamedRouteMatcher do
   context 'when Grape::Route objects share the same helper name' do
     context 'when helpers require different segments to generate their path' do
       it 'uses arguments to infer which route to use' do
-        api
-
         show_path = api_v1_cats_path('id' => 1)
         expect(show_path).to eq('/api/v1/cats/1.json')
 
@@ -163,8 +152,6 @@ describe GrapeRouteHelpers::NamedRouteMatcher do
 
     context 'when query params are passed in' do
       it 'uses arguments to infer which route to use' do
-        api
-
         show_path = api_v1_cats_path('id' => 1, params: { 'foo' => 'bar' })
         expect(show_path).to eq('/api/v1/cats/1.json?foo=bar')
 

data/spec/spec_helper.rb

@@ -5,5 +5,3 @@ require 'grape/route_helpers'
 
 support_files = Dir.glob('spec/support/*')
 support_files.each { |f| require File.expand_path(f) }
-
-include Spec::Support::RouteMatcherHelpers

data/spec/support/api.rb

@@ -0,0 +1,57 @@
+module Spec
+  module Support
+    # Test API
+    class API < Grape::API
+      version 'v1'
+      prefix 'api'
+      format 'json'
+
+      get 'custom_name', as: :my_custom_route_name do
+        'hello'
+      end
+
+      get 'ping' do
+        'pong'
+      end
+
+      resource :cats do
+        get '/' do
+          %w(cats cats cats)
+        end
+
+        route_param :id do
+          get do
+            'cat'
+          end
+        end
+      end
+
+      route :any, '*path' do
+        'catch-all route'
+      end
+    end
+
+    # API with more than one version
+    class APIWithMultipleVersions < Grape::API
+      version %w(beta alpha v1)
+
+      get 'ping' do
+        'pong'
+      end
+    end
+
+    # API with another API mounted inside it
+    class MountedAPI < Grape::API
+      mount Spec::Support::API
+    end
+
+    # API with a version that would be illegal as a method name
+    class APIWithIllegalVersion < Grape::API
+      version 'beta-1'
+
+      get 'ping' do
+        'pong'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-route-helpers
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Harper Henn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-27 00:00:00.000000000 Z
+date: 2015-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -122,7 +122,7 @@ files:
 - spec/grape_route_helpers/decorated_route_spec.rb
 - spec/grape_route_helpers/named_route_matcher_spec.rb
 - spec/spec_helper.rb
-- spec/support/route_matcher_helpers.rb
+- spec/support/api.rb
 homepage: https://github.com/reprah/grape-route-helpers
 licenses:
 - MIT

data/spec/support/route_matcher_helpers.rb

@@ -1,44 +0,0 @@
-module Spec
-  module Support
-    # container for methods used in specs
-    module RouteMatcherHelpers
-      def self.api
-        Class.new(Grape::API) do
-          version 'v1'
-          prefix 'api'
-          format 'json'
-
-          get 'custom_name', as: :my_custom_route_name do
-            'hello'
-          end
-
-          get 'ping' do
-            'pong'
-          end
-
-          resource :cats do
-            get '/' do
-              %w(cats cats cats)
-            end
-
-            route_param :id do
-              get do
-                'cat'
-              end
-            end
-          end
-
-          route :any, '*path' do
-            'catch-all route'
-          end
-        end
-      end
-
-      def self.mounting_api
-        Class.new(Grape::API) do
-          mount Spec::Support::RouteMatcherHelpers.api
-        end
-      end
-    end
-  end
-end