Support inbox zero fixed holidays (#2629)

Author: viktorasl

Classes/Systems/InboxZeroLoader.swift

@@ -11,7 +11,7 @@ import Foundation
 final class InboxZeroLoader {
 
     // [year/"fixed": [month: [day: [key:value]]]
-    private typealias SerializedType = [String: [String: [String: [String: String]]]]
+    typealias SerializedType = [String: [String: [String: [String: String]]]]
     private let path: String = {
         let path = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true)[0]
         return "\(path)/holidays.json"
@@ -34,6 +34,10 @@ final class InboxZeroLoader {
             ]).url
     }
 
+    init(json: SerializedType? = nil) {
+        json.flatMap { self.json = $0 }
+    }
+
     func load(completion: @escaping (Bool) -> Void) {
         guard let url = self.url else {
             completion(false)
@@ -62,6 +66,14 @@ final class InboxZeroLoader {
         return ("🎉", NSLocalizedString("Inbox zero!", comment: ""))
     }
 
+    // either key on the current year or "fixed" (for permanent dates)
+    private func holiday(year: Int, month: Int, day: Int) -> [String: String]? {
+        let holidays: (String) -> [String: String]? = {
+            return self.json[$0]?["\(month)"]?["\(day)"]
+        }
+        return holidays("\(year)") ?? holidays("fixed")
+    }
+
     func message(date: Date = Date()) -> (emoji: String, message: String) {
         let components = Calendar.current.dateComponents([.day, .month, .year], from: date)
         guard let day = components.day,
@@ -70,12 +82,9 @@ final class InboxZeroLoader {
                 return fallback
         }
 
-        // either key on the current year or "fixed" (for permanent dates)
-        if let yearData = json["\(year)"] ?? json["fixed"],
-            let monthData = yearData["\(month)"],
-            let data = monthData["\(day)"],
-            let emoji = data["emoji"],
-            let message = data["message"] {
+        if let holiday = holiday(year: year, month: month, day: day),
+            let emoji = holiday["emoji"],
+            let message = holiday["message"] {
             return (emoji, message)
         }
         return fallback

Freetime.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		03C127B8220993300062F7C9 /* InboxZeroLoaderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03C127B7220993300062F7C9 /* InboxZeroLoaderTests.swift */; };
 		0F9440FD32236514CD7215E9 /* Pods_Freetime.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = ECF622FFD773FDA73297C0D0 /* Pods_Freetime.framework */; };
 		15F28F992108DBA6006421B6 /* SplashView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 15F28F982108DBA6006421B6 /* SplashView.swift */; };
 		290056F3210028B20046EAE5 /* UIViewController+MenuDone.swift in Sources */ = {isa = PBXBuildFile; fileRef = 290056F2210028B20046EAE5 /* UIViewController+MenuDone.swift */; };
@@ -593,6 +594,8 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		03A0EC6221F8F60B008C9CE2 /* RepositoryOverviewHeaderViewModels.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RepositoryOverviewHeaderViewModels.swift; sourceTree = "<group>"; };
+		03C127B7220993300062F7C9 /* InboxZeroLoaderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InboxZeroLoaderTests.swift; sourceTree = "<group>"; };
 		07C7DC5A7A907BE73BCA95AC /* Pods-FreetimeTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-FreetimeTests.debug.xcconfig"; path = "Pods/Target Support Files/Pods-FreetimeTests/Pods-FreetimeTests.debug.xcconfig"; sourceTree = "<group>"; };
 		0F26A46A43D11F8D04E17D4A /* Pods-FreetimeWatch Extension.testflight.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-FreetimeWatch Extension.testflight.xcconfig"; path = "Pods/Target Support Files/Pods-FreetimeWatch Extension/Pods-FreetimeWatch Extension.testflight.xcconfig"; sourceTree = "<group>"; };
 		15F28F982108DBA6006421B6 /* SplashView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SplashView.swift; sourceTree = "<group>"; };
@@ -1744,6 +1747,7 @@
 				295F52A61EF1B9D2000B53CF /* Test.md */,
 				291E987C21973FA700E5EED9 /* URLBuilderTests.swift */,
 				29827D7321AA5DA300A1B293 /* ViewControllerTestUtil.swift */,
+				03C127B7220993300062F7C9 /* InboxZeroLoaderTests.swift */,
 			);
 			path = FreetimeTests;
 			sourceTree = "<group>";
@@ -3425,6 +3429,7 @@
 				DC60C6D51F983DF800241271 /* IssueLabelCellTests.swift in Sources */,
 				49FE18FF204B6508001681E8 /* SequenceTests.swift in Sources */,
 				DC5C02C31F9C6D0B00E80B9F /* SearchRecentStoreTests.swift in Sources */,
+				03C127B8220993300062F7C9 /* InboxZeroLoaderTests.swift in Sources */,
 				9870B9081FC74E300009719C /* SecretsTests.swift in Sources */,
 				29EDFE7C1F65C580005BCCEB /* SplitViewTests.swift in Sources */,
 				2986B35E1FD462AA00E3CFC6 /* FilePathTests.swift in Sources */,

FreetimeTests/InboxZeroLoaderTests.swift

@@ -0,0 +1,77 @@
+//
+//  InboxZeroLoaderTests.swift
+//  FreetimeTests
+//
+//  Created by Viktoras Laukevicius on 05/02/2019.
+//  Copyright © 2019 Ryan Nystrom. All rights reserved.
+//
+
+import XCTest
+@testable import Freetime
+
+extension Date {
+    static func date(from: [Calendar.Component : Int]) -> Date {
+        var dc = DateComponents()
+        dc.calendar = Calendar.current
+        for (comp, val) in from {
+            switch comp {
+            case .year: dc.year = val
+            case .month: dc.month = val
+            case .day: dc.day = val
+            case .hour: dc.hour = val
+            case .minute: dc.minute = val
+            case .second: dc.second = val
+            default: break
+            }
+        }
+        return dc.date!
+    }
+}
+
+class InboxZeroLoaderTests: XCTestCase {
+
+    private var loader: InboxZeroLoader!
+
+    override func setUp() {
+        loader = InboxZeroLoader(json: [
+            "2019": [
+                "2": [
+                    "5": [
+                        "emoji": "🐷",
+                        "message": "新年好 / 新年好"
+                    ]
+                ]
+            ],
+            "fixed": [
+                "4": [
+                    "1": [
+                        "emoji": "🤡",
+                        "message": "Inbox ∞"
+                    ]
+                ]
+            ]
+        ])
+    }
+
+    override func tearDown() {
+        loader = nil
+    }
+
+    func test_particularDate() {
+        let date = Date.date(from: [.year: 2019, .month: 4, .day: 1, .hour: 13])
+        let message = loader.message(date: date)
+        XCTAssertEqual(message.emoji, "🤡")
+    }
+
+    func test_fixedDate() {
+        let date = Date.date(from: [.year: 2019, .month: 2, .day: 5, .hour: 13])
+        let message = loader.message(date: date)
+        XCTAssertEqual(message.emoji, "🐷")
+    }
+
+    func test_defaultMessage() {
+        let date = Date.date(from: [.year: 2019, .month: 4, .day: 2, .hour: 13])
+        let message = loader.message(date: date)
+        XCTAssertEqual(message.emoji, "🎉")
+    }
+}