Cleaning up API and code structure

* Moved code to use psr-4 style
* Changed key creator to return an array not a string
* Support for generating multiple versions in sami docs
* Added 5.5 to travis build
* Updated change log to reflect changes
* Move to tedivm/stash for cacheing
* Update licence to use current year
* Move SilverStripe code into namespace
* Remove unneeded dev deps
* Remove PHP CI file
* Fix unit tests

Author: camspiers

.sami

@@ -1,6 +1,7 @@
 <?php
 
 use Sami\Sami;
+use Sami\Version\GitVersionCollection;
 use Symfony\Component\Finder\Finder;
 
 $iterator = Finder::create()
@@ -12,8 +13,15 @@ $iterator = Finder::create()
     ->exclude('framework')
     ->in(__DIR__);
 
+$versions = GitVersionCollection::create($dir)
+    ->addFromTags('*')
+    ->add('master', 'master branch');
+
 return new Sami($iterator, array(
     'title'                => 'Cache Include API',
-    'build_dir'            => __DIR__ . '/build/api',
-    'cache_dir'            => __DIR__ . '/build/apicache'
+    'versions'             => $versions,
+    'theme'                => 'enhanced',
+    'build_dir'            => __DIR__ . '/build/api/%version%',
+    'cache_dir'            => __DIR__ . '/build/apicache/%version%',
+    'default_opened_level' => 2,
 ));

.travis.yml

@@ -3,6 +3,7 @@ language: php
 php:
   - 5.3
   - 5.4
+  - 5.5
 
 before_script:
   - composer self-update

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 4.0.0
+
+* [BC Break] Use "tedivm/stash" for caching
+* [BC Break] Change KeyCreator interface to return an array from getKey
+
+## 3.1.0
+
+* Added special <% cache 'Name' %> syntax for templates
+* [BC BREAK] Removed ability to use `CacheIncludePartial`
+* Added support for caching by whether a use is logged in (as opposed to caching for a specific user)
+* Removed redundant key creation code for page, url-params, controller all combined into one functionality
+
 ## 3.0.8
 
 * Only cache 200 status codes in global request cache

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013 Heyday Limited
+Copyright (c) 2012-2014 Heyday Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

_config/config.yml

@@ -7,52 +7,49 @@ Director:
 
 Injector:
   SSTemplateParser:
-      properties:
-        closedBlocks:
-          cache: "CacheIncludeExtension::cacheTemplate"
+    properties:
+      closedBlocks:
+        cache: "Heyday\CacheInclude\SilverStripe\CacheIncludeExtension::cacheTemplate"
+
   CacheInclude:
     class: Heyday\CacheInclude\CacheInclude
     constructor:
       0: '%$CacheCache'
-      1: '%$CacheIncludeKeyCreator'
       2: '%$CacheIncludeConfig'
-  CacheIncludeKeyCreator:
-    class: Heyday\CacheInclude\KeyCreators\KeyCreator
+
   CacheIncludeConfig:
     class: Heyday\CacheInclude\Configs\ArrayConfig
-    constructor:
-      0: []
+
   CacheIncludeViewableDataProcessor:
     class: Heyday\CacheInclude\Processors\ViewableDataProcessor
-  CacheCache:
-    class: CacheCache\Cache
-    constructor:
-      0: '%$CacheCacheBackend'
-      1: cacheinclude
-      2: null
-      3: 0
-  CacheCacheBackend:
-    class: CacheCache\Backends\File
+
+  Stash:
+      class: Stash\Pool
+      constructor:
+        0: '%$StashDriver'
+  StashDriver:
+    class: Stash\Driver\FileSystem
     constructor:
       0:
-        dir: '../silverstripe-cacheinclude/cache'
-        file_extension: '.cache'
+        path: '../silverstripe-cacheinclude/cache'
+
   CacheIncludeExtension:
-    class: CacheIncludeExtension
+    class: Heyday\CacheInclude\SilverStripe\CacheIncludeExtension
     constructor:
       0: '%$CacheInclude'
-      2: '%$CacheIncludeViewableDataProcessor'
+      1: '%$CacheIncludeViewableDataProcessor'
+
   CacheIncludeController:
-    class: CacheIncludeController
+    class: Heyday\CacheInclude\SilverStripe\CacheIncludeController
     constructor:
       0: '%$CacheInclude'
+
   RequestCache:
     class: Heyday\CacheInclude\RequestCache
     constructor:
       0: '%$CacheInclude'
       1: Global
 
-
 ---
 Only:
   CACHEINCLUDE_FORCE_EXPIRE: true
@@ -64,6 +61,5 @@ Injector:
     class: Heyday\CacheInclude\CacheInclude
     constructor:
       0: '%$CacheCache'
-      1: '%$CacheIncludeKeyCreator'
-      2: '%$CacheIncludeConfig'
-      3: true
+      1: '%$CacheIncludeConfig'
+      2: true

code/CacheIncludeSiteTreeExtension.php

@@ -4,26 +4,26 @@
     "require": {
         "php": ">=5.3.2",
         "composer/installers": "~1.0",
-        "maximebf/cachecache": "~1.0",
+        "tedivm/stash": "~0.11.4",
         "symfony/yaml": "~2.1"
     },
     "require-dev": {
-        "silverstripe/framework": "3.1.x-dev",
+        "silverstripe/framework": "~3.1.2",
         "symfony/class-loader": "~2.2",
-        "phpmd/phpmd": "~1.4",
-        "phploc/phploc": "dev-master",
-        "symfony/finder": "@dev",
-        "zetacomponents/console-tools": "@dev",
-        "theseer/fdomdocument": "@dev",
-        "pdepend/pdepend": "~1.1",
-        "sami/sami": "dev-master"
+        "sami/sami": "dev-master",
+        "phpunit/phpunit": "~3.7",
+        "mikey179/vfsStream": "~1.2"
     },
     "autoload": {
-        "psr-0": { "Heyday\\CacheInclude": "src/" }
+        "psr-4": { "Heyday\\CacheInclude\\": "src/" }
     },
     "authors": [{
         "name": "Cam Spiers",
         "email": "[email protected]",
         "homepage": "https://github.com/camspiers/"
+    }, {
+        "name": "Stephen Holdaway",
+        "email": "[email protected]",
+        "homepage": "https://github.com/stecman/"
     }]
 }