api_doc_generation 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a59367781747d4ca6e94511c8045e8d74321ca1
-  data.tar.gz: 4eb0b36c7174d662bf5d9e32b0ffcc8bd56be26c
+  metadata.gz: 8a872e53bc7f3cf10f4ab8a3eee37af883c06c4e
+  data.tar.gz: 57a8595fa489c5f3d4247c1e6df6c5d8b9312f57
 SHA512:
-  metadata.gz: 4c05f53ce3c4ea401131c8eff1ce55a80c9af707f59324efee5f99d5b4008659d7146ab5df2647a9be91c3351484eebecca557956bfc3106adb651986ec54688
-  data.tar.gz: 22b878cb56d46e98e571d02375d94970c35f6641fe7b78a24550cf8dfc76fd24b88a5f1407e1ea984a8883a10a8d6240199fdfa2808663fd66fbbbdba899bfe6
+  metadata.gz: 7a72d59cdedafec4bcad569ae07fd8de99eebcf7e2e027e10c6682c220036d34c9d7ed01bcf5dd790dc6a2c5c83688158987f0a981308b89dbcad23d1da77884
+  data.tar.gz: 36e1d8d4dd28af3fb6b7061bac1ae256fbc13034abec4c6e682869822862c06e0624f80add0fdb50d5ca23aa3de5c61957f23a86fbb1bf55465c5f659e9d1279

data/README.md

@@ -32,6 +32,7 @@ __代码注释格式:__
     # Return:
     #   count: [Integer] 数据总条数
     #   items: [Array] 当前页数据的数组
+    # Level: read
     def list
       # ...
     end
@@ -54,6 +55,16 @@ __代码注释格式:__
 上面已经给出了api说明，参数，返回，错误信息,而api地址和请求方法将会自动从Rails中查找出来
 
 
+## Level
+  * 默认level显示所有
+  * 输出时只会显示指定level的api
+  * 所有的level为:
+    ```read search update create delete```
+  * 使用：
+    ``` rake doc:api LEVEL=read,search```
+
+
+
 ## Contributing
 
 1. Fork it

data/lib/api_doc_generation/version.rb

@@ -1,3 +1,3 @@
 module ApiDocGeneration
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/api_doc_generation.rb

@@ -24,25 +24,25 @@ module ApiDocGeneration; class Generation
   end
 
 
-  def generate_html_string
+  def generate_html_string(opts = {})
     template = ERB.new(
       File.read(File.expand_path('../../templates/doc.html.erb', __FILE__))
     )
 
-    ViewHelper.render(template, {
+    ViewHelper.render(template, opts.merge({
       :documents => @controller_documents
-    })
+    }))
   end
 
 
-  def generate_detailed_html_string
+  def generate_detailed_html_string(opts = {})
     template = ERB.new(
       File.read(File.expand_path('../../templates/doc_detailed.html.erb', __FILE__))
     )
 
-    ViewHelper.render(template, {
+    ViewHelper.render(template, opts.merge({
       :documents => @controller_documents
-    })
+    }))
   end
 
 

data/lib/rake/tasks/api_doc.rake

@@ -5,17 +5,24 @@ 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
 
     puts out_format
     
     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)
+        f.write(
+          ApiDocGeneration::Generation.new(codes_path)
+            .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)
+        f.write(
+          ApiDocGeneration::Generation.new(codes_path)
+            .generate_detailed_html_string(:level => level)
+        )
       end
     else
       puts "undefined OUT_FORMAT: '#{out_format}'"

data/templates/doc_detailed.html.erb

@@ -86,6 +86,8 @@
 
             <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]) %>'>
@@ -105,6 +107,8 @@
         <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]) %>'>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_doc_generation
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - jiangzhi.xie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler