Merge branch 'release/1.0.0' into v1

CHANGELOG.md

@@ -2,8 +2,6 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
-
-## 1.0.0 - 2018-04-06
+## 1.0.0 - 2018-04-07
 ### Added
 - Initial release

README.md

@@ -61,7 +61,7 @@ Reload your page, and then click on the **Time** section of the Debug Toolbar, a
 
 The **Duration** column shows how long it took to execute the chunk of code inside of the `{% profile %}` block.
 
-The **Category** column shows the type of the profile sample, which will always been **Twig Profiler** for profile data collected by Twig Profiler.
+The **Category** column shows the type of the profile sample, which will always been **Twig Profiler** along with the name of the template, for profile data collected by Twig Profiler.
 
 The **Info** column shows the unique identifier we passed in.
 

src/TwigProfiler.php

@@ -11,12 +11,16 @@
 
 namespace nystudio107\twigprofiler;
 
+use nystudio107\twigprofiler\models\Settings;
 use nystudio107\twigprofiler\services\Profile as ProfileService;
 use nystudio107\twigprofiler\twigextensions\ProfilerTwigExtension;
-use nystudio107\twigprofiler\models\Settings;
 
 use Craft;
 use craft\base\Plugin;
+use craft\events\TemplateEvent;
+use craft\web\View;
+
+use yii\base\Event;
 
 /**
  * Class TwigProfiler
@@ -37,6 +41,11 @@ class TwigProfiler extends Plugin
      */
     public static $plugin;
 
+    /**
+     * @var string The name of the rendering template
+     */
+    public static $renderingTemplate = '';
+
     // Public Properties
     // =========================================================================
 
@@ -56,8 +65,24 @@ public function init()
         parent::init();
         self::$plugin = $this;
 
+        $settings = $this->getSettings();
         Craft::$app->view->registerTwigExtension(new ProfilerTwigExtension());
 
+        if ($settings->appendTemplateName) {
+            // Handler: View::EVENT_BEFORE_RENDER_TEMPLATE
+            Event::on(
+                View::class,
+                View::EVENT_BEFORE_RENDER_TEMPLATE,
+                function (TemplateEvent $event) {
+                    Craft::debug(
+                        'View::EVENT_BEFORE_RENDER_TEMPLATE',
+                        __METHOD__
+                    );
+                    self::$renderingTemplate = ' - '.$event->template;
+                }
+            );
+        }
+
         Craft::info(
             Craft::t(
                 'twig-profiler',

src/config.php

@@ -2,7 +2,8 @@
 /**
  * Twig Profiler plugin for Craft CMS 3.x
  *
- * Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
+ * Twig Profiler allows you to profile sections of your Twig templates, and see
+ * the resulting timings in the Yii2 Debug Toolbar
  *
  * @link      https://nystudio107.com/
  * @copyright Copyright (c) 2018 nystudio107
@@ -18,13 +19,12 @@
  * and make your changes there to override default settings.
  *
  * Once copied to 'craft/config', this file will be multi-environment aware as
- * well, so you can have different settings groups for each environment, just as
- * you do for 'general.php'
+ * well, so you can have different settings groups for each environment, just
+ * as you do for 'general.php'
  */
 
 return [
 
-    // This controls blah blah blah
-    "someAttribute" => true,
-
+    // Controls whether to append the template name to the profile category
+    'appendTemplateName' => true,
 ];

src/models/Settings.php

@@ -2,7 +2,8 @@
 /**
  * Twig Profiler plugin for Craft CMS 3.x
  *
- * Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
+ * Twig Profiler allows you to profile sections of your Twig templates, and see
+ * the resulting timings in the Yii2 Debug Toolbar
  *
  * @link      https://nystudio107.com/
  * @copyright Copyright (c) 2018 nystudio107
@@ -26,21 +27,21 @@ class Settings extends Model
     // =========================================================================
 
     /**
-     * @var string
+     * @var bool Controls whether to append the template name to the profile
+     *      category
      */
-    public $someAttribute = 'Some Default';
+    public $appendTemplateName = true;
 
     // Public Methods
     // =========================================================================
 
     /**
      * @inheritdoc
      */
-    public function rules()
+    public function rules(): array
     {
         return [
-            ['someAttribute', 'string'],
-            ['someAttribute', 'default', 'value' => 'Some Default'],
+            ['appendTemplateName', 'boolean'],
         ];
     }
 }

src/services/Profile.php

@@ -2,7 +2,8 @@
 /**
  * Twig Profiler plugin for Craft CMS 3.x
  *
- * Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
+ * Twig Profiler allows you to profile sections of your Twig templates, and see
+ * the resulting timings in the Yii2 Debug Toolbar
  *
  * @link      https://nystudio107.com/
  * @copyright Copyright (c) 2018 nystudio107
@@ -12,6 +13,7 @@
 
 use Craft;
 use craft\base\Component;
+use nystudio107\twigprofiler\TwigProfiler;
 
 /**
  * @author    nystudio107
@@ -20,6 +22,11 @@
  */
 class Profile extends Component
 {
+    // Constants
+    // =========================================================================
+
+    const CATEGORY_PREFIX = 'Twig Profiler';
+
     // Public Methods
     // =========================================================================
 
@@ -30,7 +37,11 @@ class Profile extends Component
      */
     public function begin(string $profile)
     {
-        Craft::beginProfile($profile, 'Twig Profiler');
+        Craft::beginProfile(
+            $profile,
+            Craft::t('twig-profiler', self::CATEGORY_PREFIX)
+            .TwigProfiler::$renderingTemplate
+        );
     }
 
     /**
@@ -40,6 +51,10 @@ public function begin(string $profile)
      */
     public function end(string $profile)
     {
-        Craft::endProfile($profile, 'Twig Profiler');
+        Craft::endProfile(
+            $profile,
+            Craft::t('twig-profiler', self::CATEGORY_PREFIX)
+            .TwigProfiler::$renderingTemplate
+        );
     }
 }

src/translations/en/twig-profiler.php

@@ -2,7 +2,8 @@
 /**
  * Twig Profiler plugin for Craft CMS 3.x
  *
- * Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
+ * Twig Profiler allows you to profile sections of your Twig templates, and see
+ * the resulting timings in the Yii2 Debug Toolbar
  *
  * @link      https://nystudio107.com/
  * @copyright Copyright (c) 2018 nystudio107
@@ -14,5 +15,6 @@
  * @since     1.0.0
  */
 return [
-    'Twig Profiler plugin loaded' => 'Twig Profiler plugin loaded',
+    '{name} plugin loaded' => '{name} plugin loaded',
+    'Twig Profiler'        => 'Twig Profiler',
 ];

src/twigextensions/ProfilerNode.php

@@ -2,7 +2,8 @@
 /**
  * Twig Profiler plugin for Craft CMS 3.x
  *
- * Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
+ * Twig Profiler allows you to profile sections of your Twig templates, and see
+ * the resulting timings in the Yii2 Debug Toolbar
  *
  * @link      https://nystudio107.com/
  * @copyright Copyright (c) 2018 nystudio107
@@ -14,6 +15,7 @@
 
 /**
  * Class ProfilerTokenParser
+ *
  * @author    nystudio107
  * @package   TwigProfiler
  * @since     1.0.0

src/twigextensions/ProfilerTokenParser.php

@@ -2,7 +2,8 @@
 /**
  * Twig Profiler plugin for Craft CMS 3.x
  *
- * Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
+ * Twig Profiler allows you to profile sections of your Twig templates, and see
+ * the resulting timings in the Yii2 Debug Toolbar
  *
  * @link      https://nystudio107.com/
  * @copyright Copyright (c) 2018 nystudio107
@@ -12,6 +13,7 @@
 
 /**
  * Class ProfilerTokenParser
+ *
  * @author    nystudio107
  * @package   TwigProfiler
  * @since     1.0.0
@@ -49,6 +51,7 @@ public function parse(\Twig_Token $token)
 
     /**
      * @param \Twig_Token $token
+     *
      * @return bool
      */
     public function decideProfilerEnd(\Twig_Token $token): bool