# penekhun/baekjoon-java-starter architecture

> Architecture diagram of the GitHub repository penekhun/baekjoon-java-starter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/penekhun/baekjoon-java-starter
- Repository: https://github.com/penekhun/baekjoon-java-starter

## Overview

##### Core Components
- Problem Parser Module
- Code Generator Module
- File Generator Module
- Code Runner Module
- User Configuration Module
- Version Checker Module

##### External Integrations
- Baekjoon Online Judge Website
- IntelliJ IDEA
- GitHub (for version checking)

##### Input/Interface Layer
- CLI interface (BojStarter.java and Main.java)
- It to the user input flow (problem number)

##### Core Processing Layer

a. Problem Parser Component:
- BaekjoonProblemParser
- JsoupWebParser
- Problem and TestCase entities
- Connection to Baekjoon website

b. Code Generation Pipeline:
- FileContentGenerator
- JavaCodeGenerator
- JavaTemplate
- Template processing flow

c. File Management:
- JavaSourceCodeFile
- SourceCodeFile
- File system interactions

d. IDE Integration:
- CodeOpenManager
- IdeaCodeOpenManager
- Connection to IntelliJ IDEA

##### Support Systems
- Version Checker (connecting to GitHub)
- User Configuration System
- Operating System Detection

Visualization Guidelines:

##### Component Grouping
- Use clear labels for each group
- Clear boundaries between different responsibilities

Special Considerations:

##### Testing Infrastructure
- A separate section showing test components
- Relationship between production and test code
- How test helpers integrate with the main system

##### Configuration Flow
- How user configurations are loaded and applied
- Where template customization occurs
- Configuration feedback loop

##### Error Handling
- Validation and error reporting flows

Level of Detail:

- Problem parsing and test case extraction
- Code generation and template processing
- IDE integration flow

##### The test automation infrastructure

This system design should reflect the tool's main purpose: automating the setup process for competitive programming problems while maintaining a clean separation of concerns and extensibility for future enhancements.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Interface
        CLI[CLI Interface]:::interface
        Main["Main Class"]:::interface
        BojStarter["BOJ Starter"]:::interface
    end

    subgraph "Problem Parser"
        BP["Baekjoon Problem Parser"]:::core
        JWP["Jsoup Web Parser"]:::core
        Problem["Problem Entity"]:::entity
        TestCase["Test Case Entity"]:::entity
    end

    subgraph "Code Generation"
        JCG["Java Code Generator"]:::core
        FCG["File Content Generator"]:::core
        JT["Java Template"]:::core
    end

    subgraph "File Management"
        JSCF["Java Source Code File"]:::file
        SCF["Source Code File"]:::file
    end

    subgraph "IDE Integration"
        COM["Code Open Manager"]:::core
        ICOM["IDEA Code Open Manager"]:::core
    end

    subgraph "Support Systems"
        VC["Version Checker"]:::support
        UC["User Configuration"]:::support
        UCL["User Config Loader"]:::support
        UCF["User Config Fields"]:::support
        OS["Operating System"]:::support
    end

    subgraph "External Services"
        BOJ["Baekjoon Online Judge"]:::external
        IDEA["IntelliJ IDEA"]:::external
        GH["GitHub"]:::external
    end

    %% Connections
    CLI --> Main
    Main --> BojStarter
    BojStarter --> BP
    BP --> JWP
    JWP --> BOJ
    BP --> Problem
    BP --> TestCase
    
    BojStarter --> JCG
    JCG --> FCG
    FCG --> JT
    JCG --> JSCF
    JSCF --> SCF
    
    BojStarter --> COM
    COM --> ICOM
    ICOM --> IDEA
    
    BojStarter --> UC
    UC --> UCL
    UCL --> UCF
    
    BojStarter --> VC
    VC --> GH
    
    BojStarter --> OS

    %% Click Events
    click Main "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/Main.java"
    click BojStarter "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/BojStarter.java"
    click BP "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/problem_parser/BaekjoonProblemParser.java"
    click JWP "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/problem_parser/JsoupWebParser.java"
    click Problem "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/problem_parser/Problem.java"
    click TestCase "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/problem_parser/TestCase.java"
    click JCG "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/code_generator/JavaCodeGenerator.java"
    click FCG "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/code_generator/FileContentGenerator.java"
    click JT "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/code_generator/JavaTemplate.java"
    click JSCF "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/file_generator/JavaSourceCodeFile.java"
    click SCF "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/file_generator/SourceCodeFile.java"
    click COM "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/code_runner/CodeOpenManager.java"
    click ICOM "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/code_runner/IdeaCodeOpenManager.java"
    click UC "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/user_configuration/UserConfiguration.java"
    click UCL "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/user_configuration/UserConfigurationLoader.java"
    click UCF "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/user_configuration/UserConfigurationField.java"
    click OS "https://github.com/PENEKhun/baekjoon-java-starter/blob/main/src/main/java/kr/huni/os/OperatingSystem.java"

    %% Styles
    classDef interface fill:#FFE5CC,stroke:#FF9933
    classDef core fill:#CCE5FF,stroke:#3399FF
    classDef entity fill:#E5CCFF,stroke:#9933FF
    classDef file fill:#CCFFE5,stroke:#33FF99
    classDef support fill:#E5E5E5,stroke:#666666
    classDef external fill:#FFE5E5,stroke:#FF3333
```
