meta/Sources/Model/Extensions/Array.swift

//
//  Array.swift
//  Meta
//
//  Created by david-swift on 26.05.24.
//

import Foundation

/// Extend arrays.
extension Array: AnyView where Element == AnyView {

    /// The array's view body is the array itself.
    public var viewContent: Body { self }

    /// Get a widget from a collection of views.
    /// - Parameters:
    ///     - data: Modify views before being updated.
    ///     - type: The app storage type.
    /// - Returns: A widget.
    public func widget<Data>(
        data: WidgetData,
        type: Data.Type
    ) -> Widget where Data: ViewRenderData {
        if count == 1, let widget = self[safe: 0]?.widget(data: data, type: type) {
            return widget
        } else {
            var modified = self
            for (index, view) in modified.enumerated() {
                modified[safe: index] = view.getModified(data: data, type: type)
            }
            return Data.WrapperType { modified }
        }
    }

    /// Update a collection of views with a collection of view storages.
    /// - Parameters:
    ///     - storages: The collection of view storages.
    ///     - data: Modify views before being updated.
    ///     - updateProperties: Whether to update properties.
    ///     - type: The view render data type.
    public func update<Data>(
        _ storages: [ViewStorage],
        data: WidgetData,
        updateProperties: Bool,
        type: Data.Type
    ) async where Data: ViewRenderData {
        for (index, element) in filter({ $0.renderable(type: type, data: data) }).enumerated() {
            if let storage = storages[safe: index] {
                await element
                    .widget(data: data, type: type)
                    .updateStorage(storage, data: data, updateProperties: updateProperties, type: type)
            }
        }
    }

    /// Get the view storages of a collection of views.
    /// - Parameters:
    ///     - data: Modify views before generating the storages.
    ///     - type: The view render data type.
    /// - Returns: The storages.
    public func storages<Data>(
        data: WidgetData,
        type: Data.Type
    ) async -> [ViewStorage] where Data: ViewRenderData {
        await compactMap { view in
            await view.renderable(type: type, data: data) ? view.storage(data: data, type: type) : nil
        }
    }

}

/// Extend arrays.
extension Array {

    /// Accesses the element at the specified position safely.
    /// - Parameters:
    ///   - index: The position of the element to access.
    ///
    ///   Access and set elements the safe way:
    ///   ```swift
    ///   var array = ["Hello", "World"]
    ///   print(array[safe: 2] ?? "Out of range")
    ///   ```
    public subscript(safe index: Int?) -> Element? {
        get {
            if let index, indices.contains(index) {
                return self[index]
            }
            return nil
        }
        set {
            if let index, let value = newValue, indices.contains(index) {
                self[index] = value
            }
        }
    }

    /// Returns the first element of the sequence that satisfies the given predicate.
    /// - Parameter predicate: A closure that takes an element of the sequence as its argument
    /// and returns a Boolean value indicating whether the element is a match.
    /// - Returns: The first element of the sequence that satisfies `predicate`,
    /// or `nil` if there is no element that satisfies `predicate`.
    public func first(where predicate: (Element) async throws -> Bool) async rethrows -> Element? {
        for element in self {
            let matches = try await predicate(element)
            if matches {
                return element
            }
        }
        return nil
    }

    /// Returns the last element of the sequence that satisfies the given predicate.
    /// - Parameter predicate: A closure that takes an element of the sequence as its argument
    /// and returns a Boolean value indicating whether the element is a match.
    /// - Returns: The last element of the sequence that satisfies `predicate`,
    /// or `nil` if there is no element that satisfies `predicate`.
    public func last(where predicate: (Element) async throws -> Bool) async rethrows -> Element? {
        try await reversed().first(where: predicate)
    }

    /// Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
    /// - Parameter predicate: A closure that takes an element of the sequence as its argument
    /// and returns a Boolean value indicating whether the element is a match.
    /// - Returns: Whether the sequence contains an element that satisfies `predicate`.
    public func contains(where predicate: (Element) async throws -> Bool) async rethrows -> Bool {
        try await first(where: predicate) != nil
    }

    /// Returns an array containing the results of mapping the given closure over the sequence’s elements.
    /// Remove elements that are `nil`.
    /// - Parameter transform: Transforms each element.
    /// - Returns: The result.
    public func compactMap<ElementOfResult>(
        _ transform: (Element) async throws -> ElementOfResult?
    ) async rethrows -> [ElementOfResult] {
        var result: [ElementOfResult] = []
        for element in self {
            if let element = try await transform(element) {
                result.append(element)
            }
        }
        return result
    }

    /// Returns an array containing the results of mapping the given closure over the sequence’s elements.
    /// - Parameter transform: Transforms each element.
    /// - Returns: The result.
    public func map<ElementOfResult>(
        _ transform: (Element) async throws -> ElementOfResult
    ) async rethrows -> [ElementOfResult] {
        try await compactMap { try await transform($0) }
    }

}

/// Extend arrays.
extension Array where Element: Identifiable {

    /// Accesses the element with a certain id safely.
    /// - Parameters:
    ///   - id: The child's id.
    ///
    ///   Access and set elements the safe way:
    ///   ```swift
    ///   var array = ["Hello", "World"]
    ///   print(array[safe: 2] ?? "Out of range")
    ///   ```
    public subscript(id id: Element.ID) -> Element? {
        self[safe: firstIndex { $0.id == id }]
    }

}