markita 5.0.241001 → 6.0.250327

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3ec2273b3a06985b04dbcaa4e4cc190ad724b78a95614715bc940d762f0603
-  data.tar.gz: 45313726512a832f997d4ea3ac16e7be4839a448de674eeabfe62817ddd7128f
+  metadata.gz: 9ed48aca2238e0b8ac390519ddc7d4c0e8e5e6f798b87a7654da9454f5f92cd3
+  data.tar.gz: bfec77d804b3e803c282e4581c6ac7008a716ad0c2d91c2e9dca170b9ecb987a
 SHA512:
-  metadata.gz: 75a93470a33b67d868ed1fabac90b0d6a111f1f2c3e028534ffdc5ce434d8361103e8fa27249c4f34e347c3de57dc8806bd221351bc8abf75396ad9a1500f8bb
-  data.tar.gz: d1180313131e3487558c863cdd6817c401e37ddd36bc64ad1821eb082a11c432bed0f0eb055dc34a9bb75c68129a0a109e721bd4132efc072a6ca4583c2d655f
+  metadata.gz: 4feb3c5ba26177dc86f27ab90599c120a3d0631f24d5919d28efacb39edd7bbdb5d6a76d9eb28ee852ec0b0bfdfc41ea3097b82f1bdc29d533686f95756bb13f
+  data.tar.gz: b8dfe46d0853061fe8d7d8a666e1c102b249a12cd3ad26558b05ebe5893d899b03add66fe8d9da41fd984e27e7d158cb0b69d1967e7fe365f703c2e2ba74ae20

data/README.md

@@ -1,6 +1,6 @@
 # Markita
 
-* [VERSION 5.0.241001](https://github.com/carlosjhr64/markita/releases)
+* [VERSION 6.0.250327](https://github.com/carlosjhr64/markita/releases)
 * [github](https://www.github.com/carlosjhr64/markita)
 * [rubygems](https://rubygems.org/gems/markita)
 
@@ -25,27 +25,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 +52,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 +214,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 +241,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 +308,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

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,41 @@
+# 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
+    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"
+        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 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.+)$/
+      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

data/lib/markita/markdown/empty.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Empty
+      RGX = /^$/
+    end
+
+    @@parsers << :empty
+
+    def empty
+      return false unless Empty::RGX.match?(@line)
+
+      line_gets
+      true
+    end
+  end
+end