grape-markdown 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30f403b536969e9ff19d17557900c45af9560c43
-  data.tar.gz: a6e79f5280fd10081e291afb34ad391de064b34f
+  metadata.gz: fd6795347e2d992cc9afb0cff433233546c37c85
+  data.tar.gz: 2ae1d275b9041fb8156b00fa03e0dba70771a152
 SHA512:
-  metadata.gz: 845705d3464c1b22597cc19979488b546ebd7f8db9ca0228ae84da26348fbf50b2acf93dda6556294a83abea97d151e1bbb6fd3a98fbf84a9ae8f1dc5ac3daee
-  data.tar.gz: 365d3089e3a15d327684040cbf69b69d2ab3f51beed7e01fc7c218bd09773938853e9ffd865286ca1d1ed61a5a353ad2ff4bbcd841058faecbd12b72aec0e6fb
+  metadata.gz: 0a932d99462ca9b8730897151b20876612919d4107a349851a3ee30a01902e11f6243a65f8039c0d87798e404ff5095d90b257240bd3fd5084414dbdff41b71b
+  data.tar.gz: 507427675239837beb66161070d93ecacf44fefa80348f951596444b0a4fd1136fa77d39221ff3dc3f3786b1a297984cf463f5af51022c29af512183ca00399d

data/lib/grape-markdown/document.rb

@@ -30,7 +30,7 @@ module GrapeMarkdown
     def resources
       @resources ||= begin
         grouped_routes = routes.group_by(&:route_name).reject do |name, routes|
-          resource_exclusion.include?(name.to_sym)
+          resource_exclusion.include?(name.parameterize('_').to_sym)
         end
 
         grouped_routes.map { |name, routes| Resource.new(name, routes) }

data/lib/grape-markdown/route.rb

@@ -38,7 +38,9 @@ module GrapeMarkdown
       #{list? ? route_title : route_title.singularize}
       DESCRIPTION
 
-      description << "on a #{root_resource_title.singularize}" if has_parent?
+      description << "on a #{root_resource_title.singularize}" if parent?
+
+      description
     end
 
     def route_path_without_format
@@ -63,7 +65,7 @@ module GrapeMarkdown
       !%w(GET DELETE).include?(route_method)
     end
 
-    def has_parent?
+    def parent?
       route_name != root_resource
     end
   end

data/lib/grape-markdown/version.rb

@@ -1,3 +1,3 @@
 module GrapeMarkdown
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/grape-markdown/document_spec.rb

@@ -39,6 +39,10 @@ describe GrapeMarkdown::Document do
     it 'includes properties for the resources' do
       expect(subject).to include('Properties')
     end
+
+    it 'includes short route descriptions' do
+      expect(subject).to include('## Post a Widget')
+    end
   end
 
   it 'exposes configuration settings' do

data/spec/support/sample_api.rb

@@ -31,6 +31,28 @@ class SampleApi < Grape::API
     end
   end
 
+  resource '/widgets/:widget_id/sprockets' do
+    desc 'create a sprocket for a specific widget'
+    params do
+      requires :name,
+               type: 'string',
+               desc: 'the widgets name',
+               documentation: { example: 'super widget' }
+    end
+    post '/' do
+    end
+
+    desc 'updates a sprocket for a specific widget'
+    params do
+      requires :name,
+               type: 'string',
+               desc: 'the widgets name',
+               documentation: { example: 'super widget' }
+    end
+    put ':id' do
+    end
+  end
+
   resource 'admin' do
     get '/' do
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - John Allen