Deprecate many attribute reader functions

danielsaidi · Feb 14, 2024 · 611be51 · 611be51
1 parent f4b6ae8
commit 611be51
Show file tree

Hide file tree

Showing 16 changed files with 41 additions and 39 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -10,11 +10,11 @@ Until then, minor updates may remove deprecated features and introduce breaking
 
 This release adds a lot of new `RichTextAction` cases and adjusts the context and coordinator subscription.
 
-This release also deprecates `RichTextAttributeReader` and `RichTextAttributeWriter` functionality that are not used by the library, in favor of `RichTextViewComponent`. This is done to reduce the complexity of the library. 
+This release also deprecates `RichTextAttributeReader` and `RichTextAttributeWriter` functionality that are not used by the library, in favor of `RichTextViewComponent`, to reduce the complexity of the library. 
 
-Until now, the functions mostly did the same things, but sometimes the `RichTextViewComponent` have to use its text storage or layout manager, or update the typing attributes. Since these are not present in the reader and writer protocols, the code diverged and mostly identical copies had to co-exist. And since the reader and writer versions are not used by the library, they may not work as well as intended.
+Until now, these functions mostly did the same thing, but sometimes the `RichTextViewComponent` have to use its text storage or layout manager, or update the typing attributes. This caused the code to diverge and mostly identical copies had co-exist, where the reader and writer versions were not even used by the library.
 
-This change will hopefully make it possible to simplify the library in the 1.0 release, and focus more on unifying the different TextView platform implementations (`UITextView` in iOS and `NSTextView` in macOS), rather than providing a low level string handling interface.
+By deprecating these functions, we can simplify the library in 1.0, and focus more on unifying the different `RichTextViewComponent` implementations (`UITextView` in iOS and `NSTextView` in macOS), rather than providing a low level string handling interface.
 
 ### ✨ Features
 
@@ -39,10 +39,10 @@ This change will hopefully make it possible to simplify the library in the 1.0 r
 * `RichTextAlignment` now behaves better.
 * `RichTextCoordinator` now handles indentation changes.
 
-
 ### 🗑️ Deprecations 
 
-* `RichTextAttributeWriter` deprecates many functions in favor of `RichTextViewComponent`.
+* `RichTextAttributeReader` has deprecated a lot of functions.
+* `RichTextAttributeWriter` has deprecated a lot of functions.
 * `RichTextCoordinator` functions that simply triggered `handle(_:)` have been deprecated.
 
 

diff --git a/Sources/RichTextKit/Component/RichTextViewComponent+Colors.swift b/Sources/RichTextKit/Component/RichTextViewComponent+Colors.swift
@@ -17,6 +17,15 @@ public extension RichTextViewComponent {
         guard let attribute = color.attribute else { return nil }
         return richTextAttribute(attribute)
     }
+
+    /// Get a certain rich text color at a certain range.
+    func richTextColor(
+        _ color: RichTextColor,
+        at range: NSRange
+    ) -> ColorRepresentable? {
+        guard let attribute = color.attribute else { return nil }
+        return richTextAttribute(attribute, at: range)
+    }
 
     /// Set a certain rich text color at current range.
     func setRichTextColor(

diff --git a/...s/RichTextAttributeReader+Alignment.swift → ...d/RichTextAttributeReader+Alignment.swift b/...s/RichTextAttributeReader+Alignment.swift → ...d/RichTextAttributeReader+Alignment.swift
@@ -8,6 +8,7 @@
 
 import Foundation
 
+@available(*, deprecated, message: "Use RichTextViewComponent instead.")
 public extension RichTextAttributeReader {
 
     /// Get the rich text alignment at a certain range.

diff --git a/...utes/RichTextAttributeReader+Colors.swift → ...ated/RichTextAttributeReader+Colors.swift b/...utes/RichTextAttributeReader+Colors.swift → ...ated/RichTextAttributeReader+Colors.swift
@@ -8,10 +8,11 @@
 
 import Foundation
 
+@available(*, deprecated, message: "Use RichTextViewComponent instead")
 public extension RichTextAttributeReader {
 
     /// Get a certain rich text color at a certain range.
-    func richTextColor(
+    func richTextColorOld(
         _ color: RichTextColor,
         at range: NSRange
     ) -> ColorRepresentable? {

diff --git a/...ibutes/RichTextAttributeReader+Font.swift → ...ecated/RichTextAttributeReader+Font.swift b/...ibutes/RichTextAttributeReader+Font.swift → ...ecated/RichTextAttributeReader+Font.swift
@@ -8,6 +8,7 @@
 
 import Foundation
 
+@available(*, deprecated, message: "Use RichTextViewComponent instead.")
 public extension RichTextAttributeReader {
 
     /// Get the rich text font at a certain range.

diff --git a/...utes/RichTextAttributeReader+Indent.swift → ...ated/RichTextAttributeReader+Indent.swift b/...utes/RichTextAttributeReader+Indent.swift → ...ated/RichTextAttributeReader+Indent.swift
@@ -8,6 +8,7 @@
 
 import Foundation
 
+@available(*, deprecated, message: "Use RichTextViewComponent instead")
 public extension RichTextAttributeReader {
 
     /// Get the rich text indent at a certain range.

diff --git a/...s/RichTextAttributeReader+Paragraph.swift → ...d/RichTextAttributeReader+Paragraph.swift b/...s/RichTextAttributeReader+Paragraph.swift → ...d/RichTextAttributeReader+Paragraph.swift
@@ -16,6 +16,7 @@ import UIKit
 import AppKit
 #endif
 
+@available(*, deprecated, message: "Use RichTextViewComponent instead.")
 public extension RichTextAttributeReader {
 
     /// Get the rich text paragraph style at a certain range.

diff --git a/...butes/RichTextAttributeReader+Style.swift → ...cated/RichTextAttributeReader+Style.swift b/...butes/RichTextAttributeReader+Style.swift → ...cated/RichTextAttributeReader+Style.swift
@@ -8,6 +8,7 @@
 
 import Foundation
 
+@available(*, deprecated, message: "Use RichTextViewComponent instead")
 public extension RichTextAttributeReader {
 
     /// Get all rich text styles at a certain range.

diff --git a/...RichTextAttributeReader+Superscript.swift → ...RichTextAttributeReader+Superscript.swift b/...RichTextAttributeReader+Superscript.swift → ...RichTextAttributeReader+Superscript.swift
@@ -9,6 +9,7 @@
 #if macOS
 import Foundation
 
+@available(*, deprecated, message: "Use RichTextViewComponent instead.")
 public extension RichTextAttributeReader {
 
     /// Get the superscript level at a certain range.

diff --git a/Sources/RichTextKit/_Deprecated/RichTextAttributeWriter+Colors.swift b/Sources/RichTextKit/_Deprecated/RichTextAttributeWriter+Colors.swift
@@ -12,13 +12,13 @@ import Foundation
 public extension RichTextAttributeWriter {
 
     /// Set a certain rich text color at a certain range.
-    func setRichTextColor(
+    func setRichTextColorOld(
         _ color: RichTextColor,
         to val: ColorRepresentable,
         at range: NSRange
     ) {
         guard let attribute = color.attribute else { return }
-        if richTextColor(color, at: range) == val { return }
+        if richTextColorOld(color, at: range) == val { return }
         setRichTextAttribute(attribute, to: val, at: range)
     }
 }
diff --git a/Tests/RichTextKitTests/Attributes/RichTextAttributeReader+AlignmentTests.swift b/Tests/RichTextKitTests/Attributes/RichTextAttributeReader+AlignmentTests.swift
diff --git a/Tests/RichTextKitTests/RichTextCoordinatorIntegrationTests+UIKit.swift b/Tests/RichTextKitTests/RichTextCoordinatorIntegrationTests+UIKit.swift
@@ -72,7 +72,7 @@ final class RichTextCoordinatorIntegrationTests: XCTestCase {
         XCTAssertEqual(textView.richTextAttributes[.font] as? FontRepresentable, FontRepresentable.systemFont(ofSize: 16))
         XCTAssertEqual(textView.richTextAttributes[.foregroundColor] as? ColorRepresentable, ColorRepresentable.red)
 
-        textView.setRichTextStyle(.strikethrough, to: true, at: textView.selectedRange)
+        textView.setRichTextStyle(.strikethrough, to: true)
         XCTAssertEqual(textView.richTextAttributes[.strikethroughStyle] as? Int, 1)
     }
 }

diff --git a/Tests/RichTextKitTests/RichTextViewRepresentable+AttributesTests.swift b/Tests/RichTextKitTests/RichTextViewRepresentable+AttributesTests.swift
@@ -47,7 +47,9 @@ final class RichTextViewComponent_AttributesTests: XCTestCase {
         textView.setRichTextAttribute(.font, to: font)
         assertEqualAttributes(textView.richTextAttributes)
         assertEqualAttributes(textView.richTextAttributes(at: selectedRange))
+        #if iOS
         assertEqualAttributes(textView.typingAttributes)
+        #endif
     }
 
     func testTextAttributesIsValidForNoSelectedRange() {
@@ -65,7 +67,9 @@ final class RichTextViewComponent_AttributesTests: XCTestCase {
         textView.setRichTextAttribute(.font, to: font)
         assertEqualAttribute(textView.richTextAttribute(.font))
         assertEqualAttribute(textView.richTextAttribute(.font, at: selectedRange))
+        #if iOS
         assertEqualAttribute(textView.typingAttributes[.font])
+        #endif
     }
 
     func testTextAttributeValueForKeyIsValidForNoSelectedRange() {

diff --git a/Tests/RichTextKitTests/RichTextViewRepresentable+ColorTests.swift b/Tests/RichTextKitTests/RichTextViewRepresentable+ColorTests.swift
@@ -56,7 +56,9 @@ final class RichTextViewComponent_ColorTests: XCTestCase {
         XCTAssertEqual(textView.richTextColor(.background), color)
         assertEqualColor(textView.richTextAttributes[.backgroundColor])
         assertEqualColor(textView.richTextAttributes(at: selectedRange)[.backgroundColor])
+        #if iOS || os(tvOS)
         assertEqualColor(textView.typingAttributes[.backgroundColor])
+        #endif
     }
 
     func testRichTextBackgroundColorWorksForNoSelectedRange() {
@@ -76,7 +78,9 @@ final class RichTextViewComponent_ColorTests: XCTestCase {
         XCTAssertEqual(textView.richTextColor(.foreground), color)
         assertEqualColor(textView.richTextAttributes[.foregroundColor])
         assertEqualColor(textView.richTextAttributes(at: selectedRange)[.foregroundColor])
+        #if iOS || os(tvOS)
         assertEqualColor(textView.typingAttributes[.foregroundColor])
+        #endif
     }
 
     func testRichTextForegroundColorWorksForNoSelectedRange() {

diff --git a/Tests/RichTextKitTests/RichTextViewRepresentable+FontSizeTests.swift b/Tests/RichTextKitTests/RichTextViewRepresentable+FontSizeTests.swift
@@ -51,7 +51,9 @@ final class RichTextViewComponent_FontSizeTests: XCTestCase {
         XCTAssertEqual(textView.richTextFont?.fontName, font.fontName)
         assertEqualFont(textView.richTextAttribute(.font))
         assertEqualFont(textView.richTextAttributes(at: selectedRange)[.font])
+        #if iOS || os(tvOS)
         assertEqualFont(textView.typingAttributes[.font])
+        #endif
     }
 
     func testRichTextFontWorksForNoSelectedRange() {

diff --git a/Tests/RichTextKitTests/RichTextViewRepresentableTests.swift b/Tests/RichTextKitTests/RichTextViewRepresentableTests.swift
@@ -73,11 +73,14 @@ final class RichTextViewComponentTests: XCTestCase {
         #endif
         XCTAssertEqual(view.backgroundColor, .clear)
         XCTAssertEqual(view.contentCompressionResistancePriority(for: .horizontal), .defaultLow)
-        #if iOS || os(tvOS)
+        #if iOS
+        XCTAssertEqual(view.spellCheckingType, .no)
+        XCTAssertNil(view.textColor)
+        #elseif os(tvOS)
         XCTAssertEqual(view.spellCheckingType, .no)
-        XCTAssertEqual(view.textColor, nil)
+        XCTAssertNotNil(view.textColor)
         #elseif macOS
-        XCTAssertEqual(view.textColor, nil)
+        XCTAssertNotNil(view.textColor)
         #endif
     }
 }