Add formatter class and associated unit tests

tests/_data/formatter/bbcode.source.txt

@@ -0,0 +1,6 @@
+This is the first paragraph.
+It contains [b]bold[/b] [i]italic[/i] text.
+
+[quote]This is quoted text.[/quote]
+
+This example belongs to the test suite for [url="https://www.rhymix.org"]Rhymix[/url].

tests/_data/formatter/bbcode.target.html

@@ -0,0 +1,6 @@
+This is the first paragraph.
+It contains <strong>bold</strong> <em>italic</em> text.
+
+<blockquote>This is quoted text.</blockquote>
+
+This example belongs to the test suite for <a href="https://www.rhymix.org">Rhymix</a>.

tests/_data/formatter/html2markdown.source.html

@@ -0,0 +1,13 @@
+<p>This is a Markdown document.
+These lines belong in the same paragraph.
+Markdown usually ignores single line breaks.
+</p>
+
+<p>This is a <a href="foobar.html" title="title">link</a>.<br />
+This is an <img src="foobar.jpg" title="image" alt="alt" />.
+</p>
+
+<ul>
+  <li>This is a list.</li>
+  <li>It has two items.</li>
+</ul>

tests/_data/formatter/html2markdown.target.md

@@ -0,0 +1,7 @@
+This is a Markdown document. These lines belong in the same paragraph. Markdown usually ignores single line breaks.
+
+This is a [link](foobar.html "title").  
+ This is an ![alt](foobar.jpg "image").
+
+- This is a list.
+- It has two items.

tests/_data/formatter/html2text.source.html

@@ -0,0 +1,13 @@
+<p>
+This is a sample text file.<br />
+This is a paragraph with multiple lines.<br />
+This is the third line.
+</p>
+<p>
+This is another paragraph.
+</p>
+<p>
+This is a <span>SPAN</span> element that will be stripped away.<br />
+This is a <a href="foobar.html">link</a> that will be preserved.<br />
+This is an <img src="test.jpg" alt="Image Title" /> that will be preserved.<br />
+</p>

tests/_data/formatter/html2text.target.txt

@@ -0,0 +1,9 @@
+This is a sample text file.
+This is a paragraph with multiple lines.
+This is the third line.
+
+This is another paragraph.
+
+This is a SPAN element that will be stripped away.
+This is a link <foobar.html> that will be preserved.
+This is an [Image Title] <test.jpg> that will be preserved.

tests/_data/formatter/less.source1.less

@@ -0,0 +1,3 @@
+.myfunction(@size) {
+	margin: @size;
+}

tests/_data/formatter/less.source2.less

@@ -0,0 +1,7 @@
+.rhymix {
+	color: @foo;
+	background: url('foo/bar.jpg');
+	span {
+		.myfunction(@bar);
+	}
+}

tests/_data/formatter/less.target1.css

@@ -0,0 +1,9 @@
+@charset "UTF-8";
+.rhymix {
+  color: #123456;
+  background: url("../_data/formatter/foo/bar.jpg");
+}
+.rhymix span {
+  margin: 320px;
+}
+

tests/_data/formatter/less.target2.css

@@ -0,0 +1,2 @@
+@charset "UTF-8";
+.rhymix{color:#123456;background:url("../_data/formatter/foo/bar.jpg");}.rhymix span{margin:320px;}

tests/_data/formatter/markdown2html.source.md

@@ -0,0 +1,17 @@
+This is a Markdown document.
+These lines belong in the same paragraph.
+Markdown usually ignores single line breaks.
+
+    This is an indented code segment.
+    All Markdown variants will recognize it.
+
+```
+This is a fenced code segment.
+Only Markdown Extra will recognize it.
+```
+
+This is a [link](foobar.html).
+This is an ![image](foobar.jpg).
+
+  - This is a list.
+  - It has two items.

tests/_data/formatter/markdown2html.target1.html

@@ -0,0 +1,17 @@
+<p>This is a Markdown document.
+These lines belong in the same paragraph.
+Markdown usually ignores single line breaks.</p>
+
+<pre><code>This is an indented code segment.
+All Markdown variants will recognize it.
+</code></pre>
+
+<p><code>This is a fenced code segment.
+Only Markdown Extra will recognize it.</code></p>
+
+<p>This is a <a href="foobar.html">link</a>.
+This is an <img src="foobar.jpg" alt="image" />.</p>
+
+<ul><li>This is a list.</li>
+<li>It has two items.</li>
+</ul>

tests/_data/formatter/markdown2html.target2.html

@@ -0,0 +1,17 @@
+<p>This is a Markdown document.<br />
+These lines belong in the same paragraph.<br />
+Markdown usually ignores single line breaks.</p>
+
+<pre><code>This is an indented code segment.  
+All Markdown variants will recognize it.
+</code></pre>
+
+<p><code>This is a fenced code segment.  
+Only Markdown Extra will recognize it.</code></p>
+
+<p>This is a <a href="foobar.html">link</a>.<br />
+This is an <img src="foobar.jpg" alt="image" />.</p>
+
+<ul><li>This is a list.  </li>
+<li>It has two items.  </li>
+</ul>

tests/_data/formatter/markdown2html.target3.html

@@ -0,0 +1,18 @@
+<p>This is a Markdown document.<br />
+These lines belong in the same paragraph.<br />
+Markdown usually ignores single line breaks.</p>
+
+<pre><code>This is an indented code segment.  
+All Markdown variants will recognize it.
+</code></pre>
+
+<pre><code>This is a fenced code segment.  
+Only Markdown Extra will recognize it.  
+</code></pre>
+
+<p>This is a <a href="foobar.html">link</a>.<br />
+This is an <img src="foobar.jpg" alt="image" />.</p>
+
+<ul><li>This is a list.  </li>
+<li>It has two items.  </li>
+</ul>

tests/_data/formatter/minify.source.css

@@ -0,0 +1,10 @@
+@charset "UTF-8";
+.rhymix {
+	background: url("foo/bar.jpg");
+}
+.wordpress {
+	border-radius: 4px;
+}
+.xpressengine {
+	margin: 320px;
+}

tests/_data/formatter/minify.source.js

@@ -0,0 +1,6 @@
+(function($) {
+	$(".foo").click(function(event) {
+		event.preventDefault();
+		$(this).attr("bar", "baz");
+	});
+})(jQuery);

tests/_data/formatter/minify.target.css

@@ -0,0 +1 @@
+@charset "UTF-8";.rhymix{background:url(../_data/formatter/foo/bar.jpg)}.wordpress{border-radius:4px}.xpressengine{margin:320px}

tests/_data/formatter/minify.target.js

@@ -0,0 +1 @@
+(function($){$(".foo").click(function(event){event.preventDefault();$(this).attr("bar","baz")})})(jQuery)

tests/_data/formatter/scss.source1.scss

@@ -0,0 +1,3 @@
+@mixin mymixin($size) {
+	margin: $size;
+}

tests/_data/formatter/scss.source2.scss

@@ -0,0 +1,7 @@
+.rhymix {
+	color: $foo;
+	background: url('foo/bar.jpg');
+	span {
+		@include mymixin($bar);
+	}
+}

tests/_data/formatter/scss.target1.css

@@ -0,0 +1,9 @@
+@charset "UTF-8";
+.rhymix {
+  color: #123456;
+  background: url("../_data/formatter/foo/bar.jpg");
+}
+.rhymix span {
+  margin: 320px;
+}
+

tests/_data/formatter/scss.target2.css

@@ -0,0 +1,2 @@
+@charset "UTF-8";
+.rhymix{color:#123456;background:url("../_data/formatter/foo/bar.jpg")}.rhymix span{margin:320px}

tests/_data/formatter/smartypants.source.html

@@ -0,0 +1,2 @@
+<p>This paragraph contains &quot;dumb quotes&quot; and short -- dashes.</p>
+<p>This paragraph contains ``backtick quotes'' and 'long' --- dashes...</p>

tests/_data/formatter/smartypants.target.html

@@ -0,0 +1,2 @@
+<p>This paragraph contains &#8220;dumb quotes&#8221; and short &#8212; dashes.</p>
+<p>This paragraph contains &#8220;backtick quotes&#8221; and &#8217;long&#8217; &#8211; dashes&#8230;</p>

tests/_data/formatter/text2html.source.txt

@@ -0,0 +1,9 @@
+This is a sample text file.
+Some of these lines are close together.
+
+Other lines are separated by two newlines.
+
+
+Or three newlines.
+This is a <p>tag</p> that will be escaped if encoded.
+Hello world!

tests/_data/formatter/text2html.target1.html

@@ -0,0 +1,9 @@
+This is a sample text file.<br />
+Some of these lines are close together.<br />
+<br />
+Other lines are separated by two newlines.<br />
+<br />
+<br />
+Or three newlines.<br />
+This is a &lt;p&gt;tag&lt;/p&gt; that will be escaped if encoded.<br />
+Hello world!<br />

tests/_data/formatter/text2html.target2.html

@@ -0,0 +1,9 @@
+<p>This is a sample text file.</p>
+<p>Some of these lines are close together.</p>
+<p></p>
+<p>Other lines are separated by two newlines.</p>
+<p></p>
+<p></p>
+<p>Or three newlines.</p>
+<p>This is a &lt;p&gt;tag&lt;/p&gt; that will be escaped if encoded.</p>
+<p>Hello world!</p>

tests/_data/formatter/text2html.target3.html

@@ -0,0 +1,12 @@
+<p>
+This is a sample text file.<br />
+Some of these lines are close together.
+</p>
+<p>
+Other lines are separated by two newlines.
+</p>
+<p>
+Or three newlines.<br />
+This is a &lt;p&gt;tag&lt;/p&gt; that will be escaped if encoded.<br />
+Hello world!
+</p>

tests/unit/framework/FormatterTest.php

@@ -0,0 +1,134 @@
+<?php
+
+class FormatterTest extends \Codeception\TestCase\Test
+{
+	public function testText2HTML()
+	{
+		$text = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/text2html.source.txt');
+		$html1 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/text2html.target1.html');
+		$html2 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/text2html.target2.html');
+		$html3 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/text2html.target3.html');
+		
+		$this->assertEquals($html1, Rhymix\Framework\Formatter::text2html($text));
+		$this->assertEquals($html2, Rhymix\Framework\Formatter::text2html($text, Rhymix\Framework\Formatter::TEXT_NEWLINE_AS_P));
+		$this->assertEquals($html3, Rhymix\Framework\Formatter::text2html($text, Rhymix\Framework\Formatter::TEXT_DOUBLE_NEWLINE_AS_P));
+	}
+	
+	public function testHTML2Text()
+	{
+		$html = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/html2text.source.html');
+		$text = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/html2text.target.txt');
+		
+		$this->assertEquals($text, Rhymix\Framework\Formatter::html2text($html));
+	}
+	
+	public function testMarkdown2HTML()
+	{
+		$markdown = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/markdown2html.source.md');
+		$html1 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/markdown2html.target1.html');
+		$html2 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/markdown2html.target2.html');
+		$html3 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/markdown2html.target3.html');
+		
+		$this->assertEquals($html1, Rhymix\Framework\Formatter::markdown2html($markdown));
+		$this->assertEquals($html2, Rhymix\Framework\Formatter::markdown2html($markdown, Rhymix\Framework\Formatter::MD_NEWLINE_AS_BR));
+		$this->assertEquals($html3, Rhymix\Framework\Formatter::markdown2html($markdown, Rhymix\Framework\Formatter::MD_NEWLINE_AS_BR | Rhymix\Framework\Formatter::MD_ENABLE_EXTRA));
+	}
+	
+	public function testHTML2Markdown()
+	{
+		$html = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/html2markdown.source.html');
+		$markdown = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/html2markdown.target.md');
+		
+		$this->assertEquals($markdown, Rhymix\Framework\Formatter::html2markdown($html));
+	}
+	
+	public function testBBCode()
+	{
+		$bbcode = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/bbcode.source.txt');
+		$html = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/bbcode.target.html');
+		
+		$this->assertEquals($html, Rhymix\Framework\Formatter::bbcode($bbcode));
+	}
+	
+	public function testApplySmartQuotes()
+	{
+		$before = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/smartypants.source.html');
+		$after = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/smartypants.target.html');
+		
+		$this->assertEquals($after, Rhymix\Framework\Formatter::applySmartQuotes($before));
+	}
+	
+	public function testCompileLESS()
+	{
+		$sources = array(
+			\RX_BASEDIR . 'tests/_data/formatter/less.source1.less',
+			\RX_BASEDIR . 'tests/_data/formatter/less.source2.less',
+		);
+		$variables = array(
+			'foo' => '#123456',
+			'bar' => '320px',
+		);
+		
+		$real_target1 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/less.target1.css');
+		$real_target2 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/less.target2.css');
+		$test_target1 = \RX_BASEDIR . 'tests/_output/less.target1.css';
+		$test_target2 = \RX_BASEDIR . 'tests/_output/less.target2.css';
+		
+		$this->assertTrue(Rhymix\Framework\Formatter::compileLESS($sources, $test_target1, $variables));
+		$this->assertEquals($real_target1, file_get_contents($test_target1));
+		$this->assertTrue(Rhymix\Framework\Formatter::compileLESS($sources, $test_target2, $variables, true));
+		$this->assertEquals($real_target2, file_get_contents($test_target2));
+		
+		unlink($test_target1);
+		unlink($test_target2);
+	}
+	
+	public function testCompileSCSS()
+	{
+		$sources = array(
+			\RX_BASEDIR . 'tests/_data/formatter/scss.source1.scss',
+			\RX_BASEDIR . 'tests/_data/formatter/scss.source2.scss',
+		);
+		$variables = array(
+			'foo' => '#123456',
+			'bar' => '320px',
+		);
+		
+		$real_target1 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/scss.target1.css');
+		$real_target2 = file_get_contents(\RX_BASEDIR . 'tests/_data/formatter/scss.target2.css');
+		$test_target1 = \RX_BASEDIR . 'tests/_output/scss.target1.css';
+		$test_target2 = \RX_BASEDIR . 'tests/_output/scss.target2.css';
+		
+		$this->assertTrue(Rhymix\Framework\Formatter::compileSCSS($sources, $test_target1, $variables));
+		$this->assertEquals($real_target1, file_get_contents($test_target1));
+		$this->assertTrue(Rhymix\Framework\Formatter::compileSCSS($sources, $test_target2, $variables, true));
+		$this->assertEquals($real_target2, file_get_contents($test_target2));
+		
+		unlink($test_target1);
+		unlink($test_target2);
+	}
+	
+	public function testMinifyCSS()
+	{
+		$source = \RX_BASEDIR . 'tests/_data/formatter/minify.source.css';
+		$real_target = \RX_BASEDIR . 'tests/_data/formatter/minify.target.css';
+		$test_target = \RX_BASEDIR . 'tests/_output/minify.target.css';
+		
+		$this->assertTrue(Rhymix\Framework\Formatter::minifyCSS($source, $test_target));
+		$this->assertEquals(file_get_contents($real_target), file_get_contents($test_target));
+		
+		unlink($test_target);
+	}
+	
+	public function testMinifyJS()
+	{
+		$source = \RX_BASEDIR . 'tests/_data/formatter/minify.source.js';
+		$real_target = \RX_BASEDIR . 'tests/_data/formatter/minify.target.js';
+		$test_target = \RX_BASEDIR . 'tests/_output/minify.target.js';
+		
+		$this->assertTrue(Rhymix\Framework\Formatter::minifyJS($source, $test_target));
+		$this->assertEquals(file_get_contents($real_target), file_get_contents($test_target));
+		
+		unlink($test_target);
+	}
+}