cdoc 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99ec20f3098508dd105d537e7be9564ccdd47896
-  data.tar.gz: 29a4e5e29b73d966d17a090dcca9d5475ba1a8d2
+  metadata.gz: c5f4b354e7e92871ae1929676d97e545ad8be1c4
+  data.tar.gz: c9112088372b2abe90305b2e5f0dd90b04d7748c
 SHA512:
-  metadata.gz: 4f5e7d6e57c6f1ed7c9055bb7914280e0ec6efdaefbae695b6dc35af9ce08fc87faf895c38cfbfd0df0b9c30beaf26cf976a3925ec3b1e327f4443214b01e1cb
-  data.tar.gz: f8dbc6fc7c3379702c7d03bac526d7f340ca58f0c17965fb372e32874074f35596017567125c7391a704b6cd0d758b099ec4bca56218789907b9c4c475c9a2ff
+  metadata.gz: 4adfd8b396b11d9c29f5288ea27ad2187071406809e78041bd050d81f4ede494f38305a7b58dd58e68edec42b6c9b4239ceaca83328402024b7878945b277f72
+  data.tar.gz: e4c3666b68e3ced0cc529db5eeaec74a37796c6d3a16245489884c2f925cfaa508ffd38c6f0e72fba4f2a42243fd05e9380aa73535666ced318559472cb3288b

data/README.md

@@ -1,8 +1,35 @@
 # Cdoc
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cdoc`. To experiment with that code, run `bin/console` for an interactive prompt.
+Cdoc generates a simple single page api documentation from the rails application source code comments.
+To use cdoc you need to add a directive `#doc` for every comment block in the api.
 
-TODO: Delete this and the text above, and describe your gem
+For example
+
+```
+#doc
+# @endpoint /api/v1/accounts/list
+# @params
+#  {
+#    user_id: '123456'
+#  }
+# @response
+#  {
+#    accounts: [
+#      {
+#        id: 100,
+#        account_number: '11111111111',
+#        ifsc_code: 'IFSC111111'
+#      },
+#      {
+#        id: 101,
+#        account_number: '111111111112',
+#        ifsc_code: 'IFSC111112'
+#      }
+#    ]
+#  }
+```
+
+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.
 
 ## Installation
 

data/lib/cdoc.rb

@@ -2,15 +2,14 @@ require 'cdoc/version'
 require 'rake'
 require 'redcarpet'
 require 'pygments'
+require 'json'
 
 module Cdoc
+
   class DocRenderer < Redcarpet::Render::HTML
     def block_code(code, lang='text')
       lang = lang && lang.split.first || "text"
       Pygments.highlight(code, lexer: lang)
-      # output = add_code_tags(
-      #   Pygmentize.process(code, lang), lang
-      # )
     end
   end
 
@@ -39,7 +38,7 @@ module Cdoc
           break
         elsif m = line.match(/@\w+/)         # tag line if it start with @<tag>
           block = tagged_line(line, m[0])
-        elsif line.start_with?('  ') # if the line start with 2 or more spaces
+        elsif line.start_with?('  ')         # if the line start with 2 or more spaces
           code_block = []
           code_block << line.sub('  ', '')
 
@@ -125,11 +124,19 @@ module Cdoc
       @doc = DocString.new
     end
 
+    def sidebar_section(headers)
+      headers.each do |title|
+        title.capitalize
+      end
+    end
+
     def generate
       @doc.title('Chillr API Documentaion')
 
       @file_groups = files.group_by { |f| File.basename(f, '_controller.rb') }
 
+      @sidebar = sidebar_section(@file_groups.keys)
+
       @file_groups.each do |group, files|
         @doc.section(group.capitalize)
         files.each do |file|

data/lib/cdoc/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Deepak Kumar