api_doc_generation 0.0.10 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfd6d9a51b3cea651107bc1cc86c4a0c9736f78b
-  data.tar.gz: efca0e893814534a147bd931102ef7b2c20c47a3
+  metadata.gz: d3c631601be29797aa6e14707a92b515fa6b68be
+  data.tar.gz: 942cee388e1db6bfd6cd96672e2e7c51a5b9db2c
 SHA512:
-  metadata.gz: c4bdc21f7b23a83a990d9372b83c3821851ec8d925c802fffc3518de4584d3895373e440c0718d538d62965d80d4a046a7476a98b80d585d15d69a28782fd150
-  data.tar.gz: 75b4a8d3d6f80fab1ce8c18db9a7d9cf34d68bd4db10e7bf0b1014f04da26495ea2d05e159e481d555ec176da264700bc5127bc7efdea5c418b294ccaba118d6
+  metadata.gz: c12bf362dc163eb5f8c3befc5dca58a17494ae0ff5928520f23698d07feec8f759fb6ee4124aa406c24e729009bb6ef3ba7a3f6713131d05206de5b922f944f8
+  data.tar.gz: 83f02c76a07a1f33291cdfd9e4d391d36c9d2b60b8a2f1053de8f71c769dc3b05deb2cf8c7c542a55eea62d220a8b81793c45fdd1244b441260482a73a148384

data/README.md

@@ -18,11 +18,15 @@ Or install it yourself as:
 
 ## Usage
 
-`rake doc:api [CODES_PATH=app/controllers/api]`
+`rake doc:api [CODES_PATH=app/controllers/api] [OUT_FORMAT=simple_html|detailed_html]`
 
 __代码注释格式:__
 
 ```
+
+  # About: 文件说明
+  # Host: 定义api host
+  # Other: ...
   class Api::UsersController < class Api::BaseController
     # 取得所有用户
     # 
@@ -49,6 +53,20 @@ __代码注释格式:__
     def show
       # ...
     end
+
+    # 自定义路由
+    # 
+    # Path: /path/to/api
+    # Method: POST
+    # Params:
+    #   user_id: [String] 用户的id
+    # Return:
+    #   name: [String] xxx
+    # Other: 自定义的信息
+    # Other2: 更多的自定义信息..
+    def update
+      # ...
+    end
   end
 ```
 

data/lib/api_doc_generation/format_file.rb

@@ -0,0 +1,77 @@
+
+
+module ApiDocGeneration; module FormatFile; class << self
+  def analyze_file(path)
+    controller_path = path.split("app/controllers").last
+    class_name = controller_path.gsub(/controller.*\.rb/, 'controller').classify
+
+    klass = class_name.safe_constantize
+    filelines = File.readlines(path)
+    actions = klass.action_methods - klass.superclass.action_methods
+
+    actions = actions.map do |action|
+      method = klass.instance_method action
+      filepath, line = method.source_location
+      note = FormatNote.analyze(filelines, line - 2)
+      note["Level"] ||= ''
+      note['Name'] = action.to_s
+      note = get_routes(klass, action).merge(note) unless note['Path']
+      note
+    end
+
+    {
+      'Path' => path,
+      'Klass' => klass.to_s,
+      'About' => get_controller_about(filelines, klass.to_s),
+      'Actions' => actions
+    }
+  end
+
+
+  private
+
+  def get_controller_about(filelines, class_name)
+    filelines.each_with_index do |line, line_number|
+      next if line =~ /^\s*(\#.*)?$/
+      
+      doc = FormatNote.analyze(filelines, line_number -1)
+
+      doc.delete_if {|key, v| key =~ /encoding/ }
+
+      return doc
+    end
+
+    return {}
+  end
+
+
+  def get_routes(klass, action)
+    controller = klass.to_s.gsub(/Controller$/, '').underscore
+
+    (@routes ||= rails_routes).each do |route|
+      if route[:reqs] == "#{controller}##{action}"
+        return {
+          'Path' => route[:path].gsub('(.:format)', ''),
+          'Method' => route[:verb]
+        }
+      end
+    end
+
+    {
+      'Path' => "",
+      'Method' => ""
+    }
+  end
+
+
+  def rails_routes
+    Rails.application.reload_routes!
+    all_routes = Rails.application.routes.routes
+
+    require 'rails/application/route_inspector'
+    inspector = Rails::Application::RouteInspector.new
+
+    inspector.collect_routes(all_routes) + 
+      inspector.instance_variable_get(:@engines).flatten
+  end
+end; end; end

data/lib/api_doc_generation/format_note.rb

@@ -0,0 +1,86 @@
+
+
+
+
+# desc
+#
+# Params:
+#   attr: xxx
+#   other: yyy
+#       asdf las dflkj
+# Other:
+#   attr: aaa
+#
+# 
+# conversion => 
+# {
+#   'desc' => 'desc',
+#   'Params' => [{level: 1, }],
+# }  
+#
+
+module ApiDocGeneration; module FormatNote; class << self
+  
+  def analyze(filelines, line_number)
+    document = {}
+    
+    tmp = []; last_line = ""
+
+    line_number.downto(0) do |i|
+      line = filelines[i]
+
+      break unless line =~ /^\s*(\#.*?\n)?$/
+      break if line =~ /encoding/
+
+      line.gsub!(/\s*\#/, '')
+      next if line =~ /^\s*$/
+
+      format_line(line, tmp, document)
+
+      last_line = line
+    end
+
+    document['Desc'] = last_line
+    document.delete last_line
+
+    Hash[document.to_a.reverse]
+  end
+
+
+
+  private
+
+  def format_line(line, tmp, document)
+    m = line.match(/(?<level>\s*)(?<desc>(?<key>.*?)(\:(?<val>.*?))?)$/)
+    level = m[:level].length / 2
+    desc = m[:desc].gsub(/^\s*|\s*$/, '')
+    line.gsub!(/^\s*|\:?\s*$/, '')
+
+    if level == 0
+      if tmp.length == 0 && m[:val] && m[:val].length > 0
+        document[m[:key]] = m[:val]
+      else
+        document[m[:key] + (m[:val] || '')] = tmp.reverse.each_with_object([]) do |p, result|
+          if p['level'] >= 2 && result.last
+            result.last['children'] ||= []
+            result.last['children'] << p
+          else
+            result << p
+          end
+        end
+      end
+      tmp.clear
+    else
+      m = desc.match(/(?<name>\w+)\:?\s*((\[(?<type>.*?)\]\s*)?(?<val>.*))?$/)
+      p = {'level' => level, 'desc' => desc}
+
+      p.merge!({
+        'name' => m[:name],
+        'type' => m[:type],
+        'val' => m[:val]
+      }) if m
+
+      tmp << p
+    end
+  end
+end; end; end

data/lib/api_doc_generation/generation.rb

@@ -0,0 +1,53 @@
+
+
+require 'api_doc_generation/format_file'
+require 'api_doc_generation/format_note'
+
+
+module ApiDocGeneration; class Generation
+  attr_reader :controller_documents
+
+  def initialize(codes_path = nil, title = '')
+    codes_path ||= File.expand_path('app/controllers/api', Rails.root)
+    @controller_documents = []
+    @title = title
+
+    each_api_controllers_file(codes_path) do |path|
+      @controller_documents << FormatFile.analyze_file(path)
+    end
+  end
+
+
+  def generate_html_string(opts = {})
+    path = File.read(File.expand_path('templates/doc.html.erb', ROOT_PATH))
+
+    ViewHelper.render(ERB.new(path), opts.merge({
+      :documents => @controller_documents,
+      :title => @title
+    }), path)
+  end
+
+
+  def generate_detailed_html_string(opts = {})
+    path = File.read(File.expand_path('templates/doc_detailed.html.erb', ROOT_PATH))
+
+    ViewHelper.render(ERB.new(path), opts.merge({
+      :documents => @controller_documents,
+      :title => @title
+    }), path)
+  end
+
+
+  private
+
+
+  # API_CONTROLLERS_DIR = File.expand_path('app/controllers/api/**/*.rb', Rails.root)
+  def each_api_controllers_file(codes_path, &block)
+
+    Dir[codes_path + '/**/*.rb'].each do |path|
+      next if path =~ /base_controller.*\.rb$/
+      block.call path
+    end
+  end
+end; end
+

data/lib/api_doc_generation/version.rb

@@ -1,3 +1,3 @@
 module ApiDocGeneration
-  VERSION = "0.0.10"
+  VERSION = "0.2.1"
 end

data/lib/api_doc_generation/view_helper.rb

@@ -1,13 +1,20 @@
 # encoding: utf-8
 
 module ApiDocGeneration; class ViewHelper
-  def self.render(template, args = {})
+  def self.render(template, args = {}, file_path = '')
     template.result(self.new(args).obj_binding)
+
+  rescue => e
+    e.backtrace[0].gsub!(/^\(erb\)/, file_path)
+    
+    raise e
   end
 
 
   # {:a => 1, :b => 2}
   def initialize(args)
+    @args = args
+    
     args.each do |key, val|
       self.instance_variable_set("@#{key}", val)
     end
@@ -20,6 +27,19 @@ module ApiDocGeneration; class ViewHelper
 
 
 
+
+  ################## View Helper ###################
+
+  def render(path, opts = {})
+    file_path = File.expand_path("templates/_#{path}.html.erb", ROOT_PATH)
+
+    template = ERB.new(File.read(file_path))
+
+    self.class.render(template, @args.merge(opts), file_path)
+  end
+
+
+
   ################## Helper #######################
   def action_identifer(controller_name, action_name)
     "action-#{Digest::MD5.hexdigest(controller_name)}-#{action_name}"
@@ -32,47 +52,47 @@ module ApiDocGeneration; class ViewHelper
 
 
   def format_param(param)
-    return unless param[:val].to_s =~ /^\s*$/
+    return unless param['val'].to_s =~ /^\s*$/
 
-    case param[:name]
+    case param['name']
     when 'app_uname'
-      param[:type] = 'String'
-      param[:val] = 'app的唯一标识名，表明调用此api是在哪个app下'
+      param['type'] = 'String'
+      param['val'] = 'app的唯一标识名，表明调用此api是在哪个app下'
     when 'access_token'
-      param[:type] = 'String'
-      param[:val] = '请求的唯一标识，用于识别用户，用户登陆返回或是使用refresh_token换取'
+      param['type'] = 'String'
+      param['val'] = '请求的唯一标识，用于识别用户，用户登陆返回或是使用refresh_token换取'
     when 'refresh_token'
-      param[:type] = 'String'
-      param[:val] = '用户登陆时返回，使用此token来取得新的access_token'
+      param['type'] = 'String'
+      param['val'] = '用户登陆时返回，使用此token来取得新的access_token'
     when 'page'
-      param[:type] = 'Integer'
-      param[:val] = '返回所有数据中的第几页'
+      param['type'] = 'Integer'
+      param['val'] = '返回所有数据中的第几页'
     when 'perpage'
-      param[:type] = 'Integer'
-      param[:val] = '返回数据每页多少条'
+      param['type'] = 'Integer'
+      param['val'] = '返回数据每页多少条'
     end
   end
 
 
   def format_response_param(param)
-    return unless param[:val].to_s =~ /^\s*$/
+    return unless param['val'].to_s =~ /^\s*$/
 
-    case param[:name]
+    case param['name']
     when 'current_page'
-      param[:type] = 'Integer'
-      param[:val] = '当前返回数据是第几页'
+      param['type'] = 'Integer'
+      param['val'] = '当前返回数据是第几页'
     when 'perpage'
-      param[:type] = 'Integer'
-      param[:val] = '每页返回的数据量'
+      param['type'] = 'Integer'
+      param['val'] = '每页返回的数据量'
     when 'count'
-      param[:type] = 'Integer'
-      param[:val] = '数据总数量'
+      param['type'] = 'Integer'
+      param['val'] = '数据总数量'
     when 'items'
-      param[:type] = 'Array'
-      param[:val] = '数组中存放当前页的数据'
+      param['type'] = 'Array'
+      param['val'] = '数组中存放当前页的数据'
     when 'total_pages'
-      param[:type] = 'Integer'
-      param[:val] = '数据的总页数'
+      param['type'] = 'Integer'
+      param['val'] = '数据的总页数'
     end
   end
 

data/lib/api_doc_generation.rb

@@ -8,184 +8,9 @@ if defined? Rake
   require "rake/api_doc_generation"
 end
 
+require 'api_doc_generation/generation'
 
-module ApiDocGeneration; class Generation
-  def initialize(codes_path = nil)
-    codes_path ||= File.expand_path('app/controllers/api', Rails.root)
-    @controller_documents = []
 
-    each_api_controllers_file(codes_path) do |path|
-      controller_path = path.split("app/controllers").last
-      class_name = controller_path.gsub('.rb', '').classify
-      klass = class_name.safe_constantize
-
-      @controller_documents << generate_controller(path, klass)
-    end
-  end
-
-
-  def generate_html_string(opts = {})
-    template = ERB.new(
-      File.read(File.expand_path('../../templates/doc.html.erb', __FILE__))
-    )
-
-    ViewHelper.render(template, opts.merge({
-      :documents => @controller_documents
-    }))
-  end
-
-
-  def generate_detailed_html_string(opts = {})
-    template = ERB.new(
-      File.read(File.expand_path('../../templates/doc_detailed.html.erb', __FILE__))
-    )
-
-    ViewHelper.render(template, opts.merge({
-      :documents => @controller_documents
-    }))
-  end
-
-
-  private 
-
-
-  # API_CONTROLLERS_DIR = File.expand_path('app/controllers/api/**/*.rb', Rails.root)
-  def each_api_controllers_file(codes_path, &block)
-
-    Dir[codes_path + '/**/*.rb'].each do |path|
-      next if path =~ /base_controller.rb$/
-      block.call path
-    end
-  end
-
-
-
-  # {
-  #  
-  #   :path => path,
-  #   :actions => [
-  #     {
-  #       "Params" => ['xxx', 'yyy'],
-  #       "zzz" => ["zz1", "zz2"]
-  #     }
-  #   ]
-  # }
-  def generate_controller(path, klass)
-    filelines = File.readlines(path)
-    actions = klass.action_methods - klass.superclass.action_methods
-
-    actions = actions.map do |action|
-      generate_action(klass, action, filelines)
-    end
-
-    {
-      :path => path,
-      :klass => klass.to_s,
-      :actions => actions,
-      :about => get_controller_about(filelines, klass.to_s)
-    }
-  end
-
-
-
-  # {name: 'xx', desc: 'yy', Params: [{level: 1, }]}
-  def generate_action(klass, action, filelines)
-    document = {:name => action.to_s}
-    method = klass.instance_method action
-    filepath, line = method.source_location
-    tmp = []; last_line = ""
-
-    (line - 2).downto(0) do |i|
-      line = filelines[i]
-      
-      unless line =~ /^\s*(\#.*?\n)?$/
-        document[:desc] = last_line
-        document.delete last_line
-        break
-      end
-
-      line.gsub!(/\s*\#/, '')
-      next if line =~ /^\s*$/
-
-      format_line(line, tmp, document)
-
-      last_line = line
-    end
-
-    Hash[document.merge(get_routes(klass, action)).to_a.reverse]
-  end
-
-
-
-  def get_routes(klass, action)
-    controller = klass.to_s.gsub(/Controller$/, '').underscore
-
-    
-    Rails.application.routes.named_routes.routes.each do |name, journey|
-      defaults = journey.defaults
-
-      if defaults[:controller] == controller && defaults[:action] == action
-        req_m = journey.verb.to_s.match(/\^(?<req_method>\w+)\$/)
-        return {
-          :path => journey.path.spec.to_s.gsub(/\(\.\:format\)$/, ''),
-          :method => req_m ? req_m[:req_method] : 'POST | GET'
-        }
-      end
-    end
-
-    {
-      :path => "",
-      :method => ""
-    }
-  end
-
-
-  def format_line(line, tmp, document)
-    m = line.match(/(?<level>\s*)(?<desc>(?<key>.*?)(\:(?<val>.*?))?)$/)
-    level = m[:level].length / 2
-    desc = m[:desc].gsub(/^\s*|\s*$/, '')
-    line.gsub!(/^\s*|\:?\s*$/, '')
-
-    if level == 0
-      if tmp.length == 0 && m[:val] && m[:val].length > 0
-        document[m[:key]] = m[:val]
-      else
-        document[m[:key] + (m[:val] || '')] = tmp.reverse.each_with_object([]) do |p, result|
-          if p[:level] >= 2 && result.last
-            result.last[:children] ||= []
-            result.last[:children] << p
-          else
-            result << p
-          end
-        end
-      end
-      tmp.clear
-    else
-      m = desc.match(/(?<name>\w+)\:?\s*((\[(?<type>.*?)\]\s*)?(?<val>.*))?$/)
-      p = {:level => level, :desc => desc}
-
-      p.merge!({
-        :name => m[:name],
-        :type => m[:type],
-        :val => m[:val]
-      }) if m
-
-      tmp << p
-    end
-  end
-
-
-
-  def get_controller_about(filelines, class_name)
-    pre_line = ''
-
-    filelines.each do |line|
-      break if line =~ /class\s#{Regexp.escape(class_name)}/
-      pre_line = line
-    end
-
-    pre_line.gsub(/^\s*#\s*/, '')
-  end
-
-
-end; end
+module ApiDocGeneration
+  ROOT_PATH = File.expand_path('../../', __FILE__)
+end

data/lib/rake/tasks/api_doc.rake

@@ -6,23 +6,27 @@ namespace :doc do
     out_format = ENV['OUT_FORMAT'] || 'detailed_html'
     codes_path = ENV['CODES_PATH'] || File.expand_path('app/controllers/api', Rails.root)
     level = ENV['LEVEL'] ? ENV['LEVEL'].split(',') : nil
+    title = ENV['TITLE']
 
-    puts out_format
+    puts "Template: #{out_format}"
+    generation = ApiDocGeneration::Generation.new(codes_path, title)
+
+    puts generation.controller_documents if ENV['SHOW_DOCS']
     
     case out_format
     when 'simple_html'
-      File.open("./tmp/api_doc.html", "w+") do |f|
-        f.write(
-          ApiDocGeneration::Generation.new(codes_path)
-            .generate_html_string(:level => level)
-        )
+      path = "./tmp/api_doc.html"
+      puts "out_path: #{path}"
+
+      File.open(path, "w+") do |f|
+        f.write(generation.generate_html_string(:level => level))
       end
     when 'detailed_html'
-      File.open("./tmp/api_detailed_doc.html", 'w+') do |f|
-        f.write(
-          ApiDocGeneration::Generation.new(codes_path)
-            .generate_detailed_html_string(:level => level)
-        )
+      path = "./tmp/api_doc.html"
+      puts "Out path: #{path}"
+
+      File.open(path, 'w+') do |f|
+        f.write(generation.generate_detailed_html_string(:level => level))
       end
     else
       puts "undefined OUT_FORMAT: '#{out_format}'"

data/templates/_controller.html.erb

@@ -0,0 +1,71 @@
+<% @documents.each do |controller| %>
+  <div class='controller' id='<%= controller_identifer(controller['Klass']) %>'>
+    <h2 class='controller-title'><%= controller['About']['Desc'] %></h2>
+
+    <div class='action'>
+      <% controller['About'].each do |key, val| %>
+        <% next if %w{Desc}.include?(key.to_s) %>
+
+        <h4><%= key %></h4>
+        <% unless val && (val.is_a?(Array) && val.length > 1) %>
+          <p>
+            <% if val.is_a?(Array) %>
+              <%= val.first.try('fetch', 'desc') %>
+            <% else %>
+              <%= val %>
+            <% end %>
+          </p>
+        <% else %>
+          <%= render 'params_table', :params => controller['About'][key] %>
+        <% end %>
+      <% end %>
+    </div>
+    <hr />
+
+    <% controller['Actions'].each_with_index do |action, i| %>
+      <% next if @level && !@level.include?(action['Level'].strip) %>
+
+      <div class='action action-<%= i % 2 == 0 ? 'even' : 'odd' %>'
+          id='<%= action_identifer(controller['Klass'], action['Name']) %>'>
+
+        <h4>功能说明</h4>
+        <p class='about text-info'><%= action['Desc'] %></p>
+
+        <h4>请求地址</h4>
+        <p class='about text-info'><%= action['Path'] %></p>
+
+        <h4>请求方法</h4>
+        <p class='about text-info'><%= action['Method'] %></p>
+
+        <h4>参数说明</h4>
+        <%= render 'params_table', :params => action['Params'] || [], :type => 'params' %>
+
+        <h4>正常返回信息</h4>
+        <p class='about text-info'>正常完成时response.status 为 200.</p>
+        <%= render 'params_table', :params => action['Return'] || [], :type => 'return' %>
+
+        <h4>出错误时信息</h4>
+        <p class='about text-info'>出错时response.status 为 400.</p>
+        <%= render 'params_table', :params => action['Error'] || [], :type => 'error' %>
+
+        <% action.each do |key, val| %>
+          <% next if %w{Desc Path Method Params Return Error Name}.include?(key.to_s) %>
+          <h4><%= key %></h4>
+          <% unless val && (val.is_a?(Array) && val.length > 1) %>
+            <p>
+              <% if val.is_a?(Array) %>
+                <%= val.first.try('fetch', 'desc') %>
+              <% else %>
+                <%= val %>
+              <% end %>
+            </p>
+          <% else %>
+            <%= render 'params_table', :params => action[key] %>
+          <% end %>
+        <% end %>
+        <br /><hr />
+      </div>
+    <% end %>
+
+  </div>
+<% end %>

data/templates/_menu.html.erb

@@ -0,0 +1,29 @@
+<div class='list'>
+  <strong class='no_print no_opacity about'>* 被勾选的内容将被打印</strong>
+
+  <ul>
+    <% @documents.each do |controller| %>
+      <li>
+        <input type='checkbox' class='no_print no_opacity print_selector' checked=1 />
+        <a href='#<%= controller_identifer(controller['Klass']) %>'>
+          <%= controller['About']['Desc'] %>
+        </a>
+
+        <ul class='ul-controller'>
+          <% controller['Actions'].each do |action| %>
+            <% next if @level && !@level.include?(action['Level'].strip) %>
+
+            <li>
+              <input type='checkbox' class='no_print no_opacity print_selector' checked=1 />
+              <a href='#<%= action_identifer(controller['Klass'], action['Name']) %>'>
+                <%= action['Desc'] %>
+              </a>
+            </li>
+          <% end %>
+        </ul>
+
+      </li>
+    <% end %>
+  </ul>
+</div>
+    

data/templates/_params_table.html.erb

@@ -0,0 +1,53 @@
+
+<table class='table table-bordered table-striped'>
+  <thead>
+    <th>参数名</th>
+    <th>参数类型</th>
+    <th>描述</th>
+  </thead>
+
+  <tbody>
+    <% unless @params.nil? || @params.length == 0 %>
+      <% @params.each do |param| %>
+        <% if @type == 'params' %>
+          <% format_param(param) %>
+        <% elsif @type == 'return' || @type == 'error' %>
+          <% format_response_param(param); %>
+        <% else %>
+          <% format_other_param(param) %>
+        <% end %>
+
+        <tr>
+          <% ['name', 'type'].each do |key| %>
+            <td><%= param[key] %></td>
+          <% end %>
+
+          <td>
+            <%= param['val'] %>
+
+            <% if param['children'] %>
+              <% param['children'].each do |cp| %>
+                <p style='padding-left: <%= (cp['level'] - 1) * 20 %>px'>
+                  <%= cp['desc'] %>
+                </p>
+              <% end %>
+            <% end %>
+          </td>
+
+        </tr>
+      <% end %>
+    <% else %>
+      <tr>
+        <td>error</td>
+        <td>String</td>
+        <td>错误标识</td>
+      </tr>
+
+      <tr>
+        <td>error_description</td>
+        <td>String</td>
+        <td>错误具体描述</td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/templates/doc_detailed.html.erb

@@ -2,7 +2,7 @@
   <head>
     <meta http-equiv="content-type" content="text/html;charset=utf-8">
 
-    <title>Uasthree Api Documents</title>
+    <title><%= @title %></title>
 
     <link href='http://libs.baidu.com/bootstrap/2.3.2/css/bootstrap.css' rel='stylesheet'>
     <style type='text/css'>
@@ -73,182 +73,9 @@
   </head>
 
   <body>
-    <h1 class='title'>Uasthree Api Document</h1>
+    <h1 class='title'><%= @title %></h1>
+    <%= render 'menu' %>
 
-    <div class='list'>
-      <strong class='no_print no_opacity about'>* 被勾选的内容将被打印</strong>
-
-      <ul>
-        <% @documents.each do |controller| %>
-          <li>
-            <input type='checkbox' class='no_print no_opacity print_selector' checked=1 />
-            <a href='#<%= controller_identifer(controller[:klass]) %>'><%= controller[:about] %></a>
-
-            <ul class='ul-controller'>
-              <% controller[:actions].each do |action| %>
-                <% next if @level && !@level.include?(action['Level'].strip) %>
-
-                <li>
-                  <input type='checkbox' class='no_print no_opacity print_selector' checked=1 />
-                  <a href='#<%= action_identifer(controller[:klass], action[:name]) %>'>
-                    <%= action[:desc] %>
-                  </a>
-                </li>
-              <% end %>
-            </ul>
-
-          </li>
-        <% end %>
-      </ul>
-    </div>
-
-    <% @documents.each do |controller| %>
-      <div class='controller' id='<%= controller_identifer(controller[:klass]) %>'>
-        <h2 class='controller-title'><%= controller[:about] %></h2>
-        
-        <% controller[:actions].each_with_index do |action, i| %>
-          <% next if @level && !@level.include?(action['Level'].strip) %>
-
-          <div class='action action-<%= i % 2 == 0 ? 'even' : 'odd' %>'
-              id='<%= action_identifer(controller[:klass], action[:name]) %>'>
-
-            <h4>功能说明</h4>
-            <p class='about text-info'><%= action[:desc] %></p>
-
-            <h4>请求地址</h4>
-            <p class='about text-info'><%= action[:path] %></p>
-
-            <h4>请求方法</h4>
-            <p class='about text-info'><%= action[:method] %></p>
-
-            <h4>参数说明</h4>
-            <table class='table table-bordered table-striped'>
-              <thead>
-                <th>参数名</th>
-                <th>参数类型</th>
-                <th>描述</th>
-              </thead>
-
-              <tbody>
-                <% (action['Params'] || []).each do |param| %>
-                  <% format_param(param) %>
-
-                  <tr>
-                    <% [:name, :type].each do |key| %>
-                      <td><%= param[key] %></td>
-                    <% end %>
-
-                    <td>
-                      <%= param[:val] %>
-                      
-                      <% if param[:children] %>
-                        <% param[:children].each do |cp| %>
-                          <p style='padding-left: <%= (cp[:level] - 1) * 20 %>px'><%= cp[:desc] %></p>
-                        <% end %>
-                      <% end %>
-                    </td>
-                    
-                  </tr>
-                <% end %>
-              </tbody>
-            </table>
-
-            <h4>正常返回信息</h4>
-            <p class='about text-info'>正常完成时response.status 为 200.</p>
-            <table class='table table-bordered table-striped'>
-              <thead>
-                <th>参数名</th>
-                <th>参数类型</th>
-                <th>描述</th>
-              </thead>
-
-              <tbody>
-                <% (action['Return'] || []).each do |param| %>
-                  <% format_response_param(param) %>
-
-                  <tr>
-                    <% [:name, :type, :val].each do |key| %>
-                      <td><%= param[key] %></td>
-                    <% end %>
-                  </tr>
-                <% end %>
-              </tbody>
-            </table>
-
-            <h4>出错误时信息</h4>
-            <p class='about text-info'>出错时response.status 为 400.</p>
-            <table class='table table-bordered table-striped'>
-              <thead>
-                <th>参数名</th>
-                <th>参数类型</th>
-                <th>描述</th>
-              </thead>
-
-              <tbody>
-                <% if action['Error'] %>
-                  <% action['Error'].each do |param| %>
-                    <% format_response_param(param) %>
-
-                    <tr>
-                      <% [:name, :type, :val].each do |key| %>
-                        <td><%= param[key] %></td>
-                      <% end %>
-                    </tr>
-                  <% end %>
-                <% else %>
-                  <tr>
-                    <td>error</td>
-                    <td>String</td>
-                    <td>错误标识</td>
-                  </tr>
-
-                  <tr>
-                    <td>error_description</td>
-                    <td>String</td>
-                    <td>错误具体描述</td>
-                  </tr>
-                <% end %>
-              </tbody>
-            </table>
-
-            <% action.each do |key, val| %>
-              <% next if %w{desc path method Params Return Error name}.include?(key.to_s) %>
-              <h4><%= key %></h4>
-              <% unless val && (val.is_a?(Array) && val.length > 1) %>
-                <p>
-                  <% if val.is_a?(Array) %>
-                    <%= val.first[:desc] %>
-                  <% else %>
-                    <%= val %>
-                  <% end %>
-                </p>
-              <% else %>
-                <table class='table table-bordered table-striped'>
-                  <thead>
-                    <th>参数名</th>
-                    <th>参数类型</th>
-                    <th>描述</th>
-                  </thead>
-
-                  <tbody>
-                    <% (action[key] || []).each do |param| %>
-                      <% format_other_param(param) %>
-
-                      <tr>
-                        <% [:name, :type, :val].each do |key| %>
-                          <td><%= param[key] %></td>
-                        <% end %>
-                      </tr>
-                    <% end %>
-                  </tbody>
-                </table>
-              <% end %>
-            <% end %>
-            <br /><hr />
-          </div>
-        <% end %>
-
-      </div>
-    <% end %>
+    <%= render 'controller'%>
   </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_doc_generation
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.2.1
 platform: ruby
 authors:
 - jiangzhi.xie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,10 +52,16 @@ files:
 - Rakefile
 - api_doc_generation.gemspec
 - lib/api_doc_generation.rb
+- lib/api_doc_generation/format_file.rb
+- lib/api_doc_generation/format_note.rb
+- lib/api_doc_generation/generation.rb
 - lib/api_doc_generation/version.rb
 - lib/api_doc_generation/view_helper.rb
 - lib/rake/api_doc_generation.rb
 - lib/rake/tasks/api_doc.rake
+- templates/_controller.html.erb
+- templates/_menu.html.erb
+- templates/_params_table.html.erb
 - templates/doc.html.erb
 - templates/doc_detailed.html.erb
 homepage: ''