rapi_doc 0.1.1 → 0.1.2

data/README.md

@@ -0,0 +1,55 @@
+Rails API Doc Generator
+=======================
+
+RESTTful API generator...
+
+It generates a set of HTML views in the public directory. Parses the desired controllers and generates appropriate views.
+
+Currently does not read routes.rb and requires manual entry of routes
+
+Installation
+============
+
+`gem install rapi_doc`
+
+Usage
+=====
+
+Run `rake rapi_doc` to generate config and layout files. (TODO: Add a separate rake task to generate config files)
+
+Modify config file by adding your controllers, e.g.:
+
+`
+users:
+  location: "/users"
+  controller_name: "users_controller.rb"
+`
+
+Then invoke the generation by calling:
+
+`rake rapi_doc`
+
+Documentation Example
+---------------------
+
+    =begin apidoc
+    url:: /users
+    method:: GET
+    access:: FREE
+    return:: [JSON|XML] - list of user objects
+    param:: page:int - the page, default is 1
+    param:: per_page:int - max items per page, default is 10
+    
+    Get a list of all users in the system with pagination.  Defaults to 10 per page
+    =end
+    
+Layout
+------
+
+Documentation layout is located at `config/rapi_doc/layout.html.erb`.
+
+Credit
+======
+
+* Based on RAPI Doc by Jaap van der Meer found here: http://code.google.com/p/rapidoc/
+* https://github.com/sabman/rapi_doc

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/rapi_config.rb

@@ -12,12 +12,8 @@ module RapiDoc
       File.join(find_location(location), 'config.yml')
     end
 
-    def index_layout_file(location)
-      File.join(find_location(location), 'index.html.erb')
-    end
-
-    def resource_layout_file(location)
-      File.join(find_location(location), 'resource.html.erb')
+    def layout_file(location)
+      File.join(find_location(location), 'layout.html.erb')
     end
 
     def find_location(location)

data/lib/rapi_doc/tasks/rapi_doc_tasks.rake

@@ -6,7 +6,7 @@ task :rapi_doc do
     yml = YAML::load(File.open(config_file(:target)))
   rescue
     FileUtils.mkdir(config_dir) if (!File.directory?(config_dir))
-    [config_file(:template), index_layout_file(:template), resource_layout_file(:template)].each do |_file|
+    [config_file(:template), layout_file(:template)].each do |_file|
       FileUtils.cp _file, config_dir
       puts "Generated config/rapi_doc/#{File.basename(_file)}" # TODO Add instructions for users to update the config file
     end
@@ -16,11 +16,11 @@ task :rapi_doc do
   if yml
     resources = []
     yml.keys.each do |key|
-      resources << ResourceDoc.new(key, yml[key]["location"], yml[key]["controller_name"])
+      resources << RapiDoc::ResourceDoc.new(key, yml[key]["location"], yml[key]["controller_name"])
     end
 
     # generate the apidoc
-    RAPIDoc.new(resources)
+    RapiDoc::RAPIDoc.new(resources)
   end
 end
 

data/lib/rapi_doc.rb

@@ -34,7 +34,8 @@ module RapiDoc
     # generate the index file for the api views
     def generate_index!
       template = ""
-      File.open(index_layout_file(:target)).each { |line| template << line }
+      @page_type = 'index'
+      File.open(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 }
     end
@@ -68,4 +69,4 @@ module RapiDoc
       @temp_dir ||= "#{Dir.mktmpdir("apidoc")}/"
     end
   end
-end
+end

data/lib/resource_doc.rb

@@ -97,30 +97,21 @@ module RapiDoc
        end
        # write it to a file
        template = ""
-       File.open(resource_layout_file(:target)).each { |line| template << line }
+       File.open(layout_file(:target)).each { |line| template << line }
        parsed = ERB.new(template).result(binding)
        File.open(File.join(temp_dir, name + ".html"), 'w') { |file| file.write parsed }
     end
 
-
     def get_parsed_header
       template = ""
       File.open(File.join(File.dirname(__FILE__), '..', 'templates', '_resource_header.html.erb')).each { |line| template << line }
-
-      puts "-"*30
-      puts ">>> inside: get_parsed_header"
-      puts ERB.new(template).result(@class_block.get_binding)
-      puts "-"*30; puts ""
-
-      return ERB.new(template).result(@class_block.get_binding)
+      ERB.new(template).result(@class_block.get_binding)
     end
 
-
     def get_parsed_method(method_block)
       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)
     end
-      
   end
-end
+end

data/templates/_resource_method.html.erb

@@ -26,6 +26,14 @@
     </ul>
   <% end %>
 
+  <% if @output %>
+      <strong>Output:</strong>
+      <div class="code">
+        <%= @output %>
+      </div>
+      <br />
+  <% end %>
+
   <% unless @request.blank? %>
     <strong>Request:</strong>
     <pre class="code"><code><%= @request %></code></pre>

data/templates/{index.html.erb → layout.html.erb}

@@ -43,24 +43,43 @@
         font-size: 1.4em;
         color:#262626;
       }
+      .code {
+          font-family: monospace;
+      }
     </style>
 
   </head>
   <body>
     <div class="content">
 
-      <div id="introduction">
-        <!-- documentation intro -->
-      </div>
+      <% if @page_type == 'index' %>
+        <div id="introduction">
+          <!-- documentation intro -->
+        </div>
+
+        <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>
+
+        <hr />
+
+        <%=@header_code %>
 
-      <h2>Resources</h2>
-      <div id="resources">
-        <ul>
-        <% @resources.each do |r| %>
-          <li>Resource:  <a href="/apidoc/<%=r.name %>.html"><%=r.resource_location %></a></li>
+        <% @method_codes.each do |mc| %>
+          <%=mc %>
         <% end %>
-        </ul>
-      </div>
+      <% end %>
 
     </div>
   </body>

metadata

@@ -2,7 +2,7 @@
 name: rapi_doc
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Husein Choroomi
@@ -64,13 +64,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README
+- README.md
 files: 
 - .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README
+- README.md
 - Rakefile
 - VERSION
 - init.rb
@@ -85,8 +85,7 @@ files:
 - templates/_resource_header.html.erb
 - templates/_resource_method.html.erb
 - templates/config.yml
-- templates/index.html.erb
-- templates/resource.html.erb
+- templates/layout.html.erb
 - test/rapi_doc_test.rb
 - test/test_helper.rb
 - uninstall.rb
@@ -103,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4485947497076302486
+      hash: -1142143920796928786
       segments: 
       - 0
       version: "0"

data/README

@@ -1,44 +0,0 @@
-@WIP
-Based on RAPI Doc by Jaap van der Meer found here: http://code.google.com/p/rapidoc/
-
-Rails API Doc Generator
-Original Author: JPM van der Meer
-Modified By: Chelsea Robb
-=======================
-With API DOC one can generate code for a Restful Rails API.
-It generates a set of HTML views in the public directory.  Parses the desired controllers and generates appropriate views.
-Currently does not read routes.rb and requires manual entry of routes
-
-=INSTALL
-    gem install rapi_doc
-
-==Layout files
-You can find documentation layouts in config/rapi_doc
-
-index.html.erb is used for index page.
-resource.html.erb is used for individual controllers.
-
-==Usage
-Run 'rake rapi_doc' to generate config and layout files. (TODO: Add a separte rake task to generate config files)
-Modify config file by adding your controllers, e.g.:
-
-users:
-  location: "/users"
-  controller_name: "users_controller.rb"
-
-Then invoke the generation by calling:
-    rake rapi_doc
-
-==Documentation Example
-
-=begin apidoc
-url:: /users
-method:: GET
-access:: FREE
-return:: [JSON|XML] - list of user objects
-param:: page:int - the page, default is 1
-param:: per_page:int - max items per page, default is 10
-
-Get a list of all users in the system with pagination.  Defaults to 10 per page
-=end
-

data/templates/resource.html.erb

@@ -1,67 +0,0 @@
-<!-- TODO Use same layout for index and resources -->
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title><%= @name || 'Home' %></title>
-
-    <style>
-      body {
-        line-height: 1.5em;
-        color:#484848;
-      }
-
-      ul, ol {
-        margin-bottom: 0.8em;
-      }
-
-      li {
-        padding-left: 10px;
-        margin-right: 10px;
-      }
-
-      #resources {
-
-      }
-
-      h1, h2, h3 {
-        padding-top: 8px;
-        padding-bottom: 2px;
-      }
-
-      #method {
-        padding: 15px 30px;
-        border-top:1px solid #ddd;
-      }
-
-      #http_verb {
-        color:#ff6600;
-        width:200px;
-        margin-right:20px;'
-      }
-
-      .description{
-        font-size: 1.4em;
-        color:#262626;
-      }
-    </style>
-
-  </head>
-  <body>
-    <div class="content">
-      <div id="navigation"> 
-        <ul class="main">
-          <li><a href="/apidoc/index.html">&laquo; Back to index</a></li>
-        </ul>
-      </div>
-
-      <hr />
-
-      <%=@header_code %>
-
-      <% @method_codes.each do |mc| %>
-        <%=mc %>
-      <% end %>
-    </div>
-  </body>
-</html>