api_doc_generation 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3c631601be29797aa6e14707a92b515fa6b68be
-  data.tar.gz: 942cee388e1db6bfd6cd96672e2e7c51a5b9db2c
+  metadata.gz: 81d519ebc01140cc7b74d66069a3b6eb3f8a07c7
+  data.tar.gz: 47b6f328b09fc166044e4236ee927890d8527691
 SHA512:
-  metadata.gz: c12bf362dc163eb5f8c3befc5dca58a17494ae0ff5928520f23698d07feec8f759fb6ee4124aa406c24e729009bb6ef3ba7a3f6713131d05206de5b922f944f8
-  data.tar.gz: 83f02c76a07a1f33291cdfd9e4d391d36c9d2b60b8a2f1053de8f71c769dc3b05deb2cf8c7c542a55eea62d220a8b81793c45fdd1244b441260482a73a148384
+  metadata.gz: 06f370284d952468cf80dd44eeb0854264310913aacc96a7a9b80dd7d3dd755331252fe83906968320ce34662743a38b669704064fa9f5ce9f0dcfbbc0d6f800
+  data.tar.gz: ea5d24152928832e48c56e6406cb89b70928b30e94247afe10c5a2c4cac9a005b1271d8878953b99b951b606adf065c812c2525c92eecc2c933aef7d28341a20

data/README.md

@@ -72,6 +72,31 @@ __代码注释格式:__
 
 上面已经给出了api说明，参数，返回，错误信息,而api地址和请求方法将会自动从Rails中查找出来
 
+__总的来说，注释格式有三种__
+
+1.
+```
+# 层级1: 说明
+```
+
+2.
+```
+# 层级1:
+#   层级2: 说明
+#   层级2: 说明
+```
+
+3.
+```
+# 层级1:
+#   层级2: 说明
+#     层级3
+#       更多的层级，这些层级只会显示在层级2中，等于就是层级2的说明
+#   字段2: 说明
+```
+
+
+上面的格式可以任意组合，要注意的是，解析时层级是按 （空格 / 2）来计算的
 
 ## Level
   * 默认level显示所有

data/lib/api_doc_generation/format_file.rb

@@ -12,13 +12,20 @@ module ApiDocGeneration; module FormatFile; class << self
     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
 
+    actions.delete_if do |val|
+      val['Return'].nil?
+    end
+    
+
     {
       'Path' => path,
       'Klass' => klass.to_s,
@@ -33,7 +40,7 @@ module ApiDocGeneration; module FormatFile; class << self
   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/ }
@@ -71,7 +78,7 @@ module ApiDocGeneration; module FormatFile; class << self
     require 'rails/application/route_inspector'
     inspector = Rails::Application::RouteInspector.new
 
-    inspector.collect_routes(all_routes) + 
-      inspector.instance_variable_get(:@engines).flatten
+    inspector.collect_routes(all_routes) +
+      inspector.instance_variable_get(:@engines).values.flatten
   end
 end; end; end

data/lib/api_doc_generation/generation.rb

@@ -43,8 +43,8 @@ module ApiDocGeneration; class Generation
 
   # 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|
+    paths = codes_path.end_with?('.rb') ? [codes_path] : Dir[codes_path + '/**/*.rb']
+    paths.each do |path|
       next if path =~ /base_controller.*\.rb$/
       block.call path
     end

data/lib/api_doc_generation/version.rb

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

data/lib/api_doc_generation/view_helper.rb

@@ -31,7 +31,9 @@ module ApiDocGeneration; class ViewHelper
   ################## View Helper ###################
 
   def render(path, opts = {})
-    file_path = File.expand_path("templates/_#{path}.html.erb", ROOT_PATH)
+    path = "templates/_#{path}.*.erb"
+    file_path = Dir[File.expand_path(path, ROOT_PATH)].first
+    raise "no found file '#{path}'" unless file_path
 
     template = ERB.new(File.read(file_path))
 

data/templates/_javascript.js.erb

@@ -0,0 +1,58 @@
+$(function(){
+  var no_print_class = 'no_print';
+  var iframe = $('.helper_iframe')[0];
+  var idoc = iframe.contentDocument;
+
+
+  // 设置勾选内容的打印及显示
+  // 添加或移除no_print类
+  $('.print_selector').change(function(event){
+    var $this = $(this);
+    var $a = $this.next();
+    var $top = $a.parent();
+    var $target_el = $($a.attr('href'));
+
+    if ($this.is(":checked")) {
+      $top.removeClass(no_print_class)
+      $target_el.removeClass(no_print_class);
+    } else {
+      $top.addClass(no_print_class)
+      $target_el.addClass(no_print_class);
+    }
+  });
+
+  
+  // 下载保存勾选的内容
+  $("a.save_to_file").click(function(event){
+    var head = document.head.innerHTML;
+    idoc.body.innerHTML = document.body.innerHTML;
+
+    $(idoc.body).find("." + no_print_class).remove();
+
+    var html = '<html><head>';
+    html += head + '</head><body>';
+    html += idoc.body.innerHTML + '</body></html>';
+
+    window.open('data:application/octet-stream;charset=utf-8,' + encodeURIComponent(html));
+    return false;
+  });
+
+
+  // 合并文档
+  $("#merge_doc").change(function(event){
+    var fr = new FileReader();
+
+    fr.onloadend = function(e){
+      var $body = $(document.body);
+      idoc.write(this.result);
+
+      var menus = $(idoc.body).find(".list>ul>li");
+      var controllers = $(idoc.body).find(".controller");
+
+      $body.find(".list>ul").append(menus);
+      $body.append(controllers);
+    }
+
+    fr.readAsText(this.files[0]);
+  });
+});

data/templates/_menu.html.erb

@@ -1,5 +1,14 @@
 <div class='list'>
-  <strong class='no_print no_opacity about'>* 被勾选的内容将被打印</strong>
+  <strong class='no_print no_opacity about'>* 被勾选的内容才会被打印、保存</strong>
+
+  <div class='helpers'>
+    <label for='merge_doc' class='btn no_print no_opacity'>合并文档...</label>
+    <input type='file' id='merge_doc' style='display:none'/>
+
+    <a href='#' class='no_print no_opacity btn save_to_file'>保存到新文件</a>
+
+    <iframe class='helper_iframe' style='display:none'></iframe>
+  </div>
 
   <ul>
     <% @documents.each do |controller| %>

data/templates/_style.css.erb

@@ -0,0 +1,45 @@
+.title {
+  text-align: center;
+  color: blank;
+}
+
+.controller, .list {
+  width: 900px;
+  border: 1px solid;
+  margin: 20px auto 40 auto;
+}
+
+.list {
+  padding-top: 20px;
+}
+
+.list .helpers {
+  padding: 20px;
+}
+
+.controller-title {
+  text-align: center;
+}
+
+.action {
+  margin-top: 40px;
+  padding: 20px 40px 20px 20px;
+}
+
+.about {
+  padding-left: 20px;
+}
+
+.no_print {
+  opacity: 0.4;
+}
+
+.no_opacity {
+  opacity: 1;
+}
+
+@media print {
+  .no_print {
+    display: none;
+  }
+}

data/templates/doc_detailed.html.erb

@@ -5,71 +5,10 @@
     <title><%= @title %></title>
 
     <link href='http://libs.baidu.com/bootstrap/2.3.2/css/bootstrap.css' rel='stylesheet'>
-    <style type='text/css'>
-      .title {
-        text-align: center;
-        color: blank;
-      }
-
-      .controller, .list {
-        width: 900px;
-        border: 1px solid;
-        margin: 20px auto 40 auto;
-      }
-
-      .list {
-        padding-top: 20px;
-      }
-
-      .controller-title {
-        text-align: center;
-      }
-
-      .action {
-        margin-top: 40px;
-        padding: 20px 40px 20px 20px;
-      }
-
-      .about {
-        padding-left: 20px;
-      }
-
-      .no_print {
-        opacity: 0.4;
-      }
-
-      .no_opacity {
-        opacity: 1;
-      }
-
-      @media print {
-        .no_print {
-          display: none;
-        }
-      }
-    </style>
+    <style type='text/css'><%= render 'style' %></style>
 
     <script type='text/javascript' src='http://code.jquery.com/jquery-2.0.3.min.js'></script>
-    <script type='text/javascript'>
-      $(function(){
-        var no_print_class = 'no_print';
-
-        $('.print_selector').change(function(event){
-          var $this = $(this);
-          var $a = $this.next();
-          var $top = $a.parent();
-          var $target_el = $($a.attr('href'));
-
-          if ($this.is(":checked")) {
-            $top.removeClass(no_print_class)
-            $target_el.removeClass(no_print_class);
-          } else {
-            $top.addClass(no_print_class)
-            $target_el.addClass(no_print_class);
-          }
-        });
-      });
-    </script>
+    <script type='text/javascript'><%= render 'javascript' %></script>
   </head>
 
   <body>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_doc_generation
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - jiangzhi.xie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,8 +60,10 @@ files:
 - lib/rake/api_doc_generation.rb
 - lib/rake/tasks/api_doc.rake
 - templates/_controller.html.erb
+- templates/_javascript.js.erb
 - templates/_menu.html.erb
 - templates/_params_table.html.erb
+- templates/_style.css.erb
 - templates/doc.html.erb
 - templates/doc_detailed.html.erb
 homepage: ''