Add outputs option to Initialize

readme.md

@@ -55,6 +55,29 @@ Other [compares](https://github.com/VerifyTests/Verify/blob/main/docs/comparer.m
  * https://github.com/VerifyTests/Verify.ImageSharp.Compare
 
 
+### Outputs
+
+`Initialize` accepts an optional `QuestPdfOutputs` to control which outputs a document is split into:
+
+ * `Png`: render each page to a png. When omitted, pages are not rasterized at all.
+ * `All`: the default.
+
+The pdf target is not controlled by this setting. Use `VerifierSettings.ExcludeTargets("pdf")` to exclude it.
+
+<!-- snippet: InitializeOutputs -->
+<a id='snippet-InitializeOutputs'></a>
+```cs
+[ModuleInitializer]
+public static void Init()
+{
+    QuestPDF.Settings.License = LicenseType.Community;
+    // Skip rendering pages to png
+    VerifyQuestPdf.Initialize(QuestPdfOutputs.None);
+}
+```
+<sup><a href='/src/StaticSettingsTests/ModuleInitializer.cs#L3-L13' title='Snippet source file'>snippet source</a> | <a href='#snippet-InitializeOutputs' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
 ### Code that generates a document 
 
 <!-- snippet: GenerateDocument -->

src/Directory.Build.props

@@ -2,7 +2,7 @@
 <Project>
   <PropertyGroup>
     <NoWarn>CS1591;CS0649;NU1608;NU1109</NoWarn>
-    <Version>2.9.0</Version>
+    <Version>2.10.0</Version>
     <AssemblyVersion>1.0.0</AssemblyVersion>
     <LangVersion>preview</LangVersion>
     <ImplicitUsings>enable</ImplicitUsings>

src/StaticSettingsTests/ModuleInitializer.cs

@@ -0,0 +1,14 @@
+public static class ModuleInitializer
+{
+    #region InitializeOutputs
+
+    [ModuleInitializer]
+    public static void Init()
+    {
+        QuestPDF.Settings.License = LicenseType.Community;
+        // Skip rendering pages to png
+        VerifyQuestPdf.Initialize(QuestPdfOutputs.None);
+    }
+
+    #endregion
+}

src/StaticSettingsTests/StaticSettingsTests.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <OutputType>Exe</OutputType>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="TUnit" />
+    <PackageReference Include="Verify.TUnit" />
+    <PackageReference Include="Argon" />
+    <PackageReference Include="DiffEngine" />
+    <PackageReference Include="EmptyFiles" />
+    <PackageReference Include="SimpleInfoName" />
+    <PackageReference Include="Verify" />
+    <ProjectReference Include="..\Verify.QuestPDF\Verify.QuestPDF.csproj" />
+    <PackageReference Include="ProjectDefaults" PrivateAssets="all" />
+    <Compile Include="..\Tests\GlobalUsings.cs" />
+  </ItemGroup>
+</Project>

src/StaticSettingsTests/Tests.VerifyDocument.verified.txt

@@ -0,0 +1,10 @@
+{
+  Pages: 2,
+  Settings: {
+    ContentDirection: LeftToRight,
+    PDFA_Conformance: None,
+    PDFUA_Conformance: None,
+    ImageCompressionQuality: High,
+    ImageRasterDpi: 288
+  }
+}

src/StaticSettingsTests/Tests.cs

@@ -0,0 +1,22 @@
+public class Tests
+{
+    [Test]
+    public Task VerifyDocument()
+    {
+        var document = Document.Create(container =>
+        {
+            container.Page(AddPage);
+            container.Page(AddPage);
+        });
+        return Verify(document);
+    }
+
+    static void AddPage(PageDescriptor page)
+    {
+        page.Size(PageSizes.A5);
+        page.Margin(1, Unit.Centimetre);
+        page.DefaultTextStyle(_ => _.FontSize(20));
+        page.Content()
+            .Text("Hello World");
+    }
+}

src/Verify.QuestPDF.slnx

@@ -10,6 +10,7 @@
     <File Path="mdsnippets.json" />
     <File Path="nuget.md" />
   </Folder>
+  <Project Path="StaticSettingsTests/StaticSettingsTests.csproj" />
   <Project Path="Tests/Tests.csproj" />
   <Project Path="Verify.QuestPDF/Verify.QuestPDF.csproj" />
 </Solution>

src/Verify.QuestPDF/QuestPdfOutputs.cs

@@ -0,0 +1,25 @@
+namespace VerifyTests;
+
+/// <summary>
+/// Controls which outputs a QuestPDF document is split into when verified.
+/// The pdf target is not controlled here; use <c>VerifierSettings.ExcludeTargets("pdf")</c> for that.
+/// </summary>
+[Flags]
+public enum QuestPdfOutputs
+{
+    /// <summary>
+    /// No outputs. Only the source document (and info) is emitted.
+    /// </summary>
+    None = 0,
+
+    /// <summary>
+    /// Render each page to a png target.
+    /// When omitted, page images are not rendered at all.
+    /// </summary>
+    Png = 1,
+
+    /// <summary>
+    /// All outputs.
+    /// </summary>
+    All = Png
+}

src/Verify.QuestPDF/VerifyQuestPdf.cs

@@ -6,14 +6,18 @@ public static class VerifyQuestPdf
 
     public static bool Initialized { get; private set; }
 
-    public static void Initialize()
+    static QuestPdfOutputs outputs = QuestPdfOutputs.All;
+
+    /// <param name="outputs">Which outputs a document is split into. Defaults to <see cref="QuestPdfOutputs.All"/>.</param>
+    public static void Initialize(QuestPdfOutputs outputs = QuestPdfOutputs.All)
     {
         if (Initialized)
         {
             throw new("Already Initialized");
         }
 
         Initialized = true;
+        VerifyQuestPdf.outputs = outputs;
 
         InnerVerifier.ThrowIfVerifyHasBeenRun();
         VerifierSettings
@@ -26,7 +30,21 @@ public static void Initialize()
         VerifierSettings.RegisterFileConverter<IDocument>(
             conversion: (document, settings) =>
             {
-                var pages = document.GenerateImages().ToList();
+                var includePng = outputs.HasFlag(QuestPdfOutputs.Png);
+                // Rasterizing pages is expensive, so only do it when png output is enabled.
+                // Otherwise the page count comes from the much cheaper vector svg generation.
+                List<byte[]> pages = [];
+                int pageCount;
+                if (includePng)
+                {
+                    pages = document.GenerateImages().ToList();
+                    pageCount = pages.Count;
+                }
+                else
+                {
+                    pageCount = document.GenerateSvg().Count;
+                }
+
                 if (!settings.GetPagesToInclude(out var pagesToInclude))
                 {
                     pagesToInclude = _ => true;
@@ -73,7 +91,7 @@ public static void Initialize()
                 return new(
                     info: new
                     {
-                        Pages = pages.Count,
+                        Pages = pageCount,
                         Metadata = NullIfEmpty(metadata),
                         Settings = document.GetSettings(),
                     },