api_def 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdb595f5b66b430007981a694dd0156a8e086122
-  data.tar.gz: 7f035fbce6c170108d3312c2777c5c70545c7f2f
+  metadata.gz: facc10cef9e3e33751c5509748fd9ca0c8b2a313
+  data.tar.gz: d627cb23afbcad348313fe5d77613745302b0176
 SHA512:
-  metadata.gz: 9c82ff6bf4a4376c6c828b962fe90f94673ec655d5134d84e3f2cc75aff600609b6b3cc60a4279cfd2027877186fe30e2de04ec4e240ccd52a11b4e709cd2d25
-  data.tar.gz: 8f3ea1ee1dd08e8323ad55541f45c21ffc98bb69f515d123c3db74eb2e26f318723cd719256c79643276fb50f0bf6d15d7baffb823349f5fb805f890ea6b8f28
+  metadata.gz: 56367bd34b1c6a5a9841e56b99805c9d27ed3e8e4ae88cf20c4f8444dcff1f988c6354a7a642f69247caad559fa77d42a8babda72422288b2ffed6d749f25c95
+  data.tar.gz: 922530e97e7120658e668a984ed8626198d8ff92abd6d64068d5fa310439d3e900e87ebc1c90737cd783208edf9d0fb6aba035de2670a9d6f4ebfa8bcaef8e97

data/lib/api_def.rb

@@ -1,5 +1,5 @@
 module ApiDef
-  VERSION="1.0.1"
+  VERSION="1.0.2"
   # CLI
   autoload :CLI,      'api_def/cli'
   autoload :Template, 'api_def/template'

data/lib/api_def/cli.rb

@@ -7,7 +7,7 @@ class ApiDef::CLI < Thor
     default: 'markdown',
     required: true,
     type: :string,
-    enum: ['markdown', 'html'],
+    enum: ApiDef::Template::SUPPORTED_TEMPLATES,
     desc: 'Output template'
   }
   def build(file)

data/lib/api_def/parameter.rb

@@ -1,9 +1,10 @@
 class ApiDef::Parameter < ApiDef::Element
-  attr_uno :optional, :type
+  attr_uno :optional, :type, :value
 
   def on_options(options)
     super
     self.optional options[:optional]
     self.type options[:type]
+    self.value options[:value]
   end
 end

data/lib/api_def/template.rb

@@ -1,14 +1,12 @@
 class ApiDef::Template
-  autoload :Markdown, 'api_def/template/markdown'
-  autoload :Html,     'api_def/template/html'
+  SUPPORTED_TEMPLATES = ['html', 'markdown', 'textile', 'confluence']
+
+  SUPPORTED_TEMPLATES.each do |tpl|
+    self.autoload tpl.capitalize.to_sym, "api_def/template/#{tpl}"
+  end
 
   def self.find(name)
-    case name.to_s
-    when 'html'
-      ApiDef::Template::Html
-    when 'markdown'
-      ApiDef::Template::Markdown
-    end
+    self.const_get name.capitalize
   end
 
   def render(spec)

data/lib/api_def/template/confluence.rb

@@ -0,0 +1,68 @@
+require 'erb'
+require 'json'
+
+class ApiDef::Template::Confluence < ApiDef::Template
+  TEMPLATE_FILE= %{
+h1. <%= spec.name %>
+
+h1. <%= spec.version %>
+
+<% spec.elements.each do |ele| -%>
+h2. <%= ele.name %>
+
+<%= ele.desc %>
+<% end -%>
+
+<% spec.groups.each do |group| -%>
+h2. <%= group.name %>
+----
+
+<%= group.desc %>
+    <% group.entries.each do |entry| %>
+h3. <%= entry.name %>
+----
+
+<%= entry.desc %>
+
+h4. {{<%= entry.method.to_s.upcase %>}} {{<%= entry.path %>}}
+      <% entry.requests.each do |request| -%>
+
+h4. Request <%= request.name %>
+
+<%= request.desc %>
+
+<% request.params.each do |param| -%>
+* {{<%= param.name %>}}<%= " = {{" + param.value.to_s "}}" if param.value %><%= ", " + param.type.to_s if param.type %><%=", Optional" if param.optional %><%= ", " + param.desc.to_s if param.desc %>
+<% end -%>
+
+      <% end -%>
+
+      <% entry.responses.each do |response| -%>
+
+h4. Response <%= response.name %>
+
+<%= response.desc %>
+
+{code:language=javascript}
+<%= JSON.pretty_generate(response.body) %>
+{code}
+
+      <% end -%>
+    <% end -%>
+  <% end -%>
+}
+
+  def render(_spec)
+    clazz = ::ERB.new(TEMPLATE_FILE, nil, "-").def_class
+    clazz.class_eval do
+      def initialize(_spec)
+        @spec = _spec
+      end
+
+      def spec
+        @spec
+      end
+    end
+    clazz.new(_spec).result
+  end
+end

data/lib/api_def/template/html.rb

@@ -19,6 +19,7 @@ class ApiDef::Template::Html < ApiDef::Template
       <title>#{spec.name}</title>
       <style>
       body {
+        font-family: sans-serif;
         min-width: 200px;
         max-width: 790px;
         margin: 0 auto;

data/lib/api_def/template/markdown.rb

@@ -4,6 +4,7 @@ require 'json'
 class ApiDef::Template::Markdown < ApiDef::Template
   TEMPLATE_FILE= %{
 # <%= spec.name %>
+
 # <%= spec.version %>
 
 <% spec.elements.each do |ele| -%>
@@ -12,7 +13,7 @@ class ApiDef::Template::Markdown < ApiDef::Template
 <%= ele.desc %>
 <% end -%>
 
-<% spec.groups.each do |group| -%>
+<% spec.groups.each do |group|  %>
 ## <%= group.name %>
 
 <%= group.desc %>
@@ -21,22 +22,22 @@ class ApiDef::Template::Markdown < ApiDef::Template
 
 <%= entry.desc %>
 
-#### `<%= entry.path %>` [<%= entry.method.to_s.upcase %>]
+#### `<%= entry.method.to_s.upcase %>` `<%= entry.path %>`
       <% entry.requests.each do |request| -%>
 
-##### Request <%= request.name %>
+#### Request <%= request.name %>
 
 <%= request.desc %>
 
 <% request.params.each do |param| -%>
-+ `<%= param.name %>`, <%= param.type %>, <%="Optional, " if param.optional%><%= param.desc %>
++ `<%= param.name %>`<%= " = `" + param.value.to_s + "`" if param.value %><%= ", " + param.type.to_s if param.type %><%=", Optional" if param.optional%><%= ", " + param.desc.to_s if param.desc %>
 <% end -%>
 
       <% end -%>
 
       <% entry.responses.each do |response| -%>
 
-##### Response <%= response.name %>
+#### Response <%= response.name %>
 
 <%= response.desc %>
 

data/lib/api_def/template/textile.rb

@@ -0,0 +1,64 @@
+require 'erb'
+require 'json'
+
+class ApiDef::Template::Textile < ApiDef::Template
+  TEMPLATE_FILE= %{
+h1. <%= spec.name %>
+
+h1. <%= spec.version %>
+
+<% spec.elements.each do |ele| -%>
+h2. <%= ele.name %>
+
+<%= ele.desc %>
+<% end -%>
+
+<% spec.groups.each do |group| -%>
+h2. <%= group.name %>
+
+<%= group.desc %>
+    <% group.entries.each do |entry| %>
+h3. <%= entry.name %>
+
+<%= entry.desc %>
+
+h4. @<%= entry.method.to_s.upcase %>@ @<%= entry.path %>@
+      <% entry.requests.each do |request| -%>
+
+h4. Request <%= request.name %>
+
+<%= request.desc %>
+
+<% request.params.each do |param| -%>
+* @<%= param.name %>@<%= " = @" + param.value.to_s + "@" if param.value %><%= ", " + param.type.to_s if param.type %><%=", Optional" if param.optional %><%= ", " + param.desc.to_s if param.desc %>
+<% end -%>
+
+      <% end -%>
+
+      <% entry.responses.each do |response| -%>
+
+h4. Response <%= response.name %>
+
+<%= response.desc %>
+
+bc. <%= JSON.pretty_generate(response.body) %>
+
+      <% end -%>
+    <% end -%>
+  <% end -%>
+}
+
+  def render(_spec)
+    clazz = ::ERB.new(TEMPLATE_FILE, nil, "-").def_class
+    clazz.class_eval do
+      def initialize(_spec)
+        @spec = _spec
+      end
+
+      def spec
+        @spec
+      end
+    end
+    clazz.new(_spec).result
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_def
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - YANKE Guo
@@ -85,8 +85,10 @@ files:
 - lib/api_def/support/attr_array.rb
 - lib/api_def/support/attr_uno.rb
 - lib/api_def/support/attr_uno_array.rb
+- lib/api_def/template/confluence.rb
 - lib/api_def/template/html.rb
 - lib/api_def/template/markdown.rb
+- lib/api_def/template/textile.rb
 - lib/api_def/template.rb
 - lib/api_def.rb
 - bin/api_def
@@ -115,3 +117,4 @@ signing_key:
 specification_version: 4
 summary: API definition tool
 test_files: []
+has_rdoc: