Merge pull request #53 from klassen-software-solutions/development/v5

Development/v5

Author: stevenklassen8376

Dependencies/prereqs-licenses.json

@@ -3,6 +3,6 @@
     "generated": {
         "process": "license-scanner",
         "project": "KSSCore",
-        "time": "2020-09-07T14:37:28.101098-06:00"
+        "time": "2020-09-11T17:45:47.870292-06:00"
     }
 }

Package.swift

@@ -6,7 +6,7 @@ import PackageDescription
 let package = Package(
     name: "KSSCore",
     platforms: [
-        .macOS(.v10_11),
+        .macOS(.v10_12),
         .iOS(.v13),
     ],
     products: [
@@ -17,7 +17,7 @@ let package = Package(
     targets: [
         .target(name: "KSSFoundation", dependencies: []),
         .target(name: "KSSTest", dependencies: []),
-        .testTarget(name: "KSSFoundationTests", dependencies: ["KSSFoundation"]),
+        .testTarget(name: "KSSFoundationTests", dependencies: ["KSSFoundation", "KSSTest"]),
         .testTarget(name: "KSSTestTests", dependencies: ["KSSTest"]),
     ]
 )

README.md

@@ -14,6 +14,23 @@ The modules provided by this package are the following:
 
  [API Documentation](https://www.kss.cc/apis/KSSCore/docs/index.html)
 
+ ## What Has Changed In Version 5
+ 
+ This was only going to be a minor change bringing us to V4.1, however the logging was becoming
+ more and more cumbersome due to the limitations is OSX pre 10.12. So we have made 10.12 the
+ new minimum for this library.
+ 
+ In addition this version includes the following:
+ 
+ * Made the XCTest extension for `expect` more general and removed the older version of the API.
+ * Added the ability to watch a file and obtain the change notifications. This is a wrapper around the
+ Apple Core Services, hence is not available on Linux.
+ * Added a simple version of `os_log` for Linux for internal use only. (So some items that were previously
+ logged in OSX and silent on Linux, are now logged on Linux as well.)
+ * Added an additional `duration` version that computes a duration from a given date. This is more 
+ accurate than the previous version, which still exists, which does not require a given date but uses
+ approximate values for the length of a month and year.
+ 
  ## What Has Changed In Version 4
 
  The primary change from version 3 to 4 is that all the UI related items have been removed

Sources/KSSFoundation/Duration.swift

@@ -6,25 +6,60 @@
 //  Copyright © 2020 Klassen Software Solutions. All rights reserved.
 //
 
+#if canImport(os)
+import os
+#endif
+
 import Foundation
 
 
 /**
  Create a duration of the given units and return it as a `TimeInterval.`
+ - warning: The resulting time interval will be approximate, using the assumptions described
+ for the `DurationUnit`.
  */
 public func duration(_ count: Double, _ unit: DurationUnit) -> TimeInterval {
     return count * unit.rawValue
 }
 
 
+/**
+ Create a duration of the given units and return it as a `TimeInterval.` This version creates a duration
+ assuming the given starting time and will take into account the correct calendar information in terms
+ of days of the month and so on. If the calendar cannot compute an appropriate interval, then `nil` is
+ returned.
+ - warning: This uses the user's current calendar for the computation. This may lead to slightly
+ different results for different calendars. For example, crossing daylight savings time gives answers
+ that differ by an hour for calendars that take daylight savings into account.
+ */
+public func duration(_ count: Int, _ unit: DurationUnit, from start: Date = Date()) -> TimeInterval? {
+    var component = DateComponents()
+    switch unit {
+    case .seconds:  component.second = count
+    case .minutes:  component.minute = count
+    case .hours:    component.hour = count
+    case .days:     component.day = count
+    case .weeks:    component.day = count * 7
+    case .months:   component.month = count
+    case .years:    component.year = count
+    }
+
+    guard let newDate = Calendar.current.date(byAdding: component, to: start) else {
+        os_log("warning: could not compute the requested interval, using an approximation")
+        return nil
+    }
+
+    return newDate.timeIntervalSince(start)
+}
+
 /**
  Enumeration to specify the unit of a given duration. The raw value of the enumeration is a TimeInterval
  that specifies the conversion from this unit into seconds.
 
  - warning:
  This conversion is only approximate and does not consider leap years or even the difference between
- months. For example, one year will always be considered 365 days and one month will always be considered
- 30 days. For more accurate durations you will need to use the `Date` and related classes directly.
+ months. Most of the time this will not matter, but if the more accurate conversion fails, these values will
+ be used as a fallback mechanism for generating the interval.
  */
 public enum DurationUnit: TimeInterval {
     /// Conversion of one second to a `TimeInterval`
@@ -38,7 +73,7 @@ public enum DurationUnit: TimeInterval {
 
     /// Conversion of one day to a `TimeInterval`
     case days = 86400.0
-    
+
     /// Conversion of one week to a `TimeInterval`
     case weeks = 604800.0
 

Sources/KSSFoundation/FileManagerExtension.swift

@@ -75,7 +75,6 @@ public extension FileManager {
         - withPrefix: A prefix that will be used for the directory name. Note that this is just the prefix
             of the directory, not the path that leads to the directory.
      */
-    @available(OSX 10.12, *)
     func createTemporaryDirectory(withPrefix prefix: String = "temp_") throws -> URL {
         let directoryName = prefix + UUID().uuidString
         let url = temporaryDirectory.appendingPathComponent(directoryName, isDirectory: true)