cdoc 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5f4b354e7e92871ae1929676d97e545ad8be1c4
-  data.tar.gz: c9112088372b2abe90305b2e5f0dd90b04d7748c
+  metadata.gz: d820713e809296ad393075f97bc7c4f1b0765855
+  data.tar.gz: 4f62f92271bbe59df2ca5dcc0d04f5b9204c4e4b
 SHA512:
-  metadata.gz: 4adfd8b396b11d9c29f5288ea27ad2187071406809e78041bd050d81f4ede494f38305a7b58dd58e68edec42b6c9b4239ceaca83328402024b7878945b277f72
-  data.tar.gz: e4c3666b68e3ced0cc529db5eeaec74a37796c6d3a16245489884c2f925cfaa508ffd38c6f0e72fba4f2a42243fd05e9380aa73535666ced318559472cb3288b
+  metadata.gz: 861e8677bf2e5736dda1cfe3ad259855604a751406b95a2d2f1678f26a4db0b349b0cfb57a484ca68e4426982b040f968dffd1c77adeb2b46f2161c2596bd5ab
+  data.tar.gz: f9568d2ceb4f963ab377fe0b47d4125be4254bc0e18f0bfd5b7d60748d4cd00f5b58de305453ca37e18077b9501b48b7a4143736e4b3b0da163ac1511cd230c8

data/bin/cdoc

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "cdoc"
+require_relative "../lib/cdoc"
 
 # Aims to generate documentaion for Rails controller
 # default target folder is app/controllers in a Rails application

data/lib/cdoc.rb

@@ -6,6 +6,12 @@ require 'json'
 
 module Cdoc
 
+  module Helpers
+    def to_id(str)
+      str.gsub(/\W/, '').downcase
+    end
+  end
+
   class DocRenderer < Redcarpet::Render::HTML
     def block_code(code, lang='text')
       lang = lang && lang.split.first || "text"
@@ -14,22 +20,43 @@ module Cdoc
   end
 
   class DocString
+
+    include Helpers
+
     def initialize
       @docstring = ''
+      @content = []
     end
 
     def title(title)
       @title = title
-      @docstring << "\n" + "# #{title}" + "\n"
     end
 
     def section(str)
-      @docstring << "\n" + "## #{str}" + "\n"
+      template = "<p id='%{id}'><h3>%{str}</h3></p>"
+      @content <<  template % { id: to_id(str), str: str }
+    end
+
+    def sidebar(sidebar)
+      @sidebar = sidebar
     end
 
     def subsection(str)
-      lines = str.split("\n")
+
+      template = %q(
+      <div class="panel panel-default" id="accounts">
+        <div class="panel-heading">
+          <h3 class="panel-title">%{section_header}</h3>
+        </div>
+        <div class="panel-body">
+          %{section_body}
+        </div>
+      </div>)
+
+          lines = str.split("\n")
       index = 0
+      section_header = ''
+      sub_section = []
 
       loop do
         line = lines[index]
@@ -51,38 +78,47 @@ module Cdoc
               begin
                 json = JSON.parse(code_str)
                 code_str = JSON.pretty_generate(json)
-                block = ["\n", '```json', code_str, '```'].join("\n")
+                block = ['<pre><code>', code_str, '</code></pre>'].join('')
               rescue JSON::ParserError => e
-                puts e.message
-                block = ["\n", '```', code_str, '```'].join("\n")
+                # puts e.message
+                block = ['<pre><code>', code_str, '</code></pre>'].join("\n")
               end
 
               break
             else
-              code_block << line.sub('  ', '')
+              code_block << line.sub('  ', '') unless line.strip.empty?
               index = index + 1
             end
           end
         else
-          block = line
+          block = [line, '<br/>'].join('')
+        end
+
+        if index == 0
+          section_header = block
+        else
+          sub_section << block
         end
 
-        @docstring << block
         index = index + 1
       end
 
-      @docstring << "\n"
+      @content << template % { section_header: section_header, section_body: sub_section.join("\n")}
     end
 
     def tagged_line(line, tag)
+      if ['url', 'endpoint', 'api'].include?(tag.downcase)
+        # set the title of the section
+      end
+
       t   = line.sub(tag, '').strip
-      t_l = "\n" + tag.sub('@','').capitalize
+      t_l = ['<small>', tag.sub('@', '').capitalize, '</small>']
 
       if !t.empty?
-        t_l = t_l + " **#{t.strip}**\n\n"
+        t_l = t_l + ['<strong>', t.strip, '</strong>']
       end
 
-      t_l
+      ['<p>', t_l, '</p>'].flatten.join("\n")
     end
 
     def finish
@@ -97,13 +133,17 @@ module Cdoc
       f.close
     end
 
+    def content
+      @content.flatten.join('')
+    end
+
     def render_as_html
-      layout_file = File.join(File.dirname(__FILE__), 'layouts/default.html')
+      layout_file = File.join(File.dirname(__FILE__), 'layouts/bootstrap.html')
       layout = File.read(layout_file)
       f = File.open('doc/index.html', 'w+')
       renderer = DocRenderer.new
       markdown = Redcarpet::Markdown.new(renderer, fenced_code_blocks: true)
-      html = layout % { title: @title, content: markdown.render(@docstring)}
+      html = layout % { title: @title, sidebar: @sidebar, content: content }
       f.write(html)
       f.close
 
@@ -116,6 +156,8 @@ module Cdoc
 
   class CDoc
 
+    include Helpers
+
     attr_accessor :files, :docstring
 
     def initialize
@@ -124,10 +166,14 @@ module Cdoc
       @doc = DocString.new
     end
 
-    def sidebar_section(headers)
-      headers.each do |title|
-        title.capitalize
+    def generate_sidebar(keys)
+      tmpl_item = '<a href="#%{id}" class="list-group-item">%{item}</a>'
+
+      items = keys.map do |key|
+        tmpl_item % { id: to_id(key), item: key.capitalize }
       end
+
+      ['<div class="list-group">', items, '</div>'].flatten.join("\n")
     end
 
     def generate
@@ -135,7 +181,9 @@ module Cdoc
 
       @file_groups = files.group_by { |f| File.basename(f, '_controller.rb') }
 
-      @sidebar = sidebar_section(@file_groups.keys)
+      sidebar = generate_sidebar(@file_groups.keys)
+
+      @doc.sidebar(sidebar)
 
       @file_groups.each do |group, files|
         @doc.section(group.capitalize)

data/lib/cdoc/version.rb

@@ -1,3 +1,3 @@
 module Cdoc
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/layouts/bootstrap.html

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+    <title>%{title}</title>
+
+    <!-- Bootstrap -->
+    <!--<link href="/css/bootstrap.min.css" rel="stylesheet">-->
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+    <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+    <!--[if lt IE 9]>
+    <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
+    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+    <![endif]-->
+</head>
+<body>
+<nav class="navbar navbar-default">
+    <div class="container-fluid">
+        <!-- Brand and toggle get grouped for better mobile display -->
+        <div class="navbar-header">
+            <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-expanded="false">
+                <span class="sr-only">Toggle navigation</span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+            </button>
+            <a class="navbar-brand" href="#">Chillr</a>
+        </div>
+
+        <!-- Collect the nav links, forms, and other content for toggling -->
+        <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+            <ul class="nav navbar-nav navbar-right">
+                <li class="dropdown">
+                    <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">More<span class="caret"></span></a>
+                    <ul class="dropdown-menu">
+                        <li><a href="#">Action</a></li>
+                    </ul>
+                </li>
+            </ul>
+        </div><!-- /.navbar-collapse -->
+    </div><!-- /.container-fluid -->
+</nav>
+<div class="container">
+    <div class="row">
+        <div class="col-md-3">
+            %{sidebar}
+        </div>
+        <div class="col-md-8">
+            %{content}
+        </div>
+    </div>
+</div>
+<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
+<!-- Include all compiled plugins (below), or include individual files as needed -->
+<script src="/js/bootstrap.min.js"></script>
+</body>
+</html>

data/lib/layouts/default.html

@@ -13,4 +13,4 @@
   <body>
     %{content}
   </body>
-</html>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Deepak Kumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -102,6 +102,7 @@ files:
 - cdoc.gemspec
 - lib/cdoc.rb
 - lib/cdoc/version.rb
+- lib/layouts/bootstrap.html
 - lib/layouts/default.html
 - lib/styles/markdown4.css
 - lib/styles/pygments_github.css