minidown 2.1.1

data/lib/minidown/elements/unorder_list_element.rb

@@ -0,0 +1,31 @@
+module Minidown
+  class UnorderListElement < ListGroupElement
+    TaskRegexp = /\A\[([ x])\](.+)/
+    NestRegexp = /\A(\s*)[*\-+]\s+(.+)/
+    ListRegexp = Minidown::Utils::Regexp[:unorder_list]
+
+    def initialize doc, line, indent_level = 0
+      super doc, line
+      if content =~ TaskRegexp
+        @task_ul ||= true
+        list = ListElement.new(doc, $2)
+        list.task_list = true
+        list.checked = ($1 == 'x'.freeze)
+      else
+        list = ListElement.new(doc, content)
+      end
+      @children << list
+      @lists = @children.dup
+      @indent_level = indent_level
+      @put_back = []
+    end
+    
+    def to_html
+      attr = nil
+      attr = {class: 'task-list'.freeze} if @task_ul
+      build_tag 'ul'.freeze, attr do |content|
+        children.each { |child| content << child.to_html}
+      end
+    end
+  end
+end

data/lib/minidown/html_helper.rb

@@ -0,0 +1,18 @@
+module Minidown
+  module HtmlHelper
+    def build_tag name, attr = nil
+      content = ''
+      yield content if block_given?
+      if attr
+        attr = attr.map{|k, v| "#{k}=\"#{v}\""}.join ' '.freeze
+        "<#{name} #{attr}>#{content}</#{name}>"
+      else
+        "<#{name}>#{content}</#{name}>"
+      end
+    end
+
+    def br_tag
+      '<br>'
+    end
+  end
+end

data/lib/minidown/parser.rb

@@ -0,0 +1,19 @@
+module Minidown
+  class Parser
+    def initialize options = {}
+      @options = options.freeze
+    end
+
+    def render str
+      parse(str).to_html
+    end
+
+    protected
+    def parse str
+      lines = str.split Utils::Regexp[:lines]
+      doc = Document.new lines, @options
+      doc.parse
+      doc
+    end
+  end
+end

data/lib/minidown/utils.rb

@@ -0,0 +1,28 @@
+module Minidown
+  module Utils
+    Regexp = {
+      lines: /\n|\r\n/,
+      blank_line: /\A\s*\z/,
+      raw_html: /\A\s*(\<(?=[^\<\>]).+(?<=[^\<\>])\>)*\s*\z/,
+      h1_or_h2: /\A([=-]{3,})(.*)/,
+      start_with_shape: /\A(\#{1,6})\s*(.+?)\s*#*\z/,
+      start_with_quote: /\A\>\s*(.+)/,
+      unorder_list: /\A(\s*)[*\-+]\s+(.+)/,
+      order_list: /\A(\s*)\d+\.\s+(.+)/,
+      code_block: /\A\s*[`~]{3,}\s*(\S*)/,
+      table: /\A\|?([^\|]+(?:\|[^\|]*)*)\|?\s*\z/,
+      dividing_line: /\A(\s*[*-]\s*){3,}\z/,
+      indent_code: /\A\s{4}(.+)/,
+      pipe_symbol: /\|/
+    }.freeze
+
+    class << self
+      def escape_html str
+        sanitized_str = str.dup
+        sanitized_str.gsub! "<".freeze, "&lt;".freeze
+        sanitized_str.gsub! ">".freeze, "&gt;".freeze
+        sanitized_str
+      end
+    end
+  end
+end

data/lib/minidown/version.rb

@@ -0,0 +1,3 @@
+module Minidown
+  VERSION = "2.1.1"
+end

data/minidown.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minidown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minidown"
+  spec.version       = Minidown::VERSION
+  spec.authors       = ["jjy"]
+  spec.email         = ["jjyruby@gmail.com"]
+  spec.description   = %q{Minidown is a lightweight & fast markdown parser, with complete GFM support.}
+  spec.summary       = %q{Minidown is a lightweight & fast markdown parser, with complete GFM support.}
+  spec.homepage      = "https://github.com/jjyr/minidown"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+end

data/spec/blank_line_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe 'blank line' do
+    it 'should parse as nothing' do
+      ['', "\n", "\n\n", "\n\n\n\n"].each do |str|
+        Minidown.render(str).should == ''
+      end
+    end
+
+    it 'should be ignore when blank is the first line' do
+      str = "\na"
+      Minidown.render(str).should == "<p>a</p>"
+      str = "\n\n h"
+      Minidown.render(str).should == "<p> h</p>"
+      ["\n \n", "\n \n\n\n"].each do |str|
+        Minidown.render(str).should == "#{str.split(Minidown::Utils::Regexp[:lines]).last}".strip
+      end
+    end
+  end
+end

data/spec/code_block_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe 'code_block' do
+    it 'should parse correct' do
+      str =<<HERE
+```
+should in code block
+
+in block
+```
+HERE
+      Minidown.render(str).should == "<pre><code>should in code block\n\nin block</code></pre>"
+    end
+
+    it 'should allow tildes as well as backquotes' do
+      str =<<HERE
+~~~
+should in code block
+
+in block
+~~~
+HERE
+      Minidown.render(str).should == "<pre><code>should in code block\n\nin block</code></pre>"
+    end
+
+    it 'should allow arbitrary number of `' do
+      str =<<HERE
+````````````
+should in code block
+
+in block
+````````````
+HERE
+      Minidown.render(str).should == "<pre><code>should in code block\n\nin block</code></pre>"
+    end
+
+    it 'should allow arbitrary number of tildes' do
+      str =<<HERE
+~~~~~~~~~~~
+should in code block
+
+in block
+~~~~~~~~~~~
+HERE
+      Minidown.render(str).should == "<pre><code>should in code block\n\nin block</code></pre>"
+    end
+
+
+    it 'should ignore space' do
+      str =<<HERE
+  ```
+should in code block
+in block
+    ```
+HERE
+      Minidown.render(str).should == "<pre><code>should in code block\nin block</code></pre>"
+    end
+
+    it 'should have lang attribute' do
+      str =<<HERE
+```  ruby
+should in code block
+
+in block
+```
+HERE
+      Minidown.render(str).should == "<pre><code class=\"ruby\">should in code block\n\nin block</code></pre>"
+    end
+
+    it 'should have lang attribute with tildes' do
+      str =<<HERE
+~~~  ruby
+should in code block
+
+in block
+~~~
+HERE
+      Minidown.render(str).should == "<pre><code class=\"ruby\">should in code block\n\nin block</code></pre>"
+    end
+
+    it 'should allow escape' do
+      str =<<HERE
+\\```
+should in code block
+
+in block
+\\```
+HERE
+      Minidown.render(str).should == "<p>```<br>should in code block</p><p>in block<br>```</p>"
+      str =<<HERE
+\\~~~
+should in code block
+
+in block
+\\~~~
+HERE
+      Minidown.render(str).should == "<p>~~~<br>should in code block</p><p>in block<br>~~~</p>"
+    end
+
+    it 'should not escape content' do
+      str =<<HERE
+```
+\\+
+\\.
+\\-
+\\*
+<>
+```
+HERE
+      Minidown.render(str).should == "<pre><code>\\+\n\\.\n\\-\n\\*\n&lt;&gt;</code></pre>"
+      str =<<HERE
+~~~
+\\+
+\\.
+\\-
+\\*
+<>
+~~~
+HERE
+      Minidown.render(str).should == "<pre><code>\\+\n\\.\n\\-\n\\*\n&lt;&gt;</code></pre>"
+    end
+
+    it 'should escape html tag' do
+      str ='```
+<a>hello</a>
+```'
+      Minidown.render(str).should == "<pre><code>&lt;a&gt;hello&lt;/a&gt;</code></pre>"
+      str ='~~~
+<a>hello</a>
+~~~'
+      Minidown.render(str).should == "<pre><code>&lt;a&gt;hello&lt;/a&gt;</code></pre>"
+    end
+
+    it 'should not auto convert' do
+      str = '```
+jjyruby@gmail.com
+```'
+      Minidown.render(str).should == '<pre><code>jjyruby@gmail.com</code></pre>'
+      str = '~~~
+jjyruby@gmail.com
+~~~'
+      Minidown.render(str).should == '<pre><code>jjyruby@gmail.com</code></pre>'
+    end
+
+    describe "work with code block handler" do
+      it "work with handler" do
+        str = '``` ruby
+puts "We love ruby!"
+```'
+        handler = ->(lang, content){"`#{content}` is write in #{lang}"}
+        Minidown.render(str, code_block_handler: handler).should == '`puts "We love ruby!"` is write in ruby'
+      end
+
+      it "lang should return empty if not specific language" do
+        str = '```
+not specific language
+```'
+        handler = ->(lang, content){ "#{content}, so lang is #{lang.inspect}" }
+        Minidown.render(str, code_block_handler: handler).should == 'not specific language, so lang is nil'
+      end
+
+      it "handler should pass raw content" do
+        str = '```
+<script>
+```'
+        handler = ->(lang, content){ content.gsub("<", "{").gsub(">", "}") }
+        Minidown.render(str, code_block_handler: handler).should == '{script}'
+      end
+
+      it "should not escape <>" do
+        test_cases = %w{<script> <> < >}
+        handler = ->(lang, content){ content }
+        parser = Minidown::Parser.new(code_block_handler: handler)
+        test_cases.each do |case_s|
+          str = "```\n#{case_s}\n```"
+          parser.render(str).should == case_s
+        end
+      end
+    end
+  end
+end

data/spec/dividing_line_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe 'dividing line' do
+    it 'parsed correct' do
+      str = '***'
+      Minidown.render(str).should == '<hr>'
+      str = '---'
+      Minidown.render(str).should == '<hr>'
+      str = ' *** '
+      Minidown.render(str).should == '<hr>'
+      str = ' * * * '
+      Minidown.render(str).should == '<hr>'
+      str = ' -- - '
+      Minidown.render(str).should == '<hr>'
+      str = '----'
+      Minidown.render(str).should == '<hr>'
+    end
+
+    it 'should not parse if any other character' do
+      str = 'f---'
+      Minidown.render(str).should == '<p>f---</p>'
+
+      str = '* * *z'
+      Minidown.render(str).should == '<ul><li><em> </em>z</li></ul>'
+    end
+
+    it 'should allow escape' do
+      str = "\\----"
+      Minidown.render(str).should == '<p>----</p>'
+      str = "\\* * *"
+      Minidown.render(str).should == '<p>* <em> </em></p>'
+    end
+  end
+end

data/spec/h1_and_h2_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe '======== or -------' do
+    it 'should parse as text' do
+      %w{===== =====hello ------nihao}.each do |str|
+        Minidown.render(str).should == "<p>#{str}</p>"
+      end
+    end
+
+    it 'should parse as h1' do
+      %w{======= ==== === = ==}.each do |s|
+        str =<<HERE
+h1
+#{s}
+HERE
+        if s.size < 3
+          Minidown.render(str).should == "<p>h1<br>#{s}</p>"
+        else
+          Minidown.render(str).should == "<h1>h1</h1>"
+        end
+      end
+    end
+
+    it 'should parse as h2' do
+      %w{------- ---- --- - --}.each do |s|
+        str =<<HERE
+h2
+#{s}
+HERE
+        if s.size < 3
+          Minidown.render(str).should == "<p>h2<br>#{s}</p>"
+        else
+          Minidown.render(str).should == "<h2>h2</h2>"
+        end
+      end
+    end
+
+    it 'should parse newtext' do
+      %w{------ =======}.each do |s|
+        str =<<HERE
+title
+#{s}should show text
+HERE
+        tag = (s[0] == '-' ? 'h2' : 'h1')
+        Minidown.render(str).should == "<#{tag}>title</#{tag}><p>should show text</p>"
+      end
+    end
+
+    it 'should not parse as h2 if preline is h tag' do
+      str = "#### [ruby](http://ruby-lang.org/)\n---"
+      Minidown.render(str).should == "<h4><a href=\"http://ruby-lang.org/\">ruby</a></h4><hr>"
+    end
+  end
+end

data/spec/indent_block_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe 'indent should parse as code block' do
+    it 'should parse correct' do
+      str =<<HERE
+Here is a Python code example
+without syntax highlighting:
+
+    def foo:
+      if not bar:
+        return true
+HERE
+      Minidown.render(str).should == "<p>Here is a Python code example<br>without syntax highlighting:</p><pre><code>def foo:\n  if not bar:\n    return true</code></pre>"
+    end
+  end
+end