Better handling of fileNames on different OS

Author: isidore

java/org/approvaltests/CombinationApprovals.java

@@ -0,0 +1,12 @@
+package org.approvaltests;
+
+import org.approvaltests.legacycode.LegacyApprovals;
+
+public class CombinationApprovals
+{
+  public static void verifyAllCombinations(Object call, String method, Object[]... parametersVariations)
+      throws Exception
+  {
+    LegacyApprovals.LockDown(call, method, parametersVariations);
+  }
+}

java/org/approvaltests/reporters/GenericDiffReporter.java

@@ -4,10 +4,12 @@
 import java.util.Arrays;
 import java.util.List;
 
+import com.spun.util.SystemUtils;
 import com.spun.util.io.FileUtils;
 
 public class GenericDiffReporter implements EnvironmentAwareReporter
 {
+  public static final String STANDARD_ARGUMENTS    = "%s %s";
   public static boolean      REPORT_MISSING_FILES  = false;
   protected String           diffProgram;
   protected String           arguments;
@@ -19,7 +21,7 @@ public class GenericDiffReporter implements EnvironmentAwareReporter
                                                        ".tif", ".tiff");
   public GenericDiffReporter(String diffProgram, String diffProgramNotFoundMessage)
   {
-    this(diffProgram, "\"%s\" \"%s\"", diffProgramNotFoundMessage);
+    this(diffProgram, STANDARD_ARGUMENTS, diffProgramNotFoundMessage);
   }
   private GenericDiffReporter(String diffProgram, String argumentsFormat, String diffProgramNotFoundMessage)
   {
@@ -38,11 +40,31 @@ public void report(String received, String approved) throws Exception
   {
     if (!isWorkingInThisEnvironment(received)) { throw new RuntimeException(diffProgramNotFoundMessage); }
     FileUtils.createIfNeeded(approved);
-    Process exec = Runtime.getRuntime().exec(getCommandLine(received, approved));
+    Process exec = Runtime.getRuntime().exec(
+        getCommandLine(convertFileForCommandLine(received), convertFileForCommandLine(approved)));
     //    int waitFor = exec.waitFor();
     //    String text = DatabaseLifeCycleUtils.extractText(exec.getErrorStream());
     //    System.out.println(waitFor + text);
   }
+  public static String convertFileForCommandLine(String fileName)
+  {
+    return convertFileForCommandLine(fileName, SystemUtils.isWindowsEnviroment());
+  }
+  public static String convertFileForCommandLine(String fileName, boolean windowsOs)
+  {
+    if (!fileName.contains(" "))
+    {
+      return fileName;
+    }
+    else if (windowsOs)
+    {
+      return String.format("\"%s\"", fileName);
+    }
+    else
+    {
+      return fileName.replace(" ", "\\ ");
+    }
+  }
   public String getCommandLine(String received, String approved)
   {
     String command = "%s " + arguments;

java/org/approvaltests/reporters/macosx/DiffMergeReporter.java

@@ -12,6 +12,6 @@ public class DiffMergeReporter extends GenericDiffReporter
   public static final DiffMergeReporter INSTANCE     = new DiffMergeReporter();
   public DiffMergeReporter()
   {
-    super(DIFF_PROGRAM, "%s %s", MESSAGE, GenericDiffReporter.TEXT_FILE_EXTENSIONS);
+    super(DIFF_PROGRAM, GenericDiffReporter.STANDARD_ARGUMENTS, MESSAGE, GenericDiffReporter.TEXT_FILE_EXTENSIONS);
   }
 }

java/org/approvaltests/reporters/macosx/KaleidoscopeDiffReporter.java

@@ -19,6 +19,6 @@ public class KaleidoscopeDiffReporter extends GenericDiffReporter
   public static final KaleidoscopeDiffReporter INSTANCE     = new KaleidoscopeDiffReporter();
   public KaleidoscopeDiffReporter()
   {
-    super(DIFF_PROGRAM, "%s %s", MESSAGE, fileTypes);
+    super(DIFF_PROGRAM, GenericDiffReporter.STANDARD_ARGUMENTS, MESSAGE, fileTypes);
   }
 }

java/org/approvaltests/reporters/macosx/P4MergeReporter.java

@@ -21,6 +21,6 @@ public class P4MergeReporter extends GenericDiffReporter
   public static final P4MergeReporter INSTANCE     = new P4MergeReporter();
   public P4MergeReporter()
   {
-    super(DIFF_PROGRAM, "%s %s", P4MergeReporter.MESSAGE, fileTypes);
+    super(DIFF_PROGRAM, GenericDiffReporter.STANDARD_ARGUMENTS, P4MergeReporter.MESSAGE, fileTypes);
   }
 }

java/org/approvaltests/reporters/macosx/TkDiffReporter.java

@@ -12,6 +12,6 @@ public class TkDiffReporter extends GenericDiffReporter
   public static final TkDiffReporter INSTANCE     = new TkDiffReporter();
   public TkDiffReporter()
   {
-    super(DIFF_PROGRAM, "%s %s", MESSAGE, GenericDiffReporter.TEXT_FILE_EXTENSIONS);
+    super(DIFF_PROGRAM, GenericDiffReporter.STANDARD_ARGUMENTS, MESSAGE, GenericDiffReporter.TEXT_FILE_EXTENSIONS);
   }
 }

java/org/approvaltests/reporters/tests/GenericDiffReporterTest.java

@@ -5,8 +5,8 @@
 import junit.framework.TestCase;
 
 import org.approvaltests.Approvals;
+import org.approvaltests.CombinationApprovals;
 import org.approvaltests.reporters.GenericDiffReporter;
-import org.approvaltests.reporters.UseReporter;
 import org.approvaltests.reporters.macosx.P4MergeReporter;
 import org.approvaltests.reporters.macosx.TkDiffReporter;
 import org.approvaltests.reporters.windows.TortoiseTextDiffReporter;
@@ -15,7 +15,6 @@
 
 import com.spun.util.ClassUtils;
 
-@UseReporter(P4MergeReporter.class)
 public class GenericDiffReporterTest extends TestCase
 {
   public void testFileExtensions() throws Exception
@@ -42,6 +41,16 @@ public void testP4Merge() throws Exception
   {
     approveGenericReporter("a.png", "b.png", new P4MergeReporter());
   }
+  public void testCommandLineFileNames() throws Exception
+  {
+    String[] names = {"regular.txt", "with spaces.txt"};
+    Boolean[] osTypes = {true, false};
+    CombinationApprovals.verifyAllCombinations(this, "getFileName", names, osTypes);
+  }
+  public String getFileName(String name, Boolean osType)
+  {
+    return GenericDiffReporter.convertFileForCommandLine(name, osType);
+  }
   private void approveGenericReporter(String a, String b, GenericDiffReporter reporter) throws Exception
   {
     File directory = ClassUtils.getSourceDirectory(getClass());

java/org/approvaltests/reporters/tests/GenericDiffReporterTest.testCommandLineFileNames.approved.txt

@@ -0,0 +1,4 @@
+[regular.txt, true] = regular.txt 
+[with spaces.txt, true] = "with spaces.txt" 
+[regular.txt, false] = regular.txt 
+[with spaces.txt, false] = with\ spaces.txt 

java/org/approvaltests/reporters/tests/GenericDiffReporterTest.testTortoiseDiff.approved.txt

@@ -1 +1 @@
-C:\Program Files\TortoiseSVN\bin\TortoiseMerge.exe "%s" "%s"
+C:\Program Files\TortoiseSVN\bin\TortoiseMerge.exe %s %s

java/org/approvaltests/reporters/tests/GenericDiffReporterTest.testWinMerge.approved.txt

@@ -1 +1 @@
-C:\Program Files\WinMerge\WinMergeU.exe "%s" "%s"
+C:\Program Files\WinMerge\WinMergeU.exe %s %s