#420 Renamed mlRestApi to mlBundle

Author: rjrudin

README.md

@@ -54,7 +54,7 @@ Now deploy it!
 And you should see more ml-gradle logging like this:
 
     :mlDeleteModuleTimestampsFile
-    :mlPrepareRestApiDependencies
+    :mlPrepareBundles
     :mlDeployApp
     :mlPostDeploy UP-TO-DATE
     :mlDeploy

examples/dependency-project/README.md

@@ -26,21 +26,21 @@ You'll see logging like this that lets you know that the modules and data from t
 will be included when the application is deployed:
 
 ```
-Found mlRestApi configuration, will extract all of its dependencies to build/mlRestApi
+Found mlBundle configuration, will extract all of its dependencies to build/mlBundle
 Extracting file: /Users/rrudin/.m2/repository/com/marklogic/example-dependency/1.0.0/example-dependency-1.0.0.jar
-    [unzip] Expanding: /Users/rrudin/.m2/repository/com/marklogic/example-dependency/1.0.0/example-dependency-1.0.0.jar into /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlRestApi
-Finished extracting mlRestApi dependencies
-Module paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlRestApi/example-dependency/ml-modules, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-modules]
-Data paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlRestApi/example-dependency/ml-data, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-data]
-:mlPrepareRestApiDependencies (Thread[Task worker for ':' Thread 4,5,main]) completed. Took 0.165 secs.
+    [unzip] Expanding: /Users/rrudin/.m2/repository/com/marklogic/example-dependency/1.0.0/example-dependency-1.0.0.jar into /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle
+Finished extracting mlBundle dependencies
+Module paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-modules, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-modules]
+Data paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-data, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-data]
+:mlPrepareBundles (Thread[Task worker for ':' Thread 4,5,main]) completed. Took 0.165 secs.
 ```
 
 And you'll see logging like this that indicates that the example-dependency modules were loaded:
 
 ```
 Executing command [com.marklogic.appdeployer.command.modules.LoadModulesCommand] with sort order [400]
 Initializing new instance of ModulesLoader
-Loading asset modules from dir: /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlRestApi/example-dependency/ml-modules
+Loading asset modules from dir: /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-modules
 Writing 1 files
 Writing: /example.sjs
 Writing 1 documents to MarkLogic; port: 8000; database: ml-gradle-client-modules

examples/dependency-project/dhf-client-project/build.gradle

@@ -22,5 +22,5 @@ repositories {
 }
 
 dependencies {
-	mlRestApi "com.marklogic:example-dependency:1.0.0"
+	mlBundle "com.marklogic:example-dependency:1.0.0"
 }

examples/dependency-project/ml-gradle-client-project/build.gradle

@@ -19,5 +19,5 @@ repositories {
 }
 
 dependencies {
-	mlRestApi "com.marklogic:example-dependency:1.0.0"
+	mlBundle "com.marklogic:example-dependency:1.0.0"
 }

examples/sample-project/build.gradle

@@ -92,7 +92,7 @@ ext {
 		// You can have multiple config files for your content database. This is useful when you have a dependency on
 		// a package of MarkLogic modules that requires some content database config, and you don't want to duplicate
 		// that in your own content-database.json file. Instead, just add the file from your
-		// build/mlRestApi/(name of dependency)/ml-config/databases directory.
+		// build/mlBundle/(name of dependency)/ml-config/databases directory.
 		configDir.contentDatabaseFiles.add(new File("src/main/ml-config/databases/more-content-database-config.json"))
 
 		// XCC URL for running corb task below and for creating triggers on pre-8.0-4 builds of MarkLogic

examples/unit-test-project/README.md

@@ -16,15 +16,15 @@ include this by default (not every ml-gradle user will use marklogic-unit-test),
       }
     }
 
-Next, the marklogic-unit-test framework is depended on and installed as an "mlRestApi" dependency (the "mlRestApi" configuration
+Next, the marklogic-unit-test framework is depended on and installed as an "mlBundle" dependency (the "mlBundle" configuration
 is a feature of ml-gradle for depending on packages of MarkLogic modules):
 
     repositories {
       jcenter()
     }
       
     dependencies {
-      mlRestApi "com.marklogic:marklogic-unit-test-modules:0.12.0"
+      mlBundle "com.marklogic:marklogic-unit-test-modules:0.12.0"
     }
 
 ## Running unit tests

examples/unit-test-project/build.gradle

@@ -17,7 +17,7 @@ repositories {
 }
 
 dependencies {
-	mlRestApi "com.marklogic:marklogic-unit-test-modules:${marklogicUnitTestVersion}"
+	mlBundle "com.marklogic:marklogic-unit-test-modules:${marklogicUnitTestVersion}"
 
 	// For running marklogic-unit-test tests via JUnit
 	testCompile "com.marklogic:marklogic-unit-test-client:${marklogicUnitTestVersion}"

src/main/groovy/com/marklogic/gradle/MarkLogicPlugin.groovy

@@ -88,10 +88,12 @@ class MarkLogicPlugin implements Plugin<Project> {
 
 		copyGradlePropertiesToCustomTokensIfRequested(project)
 
+		project.getConfigurations().create("mlBundle")
+		// Per #420, this is deprecated, but still need to create it
 		project.getConfigurations().create("mlRestApi")
 
 		// No group or description on these so they don't show up in "gradle tasks"
-		project.task("mlDeployApp", type: DeployAppTask, dependsOn: ["mlDeleteModuleTimestampsFile", "mlPrepareRestApiDependencies"])
+		project.task("mlDeployApp", type: DeployAppTask, dependsOn: ["mlDeleteModuleTimestampsFile", "mlPrepareBundles"])
 		project.task("mlUndeployApp", type: UndeployAppTask)
 
 		String deployGroup = "ml-gradle Deploy"
@@ -130,7 +132,7 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.task("mlRestartCluster", type: RestartClusterTask, group: clusterGroup, description: "Restart the local cluster")
 
 		String dataGroup = "ml-gradle Data"
-		project.task("mlLoadData", type: LoadDataTask, group: dataGroup, dependsOn: "mlPrepareRestApiDependencies",
+		project.task("mlLoadData", type: LoadDataTask, group: dataGroup, dependsOn: "mlPrepareBundles",
 			description: "Load files as documents into a content database (or on a DHF project, the final database)")
 
 		String dbGroup = "ml-gradle Database"
@@ -141,7 +143,7 @@ class MarkLogicPlugin implements Plugin<Project> {
 			"Note that this includes those created via the deployment of resources such as temporal collections and view schemas. You may want to use mlDeleteUserSchemas instead.")
 		project.task("mlClearTriggersDatabase", type: ClearTriggersDatabaseTask, group: dbGroup, description: "Deletes all documents in the triggers database")
 		project.task("mlDeleteDatabase", type: DeleteDatabaseTask, group: dbGroup, description: "Delete a database along with all of its forests and any replicas; requires -Pconfirm=true to be set so this isn't accidentally executed")
-		project.task("mlDeployDatabases", type: DeployDatabasesTask, group: dbGroup, dependsOn: "mlPrepareRestApiDependencies", description: "Deploy each database, updating it if it exists, in the configuration directory")
+		project.task("mlDeployDatabases", type: DeployDatabasesTask, group: dbGroup, dependsOn: "mlPrepareBundles", description: "Deploy each database, updating it if it exists, in the configuration directory")
 		project.task("mlMergeContentDatabase", type: MergeContentDatabaseTask, group: dbGroup, description: "Merge the database named by mlAppConfig.contentDatabaseName")
 		project.task("mlMergeDatabase", type: MergeDatabaseTask, group: dbGroup, description: "Merge the database named by the project property dbName; e.g. gradle mlMergeDatabase -PdbName=my-database")
 		project.task("mlReindexContentDatabase", type: ReindexContentDatabaseTask, group: dbGroup, description: "Reindex the database named by mlAppConfig.contentDatabaseName")
@@ -168,7 +170,8 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.task("mlCreateResource", type: CreateResourceTask, group: devGroup, description: "Create a new resource extension in the modules services directory; use -PresourceName and -PresourceType to set the resource name and type (either xqy or sjs)")
 		project.task("mlCreateTransform", type: CreateTransformTask, group: devGroup, description: "Create a new transform in the modules transforms directory; use -PtransformName and -PtransformType to set the transform name and type (xqy, xsl, or sjs)")
 		project.task("mlExportResources", type: ExportResourcesTask, group: devGroup, description: "Export resources based on a properties file specified via -PpropertiesFile, -Pprefix, or -Pregex; use -PincludeTypes to select resource types to export via a comma-delimited string; use -PexportPath to specify where to export resources to")
-		project.task("mlPrepareRestApiDependencies", type: PrepareRestApiDependenciesTask, group: devGroup, dependsOn: project.configurations["mlRestApi"], description: "Downloads (if necessary) and unzips in the build directory all mlRestApi dependencies")
+		project.task("mlPrepareBundles", type: PrepareBundlesTask, group: devGroup, dependsOn: project.configurations["mlBundle"], description: "Downloads (if necessary) and unzips in the build directory all mlBundle dependencies")
+		project.task("mlPrepareRestApiDependencies", type: PrepareBundlesTask, group: devGroup, dependsOn: project.configurations["mlBundle"], description: "Deprecated in 3.13.0; please use mlPrepareBundles instead")
 		project.task("mlPrintCommands", type: PrintCommandsTask, group: devGroup, description: "Print information about each command used by mlDeploy and mlUndeploy")
 		project.task("mlPrintProperties", type: PrintPropertiesTask, group: devGroup, description: "Print all of the properties supported by ml-gradle")
 		project.task("mlPrintTokens", type: PrintTokensTask, group: devGroup, description: "Print the customTokens map on the mlAppConfig object (typically for debugging purposes)")
@@ -214,7 +217,7 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.task("mlUndeployMimetypes", type: UndeployMimetypesTask, group: mimetypesGroup, description: "Undeploy each mimetype defined in the configuration directory")
 
 		String modulesGroup = "ml-gradle Modules"
-		project.task("mlLoadModules", type: LoadModulesTask, group: modulesGroup, dependsOn: "mlPrepareRestApiDependencies", description: "Loads modules from directories defined by mlAppConfig or via a property on this task").mustRunAfter(["mlClearModulesDatabase"])
+		project.task("mlLoadModules", type: LoadModulesTask, group: modulesGroup, dependsOn: "mlPrepareBundles", description: "Loads modules from directories defined by mlAppConfig or via a property on this task").mustRunAfter(["mlClearModulesDatabase"])
 		project.task("mlReloadModules", group: modulesGroup, dependsOn: ["mlClearModulesDatabase", "mlLoadModules"], description: "Reloads modules by first clearing the modules database and then loading modules")
 		project.task("mlWatch", type: WatchTask, group: modulesGroup, description: "Run a loop that checks for new/modified modules every second and loads any that it finds. To ignore files that are already dirty and only process new changes, include -PignoreDirty=true . ")
 		project.task("mlDeleteModuleTimestampsFile", type: DeleteModuleTimestampsFileTask, group: modulesGroup, description: "Delete the properties file in the build directory that keeps track of when each module was last loaded")
@@ -235,7 +238,7 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.task("mlReloadSchemas", dependsOn: ["mlDeleteUserSchemas", "mlLoadSchemas"], group: schemasGroup, description: "Deletes user schemas via mlDeleteUserSchemas and then loads schemas via mlLoadSchemas")
 
 		String serverGroup = "ml-gradle Server"
-		project.task("mlDeployServers", type: DeployServersTask, group: serverGroup, dependsOn: "mlPrepareRestApiDependencies", description: "Updates the REST API server (if it exists) and deploys each other server, updating it if it exists, in the configuration directory ")
+		project.task("mlDeployServers", type: DeployServersTask, group: serverGroup, dependsOn: "mlPrepareBundles", description: "Updates the REST API server (if it exists) and deploys each other server, updating it if it exists, in the configuration directory ")
 		project.task("mlUndeployOtherServers", type: UndeployOtherServersTask, group: serverGroup, description: "Delete any non-REST API servers (e.g. ODBC and XBC servers) defined by server files in the configuration directory")
 
 		String securityGroup = "ml-gradle Security"

src/main/groovy/com/marklogic/gradle/task/client/CreateResourceTask.groovy

@@ -94,7 +94,7 @@ declare function delete(
 	        if (!servicesPath) {
 		        List<String> modulePaths = getAppConfig().getModulePaths()
 		        if (modulePaths != null && !modulePaths.isEmpty()) {
-			        // Use the last path so modules aren't written to e.g. mlRestApi paths
+			        // Use the last path so modules aren't written to e.g. mlBundle paths
 			        servicesPath = modulePaths.get(modulePaths.size() - 1) + "/services"
 		        }
 	        }

src/main/groovy/com/marklogic/gradle/task/client/CreateTransformTask.groovy

@@ -56,7 +56,7 @@ exports.transform = transform;
 	        if (!transformsPath) {
 		        List<String> modulePaths = getAppConfig().getModulePaths()
 		        if (modulePaths != null && !modulePaths.isEmpty()) {
-			        // Use the last path so modules aren't written to e.g. mlRestApi paths
+			        // Use the last path so modules aren't written to e.g. mlBundle paths
 			        transformsPath = modulePaths.get(modulePaths.size() - 1) + "/transforms"
 		        }
 	        }