markita 4.1.230116 → 5.0.241001

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e00a9566251da73346583e54ae03f74b7251a5d4a43ca5c5b553b0b3179fb4e2
-  data.tar.gz: 9e5e0d48d1aee16600af6033a58008c9cb24ff49cf85b12f37d47737f49194eb
+  metadata.gz: cd3ec2273b3a06985b04dbcaa4e4cc190ad724b78a95614715bc940d762f0603
+  data.tar.gz: 45313726512a832f997d4ea3ac16e7be4839a448de674eeabfe62817ddd7128f
 SHA512:
-  metadata.gz: 16b8d905d43fd810dc2f68aa0640be8be6ab7a2ebe51da42492c567cfdf01296ea5f4aeb676a36367274b1402b97428d848dea7db0c8a097e09b4afa1a4eaad9
-  data.tar.gz: ef8c0b4a38c07feada1e16b47280b4ab49e24eb3a95cdbbfdfa2578bdae11ed0618aafa426aa76a884b4e897fb7ddc5441ac060fd0b0b37f6d408fbd9b6f1c8d
+  metadata.gz: 75a93470a33b67d868ed1fabac90b0d6a111f1f2c3e028534ffdc5ce434d8361103e8fa27249c4f34e347c3de57dc8806bd221351bc8abf75396ad9a1500f8bb
+  data.tar.gz: d1180313131e3487558c863cdd6817c401e37ddd36bc64ad1821eb082a11c432bed0f0eb055dc34a9bb75c68129a0a109e721bd4132efc072a6ca4583c2d655f

data/README.md

@@ -1,6 +1,6 @@
 # Markita
 
-* [VERSION 4.1.230116](https://github.com/carlosjhr64/markita/releases)
+* [VERSION 5.0.241001](https://github.com/carlosjhr64/markita/releases)
 * [github](https://www.github.com/carlosjhr64/markita)
 * [rubygems](https://rubygems.org/gems/markita)
 
@@ -49,197 +49,51 @@ Types:
 ```
 ## FEATURES
 
-### Ballot boxes
-
-- [ ] Empty ballot
-- [x] Marked ballot
-
-Markdown:
-
-    - [ ] Empty ballot
-    - [x] Marked ballot
-
-### Image placement
-
-Markdown:
-
-    ![:Centered Image:](/img/image.png)
-    ![Left Floating:](/img/image.png)
-    ![:Right Floating](/img/image.png)
-    Image  centered above.
-    Image to the left.
-    Image to the right.
-    And set a HR bar below.
-    ---
-
-### Image size
-
-Markdown:
-
-    ![In alt text say 100x100](/img/image.png)
-
-### Image link
-
-Markdown:
-
-    ![Alt text](/img/image.png /href_to/page)
-
-### Forms
-
-Markdown:
-
-    A get method form without submit button on single field:
-    ! Google:[q] (https://www.google.com/search)
-
-    A post method form with a password field
-    and a submit button due to multiple fields.
-    Note the `*` in front of `pwd` marking it as a password field,
-    and the ending `!` marking the route as a post:
-    ! Username:[user] Password:[*pwd] (/login.html)!
-
-    A multi-line form with default entry and hidden field:
-    ! Name:[user] [status="active"] (/register.html)
-    ! Address:[address]
-    ! Code:[code="1234"]
-
-    A selection list:
-    ! Color:[color="Red","White","Blue"]
-
-### Template substitutions
-
-Markdown:
-
-    ! template = "* [&query;](https://www.google.com/search?q=&QUERY;)"
-    ! regx = /^\* (?<query>.*)$/
-    * Grumpy Cat
-    * It's over 9000!
-
-Template clears after first non-match.
-Note: on upcased keys, value is CGI escaped.
-
-### Split table
-
-<table><tr><td>
-<p>
-Top left
-</p>
-</td><td>
-<p>
-Top center
-</p>
-</td><td>
-<p>
-Top right
-</p>
-</td></tr><tr><td>
-<p>
-Middle left
-</p>
-</td><td>
-<p>
-Middle center
-</p>
-</td><td>
-<p>
-Middle left
-</p>
-</td></tr><tr><td>
-<p>
-Bottom left
-</p>
-</td><td>
-<p>
-Bottom center
-</p>
-</td><td>
-<p>
-Bottom right
-</p>
-</td></tr></table>
-
-Markdown:
-
-    |:
-    Top left
-    |
-    Top center
-    |
-    Top right
-    :|:
-    Middle left
-    |
-    Middle center
-    |
-    Middle left
-    :|:
-    Bottom left
-    |
-    Bottom center
-    |
-    Bottom right
-    :|
-
-### Inline links, code, bold, italic, strikes, and underline
-
-<p>
-The <b>bold</b> and <i>italics</i> <s>strikes</s> at <u>underlined</u>, while a
-<a href="#Markita">link to #Markita</a>
-sees the <code>~ code ~ "a*b*c"</code> to
-<a href="https://github.com">https://github.com</a>.
-</p>
-
-Markdown:
-
-    The *bold* and "italics" ~strikes~ at _underlined_,
-    while a [link to #Markita](#Markita)
-    sees the `~ code ~ "a*b*c"` to [https://github.com].
-
-### Lists: ordered, un-ordered, definitions
+* `#` Headers with link anchors
+* `>` Block-quotes nests up to level three
+* &#96;&#96;&#96; Code section highlighted by [Rouge](https://github.com/rouge-ruby/rouge)
+* PRE-forms on text starting with four spaces
+* Tables
+* Script section pass through starts with `^<script` and ends with `^</script>`
+* HTML pass through on `/^<.*>$/` lines
+* And more...
+
+### Horizontal rule with meta-data
+
+* If `Title` is set via meta-data, the server will set the page's title to that
+* One can use numbers to reference long URLs
+```markdown
+---
+Title: Markita
+1: https://github.com/carlosjhr64/markita
+---
+[Markita](1)
+```
+### Attributes
+```markdown
+{: style="color: blue;"}
+You can set the attributes for most blocks.
+```
+### Lists
 
+One can nest lists up to 3 levels:
+```markdown
+{: style="color: red;"}{: style="color: green;"}{: style="color: blue;"}
 1. One
 2. Two
-
-* Point A
-* Point B
-
-<dl>
-<dt>Word</dt>
-<dd>Definition of the word</dd>
-<dt>Symbol</dt>
-<dd>Usage for the symbol</dd>
-</dl>
-
-Markdown:
-
-    1. One
-    2. Two
-
-    * Point A
-    * Point B
-
-    + Word: Definition of the word
-    + Symbol:
-    +   Usage for the symbol
-
-### Block-quote
-
-Like Hamlet says...
-> To be or not to be...
-> That is the question!
-
-Markdown:
-
-    Like Hamlet says...
-    > To be or not to be...
-    > That is the question!
-
-### Code
-```ruby
-def wut
-  puts "Wut?"
-end
+ * ABC
+  - [ ] Empty ballot
+  - [x] Marked ballot
+ * XYZ
+3. Three
 ```
-Markdown:
+### Definitions
+```markdown
++ Word: Definition
++ Slang:
++ Define slang
+```
+### Code
 
     ```ruby
     def wut
@@ -253,62 +107,152 @@ Markdown:
 | ------: | ----: | :----: | :------------ |
 |       1 |   1.0 |   $    | The word      |
 |    1234 |  12.3 |   &    | On the street |
+```markdown
+| Integer | Float | Symbol | Word          |
+| ------: | ----: | :----: | :------------ |
+|       1 |   1.0 |   $    | The word      |
+|    1234 |  12.3 |   &    | On the street |
+```
+### Splits table
 
-Markdown:
-
-    | Integer | Float | Symbol | Word          |
-    | ------: | ----: | :----: | :------------ |
-    |       1 |   1.0 |   $    | The word      |
-    |    1234 |  12.3 |   &    | On the street |
-
-### Attributes
-
-Markdown:
-
-    {: style="color: blue;"}
-    You can set the attributes for most blocks.
+<table><tr><td>
+<p> Top left </p>
+</td><td>
+<p> Top center </p>
+</td><td>
+<p> Top right </p>
+</td></tr><tr><td>
+<p> Middle left </p>
+</td><td>
+<p> Middle center </p>
+</td><td>
+<p> Middle left </p>
+</td></tr><tr><td>
+<p> Bottom left </p>
+</td><td>
+<p> Bottom center </p>
+</td><td>
+<p> Bottom right </p>
+</td></tr></table>
 
+```markdown
+|:
+Top left
+|
+Top center
+|
+Top right
+:|:
+Middle left
+|
+Middle center
+|
+Middle left
+:|:
+Bottom left
+|
+Bottom center
+|
+Bottom right
+:|
+```
+### Image placement
+```markdown
+![:Centered Image:](/img/image.png)
+![Left Floating:](/img/image.png)
+![:Right Floating](/img/image.png)
+Image  centered above.
+Image to the left.
+Image to the right.
+```
+### Image size
+```markdown
+![In alt text say 100x100](/img/image.png)
+```
+### Image link
+```markdown
+![Alt text](/img/image.png /href_to/page)
+```
 ### Embed text
-
-Markdown:
-
-    !> /path-to/ascii_art.txt
-
+```markdown
+!> /path-to/ascii_art.txt
+```
 Useful for ASCII art.
 Unless an `*.html` file, the text is embedded in `pre` tags.
 Further more unless a `*.txt` file, the text is embedded in `code` tags.
 
-### Emojis
-
-I :heart: to :laughing:!
-
-Markdown:
+### Footnotes
+```markdown
+There once was a man from Nantucket[^1]  
+Who kept all his cash[^2] in a bucket.  
+But his daughter, named Nan,  
+Ran away with a man  
+And as for the bucket, Natucket.[^3]
+
+[^1]: Nantucket is an island in the U.S. state of Massachusetts.
+[^2]: Cash is money in currency.
+[^3]: Read as "Nan took it."
+```
+### Forms
+```markdown
+A get method form without submit button on single field:
+! Google:[q] (https://www.google.com/search)
+
+A post method form with a password field
+and a submit button due to multiple fields.
+Note the `*` in front of `pwd` marking it as a password field,
+and the ending `!` marking the route as a post:
+! Username:[user] Password:[*pwd] (/login.html)!
+
+A multi-line form with default entry and hidden field:
+! Name:[user] [status="active"] (/register.html)
+! Address:[address]
+! Code:[code="1234"]
+
+A selection list:
+! Color:[color="Red","White","Blue"]
+```
+### Template substitutions
+```markdown
+! template = "* [&query;](https://www.google.com/search?q=&QUERY;)"
+! regx = /^\* (?<query>.*)$/
+* Grumpy Cat
+* It's over 9000!
+```
+Template clears after first non-match.
+Note: on upcased keys, value is CGI escaped.
 
-    I :heart: to :laughing:!
+### Inline links, code, bold, italic, strikes, and underline
 
-### Footnotes
+The <b>bold</b> and <i>italics</i> <s>strikes</s> at <u>underlined</u>,
+while a [link to #Markita](#Markita)
+sees the `~ code ~ "a*b*c"` to https://github.com.
+```markdown
+The *bold* and "italics" ~strikes~ at _underlined_,
+while a [link to #Markita](#Markita)
+sees the `~ code ~ "a*b*c"` to https://github.com.
+```
+### Entity escapes
 
-Markdown:
+When you want to escape the inline substitutions or HTML tags, use backslash:
 
-    There once was a man from Nantucket[^1]  
-    Who kept all his cash[^2] in a bucket.  
-    But his daughter, named Nan,  
-    Ran away with a man  
-    And as for the bucket, Natucket.[^3]
+* &#92;&#60; &#92;&#62;  &#92;&#42; &#92;&#34; &#92;&#126; &#92;&#96; &#92;&#38; &#92;&#59; &#92;&#92;
 
-    [^1]: Nantucket is an island in the U.S. state of Massachusetts.
-    [^2]: Cash is money in currency.
-    [^3]: Read as "Nan took it."
+### Emojis
 
-### Meta-data
+I :heart: to :laughing:!
+```markdown
+I :heart: to :laughing:!
+```
+### Superscript and subscript
 
-Markdown:
+This is <sup>superscript</sup> and this is <sub>subscript</sub>.
+```markdown
+This is \^(superscript) and this is \(subscript).
+```
+### It's all Ruby!
 
-    ---
-    Title: The Title You Want For Your Page
-    1: https://way.to/create/ref/links
-    ---
-    You can now [link](1) with a reference number.
+Add your own custom features.
 
 ## HOW-TOs
 
@@ -351,7 +295,7 @@ $ GET https://raw.githubusercontent.com/carlosjhr64/markita/main/plug/todotxt.rb
 ```
 ## LICENSE
 
-Copyright 2023 CarlosJHR64
+Copyright (c) 2024 CarlosJHR64
 
 Permission is hereby granted, free of charge,
 to any person obtaining a copy of this software and

data/bin/markita

@@ -2,36 +2,36 @@
 require 'help_parser'
 require 'markita'
 
-OPTIONS = HelpParser[Markita::VERSION, <<HELP]
-Usage:
-  markita [:options+]
-Options:
-  --root=DIRECTORY \t ~/vimwiki
-  --bind=BIND      \t 0.0.0.0
-  --port=PORT      \t 8080
-  --theme=THEME    \t base16.light
-  --allowed=IPS
-  --no_about
-  --no_favicon
-  --no_highlight
-  --no_login
-  --no_navigation
-  --no_plugs
-  --no_readme
-Exclusive:
-  no_login allowed
-Types:
-  DIRECTORY /^~?[\\/\\w\\.]+$/
-  BIND      /^[\\w\\.]+$/
-  PORT      /^\\d+$/
-  IPS       /^[\\d\\.\\,]+$/
-  THEME     /^[\\w\\.]+$/
-# NOTE:
-# Assuming site is in ~/vimwiki,
-# when ~/vimwiki/.valid-id is set with a sha256sum of a password,
-# that password will restrict the site.
-# Allowed IPs bypass the need for site password
-# when the site is accessed from those locations.
+OPTIONS = HelpParser[Markita::VERSION, <<~HELP]
+  Usage:
+    markita [:options+]
+  Options:
+    --root=DIRECTORY \t ~/vimwiki
+    --bind=BIND      \t 0.0.0.0
+    --port=PORT      \t 8080
+    --theme=THEME    \t base16.light
+    --allowed=IPS
+    --no_about
+    --no_favicon
+    --no_highlight
+    --no_login
+    --no_navigation
+    --no_plugs
+    --no_readme
+  Exclusive:
+    no_login allowed
+  Types:
+    DIRECTORY /^~?[\\/\\w\\.]+$/
+    BIND      /^[\\w\\.]+$/
+    PORT      /^\\d+$/
+    IPS       /^[\\d\\.\\,]+$/
+    THEME     /^[\\w\\.]+$/
+  # NOTE:
+  # Assuming site is in ~/vimwiki,
+  # when ~/vimwiki/.valid-id is set with a sha256sum of a password,
+  # that password will restrict the site.
+  # Allowed IPs bypass the need for site password
+  # when the site is accessed from those locations.
 HELP
 begin
   Markita.run!
@@ -41,8 +41,8 @@ rescue LoadError
 rescue RuntimeError
   HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
   exit 65
-rescue Exception
-  $stderr.puts $!.backtrace
+rescue
+  warn $!.backtrace
   HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
   exit 70
 end

data/lib/markita/base.rb

@@ -1,42 +1,34 @@
 module Markita
 class Base < Sinatra::Base
-  set bind: OPTIONS&.bind || '0.0.0.0'
-  set port: OPTIONS&.port || '8080'
   set sessions: true
+  set bind: OPTIONS.bind || BIND
+  set port: OPTIONS.port || PORT
+  set server: SERVER
+  set server_settings: SERVER_SETTINGS if SERVER_SETTINGS
 
-  def Base.run!
-    puts "#{$0}-#{VERSION}"
-    super do |server|
-      if ['.cert.crt', '.pkey.pem'].all?{ File.exist? File.join(ROOT, _1)}
-        server.ssl = true
-        server.ssl_options = {
-          :cert_chain_file  => File.join(ROOT, '.cert.crt'),
-          :private_key_file => File.join(ROOT, '.pkey.pem'),
-          :verify_peer      => false,
-        }
-      end
-    end
+  def self.run!
+    super {SERVER_CONFIG[_1]}
   end
 
   get PAGE_KEY do |key|
-    filepath = File.join ROOT, key+'.md'
-    raise Sinatra::NotFound  unless File.exist? filepath
+    filepath = File.join ROOT, key+MDX
+    raise Sinatra::NotFound unless File.exist? filepath
     Markdown.new(key).filepath filepath
   end
 
   get SEND_FILE do |path|
-    pass unless params.length==1 and
-                filepath = File.join(ROOT, path) and
+    pass unless params.length==1 &&
+                (filepath=File.join ROOT, path) &&
                 File.exist?(filepath)
     send_file filepath
   end
 
   get '/' do
-    filepath = File.join ROOT, 'index.md'
+    filepath = File.join ROOT, INDEX+MDX
     if File.exist? filepath
-      Markdown.new('index').filepath filepath
+      Markdown.new(INDEX).filepath filepath
     else
-      redirect '/about.html'  unless OPTIONS&.no_about
+      redirect '/about.html' unless OPTIONS.no_about
       raise Sinatra::NotFound
     end
   end

data/lib/markita/config.rb

@@ -1,22 +1,44 @@
 module Markita
-  OPTIONS ||= nil
-
   HEADER_LINKS = ''
-  NAVIGATION = ''
+  NAVIGATION   = ''
+
+  BIND   = '0.0.0.0'
+  PORT   = '8080'
+  SERVER = 'webrick'
+
+  MDX = '.md'
+  INDEX = 'index'
+
+  ROOT = File.expand_path OPTIONS.root || '~/vimwiki'
+  raise 'Missing site root directory: '+ROOT unless File.directory? ROOT
+
+  SSL_CERTIFICATE = File.join(ROOT, '.cert.crt')
+  SSL_PRIVATE_KEY = File.join(ROOT, '.pkey.pem')
 
-  ROOT = File.expand_path OPTIONS&.root || '~/vimwiki'
-  raise "Missing site root directory: "+ROOT  unless File.directory? ROOT
-  APPDIR = File.dirname File.dirname __dir__
+  SERVER_SETTINGS = [SSL_CERTIFICATE, SSL_PRIVATE_KEY].all?{File.exist?_1} ?
+    { SSLEnable: true,
+      SSLVerifyClient: OpenSSL::SSL::VERIFY_NONE,
+      SSLCertificate: OpenSSL::X509::Certificate.new(File.read SSL_CERTIFICATE),
+      SSLPrivateKey:  OpenSSL::PKey::RSA.new(File.read SSL_PRIVATE_KEY) } : nil
+
+  SERVER_CONFIG = lambda do |server|
+    puts "#{$0}-#{VERSION}"
+    puts "Sinatra-#{Sinatra::VERSION} using #{server.class}"
+  end
+
+  APPDIR  = File.dirname __dir__, 2
   APPDATA = File.join APPDIR, 'data'
+
   PATH = lambda do |basename|
     [ROOT, APPDATA].map{ File.join _1, basename}.detect{ File.exist? _1}
   end
+
   NOT_FOUND = File.read PATH['not_found.html']
 
   EMOJIS = Hash[*File.read(PATH['emojis.tsv']).split(/\s+/)]
 
-  PAGE_KEY  = %r{/(\w[\w\/\-]*\w)}
-  SEND_FILE = %r{/(\w[\w\/\-]*\w\.\w+)}
+  PAGE_KEY  = %r{/(\w[\w/-]*\w)}
+  SEND_FILE = %r{/(\w[\w/-]*\w\.\w+)}
 
   START_TIME = Time.now
 end

data/lib/markita/html.rb

@@ -1,21 +1,21 @@
 module Markita
 module HTML
-  def HTML.header(key)
+  def self.header(title)
     <<~HEADER
       <!DOCTYPE html>
       <html>
       <head>
-        <title>#{key}</title>
-      #{HEADER_LINKS}</head>
+      <title>#{title}</title>#{HEADER_LINKS}
+      </head>
       <body>
     HEADER
   end
 
-  def HTML.navigation
+  def self.navigation
     NAVIGATION
   end
 
-  def HTML.footer
+  def self.footer
     <<~FOOTER
       </body>
       </html>