minimal_markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f513dd2b70e6b64938c16b2c1ab15c2ba24e57dcdad5a8ac1ecacefc0cbdc8e
+  data.tar.gz: a313ef705ff4a74d5cb516505d2c472e4149746cc4f9cb2c51864d75a39c5369
+SHA512:
+  metadata.gz: 8e15301d1ccf20fec7ff5efa8634e41b41280b0157ee1d7ee070a718c226c04c3f1a0aaf2999f1d94589aac75f55519c4d8e94dd7afcfa1e91c9b5e152207e23
+  data.tar.gz: 6e849f0eb968d5fb994ec33d792554eb4d081ff7b74b97360449138cae18c99b001a537c152ec703c9cc67ce5b867531dc9df530433cc9396d4f908f1041cfa1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    minimal_markdown (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minimal_markdown!
+  rspec (~> 3.8.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright 2019 Roger Nesbitt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 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.

data/README.md

@@ -0,0 +1,29 @@
+# MinimalMarkdown
+
+A lightweight and minimal Ruby implementation of a Markdown renderer,
+designed with security in mind.
+
+Tiny codebase, no dependencies, and HTML is rendered from a tree so no
+possibility of user-supplied HTML sneaking into the output.
+
+## Supported Markdown elements
+
+* Unordered lists
+* Bold
+* Italic
+* Paragraphs
+
+## Usage
+
+Add to your Gemfile:
+
+```
+gem 'minimal_markdown'
+```
+
+Add to your app:
+
+```
+MinimalMarkdown.render('Here is my *markdown*')
+=> "<div>Here is my <b>markdown</b></div>"
+```

data/lib/minimal_markdown/html_renderer.rb

@@ -0,0 +1,15 @@
+module MinimalMarkdown
+  class HtmlRenderer
+    attr_reader :tree
+
+    def initialize(tree)
+      @tree = tree
+    end
+
+    def render
+      output = ''
+      tree.each { |node| node.render(output) }
+      output
+    end
+  end
+end

data/lib/minimal_markdown/implementors.rb

@@ -0,0 +1,88 @@
+module MinimalMarkdown
+  class ImplementorBase
+    def multiline?
+      false
+    end
+
+    def update_tree(tree)
+      tree.each { |node| update_node(node) }
+    end
+
+    private
+
+    def update_node(node)
+      if node.is_a?(Text)
+        if node.text.is_a?(Array)
+          update_tree(node.text)
+        else
+          out = []
+          input = node.text
+          while result = input.match(@regex)
+            out << Text.new(result.pre_match + result[1]) unless result.pre_match.empty?
+            out << @node_class.new(Text.new(result[2]))
+            input = result[3] + result.post_match
+          end
+
+          if !out.empty?
+            out << Text.new(input) unless input.empty?
+            node.text = out
+          end
+        end
+      elsif node.respond_to?(:children)
+        update_tree(node.children)
+      else
+        update_node(node.child)
+      end
+    end
+  end
+
+  class BoldImplementor < ImplementorBase
+    def initialize
+      @regex = /(^|\W)\*(\S[^*]*|[^*]*\S)\*(\W|$)/
+      @node_class = Bold
+    end
+  end
+
+  class ItalicImplementor < ImplementorBase
+    def initialize
+      @regex = /(^|\W)_(\S[^_]*|[^_]*\S)_(\W|$)/
+      @node_class = Italic
+    end
+  end
+
+  class UnorderedListImplementor
+    def multiline?
+      true
+    end
+
+    def update_tree(tree)
+      tree.flat_map do |node|
+        if node.is_a?(String)
+          update_text(node)
+        else
+          node
+        end
+      end
+    end
+
+    private
+
+    def update_text(input)
+      out = []
+
+      while result = input.match(/(?:^[ ]*\*[ ]+[^\n]+(?:\n|$))+/m)
+        out << result.pre_match unless result.pre_match.empty?
+
+        children = result[0].split("\n").map do |line|
+          Text.new(line.gsub(/^\s*\*\s+/, ''))
+        end
+        out << UnorderedList.new(children)
+
+        input = result.post_match
+      end
+
+      out << input unless input.empty?
+      out
+    end
+  end
+end

data/lib/minimal_markdown/nodes.rb

@@ -0,0 +1,58 @@
+require 'cgi'
+
+module MinimalMarkdown
+  UnorderedList = Struct.new(:children) do
+    def render(output)
+      output << '<ul>'
+      children.each do |child|
+        output << '<li>'
+        child.render(output)
+        output << '</li>'
+      end
+      output << '</ul>'
+    end
+  end
+
+  Line = Struct.new(:child, :spacing) do
+    def render(output)
+      if spacing < 2
+        output << '<div>'
+        child.render(output)
+        output << '</div>'
+      else
+        output << '<p>'
+        child.render(output)
+        output << '</p>'
+        if spacing > 2
+          output << '<br>' * (spacing - 2)
+        end
+      end
+    end
+  end
+
+  Text = Struct.new(:text) do
+    def render(output)
+      if text.is_a?(Array)
+        text.each { |child| child.render(output) }
+      else
+        output << CGI.escapeHTML(text)
+      end
+    end
+  end
+
+  Bold = Struct.new(:child) do
+    def render(output)
+      output << '<b>'
+      child.render(output)
+      output << '</b>'
+    end
+  end
+
+  Italic = Struct.new(:child) do
+    def render(output)
+      output << '<i>'
+      child.render(output)
+      output << '</i>'
+    end
+  end
+end

data/lib/minimal_markdown/parser.rb

@@ -0,0 +1,56 @@
+require 'cgi'
+
+module MinimalMarkdown
+  class Parser
+    DEFAULT_IMPLEMENTORS = [
+      UnorderedListImplementor,
+      BoldImplementor,
+      ItalicImplementor
+    ]
+
+    attr_reader :text, :implementors
+
+    def initialize(text, implementors: DEFAULT_IMPLEMENTORS)
+      @text = text
+      @implementors = implementors
+    end
+
+    def parse
+      prepared_text = text.strip.gsub("\r", "")
+
+      preline_implementors, postline_implementors = implementors.map(&:new).partition(&:multiline?)
+
+      preline_tree = run_implementors(preline_implementors, [prepared_text])
+      postline_tree = convert_to_lines(preline_tree)
+      run_implementors(postline_implementors, postline_tree)
+    end
+
+    private
+
+    def run_implementors(implementors, input_tree)
+      implementors.inject(input_tree) do |tree, implementor|
+        implementor.update_tree(tree)
+      end
+    end
+
+    def convert_to_lines(tree)
+      tree.flat_map do |node|
+        if node.is_a?(String)
+          parse_lines(node)
+        else
+          node
+        end
+      end
+    end
+
+    def parse_lines(text)
+      text.scan(/(.*)(\s*\n)*/).flat_map do |line, spaces|
+        if line.empty?
+          []
+        else
+          Line.new(Text.new(line), spaces&.count("\n") || 0)
+        end
+      end
+    end
+  end
+end

data/lib/minimal_markdown/version.rb

@@ -0,0 +1,3 @@
+module MinimalMarkdown
+  VERSION = "0.1.0"
+end

data/lib/minimal_markdown.rb

@@ -0,0 +1,12 @@
+require_relative 'minimal_markdown/version'
+require_relative 'minimal_markdown/nodes'
+require_relative 'minimal_markdown/implementors'
+require_relative 'minimal_markdown/parser'
+require_relative 'minimal_markdown/html_renderer'
+
+module MinimalMarkdown
+  def self.render(text)
+    tree = MinimalMarkdown::Parser.new(text).parse
+    MinimalMarkdown::HtmlRenderer.new(tree).render
+  end
+end

data/minimal_markdown.gemspec

@@ -0,0 +1,15 @@
+require_relative 'lib/minimal_markdown/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'minimal_markdown'
+  s.version     = MinimalMarkdown::VERSION
+  s.summary     = "Minimal markdown renderer"
+  s.description = "A lightweight and minimal Ruby implementation of a Markdown renderer, designed with security in mind."
+  s.authors     = ["Roger Nesbitt"]
+  s.email       = 'roger@seriousorange.com'
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.homepage    = 'https://github.com/mogest/minimal_markdown'
+  s.license     = 'MIT'
+
+  s.add_development_dependency 'rspec', '~> 3.8.0'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: minimal_markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roger Nesbitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: A lightweight and minimal Ruby implementation of a Markdown renderer,
+  designed with security in mind.
+email: roger@seriousorange.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/minimal_markdown.rb
+- lib/minimal_markdown/html_renderer.rb
+- lib/minimal_markdown/implementors.rb
+- lib/minimal_markdown/nodes.rb
+- lib/minimal_markdown/parser.rb
+- lib/minimal_markdown/version.rb
+- minimal_markdown.gemspec
+homepage: https://github.com/mogest/minimal_markdown
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Minimal markdown renderer
+test_files: []