Merge pull request #320 from ins0/feature/parsedown

[WIP] feature/parsedown

Author: Ocramius

composer.json

@@ -9,7 +9,6 @@
         "zendframework/zendframework": "~2.3.0",
         "rwoverdijk/assetmanager": "1.3.*",
         "evandotpro/edp-github": "dev-master",
-        "evandotpro/edp-markdown": "0.2.*",
         "evandotpro/edp-module-layouts": "1.0.*",
         "zf-commons/zfc-user": "1.0.*",
         "zfcampus/zf-development-mode": "~2.0",

config/application.config.php

@@ -13,7 +13,6 @@
         'User',
         'EdpModuleLayouts',
         'ZfModule',
-        'EdpMarkdown',
     ],
     'module_listener_options' => [
         'config_glob_paths'    => [

module/Application/src/Application/Service/RepositoryRetriever.php

@@ -58,18 +58,40 @@ public function getUserRepositories($user, $params = [])
      * @param string $user
      * @param string $module
      * @param string $filePath
+     * @param bool $parseMarkdown
      *
      * @return bool|string
      */
-    public function getRepositoryFileContent($user, $module, $filePath)
+    public function getRepositoryFileContent($user, $module, $filePath, $parseMarkdown = false)
     {
         $contentResponse = $this->getRepositoryFileMetadata($user, $module, $filePath);
 
         if (!isset($contentResponse->content)) {
             return false;
         }
 
-        return base64_decode($contentResponse->content);
+        $content = base64_decode($contentResponse->content);
+        if ($content && $parseMarkdown) {
+            return $this->requestContentMarkdown($content);
+        }
+
+        return $content;
+    }
+
+    /**
+     * Request content as parsed markdown
+     *
+     * @param string $content
+     *
+     * @return string|null
+     */
+    private function requestContentMarkdown($content)
+    {
+        try {
+            return $this->githubClient->api('markdown')->render($content);
+        } catch (RuntimeException $e) {
+            return null;
+        }
     }
 
     /**

module/Application/test/ApplicationTest/Service/RepositoryRetrieverTest.php

@@ -3,6 +3,7 @@
 namespace ApplicationTest\Service;
 
 use Application\Service\RepositoryRetriever;
+use EdpGithub;
 use EdpGithub\Api;
 use EdpGithub\Collection;
 use EdpGithub\Listener\Exception;
@@ -77,6 +78,61 @@ public function testCanRetrieveRepositoryFileContent()
         $this->assertEquals('foo', $response);
     }
 
+    public function testRepositoryContentCanParsedMarkdown()
+    {
+        $content = 'repository file __FOO__ content';
+        $markdown = function($content) {
+            return str_replace('__FOO__', 'bar', $content);
+        };
+
+        $apiMock = $this->getMock(Api\Markdown::class, ['content','render']);
+        $apiMock
+            ->expects($this->once())
+            ->method('render')
+            ->with($this->equalTo($content))
+            ->willReturn($markdown($content));
+
+        $apiMock
+            ->expects($this->any())
+            ->method('content')
+            ->willReturn(json_encode(['content' => base64_encode($content)]));
+
+        $clientMock = $this->getMock(EdpGithub\Client::class);
+        $clientMock->expects($this->any())
+            ->method('api')
+            ->willReturn($apiMock);
+
+        $service = new RepositoryRetriever($clientMock);
+        $contentMarkdown = $service->getRepositoryFileContent('foo', 'bar', 'foo.md', true);
+
+        $this->assertEquals('repository file bar content', $contentMarkdown);
+    }
+
+    public function testRepositoryContentMarkdownFails()
+    {
+        $content = 'repository file __FOO__ content';
+        $apiMock = $this->getMock(Api\Markdown::class, ['content','render']);
+        $apiMock
+            ->expects($this->once())
+            ->method('render')
+            ->willThrowException(new Exception\RuntimeException);
+
+        $apiMock
+            ->expects($this->any())
+            ->method('content')
+            ->willReturn(json_encode(['content' => base64_encode($content)]));
+
+        $clientMock = $this->getMock(EdpGithub\Client::class);
+        $clientMock->expects($this->any())
+            ->method('api')
+            ->willReturn($apiMock);
+
+        $service = new RepositoryRetriever($clientMock);
+        $contentMarkdown = $service->getRepositoryFileContent('foo', 'bar', 'foo.md', true);
+
+        $this->assertNull($contentMarkdown);
+    }
+
     public function testResponseContentMissingOnGetRepositoryFileContent()
     {
         $payload = [];

module/ZfModule/src/ZfModule/Controller/IndexController.php

@@ -58,7 +58,7 @@ public function viewAction()
             return $this->notFoundAction();
         }
 
-        $readme = $this->repositoryRetriever->getRepositoryFileContent($vendor, $module, 'README.md');
+        $readme = $this->repositoryRetriever->getRepositoryFileContent($vendor, $module, 'README.md', true);
         $license = $this->repositoryRetriever->getRepositoryFileContent($vendor, $module, 'LICENSE');
         $composerConf = $this->repositoryRetriever->getRepositoryFileContent($vendor, $module, 'composer.json');
 

module/ZfModule/view/zf-module/index/view.phtml

@@ -13,8 +13,8 @@
 
         <div class="tab-content">
             <div class="tab-pane active" id="readme">
-                <?php if ($readme): ?>
-                    <?php echo $this->sanitizeHtml($this->markdown($this->readme)); ?>
+                <?php if($readme): ?>
+                    <?php echo $this->sanitizeHtml($this->readme); ?>
                 <?php else: ?>
                     No README file found for this Module
                 <?php endif; ?>