Skip to content

Commit

Permalink
Reformat Code Style
Browse files Browse the repository at this point in the history
  • Loading branch information
dimanyfantakis committed Jan 7, 2024
1 parent eb175c8 commit 5d61f33
Show file tree
Hide file tree
Showing 262 changed files with 17,068 additions and 14,468 deletions.
66 changes: 33 additions & 33 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,36 +27,36 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
cache: maven

- name: Set Up
run: ./mvnw install:install-file -Dfile=${{ github.workspace }}/libs/JavaFXSmartGraph/JavaFXSmartGraph/0.1/JavaFXSmartGraph-0.1.jar -DgroupId=JavaFXSmartGraph -DartifactId=JavaFXSmartGraph -Dversion=0.1 -Dpackaging=jar
- run: ./mvnw install:install-file -Dfile=${{ github.workspace }}/libs/PlantUML/PlantUML/1.2023.7/PlantUML-1.2023.7.jar -DgroupId=PlantUML -DartifactId=PlantUML -Dversion=1.2023.7 -Dpackaging=jar
- name: Build with Maven
run: ./mvnw -B package --file pom.xml --update-snapshots verify -DskipTests

- name: Test
run: ./mvnw --batch-mode -Dmaven.test.failure.ignore=true test

- name: Report
uses: dorny/test-reporter@v1
if: always()
with:
name: Maven Tests
path: target/surefire-reports/*.xml
reporter: java-junit
fail-on-error: true

- name: Upload artifact
uses: actions/upload-artifact@v1
if: always()
with:
name: surefire-reports
path: /home/runner/work
- uses: actions/checkout@v3
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
cache: maven

- name: Set Up
run: ./mvnw install:install-file -Dfile=${{ github.workspace }}/libs/JavaFXSmartGraph/JavaFXSmartGraph/0.1/JavaFXSmartGraph-0.1.jar -DgroupId=JavaFXSmartGraph -DartifactId=JavaFXSmartGraph -Dversion=0.1 -Dpackaging=jar
- run: ./mvnw install:install-file -Dfile=${{ github.workspace }}/libs/PlantUML/PlantUML/1.2023.7/PlantUML-1.2023.7.jar -DgroupId=PlantUML -DartifactId=PlantUML -Dversion=1.2023.7 -Dpackaging=jar

- name: Build with Maven
run: ./mvnw -B package --file pom.xml --update-snapshots verify -DskipTests

- name: Test
run: ./mvnw --batch-mode -Dmaven.test.failure.ignore=true test

- name: Report
uses: dorny/test-reporter@v1
if: always()
with:
name: Maven Tests
path: target/surefire-reports/*.xml
reporter: java-junit
fail-on-error: true

- name: Upload artifact
uses: actions/upload-artifact@v1
if: always()
with:
name: surefire-reports
path: /home/runner/work
74 changes: 56 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,14 @@
</div>

# Table of Contents

> - [About](#about)
> * [Motivation](#motivation)
>
* [Motivation](#motivation)
> * [Features](#features)
> - [Getting Started](#getting-started)
> * [Requirements](#requirements)
>
* [Requirements](#requirements)
> * [Installation](#installation)
> * [Usage](#usage)
>* [Contributing / Reporting issues](#contributing--reporting-issues)
Expand All @@ -37,62 +40,72 @@

### Motivation

The purpose of this project is to develop an independent software tool that produces UML diagrams by reverse engineering Java object-oriented source code.
The purpose of this project is to develop an independent software tool that produces UML diagrams by reverse engineering Java object-oriented source code.

### Features

* Visualize class && package UML diagrams
* Choose the classes/packages that will be included in the diagram
* Create different diagrams from the same project
* Visualize class && package UML diagrams
* Choose the classes/packages that will be included in the diagram
* Create different diagrams from the same project
* Export a diagram to:
* GraphML in order to visualize it using yEd
* Image
* text file that can you can later load
* GraphML in order to visualize it using yEd
* Image
* text file that can you can later load

## Getting Started

### Requirements

1. Clone the repository

```bash
git clone https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer.git
```

2. Import project into:
* [Eclipse][importEclipse-url]
* [Intellij IDEA][importIntellij-url]

* [Eclipse][importEclipse-url]
* [Intellij IDEA][importIntellij-url]

### Installation

1. Run

```bash
./mvnw compile
```

to build the project.

2.
2.

* In Eclipse: Project -> Build
* In Intellij IDEA : Build -> Project

### Usage

1. Run

```bash
./mvnw package
```

to create the jar **ObjectOrientedArchitectureDiagrammer-0.0.1-SNAPSHOT-jar-with-dependencies.jar**

2. Run

```bash
java -jar ObjectOrientedArchitectureDiagrammer\target\ObjectOrientedArchitectureDiagrammer-0.0.1-SNAPSHOT-jar-with-dependencies.jar
```

to execute the jar

Check the [User Documentation][userDocumentation-url] regarding more about the usage of the tool

### Tests

To run the tests simply run

```bash
./mvnw test
```
Expand All @@ -111,39 +124,47 @@ If you want to contribute to the development of our tool, please fork the repo a

1. Fork the Project.
2. Create your Feature Branch.

```bash
git checkout -b feature/NewFeature
```

3. Commit your Changes.

```bash
git commit -m 'Add some NewFeature'
```

4. Push to the Branch.

```bash
git push origin feature/NewFeature
```

5. Open a Pull Request.

### Issues

Create a new [Issue][issues-url] to report any issues

## Roadmap

- [X] Fix crashes with underscores, files/folders starting with '.', etc
- [ ] Build a visualization library that supports:
- [ ] A layout algorithm that uses bend minimization
- [ ] Drag & drop canvas to add UML entities
- [ ] Editable canvas in order to move & delete UML components and entities
- [ ] Editable edges that can split when clicked to help the user avoid edge/box overlapping
- [ ] Support [PlantUML][plantuml-url]
- [X] Use PlantUML’s language to define the diagram
- [X] Export the image of the diagram
- [ ] Visualize the diagram within the tool's canvas
- [X] Use PlantUML’s language to define the diagram
- [X] Export the image of the diagram
- [ ] Visualize the diagram within the tool's canvas
- [ ] Deprecate jdt parser after heavy usage of javaparser, or, extend the jdt parser to support:
- [ ] Creation of new() objects via local variables (and the resulting dependencies)
- [ ] Enums
- [ ] Creation of new() objects via local variables (and the resulting dependencies)
- [ ] Enums

## Authors

v0.2: Dimitris Anyfantakis added a new java parser; Bill Dodis added the PlanUML extension as part of his Diploma Thesis in Univ. Ioannina.<br>
v0.1: Dimitris Anyfantakis has developed the first version of the tool as part of his Diploma Thesis in Univ. Ioannina; Panos Vassiliadis acted solely as code reviewer and co-designer.

Expand All @@ -154,20 +175,37 @@ See [License][license-url] for more information regarding the license
## Acknowledgments

[workflow-url]: https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer/actions/workflows/maven.yml/badge.svg

[contributors-shield]: https://img.shields.io/github/contributors/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer

[contributors-url]: https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer/graphs/contributors

[commits-shield]: https://img.shields.io/github/last-commit/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer

[commits-url]: https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer/commit/main

[forks-shield]: https://img.shields.io/github/forks/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer

[forks-url]: https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer/network/members

[stars-shield]: https://img.shields.io/github/stars/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer

[stars-url]: https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer/stargazers

[issues-shield]: https://img.shields.io/github/issues/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer

[issues-url]: https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer/issues/

[license-shield]: https://img.shields.io/github/license/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer

[license-url]: https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer/blob/main/LICENSE

[userDocumentation-url]: https://drive.google.com/file/d/17h9-hPtQ7GXwKxacQCjEKP51aE3G2JdZ/view?usp=sharing

[demo-url]: https://github.com/DAINTINESS-Group/ObjectOrientedArchitectureDiagrammer

[importEclipse-url]: https://www.baeldung.com/maven-import-eclipse

[importIntellij-url]: https://www.jetbrains.com/idea/guide/tutorials/working-with-maven/importing-a-project/

[plantuml-url]: https://plantuml.com/
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
<groupId>JavaFXSmartGraph</groupId>
<artifactId>JavaFXSmartGraph</artifactId>
<version>0.1</version>
<description>POM was created from install:install-file</description>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
<groupId>JavaFXSmartGraph</groupId>
<artifactId>JavaFXSmartGraph</artifactId>
<version>0.1</version>
<description>POM was created from install:install-file</description>
</project>
18 changes: 9 additions & 9 deletions libs/JavaFXSmartGraph/JavaFXSmartGraph/maven-metadata.xml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<metadata>
<groupId>JavaFXSmartGraph</groupId>
<artifactId>JavaFXSmartGraph</artifactId>
<versioning>
<release>0.1</release>
<versions>
<version>0.1</version>
</versions>
<lastUpdated>20221010180439</lastUpdated>
</versioning>
<groupId>JavaFXSmartGraph</groupId>
<artifactId>JavaFXSmartGraph</artifactId>
<versioning>
<release>0.1</release>
<versions>
<version>0.1</version>
</versions>
<lastUpdated>20221010180439</lastUpdated>
</versioning>
</metadata>
12 changes: 6 additions & 6 deletions libs/PlantUML/PlantUML/1.2023.7/PlantUML-1.2023.7.pom
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
<groupId>PlantUML</groupId>
<artifactId>PlantUML</artifactId>
<version>1.2023.7</version>
<description>POM was created from install:install-file</description>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
<groupId>PlantUML</groupId>
<artifactId>PlantUML</artifactId>
<version>1.2023.7</version>
<description>POM was created from install:install-file</description>
</project>
18 changes: 9 additions & 9 deletions libs/PlantUML/PlantUML/maven-metadata.xml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<metadata>
<groupId>PlantUML</groupId>
<artifactId>PlantUML</artifactId>
<versioning>
<release>1.2023.7</release>
<versions>
<version>1.2023.7</version>
</versions>
<lastUpdated>20230518044318</lastUpdated>
</versioning>
<groupId>PlantUML</groupId>
<artifactId>PlantUML</artifactId>
<versioning>
<release>1.2023.7</release>
<versions>
<version>1.2023.7</version>
</versions>
<lastUpdated>20230518044318</lastUpdated>
</versioning>
</metadata>
Loading

0 comments on commit 5d61f33

Please sign in to comment.