Added Deprecated tab to DebugBar to catch future incompatibilities …

…with later Grav versions
getgrav · Aug 24, 2018 · 756ddaa · 756ddaa
1 parent 89f64e4
commit 756ddaa
Show file tree

Hide file tree

Showing 16 changed files with 115 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# v1.5.2
+## mm/dd/2018
+
+1. [](#new)
+    * Added `Deprecated` tab to DebugBar to catch future incompatibilities with later Grav versions
+    * Added deprecation notices for features which will be removed in Grav 2.0
+
 # v1.5.1
 ## 08/23/2018
 

diff --git a/index.php b/index.php
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @package    Grav.Core
  *
@@ -7,6 +8,7 @@
  */
 
 namespace Grav;
+
 define('GRAV_PHP_MIN', '5.6.4');
 
 // Ensure vendor libraries exist
@@ -29,7 +31,7 @@
 }
 
 // Register the auto-loader.
-$loader = require_once $autoload;
+$loader = require $autoload;
 
 // Set timezone to default, falls back to system if php.ini not set
 date_default_timezone_set(@date_default_timezone_get());

diff --git a/system/src/Grav/Common/Config/Config.php b/system/src/Grav/Common/Config/Config.php
@@ -109,6 +109,8 @@ public function init()
      */
     public function getLanguages()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use Grav::instance()[\'languages\'] instead', E_USER_DEPRECATED);
+
         return Grav::instance()['languages'];
     }
 }
diff --git a/system/src/Grav/Common/Debugger.php b/system/src/Grav/Common/Debugger.php
@@ -9,6 +9,7 @@
 namespace Grav\Common;
 
 use DebugBar\DataCollector\ConfigCollector;
+use DebugBar\DataCollector\MessagesCollector;
 use DebugBar\JavascriptRenderer;
 use DebugBar\StandardDebugBar;
 use Grav\Common\Config\Config;
@@ -31,6 +32,11 @@ class Debugger
 
     protected $timers = [];
 
+    /** @var string[] $deprecations */
+    protected $deprecations = [];
+
+    protected $errorHandler;
+
     /**
      * Debugger constructor.
      */
@@ -41,6 +47,9 @@ public function __construct()
 
         $this->debugbar = new StandardDebugBar();
         $this->debugbar['time']->addMeasure('Loading', $this->debugbar['time']->getRequestStartTime(), microtime(true));
+
+        // Set deprecation collector.
+        $this->setErrorHandler();
     }
 
     /**
@@ -177,6 +186,8 @@ public function render()
                 return $this;
             }
 
+            $this->addDeprecations();
+
             echo $this->renderer->render();
         }
 
@@ -191,6 +202,7 @@ public function render()
     public function sendDataInHeaders()
     {
         if ($this->enabled()) {
+            $this->addDeprecations();
             $this->debugbar->sendDataInHeaders();
         }
 
@@ -208,6 +220,7 @@ public function getData()
             return null;
         }
 
+        $this->addDeprecations();
         $this->timers = [];
 
         return $this->debugbar->getData();
@@ -279,4 +292,55 @@ public function addException(\Exception $e)
 
         return $this;
     }
+
+    public function setErrorHandler()
+    {
+        $this->errorHandler = set_error_handler(
+            [$this, 'deprecatedErrorHandler'],
+            E_USER_DEPRECATED
+        );
+    }
+
+    /**
+     * @param int $errno
+     * @param string $errstr
+     * @param string $errfile
+     * @param int $errline
+     * @return bool
+     */
+    public function deprecatedErrorHandler($errno, $errstr, $errfile, $errline)
+    {
+        $this->deprecations[] = [
+            'message' => $errstr,
+            'file' => $errfile,
+            'line' => $errline
+        ];
+
+        return true;
+    }
+
+    protected function addDeprecations()
+    {
+        if (!$this->deprecations) {
+            return;
+        }
+
+        $collector = new MessagesCollector('deprecated');
+        $this->addCollector($collector);
+        $collector->addMessage('Your site is using following deprecated features:');
+
+        /** @var array $deprecated */
+        foreach ($this->deprecations as $deprecated) {
+            if (strpos($deprecated['message'], 'Grav') !== false) {
+                $scope = 'grav';
+            } elseif (strpos($deprecated['file'], 'Twig') !== false) {
+                $scope = 'twig';
+            } elseif (strpos($deprecated['file'], 'yaml') !== false) {
+                $scope = 'yaml';
+            } else {
+                $scope = 'unknown';
+            }
+            $collector->addMessage($deprecated, $scope);
+        }
+    }
 }
diff --git a/system/src/Grav/Common/Errors/Errors.php b/system/src/Grav/Common/Errors/Errors.php
@@ -74,5 +74,8 @@ public function resetHandlers()
         }
 
         $whoops->register();
+
+        // Re-register deprecation handler.
+        $grav['debugger']->setErrorHandler();
     }
 }
diff --git a/system/src/Grav/Common/GravTrait.php b/system/src/Grav/Common/GravTrait.php
@@ -9,7 +9,7 @@
 namespace Grav\Common;
 
 /**
- * @deprecated 2.0
+ * @deprecated 1.4 Use Grav::instance() instead
  */
 trait GravTrait
 {
@@ -24,8 +24,7 @@ public static function getGrav()
             self::$grav = Grav::instance();
         }
 
-        $caller = self::$grav['debugger']->getCaller();
-        self::$grav['debugger']->addMessage("Deprecated GravTrait used in {$caller['file']}", 'deprecated');
+        user_error(__TRAIT__ . ' is deprecated since Grav 1.4, use Grav::instance() instead', E_USER_DEPRECATED);
 
         return self::$grav;
     }

diff --git a/system/src/Grav/Common/Page/Page.php b/system/src/Grav/Common/Page/Page.php
@@ -764,6 +764,8 @@ protected function processMarkdown()
 
         // pages.markdown_extra is deprecated, but still check it...
         if (!isset($defaults['extra']) && (isset($this->markdown_extra) || $config->get('system.pages.markdown_extra') !== null)) {
+            user_error('Configuration option \'system.pages.markdown_extra\' is deprecated since Grav 1.5, use \'system.pages.markdown.extra\' instead', E_USER_DEPRECATED);
+
             $defaults['extra'] = $this->markdown_extra ?: $config->get('system.pages.markdown_extra');
         }
 

diff --git a/system/src/Grav/Common/Session.php b/system/src/Grav/Common/Session.php
@@ -15,10 +15,12 @@ class Session extends \Grav\Framework\Session\Session
 
     /**
      * @return \Grav\Framework\Session\Session
-     * @deprecated 1.5
+     * @deprecated 1.5 Use getInstance() method instead
      */
     public static function instance()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use getInstance() method instead', E_USER_DEPRECATED);
+
         return static::getInstance();
     }
 
@@ -51,21 +53,25 @@ public function setAutoStart($auto)
      * Returns attributes.
      *
      * @return array Attributes
-     * @deprecated 1.5
+     * @deprecated 1.5 Use getAll() method instead
      */
     public function all()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use getAll() method instead', E_USER_DEPRECATED);
+
         return $this->getAll();
     }
 
     /**
      * Checks if the session was started.
      *
      * @return Boolean
-     * @deprecated 1.5
+     * @deprecated 1.5 Use isStarted() method instead
      */
     public function started()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use isStarted() method instead', E_USER_DEPRECATED);
+
         return $this->isStarted();
     }
 

diff --git a/system/src/Grav/Common/Twig/Twig.php b/system/src/Grav/Common/Twig/Twig.php
@@ -120,6 +120,10 @@ public function init()
                 $params['autoescape'] = $this->autoescape;
             }
 
+            if (empty($params['autoescape'])) {
+                user_error('Having Twig auto-escaping turned off is deprecated since Grav 1.5, please disable \'system.strict_mode.twig_compat\' setting in your configuration', E_USER_DEPRECATED);
+            }
+
             $this->twig = new TwigEnvironment($loader_chain, $params);
 
             if ($config->get('system.twig.undefined_functions')) {
@@ -411,8 +415,12 @@ public function template($template)
      * Overrides the autoescape setting
      *
      * @param boolean $state
+     * @deprecated 1.5
      */
-    public function setAutoescape($state) {
+    public function setAutoescape($state)
+    {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5', E_USER_DEPRECATED);
+
         $this->autoescape = (bool) $state;
     }
 }
diff --git a/system/src/Grav/Common/User/User.php b/system/src/Grav/Common/User/User.php
@@ -266,6 +266,8 @@ public function authorize($action)
      */
     public function authorise($action)
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use authorize() method instead', E_USER_DEPRECATED);
+
         return $this->authorize($action);
     }
 

diff --git a/system/src/Grav/Common/Utils.php b/system/src/Grav/Common/Utils.php
@@ -696,6 +696,8 @@ public static function date2timestamp($date, $format = null)
      */
     public static function resolve(array $array, $path, $default = null)
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use getDotNotation() method instead', E_USER_DEPRECATED);
+
         return static::getDotNotation($array, $path, $default);
     }
 

diff --git a/system/src/Grav/Framework/File/Formatter/IniFormatter.php b/system/src/Grav/Framework/File/Formatter/IniFormatter.php
@@ -29,6 +29,8 @@ public function __construct(array $config = [])
      */
     public function getFileExtension()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use getDefaultFileExtension() method instead', E_USER_DEPRECATED);
+
         return $this->getDefaultFileExtension();
     }
 

diff --git a/system/src/Grav/Framework/File/Formatter/JsonFormatter.php b/system/src/Grav/Framework/File/Formatter/JsonFormatter.php
@@ -27,6 +27,8 @@ public function __construct(array $config = [])
      */
     public function getFileExtension()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use getDefaultFileExtension() method instead', E_USER_DEPRECATED);
+
         return $this->getDefaultFileExtension();
     }
 

diff --git a/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php b/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php
@@ -33,6 +33,8 @@ public function __construct(array $config = [], FormatterInterface $headerFormat
      */
     public function getFileExtension()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use getDefaultFileExtension() method instead', E_USER_DEPRECATED);
+
         return $this->getDefaultFileExtension();
     }
 

diff --git a/system/src/Grav/Framework/File/Formatter/SerializeFormatter.php b/system/src/Grav/Framework/File/Formatter/SerializeFormatter.php
@@ -29,6 +29,8 @@ public function __construct(array $config = [])
      */
     public function getFileExtension()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use getDefaultFileExtension() method instead', E_USER_DEPRECATED);
+
         return $this->getDefaultFileExtension();
     }
 

diff --git a/system/src/Grav/Framework/File/Formatter/YamlFormatter.php b/system/src/Grav/Framework/File/Formatter/YamlFormatter.php
@@ -34,6 +34,8 @@ public function __construct(array $config = [])
      */
     public function getFileExtension()
     {
+        user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.5, use getDefaultFileExtension() method instead', E_USER_DEPRECATED);
+
         return $this->getDefaultFileExtension();
     }