Merge 4e499abe87 into fa907da4a4

This commit improves the `ConvertTo-ExcelXlsx` function by making it more robust. Thanks to Edward Miller for the contribution.

Note: This message follows the established convention of starting with a type (feat for feature) and providing a concise and clear description of the changes made.

.github/workflows/ci.yml

@@ -3,8 +3,11 @@ on:
     branches:
       - master
       - Set-up-GHA-CI/CD
+    paths-ignore:
+      - 'Examples/**'
       
   pull_request:
+  
 
 jobs:
   validate:

Examples/Charts/ChartDataSeparatePage.ps1

@@ -0,0 +1,35 @@
+$data = ConvertFrom-Csv @"
+Region,State,Units,Price
+West,Texas,927,923.71
+North,Tennessee,466,770.67
+East,Florida,520,458.68
+East,Maine,828,661.24
+West,Virginia,465,053.58
+North,Missouri,436,235.67
+South,Kansas,214,992.47
+North,North Dakota,789,640.72
+South,Delaware,712,508.55
+"@
+
+$xlfile = "$PSScriptRoot\spike.xlsx"
+Remove-Item $xlfile -ErrorAction SilentlyContinue
+
+$xlpkg = $data | Export-Excel $xlfile -WorksheetName Data -AutoNameRange -PassThru
+
+$null = Add-Worksheet -ExcelPackage $xlpkg -WorksheetName Summary -Activate
+
+$params = @{
+    Worksheet = $xlpkg.Summary
+    Title     = "Sales by Region"
+    ChartType = 'ColumnClustered'
+    
+    # XRange    = "Data!A2:A10"
+    # YRange    = "Data!C2:C10"
+
+    XRange    = 'Data!Region'
+    YRange    = 'Data!Units'
+}
+
+Add-ExcelChart  @params
+
+Close-ExcelPackage $xlpkg -Show

ImportExcel.psd1

@@ -6,7 +6,7 @@
     RootModule         = 'ImportExcel.psm1'
 
     # Version number of this module.
-    ModuleVersion      = '7.8.5'
+    ModuleVersion      = '7.8.9'
 
     # ID used to uniquely identify this module
     GUID               = '60dd4136-feff-401a-ba27-a84458c57ede'

Private/ArgumentCompletion.ps1

@@ -67,9 +67,8 @@ function WorksheetArgumentCompleter {
     param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
     $xlPath = $fakeBoundParameter['Path']
     if (Test-Path -Path $xlPath) {
-        $xlpkg = Open-ExcelPackage -ReadOnly -Path $xlPath
-        $WorksheetNames = $xlPkg.Workbook.Worksheets.Name
-        Close-ExcelPackage -nosave -ExcelPackage $xlpkg
+        $xlSheet = Get-ExcelSheetInfo -Path $xlPath
+        $WorksheetNames = $xlSheet.Name
         $WorksheetNames.where( { $_ -like "*$wordToComplete*" }) | foreach-object {
             New-Object -TypeName System.Management.Automation.CompletionResult -ArgumentList "'$_'",
             $_ , ([System.Management.Automation.CompletionResultType]::ParameterValue) , $_

Public/ConvertFrom-ExcelData.ps1

@@ -8,7 +8,8 @@ function ConvertFrom-ExcelData {
         [ScriptBlock]$ScriptBlock,
         [Alias("Sheet")]
         $WorksheetName = 1,
-        [int]$HeaderRow = 1,
+		[Alias('HeaderRow', 'TopRow')]
+        [int]$StartRow = 1,
         [string[]]$Header,
         [switch]$NoHeader,
         [switch]$DataOnly

Public/ConvertTo-ExcelXlsx.ps1

@@ -3,53 +3,121 @@ function ConvertTo-ExcelXlsx {
     param
     (
         [parameter(Mandatory = $true, ValueFromPipeline)]
-        [string]$Path,
+        [string[]]$Path,
         [parameter(Mandatory = $false)]
-        [switch]$Force
+        [switch]$Force,
+        [parameter(Mandatory = $false)]
+        [switch]$CacheToTemp,
+        [parameter(Mandatory = $false)]
+        [string]$CacheToDirectory
     )
     process {
-        if (-Not ($Path | Test-Path) ) {
-            throw "File not found"
-        }
-        if (-Not ($Path | Test-Path -PathType Leaf) ) {
-            throw "Folder paths are not allowed"
-        }
+        try {
 
-        $xlFixedFormat = 51 #Constant for XLSX Workbook
-        $xlsFile = Get-Item -Path $Path
-        $xlsxPath = "{0}x" -f $xlsFile.FullName
+            if ($CacheToTemp -and $CacheToDirectory) {
+                throw "Cannot specify both -CacheToTemp and -CacheToDirectory. Please choose one or the other."
+            }
 
-        if ($xlsFile.Extension -ne ".xls") {
-            throw "Expected .xls extension"
-        }
+            if ($CacheToTemp) {
+                $CacheToDirectory = [System.IO.Path]::GetTempPath()
+            }
 
-        if (Test-Path -Path $xlsxPath) {
-            if ($Force) {
-                try {
-                    Remove-Item $xlsxPath -Force
+            if ($CacheToDirectory) {
+                if (-not (Test-Path -Path $CacheToDirectory -PathType Container)) {
+                    throw "CacheToDirectory path does not exist or is not writeable"
+                }
+            }
+
+            foreach ($singlePath in $Path) {
+                if (-Not ($singlePath | Test-Path) ) {
+                    throw "File not found"
+                }
+                if (-Not ($singlePath | Test-Path -PathType Leaf) ) {
+                    throw "Folder paths are not allowed"
+                }
+
+                $xlFixedFormat = 51 #Constant for XLSX Workbook
+                $xlsFile = Get-Item -Path $singlePath
+                $destinationXlsxPath = [System.IO.Path]::ChangeExtension($xlsFile.FullName, ".xlsx")
+
+                if ($xlsFile.Extension -ne ".xls") {
+                    throw "Expected .xls extension"
+                }
+
+                if (Test-Path -Path $destinationXlsxPath) {
+                    if ($Force) {
+                        try {
+                            Remove-Item $destinationXlsxPath -Force
+                        }
+                        catch {
+                            throw "{0} already exists and cannot be removed. The file may be locked by another application." -f $destinationXlsxPath
+                        }
+                        Write-Verbose $("Removed {0}" -f $destinationXlsxPath)
+                    }
+                    else {
+                        throw "{0} already exists!" -f $destinationXlsxPath
+                    }
+                }
+
+                if ($null -eq $Excel)
+                {
+                    try {
+                        $Excel = New-Object -ComObject "Excel.Application"
+                    }
+                    catch {
+                        throw "Could not create Excel.Application ComObject. Please verify that Excel is installed."
+                    }
+                }
+
+                if ($CacheToDirectory) {
+                    $tempPath = [System.IO.Path]::Combine($CacheToDirectory, [System.IO.Path]::GetFileName($xlsFile.FullName))
+                    Write-Host ("Using Temp path: {0}" -f $tempPath)
+                    Copy-Item -Path $xlsFile.FullName -Destination $tempPath -Force
+                    $fileToProcess = $tempPath
+                }
+                else {
+                    $fileToProcess = $xlsFile.FullName
+                }
+
+                $xlsxPath = [System.IO.Path]::ChangeExtension($fileToProcess, ".xlsx")
+
+                try {  
+                    $Excel.Visible = $false
+                    $workbook = $Excel.Workbooks.Open($fileToProcess, $null, $true)
+                    if ($null -eq $workbook) {
+                        Write-Host "Failed to open workbook"
+                    } else {
+                        $workbook.SaveAs($xlsxPath, $xlFixedFormat)
+                        
+                        if ($CacheToDirectory) {
+                            Copy-Item -Path $xlsxPath -Destination $destinationXlsxPath -Force
+                        }
+                    }
                 }
                 catch {
-                    throw "{0} already exists and cannot be removed. The file may be locked by another application." -f $xlsxPath
+                    Write-Error ("Failed to convert {0} to XLSX. To avoid network issues or locking issues, you could try the -CacheToTemp or -CacheToDirectory parameter." -f $xlsFile.FullName)
+                    throw
+                }
+                finally {
+                    if ($null -ne $workbook) {
+                        $workbook.Close()
+                        [System.Runtime.InteropServices.Marshal]::ReleaseComObject($workbook) | Out-Null
+                        $workbook = $null
+                    }
+
+                    if ($CacheToDirectory) {
+                        Remove-Item -Path $tempPath -Force
+                        Remove-Item -Path $xlsxPath -Force
+                    }
                 }
-                Write-Verbose $("Removed {0}" -f $xlsxPath)
-            }
-            else {
-                throw "{0} already exists!" -f $xlsxPath
             }
         }
-
-        try {
-            $Excel = New-Object -ComObject "Excel.Application"
+        finally {
+            if ($null -ne $Excel) {
+                $Excel.Quit()
+                [System.Runtime.InteropServices.Marshal]::ReleaseComObject($Excel) | Out-Null
+                $Excel = $null
+            }
         }
-        catch {
-            throw "Could not create Excel.Application ComObject. Please verify that Excel is installed."
-        }
-
-        $Excel.Visible = $false
-        $null = $Excel.Workbooks.Open($xlsFile.FullName)
-        $Excel.ActiveWorkbook.SaveAs($xlsxPath, $xlFixedFormat)
-        $Excel.ActiveWorkbook.Close()
-        $Excel.Quit()
     }
 }
-

README.md

@@ -19,10 +19,13 @@ Consider donating. Thank you!
 <br>
 <br>
 
-[![Build Status](https://dougfinke.visualstudio.com/ImportExcel/_apis/build/status/dfinke.ImportExcel?branchName=master)](https://dougfinke.visualstudio.com/ImportExcel/_build)
+[![Follow on Twitter](https://img.shields.io/twitter/follow/dfinke.svg?style=social&label=Follow%20%40dfinke)](https://twitter.com/dfinke)
+[![Subscribe on YouTube](https://img.shields.io/youtube/channel/subscribers/UCP47ZkO5EDkoI2sr-3P4ShQ
+)](https://youtube.com/@dougfinke/)
+<br/>
+<br/>
 [![](https://img.shields.io/powershellgallery/v/ImportExcel.svg)](https://www.powershellgallery.com/packages/ImportExcel)
 [![](https://img.shields.io/powershellgallery/dt/ImportExcel.svg)](https://www.powershellgallery.com/packages/ImportExcel)
-[![](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/dfinke/ImportExcel/tree/70ab9e46c776e96fb287682d5b9b4b51a0ec3bac/LICENSE.txt)
 <a href="https://www.paypal.com/paypalme/DougCharlesFinke"><img src="https://img.shields.io/badge/Donate-PayPal-green.svg" alt="Donate"></a>
 
 # Overview

changelog.md

@@ -1,3 +1,29 @@
+# 7.8.9
+
+- Thanks to (Edward Miller)[https://github.com/edwardmiller-mesirow] for improving `ConvertTo-ExcelXlsx`and making it more robust
+
+# 7.8.8
+
+- Fix the release
+
+# 7.8.7
+
+- Thanks to [Phil Bossman](https://github.com/pbossman) for the PR and fixing this.
+    
+    Now, back again, you can type `Import-Excel .\yearlySales.xlsx`, press <ctrl+space> and get a list of the worksheets in the Excel file
+
+    ![alt text](images/AutoCompleteSheetNames.png)    
+
+# Infrastructure change
+
+- Thank you to [RipFence](https://github.com/RipFence) who asked how to place a chart on a different sheet from the data and then did a PR adding the example.
+- added `ignore` so files checked into examples do not trigger a CI run
+
+# 7.8.6
+
+- Thank you [John Boyne](https://github.com/kyllath)
+    - Add missing parameter aliases to align with caller/callee
+
 # 7.8.5
 
 - Added `Get-ExcelFileSchema` to get the schema of an Excel file.