madness 0.9.9 → 1.0.0.rc2

data/lib/madness/document.rb

@@ -1,8 +1,5 @@
-require 'commonmarker'
-require 'coderay'
-
 module Madness
-  # Handle a single markdown document.
+  # Handle a single document path.
   class Document
     include ServerHelper
     using StringRefinements
@@ -18,12 +15,7 @@ module Madness
 
     # Return the HTML for that document
     def content
-      @content ||= content!
-    end
-
-    # Return the HTML for that document, force re-read.
-    def content!
-      %i[empty missing].include?(type) ? "<h1>#{title}</h1>" : markdown_to_html
+      @content ||= %i[empty missing].include?(type) ? "<h1>#{title}</h1>" : markdown.to_html
     end
 
   private
@@ -65,108 +57,11 @@ module Madness
     end
 
     def markdown
-      @markdown ||= pre_process_markdown
-    end
-
-    def pre_process_markdown
-      result = File.read file
-      result = evaluate_shortlinks result if config.shortlinks
-      result
-    end
-
-    def doc
-      @doc ||= CommonMarker.render_doc markdown, :DEFAULT, [:table]
-    end
-
-    # Convert markdown to HTML, with some additional processing:
-    # 1. Add anchors to headers
-    # 2. Syntax highilghting
-    # 3. Prepend H1 if needed
-    def markdown_to_html
-      replace_toc_marker
-      prepend_h1 if config.auto_h1
-      add_anchor_ids
-      html = doc.to_html :UNSAFE
-      html = syntax_highlight(html) if config.highlighter
-      html
-    end
-
-    # Add anchors with IDs before all headers
-    def add_anchor_ids
-      doc.walk do |node|
-        if node.type == :header
-          anchor = CommonMarker::Node.new(:inline_html)
-
-          next unless node.first_child.type == :text
-
-          anchor_id = node.first_child.string_content.to_slug
-          anchor.string_content = "<a id='#{anchor_id}'></a>"
-          node.prepend_child anchor
-        end
-      end
+      @markdown ||= MarkdownDocument.new(markdown_text, title: title)
     end
 
-    # Replace <!-- TOC --> with a Table of Contents for the page
-    def replace_toc_marker
-      toc_marker = doc.find do |node|
-        node.type == :html and node.string_content.include? '<!-- TOC -->'
-      end
-
-      return unless toc_marker
-
-      toc_marker.insert_after document_toc
-      toc_marker.insert_after CommonMarker.render_doc('## Table of Contents').first_child
-    end
-
-    # Replace [[link]] with [link](link)
-    def evaluate_shortlinks(raw)
-      raw.gsub(/\[\[([^\]]+)\]\]/) { "[#{$1}](#{$1.to_href})" }
-    end
-
-    # Returns a UL object containing the document table of contents
-    def document_toc
-      toc = []
-      doc.walk do |node|
-        next unless node.type == :header
-
-        level = node.header_level
-        next unless level.between? 2, 3
-
-        text = node.first_child.string_content
-        spacer = '  ' * (level - 1)
-        toc << "#{spacer}- [#{text}](##{text.to_slug})"
-      end
-
-      toc = toc.join "\n"
-      CommonMarker.render_doc(toc).first_child
-    end
-
-    # If the document does not start with an H1 tag, add it.
-    def prepend_h1
-      return unless doc.first_child
-      return if (doc.first_child.type == :header) && (doc.first_child.header_level == 1)
-
-      h1 = CommonMarker.render_doc("# #{title}").first_child
-      doc.first_child.insert_before h1
-    end
-
-    # Apply syntax highlighting with CodeRay. This will parse for any
-    # <code class='LANG'> sections in the HTML, pass it to CodeRay for
-    # highlighting.
-    # Since CodeRay adds another HTML escaping, on top of what RDiscount
-    # does, we unescape it before passing it to CodeRay.
-    #
-    # Open StackOverflow question:
-    # http://stackoverflow.com/questions/37771279/prevent-double-escaping-with-coderay-and-rdiscount
-    def syntax_highlight(html)
-      line_numbers = config.line_numbers ? :table : nil
-      opts = { css: :style, wrap: nil, line_numbers: line_numbers }
-      html.gsub(%r{<code class="language-(.+?)">(.+?)</code>}m) do
-        lang = $1
-        code = $2
-        code = CGI.unescapeHTML code
-        CodeRay.scan(code, lang).html opts
-      end
+    def markdown_text
+      @markdown_text ||= File.read file
     end
 
     def md_file?

data/lib/madness/exceptions.rb

@@ -0,0 +1,6 @@
+module Madness
+  class Interrupt < Interrupt; end
+  class Error < StandardError; end
+  class InitError < Error; end
+  class ConfigurationError < Error; end
+end

data/lib/madness/highlight_renderer.rb

@@ -0,0 +1,10 @@
+require 'redcarpet'
+require 'rouge'
+require 'rouge/plugins/redcarpet'
+
+module Madness
+  # Renderer with syntax highlighting support
+  class HighlightRenderer < Redcarpet::Render::HTML
+    include Rouge::Plugins::Redcarpet
+  end
+end

data/lib/madness/markdown_document.rb

@@ -0,0 +1,103 @@
+require 'redcarpet'
+
+module Madness
+  # Handle a pure markdown document.
+  class MarkdownDocument
+    include ServerHelper
+    using StringRefinements
+
+    attr_reader :markdown, :title
+
+    def initialize(markdown, title: nil)
+      @markdown = markdown
+      @title = title || ''
+    end
+
+    def text
+      @text ||= begin
+        result = markdown
+        result = parse_toc(result) if config.auto_toc
+        result = parse_shortlinks(result) if config.shortlinks
+        result = prepend_h1(result) if config.auto_h1
+        result
+      end
+    end
+
+    def to_html
+      @to_html ||= Redcarpet::Markdown.new(redcarpet_renderer, redcarpet_options).render text
+    end
+
+  private
+
+    def parse_toc(input)
+      input.gsub '<!-- TOC -->', toc
+    end
+
+    def parse_shortlinks(input)
+      input.gsub(/\[\[([^\]]+)\]\]/) { "[#{$1}](#{$1.to_href})" }
+    end
+
+    def prepend_h1(input)
+      return input if has_h1?(input)
+
+      "# #{title}\n\n#{input}"
+    end
+
+    def has_h1?(input)
+      lines = input.lines(chomp: true).reject(&:empty?)
+      return false if lines.empty?
+
+      lines[0].match(/^# \w+/) || (lines[1] && lines[0].match(/^\w+/) && lines[1].start_with?('='))
+    end
+
+    def redcarpet_options
+      @redcarpet_options ||= {
+        no_intra_emphasis:   true,
+        autolink:            true,
+        tables:              true,
+        fenced_code_blocks:  true,
+        strikethrough:       true,
+        space_after_headers: true,
+        superscript:         true,
+        underline:           true,
+        highlight:           true,
+        quote:               false,
+        footnotes:           true,
+      }
+    end
+
+    def redcarpet_renderer
+      redcarpet_handler.new with_toc_data: true
+    end
+
+    def redcarpet_handler
+      config.highlighter ? HighlightRenderer : Redcarpet::Render::HTML
+    end
+
+    def toc_caption
+      @toc_caption ||= if config.auto_toc.is_a?(String)
+        config.auto_toc
+      else
+        '## Table of Contents'
+      end
+    end
+
+    def toc
+      result = ["#{toc_caption}\n"]
+      markdown.lines(chomp: true).each do |line|
+        next unless line.start_with? '#'
+
+        matches = line.match(/^(?<level>\#{2,3})\s+(?<text>.+)/)
+        next unless matches
+
+        level = matches[:level].size - 1
+        text = matches[:text]
+
+        spacer = '  ' * level
+        result.push "#{spacer}- [#{text}](##{text.to_slug})"
+      end
+
+      result.join "\n"
+    end
+  end
+end

data/lib/madness/server_base.rb

@@ -36,7 +36,7 @@ module Madness
     end
 
     def self.set_basic_auth
-      use Rack::Auth::Basic, config.auth_realm do |username, password|
+      use Rack::Auth::Basic, config.auth_zone do |username, password|
         config.auth.split(':') == [username, password]
       end
     end

data/lib/madness/settings.rb

@@ -47,7 +47,9 @@ module Madness
       data[:expose_extensions] ? "*.{md,#{data[:expose_extensions].delete(' ')}}" : '*.md'
     end
 
-  private
+    def data
+      @data ||= defaults.merge(file_data)
+    end
 
     def defaults
       {
@@ -57,23 +59,21 @@ module Madness
         sidebar:           true,
         auto_h1:           true,
         auto_nav:          true,
+        auto_toc:          true,
         highlighter:       true,
-        line_numbers:      true,
         copy_code:         true,
         shortlinks:        false,
         toc:               nil,
         theme:             nil,
         open:              false,
         auth:              false,
-        auth_realm:        'Madness',
+        auth_zone:         'Restricted Documentation',
         expose_extensions: nil,
-        exclude:           [/^[a-z_\-0-9]+$/],
+        exclude:           ['^[a-z_\-0-9]+$'],
       }
     end
 
-    def data
-      @data ||= defaults.merge(file_data)
-    end
+  private
 
     def file_data
       result = if file_exist?

data/lib/madness/templates/madness.yml

@@ -20,12 +20,14 @@ auto_h1: true
 # append navigation to directory READMEs
 auto_nav: true
 
+# replace <!-- TOC --> in any file with its internal table of contents
+# set to true to enable it with the default '## Table of Contents' caption,
+# or set to any string that will be inserted before it as a caption.
+auto_toc: true
+
 # enable syntax highlighter for code snippets
 highlighter: true
 
-# enable line numbers for code snippets
-line_numbers: true
-
 # enable the copy to clipboard icon for code snippets
 copy_code: true
 
@@ -48,7 +50,7 @@ open: false
 auth: false
 
 # if auth is enabled, specify auth realm name
-auth_zone: Madness
+auth_zone: Restricted Documentation
 
 # show files with these extensions in the navigation and search, for example:
 # expose_extensions: pdf,docx,xlsx,txt

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = '0.9.9'
+  VERSION = '1.0.0.rc2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -25,137 +25,131 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: coderay
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: colsole
+  name: extended_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: commonmarker
+  name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.23.4
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.23.4
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: docopt
+  name: naturally
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: extended_yaml
+  name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: naturally
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
-  name: os
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: requires
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: requires
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -195,20 +189,20 @@ files:
 - app/public/css/main.css
 - app/public/css/main.css.map
 - app/public/favicon.ico
-- app/public/fonts/fontello.eot
-- app/public/fonts/fontello.svg
-- app/public/fonts/fontello.ttf
-- app/public/fonts/fontello.woff
-- app/public/fonts/fontello.woff2
+- app/public/font/fontello.eot
+- app/public/font/fontello.svg
+- app/public/font/fontello.ttf
+- app/public/font/fontello.woff
+- app/public/font/fontello.woff2
 - app/public/js/clipboard.js
 - app/public/js/vendor/clipboard.min.js
 - app/public/js/vendor/jquery.min.js
 - app/styles/_anchor.scss
 - app/styles/_breadcrumbs.scss
 - app/styles/_code.scss
-- app/styles/_coderay.scss
+- app/styles/_fontello.scss
+- app/styles/_footnotes.scss
 - app/styles/_general.scss
-- app/styles/_icons.scss
 - app/styles/_image.scss
 - app/styles/_keyboard.scss
 - app/styles/_line.scss
@@ -216,9 +210,12 @@ files:
 - app/styles/_manifest.scss
 - app/styles/_mixins.scss
 - app/styles/_nav.scss
+- app/styles/_rouge.scss
+- app/styles/_scrollbar.scss
 - app/styles/_search.scss
 - app/styles/_table.scss
 - app/styles/_typography.scss
+- app/styles/_variables.scss
 - app/styles/main.scss
 - app/views/_breadcrumbs.slim
 - app/views/_index_nav.slim
@@ -231,11 +228,17 @@ files:
 - lib/madness.rb
 - lib/madness/breadcrumbs.rb
 - lib/madness/browser.rb
-- lib/madness/command_line.rb
+- lib/madness/cli.rb
+- lib/madness/commands/base.rb
+- lib/madness/commands/config.rb
+- lib/madness/commands/server.rb
+- lib/madness/commands/theme.rb
 - lib/madness/directory.rb
-- lib/madness/docopt.txt
 - lib/madness/document.rb
+- lib/madness/exceptions.rb
+- lib/madness/highlight_renderer.rb
 - lib/madness/item.rb
+- lib/madness/markdown_document.rb
 - lib/madness/navigation.rb
 - lib/madness/refinements/array_refinements.rb
 - lib/madness/refinements/hash_refinements.rb
@@ -270,9 +273,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.3
 signing_key: 

data/app/public/fonts/fontello.svg

@@ -1,16 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<svg xmlns="http://www.w3.org/2000/svg">
-<metadata>Copyright (C) 2019 by original authors @ fontello.com</metadata>
-<defs>
-<font id="fontello" horiz-adv-x="1000" >
-<font-face font-family="fontello" font-weight="400" font-stretch="normal" units-per-em="1000" ascent="850" descent="-150" />
-<missing-glyph horiz-adv-x="1000" />
-<glyph glyph-name="export" unicode="&#xe800;" d="M750 60l0 56 100 82 0-188q0-20-15-35t-35-15l-750 0q-20 0-35 15t-15 35l0 550q0 22 14 36t36 14l288 0q-32-24-59-49t-39-39l-10-12-130 0 0-450 650 0z m-82 348q-166 0-242-41t-160-181q0 8 1 22t9 56 22 79 44 83 70 79 107 56 149 23l0 156 332-250-332-260 0 178z" horiz-adv-x="1000" />
-
-<glyph glyph-name="home" unicode="&#xe801;" d="M888 336q16-16 11-27t-27-11l-84 0 0-310q0-14-1-21t-8-13-23-6l-204 0 0 310-204 0 0-310-194 0q-28 0-35 10t-7 30l0 310-84 0q-22 0-27 11t11 27l400 402q16 16 38 16t38-16z" horiz-adv-x="900" />
-
-<glyph glyph-name="search-1" unicode="&#xe802;" d="M772 78q30-34 6-62l-46-46q-36-32-68 0l-190 190q-74-42-156-42-128 0-223 95t-95 223 90 219 218 91 224-95 96-223q0-88-46-162z m-678 358q0-88 68-156t156-68 151 63 63 153q0 88-68 155t-156 67-151-63-63-151z" horiz-adv-x="789" />
-</font>
-</defs>
-</svg>

data/app/styles/_coderay.scss

@@ -1,37 +0,0 @@
-.clipboard-button {
-  position: absolute;
-  right: 0;
-  font-size: 1.25em;
-  opacity: 0.2;
-  transition: opacity 0.3s;
-}
-
-table.CodeRay:hover .clipboard-button {
-  opacity: 1;
-  transition: opacity 0.3s;
-}
-
-table.CodeRay {
-  position: relative;
-  margin-bottom: 0;
-  
-  pre {
-    margin-bottom: 0;
-  }
-  
-  tr, td {
-    border: 0;
-    pre {
-      margin-left: 0;
-    }
-  }
-
-  td.line-numbers {
-    background: #eee;
-    padding: 4px;    
-  }
-
-  td.code {
-  }
-
-}