Revizor

A plugin for PyCharm that takes the recurrent change patterns and highlights potential places for their application in the developer’s code editor. We use graph-based code change representations, which were gathered from 120 GitHub repositories by code-change-miner tool.

Behind the scenes, the plugin runs an inspection which builds isomorphic mappings between fine-grained Program Dependence Graphs of the mined patterns and a similar graph of your code, and then suggests you a relevant quick-fix to apply for the highlighted code fragment.

Installation

At first, clone this repository and open the root folder.

Build plugin from sources and go:

• Run ./gradlew :plugin:buildPlugin
• Check out ./plugin/build/distributions/plugin-*.zip
• Install the plugin in your PyCharm via File - Settings - Plugins - Install Plugin from Disk...

Quick IDE launch for evaluation:

• Run ./gradlew :plugin:runIde
• Open any Python file with functions, possibly containing mined code patterns
• Wait until the code analysis is complete
• Check out WARNING messages

Custom patterns support

• Let's say you've already mined patterns using code-change-miner
• Select the ones you need to automate and put them in a separate folder. Make sure each pattern is represented by a directory and contains all the necessary files, as they were provided by the miner (fragment-*.dot, sample-*.html, ...)
• Run preprocessing script via: ./gradlew :preprocessing:cli -Psrc=path/to/patterns/dir/ -Pdst=path/to/destination/dir/ -PaddDescription
  • Gradle task arguments:
    • -Psrc: Path to input directory with the patterns mined by the miner (always required)
    • -Pdst: Path to output directory for processed patterns (always required)
    • -PaddDescription: If you want to add description for each pattern manually (optional)
• Follow the instructions in the command line (actually, you could only provide the tooltip annotations for the patterns, because all the other preparation tasks will be done automatically)
• Finally, each preprocessed pattern's folder should contain 4 files:
  • graph.dot: an actual graph of the pattern
  • actions.json: edit actions stored by GumTree when it processes corresponding commits of a change pattern
  • labels_groups.json: matching modes and groups of labels for all the variables in the graph, used for localization later
  • description.txt: textual description you provide when the pattern was processed; they can explain the reason why a developer may be interested in this type of code change
• When you are finished, just copy preprocessed patterns from the destination directory to ./plugin/src/main/resources/patterns and re-build the plugin