Rename to SetNeedsDisplay

b3ll · Dec 23, 2020 · b14ee84 · b14ee84
1 parent b713933
commit b14ee84
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 22 deletions.
diff --git a/Package.swift b/Package.swift
@@ -4,19 +4,19 @@
 import PackageDescription
 
 let package = Package(
-    name: "LayoutInvalidating",
+    name: "SetNeedsDisplay",
     products: [
         .library(
-            name: "LayoutInvalidating",
-            targets: ["LayoutInvalidating"]),
+            name: "SetNeedsDisplay",
+            targets: ["SetNeedsDisplay"]),
     ],
     dependencies: [],
     targets: [
         .target(
-            name: "LayoutInvalidating",
+            name: "SetNeedsDisplay",
             dependencies: []),
         .testTarget(
-            name: "LayoutInvalidatingTests",
-            dependencies: ["LayoutInvalidating"]),
+            name: "SetNeedsDisplayTests",
+            dependencies: ["SetNeedsDisplay"]),
     ]
 )
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
-# LayoutInvalidating
+# SetNeedsDisplay
 
-![Tests](https://github.com/b3ll/LayoutInvalidating/workflows/Tests/badge.svg)
+![Tests](https://github.com/b3ll/SetNeedsDisplay/workflows/Tests/badge.svg)
 
 This package provides a property wrapper that can be used on properties for any `NSView` or `UIView` to invalidate the layout whenever the value of said property is changed.
 
 **Note**: This code contains some private Swift API stuff that powers `@Published` so there's a strong likelyhood this will break in the future.
 
-- [Introduction](#layoutinvalidating)
+- [Introduction](#SetNeedsDisplay)
 - [Usage](#usage)
 - [Installation](#installation)
   - [Requirements](#requirements)
@@ -23,7 +23,7 @@ Annotate your property of a type that conforms to `Equatable` like so:
 class MyView: UIView {
 
     // Anytime someCustomProperty is changed, `-setNeedsLayout` will be called.
-    @LayoutInvaldating var someCustomProperty: CGFloat = 0.0
+    @SetNeedsDisplay var someCustomProperty: CGFloat = 0.0
 
 }
 ```
@@ -35,19 +35,19 @@ class MyView: UIView {
 - iOS 13+, macOS 10.15+
 - Swift 5.0 or higher
 
-Currently LayoutInvalidating supports Swift Package Manager (or manually adding `LayoutInvalidating.swift` to your project).
+Currently SetNeedsDisplay supports Swift Package Manager (or manually adding `SetNeedsDisplay.swift` to your project).
 
 ## Swift Package Manager
 
 Add the following to your `Package.swift` (or add it via Xcode's GUI):
 
 ```swift
-.package(url: "https://github.com/b3ll/LayoutInvalidating", from: "0.0.1")
+.package(url: "https://github.com/b3ll/SetNeedsDisplay", from: "0.0.1")
 ```
 
 # License
 
-LayoutInvalidating is licensed under the [BSD 2-clause license](https://github.com/b3ll/LayoutInvalidating/blob/master/LICENSE).
+SetNeedsDisplay is licensed under the [BSD 2-clause license](https://github.com/b3ll/SetNeedsDisplay/blob/master/LICENSE).
 
 # Thanks
 

diff --git a/...youtInvalidating/LayoutInvalidating.swift → ...ces/SetNeedsDisplay/SetNeedsDisplay.swift b/...youtInvalidating/LayoutInvalidating.swift → ...ces/SetNeedsDisplay/SetNeedsDisplay.swift
@@ -8,7 +8,7 @@ import UIKit
 
 /// A property wrapper for `UIView` or `NSView` (depending on platform) that will invalidate the layout of the view when the property's value is changed to something new.
 @propertyWrapper
-public final class LayoutInvalidating<Value> where Value: Equatable {
+public final class SetNeedsDisplay<Value> where Value: Equatable {
 
     #if os(macOS)
     public typealias ViewType = NSView
@@ -19,7 +19,7 @@ public final class LayoutInvalidating<Value> where Value: Equatable {
     public static subscript<EnclosingSelf>(
       _enclosingInstance observed: EnclosingSelf,
       wrapped wrappedKeyPath: ReferenceWritableKeyPath<EnclosingSelf, Value>,
-      storage storageKeyPath: ReferenceWritableKeyPath<EnclosingSelf, LayoutInvalidating>
+      storage storageKeyPath: ReferenceWritableKeyPath<EnclosingSelf, SetNeedsDisplay>
     ) -> Value where EnclosingSelf: ViewType {
       get {
         return observed[keyPath: storageKeyPath].stored

diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
@@ -1,7 +1,7 @@
 import XCTest
 
-import LayoutInvalidatingTests
+import SetNeedsDisplayTests
 
 var tests = [XCTestCaseEntry]()
-tests += LayoutInvalidatingTests.allTests()
+tests += SetNeedsDisplayTests.allTests()
 XCTMain(tests)
diff --git a/...datingTests/LayoutInvalidatingTests.swift → ...dsDisplayTests/SetNeedsDisplayTests.swift b/...datingTests/LayoutInvalidatingTests.swift → ...dsDisplayTests/SetNeedsDisplayTests.swift
@@ -1,12 +1,12 @@
 import XCTest
-@testable import LayoutInvalidating
+@testable import SetNeedsDisplay
 
 #if os(macOS)
 import AppKit
 
 class TestView: NSView {
 
-    @LayoutInvalidating var testPadding: CGFloat = 0.0
+    @SetNeedsDisplay var testPadding: CGFloat = 0.0
 
     var layoutWasInvalidated: Bool = false
 
@@ -30,7 +30,7 @@ import UIKit
 
 class TestView: UIView {
 
-    @LayoutInvalidating var testPadding: CGFloat = 0.0
+    @SetNeedsDisplay var testPadding: CGFloat = 0.0
 
     var layoutWasInvalidated: Bool = false
 
@@ -49,7 +49,7 @@ class TestView: UIView {
 }
 #endif
 
-final class LayoutInvalidatingTests: XCTestCase {
+final class SetNeedsDisplayTests: XCTestCase {
 
     func testLayoutInvalidation() {
         let view = TestView(frame: .zero)

diff --git a/...utInvalidatingTests/XCTestManifests.swift → ...etNeedsDisplayTests/XCTestManifests.swift b/...utInvalidatingTests/XCTestManifests.swift → ...etNeedsDisplayTests/XCTestManifests.swift
@@ -3,7 +3,7 @@ import XCTest
 #if !canImport(ObjectiveC)
 public func allTests() -> [XCTestCaseEntry] {
     return [
-        testCase(LayoutInvalidatingTests.allTests),
+        testCase(SetNeedsDisplayTests.allTests),
     ]
 }
 #endif