Changes between Initial Version and Version 1 of RefactoringSteps/RenameModule

Timestamp:

Feb 17, 2012, 5:28:11 PM (14 years ago)

Author:

manualwiki

Comment:

--

RefactoringSteps/RenameModule

@@ +1 @@
+= Rename module =
+
+The rename module refactoring renames a module with the given new name. Renames the file and make changes in other file where this module is referenced. In the example the {{{mod1}}} module is renamed to {{{newmod}}}. The file is also renamed to {{{newmod.erl}}}.
+
+Renaming module {{{mod1}}} to {{{newmod}}}:
+
+{{{
+-module(mod1).
+
+-export([add/2]).
+
+add(A,B) -> A + B.
+}}}
+
+{{{
+-module(mod2).
+
+-export([add/1]).
+
+add([]) -> []; 
+add[{A,B}|Tail]) -> 
+   [mod1:add(A,B) 
+    |add(Tail)].
+}}}
+
+Result:
+
+{{{
+-module(newmod).
+
+-export([add/2]).
+
+add(A,B) -> A + B.                                  
+}}}
+
+{{{
+-module(mod2).
+
+-export([add/1]).
+
+add([]) -> []; 
+add[{A,B}|Tail]) -> 
+   [newmod:add(A,B) 
+    |add(Tail)].
+}}}
+
+== Side conditions ==
+
+ * The given new name should be a legal file name.
+
+ * There must not exist another module with the given new name in the graph.
+
+ * There must not exist another file with the given new name in the directory of the module to be renamed.
+
+ * If one of the above conditions fails, the transformation starts an interaction to ask for a new module name.
+
+== Transformation steps and compensations ==
+
+ 1. Rename the current module name to the new name.
+
+ 2. Rename the collected module qualifiers to the given new name.
+
+ 3. Rename the references to the module in the import lists.
+
+ 4. Rename the file to the new name.