bluecloth 2.0.0

data/spec/bluecloth/paragraphs_spec.rb

@@ -0,0 +1,75 @@
+#!/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 paragraphs" do
+	include BlueCloth::TestConstants,
+	        BlueCloth::Matchers
+
+	it "wraps them in P tags" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		This is some stuff that should all be
+		put in one paragraph
+		even though
+		it occurs over several lines.
+
+		And this is a another
+		one.
+		---
+		<p>This is some stuff that should all be
+		put in one paragraph
+		even though
+		it occurs over several lines.</p>
+
+		<p>And this is a another
+		one.</p>
+		---
+	end
+
+	it "transforms trailing double spaces to line breaks" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Mostly the same kind of thing  
+		with two spaces at the end  
+		of each line  
+		should result in  
+		line breaks, though.
+
+		And this is a another  
+		one.
+		---
+		<p>Mostly the same kind of thing<br/>
+		with two spaces at the end<br/>
+		of each line<br/>
+		should result in<br/>
+		line breaks, though.</p>
+
+		<p>And this is a another<br/>
+		one.</p>
+		---
+	end
+
+end
+
+

data/spec/bluecloth/titles_spec.rb

@@ -0,0 +1,305 @@
+#!/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, "titles" do
+	include BlueCloth::TestConstants,
+	        BlueCloth::Matchers
+
+	# setext-style h1 -- three characters
+	it "transforms Setext-style level-one headers (three equals) into an H1" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Title Text
+		===
+		---
+		<h1>Title Text</h1>
+		---
+	end
+
+	# setext-style h1 -- match title width
+	it "transforms Setext-style level-one headers (more than three equals) into an H1" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Title Text
+		==========
+		---
+		<h1>Title Text</h1>
+		---
+	end
+
+
+	# setext-style h2 -- one character
+	it "transforms Setext-style level-two headers (one dash) into an H2" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		Title Text
+		-
+		---
+		<h2>Title Text</h2>
+		---
+	end
+
+	# setext-style h2 -- three characters
+	it "transforms Setext-style level-two headers (three dashes) into an H2" do
+		the_indented_markdown( <<-"..." ).should be_transformed_into(<<-"...").without_indentation
+		Title Text
+		---
+		...
+		<h2>Title Text</h2>
+		...
+	end
+
+	# setext-style h2 -- match title width
+	it "transforms Setext-style level-two headers (more than three dashes) into an H2" do
+		the_indented_markdown( <<-"..." ).should be_transformed_into(<<-"...").without_indentation
+		Title Text
+		----------
+		...
+		<h2>Title Text</h2>
+		...
+	end
+
+	# ATX-style h1 -- Left side only
+	it "makes a header out of an ATX-style h1 -- Left side only" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		# Title Text
+		---
+		<h1>Title Text</h1>
+		---
+	end
+
+	# ATX-style h1 -- both sides
+	it "makes a header out of an ATX-style h1 -- both sides" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		# Title Text #
+		---
+		<h1>Title Text</h1>
+		---
+	end
+
+	# ATX-style h1 -- both sides, right side with three characters
+	it "makes a header out of an ATX-style h1 -- both sides, right side with three characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		# Title Text ###
+		---
+		<h1>Title Text</h1>
+		---
+	end
+
+	# ATX-style h1 -- both sides, right side with five characters
+	it "makes a header out of an ATX-style h1 -- both sides, right side with five characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		# Title Text #####
+		---
+		<h1>Title Text</h1>
+		---
+	end
+
+
+	# ATX-style h2 -- left side only
+	it "makes a header out of an ATX-style h2 -- left side only" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		## Title Text
+		---
+		<h2>Title Text</h2>
+		---
+	end
+
+	# ATX-style h2 -- both sides
+	it "makes a header out of an ATX-style h2 -- both sides" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		## Title Text #
+		---
+		<h2>Title Text</h2>
+		---
+	end
+
+	# ATX-style h2 -- both sides, right side with three characters
+	it "makes a header out of an ATX-style h2 -- both sides, right side with three characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		## Title Text ###
+		---
+		<h2>Title Text</h2>
+		---
+	end
+
+	# ATX-style h2 -- both sides, right side with five characters
+	it "makes a header out of an ATX-style h2 -- both sides, right side with five characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		## Title Text #####
+		---
+		<h2>Title Text</h2>
+		---
+	end
+
+
+	# ATX-style h3 -- left side only
+	it "makes a header out of an ATX-style h3 -- left side only" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		### Title Text
+		---
+		<h3>Title Text</h3>
+		---
+	end
+
+	# ATX-style h3 -- both sides, right side with one character
+	it "makes a header out of an ATX-style h3 -- both sides, right side with one character" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		### Title Text #
+		---
+		<h3>Title Text</h3>
+		---
+	end
+
+	# ATX-style h3 -- both sides, right side with three characters
+	it "makes a header out of an ATX-style h3 -- both sides, right side with three characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		### Title Text ###
+		---
+		<h3>Title Text</h3>
+		---
+	end
+
+	# ATX-style h3 -- both sides, right side with five characters
+	it "makes a header out of an ATX-style h3 -- both sides, right side with five characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		### Title Text #####
+		---
+		<h3>Title Text</h3>
+		---
+	end
+
+
+	# ATX-style h4 -- left side only
+	it "makes a header out of an ATX-style h4 -- left side only" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		#### Title Text
+		---
+		<h4>Title Text</h4>
+		---
+	end
+
+	# ATX-style h4 -- both sides, right side with one character
+	it "makes a header out of an ATX-style h4 -- both sides, right side with one character" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		#### Title Text #
+		---
+		<h4>Title Text</h4>
+		---
+	end
+
+	# ATX-style h4 -- both sides, right side with three characters
+	it "makes a header out of an ATX-style h4 -- both sides, right side with three characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		#### Title Text ###
+		---
+		<h4>Title Text</h4>
+		---
+	end
+
+	# ATX-style h4 -- both sides, right side with five characters
+	it "makes a header out of an ATX-style h4 -- both sides, right side with five characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		#### Title Text #####
+		---
+		<h4>Title Text</h4>
+		---
+	end
+
+
+	# ATX-style h5 -- left side only
+	it "makes a header out of an ATX-style h5 -- left side only" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		##### Title Text
+		---
+		<h5>Title Text</h5>
+		---
+	end
+
+	# ATX-style h5 -- both sides, right side with one character
+	it "makes a header out of an ATX-style h5 -- both sides, right side with one character" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		##### Title Text #
+		---
+		<h5>Title Text</h5>
+		---
+	end
+
+	# ATX-style h5 -- both sides, right side with three characters
+	it "makes a header out of an ATX-style h5 -- both sides, right side with three characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		##### Title Text ###
+		---
+		<h5>Title Text</h5>
+		---
+	end
+
+	# ATX-style h5 -- both sides, right side with five characters
+	it "makes a header out of an ATX-style h5 -- both sides, right side with five characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		##### Title Text #####
+		---
+		<h5>Title Text</h5>
+		---
+	end
+
+
+	# ATX-style h6 -- left side only
+	it "makes a header out of an ATX-style h6 -- left side only" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		###### Title Text
+		---
+		<h6>Title Text</h6>
+		---
+	end
+
+	# ATX-style h6 -- both sides, right side with one character
+	it "makes a header out of an ATX-style h6 -- both sides, right side with one character" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		###### Title Text #
+		---
+		<h6>Title Text</h6>
+		---
+	end
+
+	# ATX-style h6 -- both sides, right side with three characters
+	it "makes a header out of an ATX-style h6 -- both sides, right side with three characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		###### Title Text ###
+		---
+		<h6>Title Text</h6>
+		---
+	end
+
+	# ATX-style h6 -- both sides, right side with five characters
+	it "makes a header out of an ATX-style h6 -- both sides, right side with five characters" do
+		the_indented_markdown( <<-"---" ).should be_transformed_into(<<-"---").without_indentation
+		###### Title Text #####
+		---
+		<h6>Title Text</h6>
+		---
+	end
+
+end
+
+

data/spec/bluecloth_spec.rb

@@ -0,0 +1,209 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.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'
+
+
+### Output some debugging if $DEBUG is true
+def debug_msg( *args )
+	$stderr.puts( *args ) if $DEBUG
+end
+
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe BlueCloth do
+	include BlueCloth::TestConstants,
+		BlueCloth::Matchers
+
+
+	it "knows what version of Discount was used to build it" do
+		BlueCloth.discount_version.should =~ /^\d+\.\d+\.\d+.*RELAXED/
+	end
+
+	it "can build a flags bitmask out of an options hash" do
+		flags = BlueCloth.flags_from_opthash(
+			:remove_links => true,
+			:header_labels => true,
+			:pandoc_headers => false
+		  )
+		
+		( flags & BlueCloth::MKD_NOLINKS ).should be_nonzero()
+		( flags & BlueCloth::MKD_TOC ).should be_nonzero()
+		( flags & BlueCloth::MKD_NOHEADER ).should be_nonzero()
+	end
+	
+	
+	it "allows output to be rendered several times" do
+		bc = BlueCloth.new( "Some text" )
+		bc.to_html.should == bc.to_html
+	end
+	
+	
+	it "correctly applies the :remove_links option to the output" do
+		input = "An [example](http://url.com/). A <a href='http://example.com/'>link</a>."
+		expected = "<p>An [example](http://url.com/). A &lt;a href='http://example.com/'>link</a>.</p>"
+
+		the_markdown( input, :remove_links => true ).should be_transformed_into( expected )
+	end
+	
+	it "correctly applies the :remove_images option to the output" do
+		input = %{An ![alt text](/path/img.jpg "Title"). An <img href='http://example.com/1.jpg' />.}
+		expected = %{<p>An ![alt text](/path/img.jpg "Title"). An &lt;img href='http://example.com/1.jpg' />.</p>}
+
+		the_markdown( input, :remove_images => true ).should be_transformed_into( expected )
+	end
+	
+	it "correctly applies the :smartypants option to the output" do
+		input = %{He was known to frequent that "other establishment"...}
+		expected = %{<p>He was known to frequent that &ldquo;other establishment&rdquo;&hellip;</p>}
+
+		the_markdown( input, :smartypants => true ).should be_transformed_into( expected )
+	end
+
+
+	describe "Discount extensions" do
+	
+		it "correctly applies the :pandoc_headers option" do
+			input = "% title\n% author1, author2\n% date\n\nStuff."
+			
+			bc = BlueCloth.new( input, :pandoc_headers => true )
+			bc.header.should == {
+				:title => 'title',
+				:author => 'author1, author2',
+				:date => 'date'
+			}
+			bc.to_html.should == '<p>Stuff.</p>'
+		end
+
+		it "correctly expands id: links when :pseudoprotocols are enabled" do
+			input = "It was [just as he said](id:foo) it would be."
+			expected = %{<p>It was <a id="foo">just as he said</a> it would be.</p>}
+
+			the_markdown( input, :pseudoprotocols => true ).should be_transformed_into( expected )
+		end
+		
+		it "correctly expands class: links when :pseudoprotocols are enabled" do
+			input = "It was [just as he said](class:foo) it would be."
+			expected = %{<p>It was <span class="foo">just as he said</span> it would be.</p>}
+
+			the_markdown( input, :pseudoprotocols => true ).should be_transformed_into( expected )
+		end
+		
+		it "correctly expands raw: links when :pseudoprotocols are enabled" do
+			input = %{I have node idea [what this is for](raw:really "but") it's here.}
+			expected = %{<p>I have node idea really it's here.</p>}
+
+			the_markdown( input, :pseudoprotocols => true ).should be_transformed_into( expected )
+		end
+
+		it "correctly adds IDs to headers when :header_labels is enabled" do
+			input = %{# A header\n\nSome stuff\n\n## Another header\n\nMore stuff.\n\n}
+			expected = %{<h1 id=\"A+header\">A header</h1>\n\n<p>Some stuff</p>\n\n} +
+			           %{<h2 id=\"Another+header\">Another header</h2>\n\n<p>More stuff.</p>}
+
+			the_markdown( input, :header_labels => true ).should be_transformed_into( expected )
+		end
+		
+		it "expands superscripts when :strict_mode is disabled" do
+			input = %{It used to be that E = mc^2 used to be the province of physicists.}
+			expected = %{<p>It used to be that E = mc<sup>2</sup> used to be the province} +
+			           %{ of physicists.</p>}
+			strict = %{<p>It used to be that E = mc^2 used to be the province} +
+			         %{ of physicists.</p>}
+
+			the_markdown( input, :strict_mode => false ).should be_transformed_into( expected )
+			the_markdown( input, :strict_mode => true ).should be_transformed_into( strict )
+		end
+		
+		it "uses relaxed emphasis when :strict_mode is disabled" do
+			input = %{If you use size_t instead, you _won't_ have to worry as much about portability.}
+			expected = %{<p>If you use size_t instead, you <em>won't</em> have to worry as much about portability.</p>}
+			strict = %{<p>If you use size<em>t instead, you </em>won't_ have to worry as much about portability.</p>}
+
+			the_markdown( input, :strict_mode => false ).should be_transformed_into( expected )
+			the_markdown( input, :strict_mode => true ).should be_transformed_into( strict )
+		end
+		
+	end
+
+	### Test email address output
+	describe " email obfuscation" do
+		TESTING_EMAILS = %w[
+			address@example.com
+			foo-list-admin@bar.com
+			fu@bar.COM
+			baz@ruby-lang.org
+			foo-tim-bazzle@bar-hop.co.uk
+			littlestar@twinkle.twinkle.band.CO.ZA
+			ll@lll.lllll.ll
+			Ull@Ulll.Ulllll.ll
+			UUUU1@UU1.UU1UUU.UU
+			l@ll.ll
+			Ull.Ullll@llll.ll
+			Ulll-Ull.Ulllll@ll.ll
+			1@111.ll
+		]
+		# I can't see a way to handle IDNs clearly yet, so these will have to wait.
+		#	info@öko.de
+		#	jemand@büro.de
+		#	irgendwo-interreßant@dÅgta.se
+		#]
+
+		def decode( str )
+			str.gsub( /&#(x[a-f0-9]+|\d{1,3});/i ) do |match|
+				code = $1
+				debug_msg "Decoding &##{code};"
+
+				case code
+				when /^x([a-f0-9]+)/i
+					debug_msg "-> #{$1.to_i(16).chr}"
+					$1.to_i(16).chr
+				when /^\d+$/
+					debug_msg "-> #{code.to_i.chr}"
+					code.to_i.chr
+				else
+					raise "Hmmm... malformed entity %p" % code
+				end
+			end
+		end
+
+		TESTING_EMAILS.each do |addr|
+			it( "obfuscates the email address %p" % addr ) do
+				html = BlueCloth.new( "<#{addr}>" ).to_html
+
+				expected_output = %r{<p><a href="([^"]+)">[^<]+</a></p>}
+				match = expected_output.match( html )
+				match.should be_an_instance_of( MatchData )
+
+				match[1].should_not == addr
+
+				decoded_href = decode( match[1] )
+				debug_msg "Unencoded href = %p" % [ decoded_href ]
+				decoded_href.should == "mailto:#{addr}"
+			end
+		end
+	end
+
+end
+
+# vim: set nosta noet ts=4 sw=4: