Remove final access modifier from public classes (#87)

* Allow test/mocking of extension methods To facilitate tests/mocking, magnet should not use the `final` modifier. This PR only removes the `final` keyword, and nothing else. * Fix extension access * coder inits required * HotKey isEqual must be public * Testing - Danger - workflow_dispatch --------- Co-authored-by: Econa77 <[email protected]>
Clipy · Oct 11, 2023 · 6ab594e · 6ab594e
1 parent 87babf2
commit 6ab594e
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 27 deletions.
diff --git a/.github/workflows/Danger.yml b/.github/workflows/Danger.yml
@@ -1,9 +1,11 @@
 name: Danger
+
 on: 
   pull_request:
   push:
     branches:
       - master
+
 jobs:
   danger:
     runs-on: macos-13

diff --git a/Lib/Magnet/HotKey.swift b/Lib/Magnet/HotKey.swift
@@ -11,7 +11,7 @@
 import Cocoa
 import Carbon
 
-public final class HotKey: NSObject {
+open class HotKey: NSObject {
 
     // MARK: - Properties
     public let identifier: String
@@ -65,8 +65,8 @@ public final class HotKey: NSObject {
 }
 
 // MARK: - Invoke
-public extension HotKey {
-    func invoke() {
+extension HotKey {
+    public func invoke() {
         guard let callback = self.callback else {
             guard let target = self.target as? NSObject, let selector = self.action else { return }
             guard target.responds(to: selector) else { return }
@@ -84,20 +84,20 @@ public extension HotKey {
 }
 
 // MARK: - Register & UnRegister
-public extension HotKey {
+extension HotKey {
     @discardableResult
-    func register() -> Bool {
+    public func register() -> Bool {
         return HotKeyCenter.shared.register(with: self)
     }
 
-    func unregister() {
+    public func unregister() {
         return HotKeyCenter.shared.unregister(with: self)
     }
 }
 
 // MARK: - override isEqual
-public extension HotKey {
-    override func isEqual(_ object: Any?) -> Bool {
+extension HotKey {
+    override public func isEqual(_ object: Any?) -> Bool {
         guard let hotKey = object as? HotKey else { return false }
 
         return self.identifier == hotKey.identifier &&

diff --git a/Lib/Magnet/HotKeyCenter.swift b/Lib/Magnet/HotKeyCenter.swift
@@ -11,7 +11,7 @@
 import Cocoa
 import Carbon
 
-public final class HotKeyCenter {
+open class HotKeyCenter {
 
     // MARK: - Properties
     public static let shared = HotKeyCenter()
@@ -37,9 +37,9 @@ public final class HotKeyCenter {
 }
 
 // MARK: - Register & Unregister
-public extension HotKeyCenter {
+extension HotKeyCenter {
     @discardableResult
-    func register(with hotKey: HotKey) -> Bool {
+    public func register(with hotKey: HotKey) -> Bool {
         guard !hotKeys.keys.contains(hotKey.identifier) else { return false }
         guard !hotKeys.values.contains(hotKey) else { return false }
 
@@ -78,7 +78,7 @@ public extension HotKeyCenter {
         return true
     }
 
-    func unregister(with hotKey: HotKey) {
+    public func unregister(with hotKey: HotKey) {
         if let carbonHotKey = hotKey.hotKeyRef {
             UnregisterEventHotKey(carbonHotKey)
         }
@@ -88,13 +88,13 @@ public extension HotKeyCenter {
     }
 
     @discardableResult
-    func unregisterHotKey(with identifier: String) -> Bool {
+    public func unregisterHotKey(with identifier: String) -> Bool {
         guard let hotKey = hotKeys[identifier] else { return false }
         unregister(with: hotKey)
         return true
     }
 
-    func unregisterAll() {
+    public func unregisterAll() {
         hotKeys.forEach { unregister(with: $1) }
     }
 }
@@ -114,8 +114,8 @@ extension HotKeyCenter {
 }
 
 // MARK: - HotKey Events
-private extension HotKeyCenter {
-    func installHotKeyPressedEventHandler() {
+extension HotKeyCenter {
+    public func installHotKeyPressedEventHandler() {
         var pressedEventType = EventTypeSpec()
         pressedEventType.eventClass = OSType(kEventClassKeyboard)
         pressedEventType.eventKind = OSType(kEventHotKeyPressed)
@@ -124,7 +124,7 @@ private extension HotKeyCenter {
         }, 1, &pressedEventType, nil, nil)
     }
 
-    func sendPressedKeyboardEvent(_ event: EventRef) -> OSStatus {
+    public func sendPressedKeyboardEvent(_ event: EventRef) -> OSStatus {
         assert(Int(GetEventClass(event)) == kEventClassKeyboard, "Unknown event class")
 
         var hotKeyId = EventHotKeyID()
@@ -151,8 +151,8 @@ private extension HotKeyCenter {
 }
 
 // MARK: - Double Tap Modifier Event
-private extension HotKeyCenter {
-    func installModifiersChangedEventHandlerIfNeeded() {
+extension HotKeyCenter {
+    public func installModifiersChangedEventHandlerIfNeeded() {
         NSEvent.addGlobalMonitorForEvents(matching: .flagsChanged) { [weak self] event in
             self?.modifierEventHandler.handleModifiersEvent(with: event.modifierFlags, timestamp: event.timestamp)
         }

diff --git a/Lib/Magnet/KeyCombo.swift b/Lib/Magnet/KeyCombo.swift
@@ -12,7 +12,7 @@ import Cocoa
 import Carbon
 import Sauce
 
-public final class KeyCombo: NSObject, NSCopying, NSCoding, Codable {
+open class KeyCombo: NSObject, NSCopying, NSCoding, Codable {
 
     // MARK: - Properties
     public let key: Key
@@ -92,7 +92,7 @@ public final class KeyCombo: NSObject, NSCopying, NSCoding, Codable {
     }
 
     // MARK: - NSCoding
-    public init?(coder aDecoder: NSCoder) {
+    public required init?(coder aDecoder: NSCoder) {
         self.doubledModifiers = aDecoder.decodeBool(forKey: CodingKeys.doubledModifiers.rawValue)
         self.modifiers = aDecoder.decodeInteger(forKey: CodingKeys.modifiers.rawValue)
         guard !doubledModifiers else {
@@ -124,7 +124,7 @@ public final class KeyCombo: NSObject, NSCopying, NSCoding, Codable {
     }
 
     // MARK: - Codable
-    public init(from decoder: Decoder) throws {
+    public required init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         self.doubledModifiers = try container.decode(Bool.self, forKey: .doubledModifiers)
         self.modifiers = try container.decode(Int.self, forKey: .modifiers)
@@ -175,6 +175,6 @@ public final class KeyCombo: NSObject, NSCopying, NSCoding, Codable {
 }
 
 // MARK: - Error
-public extension KeyCombo {
-    struct InitializeError: Error {}
+extension KeyCombo {
+    public struct InitializeError: Error {}
 }
diff --git a/Lib/Magnet/ModifierEventHandler.swift b/Lib/Magnet/ModifierEventHandler.swift
@@ -10,7 +10,7 @@
 
 import Cocoa
 
-public final class ModifierEventHandler {
+open class ModifierEventHandler {
 
     // MARK: - Properties
     public var doubleTapped: ((NSEvent.ModifierFlags) -> Void)?
@@ -30,8 +30,8 @@ public final class ModifierEventHandler {
 }
 
 // MARK: - Handling
-public extension ModifierEventHandler {
-    func handleModifiersEvent(with modifierFlags: NSEvent.ModifierFlags, timestamp: TimeInterval) {
+extension ModifierEventHandler {
+    public func handleModifiersEvent(with modifierFlags: NSEvent.ModifierFlags, timestamp: TimeInterval) {
         guard lastHandledEventTimestamp != timestamp else { return }
         lastHandledEventTimestamp = timestamp