RefactoringMatcher

Prerequisite Installation

• Neo4j
• API-Finder
• MySQL

API-Finder Installation Guide

• Clone API Finder locally.
• Run the migration scripts for the local Mysql installation.
• Update the config.properties.
• Perform the tests from JFreeChartV153TypeInferenceV2APITest.java.
• If all the tests pass, build the project using Maven command.

  mvn clean install -DskipTests

• Copy the file "apifiner-[Version]-jar-with-dependencies" from \target directory to RefactoringMatcher/lib direcotry.

Update process of 'config.properties'

• Update the github oauth token github.oauth.token.
• Update the mysql host url datasource.jdbc.url.
• Update the java installation directory [e.g., java.6.jar.directory].
• For locally cloned projects, show the path corpus.path.
• Update Maven [maven.home] and Gradle [gradle.home] installation directory.

Install Neo4j

• Download and install Neo4j Desktop from here
• Add a new project named as RefactoringMatcher

RefactoringMatcher Usage Guide

• Clone RefactoringMatcher locally.
• Open project from IntelliJ IDEA
• Open src/main/resources/refactoring-matcher-config.properties
  • Update Neo4j Configurations as required
  • Create required folders
  • commitlist.directory should contain the target csv file with commit history of a project. Please follow the file structure included with the project.
  • Update Maven maven.home directory path
• Run testGroumWhileBlockRepresentation from src/test/java/com/refactoringMatcher/representation\GroumStructureTests.java to test and verify the project setup
• Follow the Test method javadoc instructions from src/test/java/com/refactoringMatcher/representation/GroumGenerationForGithubProjectsTest.java for GROUM Graph generation and Similarity matching.