Merge branch 'master' into fix-version-restriction

switchtrue · switchtrue · commit be8dfaf4211f · 2014-12-09T20:54:29.000+11:00
* master:
  Tidy up.
  Change package name to remove references to foxopen. This project has nothing to do with FOXopen other than that I use FOXopen in my day job. Most of the work I do on the JIRAChangelogBuilder project is done in my spare time.
diff --git a/.gitignore b/.gitignore
@@ -10,16 +10,13 @@
 .project
 bin
 
-.changelogcache/*
 .nb*
 nb*
 
 build
-changelog*
 target
 lib
-credentials.properties
-!/src/net/foxopen/jira/changelog/
-!/test/net/foxopen/jira/changelog/
+*.properties
 cache
-test*.txt
+test_output
+dependency-reduced-pom.xml
diff --git a/LICENCE b/LICENCE
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ When specifying `--object-cache-path` the Java objects used to store the changel
 Testing
 -------
 
-In order to execute the unit tests properly (and build/install the program), you must create a file named credentials.properties and place it in the base directory. In this file, add the following values:
+In order to execute the unit tests properly (and build/install the program), you must create a file named testing.properties and place it in the base directory. In this file, add the following values:
   
   * `url = <URL>` where `<URL>` is the web address of the JIRA instance.
   * `username = <username>` where `<username>` is the username of a user that can access the JIRA instance.
diff --git a/build.xml b/build.xml
diff --git a/pom.xml b/pom.xml
@@ -2,7 +2,7 @@
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
-	<groupId>net.foxopen.jira.changelog</groupId>
+	<groupId>com.switchtrue.jira.changelog</groupId>
 	<artifactId>jira-changelog-builder</artifactId>
 	<version>1.05.3</version>
 	<packaging>jar</packaging>
@@ -77,7 +77,7 @@
 							<transformers>
 								<transformer
 									implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
-									<mainClass>net.foxopen.jira.changelog.Changelog</mainClass>
+									<mainClass>com.switchtrue.jira.changelog.Changelog</mainClass>
 								</transformer>
 							</transformers>
 						</configuration>
diff --git a/src/com/switchtrue/jira/changelog/Change.java b/src/com/switchtrue/jira/changelog/Change.java
@@ -1,13 +1,10 @@
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.util.Comparator;
 import java.io.Serializable;
 
 /**
  * Represents a JIRA issue for display in the changelog.
- *
- * @author apigram
- * @version 1.03.00
  */
 public class Change implements Serializable {
 
diff --git a/src/com/switchtrue/jira/changelog/Changelog.java b/src/com/switchtrue/jira/changelog/Changelog.java
@@ -1,4 +1,4 @@
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.io.File;
 
diff --git a/src/com/switchtrue/jira/changelog/ChangelogBuilder.java b/src/com/switchtrue/jira/changelog/ChangelogBuilder.java
@@ -1,4 +1,4 @@
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.io.FileWriter;
 import java.io.IOException;
diff --git a/src/com/switchtrue/jira/changelog/ChangelogTemplate.java b/src/com/switchtrue/jira/changelog/ChangelogTemplate.java
@@ -2,7 +2,7 @@
  * To change this template, choose Tools | Templates
  * and open the template in the editor.
  */
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.util.HashMap;
 import java.util.List;
diff --git a/src/com/switchtrue/jira/changelog/JiraAPI.java b/src/com/switchtrue/jira/changelog/JiraAPI.java
@@ -1,4 +1,4 @@
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.net.URI;
 import java.net.URISyntaxException;
diff --git a/src/com/switchtrue/jira/changelog/LineEnding.java b/src/com/switchtrue/jira/changelog/LineEnding.java
@@ -2,7 +2,7 @@
  * To change this template, choose Tools | Templates
  * and open the template in the editor.
  */
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 /**
  * Represents the available line ending types supported by the changelog builder.
diff --git a/src/com/switchtrue/jira/changelog/Logger.java b/src/com/switchtrue/jira/changelog/Logger.java
@@ -1,4 +1,4 @@
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.text.SimpleDateFormat;
 import java.util.Date;
diff --git a/src/com/switchtrue/jira/changelog/Type.java b/src/com/switchtrue/jira/changelog/Type.java
@@ -2,7 +2,7 @@
  * To change this template, choose Tools | Templates
  * and open the template in the editor.
  */
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.util.LinkedList;
 import java.io.Serializable;
diff --git a/src/com/switchtrue/jira/changelog/VersionInfo.java b/src/com/switchtrue/jira/changelog/VersionInfo.java
@@ -1,4 +1,4 @@
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.io.Serializable;
 import java.text.SimpleDateFormat;
diff --git a/src/com/switchtrue/jira/changelog/VersionInfoCache.java b/src/com/switchtrue/jira/changelog/VersionInfoCache.java
@@ -1,4 +1,4 @@
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.io.File;
 import java.io.FileInputStream;
@@ -76,6 +76,9 @@ public VersionInfo getCached(String versionName) {
       fileIn.close();
       Logger.log("Cache hit for '" + versionName + "'");
       return vi;
+    } catch (ClassCastException cce) {
+      // The cached file found is not a VersionInfo object so don't use the cached version, fetch it again.
+      return null;
     } catch (FileNotFoundException fnf) {
       Logger.log("Cache miss for '" + versionName + "'");
       return null; // OK, don't use cache.
diff --git a/test/com/switchtrue/jira/changelog/ChangelogTemplateTest.java b/test/com/switchtrue/jira/changelog/ChangelogTemplateTest.java
@@ -2,7 +2,7 @@
  * To change this template, choose Tools | Templates
  * and open the template in the editor.
  */
-package net.foxopen.jira.changelog;
+package com.switchtrue.jira.changelog;
 
 import java.io.*;
 import java.util.Date;
@@ -31,6 +31,16 @@ public ChangelogTemplateTest(String testName) {
   @Override
   protected void setUp() throws Exception {
     super.setUp();
+    
+    File outputDir = new File("test_output");
+    if (!outputDir.exists()) {
+      try{
+        outputDir.mkdir();
+      } catch(SecurityException se){
+        throw se;
+      } 
+    }
+    
     issues = new LinkedList<Change>();
 
     issues.add(new Change("TESTPROJ-10", "Test Issue", "Bug"));
@@ -111,7 +121,7 @@ public void testXMLChangelog() throws Exception {
    */
   public void testFullRun() throws Exception {
     Properties properties = new Properties();
-    properties.load(new FileInputStream("credentials.properties"));
+    properties.load(new FileInputStream("testing.properties"));
     System.out.println("fullRun");
     String[] args = new String[12];
     args[0] = properties.getProperty("url");
@@ -123,22 +133,22 @@ public void testFullRun() throws Exception {
     args[6] = "html.mustache,plain-text.mustache";
     args[7] = "--debug";
     args[8] = "--changelog-file-name";
-    args[9] = "changelog.html,changelog.txt";
+    args[9] = "test_output" + File.separator + "changelog.html,test_output" + File.separator + "changelog.txt";
     args[10] = "--object-cache-path";
     args[11] = "cache";
 
     // wrapper function has same effect as main, minus the System.exit call.
     Changelog.main(args);
 
-    File f = new File("changelog.html");
+    File f = new File("test_output/changelog.html");
     assertTrue(f.exists());
   }
 
   public void testLineEndings() throws Exception {
     System.out.println("lineEndings");
-    FileWriter out1 = new FileWriter("testNative.txt");
-    FileWriter out2 = new FileWriter("testWindows.txt");
-    FileWriter out3 = new FileWriter("testNIX.txt");
+    FileWriter out1 = new FileWriter("test_output" + File.separator + "testNative.txt");
+    FileWriter out2 = new FileWriter("test_output" + File.separator + "testWindows.txt");
+    FileWriter out3 = new FileWriter("test_output" + File.separator + "testNIX.txt");
     try {
       ChangelogTemplate.fileRoot = "examples";
       ChangelogTemplate.createChangelog(versions, out1, "plain-text.mustache", LineEnding.NATIVE);

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package net.foxopen.jira.changelog;`
	`1`	`+package com.switchtrue.jira.changelog;`
`2`	`2`
`3`	`3`	`import java.io.File;`
`4`	`4`