Rename refactoring: keyword fields

rascal-lsp/pom.xml

@@ -68,12 +68,12 @@
     <dependency>
       <groupId>org.rascalmpl</groupId>
       <artifactId>rascal-core</artifactId>
-      <version>0.12.3</version>
+      <version>0.12.4</version>
     </dependency>
     <dependency>
       <groupId>org.rascalmpl</groupId>
       <artifactId>typepal</artifactId>
-      <version>0.13.4</version>
+      <version>0.14.0</version>
     </dependency>
     <!-- Rascal tests require JUnit 4 -->
     <dependency>

rascal-lsp/src/main/rascal/lang/rascal/lsp/refactor/Util.rsc

@@ -99,7 +99,9 @@ rel[&K, &V] groupBy(set[&V] s, &K(&V) pred) =
 @synopsis{
     Predicate to sort locations by length.
 }
-bool byLength(loc l1, loc l2) = l1.length < l2.length;
+bool isShorter(loc l1, loc l2) = l1.length < l2.length;
+
+bool isShorterTuple(tuple[loc, &T] t1, tuple[loc, &T] t2) = isShorter(t1[0], t2[0]);
 
 @synopsis{
     Predicate to sort locations by offset.

rascal-lsp/src/main/rascal/lang/rascal/tests/rename/Fields.rsc

@@ -29,26 +29,90 @@ module lang::rascal::tests::rename::Fields
 import lang::rascal::tests::rename::TestUtils;
 import lang::rascal::lsp::refactor::Exception;
 
-test bool dataField() = testRenameOccurrences({0, 1}, "
+test bool constructorField() = testRenameOccurrences({0, 1}, "
     'D oneTwo = d(1, 2);
-    'x = d.foo;
+    'x = oneTwo.foo;
     ", decls = "data D = d(int foo, int baz);"
 );
 
-// TODO Implement data types properly
-// test bool multipleConstructorDataField() = testRenameOccurrences({0, 1, 2}, "
-//     'x = d(1, 2);
-//     'y = x.foo;
-//     ", decls = "data D = d(int foo) | d(int foo, int baz);"
-// , cursorAtOldNameOccurrence = 1);
+test bool constructorKeywordField() = testRenameOccurrences({0, 1, 2}, "
+    'D dd = d(foo=1, baz=2);
+    'x = dd.foo;
+    ", decls="data D = d(int foo = 0, int baz = 0);"
+);
+
+test bool commonKeywordField() = testRenameOccurrences({0, 1, 2}, "
+    'D oneTwo = d(foo=1, baz=2);
+    'x = oneTwo.foo;
+    ", decls = "data D(int foo = 0, int baz = 0) = d();"
+);
+
+// Flaky. Fix for non-determinism in typepal, upcoming in future release of Rascal (Core)
+// https://github.com/usethesource/typepal/commit/55456edcc52653e42d7f534a5412147b01b68c29
+test bool multipleConstructorField() = testRenameOccurrences({0, 1, 2}, "
+    'x = d(1, 2);
+    'y = x.foo;
+    ", decls = "data D = d(int foo) | d(int foo, int baz);"
+);
 
 @expected{illegalRename}
-test bool duplicateDataField() = testRename("", decls =
+test bool duplicateConstructorField() = testRename("", decls =
     "data D = d(int foo, int bar);"
 );
 
-test bool crossModuleDataField() = testRenameOccurrences({
-    byText("Foo", "data D = a(int foo) | b(int bar);", {0}),
+@expected{illegalRename}
+test bool differentTypeAcrossConstructorField() = testRename("", decls =
+    "data D = d0(int foo) | d1(str bar);"
+);
+
+test bool sameTypeFields() = testRenameOccurrences({0, 1},
+    "x = d({}, {});
+    'xx = x.foo;
+    'xy = x.baz;
+    ",
+    decls = "data D = d(set[loc] foo, set[loc] baz);"
+);
+
+test bool commonKeywordFieldsSameType() = testRenameOccurrences({0, 1},
+    "x = d();
+    'xx = x.foo;
+    'xy = x.baz;
+    ",
+    decls = "data D (set[loc] foo = {}, set[loc] baz = {})= d();"
+);
+
+test bool complexDataType() = testRenameOccurrences({0, 1},
+    "WorkspaceInfo ws = workspaceInfo(
+    '   ProjectFiles() { return {}; },
+    '   ProjectFiles() { return {}; },
+    '   set[TModel](ProjectFiles projectFiles) { return { tmodel() }; }
+    ');
+    'ws.projects += {};
+    'ws.sourceFiles += {};
+    ",
+    decls = "
+    'data TModel = tmodel();
+    'data Define;
+    'data AType;
+    'alias ProjectFiles = rel[loc projectFolder, loc file];
+    'data WorkspaceInfo (
+    '   // Instance fields
+    '   // Read-only
+    '   rel[loc use, loc def] useDef = {},
+    '   set[Define] defines = {},
+    '   set[loc] sourceFiles = {},
+    '   map[loc, Define] definitions = (),
+    '   map[loc, AType] facts = (),
+    '   set[loc] projects = {}
+    ') = workspaceInfo(
+    '   ProjectFiles() preloadFiles,
+    '   ProjectFiles() allFiles,
+    '   set[TModel](ProjectFiles) tmodelsForLocs
+    ');"
+, oldName = "sourceFiles", newName = "sources");
+
+test bool crossModuleConstructorField() = testRenameOccurrences({
+    byText("Foo", "data D = a(int foo) | b(int baz);", {0}),
     byText("Main", "
     'import Foo;
     'void main() {
@@ -58,16 +122,51 @@ test bool crossModuleDataField() = testRenameOccurrences({
     ", {0})
 });
 
-// TODO Implement data types properly
-// test bool extendedDataField() = testRenameOccurrences({
-//     byText("Scratch1", "
-//         'data Foo = f(int foo);
-//         ", {0}),
-//     byText("Scratch2", "
-//         'extend Scratch1;
-//         'data Foo = g(int foo);
-//         ", {0})
-// });
+test bool extendedConstructorField() = testRenameOccurrences({
+    byText("Scratch1", "
+        'data Foo = f(int foo);
+        ", {0}),
+    byText("Scratch2", "
+        'extend Scratch1;
+        'data Foo = g(int foo);
+        ", {0})
+});
+
+test bool dataTypeReusedName() = testRenameOccurrences({
+    byText("Scratch1", "
+        'data Foo = f();
+        ", {0}),
+    byText("Scratch2", "
+        'data Foo = g();
+        ", {})
+}, oldName = "Foo", newName = "Bar");
+
+test bool dataFieldReusedName() = testRenameOccurrences({
+    byText("Scratch1", "
+        'data Foo = f(int foo);
+        ", {0}),
+    byText("Scratch2", "
+        'data Foo = f(int foo);
+        ", {})
+});
+
+test bool dataKeywordFieldReusedName() = testRenameOccurrences({
+    byText("Scratch1", "
+        'data Foo = f(int foo = 0);
+        ", {0}),
+    byText("Scratch2", "
+        'data Foo = f(int foo = 0);
+        ", {})
+});
+
+test bool dataCommonKeywordFieldReusedName() = testRenameOccurrences({
+    byText("Scratch1", "
+        'data Foo(int foo = 0) = f();
+        ", {0}),
+    byText("Scratch2", "
+        'data Foo(int foo = 0) = g();
+        ", {})
+});
 
 test bool relField() = testRenameOccurrences({0, 1}, "
     'rel[str foo, str baz] r = {};
@@ -82,13 +181,13 @@ test bool lrelField() = testRenameOccurrences({0, 1}, "
 test bool relSubscript() = testRenameOccurrences({0, 1}, "
     'rel[str foo, str baz] r = {};
     'x = r\<foo\>;
-", skipCursors = {1});
+");
 
 test bool relSubscriptWithVar() = testRenameOccurrences({0, 2}, "
     'rel[str foo, str baz] r = {};
     'str foo = \"foo\";
     'x = r\<foo\>;
-", skipCursors = {2});
+");
 
 test bool tupleFieldSubscriptUpdate() = testRenameOccurrences({0, 1, 2}, "
     'tuple[str foo, int baz] t = \<\"one\", 1\>;
@@ -122,14 +221,14 @@ test bool tupleField() = testRenameOccurrences({0, 1}, "
 ");
 
 // We would prefer an illegalRename exception here
-@expected{unsupportedRename}
+@expected{illegalRename}
 test bool builtinFieldSimpleType() = testRename("
     'loc l = |unknown:///|;
     'f = l.top;
 ", oldName = "top", newName = "summit");
 // We would prefer an illegalRename exception here
 
-@expected{unsupportedRename}
+@expected{illegalRename}
 test bool builtinFieldCollectionType() = testRename("
     'loc l = |unknown:///|;
     'f = l.ls;

rascal-lsp/src/main/rascal/lang/rascal/tests/rename/TestUtils.rsc

@@ -29,6 +29,8 @@ module lang::rascal::tests::rename::TestUtils
 
 import lang::rascal::lsp::refactor::Rename; // Module under test
 
+import lang::rascal::lsp::refactor::Util;
+
 import IO;
 import List;
 import Location;
@@ -50,8 +52,8 @@ import util::Reflective;
 
 
 //// Fixtures and utility functions
-data TestModule = byText(str name, str body, set[int] nameOccs, str newName = name)
-                | byLoc(loc file, set[int] nameOccs, str newName = name);
+data TestModule = byText(str name, str body, set[int] nameOccs, str newName = name, set[int] skipCursors = {})
+                | byLoc(loc file, set[int] nameOccs, str newName = name, set[int] skipCursors = {});
 
 private list[DocumentEdit] sortEdits(list[DocumentEdit] edits) = [sortChanges(e) | e <- edits];
 
@@ -85,7 +87,7 @@ bool expectEq(&T expected, &T actual, str epilogue = "") {
 
 bool testRenameOccurrences(set[TestModule] modules, str oldName = "foo", str newName = "bar") {
     bool success = true;
-    for (mm <- modules, cursorOcc <- mm.nameOccs) {
+    for (mm <- modules, cursorOcc <- (mm.nameOccs - mm.skipCursors)) {
         str testName = "Test<abs(arbInt())>";
         loc testDir = |memory://tests/rename/<testName>|;
 
@@ -97,7 +99,7 @@ bool testRenameOccurrences(set[TestModule] modules, str oldName = "foo", str new
         }
 
         pcfg = getTestPathConfig(testDir);
-        modulesByLocation = {mByLoc | m <- modules, mByLoc := (m is byLoc ? m : byLoc(storeTestModule(testDir, m.name, m.body), m.nameOccs, newName = m.newName))};
+        modulesByLocation = {mByLoc | m <- modules, mByLoc := (m is byLoc ? m : byLoc(storeTestModule(testDir, m.name, m.body), m.nameOccs, newName = m.newName, skipCursors = m.skipCursors))};
         cursorT = findCursor([m.file | m <- modulesByLocation, getModuleName(m.file, pcfg) == mm.name][0], oldName, cursorOcc);
 
         println("Renaming \'<oldName>\' from <cursorT.src>");
@@ -131,8 +133,6 @@ bool testRenameOccurrences(set[TestModule] modules, str oldName = "foo", str new
 
         if (!expectEq(expectedEditsPerModule, editsPerModule, epilogue = "Rename from cursor <cursorT.src> failed:")) {
             success = false;
-            println("Unexpected edits: ");
-            iprintln(edits);
         }
 
         for (src <- pcfg.srcs) {
@@ -274,6 +274,9 @@ private set[int] extractRenameOccurrences(loc moduleFileName, list[DocumentEdit]
         oldNameOccurrences += n.src;
     }
 
+    // print("All locations of \'<name>\': ");
+    // iprintln(sort(oldNameOccurrences, byOffset));
+
     if ([changed(_, replaces)] := edits) {
         set[int] idx = {};
         for (replace(replaceAt, replaceWith) <- replaces) {

rascal-lsp/src/main/rascal/lang/rascal/tests/rename/Types.rsc

@@ -165,3 +165,13 @@ test bool dataTypesInIIModuleStructure() = testRenameOccurrences({
                        'bool func(Foo foo) = foo == f();", {0}),       byText("RightUser", "import RightExtender;
                                                                         'bool func(Foo foo) = foo == g();", {})
 }, oldName = "Foo", newName = "Bar");
+
+test bool sameIdRoleOnly() = testRenameOccurrences({
+    byText("A", "data foo = f();", {})
+  , byText("B", "extend A;
+                'data foo = g();", {})
+  , byText("C", "extend B;
+                'int foo = 8;",{0})
+  , byText("D", "import C;
+                'int baz = C::foo + 1;", {0})
+});

rascal-lsp/src/main/rascal/lang/rascal/tests/rename/Variables.rsc

@@ -197,3 +197,10 @@ test bool multiModuleVar() = testRenameOccurrences({
                '}"
                , {0})
     });
+
+test bool unrelatedVar() = testRenameOccurrences({
+    byText("Module1", "int foo = 8;", {0})
+  , byText("Module2", "import Module1;
+                      'int foo = 2;
+                      'int baz = foo;", {})
+});