Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loehnertz/doppelgaenger
An interactive tool to eliminate code clones in Java applications
https://github.com/loehnertz/doppelgaenger
clone-detection java-parser kotlin ktor
Last synced: 18 days ago
JSON representation
An interactive tool to eliminate code clones in Java applications
- Host: GitHub
- URL: https://github.com/loehnertz/doppelgaenger
- Owner: loehnertz
- License: mit
- Created: 2019-11-25T09:01:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-10T03:35:26.000Z (about 2 years ago)
- Last Synced: 2023-08-04T17:54:51.401Z (over 1 year ago)
- Topics: clone-detection, java-parser, kotlin, ktor
- Language: Kotlin
- Homepage:
- Size: 2.96 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Doppelgänger
An interactive tool to eliminate code clones in Java applications
## Features
- Analyze any Java application and detect its duplicated source code
- Either input a local project or any that is available via a public Git repository
- Receive an advanced visualization of your code clones
- Explore your application and its code clones to interactively eliminate them
## Idea
As part of a course in university, [Núria](https://github.com/NuriaBruchTarrega) and me had to do a clone detection application.
We very much enjoyed this assignment and eventually built it into this application.
While the core of _Doppelgänger_ is using AST parsing and hashing to detect source code clones,
the output can be explored visually:
## Running
The tool consists of a back-end written in Kotlin as well as front-end built with Vue.js.
The entirety of the application is bundled into Docker images and can be executed with `docker-compose`.
After having it installed, while in the root project directory, just run `docker-compose up -d`.
Instead of cloning (no pun intended) the entire repository, you can also just create this `docker-compose.yml` anywhere and run `docker-compose up -d`:
```yaml
version: "3"
services:
frontend:
image: loehnertz/doppelgaenger-frontend
ports:
- 8016:80 # Change the port in front of the colon as you wish
depends_on:
- backend
backend:
image: loehnertz/doppelgaenger-backend
ports:
- 8888:8888 # Do not change these ports
volumes:
- /:/app/projects/
environment:
PROJECT_ROOT: "/app/projects/"
```
## Usage
### Analysis
1) Select if you want to supply a local, or a Git-hosted project via the first dropdown input.
2) Either put in a path on your local file system or a Git repository URI into the second input.
- Local project example: `/home/username/projects/my-app/`
- Git project example: `[email protected]:username/my-app.git`
3) Optionally specify the base path to your source code files in the third input.
- Example: `/src/main/java/`
4) Select the clone type to use for the analysis.
- Type One: _exact copy, ignoring whitespace and comments_
- Type Two: _syntical copy, changes allowed in variable, type, and function identifiers_
- Type Three: _copy with changed, added, or deleted statements_
5) Choose a _similarity threshold_ for the analysis.
- This value determines how similar source code fragments have to be, to be flagged as clones.
6) Choose a _mass threshold_ for the analysis.
- This value determines how precise the analysis will be. Generally speaking, a low value will improve accuracy while decreasing the speed.
7) Click the `Analyze` button and start exploring the detected clones.
### Exploration
_Follows soon_
## License
This project is licensed under the [MIT license](LICENSE).