finalized for 1.0.0 release

Author: lmajano

apidocs/Application.cfc

@@ -9,7 +9,7 @@ component{
 
 	rootPath = REReplaceNoCase( this.mappings[ "/colddoc" ], "apidocs(\\|\/)$", "" );
 	this.mappings[ "/root" ] = rootPath;
-	this.mappings[ "/javaloader" ] = rootPath & "modules/javaloader/models";
+	this.mappings[ "/cbjavaloader" ] = rootPath & "modules/cbjavaloader/models";
 
 	// request start
 	public boolean function onRequestStart(String targetPage){

apidocs/index.cfm

@@ -1,14 +1,14 @@
 <cfparam name="url.version" default="0">
-<cfparam name="url.path" 	default="#expandPath( "./JavaLoader-APIDocs" )#">
+<cfparam name="url.path" 	default="#expandPath( "./CBJavaLoader-APIDocs" )#">
 <cfscript>
-	docName = "JavaLoader-APIDocs";
-	base = expandPath( "/javaloader" );
+	docName = "CBJavaLoader-APIDocs";
+	base = expandPath( "/cbjavaloader" );
 
 	colddoc 	= new ColdDoc();
-	strategy 	= new colddoc.strategy.api.HTMLAPIStrategy( url.path, "JavaLoader v#url.version#" );
+	strategy 	= new colddoc.strategy.api.HTMLAPIStrategy( url.path, "CBJavaLoader v#url.version#" );
 	colddoc.setStrategy( strategy );
 
-	colddoc.generate( inputSource=base, outputDir=url.path, inputMapping="javaloader" );
+	colddoc.generate( inputSource=base, outputDir=url.path, inputMapping="cbjavaloader" );
 </cfscript>
 
 <!---

handlers/Main.cfc

@@ -3,7 +3,7 @@
 */
 component{
 
-	property name="javaloader" inject="loader@javaloader";
+	property name="javaloader" inject="loader@cbjavaloader";
 
 	// Index
 	any function index( event,rc, prc ){

modules/javaloader/ModuleConfig.cfc renamed to modules/cbjavaloader/ModuleConfig.cfc

@@ -11,65 +11,39 @@ component {
 	this.author 			= "Ortus Solutions";
 	this.webURL 			= "http://www.ortussolutions.com";
 	this.description 		= "A JavaLoader Module for ColdBox";
-	this.version			= "1.0.0.@build.version@";
+	this.version			= "1.0.0+@build.version@";
 	// 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;
 	// Module Entry Point
-	this.entryPoint			= "javaloader";
-
+	this.entryPoint			= "cbjavaloader";
+	// CF Mapping
+	this.cfmapping			= "cbjavaloader";
+	
 	function configure(){
-
-		// Java Loader Settings
-		settings = {
-			// The array paths to load
-			loadPaths = getJars( getDirectoryFromPath( getCurrentTemplatePath() ) & "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 = 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
-		};
-
-		// Custom Declared Points
-		interceptorSettings = {
-			customInterceptionPoints = ""
-		};
-
-		// Custom Declared Interceptors
-		interceptors = [
-		];
-
 		// Register Custom DSL, don't map it because it is too late, mapping DSLs are only good by the parent app
 		controller.getWireBox().registerDSL( namespace="javaloader", path="#moduleMapping#.models.JavaLoaderDSL" );
-
-		// Bind Loader Proxy Class
-		binder.map( "loader@javaloader" )
-			.to( "#moduleMapping#.models.Loader" );
-
-		// Bind Core JavaLoader
-		binder.map( "jl@javaloader" )
-			.to( "#moduleMapping#.models.javaloader.JavaLoader" )
-			.initArg( name="loadPaths", 				value=settings.loadPaths )
-			.initArg( name="loadColdFusionClassPath", 	value=settings.loadColdFusionClassPath )
-			.initArg( name="parentClassLoader", 		value=settings.parentClassLoader )
-			.initArg( name="sourceDirectories", 		value=settings.sourceDirectories )
-			.initArg( name="compileDirectory", 			value=settings.compileDirectory )
-			.initArg( name="trustedSource", 			value=settings.trustedSource );
 	}
 
 	/**
 	* 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.javaloader.loadPaths )
+			.initArg( name="loadColdFusionClassPath", 	value=settings.javaloader.loadColdFusionClassPath )
+			.initArg( name="parentClassLoader", 		value=settings.javaloader.parentClassLoader )
+			.initArg( name="sourceDirectories", 		value=settings.javaloader.sourceDirectories )
+			.initArg( name="compileDirectory", 			value=settings.javaloader.compileDirectory )
+			.initArg( name="trustedSource", 			value=settings.javaloader.trustedSource );
 		// Load JavaLoader and class loading
-		wirebox.getInstance( "loader@javaloader" ).setup();
+		wirebox.getInstance( "loader@cbjavaloader" ).setup();
 	}
 
 	/**
@@ -90,4 +64,32 @@ component {
 		return directoryList( arguments.dirPath, true, "array", arguments.filter, "name desc" );
 	}
 
+	/**
+	* parse parent settings
+	*/
+	private function parseParentSettings(){
+		var oConfig 		= controller.getSetting( "ColdBoxConfig" );
+		var configStruct 	= controller.getConfigSettings();
+		var javaLoaderDSL 	= oConfig.getPropertyMixin( "javaloader", "variables", structnew() );
+
+		//defaults
+		configStruct.javaloader = {
+			// The array paths to load
+			loadPaths = getJars( getDirectoryFromPath( getCurrentTemplatePath() ) & "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 = 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
+		};
+
+		// incorporate settings
+		structAppend( configStruct.javaloader, javaLoaderDSL, true );
+	}
+
 }

modules/javaloader/box.json renamed to modules/cbjavaloader/box.json

@@ -2,7 +2,7 @@
 	"name" 		: "JavaLoader",
 	"version"	: "1.0.0",
 	"author" 	: "Luis Majano <[email protected]",
-	"slug"		: "javaloader",
+	"slug"		: "cbjavaloader",
 	"type"		: "modules",
 	"homepage"	: "http://www.coldbox.org",
 	"documentation"		: "http://wiki.coldbox.org",
@@ -16,6 +16,6 @@
 	],
 	"engines"	: [
 		{ "type" : "railo", "version" : ">4.1" },
-		{ "type" : "adobe", "version" : ">9.02" },
+		{ "type" : "adobe", "version" : ">9.02" }
 	]
 }

modules/cbjavaloader/changelog.md

@@ -0,0 +1,5 @@
+CHANGELOG
+=========
+
+##1.0.0
+* Create first module version

modules/cbjavaloader/instructions.md

@@ -0,0 +1,67 @@
+INSTRUCTIONS
+============
+
+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.
+
+## 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.
+
+## WireBox DSL
+The module also registers a new WireBox DSL called `javaloader`.  You can then use this custom DSL for injecting direct java class loaded classes very easily:
+
+```js
+property name="name"  inject="javaloader:{class-path}";
+property name="hello" inject="javaloader:HelloWorld";
+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:
+
+```js
+// JavaLoader settings
+javaloader = {
+	// The array paths to load
+	loadPaths = getJars( getDirectoryFromPath( getCurrentTemplatePath() ) & "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 = 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
+};
+```
+
+
+Below is a simple example:
+
+```js
+/**
+* My Event Handler Hint
+*/
+component{
+	// Inject JavaLoader
+	property name="javaloader" inject="loader@cbjavaloader";
+
+	// Index
+	any function index( event,rc, prc ){
+		// creat a java class
+		prc.hello = javaloader.create( "HelloWorld" ).init().hello();
+	}
+
+	// Run on first init
+	any function onAppInit( event, rc, prc ){
+		// on application start, load up more jars
+		javaloader.appendPaths( getSetting( "ApplicationPath" ) & "jars" );
+	}
+
+}
+```

modules/javaloader/lib/drop_jars_here.txt renamed to modules/cbjavaloader/lib/drop_jars_here.txt

@@ -37,7 +37,7 @@ component implements="coldbox.system.ioc.dsl.IDSLBuilder" accessors="true"{
 		var className = listLast( arguments.definition.dsl, ":" );
 
 		// Get Dependency, if not found, exception is thrown
-		return variables.injector.getInstance( "loader@javaloader" ).create( className );
+		return variables.injector.getInstance( "loader@cbjavaloader" ).create( className );
 	}
 
 }