markita 5.0.241001 → 6.0.251015

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3ec2273b3a06985b04dbcaa4e4cc190ad724b78a95614715bc940d762f0603
-  data.tar.gz: 45313726512a832f997d4ea3ac16e7be4839a448de674eeabfe62817ddd7128f
+  metadata.gz: 21a67b87c8ca2df79de3be5215aed19ab62ca227d98605929b64d45a14e1ff98
+  data.tar.gz: 86d8fa6166dbc759f1e456799123baa492deaacaab3c7d248526785598252d0c
 SHA512:
-  metadata.gz: 75a93470a33b67d868ed1fabac90b0d6a111f1f2c3e028534ffdc5ce434d8361103e8fa27249c4f34e347c3de57dc8806bd221351bc8abf75396ad9a1500f8bb
-  data.tar.gz: d1180313131e3487558c863cdd6817c401e37ddd36bc64ad1821eb082a11c432bed0f0eb055dc34a9bb75c68129a0a109e721bd4132efc072a6ca4583c2d655f
+  metadata.gz: 998cc045c833cb56073639f7bf40f61a1234338453d12f43f0c5c853473910cf4d9d04a74869df6f7150e2237464a85255506f1fa4e9152e60a048ee7ac64593
+  data.tar.gz: 1101459bb6b8ac05fb3c9dd7c45c5c3102e568f9d73e5b100daf95dd54c69eba7c4d364667053903184cf9348ab2796afc3290e33f06ef58c6890efecede33e9

data/CREDITS.md

@@ -0,0 +1,20 @@
+# Credits
+
+We want to credit where credit is due.
+This project owes thanks to the authors of this repository (see their commits),
+the third-party libraries we rely on (check the dependencies),
+and the diffuse pool of ideas and inspirations that shaped it.
+
+We welcome contributions to this list!
+If you feel someone or something is missing,
+please submit a pull request with the suggested addition.
+
++ [VimWiki](https://github.com/vimwiki/vimwiki): VimWiki is a personal wiki for Vim 
++ [GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github): Main specs target
+
+And then many alternate specs for Markdown:
+
+* [adam-p: Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
+* [lifeparticle: Markdown-Cheatsheed](https://github.com/lifeparticle/Markdown-Cheatsheet)
+* [CommonMark Spec](https://spec.commonmark.org/)
+* [CommonMark Cheat Sheet](https://commonmark.org/help/)

data/README.md

@@ -1,6 +1,6 @@
 # Markita
 
-* [VERSION 5.0.241001](https://github.com/carlosjhr64/markita/releases)
+* [VERSION 6.0.251015](https://github.com/carlosjhr64/markita/releases)
 * [github](https://www.github.com/carlosjhr64/markita)
 * [rubygems](https://rubygems.org/gems/markita)
 
@@ -14,6 +14,8 @@ With many extra non-standard features.
 ```console
 $ gem install markita
 ```
+* Required Ruby version: `>= 3.4`
+
 ## HELP
 ```console
 $ markita --help
@@ -25,27 +27,21 @@ Options:
   --port=PORT      	 8080
   --theme=THEME    	 base16.light
   --allowed=IPS
-  --no_about
-  --no_favicon
-  --no_highlight
-  --no_login
-  --no_navigation
-  --no_plugs
-  --no_readme
-Exclusive:
-  no_login allowed
+  --no=PLUGS
 Types:
   DIRECTORY /^~?[\/\w\.]+$/
   BIND      /^[\w\.]+$/
   PORT      /^\d+$/
   IPS       /^[\d\.\,]+$/
   THEME     /^[\w\.]+$/
+  PLUGS    /^[\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.
+# You can use the --no option to list plugins to disable.
 ```
 ## FEATURES
 
@@ -58,16 +54,25 @@ Types:
 * HTML pass through on `/^<.*>$/` lines
 * And more...
 
-### Horizontal rule with meta-data
+### Meta-data
 
-* If `Title` is set via meta-data, the server will set the page's title to that
+* `$key` substitution to its metadata value in text
+* If `Title` is set via meta-data, Javascript will set the page's title to that
 * One can use numbers to reference long URLs
 ```markdown
----
+--- # The hashtag disambiguates the horizontal rule(legal YAML comment).
 Title: Markita
 1: https://github.com/carlosjhr64/markita
----
+name: Don Quixote de la Mancha
+# You can also add to attributes here:
+attributes: style="color: darkgreen;"
+... # The end marker is needed to end the fold
 [Markita](1)
+Your name is $name.
+```
+### Horizontal rule
+```markdown
+---
 ```
 ### Attributes
 ```markdown
@@ -211,9 +216,15 @@ A multi-line form with default entry and hidden field:
 
 A selection list:
 ! Color:[color="Red","White","Blue"]
+
+A submit button:
+! [submit="Go!"]
 ```
 ### Template substitutions
 ```markdown
+! regx = /^This (?<word>\w+)/
+This cat is a pussy&word;.
+
 ! template = "* [&query;](https://www.google.com/search?q=&QUERY;)"
 ! regx = /^\* (?<query>.*)$/
 * Grumpy Cat
@@ -232,6 +243,10 @@ The *bold* and "italics" ~strikes~ at _underlined_,
 while a [link to #Markita](#Markita)
 sees the `~ code ~ "a*b*c"` to https://github.com.
 ```
+The inline links with optional title have the following syntax(with no double quotes):
+```markdown
+[link text](link title)
+```
 ### Entity escapes
 
 When you want to escape the inline substitutions or HTML tags, use backslash:
@@ -295,7 +310,7 @@ $ GET https://raw.githubusercontent.com/carlosjhr64/markita/main/plug/todotxt.rb
 ```
 ## LICENSE
 
-Copyright (c) 2024 CarlosJHR64
+Copyright (c) 2025 CarlosJHR64
 
 Permission is hereby granted, free of charge,
 to any person obtaining a copy of this software and
@@ -318,3 +333,5 @@ 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.
+
+## [CREDITS](CREDITS.md)

data/bin/markita

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'help_parser'
 require 'markita'
 
@@ -11,38 +13,33 @@ OPTIONS = HelpParser[Markita::VERSION, <<~HELP]
     --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
+    --no=PLUGS
   Types:
     DIRECTORY /^~?[\\/\\w\\.]+$/
     BIND      /^[\\w\\.]+$/
     PORT      /^\\d+$/
     IPS       /^[\\d\\.\\,]+$/
     THEME     /^[\\w\\.]+$/
+    PLUGS    /^[\\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.
+  # You can use the --no option to list plugins to disable.
 HELP
 begin
+  Markita.no.concat OPTIONS.no.split(',').map(&:to_sym) if OPTIONS.no?
   Markita.run!
-rescue LoadError
-  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
-  exit 72
-rescue RuntimeError
-  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
-  exit 65
-rescue
-  warn $!.backtrace
-  HelpParser::REDTTY["#{$!.class}: #{$!.message}"]
-  exit 70
+rescue LoadError => e
+  HelpParser::REDTTY["#{e.class}: #{e.message}"]
+  exit 72 # EX_OSFILE
+rescue RuntimeError => e
+  HelpParser::REDTTY["#{e.class}: #{e.message}"]
+  exit 65 # EX_DATAERR: generic runtime error raised, usually due to user error.
+rescue StandardError => e
+  warn e.backtrace
+  HelpParser::REDTTY["#{e.class}: #{e.message}"]
+  exit 70 # EX_SOFTWARE
 end

data/lib/markita/base.rb

@@ -1,40 +1,47 @@
+# frozen_string_literal: true
+
+# Markita namespace
 module Markita
-class Base < Sinatra::Base
-  set sessions: true
-  set bind: OPTIONS.bind || BIND
-  set port: OPTIONS.port || PORT
-  set server: SERVER
-  set server_settings: SERVER_SETTINGS if SERVER_SETTINGS
+  # Base class of the Sinatra Markita application
+  class Base < Sinatra::Base
+    set sessions: true
+    set bind: BIND
+    set port: PORT
+    set server: SERVER
+    set server_settings: SERVER_SETTINGS if SERVER_SETTINGS
 
-  def self.run!
-    super {SERVER_CONFIG[_1]}
-  end
+    def self.run!
+      super { SERVER_CONFIG[it] }
+    end
 
-  get PAGE_KEY do |key|
-    filepath = File.join ROOT, key+MDX
-    raise Sinatra::NotFound unless File.exist? filepath
-    Markdown.new(key).filepath filepath
-  end
+    get PAGE_KEY do |key|
+      filepath = File.join ROOT, key + MDX
+      raise Sinatra::NotFound unless File.exist? filepath
 
-  get SEND_FILE do |path|
-    pass unless params.length==1 &&
-                (filepath=File.join ROOT, path) &&
-                File.exist?(filepath)
-    send_file filepath
-  end
+      Markdown.new(key).filepath filepath
+    end
 
-  get '/' do
-    filepath = File.join ROOT, INDEX+MDX
-    if File.exist? filepath
-      Markdown.new(INDEX).filepath filepath
-    else
-      redirect '/about.html' unless OPTIONS.no_about
-      raise Sinatra::NotFound
+    # For the server to send a static file, the request may only specify a path
+    # (no query string) and the file must exist... Else, it passes.
+    get SEND_FILE do |path|
+      pass unless params.length == 1 &&
+                  (filepath = File.join ROOT, path) &&
+                  File.exist?(filepath)
+      send_file filepath
+    end
+
+    get '/' do
+      filepath = File.join ROOT, INDEX + MDX
+      if File.exist? filepath
+        Markdown.new(INDEX).filepath filepath
+      else
+        redirect '/about.html' unless Markita.no.include? :about
+        raise Sinatra::NotFound
+      end
     end
-  end
 
-  not_found do
-    NOT_FOUND
+    not_found do
+      NOT_FOUND
+    end
   end
 end
-end

data/lib/markita/config.rb

@@ -1,43 +1,52 @@
+# frozen_string_literal: true
+
+# Markita namespace
+# :reek:TooManyConstants because it's a configuration file!
 module Markita
   HEADER_LINKS = ''
   NAVIGATION   = ''
 
-  BIND   = '0.0.0.0'
-  PORT   = '8080'
+  BIND   = OPTIONS.bind || '0.0.0.0'
+  PORT   = OPTIONS.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')
-
-  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
+  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')
+  SERVER_SETTINGS =
+    if [ssl_certificate, ssl_private_key].all? { File.exist? it }
+      {
+        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))
+      }
+    end
 
   SERVER_CONFIG = lambda do |server|
-    puts "#{$0}-#{VERSION}"
-    puts "Sinatra-#{Sinatra::VERSION} using #{server.class}"
+    puts "#{$PROGRAM_NAME}-#{VERSION}".blue
+    puts "Sinatra-#{Sinatra::VERSION} using #{server.class}".blue
   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}
+    [ROOT, APPDATA].map { File.join it, basename }.detect { File.exist? it }
   end
 
   NOT_FOUND = File.read PATH['not_found.html']
 
-  EMOJIS = Hash[*File.read(PATH['emojis.tsv']).split(/\s+/)]
-
-  PAGE_KEY  = %r{/(\w[\w/-]*\w)}
+  PAGE_KEY  = %r{/(\w[\w/-]*\w)} # Note that it starts with a slash
   SEND_FILE = %r{/(\w[\w/-]*\w\.\w+)}
 
   START_TIME = Time.now

data/lib/markita/html.rb

@@ -1,25 +1,40 @@
+# frozen_string_literal: true
+
+# Markita namespace
 module Markita
-module HTML
-  def self.header(title)
-    <<~HEADER
-      <!DOCTYPE html>
-      <html>
-      <head>
-      <title>#{title}</title>#{HEADER_LINKS}
-      </head>
-      <body>
-    HEADER
-  end
+  # HTML template
+  # :reek:ClassVariable
+  # rubocop:disable Style/ClassVars
+  module Html
+    # category: header
 
-  def self.navigation
-    NAVIGATION
-  end
+    def self.header(title)
+      <<~HEADER
+        <!DOCTYPE html>
+        <html>
+        <head>
+        <title>#{title}</title>
+        #{@@header_links}</head>
+        <body>
+      HEADER
+    end
+
+    @@header_links = String.new(HEADER_LINKS)
+    def self.header_links = @@header_links
 
-  def self.footer
-    <<~FOOTER
-      </body>
-      </html>
-    FOOTER
+    # category: body
+
+    @@navigation = String.new(NAVIGATION)
+    def self.navigation = @@navigation
+
+    # category: footer
+
+    def self.footer
+      <<~FOOTER
+        </body>
+        </html>
+      FOOTER
+    end
   end
-end
+  # rubocop:enable Style/ClassVars
 end

data/lib/markita/markdown/attributes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Attributes
+      RGX = /^\{:( [^{}]+)\}/
+    end
+
+    @@parsers << :attributes
+
+    def attributes
+      return false unless (md = Attributes::RGX.match(@line))
+
+      @attributes.push md[1]
+      @line = md.post_match
+      true
+    end
+  end
+end

data/lib/markita/markdown/blockquote.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Blockquote
+      RGX = /^( {0,3})> (.*)$/
+
+      def self.level_quote(line)
+        mdt = RGX.match(line)
+        [mdt[1].length, mdt[2]] if mdt
+      end
+    end
+
+    @@parsers << :blockquote
+
+    # category: method
+    # :reek:DuplicateMethodCall :reek:TooManyStatements
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Lint/UselessAssignment
+    def blockquote
+      return false unless (level, quote = Blockquote.level_quote(@line))
+
+      @html << "<blockquote#{@attributes.shift}>\n"
+      current = level
+      while current.eql?(level)
+        @html << "#{inline(quote)}\n"
+        # `quote` is being used... Code is just gnarly.
+        current, quote = Blockquote.level_quote(line_gets)
+        next unless current&.>(level)
+
+        blockquote
+        level, quote = Blockquote.level_quote(@line)
+      end
+      @html << "</blockquote>\n"
+      true
+    end
+    # rubocop:enable Lint/UselessAssignment
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/markita/markdown/code.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Code
+      RGX = /^`{3}\s*(\w+)?$/
+
+      def self.code(file, lang, code = String.new)
+        # Note that we can ignore the final shifted
+        # line because it will be the closing fence.
+        while (line = file.gets) && !RGX.match?(line)
+          code << line
+        end
+        lang ? ROUGE.format(lang.new.lex(code)) : code
+      end
+
+      def self.klass_lang(line)
+        if (mdt = RGX.match(line))
+          lang = Rouge::Lexer.find(mdt[1])
+          klass = lang ? ' class="highlight"' : ''
+          [klass, lang]
+        end
+      end
+    end
+
+    @@parsers << :code
+
+    # category: method
+    # :reek:TooManyStatements
+    def code
+      return false unless (klass, lang = Code.klass_lang(@line))
+
+      @html << "<pre#{klass}#{@attributes.shift}><code>\n"
+      @html << Code.code(@line_getter, lang)
+      @html << "</code></pre>\n"
+      line_gets
+      true
+    end
+  end
+end

data/lib/markita/markdown/code_block.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module CodeBlock
+      RGX = /^ {4}(.*)$/
+    end
+
+    @@parsers << :code_block
+
+    # category: method
+    # :reek:TooManyStatements
+    def code_block
+      return false unless (md = CodeBlock::RGX.match(@line))
+
+      @html << "<pre#{@attributes.shift}>\n"
+      while md
+        @html << "#{md[1]}\n"
+        md = CodeBlock::RGX.match(line_gets)
+      end
+      @html << "</pre>\n"
+      true
+    end
+  end
+end

data/lib/markita/markdown/definitions.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Definitions
+      RGX = /^[+]\s+(\S.+)$/
+      def self.phrase(line)
+        mdt = RGX.match(line)
+        mdt[1] if mdt
+      end
+
+      def self.split(phrase)
+        return [phrase.chop, nil] if /:$/.match?(phrase)
+        return [nil, phrase] unless (mdt = /^(.*): +(\S.*)$/.match(phrase))
+
+        [mdt[1], mdt[2]]
+      end
+    end
+
+    @@parsers << :definitions
+
+    # category: method
+    # :reek:TooManyStatements
+    def definitions
+      return false unless (phrase = Definitions.phrase(@line))
+
+      @html << "<dl#{@attributes.shift}>\n"
+      while phrase
+        term, definition = Definitions.split(phrase)
+        @html << "<dt>#{inline term}</dt>\n" if term
+        @html << "<dd>#{inline definition}</dd>\n" if definition
+        phrase = Definitions.phrase(line_gets)
+      end
+      @html << "</dl>\n"
+      true
+    end
+  end
+end

data/lib/markita/markdown/embed.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Embed
+      RGX = /^!> (#{PAGE_KEY}\.\w+)$/
+
+      def self.code(filename, lang)
+        code = File.read(filename)
+        lang ? ROUGE.format(lang.new.lex(code)) : code
+      end
+
+      # :reek:TooManyStatements
+      def self.ext_klass_lang(filename, lang = nil)
+        extension = filename.split('.').last
+        unless extension == 'html'
+          lang = Rouge::Lexer.find(extension) unless extension == 'txt'
+          klass = lang ? ' class="highlight"' : ''
+          return [true, klass, lang]
+        end
+        [false, nil, nil]
+      end
+
+      def self.filename(line)
+        if (mdt = RGX.match(line))
+          mdt[1]
+        end
+      end
+    end
+
+    @@parsers << :embed
+
+    # category: method
+    # :reek:TooManyStatements
+    # rubocop:disable Metrics/MethodLength
+    def embed
+      return false unless (filename = Embed.filename(@line))
+
+      if File.exist?(filename = File.join(ROOT, filename))
+        code, klass, lang = Embed.ext_klass_lang(filename)
+        if code
+          @html << "<pre#{klass}#{@attributes.shift}>"
+          @html << '<code>' if lang
+          @html << "\n"
+        end
+        @html << Embed.code(filename, lang)
+        if code
+          @html << '</code>' if lang
+          @html << "</pre>\n"
+        end
+      else
+        @html << @line
+      end
+      line_gets
+      true
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end