minimal_markdown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f513dd2b70e6b64938c16b2c1ab15c2ba24e57dcdad5a8ac1ecacefc0cbdc8e
-  data.tar.gz: a313ef705ff4a74d5cb516505d2c472e4149746cc4f9cb2c51864d75a39c5369
+  metadata.gz: c2c4b5e33d33ba7906773ba771a60ca8bdec59bbd7c70e782c1015eb415b3fc9
+  data.tar.gz: 3856b0171044a85155edd7cd1fe571257625a939475de43bb951710c48aa541e
 SHA512:
-  metadata.gz: 8e15301d1ccf20fec7ff5efa8634e41b41280b0157ee1d7ee070a718c226c04c3f1a0aaf2999f1d94589aac75f55519c4d8e94dd7afcfa1e91c9b5e152207e23
-  data.tar.gz: 6e849f0eb968d5fb994ec33d792554eb4d081ff7b74b97360449138cae18c99b001a537c152ec703c9cc67ce5b867531dc9df530433cc9396d4f908f1041cfa1
+  metadata.gz: '068c6461129d501ba17a00024bba4baff4f47047c993f8e400036f4b93cd377c3f75ed3d7178cc397a3d52f939f09d0e514ec9e0934ceff171dd90764911c303'
+  data.tar.gz: cbebb147ce28b85e1d414b8a242eed030dbe0e4c22c4aeb9d69bc58dd4f723ef7210ab38a3a514f19e4ed3d548f88ff74f4df1fdae27c8219ec2e3d6365b9ee0

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -4,7 +4,7 @@ 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.
+possibility of corrupted or user-supplied HTML sneaking into the output.
 
 ## Supported Markdown elements
 
@@ -25,5 +25,12 @@ Add to your app:
 
 ```
 MinimalMarkdown.render('Here is my *markdown*')
+=> "<div>Here is my <i>markdown</i></div>"
+```
+
+Or use the Slack-style Markdown parser by passing an option:
+
+```
+MinimalMarkdown.render('Here is my *markdown*', style: :slack)
 => "<div>Here is my <b>markdown</b></div>"
 ```

data/lib/minimal_markdown.rb

@@ -1,12 +1,19 @@
 require_relative 'minimal_markdown/version'
-require_relative 'minimal_markdown/nodes'
-require_relative 'minimal_markdown/implementors'
+require_relative 'minimal_markdown/nodes/bold'
+require_relative 'minimal_markdown/nodes/italic'
+require_relative 'minimal_markdown/nodes/line'
+require_relative 'minimal_markdown/nodes/text'
+require_relative 'minimal_markdown/nodes/unordered_list'
+require_relative 'minimal_markdown/parsers/base'
+require_relative 'minimal_markdown/parsers/bold'
+require_relative 'minimal_markdown/parsers/italic'
+require_relative 'minimal_markdown/parsers/unordered_list'
 require_relative 'minimal_markdown/parser'
 require_relative 'minimal_markdown/html_renderer'
 
 module MinimalMarkdown
-  def self.render(text)
-    tree = MinimalMarkdown::Parser.new(text).parse
+  def self.render(text, style: :markdown)
+    tree = MinimalMarkdown::Parser.new(text, style: style).parse
     MinimalMarkdown::HtmlRenderer.new(tree).render
   end
 end

data/lib/minimal_markdown/nodes/bold.rb

@@ -0,0 +1,9 @@
+module MinimalMarkdown::Nodes
+  Bold = Struct.new(:child) do
+    def render(output)
+      output << '<b>'
+      child.render(output)
+      output << '</b>'
+    end
+  end
+end

data/lib/minimal_markdown/nodes/italic.rb

@@ -0,0 +1,9 @@
+module MinimalMarkdown::Nodes
+  Italic = Struct.new(:child) do
+    def render(output)
+      output << '<i>'
+      child.render(output)
+      output << '</i>'
+    end
+  end
+end

data/lib/minimal_markdown/nodes/line.rb

@@ -0,0 +1,18 @@
+module MinimalMarkdown::Nodes
+  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
+end

data/lib/minimal_markdown/nodes/text.rb

@@ -0,0 +1,13 @@
+require 'cgi'
+
+module MinimalMarkdown::Nodes
+  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
+end

data/lib/minimal_markdown/nodes/unordered_list.rb

@@ -0,0 +1,13 @@
+module MinimalMarkdown::Nodes
+  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
+end

data/lib/minimal_markdown/parser.rb

@@ -1,35 +1,38 @@
-require 'cgi'
-
 module MinimalMarkdown
   class Parser
-    DEFAULT_IMPLEMENTORS = [
-      UnorderedListImplementor,
-      BoldImplementor,
-      ItalicImplementor
+    DEFAULT_PARSERS = [
+      Parsers::UnorderedList,
+      Parsers::Bold,
+      Parsers::Italic,
     ]
 
-    attr_reader :text, :implementors
+    STYLES = [:markdown, :slack]
+
+    attr_reader :text, :parsers
+
+    def initialize(text, style: :markdown, parsers: DEFAULT_PARSERS)
+      raise ArgumentError, 'invalid style' unless STYLES.include?(style)
 
-    def initialize(text, implementors: DEFAULT_IMPLEMENTORS)
       @text = text
-      @implementors = implementors
+      @style = style
+      @parsers = parsers
     end
 
     def parse
       prepared_text = text.strip.gsub("\r", "")
 
-      preline_implementors, postline_implementors = implementors.map(&:new).partition(&:multiline?)
+      preline_parsers, postline_parsers = parsers.map { |parser| parser.new(@style) }.partition(&:multiline?)
 
-      preline_tree = run_implementors(preline_implementors, [prepared_text])
+      preline_tree = run_parsers(preline_parsers, [prepared_text])
       postline_tree = convert_to_lines(preline_tree)
-      run_implementors(postline_implementors, postline_tree)
+      run_parsers(postline_parsers, postline_tree)
     end
 
     private
 
-    def run_implementors(implementors, input_tree)
-      implementors.inject(input_tree) do |tree, implementor|
-        implementor.update_tree(tree)
+    def run_parsers(parsers, input_tree)
+      parsers.inject(input_tree) do |tree, parser|
+        parser.update_tree(tree)
       end
     end
 
@@ -48,7 +51,7 @@ module MinimalMarkdown
         if line.empty?
           []
         else
-          Line.new(Text.new(line), spaces&.count("\n") || 0)
+          Nodes::Line.new(Nodes::Text.new(line), spaces&.count("\n") || 0)
         end
       end
     end

data/lib/minimal_markdown/parsers/base.rb

@@ -0,0 +1,38 @@
+module MinimalMarkdown::Parsers
+  class Base
+    def multiline?
+      false
+    end
+
+    def update_tree(tree)
+      tree.each { |node| update_node(node) }
+    end
+
+    private
+
+    def update_node(node)
+      if node.is_a?(::MinimalMarkdown::Nodes::Text)
+        if node.text.is_a?(Array)
+          update_tree(node.text)
+        else
+          out = []
+          input = node.text
+          while result = input.match(@regex)
+            out << ::MinimalMarkdown::Nodes::Text.new(result.pre_match + result[1]) unless result.pre_match.empty?
+            out << @node_class.new(::MinimalMarkdown::Nodes::Text.new(result[3]))
+            input = result[4] + result.post_match
+          end
+
+          if !out.empty?
+            out << ::MinimalMarkdown::Nodes::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
+end

data/lib/minimal_markdown/parsers/bold.rb

@@ -0,0 +1,12 @@
+module MinimalMarkdown::Parsers
+  class Bold < Base
+    def initialize(style)
+      @regex = case style
+      when :markdown then /(^|\W)(\*\*|__)(\S|\S.*?\S)\2(\W|$)/
+      when :slack    then /(^|\W)(\*)(\S[^*]*|[^*]*\S)\*(\W|$)/
+      end
+
+      @node_class = ::MinimalMarkdown::Nodes::Bold
+    end
+  end
+end

data/lib/minimal_markdown/parsers/italic.rb

@@ -0,0 +1,12 @@
+module MinimalMarkdown::Parsers
+  class Italic < Base
+    def initialize(style)
+      @regex = case style
+      when :markdown then /(^|\W)([_*])(?!\2)(\S|\S.*?(?!\2)\S)\2(\W|$)/
+      when :slack    then /(^|\W)(_)(\S[^_]*|[^_]*\S)_(\W|$)/
+      end
+
+      @node_class = ::MinimalMarkdown::Nodes::Italic
+    end
+  end
+end

data/lib/minimal_markdown/parsers/unordered_list.rb

@@ -0,0 +1,40 @@
+module MinimalMarkdown::Parsers
+  class UnorderedList
+    def initialize(style)
+    end
+
+    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|
+          ::MinimalMarkdown::Nodes::Text.new(line.sub(/^\s*[*+-]\s+/, ''))
+        end
+        out << ::MinimalMarkdown::Nodes::UnorderedList.new(children)
+
+        input = result.post_match
+      end
+
+      out << input unless input.empty?
+      out
+    end
+  end
+end

data/lib/minimal_markdown/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minimal_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roger Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,15 +31,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - 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/nodes/bold.rb
+- lib/minimal_markdown/nodes/italic.rb
+- lib/minimal_markdown/nodes/line.rb
+- lib/minimal_markdown/nodes/text.rb
+- lib/minimal_markdown/nodes/unordered_list.rb
 - lib/minimal_markdown/parser.rb
+- lib/minimal_markdown/parsers/base.rb
+- lib/minimal_markdown/parsers/bold.rb
+- lib/minimal_markdown/parsers/italic.rb
+- lib/minimal_markdown/parsers/unordered_list.rb
 - lib/minimal_markdown/version.rb
 - minimal_markdown.gemspec
 homepage: https://github.com/mogest/minimal_markdown

data/lib/minimal_markdown/implementors.rb

@@ -1,88 +0,0 @@
-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

@@ -1,58 +0,0 @@
-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