Trim trailing whitespace when writing lines in java ref.

sansumbrella · sansumbrella · commit bf90ae84766b · 2013-06-11T12:51:17.000-04:00
diff --git a/java_generate/ReferenceGenerator/src/writers/TemplateWriter.java b/java_generate/ReferenceGenerator/src/writers/TemplateWriter.java
@@ -7,46 +7,46 @@
 import java.util.HashMap;
 
 public class TemplateWriter extends BaseWriter {
-	
+
 	public static String varPrefix = "<!-- ";
 	public static String varSuffix = " -->";
 	static String[] genericFields = {"classname", "returns", "related", "parameters", "syntax", "webcontentpath"};
 	static String[] navFields = {"isLibrary", "isAlphabetical", "isLanguage"};
-	
+
 	public TemplateWriter()
 	{
 	}
-	
+
 	public void write( String templateName, HashMap<String, String> vars, String outputName ) throws IOException
 	{
 		for(String s : genericFields){
 			if( ! vars.containsKey(s)){
 				vars.put(s, "");
 			}
 		}
-		
+
 		int unsetNavCount = 0;
 		for(String s : navFields){
 			if(!vars.containsKey(s)){
 				vars.put(s, "");
 				unsetNavCount++;
 			}else if(!vars.get(s).equals("")){
-				vars.put(s, "class='active'");				
+				vars.put(s, "class='active'");
 			}
-		}	
-		
+		}
+
 		if(unsetNavCount == navFields.length){
 			vars.put("isLanguage", "class='active'");
 		}
-		
+
 		Boolean written = write( templateName, vars, outputName, false );
 		write( templateName, vars, outputName, true );
 		if( written && Shared.i().isNoisy() )
-		{			
+		{
 			System.out.println("Wrote " + outputName + " from template");
 		}
 	}
-	
+
 	// returns a relative path to root (e.g. "../../" from "path/to/File.ext", or "" for "File.txt")
 	public String getRelativePathToRoot( String path )
 	{
@@ -58,7 +58,7 @@ public String getRelativePathToRoot( String path )
 		}
 		return ret;
 	}
-	
+
 	private Boolean write( String templateName, HashMap<String, String> vars, String outputName, Boolean isLocal ) throws IOException
 	{
 		String[] templateFile = FileUtils.loadStrings(Shared.i().TEMPLATE_DIRECTORY() + templateName);
@@ -73,57 +73,57 @@ private Boolean write( String templateName, HashMap<String, String> vars, String
 			vars.put( "webcontentpath",  "/" );
 			vars.put("navigation", writePartial("nav.web.template.html", vars));
 		}
-		
+
 		File f = new File( getWriterPath( outputName, isLocal ) );
-		
+
 		if( ! f.exists() )
-		{			
+		{
 			BufferedWriter out = makeWriter(outputName, isLocal);
-			
+
 			for( String line : templateFile )
 			{
-				//check if it contains a variable we want to replace, then replace it
-				line = writeLine(line, vars, false);		
+				// check if it contains a variable we want to replace, then replace it
+				line = writeLine(line, vars, false);
 				output.add(line);
 			}
 			for( String line : output )
 			{
-				out.write(line+"\n");			
+				out.write(line+"\n");
 			}
 			out.close();
-			
+
 			return true;
 		}
 		else
 		{
 			return false;
 		}
 	}
-	
+
 	public String writePartial( String templateName, HashMap<String, String> vars )
 	{	//use to write partials to be assigned to vars keys
 		String[] templateFile = FileUtils.loadStrings(Shared.i().TEMPLATE_DIRECTORY()+templateName);
 		String ret = "";
-		
+
 		for( String line : templateFile )
 		{
 			line = writeLine(line, vars, false );
 			ret = ret.concat(line+"\n");
 		}
-		
+
 		return ret;
 	}
-	
+
 	public String writeLoop( String templateName, ArrayList<HashMap<String, String>> varSet )
 	{
 		return writeLoop(templateName, varSet, "\n");
 	}
-	
+
 	public String writeLoop( String templateName, ArrayList<HashMap<String, String>> varSet, String separator )
 	{
 		String[] templateFile = FileUtils.loadStrings(Shared.i().TEMPLATE_DIRECTORY()+templateName);
 		String ret = "";
-		
+
 		int index = 0;
 		for( HashMap<String, String> vars : varSet )
 		{
@@ -138,7 +138,7 @@ public String writeLoop( String templateName, ArrayList<HashMap<String, String>>
 		}
 		return ret;
 	}
-	
+
 	private String writeLine(String line, HashMap<String, String> map, boolean isFinalLine )
 	{
 		for( String key : map.keySet())
@@ -149,20 +149,20 @@ private String writeLine(String line, HashMap<String, String> map, boolean isFin
 				value = value.replace("$", "\\$");
 				// what variable in html the value should replace
 				String var = varPrefix + key + varSuffix;
-				
+
 				// place our value into the html
 				line = line.replaceFirst(var, value);
-				
+
 				// find html that requires presence or lack of value
 				String requireStart = varPrefix + "require:" + key + varSuffix;
 				String requireEnd = varPrefix + "end" + varSuffix;
 				String requireAbsenceStart = varPrefix + "unless:" + key + varSuffix;
 				String unlessLastStart = varPrefix + "unless:last_fragment" + varSuffix;
-				
+
 				if(value.equals(""))
 				{	//remove html around things that are absent (like images)
 					while(line.contains(requireStart))
-					{	
+					{
 						String sub = line.substring(line.indexOf(requireStart), line.indexOf(requireEnd) + requireEnd.length());
 						line = line.replace(sub, "");
 					}
@@ -171,29 +171,30 @@ private String writeLine(String line, HashMap<String, String> map, boolean isFin
 				{
 					// remove things that should only exist in absence of this value
 					while(line.contains(requireAbsenceStart))
-					{	
+					{
 						String sub = line.substring(line.indexOf(requireAbsenceStart), line.indexOf(requireEnd) + requireEnd.length());
 						line = line.replace(sub, "");
 					}
 				}
-				
+
 				if( isFinalLine )
 				{
 					while(line.contains(unlessLastStart))
-					{	
+					{
 						String sub = line.substring(line.indexOf(unlessLastStart), line.indexOf(requireEnd) + requireEnd.length());
 						line = line.replace(sub, "");
 					}
 				}
-				
+
 				// finally, remove all the meta junk
 				line = line.replaceAll(requireStart, "");
 				line = line.replaceAll(requireEnd, "");
 				line = line.replaceAll(requireAbsenceStart, "");
 				line = line.replaceAll(unlessLastStart, "");
 			}
-		}			
-		return line;
+		}
+		// Strip trailing whitespace (trim() removes beginning and end)
+		return line.replaceAll("\\s+$", "");
 	}
-	
+
 }

Original file line number	Diff line number	Diff line change
`@@ -7,46 +7,46 @@`
`7`	`7`	`import java.util.HashMap;`
`8`	`8`
`9`	`9`	`public class TemplateWriter extends BaseWriter {`
`10`		`-`
	`10`	`+`
`11`	`11`	`public static String varPrefix = "<!-- ";`
`12`	`12`	`public static String varSuffix = " -->";`
`13`	`13`	`static String[] genericFields = {"classname", "returns", "related", "parameters", "syntax", "webcontentpath"};`
`14`	`14`	`static String[] navFields = {"isLibrary", "isAlphabetical", "isLanguage"};`
`15`		`-`
	`15`	`+`
`16`	`16`	`public TemplateWriter()`
`17`	`17`	`{`
`18`	`18`	`}`
`19`		`-`
	`19`	`+`
`20`	`20`	`public void write( String templateName, HashMap<String, String> vars, String outputName ) throws IOException`
`21`	`21`	`{`
`22`	`22`	`for(String s : genericFields){`
`23`	`23`	`if( ! vars.containsKey(s)){`
`24`	`24`	`vars.put(s, "");`
`25`	`25`	`}`
`26`	`26`	`}`
`27`		`-`
	`27`	`+`
`28`	`28`	`int unsetNavCount = 0;`
`29`	`29`	`for(String s : navFields){`
`30`	`30`	`if(!vars.containsKey(s)){`
`31`	`31`	`vars.put(s, "");`
`32`	`32`	`unsetNavCount++;`
`33`	`33`	`}else if(!vars.get(s).equals("")){`
`34`		`- vars.put(s, "class='active'");`
	`34`	`+ vars.put(s, "class='active'");`
`35`	`35`	`}`
`36`		`- }`
`37`		`-`
	`36`	`+ }`
	`37`	`+`
`38`	`38`	`if(unsetNavCount == navFields.length){`
`39`	`39`	`vars.put("isLanguage", "class='active'");`
`40`	`40`	`}`
`41`		`-`
	`41`	`+`
`42`	`42`	`Boolean written = write( templateName, vars, outputName, false );`
`43`	`43`	`write( templateName, vars, outputName, true );`
`44`	`44`	`if( written && Shared.i().isNoisy() )`
`45`		`- {`
	`45`	`+ {`
`46`	`46`	`System.out.println("Wrote " + outputName + " from template");`
`47`	`47`	`}`
`48`	`48`	`}`
`49`		`-`
	`49`	`+`
`50`	`50`	`// returns a relative path to root (e.g. "../../" from "path/to/File.ext", or "" for "File.txt")`
`51`	`51`	`public String getRelativePathToRoot( String path )`
`52`	`52`	`{`
`@@ -58,7 +58,7 @@ public String getRelativePathToRoot( String path )`
`58`	`58`	`}`
`59`	`59`	`return ret;`
`60`	`60`	`}`
`61`		`-`
	`61`	`+`
`62`	`62`	`private Boolean write( String templateName, HashMap<String, String> vars, String outputName, Boolean isLocal ) throws IOException`
`63`	`63`	`{`
`64`	`64`	`String[] templateFile = FileUtils.loadStrings(Shared.i().TEMPLATE_DIRECTORY() + templateName);`
`@@ -73,57 +73,57 @@ private Boolean write( String templateName, HashMap<String, String> vars, String`
`73`	`73`	`vars.put( "webcontentpath", "/" );`
`74`	`74`	`vars.put("navigation", writePartial("nav.web.template.html", vars));`
`75`	`75`	`}`
`76`		`-`
	`76`	`+`
`77`	`77`	`File f = new File( getWriterPath( outputName, isLocal ) );`
`78`		`-`
	`78`	`+`
`79`	`79`	`if( ! f.exists() )`
`80`		`- {`
	`80`	`+ {`
`81`	`81`	`BufferedWriter out = makeWriter(outputName, isLocal);`
`82`		`-`
	`82`	`+`
`83`	`83`	`for( String line : templateFile )`
`84`	`84`	`{`
`85`		`- //check if it contains a variable we want to replace, then replace it`
`86`		`- line = writeLine(line, vars, false);`
	`85`	`+ // check if it contains a variable we want to replace, then replace it`
	`86`	`+ line = writeLine(line, vars, false);`
`87`	`87`	`output.add(line);`
`88`	`88`	`}`
`89`	`89`	`for( String line : output )`
`90`	`90`	`{`
`91`		`- out.write(line+"\n");`
	`91`	`+ out.write(line+"\n");`
`92`	`92`	`}`
`93`	`93`	`out.close();`
`94`		`-`
	`94`	`+`
`95`	`95`	`return true;`
`96`	`96`	`}`
`97`	`97`	`else`
`98`	`98`	`{`
`99`	`99`	`return false;`
`100`	`100`	`}`
`101`	`101`	`}`
`102`		`-`
	`102`	`+`
`103`	`103`	`public String writePartial( String templateName, HashMap<String, String> vars )`
`104`	`104`	`{ //use to write partials to be assigned to vars keys`
`105`	`105`	`String[] templateFile = FileUtils.loadStrings(Shared.i().TEMPLATE_DIRECTORY()+templateName);`
`106`	`106`	`String ret = "";`
`107`		`-`
	`107`	`+`
`108`	`108`	`for( String line : templateFile )`
`109`	`109`	`{`
`110`	`110`	`line = writeLine(line, vars, false );`
`111`	`111`	`ret = ret.concat(line+"\n");`
`112`	`112`	`}`
`113`		`-`
	`113`	`+`
`114`	`114`	`return ret;`
`115`	`115`	`}`
`116`		`-`
	`116`	`+`
`117`	`117`	`public String writeLoop( String templateName, ArrayList<HashMap<String, String>> varSet )`
`118`	`118`	`{`
`119`	`119`	`return writeLoop(templateName, varSet, "\n");`
`120`	`120`	`}`
`121`		`-`
	`121`	`+`
`122`	`122`	`public String writeLoop( String templateName, ArrayList<HashMap<String, String>> varSet, String separator )`
`123`	`123`	`{`
`124`	`124`	`String[] templateFile = FileUtils.loadStrings(Shared.i().TEMPLATE_DIRECTORY()+templateName);`
`125`	`125`	`String ret = "";`
`126`		`-`
	`126`	`+`
`127`	`127`	`int index = 0;`
`128`	`128`	`for( HashMap<String, String> vars : varSet )`
`129`	`129`	`{`
`@@ -138,7 +138,7 @@ public String writeLoop( String templateName, ArrayList<HashMap<String, String>>`
`138`	`138`	`}`
`139`	`139`	`return ret;`
`140`	`140`	`}`
`141`		`-`
	`141`	`+`
`142`	`142`	`private String writeLine(String line, HashMap<String, String> map, boolean isFinalLine )`
`143`	`143`	`{`
`144`	`144`	`for( String key : map.keySet())`
`@@ -149,20 +149,20 @@ private String writeLine(String line, HashMap<String, String> map, boolean isFin`
`149`	`149`	`value = value.replace("$", "\\$");`
`150`	`150`	`// what variable in html the value should replace`
`151`	`151`	`String var = varPrefix + key + varSuffix;`
`152`		`-`
	`152`	`+`
`153`	`153`	`// place our value into the html`
`154`	`154`	`line = line.replaceFirst(var, value);`
`155`		`-`
	`155`	`+`
`156`	`156`	`// find html that requires presence or lack of value`
`157`	`157`	`String requireStart = varPrefix + "require:" + key + varSuffix;`
`158`	`158`	`String requireEnd = varPrefix + "end" + varSuffix;`
`159`	`159`	`String requireAbsenceStart = varPrefix + "unless:" + key + varSuffix;`
`160`	`160`	`String unlessLastStart = varPrefix + "unless:last_fragment" + varSuffix;`
`161`		`-`
	`161`	`+`
`162`	`162`	`if(value.equals(""))`
`163`	`163`	`{ //remove html around things that are absent (like images)`
`164`	`164`	`while(line.contains(requireStart))`
`165`		`- {`
	`165`	`+ {`
`166`	`166`	`String sub = line.substring(line.indexOf(requireStart), line.indexOf(requireEnd) + requireEnd.length());`
`167`	`167`	`line = line.replace(sub, "");`
`168`	`168`	`}`
`@@ -171,29 +171,30 @@ private String writeLine(String line, HashMap<String, String> map, boolean isFin`
`171`	`171`	`{`
`172`	`172`	`// remove things that should only exist in absence of this value`
`173`	`173`	`while(line.contains(requireAbsenceStart))`
`174`		`- {`
	`174`	`+ {`
`175`	`175`	`String sub = line.substring(line.indexOf(requireAbsenceStart), line.indexOf(requireEnd) + requireEnd.length());`
`176`	`176`	`line = line.replace(sub, "");`
`177`	`177`	`}`
`178`	`178`	`}`
`179`		`-`
	`179`	`+`
`180`	`180`	`if( isFinalLine )`
`181`	`181`	`{`
`182`	`182`	`while(line.contains(unlessLastStart))`
`183`		`- {`
	`183`	`+ {`
`184`	`184`	`String sub = line.substring(line.indexOf(unlessLastStart), line.indexOf(requireEnd) + requireEnd.length());`
`185`	`185`	`line = line.replace(sub, "");`
`186`	`186`	`}`
`187`	`187`	`}`
`188`		`-`
	`188`	`+`
`189`	`189`	`// finally, remove all the meta junk`
`190`	`190`	`line = line.replaceAll(requireStart, "");`
`191`	`191`	`line = line.replaceAll(requireEnd, "");`
`192`	`192`	`line = line.replaceAll(requireAbsenceStart, "");`
`193`	`193`	`line = line.replaceAll(unlessLastStart, "");`
`194`	`194`	`}`
`195`		`- }`
`196`		`- return line;`
	`195`	`+ }`
	`196`	`+ // Strip trailing whitespace (trim() removes beginning and end)`
	`197`	`+ return line.replaceAll("\\s+$", "");`
`197`	`198`	`}`
`198`		`-`
	`199`	`+`
`199`	`200`	`}`