Merge pull request odiszapc#27 from ThorbenKuck/master

[BUGFIX,ISSUE-26] Dump with If blocks now are written correctly | Slight Dumping rework

Author: odiszapc

pom.xml

@@ -22,7 +22,7 @@
 
     <groupId>com.github.odiszapc</groupId>
     <artifactId>nginxparser</artifactId>
-    <version>0.9.6</version>
+    <version>0.9.7</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>
@@ -89,8 +89,8 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.5.1</version>
                 <configuration>
-                    <source>1.6</source>
-                    <target>1.6</target>
+                    <source>1.8</source>
+                    <target>1.8</target>
                     <encoding>UTF-8</encoding>
                 </configuration>
             </plugin>

src/main/java/com/github/odiszapc/nginxparser/NgxAbstractEntry.java

@@ -22,7 +22,7 @@
 import java.util.List;
 
 public abstract class NgxAbstractEntry implements NgxEntry {
-    private Collection<NgxToken> tokens = new ArrayList<NgxToken>();
+    private Collection<NgxToken> tokens = new ArrayList<>();
 
     public NgxAbstractEntry(String... rawValues) {
         for (String val : rawValues) {

src/main/java/com/github/odiszapc/nginxparser/NgxBlock.java

@@ -37,7 +37,7 @@ public void addEntry(NgxEntry entry) {
 
     @Override
     public String toString() {
-        return super.toString() + " {";
+        return super.toString();
     }
 
 
@@ -140,4 +140,11 @@ public <T extends NgxEntry> List<NgxEntry> findAll(Class<T> clazz, List<NgxEntry
 
         return res;
     }
+
+    @Override
+    public void write(NgxPrintWriter writer) {
+        writer.openBlock(toString())
+            .write(getEntries())
+            .closeBlock();
+    }
 }

src/main/java/com/github/odiszapc/nginxparser/NgxComment.java

@@ -34,4 +34,9 @@ public String getValue() {
     public String toString() {
         return "#" + getValue();
     }
+
+    @Override
+    public void write(NgxPrintWriter printWriter) {
+        printWriter.appendLine(toString());
+    }
 }

src/main/java/com/github/odiszapc/nginxparser/NgxDumper.java

@@ -16,92 +16,96 @@
 
 package com.github.odiszapc.nginxparser;
 
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
 import java.io.OutputStream;
-import java.io.PrintWriter;
-import java.io.StringWriter;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardOpenOption;
+import java.util.Iterator;
 
 /**
  * NgxDumper is used to serialize an existing or manually created NgxConfig object
  */
 public class NgxDumper {
 
     private NgxConfig config;
-    private final static int PAD_SIZE = 2;
-    private final static String PAD_SYMBOL = "  ";
-    private final static String LBRACE = "{";
-    private final static String RBRACE = "}";
-    private final static String LF = "\n";
-    private final static String CRLF = "\r\n";
 
     public NgxDumper(NgxConfig config) {
         this.config = config;
     }
 
+    /**
+     * Dump the content of the config to a file.
+     *
+     * This method is used to write the NgxConfig directly to a file.
+     *
+     * If the file does not exist, it will be created.
+     *
+     * @param path the {@link Path} the config should be written to
+     * @throws IOException if anything goes wrong while writing or if the file is not writable
+     */
+    public void dumpToFile(Path path) throws IOException {
+        if(!Files.exists(path)) {
+            Files.createFile(path);
+        }
+        if(!Files.isWritable(path)) {
+            throw new IOException("The file cannot be written to: " + path);
+        }
+
+        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+        dump(outputStream);
+        Files.write(path, outputStream.toByteArray(), StandardOpenOption.TRUNCATE_EXISTING);
+    }
+
+    /**
+     * Dump the content of the config to a file.
+     *
+     * This method is for convenience and redirects directly to {@link #dumpToFile(Path)}
+     *
+     * @param destination the file the config should be written to
+     * @throws IOException if anything goes wrong while writing
+     * @see #dumpToFile(Path)
+     */
+    public void dumpToFile(String destination) throws IOException {
+        dumpToFile(Paths.get(destination));
+    }
+
     /**
      * Converts config int String
+     *
      * @return Serialized config
      */
     public String dump() {
-        StringWriter writer = new StringWriter();
-        writeToStream(config, new PrintWriter(writer), 0);
-        return writer.toString();
+        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+        writeToStream(config, outputStream);
+        return outputStream.toString();
     }
 
     /**
      * Serializes config and sends result to the provided OutputStream
+     *
      * @param out stream to write to
      */
     public void dump(OutputStream out) {
-        writeToStream(config, new PrintWriter(out), 0);
+        writeToStream(config, out);
     }
 
-    private void writeToStream(NgxBlock config, PrintWriter writer, int level) {
-        for (NgxEntry entry : config) {
-            NgxEntryType type = NgxEntryType.fromClass(entry.getClass());
-            switch (type) {
-                case BLOCK:
-                    NgxBlock block = (NgxBlock) entry;
-                    writer.append(getOffset(level))
-                            .append(block.toString())
-                            .append(getLineEnding());
-                    writeToStream(block, writer, level + 1);
-                    writer
-                            .append(getOffset(level))
-                            .append(RBRACE)
-                            .append(getLineEnding());
-                    break;
-                case IF:
-                    NgxIfBlock ifBlock = (NgxIfBlock) entry;
-                    writer
-                            .append(getOffset(level))
-                            .append(ifBlock.toString())
-                            .append(getLineEnding());
-                    writeToStream(ifBlock, writer, level + 1);
-                    writer
-                            .append(getOffset(level))
-                            .append(LBRACE)
-                            .append(getLineEnding());
-                case COMMENT:
-                case PARAM:
-                    writer
-                            .append(getOffset(level))
-                            .append(entry.toString())
-                            .append(getLineEnding());
-                    break;
+    private void writeToStream(NgxBlock config, OutputStream outputStream) {
+        try (NgxPrintWriter writer = new NgxPrintWriter(outputStream)) {
+            Iterator<NgxEntry> iterator = config.iterator();
+            while (iterator.hasNext()) {
+                NgxEntry current = iterator.next();
+                current.write(writer);
+                if (current instanceof NgxBlock && iterator.hasNext()) {
+                    // Extra new line, between two top level blocks
+                    writer.newLine();
+                }
             }
+        } catch (Exception e) {
+            // TODO Better Exception handling, like custom Exception types within a custom hierarchy
+            throw new IllegalStateException(e);
         }
-        writer.flush();
-    }
-
-    public String getOffset(int level) {
-        String offset = "";
-        for (int i = 0; i < level; i++) {
-            offset += PAD_SYMBOL;
-        }
-        return offset;
-    }
-
-    public String getLineEnding() {
-        return LF;
     }
 }

src/main/java/com/github/odiszapc/nginxparser/NgxEntry.java

@@ -16,7 +16,6 @@
 
 package com.github.odiszapc.nginxparser;
 
-
 public interface NgxEntry {
-
+    void write(NgxPrintWriter printWriter);
 }

src/main/java/com/github/odiszapc/nginxparser/NgxIfBlock.java

@@ -16,9 +16,24 @@
 
 package com.github.odiszapc.nginxparser;
 
+import java.util.ArrayList;
+
 public class NgxIfBlock extends NgxBlock {
 
+    @Override
     public String toString() {
-        return super.toString(); // TODO: add parentheses (looks like "if $a !~ ^1(2)3$ {" currently)
+        ArrayList<NgxToken> tokens = new ArrayList<>(getTokens());
+        String ifToken = tokens.remove(0).getToken(); // The "if"
+        StringBuilder tokenBuilder = new StringBuilder(ifToken)
+                .append(" ")
+                .append("(");
+
+        for (NgxToken value : tokens) {
+            tokenBuilder.append(value).append(" ");
+        }
+
+        String result = tokenBuilder.toString();
+
+        return result.substring(0, result.length() -1) + ")";
     }
 }

src/main/java/com/github/odiszapc/nginxparser/NgxParam.java

@@ -30,4 +30,9 @@ public String toString() {
 
         return s + ";";
     }
+
+    @Override
+    public void write(NgxPrintWriter printWriter) {
+        printWriter.appendLine(toString());
+    }
 }

src/main/java/com/github/odiszapc/nginxparser/NgxPrintWriter.java

@@ -0,0 +1,80 @@
+package com.github.odiszapc.nginxparser;
+
+import java.io.OutputStream;
+import java.io.PrintWriter;
+import java.util.Collection;
+
+public class NgxPrintWriter implements AutoCloseable {
+
+    private final static String PAD_SYMBOL = "  ";
+    private final static String LBRACE = "{";
+    private final static String RBRACE = "}";
+    private final static String LF = "\n";
+    private final PrintWriter printWriter;
+    private int level = 0;
+
+    public NgxPrintWriter(OutputStream outputStream) {
+        this.printWriter = new PrintWriter(outputStream);
+    }
+
+    public NgxPrintWriter openBlock(String prefix) {
+        append(prefix);
+        printWriter.append(" ").append(LBRACE);
+        level += 1;
+
+        return newLine();
+    }
+
+    public NgxPrintWriter closeBlock() {
+        level -= 1;
+        append(RBRACE);
+
+        return newLine();
+    }
+
+    public NgxPrintWriter newLine() {
+        printWriter.append(LF);
+
+        return this;
+    }
+
+    public NgxPrintWriter append(String string) {
+        this.printWriter.append(constructOffset(level))
+                .append(string);
+
+        return this;
+    }
+
+    public NgxPrintWriter appendLine(String string) {
+        this.printWriter.append(constructOffset(level))
+                .append(string)
+                .append(LF);
+
+        return this;
+    }
+
+    public NgxPrintWriter write(Collection<NgxEntry> entries) {
+        for (NgxEntry entry : entries) {
+            entry.write(this);
+        }
+
+        return this;
+    }
+
+    public void flush() {
+        printWriter.flush();
+    }
+
+    private String constructOffset(int level) {
+        StringBuilder offset = new StringBuilder();
+        for (int i = 0; i < level; i++) {
+            offset.append(PAD_SYMBOL);
+        }
+        return offset.toString();
+    }
+
+    @Override
+    public void close() {
+        printWriter.close();
+    }
+}

src/test/java/com/github/odiszapc/nginxparser/AlterConfigTest.java

@@ -21,7 +21,7 @@ public void removeOneLocation() throws Exception {
                 "  }\n" +
                 "}\n";
 
-        assertEquals(new NgxDumper(conf).dump(), expected);
+        assertEquals(expected, new NgxDumper(conf).dump());
     }
 
     @Test