comments

Author: kpwebb

app/controllers/api/SnapshotController.java

@@ -74,7 +74,7 @@ public static void createSnapshot () {
 		try {
 			// create a dummy snapshot from which to get values
 			Snapshot original = Base.mapper.readValue(params.get("body"), Snapshot.class);
-			Snapshot s = VersionedDataStore.takeSnapshot(original.agencyId, original.name);
+			Snapshot s = VersionedDataStore.takeSnapshot(original.agencyId, original.name, original.comment);
 			s.validFrom = original.validFrom;
 			s.validTo = original.validTo;
 			gtx = VersionedDataStore.getGlobalTx();

app/datastore/VersionedDataStore.java

@@ -78,7 +78,7 @@ static DB getRawAgencyTx (String agencyId) {
 	}
 
 	/** Take a snapshot of an agency database. The snapshot will be saved in the global database. */
-	public static Snapshot takeSnapshot (String agencyId, String name) {
+	public static Snapshot takeSnapshot (String agencyId, String name, String comment) {
 		AgencyTx tx = getAgencyTx(agencyId);
 		GlobalTx gtx = getGlobalTx();
 		int version = -1;
@@ -97,6 +97,7 @@ public static Snapshot takeSnapshot (String agencyId, String name) {
 
 			ret.snapshotTime = System.currentTimeMillis();
 			ret.name = name;
+			ret.comment = comment;
 			ret.current = true;
 
 			snapshot = getSnapshotDb(agencyId, version, false);

app/models/Snapshot.java

@@ -24,7 +24,10 @@ public class Snapshot implements Cloneable, Serializable {
 
 	/** The name of this snapshot */
 	public String name;
-	
+
+	/** The comment of this snapshot */
+	public String comment;
+
 	/** ID: agency ID, version */
     @JsonSerialize(using=JacksonSerializers.Tuple2IntSerializer.class)
     @JsonDeserialize(using=JacksonSerializers.Tuple2IntDeserializer.class)

app/views/Application/snapshots.html

@@ -29,12 +29,13 @@ <h2>&{'snapshot.for'} {{ agencyName }}</h2>
   </p>
   <table class="table table-striped">
     <thead>
-      <th>&{'snapshot.name'}</th><th>&{'snapshot.version'}</th><th>&{'snapshot.valid-from'}</th><th>&{'snapshot.valid-to'}</th><th>&{'snapshot.date'}</th><th>&{'snapshot.current'}<th>&{'snapshot.restore'}</th>
+      <th>&{'snapshot.name'}</th><th>&{'snapshot.comment'}</th><th>&{'snapshot.version'}</th><th>&{'snapshot.valid-from'}</th><th>&{'snapshot.valid-to'}</th><th>&{'snapshot.date'}</th><th>&{'snapshot.current'}<th>&{'snapshot.restore'}</th>
     </thead>
     <tbody>
       {{#snapshots}}
         <tr>
           <td>{{name}}</td>
+          <td>{{comment}}</td>
           <td>{{version}}</td>
           <td>{{validFrom}} <button class="btn btn-link edit-from" data-snapshot="{{id}}"><i class="icon-pencil"></i><span class="sr-only">&{'shared.button.edit'}</span></button></td>
           <td>{{validTo}} <button class="btn btn-link edit-to" data-snapshot="{{id}}"><i class="icon-pencil"></i><span class="sr-only">&{'shared.button.edit'}</span></button></td>
@@ -43,6 +44,7 @@ <h2>&{'snapshot.for'} {{ agencyName }}</h2>
           <td><button class="btn btn-link restore-snapshot" data-snapshot="{{id}}"><i class="icon-refresh"></i>&nbsp;&{'snapshot.restore'}</button></td>
           <td><a class="btn btn-link export-snapshot" href="api/snapshot/{{id}}.zip"><i class="icon-download"></i>&nbsp;&{'snapshot.download'}</button></td>
         </tr>
+
       {{/snapshots}}
     </tbody>
   </table>
@@ -64,6 +66,9 @@ <h3>&{'snapshot.take-snapshot'}</h3>
         <label for="snapshot-name">&{'snapshot.name'}</label>
         <input type="text" id="snapshot-name" />
 
+        <label for="snapshot-name">&{'snapshot.comment'}</label>
+        <textarea type="text" id="snapshot-comment"></textarea>
+
         <label for="valid-from">&{'snapshot.valid-from'}</label>
         <div class="input-append date" id="valid-from">
           <input size="96" type="text" />

conf/messages.en

@@ -157,6 +157,7 @@ snapshot.for=Snapshots for
 snapshot.new=Take snapshot
 snapshot.restore=Restore snapshot
 snapshot.name=Name
+snapshot.comment=Comment
 snapshot.date=Snapshot date
 snapshot.snapshots=Snapshots
 snapshot.take-before-restore=You must create a snapshot of the current state of the database before you can restore a previous version.

public/javascripts/models.js

@@ -600,6 +600,7 @@ G.Trip = Backbone.Model.extend({
   G.Snapshot = Backbone.Model.extend({
     defaults: {
       name: null,
+      comment: null,
       id: null,
       agencyId: null,
       snapshotTime: null,

public/javascripts/pages/snapshots.js

@@ -94,24 +94,26 @@ var GtfsEditor = GtfsEditor || {};
     takeSnapshot: function () {
       var instance = this;
       var name = this.$('#snapshot-name').val();
+      var comment = this.$('#snapshot-comment').val();
       var dfrom = this.toIso(this.$('#valid-from').data('datepicker').getDate());
       var dto = this.toIso(this.$('#valid-to').data('datepicker').getDate());
 
       this.$('#modal-container button.snapshot').prop('disabled', true).text('Saving . . .');
 
       this.collection.create({
             name: name,
+            comment: comment,
             validFrom: dfrom,
             validTo: dto,
             agencyId: G.session.agencyId
           }, {
             wait: true,
-
-
-      success: function () {
-        this.$('#modal-container > .modal').modal('hide').remove();
-        instance.collection.fetch({reset: true, data: {agencyId: G.session.agencyId}});
-      }});
+            success: function () {
+              this.$('#modal-container > .modal').modal('hide').remove();
+              instance.collection.fetch({reset: true, data: {agencyId: G.session.agencyId}});
+            }
+        }
+      );
     },
 
     /** convert a local date to an iso date */
@@ -134,8 +136,9 @@ var GtfsEditor = GtfsEditor || {};
     takeSnapshotAndRestore: function (e) {
       var instance = this;
       var name = this.$('#snapshot-name').val();
+      var comment = this.$('#snapshot-comment').val();
       this.$('#modal-container button.snapshot').prop('disabled', true).text('Saving . . .');
-      this.collection.create({name: name, agencyId: G.session.agencyId},
+      this.collection.create({name: name, comment: comment, agencyId: G.session.agencyId},
         {wait: true, success: function () {
           var id = $(e.target).attr('data-snapshot');
           instance.$('.restore-snapshot').prop('disabled', true);