minidown 2.1.1

data/spec/start_with_shape_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe '###### title' do
+    it 'should parse "#" as text' do
+      Minidown.render('#').should == '<p>#</p>'
+    end
+
+    it 'should parse "#####"' do
+      (2..7).map{|n| '#' * n}.each do |str|
+        tag = "h#{str.size - 1}"
+        Minidown.render(str).should == "<#{tag}>#</#{tag}>"
+      end
+    end
+
+    it 'should ignore blank' do
+      str =<<HERE
+#### h4 ######
+HERE
+      Minidown.render(str).should == "<h4>h4</h4>"
+    end
+  end
+
+  describe 'should not parse escaped' do
+    it 'start with escape' do
+      %w{\####### \###### \#### \### \## \#}.each do |str|
+        Minidown.render(str).should == "<p>#{str[1..-1]}</p>"
+      end
+    end
+
+    it 'some other case' do
+      str = '#\##'
+      Minidown.render(str).should == "<h1>\\</h1>"
+      str = '##\##\\'
+      Minidown.render(str).should == "<h2>##\\</h2>"
+      str = '# \# #'
+      Minidown.render(str).should == "<h1>#</h1>"
+      str = '#\#'
+      Minidown.render(str).should == "<h1>\\</h1>"
+    end
+  end
+end

data/spec/table_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe 'table' do
+    it 'should parse correct' do
+      str =<<HERE
+First Header  | Second Header
+------------- | -------------
+Content Cell  | Content Cell
+Content Cell  | Content Cell
+HERE
+      Minidown.render(str).should == '<table><thead><tr><th>First Header</th><th>Second Header</th></tr></thead><tbody><tr><td>Content Cell</td><td>Content Cell</td></tr><tr><td>Content Cell</td><td>Content Cell</td></tr></tbody></table>'
+    end
+
+    it 'should parse correct with pipe end' do
+      str =<<HERE
+| First Header  | Second Header |
+| ------------- | ------------- |
+| Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  |
+HERE
+      Minidown.render(str).should == '<table><thead><tr><th>First Header</th><th>Second Header</th></tr></thead><tbody><tr><td>Content Cell</td><td>Content Cell</td></tr><tr><td>Content Cell</td><td>Content Cell</td></tr></tbody></table>'
+    end
+
+    it 'should allow inline markdown' do
+    	 str = <<HERE
+| Name | Description          |
+| ------------- | ----------- |
+| Help      | ~~Display the~~ help window.|
+| Close     | _Closes_ a window     |
+HERE
+      Minidown.render(str).should == '<table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>Help</td><td><del>Display the</del> help window.</td></tr><tr><td>Close</td><td><em>Closes</em> a window</td></tr></tbody></table>'
+    end
+
+    it 'should allow define align' do
+    	 str = <<HERE
+| Left-Aligned  | Center Aligned  | Right Aligned |
+| :------------ |:---------------:| -----:|
+| col 3 is      | some wordy text | $1600 |
+| col 2 is      | centered        |   $12 |
+| zebra stripes | are neat        |    $1 |
+HERE
+	   Minidown.render(str).should == '<table><thead><tr><th align="left">Left-Aligned</th><th align="center">Center Aligned</th><th align="right">Right Aligned</th></tr></thead><tbody><tr><td align="left">col 3 is</td><td align="center">some wordy text</td><td align="right">$1600</td></tr><tr><td align="left">col 2 is</td><td align="center">centered</td><td align="right">$12</td></tr><tr><td align="left">zebra stripes</td><td align="center">are neat</td><td align="right">$1</td></tr></tbody></table>'
+    end
+
+    it 'should allow escape' do
+      str =<<HERE
+\\| First Header  | Second Header |
+| ------------- | ------------- |
+| Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  |
+HERE
+      Minidown.render(str).should == '<p>| First Header  | Second Header |<br>| ------------- | ------------- |<br>| Content Cell  | Content Cell  |<br>| Content Cell  | Content Cell  |</p>'
+    end
+
+    it 'should not parse as table' do
+    	 str = "|not|table|"
+    	 Minidown.render(str).should == '<p>|not|table|</p>'
+    	 str = "not|table"
+    	 Minidown.render(str).should == '<p>not|table</p>'
+    end
+  end
+end

data/spec/task_list_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe 'task list' do
+    it 'should parse correct' do
+      str =<<HERE
+- [ ] a task list item
+- [ ] list syntax required
+- [ ] normal **formatting**,
+      @mentions, #1234 refs
+- [ ] incomplete
+- [x] completed
+HERE
+      Minidown.render(str).should == '<ul class="task-list"><li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled=""> a task list item</li><li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled=""> list syntax required</li><li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled=""><p> normal <strong>formatting</strong>,</p>
+<p>@mentions, #1234 refs</p></li><li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" disabled=""> incomplete</li><li class="task-list-item"><input type="checkbox" class="task-list-item-checkbox" checked="" disabled=""> completed</li></ul>'
+    end
+  end
+end

data/spec/text_element_spec.rb

@@ -0,0 +1,317 @@
+require 'spec_helper'
+
+describe Minidown do
+  describe 'text element' do
+    it 'escape' do
+      str = "<>"
+      Minidown.render(str).should == "<p>&lt;&gt;</p>"
+    end
+
+    it 'escape special symbol' do
+      str = '\\\\
+\\`
+\\*
+\\_
+\\{
+\\}
+\\[
+\\]
+\\(
+\\)
+\\#
+\\+
+\\-
+\\.
+\\!'
+        Minidown.render(str).should == '<p>\
+`
+*
+_
+{
+}
+[
+]
+(
+)
+#
++
+-
+.
+!</p>'.split.join('<br>')
+    end
+
+    it 'escape escape symbol' do
+      str = %q{\\\\`
+\\\\*
+\\\\_
+\\\\{
+\\\\}
+\\\\[
+\\\\]
+\\\\(
+\\\\)
+\\\\#
+\\\\+
+\\\\-
+\\\\.
+\\\\!}
+        Minidown.render(str).should == %q{<p>\\`
+\\*
+\\_
+\\{
+\\}
+\\[
+\\]
+\\(
+\\)
+\\#
+\\+
+\\-
+\\.
+\\!</p>}.split.join('<br>')
+    end
+
+    it 'html tag' do
+      str = "<a href=\"http://github.com\">github</a>"
+      Minidown.render(str).should == "<p>#{str}</p>"
+    end
+
+    context 'link' do
+      it 'should parse correct' do
+        str = %Q{This is [an example](http://example.com/ "Title") inline link.
+
+[This link](http://example.net/) has no title attribute.}
+        Minidown.render(str).should == %Q{<p>This is <a href="http://example.com/" title="Title">an example</a> inline link.</p><p><a href="http://example.net/">This link</a> has no title attribute.</p>}
+
+        str = '[link a](https://a.example.com) and [link b](https://b.example.com)'
+        Minidown.render(str).should == "<p><a href=\"https://a.example.com\">link a</a> and <a href=\"https://b.example.com\">link b</a></p>"
+      end
+
+      it 'should allow related path' do
+        str = "See my [About](/about/) page for details."
+        Minidown.render(str).should == %Q{<p>See my <a href=\"/about/\">About</a> page for details.</p>}
+      end
+
+      it 'should allow reference' do
+        str =<<HERE
+I get 10 times more traffic from [Google] [1] than from
+[Yahoo] [2] or [MSN] [3].
+
+  [1]: http://google.com/        "Google"
+  [2]: http://search.yahoo.com/  "Yahoo Search"
+  [3]: http://search.msn.com/    "MSN Search"
+HERE
+        str2 =<<HERE
+I get 10 times more traffic from [Google][] than from
+[Yahoo][] or [MSN][].
+
+  [google]: http://google.com/        "Google"
+  [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
+  [msn]:    http://search.msn.com/    "MSN Search"
+HERE
+        [str, str2].each do |s|
+          Minidown.render(s).should == '<p>I get 10 times more traffic from <a href="http://google.com/" title="Google">Google</a> than from<br><a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>'
+        end
+      end
+
+      it 'can ignore title' do
+        str =<<HERE
+I get 10 times more traffic from [Google][] than from
+[Yahoo][] or [MSN][].
+
+  [google]: http://google.com/        "Google"
+  [yahoo]:  http://search.yahoo.com/
+  [msn]:    http://search.msn.com/    "MSN Search"
+HERE
+        Minidown.render(str).should == '<p>I get 10 times more traffic from <a href="http://google.com/" title="Google">Google</a> than from<br><a href="http://search.yahoo.com/">Yahoo</a> or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>'
+      end
+    end
+
+    context 'auto link' do
+      it 'should parse link' do
+        str = "https://github.com/jjyr/minidown"
+        Minidown.render(str).should == "<p><a href=\"#{str}\">#{str}</a></p>"
+      end
+
+      it 'can parse multi link' do
+        str = "https://github.com/jjyr/minidown https://github.com"
+        Minidown.render(str).should == "<p><a href=\"https://github.com/jjyr/minidown\">https://github.com/jjyr/minidown</a> <a href=\"https://github.com\">https://github.com</a></p>"
+      end
+
+      it 'should not parse link in tag' do
+        str = "<a href=\"https://github.com/jjyr/minidown\">minidown</a>"
+        Minidown.render(str).should == "<p>#{str}</p>"
+      end
+
+      it 'should not parse link without scheme' do
+        str = "github.com/jjyr/minidown"
+        Minidown.render(str).should == "<p>#{str}</p>"
+      end
+
+      it 'should parse email address' do
+        str = "jjyruby@gmail.com"
+        Minidown.render(str).should == "<p><a href=\"mailto:#{str}\">#{str}</a></p>"
+      end
+
+      it 'can parse multi email' do
+        str = "jjyruby@gmail.com jjyruby@gmail.com"
+        Minidown.render(str).should == "<p><a href=\"mailto:jjyruby@gmail.com\">jjyruby@gmail.com</a> <a href=\"mailto:jjyruby@gmail.com\">jjyruby@gmail.com</a></p>"
+      end
+
+      it 'should play with normal text' do
+        str = "Hi, jjyruby@gmail.com is my email."
+        Minidown.render(str).should == "<p>Hi, <a href=\"mailto:jjyruby@gmail.com\">jjyruby@gmail.com</a> is my email.</p>"
+
+        str = "Hi, <jjyruby@gmail.com> is my email."
+        Minidown.render(str).should == "<p>Hi, <a href=\"mailto:jjyruby@gmail.com\">jjyruby@gmail.com</a> is my email.</p>"
+      end
+
+      it 'should not parse email in tag' do
+        str = "<a href=\"mailto:jjyruby@gmail.com\">jjyr</a>"
+        Minidown.render(str).should == "<p>#{str}</p>"
+      end
+
+      it 'should parse with <>' do
+        str = "<https://github.com/jjyr/minidown>"
+        Minidown.render(str).should == "<p><a href=\"#{str[1..-2]}\">#{str[1..-2]}</a></p>"
+      end
+
+      it 'should not parse with <> if url invalid' do
+        str = "<github.com/jjyr/minidown>"
+        Minidown.render(str).should == "<p>#{str}</p>"
+      end
+
+      it 'should parse email' do
+        str = "<jjyruby@gmail.com>"
+        Minidown.render(str).should == "<p><a href=\"mailto:jjyruby@gmail.com\">jjyruby@gmail.com</a></p>"
+      end
+    end
+
+    context '~~del~~' do
+      it 'should parse correct' do
+        ['del', 'd', 'i am del'].each do |w|
+          str = "~~#{w}~~"
+          Minidown.render(str).should == "<p><del>#{w}</del></p>"
+        end
+      end
+
+      it 'should allow mutil in oneline' do
+        str = '~~i am del~~ and ~~i am another del~~'
+        Minidown.render(str).should == '<p><del>i am del</del> and <del>i am another del</del></p>'
+
+      end
+
+      it 'should not allow space' do
+        str = '~~ del ~~'
+        Minidown.render(str).should == '<p>~~ del ~~</p>'
+      end
+
+      it 'should allow escape' do
+        str = "\\~~del~~"
+        Minidown.render(str).should == '<p>~~del~~</p>'
+      end
+    end
+
+    context '*_ em & strong' do
+      it 'parse as em' do
+        ['*', '_'].each do |c|
+          Minidown.render("#{c}em#{c}").should == '<p><em>em</em></p>'
+        end
+      end
+
+      it 'should work well with text' do
+        Minidown.render("a _close_ a window").should == '<p>a <em>close</em> a window</p>'
+        Minidown.render("a *close* a window").should == '<p>a <em>close</em> a window</p>'
+      end
+
+      it 'can not mass' do
+        Minidown.render("*em_").should == '<p>*em_</p>'
+      end
+
+      it 'parse as strong' do
+        ['**', '__'].each do |c|
+          Minidown.render("#{c}strong#{c}").should == '<p><strong>strong</strong></p>'
+        end
+      end
+
+      it '* can work in string' do
+        Minidown.render("this*em*string").should == '<p>this<em>em</em>string</p>'
+      end
+
+      it '_ can not work in string' do
+        Minidown.render("_here_method").should == '<p>_here_method</p>'
+        Minidown.render("_here_method_").should == '<p><em>here_method</em></p>'
+      end
+
+      it 'should parse correct' do
+        Minidown.render("_ *what*_").should == '<p>_ <em>what</em>_</p>'
+      end
+
+      it 'should allow escape' do
+        Minidown.render("\\*\\_\\*").should == '<p>*_*</p>'
+      end
+
+      it 'should work well' do
+        str = "*View the [source of this content](http://github.github.com/github-flavored-markdown/sample_content.html).*"
+        Minidown.render(str).should == "<p><em>View the <a href=\"http://github.github.com/github-flavored-markdown/sample_content.html\">source of this content</a>.</em></p>"
+      end
+    end
+
+    context 'inline code' do
+      it 'should parse correct' do
+        str = "Use the `printf()` function."
+        Minidown.render(str).should == "<p>Use the <code>printf()</code> function.</p>"
+      end
+
+      it 'should can use multi `' do
+        str = "``There is a literal backtick (`) here.``"
+        Minidown.render(str).should == "<p><code>There is a literal backtick (`) here.</code></p>"
+
+        str = 'A single backtick in a code span: `` ` ``
+
+A backtick-delimited string in a code span: `` `foo` ``'
+        Minidown.render(str).should == '<p>A single backtick in a code span: <code>`</code></p><p>A backtick-delimited string in a code span: <code>`foo`</code></p>'
+      end
+
+      it 'can parse multi inline code' do
+        str = "`hello` `world`"
+        Minidown.render(str).should == "<p><code>hello</code> <code>world</code></p>"
+      end
+
+      it 'should auto escape' do
+        str = "Please don't use any `<blink>` tags."
+        Minidown.render(str).should == "<p>Please don't use any <code>&lt;blink&gt;</code> tags.</p>"
+      end
+
+      it 'should not auto convert' do
+        str = "`jjyruby@gmail.com`"
+        Minidown.render(str).should == '<p><code>jjyruby@gmail.com</code></p>'
+      end
+    end
+
+    context 'image syntax' do
+      it 'should parse correct' do
+        str = '![Alt text](/path/to/img.jpg)'
+        Minidown.render(str).should == "<p><img src=\"/path/to/img.jpg\" alt=\"Alt text\"></img></p>"
+      end
+
+      it 'should have title' do
+        str = "![Alt text](/path/to/img.jpg \"title\")"
+        Minidown.render(str).should == "<p><img src=\"/path/to/img.jpg\" alt=\"Alt text\" title=\"title\"></img></p>"
+      end
+
+      it 'should allow reference' do
+        str =<<HERE
+![Image 1][img1]
+![Image 2][img2]
+![Image 3][img3]
+
+[img1]: url/to/image1  "Image 1"
+[img2]: url/to/image2
+[img3]: url/to/image3  "Image 3"
+HERE
+        Minidown.render(str).should == "<p><img src=\"url/to/image1\" alt=\"Image 1\" title=\"Image 1\"></img><br><img src=\"url/to/image2\" alt=\"Image 2\"></img><br><img src=\"url/to/image3\" alt=\"Image 3\" title=\"Image 3\"></img></p>"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: minidown
+version: !ruby/object:Gem::Version
+  version: 2.1.1
+platform: ruby
+authors:
+- jjy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minidown is a lightweight & fast markdown parser, with complete GFM support.
+email:
+- jjyruby@gmail.com
+executables:
+- minidown
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/minidown
+- lib/minidown.rb
+- lib/minidown/document.rb
+- lib/minidown/element.rb
+- lib/minidown/elements.rb
+- lib/minidown/elements/block_element.rb
+- lib/minidown/elements/code_block_element.rb
+- lib/minidown/elements/dividing_line_element.rb
+- lib/minidown/elements/html_element.rb
+- lib/minidown/elements/indent_code_element.rb
+- lib/minidown/elements/line_element.rb
+- lib/minidown/elements/list_element.rb
+- lib/minidown/elements/list_group_element.rb
+- lib/minidown/elements/order_list_element.rb
+- lib/minidown/elements/paragraph_element.rb
+- lib/minidown/elements/raw_html_element.rb
+- lib/minidown/elements/table_element.rb
+- lib/minidown/elements/text_element.rb
+- lib/minidown/elements/unorder_list_element.rb
+- lib/minidown/html_helper.rb
+- lib/minidown/parser.rb
+- lib/minidown/utils.rb
+- lib/minidown/version.rb
+- minidown.gemspec
+- spec/blank_line_spec.rb
+- spec/code_block_spec.rb
+- spec/dividing_line_spec.rb
+- spec/h1_and_h2_spec.rb
+- spec/indent_block_spec.rb
+- spec/li_spec.rb
+- spec/minidown_spec.rb
+- spec/paragraph_spec.rb
+- spec/raw_html_spec.rb
+- spec/spec_helper.rb
+- spec/start_with_gt_spec.rb
+- spec/start_with_shape_spec.rb
+- spec/table_spec.rb
+- spec/task_list_spec.rb
+- spec/text_element_spec.rb
+homepage: https://github.com/jjyr/minidown
+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.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Minidown is a lightweight & fast markdown parser, with complete GFM support.
+test_files:
+- spec/blank_line_spec.rb
+- spec/code_block_spec.rb
+- spec/dividing_line_spec.rb
+- spec/h1_and_h2_spec.rb
+- spec/indent_block_spec.rb
+- spec/li_spec.rb
+- spec/minidown_spec.rb
+- spec/paragraph_spec.rb
+- spec/raw_html_spec.rb
+- spec/spec_helper.rb
+- spec/start_with_gt_spec.rb
+- spec/start_with_shape_spec.rb
+- spec/table_spec.rb
+- spec/task_list_spec.rb
+- spec/text_element_spec.rb