Merge branch 'develop'

CHANGELOG.md

@@ -1,3 +1,15 @@
+## 3.12.0 - 27 November 2023
+
+- Enhancements
+	-\#346 Add writeCsv()
+
+- Fixes
+	-\#347/\#348 Avoid Perl/Java regex engine incompatibilities
+
+- Maintenance
+	-\#349 Upgrade POI to 5.2.5
+	-\#350 Upgrade excel-streaming-reader to 4.2.1
+
 ## 3.11.1 - 15 November 2023
 
 - \#345 readCsv(): Commons CSV boolean options should default to true 
@@ -13,7 +25,7 @@
   - \#339 csvToQuery() ignores trim setting when reading from file
 
 - Maintenance
-  - \#334 Upgrade excel-streaming-reader to 4.2.0
+  - \#344 Upgrade excel-streaming-reader to 4.2.0
 
 ## 3.10.0 - 29 September 2023
 

ModuleConfig.cfc

@@ -4,7 +4,7 @@ component{
     this.author = "Julian Halliwell";
     this.webURL = "https://github.com/cfsimplicity/spreadsheet-cfml";
     this.description = "CFML Spreadsheet Library";
-    this.version = "3.11.1";
+    this.version = "3.12.0";
     this.autoMapModels = false;
 
     function configure(){

README.md

@@ -180,6 +180,7 @@ You may wish to place the spreadsheet library files in a central location with a
 * [workbookFromCsv](https://github.com/cfsimplicity/spreadsheet-cfml/wiki/workbookFromCsv)
 * [workbookFromQuery](https://github.com/cfsimplicity/spreadsheet-cfml/wiki/workbookFromQuery)
 * [writeFileFromQuery](https://github.com/cfsimplicity/spreadsheet-cfml/wiki/writeFileFromQuery)
+* [writeCsv](https://github.com/cfsimplicity/spreadsheet-cfml/wiki/writeCsv)
 * [writeToCsv](https://github.com/cfsimplicity/spreadsheet-cfml/wiki/writeToCsv)
 
 ### Enhanced Read() method

Spreadsheet.cfc

@@ -1,8 +1,8 @@
 component accessors="true"{
 
 	//"static"
-	property name="version" default="3.11.1-develop" setter="false";
-	property name="osgiLibBundleVersion" default="5.2.4.1" setter="false"; //first 3 octets = POI version; increment 4th with other jar updates
+	property name="version" default="3.12.0" setter="false";
+	property name="osgiLibBundleVersion" default="5.2.5.1" setter="false"; //first 3 octets = POI version; increment 4th with other jar updates
 	property name="osgiLibBundleSymbolicName" default="spreadsheet-cfml" setter="false";
 	property name="exceptionType" default="cfsimplicity.spreadsheet" setter="false";
 	//configurable
@@ -1097,14 +1097,13 @@ component accessors="true"{
 	}
 
 	/* row order is not guaranteed if using more than one thread */
-	public string function queryToCsv( required query query, boolean includeHeaderRow=false, string delimiter=",", numeric threads=1 ){
-		var data = getCsvHelper().queryToArrayForCsv( arguments.query, arguments.includeHeaderRow, arguments.threads );
-		var builder = getStringHelper().newJavaStringBuilder();
-		var csvFormat = getCsvHelper().getFormatForPrinting( arguments.delimiter );
-		createJavaObject( "org.apache.commons.csv.CSVPrinter" )
-			.init( builder, csvFormat )
-			.printRecords( data );
-		return builder.toString().Trim();
+	public string function queryToCsv( required query query, boolean includeHeaderRow=false, string delimiter=",", numeric threads=0 ){
+		return writeCsv()
+			.fromData( arguments.query )
+			.withQueryColumnsAsHeader( arguments.includeHeaderRow )
+			.withDelimiter( arguments.delimiter )
+			.withParallelThreads( arguments.threads )
+			.execute();
 	}
 
 	public any function read(
@@ -1170,17 +1169,15 @@ component accessors="true"{
 		var generatedQuery = getSheetHelper().sheetToQuery( argumentCollection=args );
 		if( arguments.format == "query" )
 			return generatedQuery;
-		args = { query: generatedQuery };
-		if( arguments.KeyExists( "headerRow" ) ){
-			args.headerRow = arguments.headerRow;
-			args.includeHeaderRow = arguments.includeHeaderRow;
-		}
 		if( arguments.format == "csv" ){
-			args.delimiter = arguments.csvDelimiter;
-			return queryToCsv( argumentCollection=args );
+			return writeCsv()
+				.fromData( generatedQuery )
+				.withQueryColumnsAsHeader( arguments.includeHeaderRow )
+				.withDelimiter( arguments.csvDelimiter )
+				.execute();
 		}
 		// format = html
-		return getQueryHelper().queryToHtml( argumentCollection=args );
+		return getQueryHelper().queryToHtml( generatedQuery, arguments.includeHeaderRow );
 	}
 
 	public binary function readBinary( required workbook ){
@@ -1245,17 +1242,15 @@ component accessors="true"{
 		var generatedQuery = getStreamingReaderHelper().readFileIntoQuery( arguments.src, builderOptions, sheetToQueryArgs );
 		if( arguments.format == "query" )
 			return generatedQuery;
-		var exportArgs = { query: generatedQuery };
-		if( arguments.KeyExists( "headerRow" ) ){
-			exportArgs.headerRow = arguments.headerRow;
-			exportArgs.includeHeaderRow = arguments.includeHeaderRow;
-		}
 		if( arguments.format == "csv" ){
-			exportArgs.delimiter = arguments.csvDelimiter;
-			return queryToCsv( argumentCollection=exportArgs );
+			return writeCsv()
+				.fromData( generatedQuery )
+				.withQueryColumnsAsHeader( arguments.includeHeaderRow )
+				.withDelimiter( arguments.csvDelimiter )
+				.execute();
 		}
 		// format = html
-		return getQueryHelper().queryToHtml( argumentCollection=exportArgs );
+		return getQueryHelper().queryToHtml( generatedQuery, arguments.includeHeaderRow );
 	}
 
 	public Spreadsheet function removePrintGridlines( required workbook ){
@@ -1769,8 +1764,11 @@ component accessors="true"{
 			,includeHeaderRow=arguments.includeHeaderRow
 			,makeColumnNamesSafe=true //doesn't affect the output: avoids ACF clunky workaround in _QueryNew()
 		);
-		var csv = queryToCsv( query=data, delimiter=arguments.delimiter );
-		FileWrite( arguments.filepath, csv );
+		writeCsv()
+			.fromData( data )
+			.toFile( arguments.filepath )
+			.withDelimiter( arguments.delimiter )
+			.execute();
 		return this;
 	}
 

box.json

@@ -1,7 +1,7 @@
 {
     "name" : "Spreadsheet CFML",
     "slug" : "spreadsheet-cfml",
-    "version" : "3.11.1",
+    "version" : "3.12.0",
     "shortDescription" : "CFML spreadsheet library",
     "author" : "Julian Halliwell",
     "location" : "forgeboxStorage",

build/README.md

@@ -24,23 +24,37 @@ https://mvnrepository.com
 Here is the current list of required jars:
 
 * commons-codec
+	https://mvnrepository.com/artifact/commons-codec/commons-codec
 * commons-collections4
+	https://mvnrepository.com/artifact/org.apache.commons/commons-collections4
 * commons-compress
+	https://mvnrepository.com/artifact/org.apache.commons/commons-compress
 * commons-io
+	https://mvnrepository.com/artifact/commons-io/commons-io
 * commons-math3
+	https://mvnrepository.com/artifact/org.apache.commons/commons-math3
 * log4j-api
+	https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-api
 * poi
+	https://repo1.maven.org/maven2/org/apache/poi/poi/
 * poi-ooxml
+	https://repo1.maven.org/maven2/org/apache/poi/poi-ooxml/
 * poi-ooxml-full
+	https://repo1.maven.org/maven2/org/apache/poi/poi-ooxml-full
 * SparseBitSet
+	https://mvnrepository.com/artifact/com.zaxxer/SparseBitSet
 * xmlbeans
+	https://mvnrepository.com/artifact/org.apache.xmlbeans/xmlbeans
 
 ## Other dependency binaries
 
 The following jars are not POI dependencies but are required by the Spreadsheet Library:
 
 * commons-csv
+	https://mvnrepository.com/artifact/org.apache.commons/commons-csv
 * excel-streaming-reader
+	https://mvnrepository.com/artifact/com.github.pjfanning/excel-streaming-reader
 * slf4j-api
+	https://mvnrepository.com/artifact/org.slf4j/slf4j-api
 
 All available from https://mvnrepository.com

build/lib-osgi.mf

@@ -2,19 +2,19 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: Spreadsheet CFML
 Bundle-SymbolicName: spreadsheet-cfml
-Bundle-Version: 5.2.4.1
+Bundle-Version: 5.2.5.1
 Bundle-ClassPath: commons-codec-1.16.0.jar,
  commons-collections4-4.4.jar,
- commons-compress-1.24.0.jar,
+ commons-compress-1.25.0.jar,
  commons-csv-1.10.0.jar,
- commons-io-2.13.0.jar,
+ commons-io-2.15.0.jar,
  commons-math3-3.6.1.jar,
- excel-streaming-reader-4.2.0.jar,
- log4j-api-2.20.0.jar,
- poi-5.2.4.jar,
- poi-ooxml-5.2.4.jar,
- poi-ooxml-full-5.2.4.jar,
- slf4j-api-1.7.36.jar,
+ excel-streaming-reader-4.2.1.jar,
+ log4j-api-2.22.0.jar,
+ poi-5.2.5.jar,
+ poi-ooxml-5.2.5.jar,
+ poi-ooxml-full-5.2.5.jar,
+ slf4j-api-2.0.9.jar,
  SparseBitSet-1.3.jar,
  spreadsheet-cfml.jar,
- xmlbeans-5.1.1.jar
+ xmlbeans-5.2.0.jar

build/task.cfc

@@ -5,11 +5,11 @@ component{
 	property name="classpathDirectories";
 	property name="libPath";
 	property name="minimumSupportedJvmVersion" default="8";//update this as necessary
-	property name="ooxmlVersion" default="5.2.4";
+	property name="ooxmlVersion" default="5.2.5";
 	property name="rootPath";
 	property name="srcPath";
 	property name="tempDirectoryPath";
-	property name="xmlBeansVersion" default="5.1.1";
+	property name="xmlBeansVersion" default="5.2.0";
 
 	void function run(){
 		variables.tempDirectoryPath = getCWD() & "temp/";

helpers/csv.cfc

@@ -17,13 +17,6 @@ component extends="base"{
 				.build();
 	}
 
-	any function getFormatForPrinting( required string delimiter ){
-		if( delimiterIsTab( arguments.delimiter ) )
-			return getFormatObject( "TDF" );
-		var format = getFormatObject( "EXCEL" );
-		return format.builder().setDelimiter( arguments.delimiter ).build();
-	}
-
 	array function getColumnNames( required boolean firstRowIsHeader, required array data, required numeric maxColumnCount ){
 		var result = [];
 		if( arguments.firstRowIsHeader )
@@ -38,30 +31,6 @@ component extends="base"{
 		return result;
 	}
 
-	/* row order is not guaranteed if using more than one thread */
-	array function queryToArrayForCsv( required query query, required boolean includeHeaderRow, numeric threads=1 ){
-		var result = [];
-		var columns = getQueryHelper()._QueryColumnArray( arguments.query );
-		if( arguments.includeHeaderRow )
-			result.Append( columns );
-		if( ( arguments.threads > 1 ) && !library().engineSupportsParallelLoopProcessing() )
-			getExceptionHelper().throwParallelOptionNotSupportedException();
-		if( arguments.threads > 1 ){
-			arguments.query.Each(
-				function( row ){
-					result.Append( getQueryRowValues( row, columns ) );
-				}
-				,true
-				,arguments.threads
-			);
-			return result;			
-		}
-		for( var row IN arguments.query ){
-			result.Append( getQueryRowValues( row, columns ) );
-		}
-		return result;
-	}
-
 	struct function parseFromString( required string csvString, required boolean trim, required any format ){
 		if( arguments.trim )
 			arguments.csvString = arguments.csvString.Trim();
@@ -108,17 +77,4 @@ component extends="base"{
 		return result;
 	}
 
-	private array function getQueryRowValues( required row, required array columns ){
-		var rowValues = [];
-		for( var column IN arguments.columns ){
-			var cellValue = arguments.row[ column ];
-			if( getDateHelper().isDateObject( cellValue ) )
-				cellValue = DateTimeFormat( cellValue, library().getDateFormats().DATETIME );
-			if( IsValid( "integer", cellValue ) )
-				cellValue = JavaCast( "string", cellValue );// prevent CSV writer converting 1 to 1.0
-			rowValues.Append( cellValue );
-		};
-		return rowValues;
-	}
-
 }

helpers/headerImage.cfc

@@ -75,7 +75,7 @@ component extends="base"{
 			getFileHelper().closeLocalFileOrStream( local, "imageInputStream" );
 		}
 		var newShapeElement = createNewHeaderImageVMLShape( pictureRelationID, vmlPosition, imageDimension );
-		headerImageXML = headerImageXML.ReReplaceNoCase( "(<\/[\w:]*xml>)", newShapeElement & "\1" );
+		headerImageXML = headerImageXML.ReplaceAll( "(?i)(<\/[\w:]*xml>)", newShapeElement & "$1" );//Use java regex for group reference consistency
 		headerImageVml.setXml( headerImageXML );
 	  //create the sheet/vml relation
 	  var xssfVmlRelation = library().createJavaObject( "org.apache.poi.xssf.usermodel.XSSFRelation" ).VML_DRAWINGS;

helpers/query.cfc

@@ -107,11 +107,10 @@ component extends="base"{
 		return arguments.queryColumnTypes;
 	}
 
-	string function queryToHtml( required query query, numeric headerRow, boolean includeHeaderRow=false ){
+	string function queryToHtml( required query query, boolean includeHeaderRow=false ){
 		var result = getStringHelper().newJavaStringBuilder();
 		var columns = _QueryColumnArray( arguments.query );
-		var generateHeaderRow = ( arguments.includeHeaderRow && arguments.KeyExists( "headerRow" ) && Val( arguments.headerRow ) );
-		if( generateHeaderRow ){
+		if( arguments.includeHeaderRow ){
 			result.Append( "<thead>" );
 			result.Append( generateHtmlRow( columns, true ) );
 			result.Append( "</thead>" );

helpers/range.cfc

@@ -53,7 +53,7 @@ component extends="base"{
 	}
 
 	string function convertRangeReferenceToAbsoluteAddress( required string rangeReference ){
-		return arguments.rangeReference.REReplace( "([A-Za-z]+|\d+)", "$\1", "ALL" ).UCase();
+		return arguments.rangeReference.ReplaceAll( "([A-Za-z]+|\d+)", "\$$1" ).UCase(); //Use java regex for group reference consistency
 	}
 
 	/* Private */

objects/WriteCsv.cfc

@@ -1,7 +1,7 @@
 component extends="BaseCsv" accessors="true"{
 
 	property name="data" setter="false";
-	property name="parallelThreadsToUse" type="numeric" default=1 setter="false";
+	property name="parallelThreadsToUse" type="numeric" default=0 setter="false";
 	property name="useQueryColumnsAsHeader" type="boolean" default="false" setter="false";
 	property name="useStructKeysAsHeader" type="boolean" default="false" setter="false";
 
@@ -25,7 +25,11 @@ component extends="BaseCsv" accessors="true"{
 	}
 
 	public WriteCsv function withParallelThreads( numeric numberOfThreads=2 ){
-		/* WARNING: can have unexpected results */
+		/* WARNING: can have unexpected results such as rows out of order or system crashes. USE WITH CARE. */
+		if( arguments.numberOfThreads < 2 ){
+			variables.parallelThreadsToUse = 0;
+			return this;
+		}
 		if( !variables.library.engineSupportsParallelLoopProcessing() )
 			variables.library.getExceptionHelper().throwParallelOptionNotSupportedException();
 		variables.parallelThreadsToUse = Int( arguments.numberOfThreads );
@@ -178,7 +182,7 @@ component extends="BaseCsv" accessors="true"{
 	}
 
 	private boolean function useParallelThreads(){
-		return variables.library.engineSupportsParallelLoopProcessing() && ( variables.parallelThreadsToUse > 1 );
+		return ( variables.library.engineSupportsParallelLoopProcessing() && ( variables.parallelThreadsToUse > 1 ) );
 	}
 
 	private array function _StructValueArray( required struct data ){

test/specs/dateFormats.cfm

@@ -90,7 +90,7 @@ describe( "dateFormats customisability",function(){
 		var actual = s.read( src=path, format="html" );
 		var expected = "<tbody><tr><td>a</td><td>b</td></tr><tr><td>1</td><td>04/01/2015 12:0:0</td></tr><tr><td>04/01/2015 1:1:1</td><td>2</td></tr></tbody>";
 		expect( actual ).toBe( expected );
-		expected = 'a,b#newline#1,04/01/2015 12:0:0#newline#04/01/2015 1:1:1,2';
+		expected = 'a,b#newline#1,04/01/2015 12:0:0#newline#04/01/2015 1:1:1,2#newline#';
 		actual = s.read( src=path, format="csv" );
 		expect( actual ).toBe( expected );
 	});