Rework 2.0 as generic Box module

Author: bdw429s

.gitignore

@@ -17,4 +17,5 @@ workbench/*
 build/*
 
 # Engines
-.engine/**
+.engine/**
+.project

.module.properties

@@ -1,3 +1,3 @@
 project.name=cbjavaloader
-project.version=1.7.0
+project.version=2.0.0
 module.name=cbjavaloader

box.json

@@ -1,6 +1,6 @@
 {
     "name":"cbjavaloader Builder",
-    "version":"1.7.0",
+    "version":"2.0.0",
     "slug":"cbjavaloader-shell",
     "private":false,
     "defaultPort":0,
@@ -12,9 +12,9 @@
         "testbox":"^2.6.0+156"
     },
     "installPaths":{
-        "workbench":"workbench/",
-        "coldbox":"coldbox/",
-        "testbox":"testbox/"
+        "workbench":"workbench",
+        "coldbox":"coldbox",
+        "testbox":"testbox"
     },
     "testbox":{
         "runner":"http://localhost:49616"

modules/cbjavaloader/ModuleConfig.cfc

@@ -11,49 +11,75 @@ component {
 	this.webURL 			= "https://www.ortussolutions.com";
 	this.description 		= "A JavaLoader Module for ColdBox";
 	this.version			= "@build.version@[email protected]@";
-	// If true, looks for views in the parent first, if not found, then in the module. Else vice-versa
-	this.viewParentLookup 	= true;
-	// If true, looks for layouts in the parent first, if not found, then in module. Else vice-versa
-	this.layoutParentLookup = true;
-	// CF Mapping
 	this.cfmapping			= "cbjavaloader";
 
 	/**
 	* Configure module
 	*/	
 	function configure(){
+		
+		settings = {
+			// The array paths to load
+			loadPaths = [],
+			// Load ColdFusion classes with loader
+			loadColdFusionClassPath = false,
+			// Attach a custom class loader as a parent
+			parentClassLoader = "",
+			// Directories that contain Java source code that are to be dynamically compiled
+			sourceDirectories = [],
+			// the directory to build the .jar file for dynamic compilation in, defaults to ./tmp
+			compileDirectory = variables.modulePath & "models/javaloader/tmp",
+			// Whether or not the source is trusted, i.e. it is going to change? Defaults to false, so changes will be recompiled and loaded
+			trustedSource = false
+		};
+		
 		// Register Custom DSL, don't map it because it is too late, mapping DSLs are only good by the parent app
-		controller.getWireBox()
+		wireBox
 			.registerDSL( namespace="javaloader", path="#moduleMapping#.models.JavaLoaderDSL" );
 	}
 
 	/**
 	* Fired when the module is registered and activated.
 	*/
 	function onLoad(){
-		var settings = controller.getConfigSettings();
-		// parse parent settings
-		parseParentSettings();
 
 		// Bind Core JavaLoader
 		binder.map( "jl@cbjavaloader" )
-			.to( "#moduleMapping#.models.javaloader.JavaLoader" )
-			.initArg( name="loadPaths", 				value=settings.modules.cbjavaloader.settings.loadPaths )
-			.initArg( name="loadColdFusionClassPath", 	value=settings.modules.cbjavaloader.settings.loadColdFusionClassPath )
-			.initArg( name="parentClassLoader", 		value=settings.modules.cbjavaloader.settings.parentClassLoader )
-			.initArg( name="sourceDirectories", 		value=settings.modules.cbjavaloader.settings.sourceDirectories )
-			.initArg( name="compileDirectory", 			value=settings.modules.cbjavaloader.settings.compileDirectory )
-			.initArg( name="trustedSource", 			value=settings.modules.cbjavaloader.settings.trustedSource );
+			.to( "#moduleMapping#.models.javaloader.JavaLoader" );
+	
+		// Duplicating so our final change won't affect the main module settings
+		var finalSettings = duplicate( settings );
 
-		// Load JavaLoader and class loading
-		wirebox.getInstance( "loader@cbjavaloader" ).setup();
-	}
+		// Start with empty array
+		finalSettings.loadPaths = [];
 
-	/**
-	* Fired when the module is unregistered and unloaded
-	*/
-	function onUnload(){
+		// Grab module settings
+		var moduleSettingsLoadPath = settings.loadPaths;
+
+		// Force array
+		if( isSimpleValue( moduleSettingsLoadPath ) ) {
+			moduleSettingsLoadPath = moduleSettingsLoadPath.listToArray();
+		}
+		
+		// Loop over settings, adding files and expanding directories
+		for( var thisLocation in moduleSettingsLoadPath ){
+			if( directoryExists( thisLocation ) ) {
+				finalSettings.loadPaths.addAll( getJars( thisLocation ) );
+			} else if ( fileExists( thisLocation ) ) {
+				finalSettings.loadPaths.append( thisLocation );
+			} else {
+				throw( "Javalaoder cannot load #thisLocation# as it is not a valid path or file" );				
+			}
+		}
 
+		// Dynamic Proxy
+		arrayPrepend(
+			finalSettings.loadPaths,
+			variables.modulePath & "/models/javaloader/support/cfcdynamicproxy/lib/cfcdynamicproxy.jar"
+		);
+				
+		// Load JavaLoader and class loading
+		wirebox.getInstance( "loader@cbjavaloader" ).setup( finalSettings );
 	}
 
 	/**
@@ -73,73 +99,4 @@ component {
 		);
 	}
 
-	/**
-	* parse parent settings
-	*/
-	private function parseParentSettings(){
-		var oConfig 		= controller.getSetting( "ColdBoxConfig" );
-		var configStruct 	= controller.getConfigSettings();
-		var javaLoaderDSL 	= oConfig.getPropertyMixin( "javaloader", "variables", structnew() );
-
-		// Default Configurations
-		configStruct.modules.cbjavaloader.settings = {
-			// The array paths to load
-			loadPaths = variables.modulePath & "lib",
-			// Load ColdFusion classes with loader
-			loadColdFusionClassPath = false,
-			// Attach a custom class loader as a parent
-			parentClassLoader = "",
-			// Directories that contain Java source code that are to be dynamically compiled
-			sourceDirectories = [],
-			// the directory to build the .jar file for dynamic compilation in, defaults to ./tmp
-			compileDirectory = variables.modulePath & "model/javaloader/tmp",
-			// Whether or not the source is trusted, i.e. it is going to change? Defaults to false, so changes will be recompiled and loaded
-			trustedSource = false
-		};
-
-		// Default load paths, empty array
-		if( !structKeyExists( javaLoaderDSL, "loadPaths" ) ){
-			javaLoaderDSL.loadPaths = [];
-		}
-
-		// Array of locations
-		if( isArray( javaLoaderDSL.loadPaths ) ){
-			var aJarPaths = [];
-			for( var thisLocation in javaLoaderDSL.loadPaths ){
-				if( directoryExists( thisLocation ) ) {
-					aJarPaths.addAll( getJars( thisLocation ) );
-				} else if ( !fileExists( thisLocation ) ) {
-					throw( "Cannot load #thisLocation# as it is not a valid path or file" );
-				}
-			}
-			javaLoaderDSL.loadPaths = aJarPaths;
-		}
-
-		// Single directory? Get all Jars in it
-		if( isSimpleValue( javaLoaderDSL.loadPaths ) and directoryExists( javaLoaderDSL.loadPaths ) ){
-			javaLoaderDSL.loadPaths = getJars( javaLoaderDSL.loadPaths );
-		}
-		
-		// Single Jar?
-		if( isSimpleValue( javaLoaderDSL.loadPaths ) and fileExists( javaLoaderDSL.loadPaths ) ){
-			javaLoaderDSL.loadPaths = [ javaLoaderDSL.loadPaths ];
-		} 
-
-		// If simple value and no length
-		if( isSimpleValue( javaLoaderDSL.loadPaths ) and !len( javaLoaderDSL.loadPaths ) ){
-			javaLoaderDSL.loadPaths = [];
-		} 
-
-		// Now that we have figured out the user's settings, let's incorporate ours
-
-		// Dynamic Proxy
-		arrayPrepend(
-			javaLoaderDSL.loadPaths,
-			variables.modulePath & "/models/javaloader/support/cfcdynamicproxy/lib/cfcdynamicproxy.jar"
-		);
-
-		// incorporate settings		
-		structAppend( configStruct.modules.cbjavaloader.settings, javaLoaderDSL, true );
-	}
-
 }

modules/cbjavaloader/models/Loader.cfc

@@ -5,12 +5,8 @@
 * Loads External Java Classes, while providing access to ColdFusion classes by interfacing with JavaLoader
 * it Stores a reference in server scope to avoid leakage.
 */
-component accessors="true" singleton{
-
-	/**
-	* Module Settings
-	*/
-	property name="moduleSettings" inject="coldbox:moduleSettings:cbjavaloader";
+component accessors="true" singleton {
+	property name="wirebox" inject="wirebox";
 
 	/**
 	* ID key saved in server scope to avoid leakage
@@ -19,34 +15,28 @@ component accessors="true" singleton{
 
 	/**
 	* Constructor
-	* @coldbox.inject coldbox
 	*/
-	function init( required coldbox ){
+	function init(){
 		// setup a static ID key according to coldbox app
-		variables.staticIDKey = "cbox-javaloader-#arguments.coldbox.getAppHash()#";
-		// setup wirebox reference
-		variables.wirebox 	  = arguments.coldbox.getWireBox();
+		variables.staticIDKey = "cbox-javaloader-#hash( getCurrentTemplatePath() )#";
 		return this;
 	}
 
 	/**
 	* Setup class loading
-	* @loadPaths.hint An array of directories to classload
-	* @loadColdFusionClassPath.hint Loads the CF library class loader as well
-	* @parentClassLoader.hint The parent java.lang.ClassLoader to attach the network class loader to.
 	*/
-	function setup(){
+	function setup( required struct moduleSettings ){
 		// verify we have it loaded
 		if( not isJavaLoaderInScope() ){
 			lock name="#variables.staticIDKey#" throwontimeout="true" timeout="30" type="exclusive"{
 				if( not isJavaLoaderInScope() ){
-					setJavaLoaderInScope( variables.wirebox.getInstance( "jl@cbjavaloader" ) );
+					setJavaLoaderInScope( variables.wirebox.getInstance( name="jl@cbjavaloader", initArguments=moduleSettings ) );
 				}
 			}
 		} else {
 			// reconfigure it, maybe settings changed
 			lock name="#variables.staticIDKey#" throwontimeout="true" timeout="30" type="exclusive"{
-				getJavaLoaderFromScope().init( argumentCollection=variables.moduleSettings );
+				getJavaLoaderFromScope().init( argumentCollection=moduleSettings );
 			}
 		}
 	}

readme.md

@@ -26,7 +26,7 @@ Just drop into your **modules** folder or use the box-cli to install
 
 `box install cbjavaloader`
 
-The module has a default folder called `lib` where any jars you drop there will be class loaded automatically.  However, we recommed using the `loadpaths` setting for selecting an array of locations to class load, so when the module updates you won't loose those files.
+The module has a default folder called `lib` where any jars you drop there will be class loaded automatically.  However, we recommend using the `loadpaths` setting for selecting an array of locations to class load, so when the module updates you won't lose those files.
 
 ## Models
 The module registers the following mapping in WireBox: `loader@cbjavaloader`. Which is the class you will use to class load, append paths and much more.  Check out the included API Docs for much more information.  The main methods of importance of the java loader are:
@@ -46,24 +46,27 @@ property name="buffer" inject="javaloader:org.class.path.StringBuffer";
 
 ## Settings
 
-Here are the module settings you can place in your `ColdBox.cfc` under an `javaloader` structure:
+Here are the module settings you can place in your `ColdBox.cfc` under an `moduleSettings.cbJavaLoader` structure:
 
 ```js
-// JavaLoader settings
-javaloader = {
-	// A single path, and array of paths or a single Jar
-	loadPaths = [],
-	// Load ColdFusion classes with loader
-	loadColdFusionClassPath = false,
-	// Attach a custom class loader as a parent
-	parentClassLoader = "",
-	// Directories that contain Java source code that are to be dynamically compiled
-	sourceDirectories = [],
-	// the directory to build the .jar file for dynamic compilation in, defaults to ./tmp
-	compileDirectory = getDirectoryFromPath( getCurrentTemplatePath() ) & "model/javaloader/tmp",
-	// Whether or not the source is trusted, i.e. it is going to change? Defaults to false, so changes will be recompiled and loaded
-	trustedSource = false
+
+moduleSettings = {
+	cbJavaLoader = {
+		// A single path, and array of paths or a single Jar
+		loadPaths = [],
+		// Load ColdFusion classes with loader
+		loadColdFusionClassPath = false,
+		// Attach a custom class loader as a parent
+		parentClassLoader = "",
+		// Directories that contain Java source code that are to be dynamically compiled
+		sourceDirectories = [],
+		// the directory to build the .jar file for dynamic compilation in, defaults to ./tmp
+		compileDirectory = "models/javaloader/tmp",
+		// Whether or not the source is trusted, i.e. it is going to change? Defaults to false, so changes will be recompiled and loaded
+		trustedSource = false
+	}
 };
+
 ```
 
 Below is a simple example: