# zahidfkhan/streams-api-practices architecture

> Architecture diagram of the GitHub repository zahidfkhan/streams-api-practices, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zahidfkhan/streams-api-practices
- Repository: https://github.com/zahidfkhan/streams-api-practices

## Overview

##### Project type and purpose
- This is an educational, single-module Maven project that provides JUnit‐based exercises and practice problems for the Java Stream API.
- There is no “production” main code—everything lives under src/test/java. Its purpose is to teach and validate Java Stream skills via hands-on tests and Markdown walkthroughs.

##### File structure
- Top level:
- pom.xml (Maven coordinates, dependencies, plugins)
- .github/workflows/maven.yml (CI pipeline)
- src/test/java/com/github/streams/learn (guided lessons & MD docs)
- src/test/java/com/github/streams/learn/functional_interfaces (tests + solutions)
- src/test/java/com/github/streams/practice (problems organized by difficulty: a_easy, b_medium, c_hard)
- module-info.java (Java module declaration)
- No src/main; this is purely a test/learning project.
- CI: GitHub Actions triggers Maven lifecycle.

##### README for additional insights
- Describes three major sections: “learn/basics,” “learn/functional_interfaces,” and “practice” challenges.
- Emphasizes forking, removing @Disabled, and solving problems.
- Mentions JUnit tests as the core delivery mechanism.

##### Elements
- Blue for code artifacts (source, tests, resources)
- Green for tools (Maven, JUnit, GitHub Actions)
- Orange for environments (Developer, CI)

## Diagram (Mermaid)

```mermaid
graph TB
  subgraph "Java Stream API Exercises & Practices"
    subgraph "Repository"
      Pom["pom.xml"]:::code
      click Pom "https://github.com/zahidfkhan/streams-api-practices/blob/main/pom.xml"
      CIConfig[".github/workflows/maven.yml"]:::code
      click CIConfig "https://github.com/zahidfkhan/streams-api-practices/blob/main/.github/workflows/maven.yml"
      ModuleInfo["module-info.java"]:::code
      click ModuleInfo "https://github.com/zahidfkhan/streams-api-practices/blob/main/src/test/java/module-info.java"
      subgraph "Learn Basics Module"
        Basics["src/test/java/com/github/streams/learn/basics"]:::code
        click Basics "https://github.com/zahidfkhan/streams-api-practices/tree/main/src/test/java/com/github/streams/learn/basics"
        Sonnet["SonnetI.txt"]:::code
        click Sonnet "https://github.com/zahidfkhan/streams-api-practices/blob/main/src/test/resources/SonnetI.txt"
      end
      subgraph "Learn Functional Interfaces"
        FITests["src/test/java/com/github/streams/learn/functional_interfaces"]:::code
        click FITests "https://github.com/zahidfkhan/streams-api-practices/tree/main/src/test/java/com/github/streams/learn/functional_interfaces"
        FISolutions["src/test/java/com/github/streams/learn/functional_interfaces/solutions"]:::code
        click FISolutions "https://github.com/zahidfkhan/streams-api-practices/tree/main/src/test/java/com/github/streams/learn/functional_interfaces/solutions"
      end
      subgraph "Practice Challenges"
        Easy["a_easy"]:::code
        click Easy "https://github.com/zahidfkhan/streams-api-practices/tree/main/src/test/java/com/github/streams/practice/a_easy"
        Medium["b_medium"]:::code
        click Medium "https://github.com/zahidfkhan/streams-api-practices/tree/main/src/test/java/com/github/streams/practice/b_medium"
        Hard["c_hard"]:::code
        click Hard "https://github.com/zahidfkhan/streams-api-practices/tree/main/src/test/java/com/github/streams/practice/c_hard"
      end
      Docs["README.md"]:::code
      click Docs "https://github.com/zahidfkhan/streams-api-practices/blob/main/README.md"
      GitIgnore[".gitignore"]:::code
      click GitIgnore "https://github.com/zahidfkhan/streams-api-practices/blob/main/.gitignore"
      Security["SECURITY.md"]:::code
      click Security "https://github.com/zahidfkhan/streams-api-practices/blob/main/SECURITY.md"
      License["LICENSE"]:::code
      click License "https://github.com/zahidfkhan/streams-api-practices/tree/main/LICENSE"
    end
  end

  Developer["Developer Workstation\n(IDE, JDK, Git)"]:::env
  GitHubRepo["GitHub Repository"]:::tools
  CIRunner["CI Runner\n(GitHub Actions)"]:::env
  Maven["Maven Build Tool"]:::tools
  JUnitEngine["JUnit 5 & Surefire Plugin"]:::tools

  Developer -->|"push code"| GitHubRepo
  GitHubRepo -->|"push/PR event"| CIRunner
  CIRunner -->|"runs mvn"| Maven
  Maven -->|"reads pom.xml"| Pom
  Maven -->|"uses module system"| ModuleInfo
  Maven -->|"executes tests via Surefire"| JUnitEngine
  JUnitEngine -->|"runs Learn Basics tests"| Basics
  JUnitEngine -->|"runs FI tests"| FITests
  JUnitEngine -->|"runs Practice tests"| Easy
  JUnitEngine -->|"loads resource"| Sonnet
  JUnitEngine -->|"reports results"| GitHubRepo

  classDef code fill:#cfe2f3,stroke:#084b8a,color:#084b8a
  classDef tools fill:#d9ead3,stroke:#38761d,color:#38761d
  classDef env fill:#fce5cd,stroke:#bf9000,color:#bf9000
```
