docwatch-bin 1.1.6 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fab5dc94d05d184be658795e8470af249f9fdb4f3e8c8e0f376bb194f456b26e
-  data.tar.gz: 444cb4d3d3259107828b72077c2d77850860b4b10926fe9f86fbecb23577af2c
+  metadata.gz: fa3e636f3b4e862d11696a5aea4b63df99c72bdd759eaeb07f09517653c32323
+  data.tar.gz: 20536056fbed0a73e38ffb614df419cc3497aae702c114a807de4893ffb09234
 SHA512:
-  metadata.gz: d9424eccb478f69d96c2353088c998188593fcd25ac217e66fe0b705bfe3320aa3afe9bdcae1fcb198805d8526f1c2d88a5b098b586062733b38248b953982b0
-  data.tar.gz: 7c494c2bfef056300b98bb76320646d87e03c7fba80aac0426b14990d814b8d7f21549cae527543868c9c57ea0b6db7027592e822a2f5479308d95318220340a
+  metadata.gz: f8987d0f03dd42ace0e7ad1ebdf4c8505968890f929f4af27ccb91b7b69f4f45aa9f0051d3228223feccf84de4b0b1c648963982776a0bc6e1bd9b8a9e299075
+  data.tar.gz: 325f71d82d130fc50b8ac7c688d5f85cd92a2119caccfd751d754257aa6c919e1fa554baa5f044a0ec52c964c01c4b39a449671cfed9a9a2d89865a7d2bc60db

data/bin/docwatch

@@ -86,7 +86,7 @@ class Main
             end
         end
 
-        puts ('Started server on %s, renderer %s' % [url, renderer.class]).yellow
+        puts 'Started server on %s, renderer %s'.yellow % [url, renderer.class]
         puts 'Press enter to open page in the default handler (xdg-open)'.green
 
         begin
@@ -95,21 +95,23 @@ class Main
             end
         rescue Interrupt
             puts
-            puts 'Bye'
+            puts 'Bye!'
         end
     end
 end
 
+PROGRAM_NAME = File.basename($PROGRAM_NAME)
+
 usage = <<~EOF
     Usage:
-        #{File.basename($0)} [options] <file-path>
-        #{File.basename($0)} ( --version | --help )
+        #{PROGRAM_NAME} [options] <file-path>
+        #{PROGRAM_NAME} ( --version | --help )
 
     Options:
         -p, --port=VALUE    Listen port [default: 8888]
         --verbose           Be verbose
         -v, --version       Show version
-        -h, --help          Show this help
+        -h, --help          Show help
 
     Renderers:
         markdown    (.md)

data/lib/docwatch/parser/frontmatter.rb

@@ -0,0 +1,37 @@
+module Docwatch
+    class Parser::Frontmatter < Parser
+        def self.split(str)
+            lines = str.lines
+
+            if lines.first.chomp != '---'
+                return [nil, str]
+            end
+
+            in_frontmatter = false
+            in_document = false
+            document = ''
+            frontmatter_yaml = ''
+
+            lines.each do |line|
+                if line.strip == '---'
+                    in_frontmatter = !in_frontmatter
+                    in_document = true if !in_frontmatter
+                elsif in_frontmatter
+                    frontmatter_yaml += line
+                elsif in_document
+                    document += line
+                end
+            end
+
+            [Frontmatter.new(frontmatter_yaml), document]
+        end
+
+        def initialize(yaml) # rubocop:disable Lint/MissingSuper
+            @data = YAML.safe_load(yaml)
+        end
+
+        def to_html
+            Util::HTML.render(@data)
+        end
+    end
+end

data/lib/docwatch/parser.rb

@@ -0,0 +1,4 @@
+module Docwatch
+    class Parser # rubocop:disable Lint/EmptyClass
+    end
+end

data/lib/docwatch/renderer/html.rb

@@ -1,5 +1,5 @@
 module Docwatch
-    class HtmlRenderer < Renderer
+    class Renderer::Html < Renderer
         extension :html
 
         def doc

data/lib/docwatch/renderer/markdown.rb

@@ -1,5 +1,5 @@
 module Docwatch
-    class MarkdownRenderer < Renderer
+    class Renderer::Markdown < Renderer
         extension :md
 
         def head
@@ -13,13 +13,35 @@ module Docwatch
         end
 
         def body
-            Redcarpet::Markdown.new(
-                Redcarpet::Render::HTML,
+            # https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use
+            markdown_args = {
                 fenced_code_blocks: true,
-                autolink: true,
                 tables: true,
+                no_intra_emphasis: true,
+                strikethrough: true,
+                space_after_headers: true,
+                superscript: true,
+                highlight: true,
                 footnotes: true,
-            ).render(contents)
+            }
+
+            # https://github.com/vmg/redcarpet#darling-i-packed-you-a-couple-renderers-for-lunch
+            html_args = {
+                with_toc_data: true,
+                link_attributes: { rel: 'noreferrer nofollow noopener' },
+                hard_wrap: true, # no need for trailing spaces to create new paragraphs
+            }
+
+            frontmatter, document = Parser::Frontmatter.split(contents)
+
+            if frontmatter
+                document = frontmatter.to_html + document
+            end
+
+            Redcarpet::Markdown.new(
+                Redcarpet::Render::HTML.new(html_args),
+                markdown_args,
+            ).render(document)
         end
     end
 end

data/lib/docwatch/util/html.rb

@@ -0,0 +1,22 @@
+module Docwatch
+    module Util
+        class HTML
+            def self.render(data)
+                case data
+                when Hash
+                    rows = data.map do |(k, v)|
+                        '<th>%s</th><td>%s</td>' % [HTML.render(k), HTML.render(v)]
+                    end.join('</tr><tr>')
+                    '<table><tr>%s</tr></table>' % rows
+                when Array
+                    rows = data.map do |v|
+                        '<li>%s</li>' % HTML.render(v)
+                    end.join
+                    '<ul>%s</ul>' % rows
+                else
+                    CGI.escapeHTML(data.to_s)
+                end
+            end
+        end
+    end
+end

data/lib/docwatch/version.rb

@@ -1,3 +1,3 @@
 module Docwatch
-    VERSION = '1.1.6'
+    VERSION = '2.0.1'
 end

data/lib/docwatch.rb

@@ -6,6 +6,8 @@ require 'docopt'
 
 require 'ostruct'
 require 'socket'
+require 'yaml'
+require 'cgi'
 
 module Docwatch
     def self.root_dir

data/res/github-markdown.css

@@ -428,30 +428,3 @@
     background-color: initial;
     border: 0
 }
-
-.container .csv-data td,
-.container .csv-data th {
-    padding: 5px;
-    overflow: hidden;
-    font-size: 12px;
-    line-height: 1;
-    text-align: left;
-    white-space: nowrap
-}
-
-.container .csv-data .blob-num {
-    padding: 10px 8px 9px;
-    text-align: right;
-    background: #fff;
-    border: 0
-}
-
-.container .csv-data tr {
-    border-top: 0
-}
-
-.container .csv-data th {
-    font-weight: 600;
-    background: #f6f8fa;
-    border-top: 0
-}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docwatch-bin
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 2.0.1
 platform: ruby
 authors:
 - crdx
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -133,17 +133,20 @@ files:
 - lib/docwatch.rb
 - lib/docwatch/connection.rb
 - lib/docwatch/logger.rb
+- lib/docwatch/parser.rb
+- lib/docwatch/parser/frontmatter.rb
 - lib/docwatch/renderer.rb
 - lib/docwatch/renderer/html.rb
 - lib/docwatch/renderer/markdown.rb
 - lib/docwatch/session.rb
+- lib/docwatch/util/html.rb
 - lib/docwatch/version.rb
 - lib/docwatch/watcher.rb
 - res/github-markdown.css
 - res/inject.js
 homepage: https://github.com/crdx/docwatch
 licenses:
-- MIT
+- GPLv3
 metadata:
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -161,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.23
 signing_key:
 specification_version: 4
 summary: Preview markdown documents in the browser with reload on change