rapi_doc 0.3.1 → 0.4.0

data/lib/doc_parser.rb

@@ -1,53 +0,0 @@
-module RapiDoc
-  # This class holds the methods that parse the doc
-  class DocParser
-    attr_accessor :current_api_block, :current_scope, :line_no, :in_class
-
-    def initialize
-      @current_api_block = nil
-      @current_scope = :none
-      @line_no = 0
-      @in_class = false
-    end
-
-    def start(order)
-      @current_scope = !in_class ? :class : :function
-      @current_api_block = MethodDoc.new(current_scope, order)
-    end
-
-    def reset_current_scope_and_api_block
-      @current_api_block = nil
-      @current_scope = :none
-    end
-
-    def parse(line)
-      case current_scope
-      when :response
-        @current_api_block.response += strip_line(line)
-      when :request
-        @current_api_block.request += strip_line(line)
-      when :output
-        @current_api_block.append_output strip_line(line)
-      when :class, :function
-        if result = /(\w+)\:\:\s*(.+)/.match(line)
-          if result[1] == "response" || result[1] == "request"
-            @current_scope = result[1].to_sym
-          elsif result[1] == "output"
-            @current_scope = result[1].to_sym
-            @current_api_block.add_output(result[1], result[2])
-          else
-            @current_api_block.add_variable(result[1], result[2])
-          end
-        else
-          # add line to block
-          @current_api_block.content << strip_line(line)
-        end
-      end
-    end
-
-    # strip the '#' on the line
-    def strip_line(line)
-      line[1..line.length]
-    end
-  end
-end

data/lib/doc_util.rb

@@ -1,8 +0,0 @@
-module RapiDoc
-  class DocUtil
-    # print some  erb code to a template
-    def self.print_erb(str, show=false)
-      (show ? "<%= " : "<% ") + str + " %>"
-    end
-  end
-end

data/lib/method_doc.rb

@@ -1,44 +0,0 @@
-module RapiDoc
-  # This class holds methods about a doc.
-  class MethodDoc
-    attr_accessor :scope, :content, :request, :response, :code, :outputs, :variables, :method_order
-    
-    def initialize(type, order)
-      @scope = type
-      @method_order = order
-      @variables = []
-      @outputs = []
-      @content = ""
-      @code = ""
-      @request = ""
-      @response = ""
-    end
-    
-    
-    def add_variable(name, value)
-      if name == "param"
-        @variables << value
-        return
-      end
-
-      eval("@#{name}= \"#{value}\"")
-      self.class.class_eval { attr_accessor name.to_sym }
-    end
-
-    def add_output(name, value)
-      if name == 'output'
-        @outputs << eval("{#{value}: ''}")
-        return
-      end
-    end
-
-    def append_output(value)
-      last_output_key = @outputs.last.keys[0]
-      @outputs.last[last_output_key] += ERB::Util.html_escape(value)
-    end
-
-    def get_binding
-      binding
-    end
-  end
-end

data/lib/rapi_config.rb

@@ -1,37 +0,0 @@
-module RapiDoc
-  module RapiConfig
-    BASE_DIR = 'config/rapi_doc'
-    
-    def config_dir
-      File.join(::Rails.root.to_s, BASE_DIR)
-    end
-
-    def template_dir
-      File.join(File.dirname(__FILE__), '/../templates')
-    end
-
-    def config_file(location)
-      File.join(find_location(location), 'config.yml')
-    end
-
-    def layout_file(location)
-      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
-  end
-end

data/lib/resource_doc.rb

@@ -1,102 +0,0 @@
-# encoding: utf-8
-require 'method_doc'
-require 'doc_parser'
-
-module RapiDoc
-  # ResourceDoc holds the information a resource contains. It parses the class header and also the 
-  # method documentation, which will be contained in MethodDoc.
-  class ResourceDoc
-    
-    attr_reader :name, :resource_location, :controller_name, :function_blocks, :class_block
-    
-    # Initializes ResourceDoc.
-    def initialize(name, resource_location, controller_name, options = {})
-      @name = name
-      @standard_methods = options[:standard_methods] || [:put, :post, :get, :delete]
-      @resource_location, @controller_name = resource_location, controller_name
-      @function_blocks = []
-      @method_codes = []
-      @header_code = ""
-      
-      unless File.exist?(controller_location)
-        raise "Unable to find or open controller. Make sure it's set properly in config/rapidoc/config.yml File: #{controller_location}"
-      end
-    end
-    
-    # returns the location of the controller that is to be parsed
-    def controller_location
-      # @resource_location
-      "#{::Rails.root.to_s}/app/controllers/#{controller_name}"
-    end
-    
-    def get_binding
-      binding
-    end
-    
-    # parse the controller
-    def parse_apidoc!
-      line_no = 0
-      
-      parser = DocParser.new
-      order = 1
-      File.open(controller_location).each do |line|
-        case
-        when line =~ /=begin apidoc/
-          parser.start(order)
-        when line =~ /=end/
-          if parser.current_api_block.nil?
-            puts "#{controller_location}:#{line_no} - No starttag for '=end' found"
-            exit
-          else
-            case parser.current_scope
-            when :class
-              @class_block = parser.current_api_block
-            when :function
-              @function_blocks << parser.current_api_block
-            end
-            parser.reset_current_scope_and_api_block
-            order += 1
-          end
-        when line =~ /class/
-          parser.in_class = true
-        when line =~ /::response-end::/, line =~ /::request-end::/, line =~ /::output-end::/
-          parser.current_scope = :function
-        else
-          parser.parse(line)
-        end
-        
-        line_no += 1
-      end
-      
-      puts "Generated #{name}.html"
-    end
-
-    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, i)
-         i += 1
-       end
-       # write it to a file
-       template = ""
-       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 }
-      ERB.new(template).result(@class_block.get_binding)
-    end
-
-    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)
-    end
-
-  end
-end

data/templates/_resource_header.html.erb

@@ -1,18 +0,0 @@
-<h1><%=@name %></h1>
-<p class="summary"><%=@content %></p>
-
-<% if @xml || @json %>
-  <h2>Representations</h2>
-
-  <% if @json %>
-    <a name="json"></a>
-    <strong>JSON representation:</strong> <br /><a href="javascript:$('#jsonrep').toggle()">(toggle code)</a><br />
-    <textarea style="width:100%;height:200px;display:none;" id="jsonrep"><%=@json %></textarea><br />
-  <% end %>
-
-  <% if @xml %>
-    <a name="xml"></a>
-    <strong>XML representation:</strong> <br /><a href="javascript:$('#xmlrep').toggle()">(toggle code)</a><br/>
-    <textarea style="width:100%;height:200px;display:none;" id="xmlrep"><%=@xml %></textarea>
-  <% end %>
-<% end %>

data/templates/_resource_method.html.erb

@@ -1,56 +0,0 @@
-<div id="method_<%=@method_order%>">
-  
-  <%
-    splitted = @method
-    str = @method
-    str = "<span id='http_verb'>#{str}</span>"
-  %>
-  <p class='description'><strong>Description:</strong> <%=@content %></p>
-
-  <h2><%=str %><%=@url %></h2>
-  
-  <% if @access %>
-    <strong>Access:</strong> <%=@access %><br />
-  <% end %>
-
-  <% if @return %>
-    <strong>Return:</strong>
-    <%=@return %>
-    <br />
-  <% end %>
-
-  <% if @variables %>  
-    <strong>Parameters:</strong>
-    <ul>
-      <% @variables.each do |v| %><li><%=v %></li><% end %>
-    </ul>
-  <% end %>
-
-  <% unless @outputs.empty? %>
-    <ul class="tabs">
-      <% @outputs.each do |output| %>
-        <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.keys.first}_#{@method_order}" %>'>
-          <pre class="prettyprint" ><%= output[output_format] %></pre>
-        </div>
-      <% end %>
-    </div>
-    <br />
-  <% end %>
-
-  <% unless @request.blank? %>
-    <strong>Request:</strong>
-    <pre class="code"><code><%= @request %></code></pre>
-  <% end %>
-
-  <% unless @response.blank? %>  
-    <strong>Response:</strong>
-    <pre class="code"><code><%= @response %></code></pre>
-  <% end %>
-
-</div>

data/templates/class_layout.html.erb

@@ -1,36 +0,0 @@
-<!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/config.yml

@@ -1,3 +0,0 @@
-#users:
-#  location: "/users"
-#  controller_name: "users_controller.rb"

data/templates/frameset.html.erb

@@ -1,11 +0,0 @@
-<!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

@@ -1,69 +0,0 @@
-<!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;
-      }
-      .code {
-          font-family: monospace;
-      }
-    </style>
-
-  </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>
-
-      <hr />
-
-      <%=@header_code %>
-
-      <% @method_codes.each do |mc| %>
-        <%=mc %>
-      <% end %>
-    </div>
-  </body>
-</html>