(#11) Implement SpacingBetweenLines property

y0ung3r · May 6, 2024 · 48fad92 · 48fad92
1 parent 046b4b5
commit 48fad92
Show file tree

Hide file tree

Showing 32 changed files with 392 additions and 74 deletions.
diff --git a/src/Word/OfficeFlow.Word.Core.Tests/ParagraphTests.cs b/src/Word/OfficeFlow.Word.Core.Tests/ParagraphTests.cs
@@ -1,6 +1,7 @@
 using System.Linq;
 using FluentAssertions;
 using OfficeFlow.Word.Core.Elements.Paragraphs;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting;
 using OfficeFlow.Word.Core.Elements.Paragraphs.Text;
 using Xunit;
 

diff --git a/...s/Paragraphs/Enums/HorizontalAlignment.cs → ...s/Formatting/Enums/HorizontalAlignment.cs b/...s/Paragraphs/Enums/HorizontalAlignment.cs → ...s/Formatting/Enums/HorizontalAlignment.cs
@@ -1,4 +1,4 @@
-namespace OfficeFlow.Word.Core.Elements.Paragraphs.Enums;
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Enums;
 
 public enum HorizontalAlignment
 {

diff --git a/...lements/Paragraphs/Enums/TextAlignment.cs → ...agraphs/Formatting/Enums/TextAlignment.cs b/...lements/Paragraphs/Enums/TextAlignment.cs → ...agraphs/Formatting/Enums/TextAlignment.cs
@@ -1,4 +1,4 @@
-namespace OfficeFlow.Word.Core.Elements.Paragraphs.Enums;
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Enums;
 
 public enum TextAlignment
 {

diff --git a/...re/Elements/Paragraphs/ParagraphFormat.cs → .../Paragraphs/Formatting/ParagraphFormat.cs b/...re/Elements/Paragraphs/ParagraphFormat.cs → .../Paragraphs/Formatting/ParagraphFormat.cs
@@ -1,10 +1,10 @@
 using OfficeFlow.MeasureUnits.Absolute;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Enums;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Spacing;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Spacing.Interfaces;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Enums;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
 using OfficeFlow.Word.Core.Interfaces;
 
-namespace OfficeFlow.Word.Core.Elements.Paragraphs;
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting;
 
 public sealed class ParagraphFormat : IVisitable
 {
@@ -23,6 +23,9 @@ public static ParagraphFormat Default
     public IParagraphSpacing SpacingAfter { get; set; } 
         = ParagraphSpacing.Exactly(8.0, AbsoluteUnits.Points);
 
+    public ILineSpacing SpacingBetweenLines { get; set; } 
+        = LineSpacing.Multiple(factor: 1.08);
+
     public bool KeepLines { get; set; }
 
     public bool KeepNext { get; set; }

diff --git a/...ents/Paragraphs/Spacing/AtLeastSpacing.cs → ...aphs/Formatting/Spacing/AtLeastSpacing.cs b/...ents/Paragraphs/Spacing/AtLeastSpacing.cs → ...aphs/Formatting/Spacing/AtLeastSpacing.cs
@@ -1,8 +1,8 @@
 using System;
 using OfficeFlow.MeasureUnits.Absolute;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Spacing.Interfaces;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
 
-namespace OfficeFlow.Word.Core.Elements.Paragraphs.Spacing;
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing;
 
 public sealed class AtLeastSpacing : ILineSpacing, IEquatable<AtLeastSpacing>
 {

diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Formatting/Spacing/AutoSpacing.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Formatting/Spacing/AutoSpacing.cs
@@ -0,0 +1,9 @@
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
+
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing;
+
+public sealed class AutoSpacing : IParagraphSpacing
+{
+    internal AutoSpacing()
+    { }
+}
diff --git a/...ements/Paragraphs/Spacing/ExactSpacing.cs → ...graphs/Formatting/Spacing/ExactSpacing.cs b/...ements/Paragraphs/Spacing/ExactSpacing.cs → ...graphs/Formatting/Spacing/ExactSpacing.cs
@@ -1,8 +1,8 @@
 using System;
 using OfficeFlow.MeasureUnits.Absolute;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Spacing.Interfaces;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
 
-namespace OfficeFlow.Word.Core.Elements.Paragraphs.Spacing;
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing;
 
 public sealed class ExactSpacing : IParagraphSpacing, ILineSpacing, IEquatable<ExactSpacing>
 {

diff --git a/...rd/OfficeFlow.Word.Core/Elements/Paragraphs/Formatting/Spacing/Interfaces/ILineSpacing.cs b/...rd/OfficeFlow.Word.Core/Elements/Paragraphs/Formatting/Spacing/Interfaces/ILineSpacing.cs
@@ -0,0 +1,3 @@
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
+
+public interface ILineSpacing;
diff --git a/...ficeFlow.Word.Core/Elements/Paragraphs/Formatting/Spacing/Interfaces/IParagraphSpacing.cs b/...ficeFlow.Word.Core/Elements/Paragraphs/Formatting/Spacing/Interfaces/IParagraphSpacing.cs
@@ -0,0 +1,3 @@
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
+
+public interface IParagraphSpacing;
diff --git a/...lements/Paragraphs/Spacing/LineSpacing.cs → ...agraphs/Formatting/Spacing/LineSpacing.cs b/...lements/Paragraphs/Spacing/LineSpacing.cs → ...agraphs/Formatting/Spacing/LineSpacing.cs
@@ -1,10 +1,19 @@
 using OfficeFlow.MeasureUnits.Absolute;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Spacing.Interfaces;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
 
-namespace OfficeFlow.Word.Core.Elements.Paragraphs.Spacing;
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing;
 
 public static class LineSpacing
 {
+    public static readonly ILineSpacing Single
+        = Multiple(factor: 1.0);
+
+    public static readonly ILineSpacing OneAndHalf
+        = Multiple(factor: 1.5);
+
+    public static readonly ILineSpacing Double
+        = Multiple(factor: 2.0);
+
     public static ILineSpacing Exactly<TUnits>(AbsoluteValue<TUnits> value)
         where TUnits : AbsoluteUnits, new()
         => new ExactSpacing(
@@ -25,6 +34,7 @@ public static ILineSpacing AtLeast<TUnits>(double value, TUnits units)
         => AtLeast(
             AbsoluteValue.From(value, units));
 
-    public static readonly ILineSpacing Auto
-        = new AutoSpacing();
+    // TODO[#11]: Design relative measurement units
+    public static ILineSpacing Multiple(double factor)
+        => new MultipleSpacing(factor);
 }
diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Formatting/Spacing/MultipleSpacing.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Formatting/Spacing/MultipleSpacing.cs
@@ -0,0 +1,34 @@
+using System;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
+
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing;
+
+public sealed class MultipleSpacing : ILineSpacing, IEquatable<MultipleSpacing>
+{
+    private const double MinValue = 0.0;
+    private const double MaxValue = 132.0;
+
+    // TODO[#11]: Design relative measurement units
+    public double Factor { get; }
+
+    internal MultipleSpacing(double factor)
+    {
+        if (factor is < MinValue or > MaxValue)
+            throw new ArgumentException(
+                $"The factor of multiple spacing must be between {MinValue} and {MaxValue}", 
+                nameof(factor));
+
+        Factor = factor;
+    }
+
+    public bool Equals(MultipleSpacing? other)
+        => other is not null && Factor.Equals(other.Factor);
+
+    /// <inheritdoc />
+    public override bool Equals(object? other)
+        => other is MultipleSpacing spacing && Equals(spacing);
+
+    /// <inheritdoc />
+    public override int GetHashCode()
+        => Factor.GetHashCode();
+}
diff --git a/...ts/Paragraphs/Spacing/ParagraphSpacing.cs → ...hs/Formatting/Spacing/ParagraphSpacing.cs b/...ts/Paragraphs/Spacing/ParagraphSpacing.cs → ...hs/Formatting/Spacing/ParagraphSpacing.cs
@@ -1,7 +1,7 @@
 using OfficeFlow.MeasureUnits.Absolute;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Spacing.Interfaces;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing.Interfaces;
 
-namespace OfficeFlow.Word.Core.Elements.Paragraphs.Spacing;
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Formatting.Spacing;
 
 public static class ParagraphSpacing
 {

diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Paragraph.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Paragraph.cs
@@ -2,6 +2,7 @@
 using System.Linq;
 using System.Text;
 using OfficeFlow.DocumentObjectModel;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting;
 using OfficeFlow.Word.Core.Elements.Paragraphs.Text;
 using OfficeFlow.Word.Core.Interfaces;
 

diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Spacing/AutoSpacing.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Spacing/AutoSpacing.cs
diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Spacing/Interfaces/ILineSpacing.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Spacing/Interfaces/ILineSpacing.cs
diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Spacing/Interfaces/IParagraphSpacing.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Spacing/Interfaces/IParagraphSpacing.cs
diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Enums/LineBreakType.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Enums/LineBreakType.cs
diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Enums/StrikethroughType.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Enums/StrikethroughType.cs
diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Formatting/Enums/LineBreakType.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Formatting/Enums/LineBreakType.cs
@@ -0,0 +1,8 @@
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting.Enums;
+
+public enum LineBreakType
+{
+    Column,
+    Page,
+    TextWrapping
+}
diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Formatting/Enums/StrikethroughType.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Formatting/Enums/StrikethroughType.cs
@@ -0,0 +1,8 @@
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting.Enums;
+
+public enum StrikethroughType
+{
+    None,
+    Single,
+    Double
+}
diff --git a/...ore/Elements/Paragraphs/Text/RunFormat.cs → ...s/Paragraphs/Text/Formatting/RunFormat.cs b/...ore/Elements/Paragraphs/Text/RunFormat.cs → ...s/Paragraphs/Text/Formatting/RunFormat.cs
@@ -1,7 +1,7 @@
-using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Enums;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting.Enums;
 using OfficeFlow.Word.Core.Interfaces;
 
-namespace OfficeFlow.Word.Core.Elements.Paragraphs.Text;
+namespace OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting;
 
 public sealed class RunFormat : IVisitable
 {

diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/LineBreak.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/LineBreak.cs
@@ -1,5 +1,5 @@
 using OfficeFlow.DocumentObjectModel;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Enums;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting.Enums;
 using OfficeFlow.Word.Core.Interfaces;
 
 namespace OfficeFlow.Word.Core.Elements.Paragraphs.Text;

diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Run.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/Run.cs
@@ -1,6 +1,7 @@
 using System.Linq;
 using OfficeFlow.DocumentObjectModel;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Enums;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting.Enums;
 using OfficeFlow.Word.Core.Interfaces;
 
 namespace OfficeFlow.Word.Core.Elements.Paragraphs.Text;

diff --git a/src/Word/OfficeFlow.Word.Core/Interfaces/IWordVisitor.cs b/src/Word/OfficeFlow.Word.Core/Interfaces/IWordVisitor.cs
@@ -1,6 +1,8 @@
 using OfficeFlow.Word.Core.Elements;
 using OfficeFlow.Word.Core.Elements.Paragraphs;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Formatting;
 using OfficeFlow.Word.Core.Elements.Paragraphs.Text;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting;
 
 namespace OfficeFlow.Word.Core.Interfaces;
 

diff --git a/src/Word/OfficeFlow.Word.OpenXml.Tests/OpenXmlElementReaderTests/LineBreakTests.cs b/src/Word/OfficeFlow.Word.OpenXml.Tests/OpenXmlElementReaderTests/LineBreakTests.cs
@@ -1,7 +1,7 @@
 using System.Xml.Linq;
 using FluentAssertions;
 using OfficeFlow.Word.Core.Elements.Paragraphs.Text;
-using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Enums;
+using OfficeFlow.Word.Core.Elements.Paragraphs.Text.Formatting.Enums;
 using Xunit;
 
 namespace OfficeFlow.Word.OpenXml.Tests.OpenXmlElementReaderTests;