[feat]: better error description & ...

Author: DanielCech

Sources/ScriptToolkit/NSColorExtension.swift

@@ -9,7 +9,7 @@ import Foundation
 import AppKit
 
 public extension NSColor {
-    convenience init(hexString: String) {
+    convenience init?(hexString: String) {
         let hexString = hexString.trimmingCharacters(in: .whitespacesAndNewlines)
         let scanner = Scanner(string: hexString)
 
@@ -18,7 +18,7 @@ public extension NSColor {
         }
 
         var color: UInt32 = 0
-        scanner.scanHexInt32(&color)
+        guard scanner.scanHexInt32(&color) else { return nil }
 
         let mask = 0x000000FF
         let r = Int(color >> 16) & mask

Sources/ScriptToolkit/NSImageExtension.swift

@@ -93,7 +93,7 @@ public extension NSImage {
         return finalResult
     }
 
-    func image(withText text: String, attributes: [NSAttributedString.Key: Any]) -> NSImage {
+    func image(withText text: String, attributes: [NSAttributedString.Key: Any], position: CGFloat) -> NSImage {
         let image = self
         let text = text as NSString
         let options: NSString.DrawingOptions = [.usesLineFragmentOrigin, .usesFontLeading]
@@ -102,7 +102,7 @@ public extension NSImage {
 
         let x = (image.size.width - textSize.width) / 2
         let y = (image.size.height - textSize.height) / 2
-        let point = NSMakePoint(x, y * 0.2)
+        let point = NSMakePoint(x, y * position)
 
         image.lockFocus()
         text.draw(at: point, withAttributes: attributes)
@@ -111,25 +111,29 @@ public extension NSImage {
         return image
     }
 
-    func annotate(text: String, size: CGFloat, fill: NSColor, stroke: NSColor) -> NSImage {
+    func annotate(text: String, font: String, size: CGFloat, position: CGFloat, fill: NSColor, stroke: NSColor, strokeWidth: CGFloat) throws -> NSImage {
+
+        guard let titleFont = NSFont(name: font, size: size) else { throw ScriptError.argumentError(message: "Unable to find font \(font)") }
 
         // Solid color text
         let fillText = image(
             withText: text,
             attributes: [
                 .foregroundColor: fill,
-                .font: NSFont(name: "Impact", size: size)!
-            ])
+                .font: titleFont
+            ],
+            position: position)
 
         // Add strokes
         return fillText.image(
             withText: text,
             attributes: [
-                .foregroundColor: fill,
+                .foregroundColor: NSColor.clear,
                 .strokeColor: stroke,
-                .strokeWidth: 1,
-                .font: NSFont(name: "Impact", size: size)!
-            ])
+                .strokeWidth: strokeWidth * size,
+                .font: titleFont
+            ],
+            position: position)
     }
 }
 

Sources/ScriptToolkit/ScriptError.swift

@@ -0,0 +1,62 @@
+//
+//  ScriptError.swift
+//  ScriptToolkit
+//
+//  Created by Dan on 06.03.2019.
+//
+
+import Foundation
+import Moderator
+
+public protocol PrintableError {
+    var errorDescription: String { get }
+}
+
+public enum ScriptError: Error {
+    case generalError(message: String)
+    case fileExists(message: String)
+    case fileNotFound(message: String)
+    case folderExists(message: String)
+    case folderNotFound(message: String)
+    case argumentError(message: String)
+    case moreInfoNeeded(message: String)
+}
+
+extension ScriptError: PrintableError {
+    public var errorDescription: String {
+        let prefix = "💥 error: "
+        var errorDescription = ""
+
+        switch self {
+        case let .generalError(message):
+            errorDescription = message
+
+        case let .fileExists(message):
+            errorDescription = "file exists: \(message)"
+
+        case let .fileNotFound(message):
+            errorDescription = "file not found: \(message)"
+
+        case let .folderExists(message):
+            errorDescription = "folder exists: \(message)"
+
+        case let .folderNotFound(message):
+            errorDescription = "folder not found: \(message)"
+
+        case let .argumentError(message):
+            errorDescription = "invalid argument: \(message)"
+
+        case let .moreInfoNeeded(message):
+            errorDescription = "more info needed: \(message)"
+        }
+
+        return prefix + errorDescription
+    }
+}
+
+
+extension ArgumentError: PrintableError {
+    public var errorDescription: String {
+        return "💥 error: \(errormessage)"
+    }
+}

Sources/ScriptToolkit/ScriptToolkit.swift

@@ -9,45 +9,6 @@ import Foundation
 import Files
 import SwiftShell
 
-public enum ScriptError: Error, CustomStringConvertible {
-    case generalError(message: String)
-    case fileExists(message: String)
-    case fileNotFound(message: String)
-    case folderExists(message: String)
-    case folderNotFound(message: String)
-    case argumentError(message: String)
-    case moreInfoNeeded(message: String)
-
-    public var description: String {
-        let prefix = "💥 error: "
-        var errorDescription = ""
-
-        switch self {
-        case let .generalError(message):
-            errorDescription = message
-
-        case let .fileExists(message):
-            errorDescription = "file exists: \(message)"
-
-        case let .fileNotFound(message):
-            errorDescription = "file not found: \(message)"
-
-        case let .folderExists(message):
-            errorDescription = "folder exists: \(message)"
-
-        case let .folderNotFound(message):
-            errorDescription = "folder not found: \(message)"
-
-        case let .argumentError(message):
-            errorDescription = "invalid argument: \(message)"
-
-        case let .moreInfoNeeded(message):
-            errorDescription = "more info needed: \(message)"
-        }
-
-        return prefix + errorDescription
-    }
-}
 
 public struct ScriptToolkit {