Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rodrigo-brito/refactoring-aware-diff
RAID is a tool pipeline that seamlessly enriches GitHub diff results with refactoring information.
https://github.com/rodrigo-brito/refactoring-aware-diff
actions chrome-extension refactoring review-tools
Last synced: 4 days ago
JSON representation
RAID is a tool pipeline that seamlessly enriches GitHub diff results with refactoring information.
- Host: GitHub
- URL: https://github.com/rodrigo-brito/refactoring-aware-diff
- Owner: rodrigo-brito
- License: mit
- Created: 2020-01-07T13:31:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-19T13:16:00.000Z (about 3 years ago)
- Last Synced: 2024-05-01T14:13:06.977Z (7 months ago)
- Topics: actions, chrome-extension, refactoring, review-tools
- Language: JavaScript
- Homepage:
- Size: 85 MB
- Stars: 79
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RAID: Refactoring-aware and Intelligent Diffs
[](https://github.com/rodrigo-brito/refactoring-aware-diff/actions)
[](https://chrome.google.com/webstore/detail/refactoring-aware-diff/bclbegekihgpelanbbleaceefgmekjdd)
[](LICENSE)
- Published at 29th IEEE/ACM International Conference on Program Comprehension (ICPC), 2021
- ArXiv: https://arxiv.org/abs/2103.11453
- IEEE Library: https://www.computer.org/csdl/proceedings-article/icpc/2021/140300a265/1tB7wfFt3ji
Code review is a key practice in modern software development. Currently, this practice is performed using textual diff tools, such as the one provided by GitHub. However, diff results can easily become complex and hard to understand. Refactorings, for example, are not represented at all in diff results. This makes diff understanding more complex because reviewers need to infer themselves that a given group of added and removed lines of code represent, for example, an extract method.
RAID is a tool pipeline that seamlessly enriches GitHub diff results with refactoring information. See the following figure:
As presented in this figure, this pipeline has three key components:
- [RefDiff](https://github.com/aserg-ufmg/RefDiff): a tool to detect refactoring operations in commits. We rely on GitHub Actions to automatically execute RefDiff after each Pull Request.
- An [external server](https://github.com/rodrigo-brito/refactoring-aware-diff/tree/server), that collects the list of refactorings produced by RefDiff.
- A [Chrome plug-in](https://chrome.google.com/webstore/detail/refactoring-aware-review/bclbegekihgpelanbbleaceefgmekjdd) that seamlessly annotates diff chunks with refactoring data (see the following snapshot).
#### Example of Move Method
#### Supported Refactorings
RAID relies on RefDiff and support the following refactorings
| Language | Language Refactorings |
|------------|----------------------------------------------------------------------------------------|
| Java | Move, Extract Function, Inline Function, Rename, Change Signature, Pull Up, Push Down |
| JavaScript | Move, Extract Function, Inline Function, Rename, Change Signature, Pull Up, Push Down |
| C | Move, Extract Function, Inline Function, Rename, Change Signature |
| Go | Move, Extract Function, Inline Function, Rename, Change Signature |
## Installation
To detect refactorings in your repository, you must first install this [Chrome plug-in](https://chrome.google.com/webstore/detail/refactoring-aware-review/bclbegekihgpelanbbleaceefgmekjdd) and configure RefDiff on [Github Actions](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow).
To execute RefDiff as Github Actions, you need to create a workflow file in `.github/workflows` folder with `.yaml` extension. Example of configuration: `.github/workflows/workflow.yml`:
```yaml
on: [pull_request] # Trigger RefDiff after each pull request
jobs:
main:
runs-on: ubuntu-latest
name: Refactoring Detection
steps:
- name: Git Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: raid
env:
LANGUAGE: ${{ github.event.repository.language }} # Supports Java, Javascrit, C and Go.
REV_BEFORE: ${{ github.event.pull_request.base.sha }}
REV_AFTER: ${{ github.event.pull_request.head.sha }}
uses: rodrigo-brito/refactoring-aware-diff@action
```
## Simple Example
We created a simple pull request with commits including toy refactorings, to illustrate the usage of our plug-in. See [here](https://github.com/rodrigo-brito/refactoring-aware-diff/pull/5/commits) (but first you need to install our plug in).
## How cite RAID
```bibtex
@inproceedings{brito2021,
author = {Rodrigo Brito and Marco Tulio Valente},
title = {{RAID}: Tool Support for Refactoring-Aware Code Reviews},
booktitle = {29th International Conference on Program Comprehension (ICPC)},
year = {2021},
pages = {265--275}
}
```
DOI: https://doi.ieeecomputersociety.org/10.1109/ICPC52881.2021.00033
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.