Skip to content

Commit 9994d29

Browse files
suratdasfhoeben
suratdas
and
fhoeben
authored
Addresses issue #1402 - Possible to search and replace method/scenario names with new name. (#1403)
* Addresses issue #1402 - Possible to search and replace method/scenario names with new name. * Changed UI based on review comments. * Review comment suggestion. Co-authored-by: Fried Hoeben <[email protected]> * Review comment suggestion. Co-authored-by: Fried Hoeben <[email protected]> * Review comment suggestion. Co-authored-by: Fried Hoeben <[email protected]> * Review comment suggestion. Co-authored-by: Fried Hoeben <[email protected]> Co-authored-by: Fried Hoeben <[email protected]>
1 parent 1226a00 commit 9994d29

File tree

9 files changed

+796
-12
lines changed

9 files changed

+796
-12
lines changed

Diff for: ‎src/fitnesse/resources/templates/refactorForm.vm

+30-4
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,48 @@
11
#if( !$type || $type == "replace" )
2-
<h2>Replace</h2>
32
<form action="$refactoredRootPage" method="post">
3+
<h2>Replace Text</h2>
44
<input type="hidden" name="responder" value="replace"/>
55
<fieldset>
66
<label for="searchString">Search String:</label>
7-
<input type="text" id="searchString" name="searchString" value="#if ($request.hasInput("searchString"))$request.getInput("searchString")#end"/>
7+
<input type="text" size="50" id="searchString" name="searchString" value="#if ($request.hasInput("searchString"))$request.getInput("searchString")#end"/>
88
</fieldset>
99
<fieldset>
1010
<label for="replacementString">Replacement:</label>
11-
<input type="text" id="replacementString" name="replacementString" value="#if ($request.hasInput("replacementString"))$request.getInput("replacementString")#end"/>
11+
<input type="text" size="50" id="replacementString" name="replacementString" value="#if ($request.hasInput("replacementString"))$request.getInput("replacementString")#end"/>
1212
</fieldset>
1313
<fieldset class="buttons">
1414
<input type="submit" name="replace" value="Replace!"/>
1515
<a class="button" href="$viewLocation">Cancel</a>
1616
</fieldset>
1717

1818
<p><strong>Search &amp; Replace: </strong>
19-
Please note that this feature is experimental! It uses java-based regular expressions. For an introduction, take a look <a href="http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html" target="_new">here</a> (new window).
19+
Please note that this feature is experimental! It uses java-based regular expressions. For an introduction, take a look <a href="http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html" target="_new">here</a> (new window).</p>
20+
</form>
21+
22+
<form action="$refactoredRootPage" method="post">
23+
<h2>Replace Method</h2>
24+
<input type="hidden" name="responder" value="replace"/>
25+
<input type="hidden" name="isMethodReplace"/>
26+
<fieldset>
27+
<label for="searchString">Search Method:</label>
28+
<input type="text" size="50" id="searchStringMethod" name="searchString" value="#if ($request.hasInput("searchString"))$request.getInput("searchString")#end"/>
29+
</fieldset>
30+
<fieldset>
31+
<label for="replacementString">Replacing Method:</label>
32+
<input type="text" size="50" id="replacementString" name="replacementString" value="#if ($request.hasInput("replacementString"))$request.getInput("replacementString")#end"/>
33+
</fieldset>
34+
<fieldset class="buttons">
35+
<input type="submit" name="replace" value="Replace Method!"/>
36+
<a class="button" href="$viewLocation">Cancel</a>
37+
</fieldset>
38+
<p>
39+
Reflect an updated method/scenario name across all existing test cases. To accomplish this, you can supply an existing line using that method from any test page. e.g. <strong>|Go to|url|</strong> can be changed to <strong>|Navigate to|url|</strong>. Keep the following in mind:
40+
<ul>
41+
<li>This will not change the parameters (if any) in the wiki.</li>
42+
<li>This will replace any line which evaluates to a method name including a line in script table, a scenario or a decision table having a similar name. This will be desired in most cases. But if you have multiple classes with the same method of which you only changed one this will not work as desired, since all calls are replaced.</li>
43+
<li>It is a good idea to review the updated lines locally (e.g. using Git) and undo any undesired changes before sharing/committing the tests. Most IDE have a version control comparison and selective undo feature.</li>
44+
</ul>
45+
</p>
2046
</form>
2147
#end
2248

Diff for: ‎src/fitnesse/responders/refactoring/SearchReplaceResponder.java

+21-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
package fitnesse.responders.refactoring;
22

3-
import fitnesse.wiki.refactoring.ContentReplacingSearchObserver;
4-
import fitnesse.wiki.search.PageFinder;
5-
import fitnesse.wiki.search.RegularExpressionWikiPageFinder;
63
import fitnesse.components.TraversalListener;
74
import fitnesse.responders.search.ResultResponder;
85
import fitnesse.wiki.WikiPage;
6+
import fitnesse.wiki.refactoring.ContentReplacingSearchObserver;
7+
import fitnesse.wiki.refactoring.MethodReplacingSearchObserver;
8+
import fitnesse.wiki.search.MethodWikiPageFinder;
9+
import fitnesse.wiki.search.PageFinder;
10+
import fitnesse.wiki.search.RegularExpressionWikiPageFinder;
911

1012
public class SearchReplaceResponder extends ResultResponder {
1113

@@ -21,19 +23,30 @@ protected String getTemplate() {
2123
@Override
2224
protected String getTitle() {
2325
return String.format("Replacing matching content \"%s\" with content \"%s\"",
24-
getSearchString(), getReplacementString());
26+
getSearchString(), getReplacementString());
2527
}
2628

2729
@Override
2830
protected PageFinder getPageFinder(TraversalListener<WikiPage> webOutputObserver) {
2931
String searchString = getSearchString();
3032
String replacementString = getReplacementString();
3133

32-
ContentReplacingSearchObserver contentReplaceObserver =
33-
new ContentReplacingSearchObserver(searchString, replacementString);
34+
if (isMethodReplace()) {
35+
MethodReplacingSearchObserver methodReplaceObserver =
36+
new MethodReplacingSearchObserver(searchString, replacementString);
37+
38+
return new MethodWikiPageFinder(searchString,
39+
new SearchReplaceTraverser(methodReplaceObserver, webOutputObserver));
40+
} else {
41+
ContentReplacingSearchObserver contentReplaceObserver =
42+
new ContentReplacingSearchObserver(searchString, replacementString);
43+
return new RegularExpressionWikiPageFinder(searchString,
44+
new SearchReplaceTraverser(contentReplaceObserver, webOutputObserver));
45+
}
46+
}
3447

35-
return new RegularExpressionWikiPageFinder(searchString,
36-
new SearchReplaceTraverser(contentReplaceObserver, webOutputObserver));
48+
private boolean isMethodReplace() {
49+
return request.hasInput("isMethodReplace");
3750
}
3851

3952
private String getReplacementString() {

Diff for: ‎src/fitnesse/util/WikiPageLineProcessingUtil.java

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
package fitnesse.util;
2+
3+
import org.apache.commons.lang3.StringUtils;
4+
5+
import java.util.ArrayList;
6+
import java.util.Arrays;
7+
import java.util.LinkedHashMap;
8+
import java.util.List;
9+
10+
public class WikiPageLineProcessingUtil {
11+
12+
public static boolean isColumnSpecialWikiKeyWord(String stringPassed) {
13+
stringPassed = stringPassed.trim();
14+
return stringPassed.isEmpty() || stringPassed.startsWith("$") || stringPassed.equals("ensure") || stringPassed.equals("reject") || stringPassed.equals("check") || stringPassed.equals("check not") || stringPassed.equals("show") || stringPassed.equals("note");
15+
}
16+
17+
public static boolean doesLineNeedExtraLastColumn(String stringPassed) {
18+
String firstColumn = Arrays.asList(stringPassed.split("\\|")).get(1).trim();
19+
return firstColumn.equals("check") || firstColumn.equals("check not");
20+
}
21+
22+
public static String getLastColumn(String stringPassed) {
23+
if (isValidLine(stringPassed)) {
24+
List<String> allColumns = Arrays.asList(stringPassed.split("\\|"));
25+
return allColumns.get(allColumns.size() - 1);
26+
}
27+
return "";
28+
}
29+
30+
private static boolean isValidLine(String textPassed) {
31+
return (textPassed.startsWith("|") && textPassed.trim().endsWith("|"));
32+
}
33+
34+
public static String getMethodNameFromLine(String textPassed) {
35+
String methodNameToReturn = "";
36+
if (isValidLine(textPassed)) {
37+
List<String> methodSplit = new ArrayList<>();
38+
methodSplit.addAll(Arrays.asList(textPassed.split("\\|")));
39+
methodSplit.remove(0);//First one is always empty. We can discard it.
40+
String firstColumn = methodSplit.get(0);
41+
int counter = !isColumnSpecialWikiKeyWord(firstColumn) ? 0 : 1;
42+
boolean lineHasExtraColumn = doesLineNeedExtraLastColumn(textPassed);
43+
for (int i = counter; i < methodSplit.size(); i += 2) {
44+
//Ensure last column is not included in the method name.
45+
if (lineHasExtraColumn && methodSplit.size() == (i + 1)) {
46+
} else {
47+
List<String> currentCellWords = Arrays.asList(methodSplit.get(i).trim().split(" "));
48+
for (String currentCellWord : currentCellWords) {
49+
if (!currentCellWord.trim().isEmpty()) {
50+
methodNameToReturn += org.apache.commons.lang3.StringUtils.capitalize(currentCellWord.trim());
51+
}
52+
}
53+
}
54+
}
55+
methodNameToReturn = StringUtils.uncapitalize(methodNameToReturn);
56+
}
57+
return methodNameToReturn;
58+
}
59+
60+
public static LinkedHashMap<Integer, String> getRowColumnsExcludingKeywordInFirstColumnIfPresent(String currentLine) {
61+
LinkedHashMap<Integer, String> allColumnsOfCurrentLine = new LinkedHashMap<>();
62+
String remainingText = currentLine;
63+
int currentIndexOfPipe = 1;
64+
boolean isFirstColumnSpecialKey = true;
65+
while (remainingText.contains("|")) {
66+
int nextIndexOfPipe = currentLine.indexOf("|", currentIndexOfPipe);
67+
String currentColumnText = currentLine.substring(currentIndexOfPipe, nextIndexOfPipe);
68+
if (isFirstColumnSpecialKey && !isColumnSpecialWikiKeyWord(currentColumnText)) {
69+
isFirstColumnSpecialKey = false;
70+
allColumnsOfCurrentLine.put(currentIndexOfPipe, currentColumnText);
71+
} else if (!isFirstColumnSpecialKey) {
72+
allColumnsOfCurrentLine.put(currentIndexOfPipe, currentColumnText);
73+
}
74+
currentIndexOfPipe = nextIndexOfPipe + 1;
75+
remainingText = currentLine.substring(nextIndexOfPipe + 1);
76+
}
77+
if (doesLineNeedExtraLastColumn(currentLine))
78+
allColumnsOfCurrentLine.remove(allColumnsOfCurrentLine.size() - 1);
79+
return allColumnsOfCurrentLine;
80+
}
81+
82+
}

Diff for: ‎src/fitnesse/wiki/refactoring/MethodReplacingSearchObserver.java

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
package fitnesse.wiki.refactoring;
2+
3+
import fitnesse.components.TraversalListener;
4+
import fitnesse.wiki.PageData;
5+
import fitnesse.wiki.WikiPage;
6+
7+
import java.util.Iterator;
8+
import java.util.LinkedHashMap;
9+
10+
import static fitnesse.util.WikiPageLineProcessingUtil.*;
11+
12+
public class MethodReplacingSearchObserver implements TraversalListener<WikiPage> {
13+
14+
private String searchMethodString;
15+
private String replacingMethodString;
16+
17+
public MethodReplacingSearchObserver(String searchString, String replacement) {
18+
this.searchMethodString = searchString;
19+
this.replacingMethodString = replacement;
20+
}
21+
22+
@Override
23+
public void process(WikiPage page) {
24+
PageData pageData = page.getData();
25+
26+
String content = pageData.getContent();
27+
String[] lines = content.split(System.lineSeparator());
28+
String newPageContent = "";
29+
boolean isModified = false;
30+
String targetMethod = getMethodNameFromLine(searchMethodString);
31+
for (String eachLineOfFile : lines) {
32+
if (!eachLineOfFile.startsWith("|") || !getMethodNameFromLine(eachLineOfFile).equals(targetMethod)) {
33+
newPageContent += eachLineOfFile + System.lineSeparator();
34+
} else {
35+
isModified = true;
36+
String modifiedLine = "";
37+
LinkedHashMap<Integer, String> toBeReplacedText = getRowColumnsExcludingKeywordInFirstColumnIfPresent(eachLineOfFile);
38+
Iterator<Integer> toBeReplacedKeys = toBeReplacedText.keySet().iterator();
39+
LinkedHashMap<Integer, String> toReplaceText = getRowColumnsExcludingKeywordInFirstColumnIfPresent(replacingMethodString);
40+
Iterator<Integer> toReplaceKeys = toReplaceText.keySet().iterator();
41+
for (int i = 0; toBeReplacedKeys.hasNext() || toReplaceKeys.hasNext(); i++) {
42+
int toBeReplacedIndex = toBeReplacedKeys.hasNext() ? toBeReplacedKeys.next() : -1;
43+
int toReplaceIndex = toReplaceKeys.hasNext() ? toReplaceKeys.next() : -1;
44+
modifiedLine = modifiedLine.isEmpty() ? eachLineOfFile.substring(0, toBeReplacedIndex - 1) : modifiedLine;
45+
if (toBeReplacedIndex > 0 && toReplaceIndex > 0) {
46+
if (i % 2 == 1) {
47+
modifiedLine += "|" + eachLineOfFile.substring(toBeReplacedIndex, toBeReplacedIndex + toBeReplacedText.get(toBeReplacedIndex).length());
48+
} else {
49+
modifiedLine += "|" + toReplaceText.get(toReplaceIndex);
50+
}
51+
}
52+
//Below case is when there are more columns in replacing text than in original text.
53+
else if (toBeReplacedIndex == -1) {
54+
//All remaining columns of replacing text should be appended.
55+
modifiedLine += "|" + toReplaceText.get(toReplaceIndex);
56+
while (toReplaceKeys.hasNext()) {
57+
modifiedLine += "|" + toReplaceText.get(toReplaceKeys.next());
58+
}
59+
break;
60+
}
61+
//below case is when there are more columns in original text which need to be removed.
62+
else if (toReplaceIndex == -1) {
63+
modifiedLine += "|";
64+
break;
65+
}
66+
}
67+
if (doesLineNeedExtraLastColumn(eachLineOfFile)) {
68+
modifiedLine += getLastColumn(eachLineOfFile);
69+
}
70+
modifiedLine = (!modifiedLine.isEmpty() && !modifiedLine.endsWith("|")) ? modifiedLine + "|" : modifiedLine;
71+
newPageContent += modifiedLine + System.lineSeparator();
72+
}
73+
}
74+
if (isModified) {
75+
pageData.setContent(newPageContent);
76+
}
77+
page.commit(pageData);
78+
}
79+
80+
}

Diff for: ‎src/fitnesse/wiki/search/MethodWikiPageFinder.java

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
package fitnesse.wiki.search;
2+
3+
import fitnesse.components.TraversalListener;
4+
import fitnesse.wiki.WikiPage;
5+
6+
import static fitnesse.util.WikiPageLineProcessingUtil.getMethodNameFromLine;
7+
8+
public class MethodWikiPageFinder extends WikiPageFinder {
9+
10+
private String methodToFind;
11+
12+
public MethodWikiPageFinder(String methodToFind, TraversalListener<? super WikiPage> observer) {
13+
super(observer);
14+
this.methodToFind = methodToFind;
15+
}
16+
17+
@Override
18+
protected boolean pageMatches(WikiPage page) {
19+
String pageContent = page.getData().getContent();
20+
String targetMethod = getMethodNameFromLine(this.methodToFind);
21+
String[] contentLines = pageContent.split(System.lineSeparator());
22+
23+
//Both the inputs should follow the correct format
24+
if (!methodToFind.startsWith("|") || !methodToFind.endsWith("|"))
25+
return false;
26+
27+
for (String eachLine : contentLines) {
28+
if (getMethodNameFromLine(eachLine).equals(targetMethod))
29+
return true;
30+
}
31+
return false;
32+
}
33+
34+
}

0 commit comments

Comments
 (0)