cdoc 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d820713e809296ad393075f97bc7c4f1b0765855
-  data.tar.gz: 4f62f92271bbe59df2ca5dcc0d04f5b9204c4e4b
+  metadata.gz: 330e5acf5e69b1f523fa79269626598381210081
+  data.tar.gz: ba839a48e9775992def0dd457e30748145b003a7
 SHA512:
-  metadata.gz: 861e8677bf2e5736dda1cfe3ad259855604a751406b95a2d2f1678f26a4db0b349b0cfb57a484ca68e4426982b040f968dffd1c77adeb2b46f2161c2596bd5ab
-  data.tar.gz: f9568d2ceb4f963ab377fe0b47d4125be4254bc0e18f0bfd5b7d60748d4cd00f5b58de305453ca37e18077b9501b48b7a4143736e4b3b0da163ac1511cd230c8
+  metadata.gz: 55f81bbabe959fd40ffa73eb2352178fddef674c4899d49a13b7d3c3df23c1a468d261bb4354e5ac559f48c6059e8de66432c0f17c4c57d39545fdf595006c83
+  data.tar.gz: 5ff8aa840889db2cc74fba3998cde069f45d9a314216fb91b7d0897976889821c446f96dd1d12f49e62f71a1d21e598c74deab344e00a3e713776ca3880fc104

data/Gemfile

@@ -3,6 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in cdoc.gemspec
 gemspec
 
-gem 'redcarpet'
 gem 'pygments.rb'
 gem 'pry'

data/README.md

@@ -7,7 +7,7 @@ For example
 
 ```
 #doc
-# @endpoint /api/v1/accounts/list
+# @api /api/v1/accounts/list
 # @params
 #  {
 #    user_id: '123456'
@@ -29,7 +29,17 @@ For example
 #  }
 ```
 
-The code sections will be highligted if a 2 space indentation is used. Alos if the code section is a valid json then the section will be highlighted.
+The code sections will be highligted if a 2 space indentation is used. Also if the code section is a valid json then the section will be highlighted.
+
+## Tags
+
+If a line starts with `@word` then the line is considered as a tagged line. The text after the tagged line is simply highlighted.
+
+eg : @api /api/v1/accounts/list will be rendered as
+
+Api **/api/v1/accounts/list**
+
+To make it simple none of the tags is considered special at the moment.
 
 ## Installation
 
@@ -51,8 +61,11 @@ Or install it yourself as:
 
 cd to your rails application and run
 
-    $ cdoc
-    $ open doc/index.html
+    $ cdoc TITLE="Fizbuz API Documentation"
+    $ cd doc
+    $ ruby -run -e httpd -- -p 5000 .   # start a web server to serve the generated files
+
+Now open the browser and go to [http://localhost:5000](http://localhost:5000) to view the documentation.
 
 ## Development
 

data/cdoc.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_runtime_dependency "redcarpet", "~>3.4.0"
   spec.add_runtime_dependency "pygments.rb", "~>1.1.1"
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/cdoc.rb

@@ -1,6 +1,5 @@
 require 'cdoc/version'
 require 'rake'
-require 'redcarpet'
 require 'pygments'
 require 'json'
 
@@ -10,11 +9,8 @@ module Cdoc
     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"
+    def highlight(code, lang)
       Pygments.highlight(code, lexer: lang)
     end
   end
@@ -24,7 +20,6 @@ module Cdoc
     include Helpers
 
     def initialize
-      @docstring = ''
       @content = []
     end
 
@@ -32,15 +27,23 @@ module Cdoc
       @title = title
     end
 
+    def sidebar(keys)
+      return if keys.empty?
+
+      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
+
+      @sidebar = ['<div class="list-group">', items, '</div>'].flatten.join("\n")
+    end
+
     def section(str)
       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)
 
       template = %q(
@@ -53,7 +56,7 @@ module Cdoc
         </div>
       </div>)
 
-          lines = str.split("\n")
+      lines = str.split("\n")
       index = 0
       section_header = ''
       sub_section = []
@@ -78,7 +81,7 @@ module Cdoc
               begin
                 json = JSON.parse(code_str)
                 code_str = JSON.pretty_generate(json)
-                block = ['<pre><code>', code_str, '</code></pre>'].join('')
+                block = highlight(code_str, 'json')
               rescue JSON::ParserError => e
                 # puts e.message
                 block = ['<pre><code>', code_str, '</code></pre>'].join("\n")
@@ -90,6 +93,24 @@ module Cdoc
               index = index + 1
             end
           end
+        elsif unordered_list?(line)
+          list_block = []
+          list_block << line.sub(/\-|\*/, '').strip
+
+          loop do
+            line = lines[index + 1]
+
+            if line.nil? || !unordered_list?(line)
+              list_block.join('\n')
+              break
+            else
+              list_block << line.sub(/\-|\*/, '').strip
+              index = index + 1
+            end
+          end
+
+          list_block = list_block.map { |i| ['<footer>', i, '</footer>'].join('') }
+          block = ['<blockquote>', list_block, '</blockquote>'].flatten.join("\n")
         else
           block = [line, '<br/>'].join('')
         end
@@ -106,6 +127,11 @@ module Cdoc
       @content << template % { section_header: section_header, section_body: sub_section.join("\n")}
     end
 
+    def unordered_list?(line)
+      l = line.strip
+      l.start_with?('- ') || l.start_with?('* ')
+    end
+
     def tagged_line(line, tag)
       if ['url', 'endpoint', 'api'].include?(tag.downcase)
         # set the title of the section
@@ -123,16 +149,9 @@ module Cdoc
 
     def finish
       FileUtils.mkdir_p('doc') unless Dir.exists?('doc')
-      render_as_markdown
       render_as_html
     end
 
-    def render_as_markdown
-      f = File.open('doc/index.md', 'w+')
-      f.write(@docstring)
-      f.close
-    end
-
     def content
       @content.flatten.join('')
     end
@@ -141,16 +160,11 @@ module Cdoc
       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, sidebar: @sidebar, content: content }
       f.write(html)
       f.close
 
-      unless Dir.exists?('doc/css')
-        puts File.join(File.dirname(__FILE__), 'styles')
-        FileUtils.cp_r(File.join(File.dirname(__FILE__), 'styles'), 'doc/css')
-      end
+      FileUtils.cp_r(File.join(File.dirname(__FILE__), 'styles'), 'doc/')
     end
   end
 
@@ -166,26 +180,16 @@ module Cdoc
       @doc = DocString.new
     end
 
-    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
-      @doc.title('Chillr API Documentaion')
-
-      @file_groups = files.group_by { |f| File.basename(f, '_controller.rb') }
+      @doc.title(ENV['TITLE'] || 'Chillr API Documentaion')
 
-      sidebar = generate_sidebar(@file_groups.keys)
+      file_groups = files.group_by { |f| File.basename(f, '_controller.rb') }
 
-      @doc.sidebar(sidebar)
+      # Generates sidebar
+      @doc.sidebar(file_groups.keys)
 
-      @file_groups.each do |group, files|
+      # Generates body
+      file_groups.each do |group, files|
         @doc.section(group.capitalize)
         files.each do |file|
           docs = extract_documentation(file)
@@ -206,8 +210,8 @@ module Cdoc
         return
       end
 
-      docs  = []
-      doclines = []
+      sections  = []
+      section_doc_lines = []
       recording = false
 
       lines.each do |line|
@@ -222,22 +226,20 @@ module Cdoc
           if line.empty?
             next
           elsif line.start_with?('#')
-            doclines << line.strip.sub('#', '')
+            section_doc_lines << line.strip.sub('#', '')
           else
             recording = false
-            docs << doclines.join("\n")
-            doclines = []
+            sections << section_doc_lines.join("\n")
+            section_doc_lines = []
           end
         end
       end
 
-      if recording && (doclines.length != 0)
-        recording = false
-        docs << doclines.join("\n")
-        doclines = []
+      if recording && (section_doc_lines.length != 0)
+        sections << section_doc_lines.join("\n")
       end
 
-      docs
+      sections
     end
   end
 end

data/lib/cdoc/version.rb

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

data/lib/layouts/bootstrap.html

@@ -10,6 +10,15 @@
     <!-- 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">
+    <link href="/styles/fruity.css" rel="stylesheet">
+
+    <style>
+        pre {
+            color: #ffffff;
+            background-color: black;
+            border-color: #0f140f;
+        }
+    </style>
     <!-- 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]>
@@ -28,20 +37,8 @@
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
             </button>
-            <a class="navbar-brand" href="#">Chillr</a>
+            <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">

data/lib/layouts/default.html

@@ -7,8 +7,8 @@
     <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
     <title>%{title}</title>
 
-    <link href="css/markdown4.css" rel="stylesheet">
-    <link href="css/pygments_github.css" rel="stylesheet">
+    <link href="styles/markdown4.css" rel="stylesheet">
+    <link href="styles/pygments_github.css" rel="stylesheet">
   </head>
   <body>
     %{content}

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Deepak Kumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement