How wikipediabrown/napkin works
Project’s type and purpose
• Type: Open-source Swift Package + Xcode template repository
• Purpose:
– Provide a modular RIBs-style architecture (Builder, Router, Interactor, Presenter, DI) for Swift apps
– Supply Xcode file templates and an install script for rapid component generation
– Automate CI/CD (tests + releases) via GitHub Actions and Fastlane
File structure
• Sources/napkin – core framework code, subdivided into:
– Builder & ComponentizedBuilder modules (assembly of components)
– DI sub-module (Component, Dependency protocols)
– Interactor, PresentableInteractor (business logic)
– Router, LaunchRouter, ViewableRouter (navigation & view ownership)
– Presenter, ViewControllable (view-layer abstraction)
– LeakDetection (Executor, LeakDetector) – optional runtime leak hooks
– MultiStageComponentizedBuilder (advanced builder)
• Tools/napkin – Xcode template files + InstallXcodeTemplates.sh
• Tests/ – unit tests for framework
• .github/workflows – CI pipelines for Tests, ReleaseTests, Release
• fastlane/ – Fastlane configuration (unit_test lane)
• Package.swift, Gemfile – package & dependency management
Extract architecture hints from the README
• Uses Swift Package Manager, Combine instead of RxSwift
• Integrates with Xcode via custom file templates
• CI: GitHub Actions + Fastlane
• No external servers or databases—pure client-side library
Main components
A. Core Framework Module (napkin)
• Builder
• ComponentizedBuilder / MultiStageComponentizedBuilder
• DI system (Component, Dependency)
• Interactor / PresentableInteractor
• Router / LaunchRouter / ViewableRouter
• Presenter / ViewControllable
• LeakDetection (Executor, LeakDetector)
B. Xcode Template Tooling
• InstallXcodeTemplates.sh (CLI script)
• Template bundles under Tools/napkin (Launch, Component Extension, Service Manager, Unit Tests)
C. Testing Suite
• XCTest targets under Tests/napkinTests
D. CI/CD Pipelines
• GitHub Actions workflows (Tests.yml, ReleaseTests.yml, Release.yml)
• fastlane unit_test lane
Relationships & data flows
• At runtime (client app + napkin library):
• App invokes Builder → constructs Component graph via DI
• Router created by Builder → attaches Interactor + optional Presenter
• Interactor executes business logic, calls into Presenter → updates ViewControllable
• LeakDetector optionally monitors objects—communicates with Executor
• At development time:
• Developer runs InstallXcodeTemplates.sh → copies Templates to Xcode
• In Xcode: “New File” → custom napkin templates generate boilerplate Builder/Interactor/Router/View code
• At CI/CD time:
• Push to repo → GitHub Actions triggers Tests → builds & runs unit tests
• Merged release branch → triggers ReleaseTests + Release workflow
• fastlane can be invoked locally for multi-platform test runs
Architectural patterns & principles
• Modularization via RIBs-style components (single-responsibility modules)
• Dependency Injection (Component/Dependency protocols)
• Separation of Concerns: Builders (assembly), Interactors (business logic), Routers (navigation), Presenters (view logic), Views (UI)
• Extensibility: Multi-stage builders, customizable templates
Elements
• Clear labels on each major block and sub-block
– Builder → Component → Router → Interactor → Presenter → View
– Install script → Xcode → generated files
– CI trigger → workflows → test suites → release
– Rectangles for code modules