UPDATE re-implement cache

NEW DBMarkdownTest for partial coverage
NEW travis, scrutinizer and test configuration files

Author: muskie9

.gitattributes

@@ -0,0 +1,4 @@
+/tests            export-ignore
+/.gitattributes   export-ignore
+/.travis.yml      export-ignore
+/.scrutinizer.yml export-ignore

.scrutinizer.yml

@@ -0,0 +1,37 @@
+inherit: true
+
+#Copied from https://www.adayinthelifeof.nl/2013/11/20/external-code-coverage-with-travis-scrutinizer/
+tools:
+  external_code_coverage:
+    timeout: 600
+  php_code_sniffer:
+    config:
+      standard: PSR2
+  php_cs_fixer:
+    extensions:
+      # Default:
+      - php
+    fixers: []
+    enabled: false
+    filter:
+      paths: [tests/*,src/*]
+      excluded_paths: []
+coding_style:
+  php:
+    indentation:
+      general:
+        use_tabs: false
+
+checks:
+  php:
+    code_rating: true
+    duplication: true
+
+build:
+  nodes:
+    analysis:
+      tests:
+        override: [php-scrutinizer-run]
+
+filter:
+  paths: [tests/*,src/*]

.travis.yml

@@ -0,0 +1,34 @@
+language: php
+
+env:
+  global:
+    - COMPOSER_ROOT_VERSION=4.0.x-dev
+    - CODECOV_TOKEN=
+    - SCRUT_TOKEN=
+
+matrix:
+  include:
+    - php: 7.1
+      env: DB=MYSQL PHPUNIT_TEST=1
+    - php: 7.2
+      env: DB=MYSQL PHPCS_TEST=1 PHPUNIT_TEST=1
+    - php: 7.3
+      env: DB=MYSQL PHPUNIT_COVERAGE_TEST=1
+
+before_script:
+  # Init PHP
+  - phpenv rehash
+  - phpenv config-rm xdebug.ini
+  - echo 'memory_limit = 2048M' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
+
+  # Install composer dependencies
+  - composer require --prefer-dist --no-update silverstripe-themes/simple:~3.2
+  - composer update --no-suggest --prefer-dist
+
+script:
+  - if [[ $PHPUNIT_TEST ]]; then vendor/bin/phpunit; fi
+  - if [[ $PHPUNIT_COVERAGE_TEST ]]; then phpdbg -qrr vendor/bin/phpunit --coverage-clover=coverage.xml && wget https://scrutinizer-ci.com/ocular.phar; fi
+  - if [[ $PHPCS_TEST ]]; then vendor/bin/phpcs src/ tests/; fi
+
+after_success:
+  - if [[ $PHPUNIT_COVERAGE_TEST ]]; then bash <(curl -s https://codecov.io/bash) -f coverage.xml -t $CODECOV_TOKEN && travis_retry php ocular.phar code-coverage:upload --format=php-clover --access-token=$SCRUT_TOKEN coverage.xml; fi

_config/cache.yml

@@ -0,0 +1,8 @@
+---
+Name: markdown-cache-config
+---
+SilverStripe\Core\Injector\Injector:
+  Psr\SimpleCache\CacheInterface.dbMarkdownCache:
+    factory: SilverStripe\Core\Cache\CacheFactory
+    constructor:
+      namespace: 'dbmarkdowncache'

composer.json

@@ -18,6 +18,10 @@
     "ext-json": "*",
     "ext-curl": "*"
   },
+  "require-dev": {
+    "phpunit/phpunit": "^5.7",
+    "squizlabs/php_codesniffer": "*"
+  },
   "support": {
     "issues": "https://github.com/undefinedoffset/silverstripe-markdown/issues"
   },
@@ -32,7 +36,8 @@
   },
   "autoload": {
     "psr-4": {
-      "UndefinedOffset\\Markdown\\": "src/"
+      "UndefinedOffset\\Markdown\\": "src/",
+      "UndefinedOffset\\Markdown\\Test\\": "tests/"
     }
   }
 }

phpcs.xml.dist

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<ruleset name="SS4">
+    <description>Coding standard for SilverStripe 4.x</description>
+
+    <!-- Don't sniff third party libraries -->
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <exclude-pattern>*/thirdparty/*</exclude-pattern>
+
+    <!-- Show progress and output sniff names on violation, and add colours -->
+    <arg value="sp"/>
+    <arg name="colors"/>
+
+    <!-- Use PSR-2 as a base standard -->
+    <rule ref="PSR2">
+        <!-- Allow classes to not declare a namespace -->
+        <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>
+
+        <!-- Allow underscores in class names -->
+        <exclude name="Squiz.Classes.ValidClassName.NotCamelCaps"/>
+
+        <!-- Allow non camel cased method names -->
+        <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps"/>
+    </rule>
+</ruleset>

phpunit.xml.dist

@@ -0,0 +1,14 @@
+<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
+    <testsuite name="silverstripe-markdown">
+        <directory>tests</directory>
+    </testsuite>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src/</directory>
+            <exclude>
+                <directory suffix=".php">tests/</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+</phpunit>

src/Model/FieldTypes/DBMarkdown.php

@@ -15,6 +15,16 @@
  */
 class DBMarkdown extends DBText
 {
+    /**
+     * @var string
+     */
+    private $cache_key;
+
+    /**
+     * @var int Cache length for field value in seconds
+     */
+    private static $cache_seconds = 86400;
+
     /**
      * {@inheritDoc}
      */
@@ -72,12 +82,11 @@ public function AsHTML($useGFM = false)
         }
 
         //Init cache stuff
-        /*$cacheKey = $this->getCacheKey();
-        $cache = Injector::inst()->get(CacheInterface::class . '.markdown');
-        $cachedHTML = $cache->load($cacheKey);//*/
+        $cacheKey = $this->getCacheKey();
+        $cache = Injector::inst()->get(CacheInterface::class . '.dbMarkdownCache');
 
         //Check cache, if it's good use it instead
-        if (isset($cachedHTML) && $cachedHTML !== false) {
+        if ($cachedHTML = $cache->get($cacheKey)) {
             $this->parsedHTML = $cachedHTML;
 
             return $this->parsedHTML;
@@ -95,9 +104,7 @@ public function AsHTML($useGFM = false)
         $this->parsedHTML = $response;
 
         //Cache response to file system
-        if (isset($cache) && isset($cacheKey)) {
-            $cache->save($this->parsedHTML, $cacheKey);
-        }
+        $cache->set($cacheKey, $this->parsedHTML, $this->config()->get('cache_seconds'));
 
         //Reset GFM
         if ($renderer instanceof GithubMarkdownRenderer && isset($beforeUseGFM)) {
@@ -151,6 +158,25 @@ private function getRenderer()
      */
     public function getCacheKey()
     {
-        return md5('Markdown_' . $this->tableName . '_' . $this->name . '_' . $this->value);
+        if (!$this->cache_key) {
+            $this->setCacheKey();
+        }
+
+        return $this->cache_key;
+    }
+
+    /**
+     * @param null $key
+     * @return $this
+     */
+    public function setCacheKey($key = null)
+    {
+        if ($key === null) {
+            $key = md5('Markdown_' . $this->tableName . '_' . $this->name . '_' . $this->value);
+        }
+
+        $this->cache_key = $key;
+
+        return $this;
     }
 }

tests/DBMarkdownTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace UndefinedOffset\Markdown\Test;
+
+use SilverStripe\Dev\SapphireTest;
+use SilverStripe\ORM\FieldType\DBField;
+use UndefinedOffset\Markdown\Model\FieldTypes\DBMarkdown;
+
+/**
+ * Class DBMarkdownTest
+ * @package UndefinedOffset\Markdown\Test
+ */
+class DBMarkdownTest extends SapphireTest
+{
+    /**
+     *
+     */
+    public function testSetCacheKey()
+    {
+        /** @var DBMarkdown $field */
+        $field = DBField::create_field(DBMarkdown::class, '###Headline', 'Markdown');
+        $this->assertEquals('9ec6af9103bea4520f8f7a2300c23a3b', $field->getCacheKey());
+
+        $field->setCacheKey('foo');
+        $this->assertEquals('foo', $field->getCacheKey());
+    }
+
+    /**
+     *
+     */
+    public function testKeySeconds()
+    {
+        $this->assertEquals(86400, DBMarkdown::config()->get('cache_seconds'));
+
+        DBMarkdown::config()->set('cache_seconds', 500);
+        $this->assertEquals(500, DBMarkdown::config()->get('cache_seconds'));
+    }
+}