Merge branch 'JENKINS-21267'

ialbors-pfc · ialbors-pfc · commit 87d044b91502 · 2014-02-10T09:40:37.000+01:00
Conflicts:
	src/main/resources/hudson/plugins/nextexecutions/NextExecutionsWidget/index.jelly
diff --git a/pom.xml b/pom.xml
@@ -43,5 +43,12 @@
             <url>http://repo.jenkins-ci.org/public/</url>
         </pluginRepository>
     </pluginRepositories>
+    <dependencies>
+      <dependency>
+        <groupId>joda-time</groupId>
+        <artifactId>joda-time</artifactId>
+        <version>2.3</version>
+      </dependency>
+    </dependencies>                      
 </project>  
 
diff --git a/src/main/java/hudson/plugins/nextexecutions/NextBuilds.java b/src/main/java/hudson/plugins/nextexecutions/NextBuilds.java
@@ -15,9 +15,20 @@
 
 import net.sf.json.JSONObject;
 
+import org.joda.time.DateTime;
+import org.joda.time.Period;
+import org.joda.time.PeriodType;
+import org.joda.time.format.DateTimeFormatter;
+import org.joda.time.format.DateTimeFormatterBuilder;
+import org.joda.time.format.PeriodFormatter;
+import org.joda.time.format.PeriodFormatterBuilder;
 import org.kohsuke.stapler.QueryParameter;
 import org.kohsuke.stapler.StaplerRequest;
 
+/**
+ * Provides a way to get the project's next execution date.
+ * 
+ */
 public class NextBuilds implements Comparable, Describable<NextBuilds>{
 	private AbstractProject project;
 	private String name;
@@ -30,13 +41,39 @@ public NextBuilds(AbstractProject project, Calendar date) {
 		this.date = date;
 	}
 	
-	public String getDate() {
+	private String formatDate(Date d) {
 		String dateFormat = this.getDescriptor().getDateFormat();
 		if(dateFormat == null){
 			dateFormat = this.getDescriptor().getDefault();
 		}
 		SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
-		return sdf.format(date.getTime());
+		return sdf.format(d.getTime());
+	}
+	
+	public String getDate() {
+		return formatDate(date.getTime());
+	}
+	
+	public String getTimeToGo() {
+		DateTime now = new DateTime();
+		
+		PeriodType periodType = PeriodType.dayTime();
+		periodType.withMillisRemoved();
+		Period timeToGo = new Period(now, new DateTime(date.getTimeInMillis()),
+				periodType);  
+
+		PeriodFormatter pf = new PeriodFormatterBuilder().
+			appendDays().
+			appendSuffix("d").
+			appendSeparatorIfFieldsBefore(" ").
+			appendHours().
+			appendSuffix("h").
+			appendSeparatorIfFieldsBefore(" ").
+			appendMinutes().
+			appendSuffix("m").
+			toFormatter();
+		
+		return Messages.TimeToGo(pf.print(timeToGo));
 	}
 	
 	public String getName() {
diff --git a/src/main/java/hudson/plugins/nextexecutions/NextExecutionsComputerWidget.java b/src/main/java/hudson/plugins/nextexecutions/NextExecutionsComputerWidget.java
@@ -16,6 +16,15 @@
 import hudson.plugins.nextexecutions.NextBuilds.DescriptorImpl;
 import hudson.plugins.nextexecutions.utils.NextExecutionsUtils;
 
+
+/**
+ * Widget in the {@link Computer} page's sidebar with a list
+ * of projects (tied to that Computer) and their next scheduled 
+ * build's date. The list is sorted by date.
+ * 
+ * @author ialbors
+ *
+ */
 @Extension
 public class NextExecutionsComputerWidget extends ComputerPanelBox {
 	
diff --git a/src/main/java/hudson/plugins/nextexecutions/NextExecutionsWidget.java b/src/main/java/hudson/plugins/nextexecutions/NextExecutionsWidget.java
@@ -24,6 +24,14 @@
 import hudson.triggers.Trigger;
 import hudson.widgets.Widget;
 
+/**
+ * Widget in the main sidebar with a list
+ * of projects and their next scheduled 
+ * build's date. The list is sorted by date.
+ * 
+ * @author ialbors
+ *
+ */
 @Extension
 public class NextExecutionsWidget extends Widget {
 	private static final Logger LOGGER = Logger.getLogger(NextExecutionsWidget.class.getName());
diff --git a/src/main/java/hudson/plugins/nextexecutions/columns/NextExecutionColumn.java b/src/main/java/hudson/plugins/nextexecutions/columns/NextExecutionColumn.java
@@ -13,6 +13,14 @@
 import hudson.plugins.nextexecutions.*;
 import hudson.plugins.nextexecutions.utils.NextExecutionsUtils;
 
+/**
+ * 
+ * Column that shows the next scheduled date for a job.
+ * 
+ * @author ialbors
+ *
+ */
+
 public class NextExecutionColumn extends ListViewColumn {
 
 	@DataBoundConstructor
diff --git a/src/main/resources/hudson/plugins/nextexecutions/Messages.properties b/src/main/resources/hudson/plugins/nextexecutions/Messages.properties
@@ -1 +1,2 @@
-Format.Error=The date format pattern is not valid.
+Format.Error=The date format pattern is not valid.
+TimeToGo=(in {0})
diff --git a/src/main/resources/hudson/plugins/nextexecutions/NextExecutionsWidget/index.jelly b/src/main/resources/hudson/plugins/nextexecutions/NextExecutionsWidget/index.jelly
@@ -3,7 +3,7 @@
   <j:forEach var="w" items="${it.builds}">
     <tr>
       <td><a tooltip="${w.name}" href="${w.url}">${w.shortName}</a></td>
-      <td>${w.date}</td>
+      <td tooltip="${w.timeToGo}">${w.date}</td>
     </tr>
   </j:forEach>
 </l:pane>

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-Format.Error=The date format pattern is not valid.`
	`1`	`+Format.Error=The date format pattern is not valid.`
	`2`	`+TimeToGo=(in {0})`