Simplify return formatter options

Author: elpete

ModuleConfig.cfc

@@ -7,11 +7,10 @@ component {
     this.cfmapping = "qb";
 
     function configure() {
-        settings = {
-            "defaultGrammar": "AutoDiscover@qb",
-            "defaultReturnFormat": "array",
-            "defaultReturnFormatOptions": {},
-            "preventDuplicateJoins": false,
+		settings = {
+			"defaultGrammar": "AutoDiscover@qb",
+			"defaultReturnFormat": "array",
+			"preventDuplicateJoins": false,
             "validateOperatorsAndCombinators": true,
             "validateQueryExecuteReturnType": false,
             "collectQueryLog": true,
@@ -77,11 +76,10 @@ component {
             .initArg( name = "returnFormatterRegistry", ref = "ReturnFormatterRegistry@qb" )
             .initArg( name = "preventDuplicateJoins", value = settings.preventDuplicateJoins )
             .initArg( name = "validateOperatorsAndCombinators", value = settings.validateOperatorsAndCombinators )
-            .initArg( name = "validateQueryExecuteReturnType", value = settings.validateQueryExecuteReturnType )
-            .initArg( name = "collectQueryLog", value = settings.collectQueryLog )
-            .initArg( name = "returnFormat", value = settings.defaultReturnFormat )
-            .initArg( name = "defaultReturnFormatOptions", value = settings.defaultReturnFormatOptions )
-            .initArg( name = "defaultOptions", value = settings.defaultOptions )
+			.initArg( name = "validateQueryExecuteReturnType", value = settings.validateQueryExecuteReturnType )
+			.initArg( name = "collectQueryLog", value = settings.collectQueryLog )
+			.initArg( name = "returnFormat", value = settings.defaultReturnFormat )
+			.initArg( name = "defaultOptions", value = settings.defaultOptions )
             .initArg( name = "sqlCommenter", ref = "ColdBoxSQLCommenter@qb" )
             .initArg( name = "shouldMaxRowsOverrideToAll", value = settings.shouldMaxRowsOverrideToAll );
 

models/Query/Formatters/StructFormatter.cfc

@@ -1,14 +1,31 @@
 component accessors="true" {
 
     property name="utils";
+    property name="options";
 
-    public StructFormatter function init( any utils = new qb.models.Query.QueryUtils() ) {
+    public StructFormatter function init( any utils = new qb.models.Query.QueryUtils(), struct options = {} ) {
         variables.utils = arguments.utils;
+        variables.options = arguments.options;
         return this;
     }
 
     public function toFormatter( struct options = {} ) {
-        return new qb.models.Query.Formatters.StructReturnFormatter( variables.utils, arguments.options );
+        return new qb.models.Query.Formatters.StructFormatter( utils = variables.utils, options = arguments.options );
+    }
+
+    public struct function format( required any q ) {
+        if (
+            !variables.options.keyExists( "columnKey" ) || isNull( variables.options.columnKey ) || !len(
+                variables.options.columnKey
+            )
+        ) {
+            throw(
+                type = "MissingColumnKey",
+                message = "A columnKey option is required for the [struct] return formatter."
+            );
+        }
+
+        return variables.utils.queryToStructOfStructs( arguments.q, variables.options.columnKey );
     }
 
 }

models/Query/Formatters/StructReturnFormatter.cfc

@@ -301,8 +301,6 @@ component displayname="QueryBuilder" accessors="true" {
      *                              Default: qb.models.Query.QueryUtils
      * @returnFormat                The closure (or string format shortcut) that modifies the query
      *                              and is eventually returned to the caller. Default: 'array'
-     * @defaultReturnFormatOptions  Options passed to the default return formatter.
-     *                              Default: {}
      * @returnFormatterRegistry     Registry used to resolve named return formatters.
      * @preventDuplicateJoins       Whether QB should ignore a .join() statement that matches an existing join
      *                              Default: false
@@ -333,7 +331,6 @@ component displayname="QueryBuilder" accessors="true" {
         grammar = new qb.models.Grammars.BaseGrammar(),
         utils = new qb.models.Query.QueryUtils(),
         returnFormat = "array",
-        struct defaultReturnFormatOptions = {},
         returnFormatterRegistry,
         preventDuplicateJoins = false,
         validateOperatorsAndCombinators = true,
@@ -367,7 +364,7 @@ component displayname="QueryBuilder" accessors="true" {
             setParentQuery( arguments.parentQuery );
         }
         param variables.defaultOptions = {};
-        setReturnFormat( arguments.returnFormat, arguments.defaultReturnFormatOptions );
+        setReturnFormat( arguments.returnFormat );
         mergeDefaultOptions( arguments.defaultOptions );
         setSqlCommenter( arguments.sqlCommenter );
         setCollectQueryLog( arguments.collectQueryLog );