grape-markdown 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e25251ad9ffa8528ff2cce7f2c22de9442bb0d4a
-  data.tar.gz: a712b64644241064a0ba9f72b3920181d77222a0
+  metadata.gz: 30f403b536969e9ff19d17557900c45af9560c43
+  data.tar.gz: a6e79f5280fd10081e291afb34ad391de064b34f
 SHA512:
-  metadata.gz: 21dc05842af3d45fd5544a9bbfa036894eaad89e066dae87ca383b3fff9da666cfdbdbed19dd959a0b7b7c16c80a202b54f82cb020d17d1221a281901f40470d
-  data.tar.gz: a345de86136d1bdf399faa931612c837dc335d87cde936b763ae9f1637da7486228fc0c77d6ff04a97a060f769ccb6ec3601ae68246e0011bd0764813f15ff7a
+  metadata.gz: 845705d3464c1b22597cc19979488b546ebd7f8db9ca0228ae84da26348fbf50b2acf93dda6556294a83abea97d151e1bbb6fd3a98fbf84a9ae8f1dc5ac3daee
+  data.tar.gz: 365d3089e3a15d327684040cbf69b69d2ab3f51beed7e01fc7c218bd09773938853e9ffd865286ca1d1ed61a5a353ad2ff4bbcd841058faecbd12b72aec0e6fb

data/lib/grape-markdown/parameter.rb

@@ -2,7 +2,7 @@ module GrapeMarkdown
   class Parameter
     attr_reader :route, :full_name, :name, :settings
 
-    delegate :route_model, :route_namespace, to: :route
+    delegate :route_name, :route_namespace, to: :route
     delegate :requirement, :type, :documentation, :desc, to: :settings
     delegate :example, to: :documentation, allow_nil: true
 
@@ -29,7 +29,7 @@ module GrapeMarkdown
     end
 
     def default_options(options)
-      model = name.include?('_id') ? name.gsub('_id', '') : route.route_model
+      model = name.include?('_id') ? name.gsub('_id', '') : route.route_name
 
       {
         required:       true,

data/lib/grape-markdown/route.rb

@@ -8,6 +8,14 @@ module GrapeMarkdown
              :route_description,
              to: '__getobj__'
 
+    def root_resource
+      route_namespace.split('/').reject(&:empty?).first
+    end
+
+    def root_resource_title
+      root_resource.titleize
+    end
+
     def route_params
       @route_params ||= __getobj__.route_params.sort.map do |param|
         Parameter.new(self, *param)
@@ -19,24 +27,30 @@ module GrapeMarkdown
         route_path.match('\/(\w*?)[\.\/\(]').captures.first
     end
 
+    def route_title
+      route_name.titleize
+    end
+
     def route_short_description
-      "#{route_method.titleize} a #{route_model}"
+      description = <<-DESCRIPTION.gsub(/^\s*/, '').gsub(/\n/, ' ').squeeze
+      #{route_method.titleize} a
+      #{list? ? 'list of '  : ' '}
+      #{list? ? route_title : route_title.singularize}
+      DESCRIPTION
+
+      description << "on a #{root_resource_title.singularize}" if has_parent?
     end
 
     def route_path_without_format
       route_path.gsub(/\((.*?)\)/, '')
     end
 
-    def route_model
-      route_namespace.split('/').last.singularize
-    end
-
     def route_type
       list? ? 'collection' : 'single'
     end
 
     def list?
-      %w(GET POST).include?(route_method) && !route_path.include?(':id')
+      route_method == 'GET' && !route_path.include?(':id')
     end
 
     def route_binding
@@ -48,5 +62,9 @@ module GrapeMarkdown
     def request_body?
       !%w(GET DELETE).include?(route_method)
     end
+
+    def has_parent?
+      route_name != root_resource
+    end
   end
 end

data/lib/grape-markdown/templates/document.md.erb

@@ -8,7 +8,7 @@
   <% resource.namespaced.each do |grouped_resource| %>
     <% grouped_resource.paths.each do |resource_by_path| %>
       <% resource_by_path.routes.each do |route| %>
-## <%= route.route_description %>
+## <%= route.route_short_description %>
       <% end %>
     <% end %>
   <% end %>

data/lib/grape-markdown/version.rb

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

metadata

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