Extracted DTO assembling code to separate classes.

dddsample/src/main/java/se/citerus/dddsample/service/CargoServiceImpl.java

@@ -9,6 +9,8 @@ import se.citerus.dddsample.repository.CargoRepository;
 import se.citerus.dddsample.repository.CarrierMovementRepository;
 import se.citerus.dddsample.repository.LocationRepository;
 import se.citerus.dddsample.service.dto.*;
+import se.citerus.dddsample.service.dto.assembler.CargoRoutingDTOAssembler;
+import se.citerus.dddsample.service.dto.assembler.CargoTrackingDTOAssembler;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -57,35 +59,7 @@ public final class CargoServiceImpl implements CargoService {
       return null;
     }
 
-    final DeliveryHistory deliveryHistory = cargo.deliveryHistory();
-
-    // TODO: use DTO assemblers
-    final Location currentLocation = deliveryHistory.currentLocation();
-    final CarrierMovement currentCarrierMovement = deliveryHistory.currentCarrierMovement();
-    final CargoTrackingDTO dto = new CargoTrackingDTO(
-      cargo.trackingId().idString(),
-      cargo.origin().toString(),
-      cargo.finalDestination().toString(),
-      deliveryHistory.status(),
-      currentLocation == null ? null : currentLocation.unLocode().idString(),
-      currentCarrierMovement == null ? null : currentCarrierMovement.carrierMovementId().idString(),
-      cargo.isMisdirected()
-    );
-
-    final List<HandlingEvent> events = deliveryHistory.eventsOrderedByCompletionTime();
-    for (HandlingEvent event : events) {
-      final CarrierMovement cm = event.carrierMovement();
-      final String carrierIdString = (cm == null) ? "" : cm.carrierMovementId().idString();
-      dto.addEvent(new HandlingEventDTO(
-        event.location().toString(),
-        event.type().toString(),
-        carrierIdString,
-        event.completionTime(),
-        cargo.itinerary().isExpected(event)
-      ));
-    }
-    return dto;
-
+    return new CargoTrackingDTOAssembler().toDTO(cargo);
   }
 
   // TODO: move this to another class?
@@ -114,22 +88,11 @@ public final class CargoServiceImpl implements CargoService {
   public List<CargoRoutingDTO> loadAllForRouting() {
     final List<Cargo> allCargos = cargoRepository.findAll();
 
-    // TODO: use DTO assembler
+    final CargoRoutingDTOAssembler assembler = new CargoRoutingDTOAssembler();
     final List<CargoRoutingDTO> dtoList = new ArrayList<CargoRoutingDTO>(allCargos.size());
+
     for (Cargo cargo : allCargos) {
-      final CargoRoutingDTO dto = new CargoRoutingDTO(
-        cargo.trackingId().idString(),
-        cargo.origin().toString(),
-        cargo.finalDestination().toString()
-      );
-      for (Leg leg : cargo.itinerary().legs()) {
-        dto.addLeg(
-          leg.carrierMovement().carrierMovementId().idString(),
-          leg.from().unLocode().idString(),
-          leg.to().unLocode().idString()
-        );
-      }
-      dtoList.add(dto);
+      dtoList.add(assembler.toDTO(cargo));
     }
 
     return dtoList;
@@ -143,20 +106,7 @@ public final class CargoServiceImpl implements CargoService {
       return null;
     }
 
-    // TODO: use DTO assembler
-    final CargoRoutingDTO dto = new CargoRoutingDTO(
-      cargo.trackingId().idString(),
-      cargo.origin().toString(),
-      cargo.finalDestination().toString()
-    );
-    for (Leg leg : cargo.itinerary().legs()) {
-      dto.addLeg(
-        leg.carrierMovement().carrierMovementId().idString(),
-        leg.from().toString(),
-        leg.to().toString()
-      );
-    }
-    return dto;
+    return new CargoRoutingDTOAssembler().toDTO(cargo);
   }
 
   @Transactional(readOnly = false)

dddsample/src/main/java/se/citerus/dddsample/service/RoutingServiceImpl.java

@@ -5,8 +5,8 @@ import se.citerus.dddsample.domain.*;
 import se.citerus.dddsample.repository.CargoRepository;
 import se.citerus.dddsample.repository.CarrierMovementRepository;
 import se.citerus.dddsample.repository.LocationRepository;
-import se.citerus.dddsample.service.dto.assembler.DTOAssembler;
 import se.citerus.dddsample.service.dto.ItineraryCandidateDTO;
+import se.citerus.dddsample.service.dto.assembler.ItineraryCandidateDTOAssembler;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -27,39 +27,37 @@ public class RoutingServiceImpl implements RoutingService {
 
   @Transactional(readOnly = true)
   public List<ItineraryCandidateDTO> calculatePossibleRoutes(TrackingId trackingId, Specification specification) {
-    Cargo cargo = cargoRepository.find(trackingId);
+    final Cargo cargo = cargoRepository.find(trackingId);
     if (cargo == null) {
       return Collections.emptyList();
     }
+
     List<Location> allLocations = locationRepository.findAll();
 
     allLocations.remove(cargo.origin());
     allLocations.remove(cargo.finalDestination());
 
-    int candidateCount = getRandomNumberOfCandidates();
-    List<ItineraryCandidateDTO> candidates = new ArrayList<ItineraryCandidateDTO>(candidateCount);
+    final int candidateCount = getRandomNumberOfCandidates();
+    final List<ItineraryCandidateDTO> candidates = new ArrayList<ItineraryCandidateDTO>(candidateCount);
+    final ItineraryCandidateDTOAssembler assembler = new ItineraryCandidateDTOAssembler();
 
     for (int i = 0; i < candidateCount; i++) {
       allLocations = getRandomChunkOfLocations(allLocations);
-      List<Leg> legs = new ArrayList<Leg>(allLocations.size() - 1);
-
-      Location firstLegTo = allLocations.get(0);
+      final List<Leg> legs = new ArrayList<Leg>(allLocations.size() - 1);
+      final Location firstLegTo = allLocations.get(0);
 
-      CarrierMovement cm1 = carrierMovementRepository.find(new CarrierMovementId("CAR_002"));
+      final CarrierMovement cm1 = carrierMovementRepository.find(new CarrierMovementId("CAR_002"));
       legs.add(new Leg(cm1, cargo.origin(), firstLegTo));
 
       for (int j = 0; j < allLocations.size() - 1; j++) {
-        legs.add(new Leg(
-            getRandomCarrierMovement(),
-            allLocations.get(j), allLocations.get(j + 1)));
+        legs.add(new Leg(getRandomCarrierMovement(), allLocations.get(j), allLocations.get(j + 1)));
       }
 
-      Location lastLegFrom = allLocations.get(allLocations.size() - 1);
+      final Location lastLegFrom = allLocations.get(allLocations.size() - 1);
       legs.add(new Leg(getRandomCarrierMovement(), lastLegFrom, cargo.finalDestination()));
 
-      Itinerary itinerary = new Itinerary(legs);
-
-      candidates.add(DTOAssembler.toItineraryCandidateDTO(itinerary));
+      final Itinerary itinerary = new Itinerary(legs);
+      candidates.add(assembler.toDTO(itinerary));
     }
 
     return candidates;
@@ -67,8 +65,8 @@ public class RoutingServiceImpl implements RoutingService {
 
   private List<Location> getRandomChunkOfLocations(List<Location> allLocations) {
     Collections.shuffle(allLocations);
-    int total = allLocations.size();
-    int chunk = total > 4 ? (total - 4) + random.nextInt(5) : total;
+    final int total = allLocations.size();
+    final int chunk = total > 4 ? (total - 4) + random.nextInt(5) : total;
     return allLocations.subList(0, chunk);
   }
 
@@ -77,7 +75,7 @@ public class RoutingServiceImpl implements RoutingService {
   }
 
   private CarrierMovement getRandomCarrierMovement() {
-    CarrierMovementId id = new CarrierMovementId("CAR_00" + (random.nextInt(9) + 1));
+    final CarrierMovementId id = new CarrierMovementId("CAR_00" + (random.nextInt(9) + 1));
     return carrierMovementRepository.find(id);
   }
 

dddsample/src/main/java/se/citerus/dddsample/service/dto/CargoRoutingDTO.java

@@ -14,6 +14,13 @@ public final class CargoRoutingDTO {
   private final String finalDestination;
   private final List<LegDTO> legs;
 
+  /**
+   * Constructor.
+   *
+   * @param trackingId
+   * @param origin
+   * @param finalDestination
+   */
   public CargoRoutingDTO(final String trackingId, final String origin, final String finalDestination) {
     this.trackingId = trackingId;
     this.origin = origin;

dddsample/src/main/java/se/citerus/dddsample/service/dto/CargoTrackingDTO.java

@@ -21,6 +21,17 @@ public final class CargoTrackingDTO implements Serializable {
   private final StatusCode statusCode;
   private final boolean misdirected;
 
+  /**
+   * Constructor.
+   *
+   * @param trackingId
+   * @param origin
+   * @param finalDestination
+   * @param statusCode
+   * @param currentLocationId
+   * @param carrierMovementId
+   * @param isMisdirected
+   */
   public CargoTrackingDTO(final String trackingId, final String origin, final String finalDestination,
                           final StatusCode statusCode, final String currentLocationId, final String carrierMovementId,
                           final boolean isMisdirected) {

dddsample/src/main/java/se/citerus/dddsample/service/dto/HandlingEventDTO.java

@@ -14,6 +14,15 @@ public final class HandlingEventDTO implements Serializable {
   private final Date time;
   private boolean expected;
 
+  /**
+   * Constructor.
+   *
+   * @param location
+   * @param type
+   * @param carrier
+   * @param time
+   * @param expected
+   */
   public HandlingEventDTO(final String location, final String type, final String carrier, final Date time,
                           final boolean expected) {
     this.location = location;

dddsample/src/main/java/se/citerus/dddsample/service/dto/ItineraryCandidateDTO.java

@@ -10,6 +10,11 @@ public final class ItineraryCandidateDTO {
 
   private final List<LegDTO> legs;
 
+  /**
+   * Constructor.
+   *
+   * @param legs The legs for this itinerary.
+   */
   public ItineraryCandidateDTO(final List<LegDTO> legs) {
     this.legs = legs;
   }

dddsample/src/main/java/se/citerus/dddsample/service/dto/LegDTO.java

@@ -9,6 +9,13 @@ public final class LegDTO {
   private final String from;
   private final String to;
 
+  /**
+   * Constructor.
+   *
+   * @param carrierMovementId
+   * @param from
+   * @param to
+   */
   public LegDTO(final String carrierMovementId, final String from, final String to) {
     this.carrierMovementId = carrierMovementId;
     this.from = from;

dddsample/src/main/java/se/citerus/dddsample/service/dto/assembler/CargoRoutingDTOAssembler.java

@@ -0,0 +1,28 @@
+package se.citerus.dddsample.service.dto.assembler;
+
+import se.citerus.dddsample.domain.Cargo;
+import se.citerus.dddsample.domain.Leg;
+import se.citerus.dddsample.service.dto.CargoRoutingDTO;
+
+/**
+ * Assembler class for the CargoRoutingDTO.
+ */
+public class CargoRoutingDTOAssembler {
+
+  public CargoRoutingDTO toDTO(final Cargo cargo) {
+    final CargoRoutingDTO dto = new CargoRoutingDTO(
+      cargo.trackingId().idString(),
+      cargo.origin().toString(),
+      cargo.finalDestination().toString()
+    );
+    for (Leg leg : cargo.itinerary().legs()) {
+      dto.addLeg(
+        leg.carrierMovement().carrierMovementId().idString(),
+        leg.from().toString(),
+        leg.to().toString()
+      );
+    }
+    return dto;
+  }
+
+}

dddsample/src/main/java/se/citerus/dddsample/service/dto/assembler/CargoTrackingDTOAssembler.java

@@ -0,0 +1,46 @@
+package se.citerus.dddsample.service.dto.assembler;
+
+import se.citerus.dddsample.domain.*;
+import se.citerus.dddsample.service.dto.CargoTrackingDTO;
+import se.citerus.dddsample.service.dto.HandlingEventDTO;
+
+import java.util.List;
+
+/**
+ * Assembler class for the CargoTrackingDTO.
+ */
+public class CargoTrackingDTOAssembler {
+
+  public CargoTrackingDTO toDTO(final Cargo cargo) {
+    final DeliveryHistory deliveryHistory = cargo.deliveryHistory();
+    final Location currentLocation = deliveryHistory.currentLocation();
+    final CarrierMovement currentCarrierMovement = deliveryHistory.currentCarrierMovement();
+    final CargoTrackingDTO dto = new CargoTrackingDTO(
+      cargo.trackingId().idString(),
+      cargo.origin().toString(),
+      cargo.finalDestination().toString(),
+      deliveryHistory.status(),
+      currentLocation == null ? null : currentLocation.unLocode().idString(),
+      currentCarrierMovement == null ? null : currentCarrierMovement.carrierMovementId().idString(),
+      cargo.isMisdirected()
+    );
+
+    final List<HandlingEvent> events = deliveryHistory.eventsOrderedByCompletionTime();
+    for (HandlingEvent event : events) {
+      final CarrierMovement cm = event.carrierMovement();
+      final String carrierIdString = (cm == null) ? "" : cm.carrierMovementId().idString();
+      dto.addEvent(toHandlingEventDTO(cargo, event, carrierIdString));
+    }
+    return dto;
+  }
+
+  protected HandlingEventDTO toHandlingEventDTO(final Cargo cargo, HandlingEvent event, String carrierIdString) {
+    return new HandlingEventDTO(
+      event.location().toString(),
+      event.type().toString(),
+      carrierIdString,
+      event.completionTime(),
+      cargo.itinerary().isExpected(event)
+    );
+  }
+}

dddsample/src/main/java/se/citerus/dddsample/service/dto/assembler/DTOAssembler.java → dddsample/src/main/java/se/citerus/dddsample/service/dto/assembler/ItineraryCandidateDTOAssembler.java

@@ -1,32 +1,33 @@
-package se.citerus.dddsample.service.dto.assembler;
-
-import se.citerus.dddsample.domain.Itinerary;
-import se.citerus.dddsample.domain.Leg;
-import se.citerus.dddsample.domain.CarrierMovementId;
-import se.citerus.dddsample.domain.UnLocode;
-import se.citerus.dddsample.service.dto.ItineraryCandidateDTO;
-import se.citerus.dddsample.service.dto.LegDTO;
-
-import java.util.ArrayList;
-import java.util.List;
-
-/**
- * Handles assembly of DTOs from the domain model.
- */
-public class DTOAssembler {
-
-  public static ItineraryCandidateDTO toItineraryCandidateDTO(final Itinerary itinerary) {
-    final List<LegDTO> legDTOs = new ArrayList<LegDTO>(itinerary.legs().size());
-    for (Leg leg : itinerary.legs()) {
-      legDTOs.add(toLegDTO(leg));
-    }
-    return new ItineraryCandidateDTO(legDTOs);
-  }
-
-  private static LegDTO toLegDTO(final Leg leg) {
-    final CarrierMovementId id = leg.carrierMovement().carrierMovementId();
-    final UnLocode from = leg.from().unLocode();
-    final UnLocode to = leg.to().unLocode();
-    return new LegDTO(id.idString(), from.idString(), to.idString());
-  }
-}
+package se.citerus.dddsample.service.dto.assembler;
+
+import se.citerus.dddsample.domain.CarrierMovementId;
+import se.citerus.dddsample.domain.Itinerary;
+import se.citerus.dddsample.domain.Leg;
+import se.citerus.dddsample.domain.UnLocode;
+import se.citerus.dddsample.service.dto.ItineraryCandidateDTO;
+import se.citerus.dddsample.service.dto.LegDTO;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Assembler class for the ItineraryCandidateDTO.
+ */
+public class ItineraryCandidateDTOAssembler {
+
+  public ItineraryCandidateDTO toDTO(final Itinerary itinerary) {
+    final List<LegDTO> legDTOs = new ArrayList<LegDTO>(itinerary.legs().size());
+    for (Leg leg : itinerary.legs()) {
+      legDTOs.add(toLegDTO(leg));
+    }
+    return new ItineraryCandidateDTO(legDTOs);
+  }
+
+  protected LegDTO toLegDTO(final Leg leg) {
+    final CarrierMovementId id = leg.carrierMovement().carrierMovementId();
+    final UnLocode from = leg.from().unLocode();
+    final UnLocode to = leg.to().unLocode();
+    return new LegDTO(id.idString(), from.idString(), to.idString());
+  }
+
+}

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

@@ -35,7 +35,7 @@ public class CargoTrackingControllerTest extends TestCase {
     response = new MockHttpServletResponse();
     session = new MockHttpSession(servletContext);
     request.setSession(session);
-    
+
     controller = new CargoTrackingController();
     controller.setFormView("test-form");
     controller.setSuccessView("test-success");
@@ -46,18 +46,17 @@ public class CargoTrackingControllerTest extends TestCase {
     return new EmptyStubCargoService() {
 
       public CargoTrackingDTO track(TrackingId trackingId) {
-        Cargo cargo = new Cargo(trackingId, HONGKONG, TOKYO);
-        HandlingEvent event = new HandlingEvent(cargo, new Date(10L), new Date(20L), HandlingEvent.Type.RECEIVE, HONGKONG, null);
-
-        // TODO: use DTO assemblers
-        CargoTrackingDTO cargoDTO = new CargoTrackingDTO(
-                cargo.trackingId().idString(),
-                cargo.origin().unLocode().idString(),
-                cargo.finalDestination().unLocode().idString(),
-                StatusCode.CLAIMED,
-                "AAAAA",
-                "BALO",
-                false);
+        final Cargo cargo = new Cargo(trackingId, HONGKONG, TOKYO);
+        final HandlingEvent event = new HandlingEvent(cargo, new Date(10L), new Date(20L), HandlingEvent.Type.RECEIVE, HONGKONG, null);
+
+        final CargoTrackingDTO cargoDTO = new CargoTrackingDTO(
+          cargo.trackingId().idString(),
+          cargo.origin().unLocode().idString(),
+          cargo.finalDestination().unLocode().idString(),
+          StatusCode.CLAIMED,
+          "AAAAA",
+          "BALO",
+          false);
         cargoDTO.addEvent(new HandlingEventDTO(
           event.location().unLocode().idString(),
           event.type().toString(),
@@ -68,7 +67,7 @@ public class CargoTrackingControllerTest extends TestCase {
       }
     };
   }
-  
+
   private CargoService getCargoServiceNullMock() {
     return new EmptyStubCargoService();
   }
@@ -86,7 +85,7 @@ public class CargoTrackingControllerTest extends TestCase {
 
   public void testHandlePost() throws Exception {
     controller.setCargoService(getCargoServiceMock());
-    request.addParameter("trackingId","JKL456");
+    request.addParameter("trackingId", "JKL456");
     request.setMethod("POST");
 
     ModelAndView mav = controller.handleRequest(request, response);
@@ -102,7 +101,7 @@ public class CargoTrackingControllerTest extends TestCase {
     controller.setCargoService(getCargoServiceNullMock());
     request.setMethod("POST");
     request.setParameter("trackingId", "unknown-id");
-    
+
     ModelAndView mav = controller.handleRequest(request, response);
 
     assertEquals("test-form", mav.getViewName());