kzykhys/markdown-testsuite

dev-master 2014-02-15 08:29 UTC

README

Latest Stable Version Latest Unstable Version

After starting the W3C Community Group about Markdown, a question has been raised a few times about a test suite for the markdown syntax.

I decided to put together a list of individual files isolating some constructs of the markdown syntax. Some features might be missing, you know the deal. Pull Requests are welcome.

Modification by @kzykhys

Helper class for PHP

<?php

class MarkdownTest extends PHPUnit_Framework_TestCase
{
    public function testParser()
    {
        $parser = new YourParser();

        // test suite based on karlcow/markdown-testsuite
        $tests = new KzykHys\MarkdownTestSuite\Tests();

        foreach ($tests as $pattern) {
            $this->assertEquals(
                $pattern->getOutput(),                   // expected
                $parser->parse($pattern->getMarkdown()), // actual
                $pattern->getName() . ' failed'          // message
            );
        }
    }

    public function testYourPatterns()
    {
        $parser = new YourParser();

        // {name}.md for input and {name}.out for output
        $tests = new KzykHys\MarkdownTestSuite\Tests('/path/to/patterns');

        foreach ($tests as $pattern) {
            $this->assertEquals(
                $pattern->getOutput(),                   // expected
                $parser->parse($pattern->getMarkdown()), // actual
                $pattern->getName() . ' failed'          // message
            );
        }
    }
}

composer.json example

{
    "require-dev": {
        "kzykhys/markdown-testsuite": "dev-master"
    }
}