RubyGems - markita - Versions diffs - 4.1.230214 → 6.0.250327 - Mend

markita 4.1.230214 → 6.0.250327

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

checksums.yaml +4 -4
data/README.md +194 -237
data/bin/markita +16 -19
data/lib/markita/base.rb +37 -38
data/lib/markita/config.rb +41 -10
data/lib/markita/html.rb +35 -20
data/lib/markita/markdown/attributes.rb +23 -0
data/lib/markita/markdown/blockquote.rb +41 -0
data/lib/markita/markdown/code.rb +44 -0
data/lib/markita/markdown/code_block.rb +29 -0
data/lib/markita/markdown/definitions.rb +42 -0
data/lib/markita/markdown/embed.rb +63 -0
data/lib/markita/markdown/empty.rb +22 -0
data/lib/markita/markdown/fold.rb +39 -0
data/lib/markita/markdown/footnotes.rb +28 -0
data/lib/markita/markdown/form.rb +125 -0
data/lib/markita/markdown/heading.rb +33 -0
data/lib/markita/markdown/horizontal_rule.rb +25 -0
data/lib/markita/markdown/image.rb +60 -0
data/lib/markita/markdown/inline.rb +123 -0
data/lib/markita/markdown/list.rb +65 -0
data/lib/markita/markdown/markup.rb +23 -0
data/lib/markita/markdown/script.rb +28 -0
data/lib/markita/markdown/split.rb +38 -0
data/lib/markita/markdown/table.rb +52 -0
data/lib/markita/markdown.rb +51 -498
data/lib/markita/plug/about.rb +28 -17
data/lib/markita/plug/favicon.rb +14 -10
data/lib/markita/plug/highlight.rb +18 -12
data/lib/markita/plug/login.rb +35 -28
data/lib/markita/plug/navigation.rb +4 -1
data/lib/markita/plug/plugs.rb +7 -1
data/lib/markita/plug/readme.rb +8 -4
data/lib/markita/preprocess.rb +52 -23
data/lib/markita/refinement.rb +21 -0
data/lib/markita/requires.rb +29 -0
data/lib/markita.rb +15 -24
metadata +52 -116

data/lib/markita/config.rb CHANGED Viewed

@@ -1,21 +1,52 @@
-module Markita
-  OPTIONS ||= nil
+# frozen_string_literal: true
+# Markita namespace
+# :reek:TooManyConstants because it's a configuration file!
+module Markita
   HEADER_LINKS = ''
-  NAVIGATION = ''
+  NAVIGATION   = ''
+  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 =
+    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
-  ROOT = File.expand_path OPTIONS&.root || '~/vimwiki'
-  raise 'Missing site root directory: '+ROOT unless File.directory? ROOT
-  APPDIR = File.dirname __dir__, 2
+  SERVER_CONFIG = lambda do |server|
+    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+/)]
+  NOT_FOUND = File.read PATH['not_found.html']
-  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 CHANGED Viewed

@@ -1,25 +1,40 @@
+# frozen_string_literal: true
+# Markita namespace
 module Markita
-module HTML
-  def self.header(key)
-    <<~HEADER
-      <!DOCTYPE html>
-      <html>
-      <head>
-        <title>#{key}</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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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

data/lib/markita/markdown/fold.rb ADDED Viewed

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    # :reek:DuplicateMethodCall
+    module Fold
+      RGX = /^[-.]{3} #/
+      METADATA = /^(\w+): (.*)$/
+      def self.scrape4metadata(line, metadata, attributes)
+        if (md = Fold::METADATA.match(line))
+          if (key = md[1]) == 'attributes'
+            attributes.push " #{md[2]}"
+          else
+            metadata[key] = md[2]
+          end
+        end
+      end
+    end
+    @@parsers << :fold
+    # category: method
+    # :reek:DuplicateMethodCall ok here
+    def fold
+      return false unless Fold::RGX.match?(@line)
+      # Fold with optional metadata
+      until Fold::RGX.match?(line_gets)
+        Fold.scrape4metadata(@line, @metadata, @attributes)
+      end
+      line_gets
+      true
+    end
+  end
+end

data/lib/markita/markdown/footnotes.rb ADDED Viewed

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Footnotes
+      RGX = /^\[\^\d+\]:/
+    end
+    @@parsers << :footnotes
+    # :reek:TooManyStatements
+    def footnotes
+      return false unless (continue = Footnotes::RGX.match?(@line))
+      @html << "<small>\n"
+      while continue
+        @html << "#{inline(@line.chomp)}<br>\n"
+        continue = Footnotes::RGX.match?(line_gets)
+      end
+      @html << "</small>\n"
+      true
+    end
+  end
+end

data/lib/markita/markdown/form.rb ADDED Viewed

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Form
+      field = '(\w+:)?\[(\*)?(\w+)(=("[^"]+")(,"[^"]+")*)?\]'
+      FIELD = Regexp.new field
+      RGX = /^!( #{field})+/
+      POST = /!$/
+      ACTION = /\(([^()]*)\)!?$/
+      def self.input_select(field, name, values)
+        %(  #{field}:<select name="#{name}">\n).tap do |html|
+          values.each do |value|
+            html << %(    <option value="#{value}">#{value}</option>\n)
+          end
+          html << "  </select>\n"
+        end
+      end
+      def self.input_text(field, type, name)
+        %(  #{field}:<input type="#{type}" name="#{name}">\n)
+      end
+      # :reek:LongParameterList :reek:TooManyStatements
+      def self.input(type, field, name, values)
+        if field
+          if values.empty? then input_text(field, type, name)
+          elsif values.count > 1 then input_select(field, name, values)
+          else
+            input_defaulted(field, type, name, values)
+          end
+        elsif name == 'submit' then input_submit(values)
+        else
+          input_hidden(name, values)
+        end
+      end
+      def self.input_submit(values)
+        %(  <input type="submit" value="#{values[0] || 'Submit'}">\n)
+      end
+      def self.input_hidden(name, values)
+        %(  <input type="hidden" name="#{name}" value="#{values[0]}">\n)
+      end
+      # :reek:LongParameterList
+      def self.input_defaulted(field, type, name, values)
+        <<-INPUT
+  #{field}:<input type="#{type}" name="#{name}"
+    value="#{values[0]}">
+        INPUT
+      end
+      def self.match?(line) = RGX.match?(line)
+      # :reek:ControlParameter :reek:NilCheck :reek:LongParameterList
+      def self.maybe(yon, name, field, values)
+        return :NO if yon == :NO || (field.nil? && name == 'submit')
+        return yon unless field && values.count < 2
+        yon == :yes ? :no : :YES
+      end
+      # :reek:LongYieldList :reek:TooManyStatements
+      def self.scan(line)
+        line.scan(FIELD).each do |field, pwd, name, value|
+          field &&= field[0...-1]
+          values = value ? value[2...-1].split('","') : []
+          type = pwd ? 'password' : 'text'
+          yield field, type, name, values
+        end
+      end
+      def self.start(line, attributes)
+        method = POST.match?(line) ? ' method="post"' : ''
+        action = (mdt = ACTION.match(line)) ? %( action="#{mdt[1]}") : ''
+        %(<form#{action}#{method}#{attributes.shift}>\n)
+      end
+      def self.stop = %(</form>\n)
+      # :reek:ControlParameter
+      def self.submit(yon)
+        case yon
+        when :yes
+          %(  <input type="submit">\n)
+        when :YES
+          %(  <br>\n  <input type="submit">\n)
+        else
+          ''
+        end
+      end
+    end
+    @@parsers << :form
+    # category: method
+    # :reek:TooManyStatements
+    # rubocop:disable Metrics/MethodLength
+    def form
+      return false unless Form.match?(@line)
+      yon = :yes # Append submit button?
+      @html << Form.start(@line, @attributes)
+      loop do
+        Form.scan(@line) do |field, type, name, values|
+          yon = Form.maybe(yon, name, field, values)
+          @html << Form.input(type, field, name, values)
+        end
+        break unless Form.match?(line_gets)
+        @html << "  <br>\n"
+      end
+      @html << Form.submit(yon)
+      @html << Form.stop
+      true
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/markita/markdown/heading.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module Heading
+      RGX = /^(\#{1,6}) (.*)$/
+      def self.level_header(line)
+        mdt = RGX.match(line)
+        [mdt[1].length, mdt[2]] if mdt
+      end
+    end
+    @@parsers << :heading
+    # category: method
+    # :reek:TooManyStatements :reek:UncommunicativeVariableName
+    def heading
+      return false unless (n, header = Heading.level_header(@line))
+      id = header.gsub(/\([^()]*\)/, '').scan(/\w+/).join('+')
+      @html << %(<a id="#{id}">\n)
+      @html << "  <h#{n}#{@attributes.shift}>#{inline(header)}</h#{n}>\n"
+      @html << "</a>\n"
+      line_gets
+      true
+    end
+  end
+end

data/lib/markita/markdown/horizontal_rule.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# Markita top level namespace
+module Markita
+  # Markdown namespace
+  # :reek:InstanceVariableAssumption :reek:ClassVariable
+  class Markdown
+    # Module to isolate from Markdown
+    module HorizontalRule
+      RGX = /^---+$/
+    end
+    @@parsers << :horizontal_rule
+    # category: method
+    def horizontal_rule
+      return false unless HorizontalRule::RGX.match?(@line)
+      line_gets
+      # Display HR
+      @html << "<hr#{@attributes.shift}>\n"
+      true
+    end
+  end
+end