# marcrespass/buildsettingextractor architecture

> Architecture diagram of the GitHub repository marcrespass/buildsettingextractor, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/marcrespass/buildsettingextractor
- Repository: https://github.com/marcrespass/buildsettingextractor

## Overview

##### Project type and purpose
- This is a macOS desktop utility (AppKit) written in Objective-C whose sole purpose is to extract Xcode build settings from a dropped `.xcodeproj` file and emit `.xcconfig` files. It includes a GUI (main window + preferences), core processing components, and a test bundle.

##### Top-level components
- BuildSettingExtractor.xcodeproj (Xcode project file)
- BuildSettingExtractor/ (AppKit source & assets)
- Preferences/ (Preferences window UI & controllers)
- Config/ (xcconfig files used to build this utility)
- BuildSettingExtractorTests/ (unit tests & test fixtures)

##### Main architectural layers & components
a. User Interface Layer (blue)
- MainWindow.xib + DragFileView
- AppDelegate (wires up drag/drop)
- Preferences.storyboard + PreferencesViewController + sub-controllers

b. Core Extraction Layer (green)
- BuildSettingExtractor (entry point for extraction logic)
- BuildSettingInfoSource (reads `project.pbxproj` + `BuildSettingInfoSubpaths.plist`)
- BuildSettingCommentGenerator (formats comments for each setting)
- SampleFileStructureGenerator (used in Preferences preview)

c. Persistence / File I/O Layer (orange)
- Destination folder I/O: writing shared & per-target `.xcconfig` files
- UserDefaults (stores preferences from PreferencesViewController)

d. Test Layer (gray)
- BuildSettingExtractorTests.m (exercise extraction on sample `.xcodeproj.test` files)
- TestFiles folder with malformed/good project fixtures

##### Relationships & data flow
1. User drags a `.xcodeproj` onto the Main Window (DragFileView)
2. AppDelegate intercepts the drop, invokes BuildSettingExtractor
3. BuildSettingExtractor reads project file via BuildSettingInfoSource
4. For each target / configuration:
– BuildSettingInfoSource yields raw build settings
– BuildSettingCommentGenerator prepends descriptive comments
– File I/O layer writes out shared & per-configuration `.xcconfig` files
5. Preferences subsystem supplies user-configured options (via UserDefaults) to the Extraction Layer (e.g., toggle comments on/off, grouping behavior)
6. Tests import the BuildSettingExtractor module, feed it test projects, and assert expected generated output

##### Architectural patterns & principles
- MVC-ish separation in the UI: XIBs/Storyboards + Controllers + AppDelegate as coordinator
- Single Responsibility:
- BuildSettingExtractor orchestrates workflow
- InfoSource handles project parsing
- CommentGenerator handles formatting
- Dependency injection: Preferences state injected into core components
- Testability: core logic is decoupled from UI for unit testing

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User
    User(["User"]):::external

    %% UI Layer
    subgraph "User Interface Layer"
        direction TB
        MainMenu["Main Window UI\n(MainMenu.xib + DragFileView)"]:::ui
        DragFileView["DragFileView"]:::ui
        AppDelegate["AppDelegate"]:::ui
        subgraph "Preferences UI"
            direction TB
            PreferencesStoryboard["Preferences.storyboard"]:::ui
            PreferencesVC["PreferencesViewController"]:::ui
            ContentsPrefVC["ContentsPreferencesViewController"]:::ui
            FileLayoutPrefVC["FileLayoutPreferencesViewController"]:::ui
        end
        Assets["Assets.xcassets"]:::ui
    end

    %% Core Extraction Layer
    subgraph "Core Extraction Layer"
        direction TB
        BuildExtractor["BuildSettingExtractor"]:::core
        InfoSource["BuildSettingInfoSource"]:::core
        CommentGen["BuildSettingCommentGenerator"]:::core
        SampleStructGen["SampleFileStructureGenerator"]:::core
    end

    %% Persistence / File I/O Layer
    subgraph "Persistence / File I/O Layer"
        direction TB
        FileIO[".xcconfig File I/O"]:::persistence
        UserDefaults["UserDefaults"]:::persistence
        Filesystem[(Filesystem)]:::persistence
    end

    %% Test Layer
    subgraph "Test Layer"
        direction TB
        Tests["BuildSettingExtractorTests"]:::tests
        TestFiles["TestFiles"]:::tests
    end

    %% Configuration Files
    ConfigFiles["Config Files\n(AppConfig.xcconfig, ProjectConfig.xcconfig)"]:::persistence

    %% Flows
    User -->|drags .xcodeproj| DragFileView
    DragFileView -->|notifies| AppDelegate
    AppDelegate -->|invokes| BuildExtractor
    BuildExtractor -->|reads project| InfoSource
    InfoSource -->|yields raw settings| BuildExtractor
    BuildExtractor -->|generates comments| CommentGen
    BuildExtractor -->|generates preview| SampleStructGen
    BuildExtractor -->|writes configs| FileIO
    FileIO -->|writes to| Filesystem
    PreferencesVC -->|stores prefs| UserDefaults
    UserDefaults -->|injects prefs| BuildExtractor
    Tests -->|exercise| BuildExtractor
    Tests -->|use fixtures| TestFiles

    %% Click Events
    click MainMenu "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/Base.lproj/MainMenu.xib"
    click DragFileView "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/DragFileView.m"
    click AppDelegate "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/AppDelegate.m"
    click PreferencesStoryboard "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/Preferences/Base.lproj/Preferences.storyboard"
    click PreferencesVC "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/Preferences/PreferencesViewController.m"
    click ContentsPrefVC "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/Preferences/ContentsPreferencesViewController.m"
    click FileLayoutPrefVC "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/Preferences/FileLayoutPreferencesViewController.m"
    click Assets "https://github.com/marcrespass/buildsettingextractor/tree/main/BuildSettingExtractor/Assets.xcassets/"
    click BuildExtractor "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/BuildSettingExtractor.m"
    click InfoSource "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/BuildSettingInfoSource.m"
    click BuildSettingInfoSubpaths "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/BuildSettingInfoSubpaths.plist"
    click CommentGen "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/BuildSettingCommentGenerator.m"
    click SampleStructGen "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractor/Preferences/SampleFileStructureGenerator.m"
    click Tests "https://github.com/marcrespass/buildsettingextractor/blob/main/BuildSettingExtractorTests/BuildSettingExtractorTests.m"
    click TestFiles "https://github.com/marcrespass/buildsettingextractor/tree/main/BuildSettingExtractorTests/TestFiles/"
    click ConfigFiles "https://github.com/marcrespass/buildsettingextractor/blob/main/Config/AppConfig.xcconfig"

    %% Styles
    classDef ui fill:#cde8ff,stroke:#1e72b8,color:#000;
    classDef core fill:#d0f0c0,stroke:#3a803a,color:#000;
    classDef persistence fill:#ffe4b5,stroke:#ba6e1f,color:#000;
    classDef tests fill:#e0e0e0,stroke:#7a7a7a,color:#000;
    classDef external fill:#ffffff,stroke:#000000,color:#000,stroke-dasharray: 5 5;
```
