bluecloth 2.0.0

data/spec/bluecloth/emphasis_spec.rb

@@ -0,0 +1,164 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+	
+	libdir = basedir + 'lib'
+	extdir = basedir + 'ext'
+	
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+	$LOAD_PATH.unshift( extdir ) unless $LOAD_PATH.include?( extdir )
+}
+
+require 'spec'
+require 'bluecloth'
+
+require 'spec/lib/helpers'
+require 'spec/lib/constants'
+require 'spec/lib/matchers'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe BlueCloth, "emphasis" do
+	include BlueCloth::TestConstants,
+	        BlueCloth::Matchers
+
+	it "treats single asterisks as indicators of emphasis" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Use *single splats* for emphasis.
+		---
+		<p>Use <em>single splats</em> for emphasis.</p>
+		---
+	end
+
+	it "treats single underscores as indicators of emphasis" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Use *underscores* for emphasis.
+		---
+		<p>Use <em>underscores</em> for emphasis.</p>
+		---
+	end
+
+	it "treats double asterisks as strong emphasis" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Use **double splats** for more emphasis.
+		---
+		<p>Use <strong>double splats</strong> for more emphasis.</p>
+		---
+	end
+
+	it "treats double underscores as strong emphasis" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Use __doubled underscores__ for more emphasis.
+		---
+		<p>Use <strong>doubled underscores</strong> for more emphasis.</p>
+		---
+	end
+
+	it "allows you to use both kinds of emphasis in a single span" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Use *single splats* or _single unders_ for normal emphasis.
+		---
+		<p>Use <em>single splats</em> or <em>single unders</em> for normal emphasis.</p>
+		---
+	end
+
+	it "allows you to use both kinds of strong emphasis in a single span" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Use _single unders_ for normal emphasis
+		or __double them__ for strong emphasis.
+		---
+		<p>Use <em>single unders</em> for normal emphasis
+		or <strong>double them</strong> for strong emphasis.</p>
+		---
+	end
+
+	it "allows you to include literal asterisks by escaping them" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		You can include literal *\\*splats\\** by escaping them.
+		---
+		<p>You can include literal <em>*splats*</em> by escaping them.</p>
+		---
+	end
+
+	it "allows two instances of asterisked emphasis on one line" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		If there's *two* splatted parts on a *single line* it should still work.
+		---
+		<p>If there's <em>two</em> splatted parts on a <em>single line</em> it should still work.</p>
+		---
+	end
+
+	it "allows two instances of double-asterisked emphasis on one line" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This **doubled** one should **work too**.
+		---
+		<p>This <strong>doubled</strong> one should <strong>work too</strong>.</p>
+		---
+	end
+
+	it "allows two instances of underscored emphasis on one line" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		If there's _two_ underbarred parts on a _single line_ it should still work.
+		---
+		<p>If there's <em>two</em> underbarred parts on a <em>single line</em> it should still work.</p>
+		---
+	end
+
+	it "allows two instances of double-underscored emphasis on one line" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This __doubled__ one should __work too__.
+		---
+		<p>This <strong>doubled</strong> one should <strong>work too</strong>.</p>
+		---
+	end
+
+	it "correctly emphasizes the first span of the text if it's emphasized with asterisks" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		*Something* like this should be bold.
+		---
+		<p><em>Something</em> like this should be bold.</p>
+		---
+	end
+
+	it "correctly emphasizes the first span of the text if it's emphasized with underscores" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		_Something_ like this should be bold.
+		---
+		<p><em>Something</em> like this should be bold.</p>
+		---
+	end
+
+	it "correctly emphasizes the first span of the text if it's emphasized with double asterisks" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		**Something** like this should be bold.
+		---
+		<p><strong>Something</strong> like this should be bold.</p>
+		---
+	end
+
+	it "correctly emphasizes the first span of the text if it's emphasized with double underscores" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		__Something__ like this should be bold.
+		---
+		<p><strong>Something</strong> like this should be bold.</p>
+		---
+	end
+
+	# Partial-word emphasis (Bug #568)
+	it "correctly emphasizes just a part of a word (bugfix for #568)" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		**E**xtended **TURN**
+		---
+		<p><strong>E</strong>xtended <strong>TURN</strong></p>
+		---
+	end
+
+end
+
+

data/spec/bluecloth/entities_spec.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+	
+	libdir = basedir + 'lib'
+	extdir = basedir + 'ext'
+	
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+	$LOAD_PATH.unshift( extdir ) unless $LOAD_PATH.include?( extdir )
+}
+
+require 'spec'
+require 'bluecloth'
+
+require 'spec/lib/helpers'
+require 'spec/lib/constants'
+require 'spec/lib/matchers'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe BlueCloth, "document with entities" do
+	include BlueCloth::TestConstants,
+	        BlueCloth::Matchers
+
+	it "escapes special characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		The left shift operator, which is written as <<, is often used & greatly admired.
+		---
+		<p>The left shift operator, which is written as &lt;&lt;, is often used &amp; greatly admired.</p>
+		---
+	end
+
+	it "preserves named entities" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		The left shift operator, which is written as &lt;&lt;, is often used &amp; greatly admired.
+		---
+		<p>The left shift operator, which is written as &lt;&lt;, is often used &amp; greatly admired.</p>
+		---
+	end
+
+	it "preserves decimal-encoded entities" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		The left shift operator, which is written as &#060;&#060;, is often used &#038; greatly admired.
+		---
+		<p>The left shift operator, which is written as &#060;&#060;, is often used &#038; greatly admired.</p>
+		---
+	end
+
+	it "preserves hex-encoded entities" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		The left shift operator, which is written as &#x3c;&#x3c;, is often used &#x26; greatly admired.
+		---
+		<p>The left shift operator, which is written as &#x3c;&#x3c;, is often used &#x26; greatly admired.</p>
+		---
+	end
+
+end
+
+

data/spec/bluecloth/hrules_spec.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+	
+	libdir = basedir + 'lib'
+	extdir = basedir + 'ext'
+	
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+	$LOAD_PATH.unshift( extdir ) unless $LOAD_PATH.include?( extdir )
+}
+
+require 'spec'
+require 'bluecloth'
+
+require 'spec/lib/helpers'
+require 'spec/lib/constants'
+require 'spec/lib/matchers'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe BlueCloth, "horizontal rules" do
+	include BlueCloth::TestConstants,
+	        BlueCloth::Matchers
+
+	# Hrule -- three asterisks
+	it "produces a horizontal rule tag from three asterisks on a line by themselves" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		***
+		---
+		<hr />
+		---
+	end
+
+	# Hrule -- three spaced-out asterisks
+	it "produces a horizontal rule tag from three asterisks with intervening spaces on a line " +
+	   " by themselves" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		* * *
+		---
+		<hr />
+		---
+	end
+
+	# Indented Hrule -- three spaced-out asterisks
+	it "produces a horizontal rule tag from three asterisks with intervening spaces on a line " +
+	   " by themselves, even if they're indented less than 4 spaces" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		   * * *
+		---
+		<hr />
+		---
+	end
+
+	# Hrule -- more than three asterisks
+	it "produces a horizontal rule tag from more than three asterisks on a line by themselves" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		*****
+		---
+		<hr />
+		---
+	end
+
+	# Hrule -- a line of dashes
+	it "produces a horizontal rule tag from three dashes on a line by themselves" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		---------------------------------------
+		---
+		<hr />
+		---
+	end
+
+	# Hrule -- three spaced-out dashes
+	it "produces a horizontal rule tag from three dashes with intervening spaces on a line " +
+	   " by themselves" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		- - -
+		---
+		<hr />
+		---
+	end
+
+end
+
+

data/spec/bluecloth/images_spec.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+	
+	libdir = basedir + 'lib'
+	extdir = basedir + 'ext'
+	
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+	$LOAD_PATH.unshift( extdir ) unless $LOAD_PATH.include?( extdir )
+}
+
+require 'spec'
+require 'bluecloth'
+
+require 'spec/lib/helpers'
+require 'spec/lib/constants'
+require 'spec/lib/matchers'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe BlueCloth, "images" do
+	include BlueCloth::TestConstants,
+	        BlueCloth::Matchers
+
+	### [Images]
+
+	# Inline image with title
+	it "transforms inline images with a title in double quotes to an IMG tag" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		![alt text](/path/img.jpg "Title")
+		---
+		<p><img src="/path/img.jpg" title="Title" alt="alt text" /></p>
+		---
+	end
+
+	# Inline image with title (single-quotes)
+	it "transforms inline images with a title in single quotes to an IMG tag" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		![alt text](/path/img.jpg 'Title')
+		---
+		<p><img src="/path/img.jpg" title="Title" alt="alt text" /></p>
+		---
+	end
+
+	# Inline image with title (with embedded quotes)
+	it "transforms inline images with a title that includes quotes to an IMG tag" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		![alt text](/path/img.jpg 'The "Title" Image')
+		---
+		<p><img src="/path/img.jpg" title="The &quot;Title&quot; Image" alt="alt text" /></p>
+		---
+	end
+
+	# Inline image without title
+	it "transforms inline images without a title to an IMG tag" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		![alt text](/path/img.jpg)
+		---
+		<p><img src="/path/img.jpg" alt="alt text" /></p>
+		---
+	end
+
+	# Inline image with quoted alt text
+	it "transforms inline images with quoted alt text to an IMG tag" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		![the "alt text"](/path/img.jpg)
+		---
+		<p><img src="/path/img.jpg" alt="the &quot;alt text&quot;" /></p>
+		---
+	end
+
+
+	# Reference image
+	it "transforms image references with a title to an IMG tag" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		![alt text][id]
+
+		[id]: /url/to/img.jpg "Title"
+		---
+		<p><img src="/url/to/img.jpg" title="Title" alt="alt text" /></p>
+		---
+	end
+
+end
+
+

data/spec/bluecloth/inline_html_spec.rb

@@ -0,0 +1,238 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+	
+	libdir = basedir + 'lib'
+	extdir = basedir + 'ext'
+	
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+	$LOAD_PATH.unshift( extdir ) unless $LOAD_PATH.include?( extdir )
+}
+
+require 'spec'
+require 'bluecloth'
+
+require 'spec/lib/helpers'
+require 'spec/lib/constants'
+require 'spec/lib/matchers'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe BlueCloth, "document with inline HTML" do
+	include BlueCloth::TestConstants,
+	        BlueCloth::Matchers
+
+	it "preserves TABLE block" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is a regular paragraph.
+
+		<table>
+		    <tr>
+		        <td>Foo</td>
+		    </tr>
+		</table>
+
+		This is another regular paragraph.
+		---
+		<p>This is a regular paragraph.</p>
+
+		<table>
+		    <tr>
+		        <td>Foo</td>
+		    </tr>
+		</table>
+
+		<p>This is another regular paragraph.</p>
+		---
+	end
+
+	it "preserves DIV block" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is a regular paragraph.
+
+		<div>
+		   Something
+		</div>
+		Something else.
+		---
+		<p>This is a regular paragraph.</p>
+
+		<div>
+		   Something
+		</div>
+
+		<p>Something else.</p>
+		---
+	end
+
+
+	it "preserves HRs" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is a regular paragraph.
+
+		<hr />
+
+		Something else.
+		---
+		<p>This is a regular paragraph.</p>
+
+		<hr />
+
+		<p>Something else.</p>
+		---
+	end
+
+
+	it "preserves fancy HRs" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is a regular paragraph.
+
+		<hr class="publishers-mark" id="first-hrule" />
+
+		Something else.
+		---
+		<p>This is a regular paragraph.</p>
+
+		<hr class="publishers-mark" id="first-hrule" />
+
+		<p>Something else.</p>
+		---
+	end
+
+
+	it "preserves IFRAMEs" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is a regular paragraph.
+
+		<iframe src="foo.html" id="foo-frame"></iframe>
+
+		Something else.
+		---
+		<p>This is a regular paragraph.</p>
+
+		<iframe src="foo.html" id="foo-frame"></iframe>
+
+		<p>Something else.</p>
+		---
+	end
+
+
+	it "preserves MathML block" do
+		pending "discount doesn't support this, it explicitly matches block-level HTML elements only"
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Examples
+		--------
+		
+		Now that we have met some of the key players, it is time to see what we can
+		do. Here are some examples and comments which illustrate the use of the basic
+		layout and token elements. Consider the expression x2 + 4x + 4 = 0. A basic
+		MathML presentation encoding for this would be:
+		
+		<math>
+		  <mrow>
+			<msup>
+			  <mi>x</mi>
+			  <mn>2</mn>
+			</msup>
+			<mo>+</mo>
+			<mn>4</mn>
+			<mi>x</mi>
+			<mo>+</mo>
+			<mn>4</mn>
+			<mo>=</mo>
+			<mn>0</mn>
+		  </mrow>
+		</math>
+		
+		This encoding will display as you would expect. However, if we were interested
+		in reusing this expression in unknown situations, we would likely want to spend
+		a little more effort analyzing and encoding the logical expression structure.
+		---
+		<h2>Examples</h2>
+		
+		<p>Now that we have met some of the key players, it is time to see what we can
+		do. Here are some examples and comments which illustrate the use of the basic
+		layout and token elements. Consider the expression x2 + 4x + 4 = 0. A basic
+		MathML presentation encoding for this would be:</p>
+		
+		<math>
+		  <mrow>
+		    <msup>
+		      <mi>x</mi>
+		      <mn>2</mn>
+		    </msup>
+		    <mo>+</mo>
+		    <mn>4</mn>
+		    <mi>x</mi>
+		    <mo>+</mo>
+		    <mn>4</mn>
+		    <mo>=</mo>
+		    <mn>0</mn>
+		  </mrow>
+		</math>
+		
+		<p>This encoding will display as you would expect. However, if we were interested
+		in reusing this expression in unknown situations, we would likely want to spend
+		a little more effort analyzing and encoding the logical expression structure.</p>
+		---
+	end
+
+
+	it "preserves span-level HTML" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is some stuff with a <span class="foo">spanned bit of text</span> in
+		it. And <del>this *should* be a bit of deleted text</del> which should be
+		preserved, and part of it emphasized.
+		---
+		<p>This is some stuff with a <span class="foo">spanned bit of text</span> in
+		it. And <del>this <em>should</em> be a bit of deleted text</del> which should be
+		preserved, and part of it emphasized.</p>
+		---
+	end
+
+	it "preserves block-level HTML case-insensitively" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is a regular paragraph.
+
+		<TABLE>
+		    <TR>
+		        <TD>Foo</TD>
+		    </TR>
+		</TABLE>
+
+		This is another regular paragraph.
+		---
+		<p>This is a regular paragraph.</p>
+
+		<TABLE>
+		    <TR>
+		        <TD>Foo</TD>
+		    </TR>
+		</TABLE>
+
+		<p>This is another regular paragraph.</p>
+		---
+	end
+
+	it "preserves span-level HTML case-insensitively" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is some stuff with a <SPAN CLASS="foo">spanned bit of text</SPAN> in
+		it. And <DEL>this *should* be a bit of deleted text</DEL> which should be
+		preserved, and part of it emphasized.
+		---
+		<p>This is some stuff with a <SPAN CLASS="foo">spanned bit of text</SPAN> in
+		it. And <DEL>this <em>should</em> be a bit of deleted text</DEL> which should be
+		preserved, and part of it emphasized.</p>
+		---
+	end
+
+
+end
+
+