rapi_doc 0.2.2 → 0.3.1

data/README.md

@@ -13,7 +13,7 @@ Installation
 Usage
 =====
 
-Run `rake rapi_doc` to generate config and layout files. (TODO: Add a separate rake task to generate config files)
+Run `rake rapi_doc:setup` to generate config and layout files.
 
 Modify config file by adding your controllers, e.g.:
 
@@ -23,7 +23,7 @@ Modify config file by adding your controllers, e.g.:
 
 Then invoke the generation by calling:
 
-`rake rapi_doc`
+`rake rapi_doc:generate`
 
 Documentation Example
 ---------------------

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.1

data/lib/doc_parser.rb

@@ -10,9 +10,9 @@ module RapiDoc
       @in_class = false
     end
 
-    def start
+    def start(order)
       @current_scope = !in_class ? :class : :function
-      @current_api_block = MethodDoc.new(current_scope)
+      @current_api_block = MethodDoc.new(current_scope, order)
     end
 
     def reset_current_scope_and_api_block

data/lib/method_doc.rb

@@ -1,10 +1,11 @@
 module RapiDoc
   # This class holds methods about a doc.
   class MethodDoc
-    attr_accessor :scope, :content, :request, :response, :code, :outputs, :variables
+    attr_accessor :scope, :content, :request, :response, :code, :outputs, :variables, :method_order
     
-    def initialize(type)
+    def initialize(type, order)
       @scope = type
+      @method_order = order
       @variables = []
       @outputs = []
       @content = ""

data/lib/rapi_config.rb

@@ -18,6 +18,18 @@ module RapiDoc
       File.join(find_location(location), 'layout.html.erb')
     end
 
+    def class_layout_file(location)
+      File.join(find_location(location), 'class_layout.html.erb')
+    end
+
+    def frameset_file(location)
+      File.join(find_location(location), 'frameset.html.erb')
+    end
+
+    def main_file(location)
+      File.join(find_location(location), 'main.html.erb')
+    end
+
     def find_location(location)
       location == :target ? config_dir : template_dir
     end

data/lib/rapi_doc.rb

@@ -34,16 +34,20 @@ module RapiDoc
     # generate the index file for the api views
     def generate_index!
       template = ""
-      @page_type = 'index'
-      File.open(layout_file(:target)).each { |line| template << line }
+      @page_type2 = 'dudul'
+      File.open(class_layout_file(:target)).each { |line| template << line }
       parsed = ERB.new(template).result(binding)
-      File.open(File.join(temp_dir, "index.html"), 'w') { |file| file.write parsed }
+      File.open(File.join(temp_dir, "class.html"), 'w') { |file| file.write parsed }
     end
 
     def move_structure!
       target_folder = "#{::Rails.root.to_s}/public/apidoc/"
       Dir.mkdir(target_folder) if (!File.directory?(target_folder))
 
+      # Copy the frameset & main files
+      FileUtils.cp frameset_file(:target), target_folder + 'index.html'
+      FileUtils.cp main_file(:target), target_folder + 'main.html'
+
       Dir.new(temp_dir).each do |d|
         if d =~ /^[a-zA-Z]+\.(html|css)$/ # Only want to copy over the .html files, not the .erb templates
           FileUtils.cp  File.join(temp_dir + d), target_folder + d

data/lib/rapi_doc/tasks/rapi_doc_tasks.rake

@@ -8,7 +8,7 @@ namespace :rapi_doc do
     else
       FileUtils.mkdir(config_dir)
     end
-    %w(config_file layout_file).each do |type_file|
+    %w(config_file layout_file class_layout_file frameset_file main_file).each do |type_file|
       target_file = send(type_file, :target)
       template_file = send(type_file, :template)
       if File.exist? target_file

data/lib/resource_doc.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'method_doc'
 require 'doc_parser'
 
@@ -8,7 +9,7 @@ module RapiDoc
     
     attr_reader :name, :resource_location, :controller_name, :function_blocks, :class_block
     
-    # Initializes RAPIDoc.
+    # Initializes ResourceDoc.
     def initialize(name, resource_location, controller_name, options = {})
       @name = name
       @standard_methods = options[:standard_methods] || [:put, :post, :get, :delete]
@@ -37,10 +38,11 @@ module RapiDoc
       line_no = 0
       
       parser = DocParser.new
+      order = 1
       File.open(controller_location).each do |line|
         case
         when line =~ /=begin apidoc/
-          parser.start
+          parser.start(order)
         when line =~ /=end/
           if parser.current_api_block.nil?
             puts "#{controller_location}:#{line_no} - No starttag for '=end' found"
@@ -53,6 +55,7 @@ module RapiDoc
               @function_blocks << parser.current_api_block
             end
             parser.reset_current_scope_and_api_block
+            order += 1
           end
         when line =~ /class/
           parser.in_class = true
@@ -71,8 +74,10 @@ module RapiDoc
     def generate_view!(resources, temp_dir)
        @resources = resources
        @header_code = get_parsed_header unless @class_block.nil?
+       i = 1
        function_blocks.each do |mb|
-         @method_codes << get_parsed_method(mb)
+         @method_codes << get_parsed_method(mb, i)
+         i += 1
        end
        # write it to a file
        template = ""
@@ -87,7 +92,7 @@ module RapiDoc
       ERB.new(template).result(@class_block.get_binding)
     end
 
-    def get_parsed_method(method_block)
+    def get_parsed_method(method_block, method_order)
       template = ""
       File.open(File.join(File.dirname(__FILE__), '..', 'templates', '_resource_method.html.erb')).each { |line| template << line }
       return ERB.new(template).result(method_block.get_binding)

data/templates/_resource_method.html.erb

@@ -1,4 +1,4 @@
-<div id="method">
+<div id="method_<%=@method_order%>">
   
   <%
     splitted = @method
@@ -29,13 +29,13 @@
   <% unless @outputs.empty? %>
     <ul class="tabs">
       <% @outputs.each do |output| %>
-        <li class="<%= (output == @outputs.first)? 'active' : '' %>"><a href="#<%= output.keys.first %>"><%= output.keys.first %></a></li>
+        <li class="<%= (output == @outputs.first)? 'active' : '' %>"><a href='#<%= "#{output.keys.first}_#{@method_order}" %>'><%= output.keys.first %></a></li>
       <% end %>
     </ul>
     <div class="pill-content">
       <% @outputs.each do |output| %>
         <% output_format = output.keys.first %>
-        <div class="<%= (output == @outputs.first)? 'active' : '' %>" id="<%= output_format %>">
+        <div class="<%= (output == @outputs.first)? 'active' : '' %>" id='<%= "#{output.keys.first}_#{@method_order}" %>'>
           <pre class="prettyprint" ><%= output[output_format] %></pre>
         </div>
       <% end %>

data/templates/class_layout.html.erb

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title><%= @name || 'Home' %></title>
+    <base id="base_target"></base>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames'
+      }
+    </script>
+    <div class="content">
+      <h2>Resources</h2>
+      <div id="resources_<%=@page_type2%>">
+        <ul>
+        <% @resources.each do |r| %>
+          <li>
+            Resource:  <a href="/apidoc/<%=r.name %>.html"><%=r.resource_location %></a>
+            <% if r.function_blocks.any? %>
+              <ul>
+                <% r.function_blocks.each do |method_block| %>
+                  <li><a href="/apidoc/<%=r.name %>.html#method_<%=method_block.method_order%>"><%= method_block.url %></a></li>
+                <% end %>
+              </ul>
+            <% end %>
+          </li>
+        <% end %>
+        </ul>
+      </div>
+    
+    </div>
+  </body>
+</html>

data/templates/frameset.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>Home</title>
+  </head>
+  <frameset cols="20%,*">
+    <frame name="list" src="/apidoc/class.html"></frame>
+    <frame name="main" src="/apidoc/main.html"></frame>
+  </frameset>
+</html>

data/templates/layout.html.erb

@@ -51,36 +51,19 @@
   </head>
   <body>
     <div class="content">
+      <div id="navigation">
+        <ul class="main">
+          <li><a href="/apidoc/main.html">&laquo; Back to index</a></li>
+        </ul>
+      </div>
 
-      <% if @page_type == 'index' %>
-        <div id="introduction">
-          <!-- documentation intro -->
-        </div>
+      <hr />
 
-        <h2>Resources</h2>
-        <div id="resources">
-          <ul>
-          <% @resources.each do |r| %>
-            <li>Resource:  <a href="/apidoc/<%=r.name %>.html"><%=r.resource_location %></a></li>
-          <% end %>
-          </ul>
-        </div>
-      <% else %>
-        <div id="navigation">
-          <ul class="main">
-            <li><a href="/apidoc/index.html">&laquo; Back to index</a></li>
-          </ul>
-        </div>
+      <%=@header_code %>
 
-        <hr />
-
-        <%=@header_code %>
-
-        <% @method_codes.each do |mc| %>
-          <%=mc %>
-        <% end %>
+      <% @method_codes.each do |mc| %>
+        <%=mc %>
       <% end %>
-
     </div>
   </body>
 </html>

data/templates/main.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  </head>
+  <body>
+    <div class="content">
+      <h1>API Doc</h1>
+      <div>
+        
+      </div>
+    
+    </div>
+  </body>
+</html>

metadata

@@ -1,83 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rapi_doc
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.1
   prerelease: 
-  version: 0.2.2
 platform: ruby
-authors: 
+authors:
 - Husein Choroomi
 - Adinda Praditya
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-09 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70302725893440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "2.1"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70302725893440
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70302725892500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70302725892500
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70302725891540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70302725891540
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70302725890700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70302725890700
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70302725889940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *70302725889940
 description: Rails API Doc Generator
 email: hchoroomi@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
+files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
@@ -100,38 +97,38 @@ files:
 - spec/spec_helper.rb
 - templates/_resource_header.html.erb
 - templates/_resource_method.html.erb
+- templates/class_layout.html.erb
 - templates/config.yml
+- templates/frameset.html.erb
 - templates/layout.html.erb
+- templates/main.html.erb
 - uninstall.rb
 homepage: http://github.com/elc/rapi_doc
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -1093643544274794326
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4532277263417640116
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Rails API Doc Generator
 test_files: []
-