timer delegates

Author: lmajano

changelog.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * ColdBox 7 support
+* New `TimerDelegate` that can be used to add timer functions to any model
 * Timer service rewritten to support nesting and included metadata
 * Ability to open views and layouts from the execution timers in any Code Editor
 * New `WireBoxCollector` which is only used if enabled.  This greatly accelerates the performance of the request collector since before they where in the same collector.

models/TimerDelegate.cfc

@@ -0,0 +1,47 @@
+/**
+ * Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
+ * www.ortussolutions.com
+ * ---
+ * This delegate allows objects to be able to time themselves into the debugger
+ */
+component accessors="true" singleton threadsafe {
+
+	// DI
+	property name="timer" inject="Timer@cbdebugger";
+
+	/**
+	 * Start a timer with a tracking label
+	 *
+	 * @label The tracking label to register
+	 *
+	 * @return A unique tracking hash you must use to stop the timer
+	 */
+	function startCBTimer( required label ){
+		return variables.timer.start( arguments.label );
+	}
+
+	/**
+	 * End a code timer with a tracking hash. If the tracking hash is not tracked we ignore it
+	 *
+	 * @labelHash The timer label hash to stop
+	 */
+	function stopCBTimer( required labelHash ){
+		return variables.timer.stop( arguments.labelHash );
+	}
+
+	/**
+	 * Time the execution of the passed closure that we will execution for you
+	 *
+	 * @label    The label to use as a timer label
+	 * @closure  The target to execute and time
+	 * @metadata A struct of metadata to store in the execution timer
+	 */
+	function cbTimeIt(
+		required label,
+		required closure,
+		struct metadata = {}
+	){
+		return variables.timer.timeIt( argumentCollection = arguments );
+	}
+
+}

readme.md

@@ -105,8 +105,8 @@ moduleSettings = {
 		requestTracker : {
 			// Track all cbdebugger events, by default this is off, turn on, when actually profiling yourself :) How Meta!
 			trackDebuggerEvents          : false,
-			// Store the request profilers in heap memory or in cachebox, default is cachebox. Options are: local, cachebox
-			storage                      : "cachebox",
+			// Store the request profilers in heap memory or in cachebox, default is memory. Options are: memory, cachebox
+			storage                      : "memory",
 			// Which cache region to store the profilers in if storage == cachebox
 			cacheName                    : "template",
 			// Expand by default the tracker panel or not
@@ -266,6 +266,23 @@ This module will also register a few methods in all your handlers/interceptors/l
 	)
 ```
 
+## Timer Delegate
+
+We have included a ColdBox 7 Timer delegate: `TimerDelegate@cbDebguger` that can add timing capabilities to any CFC
+
+```js
+component delegates="TimerDelegate@cbDebguger"{
+
+...
+	startCBTimer();
+	stopCBTimer();
+	timeIt();
+...
+
+}
+
+```
+
 ## Debugger Events
 
 The debugger also announces several events that you can listen to and extend the debugging and profiling capabilities:

test-harness/box.json

@@ -6,20 +6,16 @@
     "description":"",
     "dependencies":{
         "coldbox":"be",
-        "JSONPrettyPrint":"^1.4.1",
         "quick":"^4.2.4",
-        "cborm":"^3.0.0+184",
-        "sqlformatter":"^1.0.1"
+        "cborm":"^4.0.0"
     },
     "devDependencies":{
         "testbox":"*"
     },
     "installPaths":{
         "coldbox":"coldbox/",
         "testbox":"testbox/",
-        "JSONPrettyPrint":"modules/JSONPrettyPrint/",
         "quick":"modules/quick/",
-        "cborm":"modules/cborm/",
-        "sqlformatter":"modules/sqlformatter/"
+        "cborm":"modules/cborm/"
     }
 }