Added two new Handling Events: RECEIVE and CLAIM

Modified start view and style to present new events
Added two new test cargos ABC and CBA in CargoRepositoryInMem

dddsample/src/main/java/se/citerus/dddsample/domain/Cargo.java

@@ -36,11 +36,22 @@ public class Cargo {
 
   public Location getCurrentLocation() {
     HandlingEvent lastEvent = history.last();
+    
+    // If we have no last event, we have not even received the package. Return unknown location
     if (lastEvent == null) {
-      return origin;
+      return Location.NULL;
     }
+   
+    Location location = lastEvent.getLocation();
     
-    return lastEvent.getLocation();
+    // If the last handling event has no idea of where the cargo is due to lack of CarrierMovement (like for CLAIM or RECEIVE events)
+    // location must be calculated based on event type and origin or final destination
+    // TODO: Maybe we need to refactor HandlingEvent.
+    if (location == Location.NULL){
+      location = (lastEvent.getType() == HandlingEvent.Type.CLAIM) ? finalDestination : origin;
+    }
+      
+    return location;
   }
 
   public TrackingId trackingId() {

dddsample/src/main/java/se/citerus/dddsample/domain/HandlingEvent.java

@@ -20,7 +20,7 @@ public class HandlingEvent implements Comparable<HandlingEvent> {
   private final Date time;
 
   public enum Type {
-    LOAD, UNLOAD
+    LOAD, UNLOAD, RECEIVE, CLAIM
   }
 
   public HandlingEvent(Date time, Type type, CarrierMovement carrierMovement) {
@@ -41,8 +41,37 @@ public class HandlingEvent implements Comparable<HandlingEvent> {
     return time;
   }
   
+  /**
+   * Returns the Location of the Cargo. The location is calculated based on the following rules:
+   * <br>For
+   * <ul>
+   * <li> RECEIVE events: Location.NULL is returned. This basically means that the cargo is at its origin but not yet loaded on a CarrierMovment
+   * <li> CLAIM events: Location.NULL is returned. This means that the cargo is at its final destination and has been unloaded and claimed by the customer.
+   * <li> LOAD events: The from Location is returned.
+   * <li> UNLOAD events: The to Location is returned.
+   * </ul> 
+   * 
+   * @return The Location
+   */
   public Location getLocation() {
-    return (type == HandlingEvent.Type.LOAD) ? carrierMovement.from() : carrierMovement.to();
+    Location location = Location.NULL;
+    
+    //My gosh! A switch statement....
+    switch (type) {
+      case LOAD:
+        location = carrierMovement.from();
+      break;
+
+      case UNLOAD:
+        location = carrierMovement.to();
+      break;
+      
+      default: 
+        // for others (RECEIVE, CLAIM) Location.NULL is fine...
+      break;
+    }
+    
+    return location;
   }
   
   

dddsample/src/main/java/se/citerus/dddsample/domain/Location.java

@@ -4,6 +4,11 @@ import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
 
 public class Location {
+  /**
+   * The NULL Location object
+   */
+  public static final Location NULL = new Location("");
+  
   private final String unlocode;
 
   public Location(String unlocode) {

dddsample/src/main/java/se/citerus/dddsample/repository/CargoRepositoryInMem.java

@@ -41,6 +41,8 @@ public class CargoRepositoryInMem implements CargoRepository {
   private void setup() throws Exception {
     String trackIdXYZ = "XYZ";
     final Cargo cargoXYZ = new Cargo(new TrackingId(trackIdXYZ), new Location("SESTO"), new Location("AUMEL"));
+    
+    cargoXYZ.handle(new HandlingEvent(getDate("2007-11-30"), HandlingEvent.Type.RECEIVE, null));
 
     final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
 
@@ -57,7 +59,9 @@ public class CargoRepositoryInMem implements CargoRepository {
     
     String trackIdZYX = "ZYX";
     final Cargo cargoZYX = new Cargo(new TrackingId(trackIdZYX), new Location("AUMEL"), new Location("SESTO"));
-
+    
+    cargoZYX.handle(new HandlingEvent(getDate("2007-12-09"), HandlingEvent.Type.RECEIVE, null));
+    
     final CarrierMovement melbourneToTokyo = new CarrierMovement(new Location("AUMEL"), new Location("JPTOK"));
 
     cargoZYX.handle(new HandlingEvent(getDate("2007-12-10"), HandlingEvent.Type.LOAD, melbourneToTokyo));
@@ -68,6 +72,27 @@ public class CargoRepositoryInMem implements CargoRepository {
     cargoZYX.handle(new HandlingEvent(getDate("2007-12-13"), HandlingEvent.Type.LOAD, tokyoToLosAngeles));
 
     cargoDb.put(trackIdZYX, cargoZYX);
+    
+    String trackIdABC = "ABC";
+    final Cargo cargoABC = new Cargo(new TrackingId(trackIdABC), new Location("SESTO"), new Location("FIHEL"));
+    
+    cargoABC.handle(new HandlingEvent(getDate("2008-01-01"), HandlingEvent.Type.RECEIVE, null));
+
+    final CarrierMovement stockholmToHelsinki = new CarrierMovement(new Location("SESTO"), new Location("FIHEL"));
+
+    cargoABC.handle(new HandlingEvent(getDate("2008-01-02"), HandlingEvent.Type.LOAD, stockholmToHelsinki));
+    cargoABC.handle(new HandlingEvent(getDate("2008-01-03"), HandlingEvent.Type.UNLOAD, stockholmToHelsinki));
+    cargoABC.handle(new HandlingEvent(getDate("2008-01-05"), HandlingEvent.Type.CLAIM, null));
+    
+    cargoDb.put(trackIdABC, cargoABC);
+    
+    String trackIdCBA = "CBA";
+    final Cargo cargoCBA = new Cargo(new TrackingId(trackIdCBA), new Location("FIHEL"), new Location("SESTO"));
+    
+    cargoCBA.handle(new HandlingEvent(getDate("2008-01-10"), HandlingEvent.Type.RECEIVE, null));
+
+    
+    cargoDb.put(trackIdCBA, cargoCBA);
   }
 
   /**

dddsample/src/main/webapp/style.css

@@ -221,4 +221,12 @@ input.radio {
 
 .event-type-UNLOAD {
   background: #FFCCFF;
+}
+
+.event-type-RECEIVE {
+  background: #FFFF99;
+}
+
+.event-type-CLAIM {
+  background: #66FF99;
 }

dddsample/src/test/java/se/citerus/dddsample/domain/CargoTest.java

@@ -7,121 +7,143 @@ import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 
+public class CargoTest extends TestCase {
 
-public class CargoTest extends TestCase{
-
-  public void testCurrentLocationAtOrigin() throws Exception {
+  public void testCurrentLocationUnknownWhenNoEvents() throws Exception {
     Location destination = new Location("AUMEL");
     Location origin = new Location("SESTO");
     Cargo cargo = new Cargo(new TrackingId("XYZ"), origin, destination);
 
-		assertEquals(origin, cargo.getCurrentLocation());
-	}
+    assertEquals(Location.NULL, cargo.getCurrentLocation());
+  }
+  
+  public void testCurrentLocationReceived() throws Exception {
+    Cargo cargo = populateCargoReceivedStockholm();
+
+    assertEquals(new Location("SESTO"), cargo.getCurrentLocation());
+  }
 
+  public void testCurrentLocationClaimed() throws Exception {
+    Cargo cargo = populateCargoClaimedMelbourne();
 
+    assertEquals(new Location("AUMEL"), cargo.getCurrentLocation());
+  }
+  
   public void testCurrentLocationUnloaded() throws Exception {
-		Cargo cargo = populateCargoOffHongKong();
-		
-		assertEquals(new Location("CNHGK"), cargo.getCurrentLocation());
-	}
-	
-	public void testCurrentLocationloaded() throws Exception {
-		Cargo cargo = populateCargoOnHamburg();
-		
-		assertEquals(new Location("DEHAM"), cargo.getCurrentLocation());
-	}
-	
-	public void testAtFinalLocation() throws Exception {
-		Cargo cargo = populateCargoOffMelbourne();
-		
-		assertTrue(cargo.atFinalDestiation());
-	}
-	
-	public void testNotAtFinalLocationWhenNotUnloaded() throws Exception {
-		Cargo cargo = populateCargoOnHongKong();
-		
-		assertFalse(cargo.atFinalDestiation());
-	}
-	
-	// TODO: Generate test data some better way
-	private Cargo populateCargoOffHongKong() throws Exception {
-		final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
-
-		final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
-
-	    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.LOAD, stockholmToHamburg));
-	    cargo.handle(new HandlingEvent(getDate("2007-12-02"), HandlingEvent.Type.UNLOAD, stockholmToHamburg));
-
-	    final CarrierMovement hamburgToHongKong =
-	       new CarrierMovement(new Location("DEHAM"), new Location("CNHGK"));
-
-	    cargo.handle(new HandlingEvent(getDate("2007-12-03"), HandlingEvent.Type.LOAD, hamburgToHongKong));
-	    cargo.handle(new HandlingEvent(getDate("2007-12-04"), HandlingEvent.Type.UNLOAD, hamburgToHongKong));
-	    
-		return cargo;
-	}
-	
-	private Cargo populateCargoOnHamburg() throws Exception {
-		final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
-
-		final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
-
-	    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.LOAD, stockholmToHamburg));
-	    cargo.handle(new HandlingEvent(getDate("2007-12-02"), HandlingEvent.Type.UNLOAD, stockholmToHamburg));
-
-	    final CarrierMovement hamburgToHongKong =
-	       new CarrierMovement(new Location("DEHAM"), new Location("CNHGK"));
-
-	    cargo.handle(new HandlingEvent(getDate("2007-12-03"), HandlingEvent.Type.LOAD, hamburgToHongKong));
-
-		return cargo;
-	}
-	private Cargo populateCargoOffMelbourne() throws Exception {
-		final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
-
-		final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
-
-	    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.LOAD, stockholmToHamburg));
-	    cargo.handle(new HandlingEvent(getDate("2007-12-02"), HandlingEvent.Type.UNLOAD, stockholmToHamburg));
-
-	    final CarrierMovement hamburgToHongKong =
-	       new CarrierMovement(new Location("DEHAM"), new Location("CNHGK"));
-
-	    cargo.handle(new HandlingEvent(getDate("2007-12-03"), HandlingEvent.Type.LOAD, hamburgToHongKong));
-	    cargo.handle(new HandlingEvent(getDate("2007-12-04"), HandlingEvent.Type.UNLOAD, hamburgToHongKong));
-
-	    final CarrierMovement hongKongToMelbourne =
-		       new CarrierMovement(new Location("CNHGK"), new Location("AUMEL"));
-	    
-	    cargo.handle(new HandlingEvent(getDate("2007-12-05"), HandlingEvent.Type.LOAD, hongKongToMelbourne));
-	    cargo.handle(new HandlingEvent(getDate("2007-12-07"), HandlingEvent.Type.UNLOAD, hongKongToMelbourne));
-	    
-		return cargo;
-	}
-	
-	private Cargo populateCargoOnHongKong() throws Exception {
-		final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
-
-		final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
-
-	    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.LOAD, stockholmToHamburg));
-	    cargo.handle(new HandlingEvent(getDate("2007-12-02"), HandlingEvent.Type.UNLOAD, stockholmToHamburg));
-
-	    final CarrierMovement hamburgToHongKong =
-	       new CarrierMovement(new Location("DEHAM"), new Location("CNHGK"));
-
-	    cargo.handle(new HandlingEvent(getDate("2007-12-03"), HandlingEvent.Type.LOAD, hamburgToHongKong));
-	    cargo.handle(new HandlingEvent(getDate("2007-12-04"), HandlingEvent.Type.UNLOAD, hamburgToHongKong));
-
-	    final CarrierMovement hongKongToMelbourne =
-		       new CarrierMovement(new Location("CNHGK"), new Location("AUMEL"));
-	    
-	    cargo.handle(new HandlingEvent(getDate("2007-12-05"), HandlingEvent.Type.LOAD, hongKongToMelbourne));
-	    
-		return cargo;
-	}
-	
-	/**
+    Cargo cargo = populateCargoOffHongKong();
+
+    assertEquals(new Location("CNHGK"), cargo.getCurrentLocation());
+  }
+
+  public void testCurrentLocationloaded() throws Exception {
+    Cargo cargo = populateCargoOnHamburg();
+
+    assertEquals(new Location("DEHAM"), cargo.getCurrentLocation());
+  }
+
+  public void testAtFinalLocation() throws Exception {
+    Cargo cargo = populateCargoOffMelbourne();
+
+    assertTrue(cargo.atFinalDestiation());
+  }
+
+  public void testNotAtFinalLocationWhenNotUnloaded() throws Exception {
+    Cargo cargo = populateCargoOnHongKong();
+
+    assertFalse(cargo.atFinalDestiation());
+  }
+
+  // TODO: Generate test data some better way
+  private Cargo populateCargoReceivedStockholm() throws Exception {
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.RECEIVE, null));
+
+    return cargo;
+  }
+  
+  private Cargo populateCargoClaimedMelbourne() throws Exception {
+    final Cargo cargo = populateCargoOffMelbourne();
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-09"), HandlingEvent.Type.CLAIM, null));
+    
+    return cargo;
+  }
+  
+  // TODO: Generate test data some better way
+  private Cargo populateCargoOffHongKong() throws Exception {
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
+
+    final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.LOAD, stockholmToHamburg));
+    cargo.handle(new HandlingEvent(getDate("2007-12-02"), HandlingEvent.Type.UNLOAD, stockholmToHamburg));
+
+    final CarrierMovement hamburgToHongKong = new CarrierMovement(new Location("DEHAM"), new Location("CNHGK"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-03"), HandlingEvent.Type.LOAD, hamburgToHongKong));
+    cargo.handle(new HandlingEvent(getDate("2007-12-04"), HandlingEvent.Type.UNLOAD, hamburgToHongKong));
+
+    return cargo;
+  }
+
+  private Cargo populateCargoOnHamburg() throws Exception {
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
+
+    final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.LOAD, stockholmToHamburg));
+    cargo.handle(new HandlingEvent(getDate("2007-12-02"), HandlingEvent.Type.UNLOAD, stockholmToHamburg));
+
+    final CarrierMovement hamburgToHongKong = new CarrierMovement(new Location("DEHAM"), new Location("CNHGK"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-03"), HandlingEvent.Type.LOAD, hamburgToHongKong));
+
+    return cargo;
+  }
+
+  private Cargo populateCargoOffMelbourne() throws Exception {
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
+
+    final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.LOAD, stockholmToHamburg));
+    cargo.handle(new HandlingEvent(getDate("2007-12-02"), HandlingEvent.Type.UNLOAD, stockholmToHamburg));
+
+    final CarrierMovement hamburgToHongKong = new CarrierMovement(new Location("DEHAM"), new Location("CNHGK"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-03"), HandlingEvent.Type.LOAD, hamburgToHongKong));
+    cargo.handle(new HandlingEvent(getDate("2007-12-04"), HandlingEvent.Type.UNLOAD, hamburgToHongKong));
+
+    final CarrierMovement hongKongToMelbourne = new CarrierMovement(new Location("CNHGK"), new Location("AUMEL"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-05"), HandlingEvent.Type.LOAD, hongKongToMelbourne));
+    cargo.handle(new HandlingEvent(getDate("2007-12-07"), HandlingEvent.Type.UNLOAD, hongKongToMelbourne));
+
+    return cargo;
+  }
+
+  private Cargo populateCargoOnHongKong() throws Exception {
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
+
+    final CarrierMovement stockholmToHamburg = new CarrierMovement(new Location("SESTO"), new Location("DEHAM"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-01"), HandlingEvent.Type.LOAD, stockholmToHamburg));
+    cargo.handle(new HandlingEvent(getDate("2007-12-02"), HandlingEvent.Type.UNLOAD, stockholmToHamburg));
+
+    final CarrierMovement hamburgToHongKong = new CarrierMovement(new Location("DEHAM"), new Location("CNHGK"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-03"), HandlingEvent.Type.LOAD, hamburgToHongKong));
+    cargo.handle(new HandlingEvent(getDate("2007-12-04"), HandlingEvent.Type.UNLOAD, hamburgToHongKong));
+
+    final CarrierMovement hongKongToMelbourne = new CarrierMovement(new Location("CNHGK"), new Location("AUMEL"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-05"), HandlingEvent.Type.LOAD, hongKongToMelbourne));
+
+    return cargo;
+  }
+
+  /**
    * Parse an ISO 8601 (YYYY-MM-DD) String to Date
    *
    * @param isoFormat String to parse.

dddsample/src/test/java/se/citerus/dddsample/domain/HandlingEventTest.java

@@ -0,0 +1,36 @@
+package se.citerus.dddsample.domain;
+
+import junit.framework.TestCase;
+
+public class HandlingEventTest extends TestCase {
+  public void testCurrentLocationLoadEvent() throws Exception {
+    Location locationAAA = new Location("AAA");
+    Location locationBBB = new Location("BBB");
+    CarrierMovement cm = new CarrierMovement(locationAAA, locationBBB);
+    
+    HandlingEvent ev = new HandlingEvent(null, HandlingEvent.Type.LOAD, cm);
+    
+    assertEquals(locationAAA, ev.getLocation());
+  }
+  
+  public void testCurrentLocationUnloadEvent() throws Exception {
+    Location locationAAA = new Location("AAA");
+    Location locationBBB = new Location("BBB");
+    CarrierMovement cm = new CarrierMovement(locationAAA, locationBBB);
+    
+    HandlingEvent ev = new HandlingEvent(null, HandlingEvent.Type.UNLOAD, cm);
+    
+    assertEquals(locationBBB, ev.getLocation());
+  }
+  
+  public void testCurrentLocationReceivedEvent() throws Exception {
+    HandlingEvent ev = new HandlingEvent(null, HandlingEvent.Type.RECEIVE, null);
+
+    assertEquals(Location.NULL, ev.getLocation());
+  }
+  public void testCurrentLocationClaimedEvent() throws Exception {
+    HandlingEvent ev = new HandlingEvent(null, HandlingEvent.Type.CLAIM, null);
+
+    assertEquals(Location.NULL, ev.getLocation());
+  }
+}

dddsample/src/test/java/se/citerus/dddsample/web/CargoTrackingControllerTest.java

@@ -10,6 +10,7 @@ import org.springframework.validation.Errors;
 import org.springframework.validation.FieldError;
 import org.springframework.web.servlet.ModelAndView;
 import se.citerus.dddsample.domain.Cargo;
+import se.citerus.dddsample.domain.HandlingEvent;
 import se.citerus.dddsample.domain.Location;
 import se.citerus.dddsample.domain.TrackingId;
 import se.citerus.dddsample.service.CargoService;
@@ -42,6 +43,7 @@ public class CargoTrackingControllerTest extends TestCase {
           new TrackingId(trackingId),
           new Location("AAA"),
           new Location("BBB"));
+        cargo.handle(new HandlingEvent(null, HandlingEvent.Type.RECEIVE, null)); //Cargo must be received to be at known location
         return cargo;
       }
     };