marker 0.3.3 → 0.4.0

data/lib/marker/text.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2009 Ryan Blue.
+# Copyright 2009-2011 Ryan Blue.
 # Distributed under the terms of the GNU General Public License (GPL).
 # See the LICENSE file for further information on the GPL.
 #++
@@ -7,13 +7,25 @@
 require 'marker/common'
 
 module Marker #:nodoc:
-  class Paragraph < RecursiveList
+  class Paragraph < ParseNode
+    def to_html( options = {} )
+      if text.no_wrap?
+        text.to_html(options)
+      else
+        "<p>#{text.to_html(options)}</p>"
+      end
+    end
+
+    def to_s( options = {} )
+      text.to_s(options)
+    end
+  end
+
+  class TextBlock < RecursiveList
     def to_html( options = {} )
-      '<p>' +
       to_a.map { |p|
         p.to_html(options)
-      }.join(' ') +
-      '</p>'
+      }.join(' ')
     end
 
     # TODO: add wordwrap
@@ -22,6 +34,11 @@ module Marker #:nodoc:
         p.to_s(options)
       }.join(' ')
     end
+
+    # returns true if this text block does not need to be wrapped in a paragraph
+    def no_wrap?
+      single? and h.no_wrap?
+    end
   end
 
   class Phrase < RecursiveList
@@ -44,6 +61,11 @@ module Marker #:nodoc:
       (ws and ws.present?) or (aws and aws.present?)
     end
 
+    # returns true if this phrase does not need to be wrapped in a paragraph
+    def no_wrap?
+      single? and h.is_a? Template
+    end
+
     #-- defaults ++
     def ws
       nil
@@ -74,6 +96,16 @@ module Marker #:nodoc:
     end
   end
 
+  class Escaped < ParseNode
+    def to_html( options = {} )
+      text_value.slice(-1,1)
+    end
+
+    def to_s( options = {} )
+      text_value.slice(-1,1)
+    end
+  end
+
   class HorizRule < ParseNode
     def to_html( options = {} )
       "<hr />" +

data/test/encodings_test.rb

@@ -6,19 +6,19 @@ class EncodingsTest < Test::Unit::TestCase
   def test_linux_newlines
     text = "one\ntwo\n\nthree"
     markup = Marker.parse text
-    assert_match("<p>one two</p>\n\n<p>three</p>", markup.to_html)
+    assert_match("<p>one two</p>\n<p>three</p>", markup.to_html)
   end
 
   def test_windows_newlines
     text = "one\r\ntwo\r\n\r\nthree"
     markup = Marker.parse text
-    assert_match("<p>one two</p>\n\n<p>three</p>", markup.to_html)
+    assert_match("<p>one two</p>\n<p>three</p>", markup.to_html)
   end
 
   def test_mac_newlines
     text = "one\rtwo\r\rthree"
     markup = Marker.parse text
-    assert_match("<p>one two</p>\n\n<p>three</p>", markup.to_html)
+    assert_match("<p>one two</p>\n<p>three</p>", markup.to_html)
   end
 
 end

data/test/formatting_test.rb

@@ -69,7 +69,7 @@ class FormattingTest < Test::Unit::TestCase
     text = "paragraph 1\n\nparagraph 2\n\nparagraph 3"
     markup = Marker.parse text
 
-    assert_match("<p>paragraph 1</p>\n\n<p>paragraph 2</p>\n\n<p>paragraph 3</p>", markup.to_html)
+    assert_match("<p>paragraph 1</p>\n<p>paragraph 2</p>\n<p>paragraph 3</p>", markup.to_html)
   end
 
   def test_newlines_in_paragraphs

data/test/helper.rb

@@ -0,0 +1,9 @@
+# helper methods for tests
+
+module MarkerTestHelpers
+  def assert_renders_html( expected_html, markup )
+  end
+
+  def assert_renders_text( expected_text, markup )
+  end
+end

data/test/lists_test.rb

@@ -14,7 +14,7 @@ class ListTest < Test::Unit::TestCase
     text = "* List item 1\n** List item 2\n* List item 3"
     markup = Marker.parse text
     
-    assert_match("<ul><li>List item 1</li><ul><li>List item 2</li></ul><li>List item 3</li></ul>", markup.to_html)
+    assert_match("<ul><li>List item 1<ul><li>List item 2</li></ul></li><li>List item 3</li></ul>", markup.to_html)
   end
 
   def test_numbered_list
@@ -28,7 +28,7 @@ class ListTest < Test::Unit::TestCase
     text = "# List item 1\n## List item 2\n# List item 3"
     markup = Marker.parse text
     
-    assert_match("<ol><li>List item 1</li><ol><li>List item 2</li></ol><li>List item 3</li></ol>", markup.to_html)
+    assert_match("<ol><li>List item 1<ol><li>List item 2</li></ol></li><li>List item 3</li></ol>", markup.to_html)
   end
 
   def test_definition_list
@@ -59,15 +59,22 @@ class ListTest < Test::Unit::TestCase
     markup = Marker.parse text
     
     assert_match("<ol><li>List item 1</li></ol><ul><li>List item 2</li></ul><ol><li>List item 3</li></ol><dl><dt>List item 4</dt>" +
-        "<dd>definition</dd></dl><div class='indent'><div>List item 5</div></div><ul><li>List item 6</li></ul>", markup.to_html)
+        "<dd>definition</dd></dl><div class='indent'><div class='indented_item'>List item 5</div></div><ul><li>List item 6</li></ul>", markup.to_html)
   end
 
   def test_nested_mixed_list
     text = "# List item 1\n#* List item 2\n# List item 3\n## List item 4\n#; List item 5 : definition\n#:List item 6"
     markup = Marker.parse text
     
-    assert_match("<ol><li>List item 1</li><ul><li>List item 2</li></ul><li>List item 3</li><ol><li>List item 4</li></ol>" +
-        "<dl><dt>List item 5</dt><dd>definition</dd></dl><div class='indent'><div>List item 6</div></div></ol>", markup.to_html)
+    assert_match("<ol><li>List item 1<ul><li>List item 2</li></ul></li><li>List item 3<ol><li>List item 4</li></ol>" +
+        "<dl><dt>List item 5</dt><dd>definition</dd></dl><div class='indent'><div class='indented_item'>List item 6</div></div></li></ol>", markup.to_html)
+  end
+
+  def test_bare_nested_list
+    text = "*** item"
+    markup = Marker.parse text
+
+    assert_match("<ul><li><ul><li><ul><li>item</li></ul></li></ul></li></ul>", markup.to_html)
   end
 
 end

data/test/templates_test.rb

@@ -1,55 +1,170 @@
 require File.expand_path( File.dirname( __FILE__ ) + '/test_helper' )
 require 'marker'
 
-class TemplatesTest < Test::Unit::TestCase
+class TemplatesTest < MarkerTest
+
+  DEFAULT_OPTIONS = '{:link_base=>"", :footnotes=>}'
 
   def test_basic_template
     text = "{{ template }}"
-    markup = Marker.parse text
+    markup = parse_with_assertions text
+    html = markup.to_html
     
-    assert_match("<p>render:template( :html, [], {} )</p>", markup.to_html)
+    assert_match("render:template( :html, [], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_no_match(/<div/, html, text)
   end
 
-  def test_positional_args
+  def test_ordered_args
     text = "{{ template | one | two | three }}"
-    markup = Marker.parse text
-    
-    assert_match("<p>render:template( :html, [\"one\", \"two\", \"three\"], {} )</p>", markup.to_html)
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:template( :html, [\"one\", \"two\", \"three\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_no_match(/<div/, html, text)
   end
 
   def test_named_args
     text = "{{ template | one=1 | two = 2 }}"
-    markup = Marker.parse text
-    
-    # might want to fix this assertion, the hash could come out in any order
-    assert_match("<p>render:template( :html, [], {", markup.to_html)
-    assert_match("\"two\"=>\"2\"", markup.to_html)
-    assert_match("\"one\"=>\"1\"", markup.to_html)
-    assert_match("} )</p>", markup.to_html)
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:template( :html, [], {", html, text)
+    assert_match("\"two\"=>\"2\"", html, text)
+    assert_match("\"one\"=>\"1\"", html, text)
+    assert_match("}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_no_match(/<div/, html, text)
   end
 
   def test_mixed_args
     text = "{{ template | one | two = 2 | three }}"
-    markup = Marker.parse text
-    
-    assert_match("<p>render:template( :html, [\"one\", \"three\"], {\"two\"=>\"2\"} )</p>", markup.to_html)
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:template( :html, [\"one\", \"three\"], {\"two\"=>\"2\"}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_no_match(/<div/, html, text)
   end
 
   def test_empty_args
     text = "{{ template | }}"
-    markup = Marker.parse text
-    assert_match("<p>render:template( :html, [\"\"], {} )</p>", markup.to_html)
+    markup = parse_with_assertions text
+    html = markup.to_html
+    assert_match("render:template( :html, [\"\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_no_match(/<div/, html, text)
 
     text = "{{ template | | }}"
-    markup = Marker.parse text
-    assert_match("<p>render:template( :html, [\"\", \"\"], {} )</p>", markup.to_html)
+    markup = parse_with_assertions text
+    html = markup.to_html
+    assert_match("render:template( :html, [\"\", \"\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_no_match(/<div/, html, text)
   end
 
   def test_rendered_args
     text = "{{ template | [http://www.example.com Example] }}"
-    markup = Marker.parse text
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:template( :html, [\"<a href='http://www.example.com'>Example</a>\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_no_match(/<div/, html, text)
+  end
+
+  def test_escaped_characters
+    # keep in mind here that the default template rendering (that produces
+    # "render:name(*args)") inserts the template arguments by using
+    # String#inspect, so everything that is produced will be escaped.
+    text = '{{ template | \| | a \= b | \|a, b\| }}'
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    # escaping delimiters is not supported (and may not ever be)
+    #assert_match("render:template( :html, [\"|\", \"a = b\", \"|a, b|\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_no_match(/<div/, html, text)
+  end
+
+  def test_line_anchored_markup_inside_templates
+    text = "{{ ruby code |\n puts 'hello'\n}}"
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:ruby_code( :html, [\"<pre>\\nputs 'hello'\\n</pre>\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_match(/<div/, html, text)
+  end
+
+  def test_verbatim_arg_without_final_newline
+    text = "{{ ruby code |\n puts 'hello'}}"
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:ruby_code( :html, [\"<pre>\\nputs 'hello'\\n</pre>\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_match(/<div/, html, text)
+  end
+
+  def test_verbatim_arg_without_newline_before_pipe
+    text = "{{ ruby code |\n puts 'hello'| another arg }}"
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:ruby_code( :html, [\"<pre>\\nputs 'hello'\\n</pre>\", \"another arg\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_match(/<div/, html, text)
+  end
+
+  def test_line_anchored_markup_inside_templates_with_blank_lines
+    text = "{{ ruby code |\n puts 'hello'\n\n* list}}"
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:ruby_code( :html, [\"<pre>\\nputs 'hello'\\n</pre>\\n<ul><li>list</li></ul>\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_match(/<div/, html, text)
+  end
+
+  def test_multiline_inline_arguments
+    text = "this is a {{bold|paragraph\nwith some bold text}} in it."
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("this is a render:bold( :html, [\"paragraph with some bold text\"], {}, #{DEFAULT_OPTIONS} ) in it.", html, text)
+    assert_no_match(/<div/, html, text)
+  end
+
+  def test_multiparagraph_inline_arguments
+    text = "this is a {{bold|paragraph\n\nwith some bold text}} in it."
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("this is a <div class=\'bold\'>render:bold( :html, [\"<p>paragraph</p>\\n<p>with some bold text</p>\"], {}, #{DEFAULT_OPTIONS} )</div> in it.", html, text)
+    assert_match(/<div/, html, text)
+  end
+
+  def test_list_with_starting_newline
+    text = "{{ inner list |\n* list item 1\n*list item 2}}"
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:inner_list( :html, [\"<ul><li>list item 1</li><li>list item 2</li></ul>\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_match(/<div/, html, text)
+  end
+
+  def test_list_with_starting_unsafe_text
+    # you might expect this to render as a two-item list, but this is one of
+    # the ways Marker differs with MediaWiki. For consistency, Marker will not
+    # treat any text that doesn't appear at the start a line as line anchored
+    # markup. Otherwise, cases like this would behave strangely:
+    # {{ template | should this be verbatim? }}
+    #
+    text = "{{ inner list |* list item 1\n*list item 2}}"
+    markup = parse_with_assertions text
+    html = markup.to_html
+
+    assert_match("render:inner_list( :html, [\"<p>* list item 1</p>\\n<ul><li>list item 2</li></ul>\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_match(/<div/, html, text)
+  end
+
+  def test_forced_block_argument
+    text = "{{ block |\nnormal text}}"
+    markup = parse_with_assertions text
+    html = markup.to_html
 
-    assert_match("<p>render:template( :html, [\"<a href='http://www.example.com'>Example</a>\"], {} )</p>", markup.to_html)
+    assert_match("render:block( :html, [\"<p>normal text</p>\"], {}, #{DEFAULT_OPTIONS} )", html, text)
+    assert_match(/<div/, html, text)
   end
 
 end

data/test/test_helper.rb

@@ -1,2 +1,13 @@
 require 'test/unit'
-$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../lib' )
+$LOAD_PATH.unshift File.expand_path( File.dirname(__FILE__) + '/../lib' )
+
+class MarkerTest < Test::Unit::TestCase
+  def parse_with_assertions( text )
+    tree = nil
+    assert_nothing_raised do
+      tree = Marker.parse( text )
+    end
+    assert_not_nil( tree, Marker.parser.failure_reason )
+    tree
+  end
+end

metadata

@@ -1,95 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: marker
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 3
-  version: 0.3.3
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ryan Blue
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-03 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: treetop
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 2
-        version: 1.4.2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: 
 email: rdblue@gmail.com
-executables: 
+executables:
 - marker
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
 - LICENSE
-files: 
+files:
 - bin/marker
+- lib/marker.rb
+- lib/marker/links.rb
 - lib/marker/common.rb
+- lib/marker/templates.rb
 - lib/marker/lists.rb
-- lib/marker/headings.rb
-- lib/marker/text.rb
 - lib/marker/markup.rb
+- lib/marker/text.rb
+- lib/marker/headings.rb
 - lib/marker/verbatim.rb
-- lib/marker/links.rb
-- lib/marker/templates.rb
-- lib/marker.rb
 - lib/marker/language.treetop
 - README
 - LICENSE
-has_rdoc: true
+- test/encodings_test.rb
+- test/headings_test.rb
+- test/formatting_test.rb
+- test/lists_test.rb
+- test/links_test.rb
+- test/test_helper.rb
+- test/templates_test.rb
+- test/verbatim_test.rb
+- test/helper.rb
 homepage: http://github.com/rdblue/marker
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A markup parser that outputs html and text.  Syntax is similar to MediaWiki.
-test_files: 
-- test/verbatim_test.rb
+test_files:
+- test/encodings_test.rb
 - test/headings_test.rb
-- test/links_test.rb
-- test/test_helper.rb
 - test/formatting_test.rb
-- test/encodings_test.rb
 - test/lists_test.rb
+- test/links_test.rb
+- test/test_helper.rb
 - test/templates_test.rb
+- test/verbatim_test.rb
+- test/helper.rb