Merge remote-tracking branch 'origin/main' into element-non-generic

Author: twsouthwick

.github/workflows/build.yml

@@ -96,10 +96,10 @@ jobs:
     - name: Build
       run: dotnet build --no-restore --verbosity normal
     - name: Test
-      run: dotnet test --no-restore --verbosity normal --logger trx --results-directory test-results/
+      run: dotnet test --no-restore -- --results-directory ${{ github.workspace }}/test-results/ --report-xunit-trx
     - name: Upload Test Results
       if: always()
       uses: actions/upload-artifact@v4
       with:
         name: Test Results (${{ matrix.os }} ${{ matrix.configuration }} ${{ matrix.projectloadstyle }})
-        path: test-results/*
+        path: ${{ github.workspace }}/test-results/*

.github/workflows/code-coverage.yml

@@ -20,6 +20,7 @@ on:
 
 jobs:
   build_and_test:
+    if: false # Disable for now while getting XUnit v3 working
     name: Run
 
     env:
@@ -47,7 +48,7 @@ jobs:
       run: dotnet test --no-restore --verbosity normal --collect:"XPlat Code Coverage" --results-directory coverage
 
     - name: ReportGenerator
-      uses: danielpalme/[email protected].1
+      uses: danielpalme/[email protected].4
       with:
         reports: coverage/**/coverage.cobertura.xml
         targetdir: coveragereport

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
         if: github.event.workflow_run.conclusion == 'success'
         steps:
         - name: Download Release Info
-          uses: dawidd6/action-download-artifact@v8
+          uses: dawidd6/action-download-artifact@v9
           with:
            run_id: ${{ github.event.workflow_run.id }}
            name: release-info
@@ -39,7 +39,7 @@ jobs:
       runs-on: ubuntu-latest
       steps:
         - name: Download and Extract Artifacts from build
-          uses: dawidd6/action-download-artifact@v8
+          uses: dawidd6/action-download-artifact@v9
           with:
             run_id: ${{ github.event.workflow_run.id }}
             name: Signed

.github/workflows/test-results.yml

@@ -22,7 +22,7 @@ jobs:
     steps:
       # Need to download from the associated workflow
       - name: Download and Extract Artifacts from build
-        uses: dawidd6/action-download-artifact@v8
+        uses: dawidd6/action-download-artifact@v9
         with:
           run_id: ${{ github.event.workflow_run.id }}
           path: artifacts

Directory.Build.props

@@ -41,10 +41,11 @@
         <NoWarn>$(NoWarn);CS1685</NoWarn>
         <ProductTargetFrameworks>net35</ProductTargetFrameworks>
         <FrameworkTargetFrameworks>net35</FrameworkTargetFrameworks>
-        <TestTargetFrameworks>net462</TestTargetFrameworks>
-        <AssetsTargetFrameworks>net462</AssetsTargetFrameworks>
-        <LatestTargetFramework>net462</LatestTargetFramework>
+        <TestTargetFrameworks>net472</TestTargetFrameworks>
+        <AssetsTargetFrameworks>net472</AssetsTargetFrameworks>
+        <LatestTargetFramework>net472</LatestTargetFramework>
         <SamplesFrameworks>net472</SamplesFrameworks>
+        <DefineConstants>$(DefineConstants);FEATURE_NO_VALIDATOR_CANCELLATIONTOKEN</DefineConstants>
       </PropertyGroup>
     </When>
     <When Condition=" '$(ProjectLoadStyle)' == 'net40' ">
@@ -53,22 +54,22 @@
         <NoWarn>$(NoWarn);CS1685</NoWarn>
         <ProductTargetFrameworks>net40</ProductTargetFrameworks>
         <FrameworkTargetFrameworks>net40</FrameworkTargetFrameworks>
-        <TestTargetFrameworks>net462</TestTargetFrameworks>
-        <AssetsTargetFrameworks>net462</AssetsTargetFrameworks>
-        <LatestTargetFramework>net462</LatestTargetFramework>
+        <TestTargetFrameworks>net472</TestTargetFrameworks>
+        <AssetsTargetFrameworks>net472</AssetsTargetFrameworks>
+        <LatestTargetFramework>net472</LatestTargetFramework>
         <SamplesFrameworks>net472</SamplesFrameworks>
       </PropertyGroup>
     </When>
     <Otherwise>
       <PropertyGroup>
         <ProductTargetFrameworks>netstandard2.0;net8.0;net35;net40;net46</ProductTargetFrameworks>
         <FrameworkTargetFrameworks>netstandard2.0;net6.0;net8.0;net35;net40;net46</FrameworkTargetFrameworks>
-        <AssetsTargetFrameworks>netstandard2.0;net462</AssetsTargetFrameworks>
+        <AssetsTargetFrameworks>netstandard2.0;net472</AssetsTargetFrameworks>
         <TestTargetFrameworks>net8.0</TestTargetFrameworks>
-        <TestTargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TestTargetFrameworks);net462</TestTargetFrameworks>
+        <TestTargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TestTargetFrameworks);net472</TestTargetFrameworks>
         <LatestTargetFramework>net8.0</LatestTargetFramework>
         <SamplesFrameworks>net8.0</SamplesFrameworks>
-        <SamplesFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TestTargetFrameworks);net472</SamplesFrameworks>
+        <SamplesFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(SamplesFrameworks);net472</SamplesFrameworks>
       </PropertyGroup>
     </Otherwise>
   </Choose>

Directory.Packages.props

@@ -3,7 +3,7 @@
   <ItemGroup>
     <PackageVersion Include="BenchmarkDotNet" Version="0.14.0" />
     <PackageVersion Include="BenchmarkDotNet.Diagnostics.Windows" Version="0.14.0" />
-    <PackageVersion Include="coverlet.collector" Version="6.0.2" />
+    <PackageVersion Include="coverlet.collector" Version="6.0.4" />
     <PackageVersion Include="Microsoft.Bcl.Memory" Version="9.0.0" />
     <PackageVersion Include="Microsoft.DotNet.BuildTools.GenAPI" Version="3.0.0-preview4-06015-01" />
     <PackageVersion Include="Microsoft.CodeAnalysis" Version="4.11.0" />
@@ -14,24 +14,24 @@
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageVersion Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.3" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
+    <PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="17.13.1" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageVersion Include="NSubstitute" Version="5.3.0" />
-    <PackageVersion Include="NuGet.Common" Version="6.12.1" />
-    <PackageVersion Include="NuGet.Packaging" Version="6.12.1" />
+    <PackageVersion Include="NuGet.Common" Version="6.13.2" />
+    <PackageVersion Include="NuGet.Packaging" Version="6.13.2" />
     <PackageVersion Include="NuGet.Protocol" Version="6.12.1" />
     <PackageVersion Include="NuGet.Resolver" Version="6.12.1" />
     <PackageVersion Include="ObjectLayoutInspector" Version="0.1.4" />
     <PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />
     <PackageVersion Include="Svg" Version="3.4.7" />
     <PackageVersion Include="System.CodeDom" Version="8.0.0" />
     <PackageVersion Include="System.IO.Packaging" Version="8.0.1" />
-    <PackageVersion Include="System.Collections.Immutable" Version="7.0.0" />
+    <PackageVersion Include="System.Collections.Immutable" Version="8.0.0" />
     <PackageVersion Include="System.Net.Http" Version="4.3.4" />
     <PackageVersion Include="System.Security.Cryptography.Algorithms" Version="4.3.1" />
     <PackageVersion Include="System.Text.Json" Version="9.0.0" />
     <PackageVersion Include="System.Xml.ReaderWriter" Version="4.3.1" />
     <PackageVersion Include="System.ValueTuple" Version="4.5.0" />
-    <PackageVersion Include="xunit" Version="2.9.2" />
-    <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
+    <PackageVersion Include="xunit.v3" Version="1.0.0" />
   </ItemGroup>
 </Project>

GitVersion.yml

@@ -1,5 +1,5 @@
 mode: ContinuousDeployment
-next-version: 3.1.0
+next-version: 3.4.0
 branches: {}
 ignore:
   sha: []

Open-XML-SDK.sln

@@ -67,8 +67,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "gen", "gen", "{3653266D-2C8
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentFormat.OpenXml.Generator", "gen\DocumentFormat.OpenXml.Generator\DocumentFormat.OpenXml.Generator.csproj", "{E04F2FB4-DBC6-46DC-857C-F0E89B42F385}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentFormat.OpenXml.Generator.Tests", "test\DocumentFormat.OpenXml.Generator.Tests\DocumentFormat.OpenXml.Generator.Tests.csproj", "{BAC36A8F-AA8E-4097-B2BA-2EFE559BEE62}"
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Linq", "Linq", "{C5AE39F0-A152-471A-B90E-B8F4E94AA6C2}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SvgExampleLinq", "samples\Linq\SvgExample\SvgExampleLinq.csproj", "{DE06FC2B-EABB-4535-BC73-C51A32B5AC01}"
@@ -149,10 +147,6 @@ Global
 		{E04F2FB4-DBC6-46DC-857C-F0E89B42F385}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E04F2FB4-DBC6-46DC-857C-F0E89B42F385}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E04F2FB4-DBC6-46DC-857C-F0E89B42F385}.Release|Any CPU.Build.0 = Release|Any CPU
-		{BAC36A8F-AA8E-4097-B2BA-2EFE559BEE62}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{BAC36A8F-AA8E-4097-B2BA-2EFE559BEE62}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{BAC36A8F-AA8E-4097-B2BA-2EFE559BEE62}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{BAC36A8F-AA8E-4097-B2BA-2EFE559BEE62}.Release|Any CPU.Build.0 = Release|Any CPU
 		{DE06FC2B-EABB-4535-BC73-C51A32B5AC01}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{DE06FC2B-EABB-4535-BC73-C51A32B5AC01}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{DE06FC2B-EABB-4535-BC73-C51A32B5AC01}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -211,7 +205,6 @@ Global
 		{E157C5F1-D70B-4939-A199-0B758FED8541} = {0782A132-968D-4BDD-911A-2C3074EAF886}
 		{3B82C340-3B10-42BF-9A2C-2E2327A9CFD4} = {0782A132-968D-4BDD-911A-2C3074EAF886}
 		{E04F2FB4-DBC6-46DC-857C-F0E89B42F385} = {3653266D-2C88-4487-8977-839CB3E78A0A}
-		{BAC36A8F-AA8E-4097-B2BA-2EFE559BEE62} = {0782A132-968D-4BDD-911A-2C3074EAF886}
 		{C5AE39F0-A152-471A-B90E-B8F4E94AA6C2} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
 		{DE06FC2B-EABB-4535-BC73-C51A32B5AC01} = {7DAF7304-40CC-4180-88A5-9A89DD13C565}
 		{890B74DD-6316-4D56-B42A-5D66F10F88C6} = {C5AE39F0-A152-471A-B90E-B8F4E94AA6C2}

README.md

@@ -4,9 +4,7 @@ Open XML SDK
 
 > [!NOTE]
 >  
-> [v3.0.0](https://www.nuget.org/packages/DocumentFormat.OpenXml/3.0.0) refactors and addresses some technical debt while retaining source compatibility as much as possible. You should be able to update your package and recompile with limited changes. However, binary compatibility was not a goal and will break that for some changes which are documented. PRs that introduced such changes are marked with a `breaking-change` label and were added to a list to help migrating to v3.0.0.
->
-> Please see the [v3.0.0 milestone](https://github.com/OfficeDev/Open-XML-SDK/milestone/1) for issues and PRs that are included. For discussions, please join us at [this issue](https://github.com/OfficeDev/Open-XML-SDK/issues/1270).
+> 3.0.0 introduced breaking changes and you should be able to update your package and recompile with limited changes. Please see the [v3.0.0 milestone](https://github.com/OfficeDev/Open-XML-SDK/milestone/1) for issues and PRs that were included.
 
 
 > [!IMPORTANT]
@@ -16,14 +14,20 @@ Open XML SDK
 [![Build Status](https://office.visualstudio.com/OC/_apis/build/status/OpenXmlSdk/OfficeDev.Open-XML-SDK?branchName=main)](https://office.visualstudio.com/OC/_build/latest?definitionId=7420&branchName=main)
 [![Backend Status](https://ointprotocol.visualstudio.com/OInteropTools/_apis/build/status/OpenXML-Schemas?branchName=main)](https://ointprotocol.visualstudio.com/OInteropTools/_build/latest?definitionId=21&branchName=main)
 
-The Open XML SDK provides tools for working with Office Word, Excel, and PowerPoint documents. It supports scenarios such as:
+The Open XML SDK is a framework for working with Microsoft Office Word, Excel, and PowerPoint documents. It includes APIs for low-level operations related to OPC packages, Flat OPC files, and Open XML markup in two forms (i.e., strongly-typed classes and LINQ to XML). It is designed to closely follow the Microsoft Office implementation of the ISO 29500 standard, but was not intended to directly provide higher-level abstractions or productivity tools.
+
+These APIs enable scenarios such as:
 
 - High-performance generation of word-processing documents, spreadsheets, and presentations.
 - Document modification, such as adding, updating, and removing content and metadata.
-- Search and replace content using regular expressions.
+- Searching and replacing content using regular expressions.
 - Splitting up (shredding) a file into multiple files, and combining multiple files into a single file.
 - Updating cached data and embedded spreadsheets for charts in Word/PowerPoint.
 
+
+Prerequisite for using the Open XML SDK: detailed knowledge of the relevant formats (https://learn.microsoft.com/en-us/openspecs/office_standards/ms-offstandlp) and standards (https://standards.iso.org/ittf/PubliclyAvailableStandards/index.html - search for 29500)
+
+
 <!-- omit in toc -->
 # Table of Contents
 

src/DocumentFormat.OpenXml.Framework/EnumerableExtensions.cs

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace DocumentFormat.OpenXml;
+
+internal static class EnumerableExtensions
+{
+    /// <summary>
+    /// Similar to <see cref="Enumerable.FirstOrDefault{TSource}(IEnumerable{TSource})"/> but will also verify that at most there is one.
+    /// </summary>
+    public static T? FirstOrDefaultAndMaxOne<T>(this IEnumerable<T> enumerable, Func<Exception>? exceptionFactory = null)
+    {
+        using var e = enumerable.GetEnumerator();
+
+        if (e.MoveNext())
+        {
+            var first = e.Current;
+
+            if (e.MoveNext())
+            {
+                throw exceptionFactory?.Invoke() ?? throw new InvalidOperationException(ExceptionMessages.FirstOrDefaultMaxOne);
+            }
+
+            return first;
+        }
+
+        return default;
+    }
+}