qdoc 0.0.22 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59b6ef3449df0454bfa9313eb121ffbace6679cf
-  data.tar.gz: eb7b2affec88066b4db7cef3d7d86899cbc967b8
+  metadata.gz: 8d15f985461e6968951af4faa1cd89f97e176a6a
+  data.tar.gz: 800dbc887390648b3a60f7a403b41b5dd2c8f863
 SHA512:
-  metadata.gz: a6230718eddf17992f06e34d66cfb0ae4c07490ead8c0f93224922780c32227c9202b867e225f8bdb9de8db71094b8980c180e9b3fae547550d1e723e56bfdc3
-  data.tar.gz: 4d426858a2ec112af37cb1fe8adc22ece458c79e2e4283de344ae306caa5ed09e907a49ea01baa120d6dd152395769d52edd4e9bfb72d005759b5350c29cb222
+  metadata.gz: fc7674660a98508ec3b4cc10cbe49a71e4702fac92774f9bac0cd0592c8f90e79b4a4dc7cb949938e74b97c9ec85b1b89f9ac1e311f2bd83b018f8ae4e29549f
+  data.tar.gz: 2f89b14f7ade0106202a65389b3a5c6a6d05fe2e1193f5e046f9490e2e5aca1c30f0e278019a7d4e1b3e04bd07cefb405cd87b536b6105c1617f9400d1cb3f9c

data/lib/qdoc.rb

@@ -2,100 +2,106 @@
 require 'redcarpet'
 require 'kramdown'
 require 'fileutils'
+require 'cgi'
 
 class QDoc
-  
-  def initialize
-    @documents = [ { file: "index.html", title: "index", file: "index.html", content: "Choose from the left nav.", directory: "", parse: false } ]
-    # @locations = [ "accomplishments", "cio-staff", "one-on-one", "team-staff"]
+
+  def initialize( options = {} )
+    defaults = { output_directory: "doc", index_content: "Choose from the left nav." }
+    options = defaults.merge options
+    @out_dir = options[:output_directory]
+
+    @index = { file: "index.html", title: "index", extension: "html", content: options[:index_content], directory: nil, output_file: "index.html", parse: false }
+    
+    @documents = Array.new
     @locations = Array.new
-    @out_dir = "doc"
     @redcarpet = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :autolink => true, :space_after_headers => true)
   end
-  
+
   def run
-    search_for_files
-    stage_files( @locations )
+    @locations = identify_locations
+    @documents = stage_files( @locations )
     nav = create_nav( @documents )
-    index = nil
+    # index = nil
     make_doc_directory
     @documents.each do |doc|
-      index = doc if doc[:title] == "index"
-      next if !doc[:parse]
-      doc[:content] = parse_file( "#{doc[:directory]}/#{doc[:filename]}")
-      write_file( "#{@out_dir}/#{doc[:directory]}-#{doc[:file]}", create_page(nav, doc[:content]) )
-      # write_file( "#{@out_dir}/#{doc[:file]}", create_page(nav, doc[:content]) )
+      doc[:content] = parse_document( doc ) if doc[:parse] #"#{doc[:directory]}/#{doc[:filename]}")
+      write_file( "#{@out_dir}/#{doc[:output_file]}", create_page(nav, doc[:content]) )
     end
-    write_file( "#{@out_dir}/#{index[:file]}", create_page(nav, create_index))
     copy_bootstrap
-    # create_custom_css
   end
-  
+
   private
-  
+
   def make_doc_directory
     if !File.directory?(@out_dir)
       FileUtils.mkdir_p(@out_dir)
     end
   end
-  
-  def search_for_files
-    @locations << "" # Current directory
-    Dir.foreach('./') do |leaf|
-      next if leaf =~ /\A\./ || leaf == @out_dir || leaf =~ /\.rb\z/
-      @locations << leaf if File.directory?(leaf)
+
+  def identify_locations
+    locations = [""] # Current directory
+    Dir.foreach('./') do |node|
+      next if node =~ /\A\./ || node == @out_dir # || leaf =~ /\.rb\z/
+      locations << node if File.directory?(node)
     end
+    locations
   end
-  
+
   def create_index
     page = "<div class='col-md-8'><p>Choose from the left navigation to select a document</p>" + \
-           "<p>#{@documents.count-1} files parsed from the following locations:<p>" + \
-           "<table class='table table-striped'><tbody>"
+    "<p>#{@documents.count-1} files parsed from the following locations:<p>" + \
+    "<table class='table table-striped'><tbody>"
     @locations.each do |l|
       l = "Current Dir" if l == ""
       page += "<tr><td>#{l}</td></tr>"
     end
     page += "</tbody></table></div>"
   end
-  
+
   def stage_files( locations )
-    locations.each do |l|
-      Dir.foreach("./#{l}") do |leaf|
-        next if leaf !~ /(.*)\.(txt|md|rc)\z/
-        filehead = $~.captures[0]
-        file_ext = $~.captures[1]
-        filename = filehead + "." + file_ext
-        @documents << { directory: l, filename: filename, file: filehead + ".html", title: filename, content: nil, parse: true }
-        # p @documents.last
+    documents = [ @index ]
+    locations.each do |dir|
+      Dir.foreach("./#{dir}") do |node|
+        node.match(/(?<name>.*)\.(?<ext>txt|md|rc)\z/) do |match|
+          filehead = match[:name]
+          file_ext = match[:ext]
+          filename = filehead + "." + file_ext
+          documents << { directory: dir, filename: filename, extension: file_ext, file: filehead + ".html", title: filename, content: nil, parse: true, output_file: "#{dir}-#{filename}.html" }
+        end
       end
     end
+    documents
   end
-  
-  def fix_tables( html )
+
+  def bootstrap_tables( html )
     html.gsub('<table>', '<table class="table">')
   end
 
-  def parse_file( filename )
+  def parse_document( doc )
+    filename = doc[:directory] == "" ? doc[:filename] : "#{doc[:directory]}/#{doc[:filename]}"
     contents = File.open( filename, "r" ) do |c|
       c.read 
     end
-    contents = fix_hawaiian( contents )
-    case File.extname(filename)
-    when ".md"
-      return Kramdown::Document.new( contents ).to_html
-    when ".rc"
-      return @redcarpet.render( contents )
-    when ".txt"
-      return @redcarpet.render( contents )
+    # contents = fix_hawaiian CGI::escapeHTML contents
+    case doc[:extension]
+    when "md"
+      return fix_hawaiian Kramdown::Document.new( CGI::escapeHTML  contents ).to_html
+    when "rc"
+      return @redcarpet.render( fix_hawaiian CGI::escapeHTML contents )
+    when "txt"
+      return @redcarpet.render( fix_hawaiian CGI::escapeHTML contents )
+    when "html"
+      return contents
     else
       nil
     end
   end
-  
+
   def copy_bootstrap
     FileUtils.cp( File.dirname(__FILE__) + "/bootstrap.min.css", "#{@out_dir}/bootstrap.min.css" )
   end
-  
+
   def fix_hawaiian( text )
     text.gsub("ʻ", "&#8216;").gsub("ā", "&#257;").gsub("ē","&#275;").gsub("ī", "&#299;").gsub("ō","&#333;").gsub("ū", "&#363;").gsub("Ā", "&#256;").gsub("Ē","&#274;").gsub("Ī", "&#298;").gsub("Ō", "&#332;").gsub("Ū", "&#362;")
   end
@@ -103,42 +109,42 @@ class QDoc
   def create_page( nav, content )
     "<!DOCTYPE html>
     <html>
-      <head>
-        <title>My Documents</title>
-        <link href='bootstrap.min.css' rel='stylesheet'>
-      </head>
-      <body>
-        <div class='row'>
-          <div class='col-md-3'>" + \
-            nav + \
-          "</div>
-           <div class='col-md-9'>" + \
-             content + \
-          "</div>
-        </div>
-      </body>"
+    <head>
+    <title>My Documents</title>
+    <link href='bootstrap.min.css' rel='stylesheet'>
+    </head>
+    <body>
+    <div class='row'>
+    <div class='col-md-3'>" + \
+    nav + \
+    "</div>
+    <div class='col-md-9'>" + \
+    content + \
+    "</div>
+    </div>
+    </body>"
   end
 
   def create_nav( documents )
-    snippet = "<table class='table'>
-      <thead>
-        <tr>
-          <th>Documents</th>
-        </tr>
-      </thead>
-      <tbody>"
+    snippet = "<table class='table table-striped'>
+    <thead>
+    <tr>
+    <th>Location</th><th>Document</th>
+    </tr>
+    </thead>
+    <tbody>"
     documents.each do |doc|
       snippet += "<tr>
-        <td><a href='#{doc[:directory]}-#{doc[:file]}'>#{doc[:directory]} : #{doc[:title]}</a></td>
+      <td>#{doc[:directory]}</td><td><a href='#{doc[:output_file]}'>#{doc[:title]}</a></td>
       </tr>"
     end
     snippet += "</tbody></table>"
     snippet
   end
-  
+
   def write_file( filename, content )
     File.open(filename, "w") do |o|
-      o.write( fix_tables(content) )
+      o.write( bootstrap_tables(content) )
       o.close
     end
   end  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
 platform: ruby
 authors:
 - Patrick Sereno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet