To Do List App

Minimalistic to do list app for iOS. You can add, update, delete and mark as done your tasks.

This design was inspired by Dribbble - To Do List (ucaly).

---

Development

Clone this repository and open ToDoList.xcodeproj with Xcode.

Setting API Keys

1. Make a file named Secrets.xcconfig in Resources directory below the Secrets.example.xcconfig.
2. Copy all contents of Secrets.example.xcconfig to Secrets.xcconfig.
3. Erase placeholder of the THE_DOG_API_KEY.
4. (Optional) Fill the THE_DOG_API_KEY with your API key. or leave it blank (THE_DOG_API_KEY is the API key for The Dog API)

---

Table of Contents

• Project Description
  • Directory Structure
  • Features
  • MVC Architecture
    • Model
    • View
    • Controller
  • Scenarios
• API References
  • Publishable
  • EventBus
  • WeakRef
  • Storage

Project Description

Directory Structure

ToDoList/
├── Resources/
├── Models/
├── ViewModels/
├── Services/
├── Views/
│  ├── EditTaskGroup/
│  ├── Shared/
│  ├── TaskGroup/
│  ├── TaskTable/
│  ├── Identifier.swift
│  └── RootView.swift
├── Controllers/
├── Utilities/
└── Info.plist

Features

• 할 일 그룹 생성/변경/삭제
• 할 일 생성/변경/삭제
• 할 일 순서 변경
• 할 일 그룹 진행률 표시 (원형 진행바, 애니메이션 적용)
• 할 일 그룹 별 랜덤 이미지 설정 (The Dog/Cat API)
• 할 일 그룹 별 색상 설정
• CollectionView / TableView 제공
• Color Theme 대응 (Light/Dark)

MVC Architecture

해당 프로젝트는 Model - View - Controller 패턴을 적용하여 구현했습니다.

Model

• 자료구조 및 클래스를 가지고 있는 Model과 ViewModel, 그리고 비즈니스 로직을 가진 Service입니다.
• Models: Codable 프로토콜을 채택한 자료구조를 가집니다. Storage에서 데이터를 불러오고 내보내기 위해 사용합니다.
• ViewModels: Model의 데이터를 가공하여 View에게 전달합니다.
  • Publishable을 적용하여 구독자에게 변경사항을 알립니다.
• Services: 비즈니스 로직을 담당합니다.
  • APIService: 네트워크 관련 로직을 담당합니다.
  • TaskService: ViewModels 데이터를 관리합니다.

View

• View는 사용자에게 보여지는 UI를 구성합니다.
• RootView
  • Controller와 1:1 관계로 연결되는 View입니다. TypedViewController에게 전달됩니다.
  • 프로토콜로서 initializeUI()를 필수로 구현해야 합니다.
• 그 외 View는 RootView에서 사용하는 하위 View입니다.
• Model의 변경사항을 구독하고 있으며, 구독 중인 속성이 변경되면 UI를 변경합니다. (Publishable)
• 특정 이벤트가 발생하면 Controller에게 이를 알립니다. (EventBus)

Controller

• Controller는 View를 생성하고 연결합니다. 연결된 View는 typedView 속성을 통해 접근할 수 있습니다.
• EventBus에 View에서 발생하는 모든 이벤트를 등록합니다. (ViewControllerEvents, RootViewController)
• 등록된 이벤트가 발생했을 때 Model에게 데이터 변경을 요청할 수 있습니다.

Scenarios

사용자가 앱을 접속했을 때

---
title: MVC Architecture Sequence Diagram
---

sequenceDiagram

participant User
participant Controller
participant View
participant Model
participant Storage

Note over Model: Publishable

autonumber

User->>Controller: Open app & Request UI
Controller->>View: Create & Connect (1:1 Relationship)
View->>Model: Subscribe data changes
Storage-->>Model: Load data (if exists)
Controller->>+Model: Request data
Model->>Model: Processing (to cause changes)
Model-->>-View: Publish data
View->>Controller: Build UI
Controller->>User: Display

1. User가 앱을 실행하고 UI를 요청하면,
   1. Controller가 View를 생성하고 자신에게 연결합니다. (TypedViewController)
   2. View를 생성하는 단계에서 Model의 변경사항을 구독합니다. (Publishable)
   3. Storage로부터 데이터를 불러와 Model을 준비합니다.
2. Controller는 UI를 그리기 위해 필요한 데이터를 Model에 요청합니다.
3. Model은 필요한 데이터를 정리하여 View에게 발행합니다. View는 이를 토대로 UI를 구축합니다.
4. View와 연결된 Controller를 통해서 사용자에게 UI를 보여줍니다.

사용자가 UI를 조작했을 때

---
title: MVC Architecture Sequence Diagram
---

sequenceDiagram

participant User
participant View
participant EventBus
participant Controller
participant Model
participant Storage

Note over Model: Publishable

autonumber

Controller->>EventBus: Register callback for events
User->>View: Do specific actions
View->>+EventBus: Emit events (with data)
EventBus-->>-Controller: Run callback for the event
Controller->>+Model: Request CRUD
Model->>Model: Processing (to cause changes)
Model-->>Storage: Save data (if exists)
Model-->>-View: Publish changes with data
View->>User: Update UI & Display

1. Controller가 생성되는 과정에서 특정 이벤트에 실행할 동작을 정의합니다. (EventBus)
2. User가 View를 통해 특정 행동을 수행하면 EventBus에 등록된 이벤트를 발행합니다.
3. 해당 이벤트를 구독 중인 Controller는 이벤트를 받아 데이터 생성/변경/삭제를 Model에게 요청합니다.
4. Model은 요청에 맞게 데이터를 적절히 처리한 후, 변환하여 Storage에 저장합니다.
5. Model은 변경사항을 데이터와 함께 구독 중인 View에게 알립니다. View는 이를 토대로 UI를 변경합니다.
6. View와 연결된 Controller를 통해서 사용자에게 UI를 보여줍니다.

API References

Publishable

속성값의 변경사항을 구독자에게 자동으로 알려주는 Property Wrapper 클래스입니다.

내부적으로 self에 대한 참조를 WeakRef로 관리하고 있으므로, 메모리 해제 시 자동으로 구독을 해제합니다.

API

• Publishable: 값의 변화를 구독자에게 알려주는 Property Wrapper 클래스입니다.
• Publisher: 발행자를 나타냅니다. Publishable을 적용한 속성의 타입입니다.
• Subscriber: 구독자를 나타냅니다. Publishable을 구독하는 타입입니다.
• Changes: 값의 변화를 나타냅니다. 변경이전 값 old와 변경된 값 new를 가집니다.

/// 구독자를 추가합니다. (immediate을 true로 설정하면 구독 즉시 이벤트를 발행합니다)
/// 이미 구독 중인 경우, 기존 구독을 취소하고 새로운 구독을 추가합니다.
func subscribe<Subscriber>(by: Subscriber, immediate: Bool, EventCallback<Subscriber>)

/// 주어진 구독자의 구독을 취소합니다.
func unsubscribe<Subscriber>(by: Subscriber)

/// 구독자에게 변경 사항을 발행합니다. nil을 전달하면 현재 값으로 발행합니다.
func publish(Changes?)

Example

final class MyModel {
    @Publishable var name: String

    init(name: String) {
        self.name = name
    }
}

final class Main {
    static let shared = Main()
    private init() {}

    func run() {
        let model = MyModel(name: "Old Model")

        model.$name.subscribe(by: self, immediate: true) { (subscriber, changes) in
            // 강한 순환 참조를 피하기 위해 self 대신 subscriber를 사용합니다.
            print("Old Name: \(changes.old), New Name: \(changes.new)")
        }
        
        model.name = "New Model"  // 구독자에게 변경을 알립니다.
    }
}

Main.shared.run()

// 출력 결과
// Old Name: Old Model, New Name: Old Model
// Old Name: Old Model, New Name: New Model

EventBus

이벤트를 관리하며, 구독 및 발행 기능을 제공합니다. 이벤트 기반의 프로그래밍 패턴을 제공합니다.

내부적으로 self에 대한 참조를 WeakRef로 관리하고 있으므로, 메모리 해제 시 자동으로 구독을 해제합니다.

API

• EventBus: 이벤트를 구독 및 발행할 수 있는 싱글턴 클래스입니다.
• EventProtocol: 이벤트를 나타내는 프로토콜입니다. Payload 연관 타입을 가집니다.
• Emitter: 이벤트를 발행할 수 있는 타입입니다.
• Listener: 이벤트를 구독할 수 있는 타입입니다.

/// 주어진 이벤트를 구독합니다.
func on<Listener, Event: EventProtocol>(Event.Type, by: Listener, EventCallback<Listener, Event>) 

/// 주어진 구독자의 이벤트 구독을 취소합니다.
func off<Listener, Event: EventProtocol>(Event, by: Listener) 

/// 주어진 구독자의 모든 구독을 취소합니다.
func reset<Listener>(Listener)

/// 주어진 이벤트를 발행합니다.
func emit<Event: EventProtocol>(Event) 

Example

final class Main {
    static let shared = Main()
    private init() {}
    
    func run() {
        struct MyEvent: EventProtocol {
            struct Payload {
                let text: String
            }

            let payload: Payload
        }

        // 이벤트 구독
        EventBus.shared.on(MyEvent.self, by: self) { (listener, payload) in
            // 강한 순환 참조를 피하기 위해 self 대신 listener를 사용합니다.
            print("Payload: \(payload.text)")
        }

        // 이벤트 발행
        EventBus.shared.emit(MyEvent(payload: .init(text: "Hello, World!")))
    }
}

Main.shared.run()

// 출력 결과
// Payload: Hello, World!

WeakRef

weak 참조를 감싸는 구조체입니다.

struct WeakRef<T: AnyObject> {
    weak var value: T?
    init(_ value: T?) {
        self.value = value
    }
}

Storage

데이터를 (영속적으로) 저장하고, 불러오는 기능을 제공하는 타입이 채택하는 프로토콜입니다.

현재 UserDefaultsStorage를 제공합니다.

protocol Storage {
    static var shared: Self { get }

    func save<T: Encodable>(_ object: T, forKey key: String)
    func load<T: Decodable>(forKey key: String) -> T?
    func remove(forKey key: String)
}