cdoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 012f909628d011dd541bc011899dc952849da0f2
+  data.tar.gz: c21c90cffd4c62383fd94ab44407b15f5fe3e089
+SHA512:
+  metadata.gz: 949a99bd3b56e056b5c03a7a906e3dd3c178b374df0419f7ff417ad61c86daacdd62cf9bf850397e321bacd91822aef16a54f7f95039df5b019cb5f0e262194c
+  data.tar.gz: 5fef22b87d31974cf1f949ae9b55b32038ffd26f34a60b4c291dca2661b1f155106180fd689b711e75ba9158dd6e5632380281e537b8812f958cd21a3a285f2d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Deepak Kumar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cdoc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cdoc
+
+## Usage
+
+cd to your rails application and run
+
+    $ cdoc
+    $ open doc/index.html
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cdoc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/cdoc

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cdoc"
+
+# Aims to generate documentaion for Rails controller
+# default target folder is app/controllers in a Rails application
+require 'pry'
+Cdoc::CDoc.new.generate

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cdoc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cdoc.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cdoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cdoc"
+  spec.version       = Cdoc::VERSION
+  spec.authors       = ["Deepak Kumar"]
+  spec.email         = ["deepakkumarnd@gmail.com"]
+
+  spec.summary       = %q{Generate single page api documentation for Rails application.}
+  spec.description   = %q{Generate single page api documentation for Rails application.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/cdoc.rb

@@ -0,0 +1,187 @@
+require 'cdoc/version'
+require 'rake'
+Bundler.require(:default)
+
+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
+
+  class DocString
+    def initialize
+      @docstring = ''
+    end
+
+    def title(title)
+      @title = title
+      @docstring << "\n" + "# #{title}" + "\n"
+    end
+
+    def section(str)
+      @docstring << "\n" + "## #{str}" + "\n"
+    end
+
+    def subsection(str)
+      lines = str.split("\n")
+      index = 0
+
+      loop do
+        line = lines[index]
+
+        if line.nil?
+          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
+          code_block = []
+          code_block << line.sub('  ', '')
+
+          loop do
+            line = lines[index + 1]
+
+            if line.nil? || !line.start_with?('  ')
+              code_str = code_block.join("\n")
+              # try to parse this as json
+              begin
+                json = JSON.parse(code_str)
+                code_str = JSON.pretty_generate(json)
+                block = ["\n", '```json', code_str, '```'].join("\n")
+              rescue JSON::ParserError => e
+                puts e.message
+                block = ["\n", '```', code_str, '```'].join("\n")
+              end
+
+              break
+            else
+              code_block << line.sub('  ', '')
+              index = index + 1
+            end
+          end
+        else
+          block = line
+        end
+
+        @docstring << block
+        index = index + 1
+      end
+
+      @docstring << "\n"
+    end
+
+    def tagged_line(line, tag)
+      t   = line.sub(tag, '').strip
+      t_l = "\n" + tag.sub('@','').capitalize
+
+      if !t.empty?
+        t_l = t_l + " **#{t.strip}**\n\n"
+      end
+
+      t_l
+    end
+
+    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 render_as_html
+      layout_file = File.join(File.dirname(__FILE__), 'layouts/default.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)}
+      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
+    end
+  end
+
+  class CDoc
+
+    attr_accessor :files, :docstring
+
+    def initialize
+      @files = Rake::FileList.new('app/controllers/**/*.rb')
+      @files = @files.select { |file| file.end_with?('_controller.rb') }
+      @doc = DocString.new
+    end
+
+    def generate
+      @doc.title('Chillr API Documentaion')
+
+      @file_groups = files.group_by { |f| File.basename(f, '_controller.rb') }
+
+      @file_groups.each do |group, files|
+        @doc.section(group.capitalize)
+        files.each do |file|
+          docs = extract_documentation(file)
+          docs.each do |doc|
+            @doc.subsection(doc)
+          end
+        end
+      end
+
+      @doc.finish
+    end
+
+    def extract_documentation(file)
+      begin
+        lines = File.readlines(file)
+      rescue => e
+        puts "#{e.class}: Error reading file #{file}. Skip"
+        return
+      end
+
+      docs  = []
+      doclines = []
+      recording = false
+
+      lines.each do |line|
+        if !recording && (line.strip == '#doc')
+          recording = true
+          next
+        end
+
+        if recording
+          line = line.strip
+
+          if line.empty?
+            next
+          elsif line.start_with?('#')
+            doclines << line.strip.sub('#', '')
+          else
+            recording = false
+            docs << doclines.join("\n")
+            doclines = []
+          end
+        end
+      end
+
+      if recording && (doclines.length != 0)
+        recording = false
+        docs << doclines.join("\n")
+        doclines = []
+      end
+
+      docs
+    end
+  end
+end

data/lib/cdoc/version.rb

@@ -0,0 +1,3 @@
+module Cdoc
+  VERSION = "0.1.0"
+end

data/lib/layouts/default.html

@@ -0,0 +1,16 @@
+<!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>
+
+    <link href="css/markdown4.css" rel="stylesheet">
+    <link href="css/pygments_github.css" rel="stylesheet">
+  </head>
+  <body>
+    %{content}
+  </body>
+</html>

data/lib/styles/markdown4.css

@@ -0,0 +1,112 @@
+@charset "utf-8";
+
+/**
+ * markdown.css
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see http://gnu.org/licenses/lgpl.txt.
+ *
+ * @project      Weblog and Open Source Projects of Florian Wolters
+ * @version      GIT: $Id$
+ * @package      xhtml-css
+ * @author       Florian Wolters <florian.wolters.85@googlemail.com>
+ * @copyright    2012 Florian Wolters
+ * @cssdoc       version 1.0-pre
+ * @license      http://gnu.org/licenses/lgpl.txt GNU Lesser General Public License
+ * @link         http://github.com/FlorianWolters/jekyll-bootstrap-theme
+ * @media        all
+ * @valid        true
+ */
+
+body {
+    font-family: Helvetica, Arial, Freesans, clean, sans-serif;
+padding:1em;
+margin:auto;
+max-width:42em;
+background:#fefefe;
+}
+
+h1, h2, h3, h4, h5, h6 {
+    font-weight: bold;
+}
+
+h1 {
+    color: #000000;
+    font-size: 28px;
+}
+
+h2 {
+    border-bottom: 1px solid #CCCCCC;
+    color: #000000;
+    font-size: 24px;
+}
+
+h3 {
+    font-size: 18px;
+}
+
+h4 {
+    font-size: 16px;
+}
+
+h5 {
+    font-size: 14px;
+}
+
+h6 {
+    color: #777777;
+    background-color: inherit;
+    font-size: 14px;
+}
+
+hr {
+    height: 0.2em;
+    border: 0;
+    color: #CCCCCC;
+    background-color: #CCCCCC;
+}
+
+p, blockquote, ul, ol, dl, li, table, pre {
+    margin: 15px 0;
+}
+
+code, pre {
+    border-radius: 3px;
+    background-color: #F8F8F8;
+    color: inherit;
+}
+
+code {
+    border: 1px solid #EAEAEA;
+    margin: 0 2px;
+    padding: 0 5px;
+}
+
+pre {
+    border: 1px solid #CCCCCC;
+    line-height: 1.25em;
+    overflow: auto;
+    padding: 6px 10px;
+}
+
+pre > code {
+    border: 0;
+    margin: 0;
+    padding: 0;
+}
+
+a, a:visited {
+    color: #4183C4;
+    background-color: inherit;
+    text-decoration: none;
+}

data/lib/styles/pygments_github.css

@@ -0,0 +1,61 @@
+.highlight .hll { background-color: #ffffcc }
+.highlight .c { color: #999988; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.highlight .k { color: #000000; font-weight: bold } /* Keyword */
+.highlight .o { color: #000000; font-weight: bold } /* Operator */
+.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */
+.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #999999 } /* Generic.Heading */
+.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #555555 } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
+.highlight .gt { color: #aa0000 } /* Generic.Traceback */
+.highlight .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #000000; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #009999 } /* Literal.Number */
+.highlight .s { color: #d01040 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086B3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #800080 } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nl { color: #990000; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #555555 } /* Name.Namespace */
+.highlight .nt { color: #000080 } /* Name.Tag */
+.highlight .nv { color: #008080 } /* Name.Variable */
+.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sb { color: #d01040 } /* Literal.String.Backtick */
+.highlight .sc { color: #d01040 } /* Literal.String.Char */
+.highlight .sd { color: #d01040 } /* Literal.String.Doc */
+.highlight .s2 { color: #d01040 } /* Literal.String.Double */
+.highlight .se { color: #d01040 } /* Literal.String.Escape */
+.highlight .sh { color: #d01040 } /* Literal.String.Heredoc */
+.highlight .si { color: #d01040 } /* Literal.String.Interpol */
+.highlight .sx { color: #d01040 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #d01040 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #008080 } /* Name.Variable.Class */
+.highlight .vg { color: #008080 } /* Name.Variable.Global */
+.highlight .vi { color: #008080 } /* Name.Variable.Instance */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: cdoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Deepak Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Generate single page api documentation for Rails application.
+email:
+- deepakkumarnd@gmail.com
+executables:
+- cdoc
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cdoc
+- bin/console
+- bin/setup
+- cdoc.gemspec
+- lib/cdoc.rb
+- lib/cdoc/layout.html
+- lib/cdoc/version.rb
+- lib/layouts/default.html
+- lib/styles/markdown4.css
+- lib/styles/pygments_github.css
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Generate single page api documentation for Rails application.
+test_files: []