✨ Filter for calendar sources

Author: Oliver Schrenk

Sources/Cli/Main.swift

@@ -13,6 +13,8 @@ enum Main {
     let calendarFilter = CalendarFilter.build(
       selectCalendars: opts.selectCalendars,
       ignoreCalendars: opts.ignoreCalendars,
+      selectCalendarSources: opts.selectCalendarSources,
+      ignoreCalendarSources: opts.ignoreCalendarSources,
       selectCalendarTypes: opts.selectCalendarTypes,
       ignoreCalendarTypes: opts.ignoreCalendarTypes
     )

Sources/Cli/SharedOptions.swift

@@ -30,6 +30,16 @@ struct SharedOptions: ParsableArguments {
     valueName: "v"
   )) var ignoreCalendars: [String] = []
 
+  @Option(help: ArgumentHelp(
+    "Select calendar sources <s>. A comma separated list of calendar sources",
+    valueName: "s"
+  )) var selectCalendarSources: [String] = []
+
+  @Option(help: ArgumentHelp(
+    "Ignore calendar sources <s>. A comma separated list of calendar sources",
+    valueName: "s"
+  )) var ignoreCalendarSources: [String] = []
+
   @Option(help: ArgumentHelp(
     "Select calendar types <v>. A comma separated list of calendar types. " +
       "Available: [local|caldav|exchange|subscription|birthday]",

Sources/Filters/CalendarFilter.swift

@@ -36,6 +36,37 @@ class CalendarFilter {
     }
   }
 
+  static func selectSources(sources: [String]) -> ((PlanCalendar?) -> Bool) {
+    { calendar in
+      // if no selection, allow everything
+      if sources.isEmpty {
+        return true
+      }
+      // if event has no valid calendar, don't show
+      if calendar == nil {
+        return false
+      }
+
+      return sources.contains(calendar!.source)
+    }
+  }
+
+  static func ignoreSources(sources: [String]) -> ((PlanCalendar?) -> Bool) {
+    { calendar in
+      // if no selection, allow everything
+      if sources.isEmpty {
+        return true
+      }
+
+      // if event has no valid calendar, don't show
+      if calendar == nil {
+        return false
+      }
+
+      return !sources.contains(calendar!.source)
+    }
+  }
+
   static func selectTypes(types: [EKCalendarType]) -> ((PlanCalendar?) -> Bool) {
     { calendar in
       // if no selection, allow everything
@@ -79,6 +110,8 @@ class CalendarFilter {
   static func build(
     selectCalendars: [String] = [],
     ignoreCalendars: [String] = [],
+    selectCalendarSources: [String] = [],
+    ignoreCalendarSources: [String] = [],
     selectCalendarTypes: [EKCalendarType] = [],
     ignoreCalendarTypes: [EKCalendarType] = []
   ) -> ((PlanCalendar) -> Bool) {
@@ -96,6 +129,18 @@ class CalendarFilter {
       Log.write("added filter before: ignoreCalendars(\(ignoreCalendars))")
     }
 
+    if !selectCalendarSources.isEmpty {
+      let f: (PlanCalendar) -> Bool = CalendarFilter.selectSources(sources: selectCalendarSources)
+      filters.append(f)
+      Log.write("added filter before: selectSources(\(selectCalendarSources))")
+    }
+
+    if !ignoreCalendarSources.isEmpty {
+      let f: (PlanCalendar) -> Bool = CalendarFilter.ignoreSources(sources: ignoreCalendarSources)
+      filters.append(f)
+      Log.write("added filter before: ignoreSources(\(ignoreCalendarSources))")
+    }
+
     if !selectCalendarTypes.isEmpty {
       let sct: (PlanCalendar) -> Bool = CalendarFilter.selectTypes(types: selectCalendarTypes)
       filters.append(sct)

Tests/CalendarFilterTest.swift

@@ -4,10 +4,12 @@ import EventKit
 import XCTest
 
 final class CalendarFilterTests: XCTestCase {
-  private func genCalendar(type: EKCalendarType = EKCalendarType.calDAV) -> PlanCalendar {
+  private func genCalendar(
+    type: EKCalendarType = EKCalendarType.calDAV,
+    source: String = "Test"
+  ) -> PlanCalendar {
     let id = "5E28ECB5-A07D-4FC8-82E4-5F37C38C786F"
     let label = "Test"
-    let source = "Test"
     let color = "#FFB3E4"
 
     return PlanCalendar(
@@ -59,6 +61,49 @@ final class CalendarFilterTests: XCTestCase {
     XCTAssertEqual(actual, expected, "The calendar was not accepted")
   }
 
+  func testIgnoreCalendarSourcesMatching() {
+    let source = "Personal"
+    let calendar = genCalendar(source: source)
+    let expected = false
+    let actual = CalendarFilter.ignoreSources(sources: [source])(calendar)
+
+    XCTAssertEqual(actual, expected, "The calendar was accepted")
+  }
+
+  func testIgnoreCalendarSourcesEmptyArray() {
+    let calendar = genCalendar()
+    let expected = true
+    let actual = CalendarFilter.ignoreSources(sources: [])(calendar)
+
+    XCTAssertEqual(actual, expected, "The calendar was rejected")
+  }
+
+  func testSelectCalendarSourcesMatching() {
+    let source = "Personal"
+    let calendar = genCalendar(source: source)
+    let expected = true
+    let actual = CalendarFilter.selectSources(sources: [source])(calendar)
+
+    XCTAssertEqual(actual, expected, "The calendar was rejected")
+  }
+
+  func testSelectCalendarSourcesNotMatching() {
+    let source = "Personal"
+    let calendar = genCalendar(source: source)
+    let expected = false
+    let actual = CalendarFilter.selectSources(sources: ["not-existing"])(calendar)
+
+    XCTAssertEqual(actual, expected, "The calendar was accepted")
+  }
+
+  func testSelectCalendarSourcesEmptyArray() {
+    let calendar = genCalendar()
+    let expected = true
+    let actual = CalendarFilter.selectSources(sources: [])(calendar)
+
+    XCTAssertEqual(actual, expected, "The calendar was rejected")
+  }
+
   func testIgnoreCalendarTypesMatching() {
     let type = EKCalendarType.birthday
     let calendar = genCalendar(type: type)