Merge pull request #303 from d22/master

Refactor: Use own model for header and footer, improve XML escaping

Author: Olivier Chédru

.github/workflows/build.yml

@@ -2,7 +2,6 @@ name: build
 on:
     push:
         branches: [ '*' ]
-        tags: [ '*' ]
     pull_request:
         branches: [ '*' ]
 jobs:
@@ -15,21 +14,4 @@ jobs:
                     distribution: 'zulu'
                     java-version: '8'
             -   name: maven build
-                env:
-                    GPG_SECRET_KEY: ${{ secrets.GPG_SECRET_KEY }}
-                    GPG_OWNERTRUST: ${{ secrets.GPG_OWNERTRUST }}
-                    GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
-                    SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
-                    SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
-                run: |
-                    if echo "${GITHUB_REF_NAME}" | egrep '^[0-9]+\.[0-9]+\.[0-9]+(-[0-9]+)?$'
-                    then
-                        # the tag looks like a version number: proceed with release
-                        echo ${GPG_SECRET_KEY} | base64 --decode | gpg --import --no-tty --batch --yes
-                        echo ${GPG_OWNERTRUST} | base64 --decode | gpg --import-ownertrust --no-tty --batch --yes
-                        mvn -ntp versions:set -DnewVersion=${GITHUB_REF_NAME}
-                        mvn -ntp -s .github/settings.xml -Prelease deploy
-                    else
-                        # this is a regular build
-                        mvn -ntp install
-                    fi
+                run: mvn --batch-mode --errors --show-version --no-transfer-progress clean verify

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: release
+on:
+    push:
+        tags: [ '*' ]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@v3
+            -   uses: actions/setup-java@v3
+                with:
+                    distribution: 'zulu'
+                    java-version: '8'
+            -   name: maven release
+                env:
+                    GPG_SECRET_KEY: ${{ secrets.GPG_SECRET_KEY }}
+                    GPG_OWNERTRUST: ${{ secrets.GPG_OWNERTRUST }}
+                    GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+                    SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+                    SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+                run: |
+                    if echo "${GITHUB_REF_NAME}" | egrep '^[0-9]+\.[0-9]+\.[0-9]+(-[0-9]+)?$'
+                    then
+                        # the tag looks like a version number: proceed with release
+                        echo ${GPG_SECRET_KEY} | base64 --decode | gpg --import --no-tty --batch --yes
+                        echo ${GPG_OWNERTRUST} | base64 --decode | gpg --import-ownertrust --no-tty --batch --yes
+                        mvn --batch-mode --errors --show-version --no-transfer-progress versions:set -DnewVersion=${GITHUB_REF_NAME}
+                        mvn --batch-mode --errors --show-version --no-transfer-progress --settings .github/settings.xml -Prelease deploy
+                    fi

fastexcel-writer/pom.xml

@@ -30,6 +30,11 @@
             <artifactId>junit-jupiter-engine</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.assertj</groupId>
             <artifactId>assertj-core</artifactId>

fastexcel-writer/src/main/java/org/dhatim/fastexcel/MarginalInformation.java

@@ -0,0 +1,62 @@
+package org.dhatim.fastexcel;
+
+import java.io.IOException;
+
+/**
+ * Marginal Information, represents a header or footer
+ * in an Excel file.
+ */
+public class MarginalInformation {
+
+	private static final String DEFAULT_FONT = "Times New Roman";
+	private static final int DEFAULT_FONT_SIZE = 12;
+	private final String text;
+	private final Position position;
+	private final String font;
+	private final int fontSize;
+
+	public MarginalInformation(String text, Position position) {
+		this(text, position, DEFAULT_FONT, DEFAULT_FONT_SIZE);
+	}
+
+	private MarginalInformation(String text, Position position, String font, int fontSize) {
+		this.text = text;
+		this.position = position;
+		this.font = font;
+		this.fontSize = fontSize;
+	}
+
+	public MarginalInformation withFont(String font) {
+		return new MarginalInformation(this.text, this.position, font, fontSize);
+	}
+
+	public MarginalInformation withFontSize(int fontSize) {
+		return new MarginalInformation(this.text, this.position, this.font, fontSize);
+	}
+
+	public String getContent() {
+		return "&" + position.getPos() +
+				"&"" + font + ",Regular"&" + fontSize +
+				"&K000000" + prepareTextForXml(text);
+	}
+
+	public void write(Writer writer) throws IOException {
+		writer.append(getContent());
+	}
+
+	private String prepareTextForXml(String text) {
+		switch (text.toLowerCase()) {
+			case "page 1 of ?":
+				return "Page &P of &N";
+			case "page 1, sheetname":
+				return "Page &P, &A";
+			case "page 1":
+				return "Page &P";
+			case "sheetname":
+				return "&A";
+			default:
+				XmlEscapeHelper xmlEscapeHelper = new XmlEscapeHelper();
+				return xmlEscapeHelper.escape(text);
+		}
+	}
+}

fastexcel-writer/src/main/java/org/dhatim/fastexcel/Worksheet.java

@@ -206,11 +206,11 @@ public class Worksheet implements Closeable {
     /**
      * Header map for left, central and right field text.
      */
-    private Map<Position,String> header = new LinkedHashMap();
+    private final Map<Position, MarginalInformation> header = new LinkedHashMap<>();
     /**
      * Footer map for left, central and right field text.
      */
-    private Map<Position,String> footer = new LinkedHashMap();
+    private final Map<Position, MarginalInformation> footer = new LinkedHashMap<>();
     /**
      * Range of repeating rows for the print setup.
      * (Those rows will be repeated on each page when document is printed.)
@@ -907,14 +907,14 @@ public void finish() throws IOException {
         /* write to header and footer */
         writer.append("<headerFooter differentFirst=\"false\" differentOddEven=\"false\">");
         writer.append("<oddHeader>");
-        if (header.get(Position.LEFT) != null) writer.append(header.get(Position.LEFT));
-        if (header.get(Position.CENTER) != null) writer.append(header.get(Position.CENTER));
-        if (header.get(Position.RIGHT) != null) writer.append(header.get(Position.RIGHT));
+        for (MarginalInformation headerEntry : header.values()) {
+            headerEntry.write(writer);
+        }
         writer.append("</oddHeader>");
         writer.append("<oddFooter>");
-        if (footer.get(Position.LEFT) != null) writer.append(footer.get(Position.LEFT));
-        if (footer.get(Position.CENTER) != null) writer.append(footer.get(Position.CENTER));
-        if (footer.get(Position.RIGHT) != null) writer.append(footer.get(Position.RIGHT));
+        for (MarginalInformation footerEntry : footer.values()) {
+            footerEntry.write(writer);
+        }
         writer.append("</oddFooter></headerFooter>");
 
 
@@ -1266,35 +1266,13 @@ public void repeatCols(int col) {
         this.repeatingCols = new RepeatColRange(col, col);
     }
 
-    /**
-     * Gets input text form and converts it into what will be written in the
-     * <header>/<footer> xml tag
-     * @param text Header/footer text input form
-     * @return (partial) String content of <header> or <footer> XML tag
-     */
-    private String prepareForXml(String text) {
-        switch(text.toLowerCase()) {
-            case "page 1 of ?":
-                return "Page &amp;P of &amp;N";
-            case "page 1, sheetname":
-                return "Page &amp;P, &amp;A";
-            case "page 1":
-                return "Page &amp;P";
-            case "sheetname":
-                return "&amp;A";
-            default:
-                return text;
-        }
-    }
-
     /**
      * Set footer text.
      * @param text - text input form or custom text
      * @param position - Position.LEFT/RIGHT/CENTER enum
      */
     public void footer(String text, Position position) {
-        this.footer.put(position, "&amp;" + position.getPos() +
-                                  prepareForXml(text));
+        this.footer.put(position, new MarginalInformation(text, position));
     }
 
     /**
@@ -1304,9 +1282,8 @@ public void footer(String text, Position position) {
      * @param fontSize - integer describing font size
      */
     public void footer(String text, Position position, int fontSize) {
-        this.footer.put(position, "&amp;" + position.getPos() +
-                                  "&amp;&quot;Times New Roman,Regular&quot;&amp;" + fontSize +
-                                  "&amp;K000000" + prepareForXml(text));
+        this.footer.put(position, new MarginalInformation(text, position)
+            .withFontSize(fontSize));
     }
 
     /**
@@ -1317,9 +1294,9 @@ public void footer(String text, Position position, int fontSize) {
      * @param fontSize - integer describing font size
      */
     public void footer(String text, Position position, String fontName, int fontSize) {
-        this.footer.put(position, "&amp;" + position.getPos() +
-                                  "&amp;&quot;" + fontName + ",Regular&quot;&amp;" + fontSize +
-                                  "&amp;K000000" + prepareForXml(text));
+        this.footer.put(position, new MarginalInformation(text, position)
+            .withFont(fontName)
+            .withFontSize(fontSize));
     }
 
     /**
@@ -1330,9 +1307,9 @@ public void footer(String text, Position position, String fontName, int fontSize
      * @param fontSize - integer describing font size
      */
     public void header(String text, Position position, String fontName, int fontSize) {
-        this.header.put(position, "&amp;" + position.getPos() +
-                                  "&amp;&quot;" + fontName + ",Regular&quot;&amp;" + fontSize +
-                                  "&amp;K000000" + prepareForXml(text));
+        this.header.put(position, new MarginalInformation(text, position)
+            .withFont(fontName)
+            .withFontSize(fontSize));
     }
 
     /**
@@ -1342,9 +1319,8 @@ public void header(String text, Position position, String fontName, int fontSize
      * @param fontSize - integer describing font size
      */
     public void header(String text, Position position, int fontSize) {
-        this.header.put(position, "&amp;" + position.getPos() +
-                                  "&amp;&quot;Times New Roman,Regular&quot;&amp;" + fontSize +
-                                  "&amp;K000000" + prepareForXml(text));
+        this.header.put(position, new MarginalInformation(text, position)
+            .withFontSize(fontSize));
     }
 
     /**
@@ -1353,8 +1329,7 @@ public void header(String text, Position position, int fontSize) {
      * @param position - Position.LEFT/RIGHT/CENTER enum
      */
     public void header(String text, Position position) {
-        this.header.put(position, "&amp;" + position.getPos() +
-                                  prepareForXml(text));
+        this.header.put(position, new MarginalInformation(text, position));
     }
 
     /**

fastexcel-writer/src/main/java/org/dhatim/fastexcel/Writer.java

@@ -65,61 +65,18 @@ Writer appendEscaped(String s) throws IOException {
         return append(s, true);
     }
 
-    /**
-     * Append a char with XML escaping. Invalid characters in XML 1.0 are
-     * ignored.
-     *
-     * @param c Character code point.
-     */
-    private void escape(int c) {
-        if (!(c == 0x9 || c == 0xa || c == 0xD
-                || (c >= 0x20 && c <= 0xd7ff)
-                || (c >= 0xe000 && c <= 0xfffd)
-                || (c >= 0x10000 && c <= 0x10ffff))) {
-            return;
-        }
-        switch (c) {
-            case '<':
-                sb.append("&lt;");
-                break;
-            case '>':
-                sb.append("&gt;");
-                break;
-            case '&':
-                sb.append("&amp;");
-                break;
-            case '\'':
-                sb.append("&apos;");
-                break;
-            case '"':
-                sb.append("&quot;");
-                break;
-            default:
-                if (c > 0x7e || c < 0x20) {
-                    sb.append("&#x").append(Integer.toHexString(c)).append(';');
-                } else {
-                    sb.append((char) c);
-                }
-                break;
-        }
-    }
-
     /**
      * Append a string with or without escaping.
      *
      * @param s String.
-     * @param escape Is the string escaped?
+     * @param escape Whether the string should be escaped or not
      * @return This writer.
      * @throws IOException If an I/O error occurs.
      */
     private Writer append(String s, boolean escape) throws IOException {
         if (escape) {
-            int offset = 0;
-            while (offset < s.length()) {
-                int codePoint = s.codePointAt(offset);
-                escape(codePoint);
-                offset += Character.charCount(codePoint);
-            }
+            XmlEscapeHelper xmlEscapeHelper = new XmlEscapeHelper();
+            sb.append(xmlEscapeHelper.escape(s));
         } else {
             sb.append(s);
         }

fastexcel-writer/src/main/java/org/dhatim/fastexcel/XmlEscapeHelper.java

@@ -0,0 +1,58 @@
+package org.dhatim.fastexcel;
+
+/**
+ * Helper which can apply XML escaping to a string
+ */
+public class XmlEscapeHelper {
+
+	/**
+	 * Apply XML escaping to a String.
+	 * Invalid characters in XML 1.0 are ignored.
+	 *
+	 * @param text text to be escaped
+	 * @return escaped text
+	 */
+	public String escape(final String text) {
+		int offset = 0;
+		StringBuilder sb = new StringBuilder();
+		while (offset < text.length()) {
+			int codePoint = text.codePointAt(offset);
+			sb.append(escape(codePoint));
+			offset += Character.charCount(codePoint);
+		}
+		return sb.toString();
+	}
+
+	/**
+	 * Escape char with XML escaping.
+	 * Invalid characters in XML 1.0 are ignored.
+	 *
+	 * @param c Character code point.
+	 */
+	private String escape(int c) {
+		if (!(c == 0x9 || c == 0xa || c == 0xD
+				|| (c >= 0x20 && c <= 0xd7ff)
+				|| (c >= 0xe000 && c <= 0xfffd)
+				|| (c >= 0x10000 && c <= 0x10ffff))) {
+			return "";
+		}
+		switch (c) {
+			case '<':
+				return "&lt;";
+			case '>':
+				return "&gt;";
+			case '&':
+				return "&amp;";
+			case '\'':
+				return "&apos;";
+			case '"':
+				return "&quot;";
+			default:
+				if (c > 0x7e || c < 0x20) {
+					return "&#x".concat(Integer.toHexString(c)).concat(";");
+				} else {
+					return String.valueOf((char) c);
+				}
+		}
+	}
+}