doneeeee

Author: santisq

CHANGELOG.md

@@ -2,21 +2,35 @@
 
 ## 12/13/2025
 
-- Zip entries are now created directly from `ICSharpCode.SharpZipLib.Zip.ZipEntry`.  
-  This adds the following new properties to `ZipEntryBase`:
-  - `IsEncrypted` (`bool`)
-  - `AESKeySize` (`int`)
-  - `CompressionMethod` (`ICSharpCode.SharpZipLib.Zip.CompressionMethod`)
-  - `Comment` (`string`)
+- **Native Zip Entry Objects**
 
-- `Get-ZipEntryContent` and `Expand-ZipEntry` now support reading and extracting encrypted entries.  
-  A new parameter has been added to both cmdlets:
+  Zip entries returned by `Get-ZipEntry` (and created by `New-ZipEntry`) are now backed directly by `ICSharpCode.SharpZipLib.Zip.ZipEntry`.  
+  This exposes additional useful properties on `ZipEntryBase` derived objects:
+  - `IsEncrypted` (`bool`) – Indicates whether the entry is encrypted.
+  - `AESKeySize` (`int`) – AES key size (0, 128, 192, or 256) if AES encryption is used.
+  - `CompressionMethod` (`ICSharpCode.SharpZipLib.Zip.CompressionMethod`) – The actual compression method used.
+  - `Comment` (`string`) – The entry comment.
+  - `Crc` (`long`) – Cyclic redundancy check.
+
+- **Support for Encrypted Zip Entries**  
+
+  `Get-ZipEntryContent` and `Expand-ZipEntry` now fully support reading and extracting password-protected entries.  
+  A new common parameter has been added to both cmdlets:
 
   ```powershell
   -Password <SecureString>
   ```
 
-  If an entry is encrypted and no password is provided, the cmdlets will securely prompt for one.
+  - If an entry is encrypted and no password is provided, the cmdlets will securely prompt for one.
+  - Examples and detailed guidance for handling encrypted entries have been added to the help documentation.
+  
+- **Documentation Improvements**
+
+  All cmdlet help files have been reviewed and updated for consistency and clarity.
+  Significant enhancements to `Get-ZipEntryContent` and `Expand-ZipEntry` help:
+    - Added dedicated examples demonstrating password-protected entry handling.
+    - Updated parameter descriptions and notes for the new `-Password` parameter.
+    - Improved phrasing, removed outdated example output, and ensured uniform formatting across the module.
 
 ## 07/02/2025
 

module/PSCompression.psd1

@@ -11,7 +11,7 @@
     RootModule         = 'PSCompression.psm1'
 
     # Version number of this module.
-    ModuleVersion      = '3.0.1'
+    ModuleVersion      = '3.1.0'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()

src/PSCompression/Abstractions/TarEntryBase.cs

@@ -36,7 +36,7 @@ internal FileSystemInfo ExtractTo(
         }
 
         FileInfo file = new(destination);
-        file.Directory?.Create();
+        file.Directory!.Create();
 
         using FileStream destStream = file.Open(
             overwrite ? FileMode.Create : FileMode.CreateNew,

src/PSCompression/Abstractions/ZipEntryBase.SharpZipLib.Zip.cs

@@ -28,6 +28,8 @@ public abstract partial class ZipEntryBase(ZipEntry entry, string source)
 
     public string Comment { get; } = entry.Comment ?? string.Empty;
 
+    public long Crc { get; } = entry.Crc;
+
     protected ZipEntryBase(ZipEntry entry, Stream? stream)
         : this(entry, $"InputStream.{Guid.NewGuid()}")
     {

src/PSCompression/AlgorithmMappings.cs

@@ -31,6 +31,5 @@ internal static class AlgorithmMappings
     };
 
     internal static Algorithm Parse(string path) =>
-        _mappings.TryGetValue(Path.GetExtension(path), out Algorithm value)
-            ? value : Algorithm.none;
+        _mappings.TryGetValue(Path.GetExtension(path), out Algorithm value) ? value : Algorithm.none;
 }

tests/ArchiveEntryManagementCommands.tests.ps1

@@ -32,7 +32,8 @@ Describe 'Archive Entry Management Commands' {
             Compress-TarArchive @compressTarArchiveSplat
         }
 
-        $zip, $file, $uri, $tarArchives, $itemCounts, $totalCount | Out-Null
+        $encryptedZip = Get-Item $PSScriptRoot/../assets/helloworld.zip
+        $zip, $file, $uri, $tarArchives, $itemCounts, $totalCount, $encryptedZip | Out-Null
     }
 
     Context 'New-ZipEntry' -Tag 'New-ZipEntry' {
@@ -356,6 +357,20 @@ Describe 'Archive Entry Management Commands' {
             { $zip | Get-ZipEntry -Type Directory | Get-ZipEntry } |
                 Should -Throw
         }
+
+        It 'Can read encrypted entries' {
+            $passw = ConvertTo-SecureString 'test' -AsPlainText -Force
+
+            Use-Object ($stream = $encryptedZip.OpenRead()) {
+                $stream | Get-ZipEntry -Type Archive |
+                    Get-ZipEntryContent -Password $passw |
+                    Should -BeExactly 'hello world!'
+            }
+
+            $encryptedZip | Get-ZipEntry -Type Archive |
+                Get-ZipEntryContent -Password $passw |
+                Should -BeExactly 'hello world!'
+        }
     }
 
     Context 'Get-TarEntryContent' -Tag 'Get-TarEntryContent' {
@@ -680,6 +695,26 @@ Describe 'Archive Entry Management Commands' {
             Get-ChildItem -LiteralPath $destination -Recurse -File |
                 ForEach-Object { $_ | Get-Content | Should -BeExactly $content }
         }
+
+        It 'Can extract an encrypted entry' {
+            $passw = ConvertTo-SecureString 'test' -AsPlainText -Force
+            $dest = Join-Path $TestDrive encryptedTestFolder
+            Use-Object ($stream = $encryptedZip.OpenRead()) {
+                $info = $stream | Get-ZipEntry -Type Archive |
+                    Expand-ZipEntry -Password $passw -Destination $dest -PassThru
+
+                $info | Should -BeOfType ([FileInfo])
+                Get-Content $info.FullName | Should -BeExactly 'hello world!'
+                $info.Delete()
+            }
+
+            $info = $encryptedZip | Get-ZipEntry |
+                Expand-ZipEntry -Password $passw -Destination $dest -PassThru
+
+            $info | Should -BeOfType ([FileInfo])
+            Get-Content $info.FullName | Should -BeExactly 'hello world!'
+            $info.Delete()
+        }
     }
 
     Context 'Expand-TarEntry' -Tag 'Expand-TarEntry' {

tests/ZipEntryBase.tests.ps1

@@ -76,6 +76,10 @@ Describe 'ZipEntryBase Class' {
         ($zip | Get-ZipEntry).CompressionRatio | Should -BeOfType ([string])
     }
 
+    It 'Has a Crc Property' {
+        ($zip | Get-ZipEntry).Crc | Should -BeOfType ([long])
+    }
+
     It 'Can remove an entry in the source zip' {
         { $zip | Get-ZipEntry | ForEach-Object Remove } |
             Should -Not -Throw