Replaces multiple System.lineSeparator() calls with a constant for less visual clutter and to avoid calling the same method repeatedly.

mh120888 · mh120888 · commit c5f23dc5f478 · 2016-09-02T13:29:33.000-07:00
diff --git a/TEST b/TEST
@@ -0,0 +1,14 @@
+  1. Move the cursor to this line.
+
+  2. Press  v  and move the cursor to the fifth item below.  Notice that the
+     text is highlighted.
+
+  3. Press the  :  character.  At the bottom of the screen  :'<,'> will appear.
+
+  4. Type  w TEST  , where TEST is a filename that does not exist yet.  Verify
+     that you see  :'<,'>w TEST  before you press <ENTER>.
+
+  5. Vim will write the selected lines to the file TEST.  Use  :!dir  or  :!ls
+     to see it.  Do not remove it yet!  We will use it in the next lesson.
+
+NOTE:  Pressing  v  starts Visual selection.  You can move the cursor around
diff --git a/pom.xml b/pom.xml
@@ -61,11 +61,11 @@
                 <artifactId>cobertura-maven-plugin</artifactId>
                 <version>2.7</version>
                 <configuration>
-                <formats>
-                    <format>html</format>
-                    <format>xml</format>
-                </formats>
-            </configuration>
+                    <formats>
+                        <format>html</format>
+                        <format>xml</format>
+                    </formats>
+                </configuration>
                 <reportSets>
                     <reportSet>
                         <reports>
diff --git a/src/main/java/com/github/mh120888/basichttpmessage/BasicHTTPResponse.java b/src/main/java/com/github/mh120888/basichttpmessage/BasicHTTPResponse.java
@@ -6,6 +6,8 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;
+
 public class BasicHTTPResponse implements HTTPResponse {
     int status;
     String version = "";
@@ -41,16 +43,16 @@ public String getFormattedResponse() {
 
     public String getStatusLineAndHeaders() {
         String result = "";
-        result += version + " " + status + " " + getStatusText() + System.lineSeparator();
-        result += getFormattedHeaders() + System.lineSeparator();
+        result += version + " " + status + " " + getStatusText() + CRLF;
+        result += getFormattedHeaders() + CRLF;
 
         return result;
     }
 
     String getFormattedHeaders() {
         String result = "";
         for (Map.Entry<String, String> header : headers.entrySet()) {
-            result += header.getKey() + ": " + header.getValue() + System.lineSeparator();
+            result += header.getKey() + ": " + header.getValue() + CRLF;
         }
         return result;
     }
diff --git a/src/main/java/com/github/mh120888/basichttpmessage/RequestParser.java b/src/main/java/com/github/mh120888/basichttpmessage/RequestParser.java
@@ -4,6 +4,8 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;
+
 public class RequestParser {
     private String request;
 
@@ -45,7 +47,7 @@ public HashMap getParams(String pathWithParams) {
 
     public HashMap getHeaders(String headerInput) {
         HashMap<String, String> headers = new HashMap<>();
-        String[] splitUpHeaders = headerInput.split(System.lineSeparator());
+        String[] splitUpHeaders = headerInput.split(CRLF);
         for (String headerPair : splitUpHeaders) {
             String[] separatePair = headerPair.split(":");
             String headerName = separatePair[0];
diff --git a/src/main/java/com/github/mh120888/cobspecapp/GetStaticResourceAction.java b/src/main/java/com/github/mh120888/cobspecapp/GetStaticResourceAction.java
@@ -69,7 +69,7 @@ private byte[] getBodyForDirectory() {
     }
 
     private String renderHTMLLinkForFile(String fileName) {
-       return "<a href=\"/" + fileName + "\">" + fileName + "</a>\n";
+        return "<a href=\"/" + fileName + "\">" + fileName + "</a>\n";
     }
 
     private byte[] getBodyForFile() {
@@ -87,3 +87,4 @@ private boolean isPathADirectory() {
         return fileIO.isDirectory(filePath);
     }
 }
+
diff --git a/src/main/java/com/github/mh120888/cobspecapp/LogsAction.java b/src/main/java/com/github/mh120888/cobspecapp/LogsAction.java
@@ -6,6 +6,8 @@
 import com.github.mh120888.httpmessage.HTTPResponse;
 import com.github.mh120888.httpmessage.HTTPStatus;
 
+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;
+
 public class LogsAction implements Application {
     private String correctCredentials = "admin:hunter2";
 
@@ -25,7 +27,7 @@ private void setUnauthorizedResponse(HTTPResponse response) {
 
     private void setAuthorizedResponse(HTTPResponse response) {
         response.setStatus(HTTPStatus.OK);
-        response.setBody(String.join(System.lineSeparator(), Logger.getLog()).getBytes());
+        response.setBody(String.join(CRLF, Logger.getLog()).getBytes());
     }
 
     private boolean isAuthorized(HTTPRequest request) {
diff --git a/src/main/java/com/github/mh120888/cobspecapp/ParametersAction.java b/src/main/java/com/github/mh120888/cobspecapp/ParametersAction.java
@@ -7,6 +7,8 @@
 
 import java.util.Map;
 
+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;
+
 public class ParametersAction implements Application {
     private HTTPRequest request;
 
@@ -40,7 +42,7 @@ private byte[] getBody() {
     private String formatParametersForBody(Map<String, String> parameters) {
         String body = "";
         for (Map.Entry<String, String> entry : parameters.entrySet()) {
-            body += entry.getKey() + " = " + entry.getValue() + System.lineSeparator();
+            body += entry.getKey() + " = " + entry.getValue() + CRLF;
         }
         return body;
     }
diff --git a/src/main/java/com/github/mh120888/cobspecapp/Router.java b/src/main/java/com/github/mh120888/cobspecapp/Router.java
@@ -96,4 +96,3 @@ private static void configureRoutesBasedOnPublicDirectory() {
         addRoute("HEAD", "/index", headStaticResourceAction);
     }
 }
-
diff --git a/src/main/java/com/github/mh120888/httpmessage/MessageFormatting.java b/src/main/java/com/github/mh120888/httpmessage/MessageFormatting.java
@@ -0,0 +1,6 @@
+package com.github.mh120888.httpmessage;
+
+public class MessageFormatting {
+    public static final String CRLF = System.lineSeparator();
+
+}
diff --git a/src/main/java/com/github/mh120888/server/CommandLineArgsParser.java b/src/main/java/com/github/mh120888/server/CommandLineArgsParser.java
@@ -2,9 +2,11 @@
 
 import java.util.HashMap;
 
+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;
+
 public class CommandLineArgsParser {
-    private final static String usage = "Usage: java -jar javaserver-1.0-SNAPSHOT.jar [-pd]" + System.lineSeparator() +
-            "\t-p <port number> {80}" + System.lineSeparator() +
+    private final static String usage = "Usage: java -jar javaserver-1.0-SNAPSHOT.jar [-pd]" + CRLF +
+            "\t-p <port number> {80}" + CRLF +
             "\t-d <public directory> {.} (required)";
 
     public static HashMap<String, String> groupOptions(String[] args) {
diff --git a/src/main/java/com/github/mh120888/server/ConnectionHandler.java b/src/main/java/com/github/mh120888/server/ConnectionHandler.java
@@ -1,16 +1,18 @@
 package com.github.mh120888.server;
 
-import com.github.mh120888.httpmessage.HTTPRequest;
+import com.github.mh120888.app.Application;
 import com.github.mh120888.httpmessage.HTTPMessageFactory;
+import com.github.mh120888.httpmessage.HTTPRequest;
 import com.github.mh120888.httpmessage.HTTPResponse;
-import com.github.mh120888.app.Application;
 
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.io.PrintStream;
 import java.net.Socket;
 
+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;
+
 public class ConnectionHandler implements Runnable {
 
     private Socket clientSocket;
@@ -60,7 +62,7 @@ String readInHeaders(BufferedReader br) throws IOException {
         String input = "";
         String currentLine = br.readLine();
         while (currentLine != null && !currentLine.trim().isEmpty()) {
-            input += currentLine.trim() + System.lineSeparator();
+            input += currentLine.trim() + CRLF;
             currentLine = br.readLine();
         }
         return input;
diff --git a/src/test/java/com/github/mh120888/server/ConnectionHandlerTest.java b/src/test/java/com/github/mh120888/server/ConnectionHandlerTest.java
@@ -1,6 +1,5 @@
 package com.github.mh120888.server;
 
-import com.github.mh120888.app.Application;
 import com.github.mh120888.basichttpmessage.BasicHTTPMessageFactory;
 import com.github.mh120888.httpmessage.HTTPRequest;
 import com.github.mh120888.mocks.*;
@@ -16,6 +15,8 @@
 import java.net.ServerSocket;
 import java.net.Socket;
 
+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;
+
 public class ConnectionHandlerTest {
     ConnectionHandler connectionHandler;
     ServerSocket dummyServerSocket;
@@ -36,23 +37,25 @@ public void tearDown() throws IOException {
 
     @Test
     public void buildHttpRequestReturnsARequestObjectWithAProperRequestLine() throws IOException {
-        BufferedReader in = new BufferedReader(new StringReader("GET / HTTP/1.1\n"));
+        BufferedReader in = new BufferedReader(new StringReader("GET / HTTP/1.1"));
         HTTPRequest request = connectionHandler.buildHttpRequest(in);
 
         Assert.assertEquals("GET / HTTP/1.1", request.getInitialRequestLine());
     }
 
     @Test
     public void buildHttpRequestReturnsARequestObjectWithAnEmptyBodyWhenNoneIsProvided() throws IOException {
-        BufferedReader in = new BufferedReader(new StringReader("GET / HTTP/1.1\n"));
+        BufferedReader in = new BufferedReader(new StringReader("GET / HTTP/1.1"));
         HTTPRequest request = connectionHandler.buildHttpRequest(in);
 
         Assert.assertTrue(request.getBody().isEmpty());
     }
 
     @Test
     public void buildHttpRequestReturnsARequestObjectWithCorrectHeaders() throws IOException {
-        BufferedReader in = new BufferedReader(new StringReader("GET / HTTP/1.1\nTest header: 29393939\nAnother test: 40223840"));
+        BufferedReader in = new BufferedReader(new StringReader("GET / HTTP/1.1" + CRLF +
+                                                                "Test header: 29393939" + CRLF +
+                                                                "Another test: 40223840"));
         HTTPRequest request = connectionHandler.buildHttpRequest(in);
 
         Assert.assertTrue(request.containsHeader("Another test"));
@@ -61,9 +64,9 @@ public void buildHttpRequestReturnsARequestObjectWithCorrectHeaders() throws IOE
 
     @Test
     public void buildHttpRequestReturnsARequestObjectWithBody() throws IOException {
-        BufferedReader in = new BufferedReader(new StringReader("GET / HTTP/1.1\r\n" +
-                                                                "Content-Length: 12\n" +
-                                                                System.lineSeparator() +
+        BufferedReader in = new BufferedReader(new StringReader("GET / HTTP/1.1" + CRLF +
+                                                                "Content-Length: 12" + CRLF +
+                                                                CRLF +
                                                                 "body content"));
         HTTPRequest request = connectionHandler.buildHttpRequest(in);
 
@@ -100,22 +103,23 @@ public void readInHeadersTrimsEachLineAndEndsItWithANewlineCharacter() throws Ex
         BufferedReader in = new BufferedReader(new StringReader("Some string with whitespace at the end    "));
         String result = connectionHandler.readInHeaders(in);
 
-        Assert.assertEquals("Some string with whitespace at the end\n", result);
+        Assert.assertEquals("Some string with whitespace at the end" + CRLF, result);
     }
 
     @Test
     public void readInHeadersWorksProperlyForMultiLineInput() throws Exception {
-        BufferedReader in = new BufferedReader(new StringReader("Line one\nLine two   "));
+        BufferedReader in = new BufferedReader(new StringReader("Line one" + CRLF +
+                                                                "Line two   "));
         String result = connectionHandler.readInHeaders(in);
 
-        Assert.assertEquals("Line one\nLine two\n", result);
+        Assert.assertEquals("Line one" + CRLF + "Line two" + CRLF, result);
     }
 
     @Test
     public void generateOutputWritesToOutputStream() throws Exception {
         HTTPRequest request = new MockHTTPRequest();
         MockPrintStream out = new MockPrintStream(new MockOutputStream());
-        Application app = new MockApplication("Random response");
+        new MockApplication("Random response");
         connectionHandler.generateOutput(request, out);
 
         Assert.assertTrue(out.lastMessage.contains("Random response"));
diff --git a/src/test/java/com/github/mh120888/server/MyServerTest.java b/src/test/java/com/github/mh120888/server/MyServerTest.java
@@ -7,19 +7,20 @@
 import java.security.Permission;
 import java.util.HashMap;
 
+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;
 import static org.junit.Assert.assertEquals;
 
 public class MyServerTest {
     private final ByteArrayOutputStream outContent = new ByteArrayOutputStream();
     private final ByteArrayOutputStream errContent = new ByteArrayOutputStream();
     private SecurityManager securityManager;
-    private final int DEFAULTPORT = 3000;
-    private final String DEFAULTDIRECTORY = "/default/";
+    private final int DEFAULT_PORT = 3000;
+    private final String DEFAULT_DIRECTORY = "/default/";
 
     @org.junit.Before
     public void setUp() throws Exception {
-        MyServer.myPort = DEFAULTPORT;
-        MyServer.publicDirectory = DEFAULTDIRECTORY;
+        MyServer.myPort = DEFAULT_PORT;
+        MyServer.publicDirectory = DEFAULT_DIRECTORY;
 
         System.setOut(new PrintStream(outContent));
         System.setErr(new PrintStream(errContent));
@@ -55,7 +56,7 @@ public void getPortNumberReturnsDefaultPortIfNoPortSpecifiedInOptions() {
 
         int port = MyServer.getPortNumber(options);
 
-        Assert.assertEquals(DEFAULTPORT, port);
+        Assert.assertEquals(DEFAULT_PORT, port);
     }
 
     @Test
@@ -75,7 +76,7 @@ public void getPortNumberReturnsDefaultPortIfPortInOptionsIsNotAnInt() {
 
         int port = MyServer.getPortNumber(options);
 
-        Assert.assertEquals(DEFAULTPORT, port);
+        Assert.assertEquals(DEFAULT_PORT, port);
     }
 
     @Test
@@ -111,8 +112,8 @@ public void verifyAndSetOptionsDoesNotSetPortOrDirectoryIfDirectoryIsPresentButI
         } catch (SecurityException e) {
 
         } finally {
-            assertEquals(DEFAULTDIRECTORY, MyServer.publicDirectory);
-            assertEquals(DEFAULTPORT, MyServer.myPort);
+            assertEquals(DEFAULT_DIRECTORY, MyServer.publicDirectory);
+            assertEquals(DEFAULT_PORT, MyServer.myPort);
         }
     }
 
@@ -130,7 +131,7 @@ public void verifyAndSetOptionsSetsPortAndDirectoryWhenBothOptionsArePresentAndV
     public void printRunningMessageDisplaysThatTheServerIsRunningOnTheCorrectPort() {
         MyServer.printRunningMessage();
 
-        assertEquals("Server running on port " + MyServer.myPort + System.lineSeparator(), outContent.toString());
+        assertEquals("Server running on port " + MyServer.myPort + CRLF, outContent.toString());
     }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ private byte[] getBodyForDirectory() {`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`private String renderHTMLLinkForFile(String fileName) {`
`72`		`- return "<a href=\"/" + fileName + "\">" + fileName + "</a>\n";`
	`72`	`+ return "<a href=\"/" + fileName + "\">" + fileName + "</a>\n";`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`private byte[] getBodyForFile() {`
`@@ -87,3 +87,4 @@ private boolean isPathADirectory() {`
`87`	`87`	`return fileIO.isDirectory(filePath);`
`88`	`88`	`}`
`89`	`89`	`}`
	`90`	`+`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`import java.util.Map;`
`9`	`9`
	`10`	`+import static com.github.mh120888.httpmessage.MessageFormatting.CRLF;`
	`11`	`+`
`10`	`12`	`public class ParametersAction implements Application {`
`11`	`13`	`private HTTPRequest request;`
`12`	`14`
`@@ -40,7 +42,7 @@ private byte[] getBody() {`
`40`	`42`	`private String formatParametersForBody(Map<String, String> parameters) {`
`41`	`43`	`String body = "";`
`42`	`44`	`for (Map.Entry<String, String> entry : parameters.entrySet()) {`
`43`		`- body += entry.getKey() + " = " + entry.getValue() + System.lineSeparator();`
	`45`	`+ body += entry.getKey() + " = " + entry.getValue() + CRLF;`
`44`	`46`	`}`
`45`	`47`	`return body;`
`46`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -96,4 +96,3 @@ private static void configureRoutesBasedOnPublicDirectory() {`
`96`	`96`	`addRoute("HEAD", "/index", headStaticResourceAction);`
`97`	`97`	`}`
`98`	`98`	`}`
`99`		`-`