droutes 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5170a29cf67dc90e0ee5d42699090274abff096
-  data.tar.gz: cb2c59bc4673ed3c57b7faa74d35da68943023aa
+  metadata.gz: e9ee275f75f3f7d41c1ca47ff00d5e21374f00c0
+  data.tar.gz: 8f7a4017c5547d13e72ea09cc10efb4d1feba0e1
 SHA512:
-  metadata.gz: f09440c38cc9cb56fd0fca2471ac02e1908e8a3d64cf37ff3eaf2a0df748d3d3f1dd8fc0c5e99dc61ba7dc5c641c091879eaa78bda95977aa6ce53fdcdbb046f
-  data.tar.gz: c69c4a8a1786dce0c687ea58bd3471077bf514811d3ef1ea8b005d1208c4b47e7a2bc2310294bf355fbfb34131ce607cd123e9569fbb8831e7b145f45ffe2740
+  metadata.gz: b7a35a2e01f9966a7b82105f7e47f68f54a45bb3dbde6fda2885b50db0a05ac78ea6f0b5fa8f4e8f2d40c6d106dcd7bef8b21dca889385e0b3c4f9853123ac13
+  data.tar.gz: 14aaced7ffabc0cf9fffcf29c5887009eea4d1bc0992b18812d8414ae84f9b97b3f532e1db50f77bf7f1f0a13e6b509fdd1b5332605078f05188f980b0bacda3

data/lib/generators/droutes/documentation_generator.rb

@@ -107,12 +107,34 @@ DOC
     end
 
     def comments_doc(doc)
+      params_dl = '<dl class="dl-horizontal params">'
+      example_json = ''
+      doc.tags("param").each do |param|
+        params_dl += "    <dt>#{param.name}</dt><dd>[#{param.types.join('|')}] #{param.text}</dd>"
+        eg_param = param.types.first
+        eg_text = if ["String", "Symbol"].include?(eg_param)
+                    '"some string"'
+                  elsif ["Fixnum", "Integer", "Int"].include?(eg_param)
+                    rand(100)
+                  elsif ["Float", "Double", "Numeric"].include?(eg_param)
+                    (rand * 100.0).round(2)
+                  elsif eg_param == "Hash"
+                    '{}'
+                  elsif eg_param == "Arrray"
+                    '[]'
+                  end
+        example_json += "\n    \"#{param.name}\": #{eg_text},"
+      end
+      unless example_json.blank?
+        example_json = "<p>Example JSON Body</p><pre><code>{#{example_json}\n}</code></pre>"
+      end
       <<DOC
     <p class="summary">#{doc.summary}</p>
     <dl class="dl-horizontal params">
-        #{doc.tags("param").collect{|param| "<dt>#{param.name}</dt><dd>[#{param.types.join("|")}] #{param.text}</dd>"}.join("\n")}
+        #{params_dl}
         #{(ret = doc.tags("return").first) and "<dt>[return]</dt><dd>#{ret.text}</dd>"}
     </dl>
+    #{example_json}
 DOC
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droutes
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Tyler Margison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-27 00:00:00.000000000 Z
 dependencies: []
 description: Generating documentation for REST endpoints for client developers can
   be a pain, but droutes can make it easy.