Merge pull request #11 from Ortus-Solutions/development

v1.5.0

ModuleConfig.cfc

@@ -10,7 +10,7 @@ component {
 
 	this.name      = "TestBox CLI";
 	this.version   = "@build.version@[email protected]@";
-	this.cfmapping = "testbox-cli";
+	this.cfmapping = "testboxCLI";
 
 	function configure(){
 		settings = { templatesPath : modulePath & "/templates" }

README.md

@@ -35,6 +35,21 @@ box install testbox-cli
 
 You can use the CLI for many things like generating tests, harnesses, running tests and more.  Please remember that you can always get help on any command by using the `--help` flag.
 
+## BoxLang Generation Support
+
+The CLI will try to detect if you are running a BoxLang server or are in a BoxLang project using the following discovery techniques in order to determine if the command generators should use the BoxLang language or CFML.
+
+- Is the server running in the current directory a BoxLang server
+- Do you have a `testbox.runner=boxlang` in your `box.json` file
+- Do you have the `language=boxlang` in your `box.json` file
+
+## CFML Generation Support
+
+The CLI will try to detect if you are running a CFML server or are in a CFML project using the following discovery techniques in order to determine if the command generators should use the CFML language or BoxLang.
+
+- Is the server running in the current directory a CFML (Lucee or Adobe) server
+- Do you have a `language=cfml` in your `box.json` file
+
 ----
 
 ## Credits & Contributions

box.json

@@ -1,6 +1,6 @@
 {
     "name":"TestBox CLI",
-    "version":"1.4.0",
+    "version":"1.5.0",
     "location":"https://downloads.ortussolutions.com/ortussolutions/commandbox-modules/testbox-cli/@build.version@/[email protected]@.zip",
     "slug":"testbox-cli",
     "author":"Ortus Solutions, Corp",

changelog.md

@@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Internal refactoring for reuse of commands
+- BoxLang support for all generation commands and templates
+- You can now also use `--boxlang` to generate templates in BoxLang explicitly without detection
+- Bundle `displayName` now showing up on the reports
+- Updated the `run` command with tons of docs
+- Mutually exclusive options for `run` command which never existed before for `bundles` and `directory`
+
+### Bugs
+
+- Using the `useTestBoxLocal` was not working correctly and re-downloading TestBox every time
+- TestBox run should use webroot when resolving testbox location in ensureTestBox()
+
 ## [1.4.0] - 2024-02-29
 
 ### Added

commands/testbox/apidocs.cfc

@@ -16,7 +16,6 @@ component {
 	 **/
 	function run(){
 		var docsUri = "https://apidocs.ortussolutions.com/##/testbox";
-
 		command( "browse" ).params( uri: docsUri ).run();
 	}
 

commands/testbox/create/bdd.cfc

@@ -7,20 +7,23 @@
  * {code}
  *
  **/
-component {
-
-	property name="settings" inject="box:modulesettings:testbox-cli";
+component extends="testboxCLI.models.BaseCommand" {
 
 	/**
-	 * @name.hint Name of the BDD spec to create without the .cfc. For packages, specify name as 'myPackage/myBDDSpec'
-	 * @open.hint Open the file once it is created
-	 * @directory.hint The base directory to create your BDD spec in and creates the directory if it does not exist.
+	 * @name Name of the BDD spec to create without the .cfc. For packages, specify name as 'myPackage/myBDDSpec'
+	 * @open Open the file once it is created
+	 * @directory The base directory to create your BDD spec in and creates the directory if it does not exist.
+	 * @boxlang   Is this a boxlang project? else it is a CFML project
 	 **/
 	function run(
 		required name,
-		boolean open = false,
-		directory    = getCWD()
+		boolean open    = false,
+		directory       = getCWD(),
+		boolean boxlang = isBoxLangProject( getCWD() )
 	){
+		isBoxLangProject();
+		return;
+
 		// Allow dot-delimited paths
 		arguments.name = replace( arguments.name, ".", "/", "all" );
 
@@ -46,7 +49,7 @@ component {
 		print.line();
 
 		// Read in Templates
-		var BDDContent = fileRead( "#variables.settings.templatesPath#/testbox/bdd.txt" );
+		var BDDContent = fileRead( "#variables.settings.templatesPath#/#arguments.boxlang ? "bx" : "cfml"#/bdd.txt" );
 
 		// Write out BDD Spec
 		var BDDPath= "#arguments.directory#/#name#.cfc";

commands/testbox/create/unit.cfc

@@ -7,19 +7,19 @@
  * {code}
  *
  **/
-component {
-
-	property name="settings" inject="box:modulesettings:testbox-cli";
+component extends="testboxCLI.models.BaseCommand" {
 
 	/**
-	 * @name.hint Name of the xUnit bundle to create without the .cfc. For packages, specify name as 'myPackage/MyTest'
-	 * @open.hint Open the file once it is created
-	 * @directory.hint The base directory to create your CFC in and creates the directory if it does not exist.
+	 * @name Name of the xUnit bundle to create without the .cfc. For packages, specify name as 'myPackage/MyTest'
+	 * @open Open the file once it is created
+	 * @directory The base directory to create your CFC in and creates the directory if it does not exist.
+	 * @boxlang   Is this a boxlang project? else it is a CFML project
 	 **/
 	function run(
 		required name,
-		boolean open = false,
-		directory    = getCWD()
+		boolean open    = false,
+		directory       = getCWD(),
+		boolean boxlang = isBoxLangProject( getCWD() )
 	){
 		// Allow dot-delimited paths
 		arguments.name = replace( arguments.name, ".", "/", "all" );
@@ -46,7 +46,7 @@ component {
 		print.line();
 
 		// Read in Templates
-		var content = fileRead( "#variables.settings.templatesPath#/testbox/unit.txt" );
+		var content = fileRead( "#variables.settings.templatesPath#/#arguments.boxlang ? "bx" : "cfml"#/unit.txt" );
 
 		// Write out BDD Spec
 		var thisPath= "#arguments.directory#/#name#.cfc";

commands/testbox/docs.cfc

@@ -21,7 +21,6 @@ component {
 	 **/
 	function run( string search = "" ){
 		var docsUri = "https://testbox.ortusbooks.com" & ( search.len() ? "?q=#search#" : "" );
-
 		command( "browse" ).params( uri: docsUri ).run();
 	}
 

commands/testbox/generate/browser.cfc

@@ -11,24 +11,26 @@
  * testbox create browser C:\myApp
  * {code}
  */
-component {
-
-	property name="settings" inject="box:modulesettings:testbox-cli";
+component extends="testboxCLI.models.BaseCommand" {
 
 	/**
 	 * @directory The base directory to create your test browser
+	 * @boxlang   Is this a boxlang project? else it is a CFML project
 	 */
-	function run( string directory = getCWD() ){
+	function run(
+		string directory = getCWD(),
+		boolean boxlang  = isBoxLangProject( getCWD() )
+	){
 		// This will make each directory canonical and absolute
-		arguments.directory = resolvePath( arguments.directory & "/tests/test-browser" );
+		arguments.directory = resolvePath( arguments.directory & "/tests/browser" );
 
 		// Validate directory
 		if ( !directoryExists( arguments.directory ) ) {
 			directoryCreate( arguments.directory );
 
-			// Copy template
+			// Copy template from testbox source
 			directoryCopy(
-				"#variables.settings.templatesPath#/testbox/test-browser/",
+				"#variables.settings.templatesPath#/#arguments.boxlang ? "bx" : "cfml"#/browser/",
 				arguments.directory,
 				true
 			);

commands/testbox/generate/harness.cfc

@@ -11,24 +11,26 @@
  * testbox create harness C:\myApp
  * {code}
  */
-component {
-
-	property name="settings" inject="box:modulesettings:testbox-cli";
+component extends="testboxCLI.models.BaseCommand" {
 
 	/**
-	 * @directory The base directory to create your test harness
+	 * @directory The base directory to create your test browser
+	 * @boxlang   Is this a boxlang project? else it is a CFML project
 	 */
-	function run( string directory = getCWD() ){
+	function run(
+		string directory = getCWD(),
+		boolean boxlang  = isBoxLangProject( getCWD() )
+	){
 		// This will make each directory canonical and absolute
 		arguments.directory = resolvePath( arguments.directory & "/tests" );
 
 		// Validate directory
 		if ( !directoryExists( arguments.directory ) ) {
 			directoryCreate( arguments.directory );
 
-			// Copy template
+			// Copy template from testbox source
 			directoryCopy(
-				"#variables.settings.templatesPath#/testbox/test-harness/",
+				"#variables.settings.templatesPath#/#arguments.boxlang ? "bx" : "cfml"#/tests/",
 				arguments.directory,
 				true
 			);

commands/testbox/generate/module.cfc

@@ -11,17 +11,17 @@
  * testbox create module myModule tests/resources/modules
  * {code}
  */
-component {
-
-	property name="settings" inject="box:modulesettings:testbox-cli";
+component extends="testboxCLI.models.BaseCommand" {
 
 	/**
 	 * @name The name of the module
 	 * @rootDirectory Where to create the module, by default it will be in the same folder as you call the command
+	 * @boxlang   Is this a boxlang project? else it is a CFML project
 	 */
 	function run(
 		required name,
-		string rootDirectory = getCWD()
+		string rootDirectory = getCWD(),
+		boolean boxlang      = isBoxLangProject( getCWD() )
 	){
 		var moduleDirectory = resolvePath( arguments.rootDirectory ) & "/" & arguments.name;
 
@@ -31,7 +31,7 @@ component {
 
 			// Copy template
 			directoryCopy(
-				"#variables.settings.templatesPath#/testbox/module/",
+				"#variables.settings.templatesPath#/#arguments.boxlang ? "bx" : "cfml"#/module/",
 				moduleDirectory,
 				true
 			);

commands/testbox/generate/visualizer.cfc

@@ -11,9 +11,7 @@
  * testbox create visualizer C:\myApp
  * {code}
  */
-component {
-
-	property name="settings" inject="box:modulesettings:testbox-cli";
+component extends="testboxCLI.models.BaseCommand" {
 
 	/**
 	 * @directory The base directory to create your test visualizer
@@ -22,13 +20,16 @@ component {
 		// This will make each directory canonical and absolute
 		arguments.directory = resolvePath( arguments.directory & "/tests/test-visualizer" );
 
+		// Make sure we have the latest TestBox for assets
+		ensureTestBox( false );
+
 		// Validate directory
 		if ( !directoryExists( arguments.directory ) ) {
 			directoryCreate( arguments.directory );
 
 			// Copy template
 			directoryCopy(
-				"#variables.settings.templatesPath#/testbox/test-visualizer/",
+				expandPath( "/testbox/test-visualizer" ),
 				arguments.directory,
 				true
 			);