diff --git a/README.md b/README.md index 5b3e902..1ea0f7a 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,68 @@ -

SBSRE

-

An eclipse plugin for identifying Single responsibility violations in the methods.

+# SBSRE +SBSRE is a **slice-based single responsibility extraction** approach supported by an **eclipse plugin** for identifying Single responsibility violations in the methods. -

Use SBSRE by following these steps:

+The responsibility of a method can be best described by its impacts on the outer scope that are exposed through modifying the return values, outputs, and global variables. In the context of object-oriented programming, a method may modify either the class fields or return a value to its caller method. If the corresponding slices of these fields or return values within the method body are entirely separate, the method presumably exposes different functionalities. -

Step1: For using SBSRE, It is recommended to use the Eclipse Neon.

+Existing extract method refactoring tools do not pay serious attention to these so-called output instructions and the output variables while searching for extract method candidates, which results in imprecise refactoring opportunity detection from the developer's viewpoint. We introduce a new **Output-based Slicing** algorithm, focused on extracting chunks of codes that commit to the specific output from the body of long methods. -Eclipse Neon download link -

Step2: Import the SBSRE in the Eclipse.

+## Relevant publications +To be announced. + + + +## Getting started + +### Step1: Prerequisites + +It is recommended to use the Eclipse Neon IDE with JDK 1.8.x for lunching our SBSRE tool + +* [Download Eclipse Neon](https://www.eclipse.org/downloads/packages/release/neon/3/eclipse-ide-java-ee-developers) + +* [Download JDK 8](https://www.oracle.com/java/technologies/downloads/) + + +### Step2: Import the SBSRE tool + + Import the SBSRE tool in the Eclipse IDE

-

Step2

+

Figure 1. Operations of Step 2.

-

Step3: Run the SBSRE plugin in the Eclipse.

+ + +### Step3: Run the SBSRE tool + +Run the SBSRE tool as as a plugin in the Eclipse IDE

-

Step3

+

Figure 2. Operations of Step 3.

+ + -

Step4: Insert or create a java project, then on Bad Smells tab, choose SRP-Violation.

+### Step4: Open SRP-Violation window + +Insert or create a java project, then on Bad Smells tab, choose SRP-Violation

-

Step4

+

Figure 3. Operations of Step 4.

+ +### Step5: Identifying SRP-Violation -

Step5: By clicking on each of the packages, classes, or methods, it will be selected. Then by clicking on the "i" icon, results will be shown.

+By clicking on each of the packages, classes, or methods, it will be selected. Then by clicking on the "i" icon, results will be shown.

-

Step5

+

Figure 4. Operations of Step 5.

+ + + +### Step6: -

Step6: Results are shown here and by selecting each of them, a code fragment proposed for method extraction will be highlighted.

+Results are shown here and by selecting each of them, a code fragment proposed for method extraction will be highlighted.

-

Step6

+

Figure 5. Operations of Step 6.