Merge pull request #62 from denise-khuu/feature/katacodachangefile

feature/katacodachangefile

Author: maybeec

documentation/Functions.md

@@ -32,6 +32,14 @@ installCobiGen()
 2. The numbers that represent the templates that CobiGen uses to generate code: int array
 #### example
 cobiGenJava("path/to/java/file/MyEntity.java",[1,3,5,6,8])
+### details
+| Number | Description |
+| --- | -- |
+| 1 | CRUD logic: Generates the logic layer and implementations for some use cases.|
+| 3 | CRUD REST services: Generates the service layer with CRUD operations for using in REST services.|
+| 5 | TO's: Generates the related Transfer Objects.|
+| 6 | Entity infrastructure: Creates the entity main interface and edits (by a merge) the current entity to extend the newly generated classes.|
+| 8 | CRUD SpringData Repository: Generates the entity repository (that contains the CRUD operations) in the data access layer.
 
 ***
 
@@ -60,3 +68,31 @@ buildJava("cobigenexample", true)
 createFile("cobigenexample/core/src/main/java/com/example/application/cobigenexample/customermanagement/dataaccess/api/CustomerEntity.java", "files/CustomerEntity.java")
 
 ***
+
+### changeFile
+#### parameter 
+1. Path of the file to be changed (relative path to the workspace directory)
+2. 
+ *  path of the file to get the content from or a string, that should be inserted.
+ * (Optional) Name of a placeholder 
+#### example 
+changeFile("cobigenexample/core/src/main/java/com/example/application/cobigenexample/customermanagement/dataaccess/api/CustomerEntity.java", { "file": "files/Placeholder.java", "placeholder": "private static final long serialVersionUID = 1L;" })
+#### details
+##### Path of the file to get the content from or a string, that should be inserted.
+If you want to add content from a file: 
+{"file": "[path]"}
+If you want to add a string to a file: 
+{"content": "[string]"}
+##### Name of the placeholder
+If you want to insert content into your code between two existing lines, take the previous line as your placeholder. Add your placeholder into the new file or string, otherwise it will be replaced entirely.
+
+example:{...,"placeholder": "private int age;"}
+| Before | Content or File | After |
+| --- | --- | --- |
+|<p>private int age;<br><br>public String getFirstname() {<br>return firstname;<br>}<br></p>|<p>private int age;<br><br>private String company;<br>public String getCompany() {<br>return firstname;<br>}<br>public void setCompany(String company) {<br>this.company = company;<br>}</p>|<p>private int age;<br><br>private String company;<br>public String getCompany() {<br>return firstname;<br>}<br>public void setCompany(String company) {<br>this.company = company;<br><br>public String getFirstname() {<br>return firstname;<br>}<br></p>|
+
+A placeholder is optional. If you do not define a placeholder, the content in the existing file will be simply replaced by the new content.
+
+Please try not to use custom placeholders. Keep in mind that you might want to build the project before changing them. Custom placeholders with a comment-syntax (e.g. "//PLACEHOLDER") will be removed by the console-environment and others might cause errors.
+
+***

runners/katacoda/index.ts

@@ -144,7 +144,7 @@ export class Katacoda extends Runner {
         let workspaceDir = path.join("devonfw", "workspaces", "main");
         let filePath = path.join(command.parameters[0].substring(0,path.join(command.parameters[0]).lastIndexOf(path.sep))).replace(/\\/g, "/");
         let fileDir = path.join(workspaceDir, command.parameters[0]).replace(/\\/g, "/");
-        let fileName = path.join(command.parameters[0].substring(path.join( command.parameters[0]).lastIndexOf(path.sep) + 1 , command.parameters[0].length )).replace(/\\/g, "/");
+        let fileName = path.basename(path.join(command.parameters[0]));
         let content = "";
         if(command.parameters.length == 2) {
             content = fs.readFileSync(path.join(this.playbookPath, command.parameters[1]), { encoding: "utf-8" });
@@ -159,6 +159,34 @@ export class Katacoda extends Runner {
         return null;
     }
 
+    runChangeFile(step: Step, command: Command): RunResult{
+        let workspaceDir = path.join("devonfw", "workspaces", "main");
+        let fileName = path.basename(path.join(command.parameters[0]));
+        let fileDir = path.join(workspaceDir, command.parameters[0]).replace(/\\/g, "/");
+        let content = "";
+        let placeholder = "";
+        let dataTarget = "replace";
+        let changeDescr = "Replace the content of "+ fileName +" with the following code.";
+        if(command.parameters[1].placeholder){
+            dataTarget = "insert";
+            placeholder = command.parameters[1].placeholder;
+            changeDescr = "Insert after ' " + command.parameters[1].placeholder + " ' the following segment of code.";
+        }
+        if(command.parameters[1].content){
+            content = command.parameters[1].content;
+        }else if(command.parameters[1].file){
+            content = fs.readFileSync(path.join(this.playbookPath, command.parameters[1].file), { encoding: "utf-8" });
+        }
+
+        this.steps.push({
+            "title": "Change " + fileName,
+            "text": "step" + this.stepsCount + ".md"
+        });
+        
+        this.renderTemplate("changeFile.md", this.outputPathTutorial + "step" + (this.stepsCount++) + ".md", { text: step.text, textAfter: step.textAfter, fileDir: fileDir, fileName:fileName, content: content, placeholder: placeholder, dataTarget: dataTarget, changeDescr: changeDescr});
+        return null;
+    }
+
     runBuildJava(step: Step, command: Command): RunResult{
 
         let cdCommand = this.changeCurrentDir(path.join("/root", "devonfw", "workspaces", "main", command.parameters[0]));
@@ -181,8 +209,6 @@ export class Katacoda extends Runner {
 
     }
 
-    
-
     private renderTemplate(name: string, targetPath: string, variables) {
         let template = fs.readFileSync(path.join(this.getRunnerDirectory(),"templates", name), 'utf8');
         let result = ejs.render(template, variables);

runners/katacoda/templates/changeFile.md

@@ -0,0 +1,14 @@
+<%= text; %>
+
+Go back to the IDE and find the file <%= fileName; %>.
+
+<%= changeDescr; %>
+
+Click on 'Copy to Editor' to change it automatically.
+
+<pre class="file" data-filename="<%= fileDir; %>" data-target="<%= dataTarget; %>" data-marker="<%= placeholder; %>">
+<%= content; %>
+</pre>
+
+
+<%= textAfter; %>