pretty_doc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a96928b9bcc0dc2d0df55c7f54bd07e97090475
+  data.tar.gz: 3b3f486f6295ba4caab0da163bd00d039ef4a5ee
+SHA512:
+  metadata.gz: ebb692c94a6fe4f77a6105adf11df6dc597c93b4b1e5a31edfed9ad1a958dc8cd520a4bf1d9fb959cfe3a46443d956f2f800e838f7bd8ccf889f675c66256a47
+  data.tar.gz: 82f2a8399bdf5028ee6828e8ff75127ede856a8f29442faf7a7db417874bf3eff25486e790d8bd47edaf33eec559399ff923024bb91541b01603496a47856bf1

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.sass-cache

data/CHANGES.md

@@ -0,0 +1,3 @@
+1.0.0
+-----------
+- Initial release!

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    pretty_doc (1.0.0)
+      bootstrap-sass (~> 3.3.5)
+      compass (~> 1.0.3)
+      kramdown (~> 1.8.0)
+      nokogiri (~> 1.6.6)
+      pygments.rb (~> 0.6.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    autoprefixer-rails (5.2.1.1)
+      execjs
+      json
+    bootstrap-sass (3.3.5.1)
+      autoprefixer-rails (>= 5.0.0.1)
+      sass (>= 3.3.0)
+    chunky_png (1.3.4)
+    coderay (1.1.0)
+    compass (1.0.3)
+      chunky_png (~> 1.2)
+      compass-core (~> 1.0.2)
+      compass-import-once (~> 1.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      sass (>= 3.3.13, < 3.5)
+    compass-core (1.0.3)
+      multi_json (~> 1.0)
+      sass (>= 3.3.0, < 3.5)
+    compass-import-once (1.0.5)
+      sass (>= 3.2, < 3.5)
+    diff-lcs (1.2.5)
+    execjs (2.5.2)
+    ffi (1.9.10)
+    json (1.8.3)
+    kramdown (1.8.0)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    posix-spawn (0.3.11)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pygments.rb (0.6.3)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sass (3.4.16)
+    slop (3.6.0)
+    yajl-ruby (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  pretty_doc!
+  pry
+  rake
+  rspec (>= 3.0.0)
+  rspec-its (>= 1.0.0)
+
+BUNDLED WITH
+   1.10.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Felix Liu
+
+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,56 @@
+Pretty Doc
+==========
+
+Pretty Doc is quick and convenient markdown to html converter with beautiful templates, aiming to provide a simple tool to generate beautiful docs for common use.
+
+[TOC]
+
+## Features
+
++ Beautiful built-in templates: `default`, `bootstrap`, `parallel`
++ Code highlight
++ Markdown TOC supports
++ Easy to customize template
++ Support GFM( GitHub Flavored Markdown ) syntax
+
+## Examples
+
++ [Template Default](https://lyfeyaj.github.io/pretty_doc/examples/default/README.html)
++ [Template Bootstrap](https://lyfeyaj.github.io/pretty_doc/examples/bootstrap/README.html)
++ [Template Parallel](https://lyfeyaj.github.io/pretty_doc/examples/parallel/README.html)
+
+## Installation
+
+Pretty Doc is relied on `ruby` environment. Please make sure that your system has `ruby` installed.
+
+```bash
+gem install pretty_doc
+```
+
+## Usage
+
+``` bash
+# Usage: pretty_doc [options] files
+#
+# Options:
+#
+#     -o, --output [path]              output to a given folder
+#     -t, --template [folder]          choose a template
+#     -l, --line-numbers               enable line numbers for codes
+#     -v, --version                    output the version number
+#     -h, --help                       output usage information
+```
+
+## Create a custom template
+
+template structure
+
+```
+├── init.rb
+├── style.scss
+└── template.html.erb
+```
+
+## TODO
+
++ Add docs for how to create a custom template

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/pretty_doc

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+
+lib_path = File.expand_path('../../lib', __FILE__)
+$:.unshift(lib_path)
+
+require 'pretty_doc/cli'
+
+PrettyDoc::Cli.run!(ARGV)

data/build.sh

@@ -0,0 +1,7 @@
+pretty_doc -t default -o ./examples/default README.md
+pretty_doc -t bootstrap -o ./examples/bootstrap README.md
+pretty_doc -t parallel -o ./examples/parallel README.md
+
+pretty_doc -t parallel README.md
+
+mv README.html index.html

data/lib/pretty_doc/cli.rb

@@ -0,0 +1,64 @@
+require 'optparse'
+require 'ostruct'
+require 'pretty_doc'
+
+module PrettyDoc
+  class Cli
+    class << self
+      def run!(args)
+        options = OpenStruct.new
+        options.template = 'default'
+        options.output = File.expand_path('.')
+        options.files = []
+        options.enable_line_numbers = false
+
+        opts_parser = OptionParser.new do |opts|
+          opts.banner = 'Pretty document empowered by markup language.'
+          opts.separator ''
+          opts.separator 'Usage: pretty_doc [options] files'
+          opts.separator ''
+          opts.separator 'Options:'
+          opts.separator ''
+
+          opts.on_tail('-v', '--version', 'output the version number') do
+            puts PrettyDoc::VERSION
+            exit
+          end
+
+          opts.on_tail('-h', '--help', 'output usage information') do
+            puts opts
+            exit
+          end
+
+          opts.on('-o', '--output [path]', 'output to a given folder') do |o|
+            options.output = File.expand_path(o || '.')
+            if !Dir.exist? options.output
+              puts "Directory #{options.output} is not exists, creating new..."
+              FileUtils.mkdir_p(options.output)
+            end
+          end
+
+          opts.on('-t', '--template [folder]', 'choose a template') do |tmpl|
+            options.template = tmpl
+          end
+
+          opts.on('-l', '--line-numbers', 'enable line numbers for codes') do
+            options.enable_line_numbers = true
+          end
+        end
+
+        opts_parser.parse!(args)
+
+        options.files = args
+        options.files = Dir.glob('./*.md') if options.files.length == 0
+        if options.files.length == 0
+          puts opts_parser
+          exit
+        end
+
+        options.template = PrettyDoc.template(options.template)
+        PrettyDoc::Resource::Source.build(options)
+      end
+    end
+  end
+end

data/lib/pretty_doc/converter.rb

@@ -0,0 +1,25 @@
+module PrettyDoc
+  # Common Converter Class that will be inherited
+  class Converter
+    attr_accessor :content, :options
+
+    def as_html
+      convert
+    end
+
+    def self.perfer_exts
+      []
+    end
+
+    # load all descendants
+    def self.descendants
+      ObjectSpace.each_object(Class).select { |klass| klass < self }
+    end
+
+    private
+
+    # Convert Markdown to Html, implement this method to convert content
+    def convert
+    end
+  end
+end

data/lib/pretty_doc/converters/markdown.rb

@@ -0,0 +1,108 @@
+require 'kramdown'
+require 'nokogiri'
+require 'pygments'
+require 'pretty_doc/converter'
+
+module PrettyDoc
+  # Markdown Converter
+  class Markdown < Converter
+    def self.perfer_exts
+      ['.md', '.markdown', '.mdown', '.txt']
+    end
+
+    def before_convert
+      self.content = content
+        .gsub(/\[NO_TOC\]\n/, "{:.no_toc}\n")
+        .gsub(/\[TOC\]\n/, "+ __toc_line__\n{:toc}\n")
+    end
+
+    private
+
+    def convert
+      before_convert
+      html = Kramdown::Document.new(
+        content,
+        input: :GFM,
+        enable_coderay: false,
+        transliterated_header_ids: true
+      ).to_html
+      doc = Nokogiri::HTML::DocumentFragment.parse(html)
+      figure_role(doc)
+      code_block(doc)
+      doc.to_html
+    end
+
+    def code_block(doc)
+      doc.css('pre > code[class^=language]').each do |code_node|
+        lang = (code_node['class'].scan(/language-([^\s]+)/).first || []).first
+        highlight_code_block(code_node, lang)
+      end
+
+      doc.css('pre[lang] > code').each do |code_node|
+        lang = code_node.parent['lang']
+        highlight_code_block(code_node, lang)
+      end
+    end
+
+    def highlight_code_block(code_node, lang)
+      pre = code_node.parent
+      code_output = highlight(code_node.content, lang)
+      code_doc = Nokogiri::HTML::DocumentFragment.parse(code_output)
+      pre.replace code_doc.children
+    end
+
+    def highlight(content, lang)
+      highlighted_code = Pygments.highlight(
+        content,
+        lexer: lang,
+        formatter: 'html',
+        options: { encoding: 'utf-8' }
+      )
+      str = highlighted_code.match(/<pre>(.+)<\/pre>/m)[1].to_s.gsub(/ *$/, '')
+      tableize_code(str, lang)
+    end
+
+    def tableize_code (str, lang = '')
+      line_numbers = ''
+      code = ''
+      str.lines.each_with_index do |line, index|
+        line_numbers += "<span class='line-number'>#{index + 1}</span>\n" if options.enable_line_numbers
+        code += "<span class='line'>#{line}</span>"
+      end
+
+      if options.enable_line_numbers
+        line_numbers = <<-HTML
+          <td class="lines">
+            <pre class="line-numbers">#{line_numbers}</pre>
+          </td>
+        HTML
+      end
+
+      no_line_numbers_class = options.enable_line_numbers ? '' : 'no-lines'
+
+      table = <<-HTML
+        <div class="highlight #{no_line_numbers_class}">
+          <table>
+            <tr>
+              #{line_numbers}
+              <td class="code">
+                <pre><code>#{code}</code></pre>
+              </td>
+            </tr>
+          </table>
+        </div>
+      HTML
+      table
+    end
+
+    def figure_role(doc)
+      doc.css('p[role=figure]').each do |p|
+        p.remove_attribute 'role'
+        p.name = 'figure'
+        p['class'] = 'thumbnail'
+        p.css('em').each { |s| s.name = 'figcaption' }
+        p.css('strong').each { |s| s.name = 'figcaption' }
+      end
+    end
+  end
+end

data/lib/pretty_doc/resource.rb

@@ -0,0 +1,11 @@
+require 'fileutils'
+
+module PrettyDoc
+  # Base Resource Class
+  class Resource
+    attr_accessor :file
+
+    def write(file_dir, options = {})
+    end
+  end
+end

data/lib/pretty_doc/resources/scss.rb

@@ -0,0 +1,37 @@
+require 'tempfile'
+require 'compass'
+require 'compass/exec'
+require 'pretty_doc/resource'
+
+module PrettyDoc
+  class Resource
+    # Scss resource
+    class Scss < Resource
+      attr_accessor :scss_pathname
+
+      def initialize(scss_pathname)
+        self.scss_pathname = scss_pathname
+      end
+
+      def write(dir, options = {})
+        PrettyDoc.mktmpdir do |tmppath|
+          tmpdir = Pathname.new(tmppath)
+          ::Compass.configuration.sass_path = scss_pathname.to_s
+          ::Compass.configuration.css_path = tmpdir.to_s
+
+          update_project = ::Compass::Commands::UpdateProject.new(
+            PrettyDoc.root.join('tmp').to_s,
+            quiet: true
+          )
+
+          update_project.perform
+
+          tmpdir.children.each do |child|
+            relative_pathname = child.relative_path_from(tmpdir)
+            FileUtils.cp(child, File.join(dir, relative_pathname))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pretty_doc/resources/source.rb

@@ -0,0 +1,46 @@
+require 'pretty_doc/resource'
+
+module PrettyDoc
+  class Resource
+    # Source Resource
+    class Source < Resource
+      attr_accessor :content, :basename
+
+      def initialize(file, converter, options)
+        self.file = file
+        extname = File.extname(file)
+        self.basename = File.basename(file, extname)
+        converter.content = File.read(self.file)
+        converter.options = options
+        self.content = converter.as_html
+      end
+
+      def write(target_dir, options = {})
+        template = options[:template]
+        result = template.render(content: content)
+        target = File.join(target_dir, "#{basename}.html")
+        File.open(target, 'w') { |f| f << result }
+        template.write_assets(target_dir)
+        puts "Create File: #{target}"
+      end
+
+      def self.build(options)
+        puts 'Converting files ...'
+        output_dir = options.output
+        options.files.each do |file|
+          extname = File.extname(file)
+          converter_class = PrettyDoc::Converter.descendants.find do |klass|
+            klass.perfer_exts.include?(extname)
+          end
+          if converter_class
+            converter = converter_class.new
+            result = new(file, converter, options)
+            result.write(output_dir, options)
+          else
+            puts 'No corresponding converter found!'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pretty_doc/template.rb

@@ -0,0 +1,44 @@
+require 'pretty_doc/resources/scss'
+require 'erb'
+
+module PrettyDoc
+  # Base Template class
+  class Template
+    attr_accessor :dir
+
+    class << self
+      def register(name, theme)
+        @pool ||= {}
+        @pool[name] = theme
+      end
+
+      def get(name)
+        @pool ||= {}
+        @pool[name]
+      end
+    end
+
+    def theme_file_pathname(file)
+      dir.join(file)
+    end
+
+    def assets
+      [Resource::Scss.new(dir)]
+    end
+
+    def render(hash)
+      erb_file = theme_file_pathname('template.html.erb')
+      template = ERB.new(erb_file.read)
+
+      @content = hash[:content]
+      @title = hash[:title]
+      template.result(binding)
+    end
+
+    def write_assets(dir)
+      assets.each do |asset|
+        asset.write(dir)
+      end
+    end
+  end
+end

data/lib/pretty_doc/version.rb

@@ -0,0 +1,3 @@
+module PrettyDoc
+  VERSION = '1.0.0'
+end

data/lib/pretty_doc.rb

@@ -0,0 +1,75 @@
+require 'pathname'
+require 'fileutils'
+
+module PrettyDoc
+end
+
+require 'pretty_doc/version'
+require 'pretty_doc/template'
+require 'pretty_doc/converters/markdown'
+require 'pretty_doc/resources/source'
+
+# PrettyDoc Module
+module PrettyDoc
+  def self.template(name)
+    @template_loaded = false
+    try_load_template_from_gem name
+    try_load_template_from_dir name
+    try_load_template_from_defaults name
+    tmpl = Template.get(File.basename(name))
+    if @template_loaded && tmpl
+      tmpl
+    else
+      puts "No valid template '#{name}' found"
+      exit
+    end
+  end
+
+  def self.try_load_template_from_gem(name = '')
+    unless @template_loaded
+      begin
+        require name
+        @template_loaded = true
+      rescue LoadError
+        @template_loaded = false
+      end
+    end
+  end
+
+  def self.try_load_template_from_dir(name = '')
+    if !@template_loaded && Dir.exist?(File.expand_path(name))
+      begin
+        require File.join(File.expand_path(name), 'init.rb')
+        @template_loaded = true
+      rescue LoadError
+        @template_loaded = false
+      end
+    end
+  end
+
+  def self.try_load_template_from_defaults(name = '')
+    unless @template_loaded
+      begin
+        require PrettyDoc.root.join('templates', name, 'init.rb')
+        @template_loaded = true
+      rescue LoadError
+        @template_loaded = false
+      end
+    end
+  end
+
+  def self.root
+    Pathname.new(File.expand_path('../../', __FILE__))
+  end
+
+  def self.tmpdir
+    PrettyDoc.root.join('tmp')
+  end
+
+  def self.mktmpdir
+    FileUtils.mkdir_p(tmpdir)
+    Dir.mktmpdir(nil, tmpdir) do |tmpdir|
+      yield(tmpdir)
+    end
+  end
+end