πŸ–₯️ ComputerMapper Service Documentation

Welcome to the ComputerMapper documentation! This document provides an in-depth look into the IrbyImaging/Services/ComputerMapper.cs file, which defines the mapping logic between domain entities and view models for computer assets in the IrbyImaging application.


πŸ“‘ Table of Contents

  1. 🎯 Overview & Purpose
  2. πŸ› οΈ Dependencies & Technologies
  3. πŸ” UML Class Diagram
  4. πŸ”Œ IComputerMapper Interface
  5. πŸ–₯️ ComputerMapper Class
    5.1. βš™οΈ Constructor
    5.2. βž• Create Operations
    5.3. πŸ” Read Operations
    5.4. ✏️ Update Operations
    5.5. πŸ“œ History Operations
  6. 🧩 Helper Methods & Utilities
  7. πŸš€ Usage Examples
  8. πŸ§ͺ Sample Code Blocks
  9. πŸ“Œ Conclusion

1. 🎯 Overview & Purpose

The ComputerMapper service sits in the UI layer (Assembly: IrbyImaging.UI) and implements the IComputerMapper interface. Its primary responsibilities are:

  • Generate view models (ComputerCreateViewModel, ComputerDetailViewModel, etc.) from domain objects (Computer, AssetHistory).
  • Map incoming view models back to domain entities for Create and Update workflows.
  • Enrich view models with business logic (e.g., warranty calculations, status color‑coding).

These mappings decouple the UI from the business/domain layers and centralize all translation logic in one place.


2. πŸ› οΈ Dependencies & Technologies

Dependency Purpose
IrbyImaging.BusinessLogic.IAssetManager Retrieves metadata (models, OS, owners) for dropdowns and lookups.
IrbyImaging.DomainClasses.Computer Domain entity representing a computer asset.
IrbyImaging.DomainClasses.AssetHistory Domain entity capturing history of asset changes.
IrbyImaging.Models.* View models used in MVC views (Create, Detail, List, Edit, History).
IrbyImaging.Utility.Helpers Utility methods (e.g., generate SelectListItem lists).
Newtonsoft.Json Serializes/deserializes JSON for history snapshots.
.NET 6+ / C# 10 Language and framework.

3. πŸ” UML Class Diagram

classDiagram
    IComputerMapper <|.. ComputerMapper
    ComputerMapper o-- IAssetManager : depends on
    ComputerMapper ..> Helpers : uses
    ComputerMapper ..> JsonConvert : uses
    class IComputerMapper {
      <<interface>>
      +GenerateComputerCreateViewModel() : ComputerCreateViewModel
      +CreateViewModelToComputer(vm) : Computer
      +GenerateComputerDetailViewModel(c) : ComputerDetailViewModel
      +GenerateComputerListViewModel(cs, status) : ComputerListViewModel
      +ComputerToEditViewModel(c) : ComputerEditViewModel
      +EditViewModelToComputer(vm) : Computer
      +GenerateComputerHistoryViewModel(h) : HistoryViewModel
      +GenerateComputerHistoryListViewModel(hs) : HistoryListViewModel
    }

    class ComputerMapper {
      -IAssetManager _assetManager
      +ComputerMapper(assetManager)
      +GenerateComputerCreateViewModel()
      +CreateViewModelToComputer(vm)
      +GenerateComputerDetailViewModel(c)
      +GenerateComputerListViewModel(cs, status)
      +ComputerToEditViewModel(c)
      +EditViewModelToComputer(vm)
      +GenerateComputerHistoryViewModel(h)
      +GenerateComputerHistoryListViewModel(hs)
    }

4. πŸ”Œ IComputerMapper Interface

public interface IComputerMapper
{
    // Create
    ComputerCreateViewModel GenerateComputerCreateViewModel();
    Computer CreateViewModelToComputer(ComputerCreateViewModel viewModel);

    // Read
    ComputerDetailViewModel GenerateComputerDetailViewModel(Computer computer);
    ComputerListViewModel GenerateComputerListViewModel(IEnumerable<Computer> computers, AssetStatus status);

    // Update
    ComputerEditViewModel ComputerToEditViewModel(Computer computer);
    Computer EditViewModelToComputer(ComputerEditViewModel viewModel);

    // History
    HistoryViewModel GenerateComputerHistoryViewModel(AssetHistory history);
    HistoryListViewModel GenerateComputerHistoryListViewModel(IEnumerable<AssetHistory> assetHistories);
}

Key Points:

  • Defines mapping methods for all CRUD + history operations.
  • Segregates logic by operation type (Create, Read, Update, History).
  • Returns view models consumed by Razor views or APIs.

5. πŸ–₯️ ComputerMapper Class

public class ComputerMapper : IComputerMapper
{
    private readonly IAssetManager _assetManager;

    public ComputerMapper(IAssetManager assetManager)
    {
        _assetManager = assetManager;
    }

    // ... mapping methods ...
}

5.1 βš™οΈ Constructor

  • Signature: public ComputerMapper(IAssetManager assetManager)
  • Responsibility: Injects the IAssetManager service to fetch lookup data.

5.2 βž• Create Operations

GenerateComputerCreateViewModel

public ComputerCreateViewModel GenerateComputerCreateViewModel()
{
    var viewModel = new ComputerCreateViewModel
    {
        ModelList             = Helpers.GenerateSelectListFor(_assetManager.GetModelsFor(AssetCategory.Computer)),
        OperatingSystemList   = Helpers.GenerateSelectListFor(_assetManager.GetOperatingSystems()),
        OwnerList             = Helpers.GenerateSelectListFor(_assetManager.GetOwners()),
        PurchaseDate          = DateTimeOffset.Now
    };
    return viewModel;
}
  • Purpose: Builds a blank form model populated with:
    • Dropdowns for Models, Operating Systems, Owners.
    • Default PurchaseDate = Now.
  • Output: ComputerCreateViewModel

CreateViewModelToComputer

public Computer CreateViewModelToComputer(ComputerCreateViewModel vm)
{
    return new Computer
    {
        Id                 = Guid.NewGuid(),
        SerialNumber       = vm.SerialNumber,
        Status             = vm.Status,
        PurchaseDate       = vm.PurchaseDate,
        ModelId            = vm.ModelId,
        OperatingSystemId  = vm.OperatingSystemId,
        OwnerId            = vm.OwnerId,
        AssetNumber        = vm.AssetNumber,
        UnitNumber         = vm.UnitNumber,
        CpsNumber          = vm.CpsNumber,
        Notes              = vm.Notes
    };
}
  • Purpose: Translates user input into a new Computer domain entity.
  • Note: Generates a new Guid for Id.

5.3 πŸ” Read Operations

GenerateComputerDetailViewModel

public ComputerDetailViewModel GenerateComputerDetailViewModel(Computer c)
{
    var vm = new ComputerDetailViewModel
    {
        Id                  = c.Id,
        SerialNumber        = c.SerialNumber,
        OwnerId             = c.OwnerId ?? Guid.Empty,
        OwnerFullName       = c.OwnerId != null ? c.Owner.FullName : "ERROR",
        EmployeeId          = c.Owner.JdeNumber,
        OperatingSystem     = c.OperatingSystem.Name,
        MakeAndModel        = $"{c.Model.Make.Name} {c.Model.Name}",
        PurchaseDate        = c.PurchaseDate,
        Status              = c.Status,
        AssetNumber         = c.AssetNumber,
        UnitNumber          = c.UnitNumber,
        CpsNumber           = c.CpsNumber,
        Notes               = c.Notes,
        EndOfWarranty       = c.PurchaseDate.AddYears(3).AddDays(-1),
        NeedsReview         = c.NeedsReview
    };

    // Warranty color logic
    if (DateTimeOffset.Now > vm.EndOfWarranty)
        vm.WarrantyColorClass = vm.IsOutOfWarranty   = "outOfWarranty";
    else if (DateTimeOffset.Now > vm.EndOfWarranty.AddMonths(-6))
        vm.WarrantyColorClass = vm.IsApproachingEndOfWarranty = "approachingEndOfWarranty";
    else
        vm.WarrantyColorClass = "inWarranty";

    // Status color logic
    vm.StatusColor = c.Status switch
    {
      AssetStatus.Active      => "irby-green",
      AssetStatus.Available   => "irby-blue",
      AssetStatus.LostOrStolen=> "irby-red",
      _                       => string.Empty
    };

    return vm;
}
  • Calculations:
    • EndOfWarranty = PurchaseDate + 3 years – 1 day
    • CSS classes for warranty and status highlighting
  • Output: ComputerDetailViewModel

GenerateComputerListViewModel

public ComputerListViewModel GenerateComputerListViewModel(IEnumerable<Computer> computers, AssetStatus status)
{
    var items = new List<ComputerDetailViewModel>();
    int outOfWarranty = 0, approaching = 0;

    foreach (var comp in computers)
    {
        if (status != AssetStatus.All && comp.Status != status) continue;

        var detailVm = GenerateComputerDetailViewModel(comp);
        if (detailVm.IsOutOfWarranty)      outOfWarranty++;
        else if (detailVm.IsApproachingEndOfWarranty) approaching++;

        items.Add(detailVm);
    }

    return new ComputerListViewModel
    {
        Computers                    = items,
        NumberApproachingEndOfWarranty = approaching.ToString(),
        NumberOutOfWarranty            = outOfWarranty.ToString(),
        Status                         = status
    };
}
  • Filters by status (unless All).
  • Aggregates warranty counts.
  • Output: ComputerListViewModel

5.4 ✏️ Update Operations

ComputerToEditViewModel

public ComputerEditViewModel ComputerToEditViewModel(Computer c)
{
    return new ComputerEditViewModel
    {
        Id                  = c.Id,
        SerialNumber        = c.SerialNumber,
        Status              = c.Status,
        PurchaseDate        = c.PurchaseDate,
        ModelId             = c.ModelId,
        OperatingSystemId   = c.OperatingSystemId,
        OwnerId             = c.OwnerId ?? Guid.Empty,
        ModelList           = Helpers.GenerateSelectListFor(_assetManager.GetModelsFor(AssetCategory.Computer)),
        OperatingSystemList = Helpers.GenerateSelectListFor(_assetManager.GetOperatingSystems()),
        OwnerList           = Helpers.GenerateSelectListFor(_assetManager.GetOwners()),
        AssetNumber         = c.AssetNumber,
        UnitNumber          = c.UnitNumber,
        CpsNumber           = c.CpsNumber,
        NeedsReview         = c.NeedsReview,
        Notes               = c.Notes
    };
}

EditViewModelToComputer

public Computer EditViewModelToComputer(ComputerEditViewModel vm)
{
    return new Computer
    {
        Id                 = vm.Id,
        SerialNumber       = vm.SerialNumber,
        Status             = vm.Status,
        PurchaseDate       = vm.PurchaseDate,
        ModelId            = vm.ModelId,
        OperatingSystemId  = vm.OperatingSystemId,
        OwnerId            = vm.OwnerId,
        AssetNumber        = vm.AssetNumber,
        UnitNumber         = vm.UnitNumber,
        CpsNumber          = vm.CpsNumber,
        NeedsReview        = vm.NeedsReview,
        Notes              = vm.Notes
    };
}
  • Purpose: Supports the Edit workflow by populating the form and then applying changes back to a Computer.

5.5 πŸ“œ History Operations

GenerateComputerHistoryViewModel

public HistoryViewModel GenerateComputerHistoryViewModel(AssetHistory history)
{
    return new HistoryViewModel
    {
        AssetId              = history.AssetId,
        Owner                = history.Owner,
        OwnerId              = history.OwnerId,
        ModifiedBy           = history.ModifiedBy,
        Status               = history.Status,
        Timestamp            = history.Timestamp,
        Reason               = history.Reason,
        SomeAsset            = JsonConvert.DeserializeObject<Computer>(history.SerializedProperties)
    };
}
  • Deserializes the SerializedProperties JSON into a Computer snapshot.
  • Output: HistoryViewModel

GenerateComputerHistoryListViewModel

public HistoryListViewModel GenerateComputerHistoryListViewModel(IEnumerable<AssetHistory> assetHistories)
{
    var historyVMs = assetHistories.Select(GenerateComputerHistoryViewModel).ToList();
    return new HistoryListViewModel
    {
        AssetId  = historyVMs.FirstOrDefault()?.AssetId ?? Guid.Empty,
        Histories = historyVMs
    };
}
  • Aggregates multiple history entries into a single list view.

6. 🧩 Helper Methods & Utilities

  • Helpers.GenerateSelectListFor
    Generates IEnumerable<SelectListItem> from domain objects:
    public static IEnumerable<SelectListItem> GenerateSelectListFor<T>(IEnumerable<T> items) { … }
    
  • JsonConvert from Newtonsoft.Json for serializing/deserializing history snapshots.

7. πŸš€ Usage Examples

Injecting the Mapper in a Controller

public class ComputerController : Controller
{
    private readonly IComputerMapper _mapper;
    private readonly IAssetManager   _assetManager;

    public ComputerController(IComputerMapper mapper, IAssetManager assetManager)
    {
        _mapper      = mapper;
        _assetManager = assetManager;
    }
    
    public IActionResult Create()
    {
        var vm = _mapper.GenerateComputerCreateViewModel();
        return View(vm);
    }

    [HttpPost]
    public IActionResult Create(ComputerCreateViewModel vm)
    {
        if (!ModelState.IsValid) return View(vm);
        
        var computer = _mapper.CreateViewModelToComputer(vm);
        _assetManager.AddComputer(computer);
        return RedirectToAction("Index");
    }
}

Listing Computers

public IActionResult Index(AssetStatus status = AssetStatus.All)
{
    var computers = _assetManager.GetAllComputers();
    var vm        = _mapper.GenerateComputerListViewModel(computers, status);
    return View(vm);
}

8. πŸ§ͺ Sample Code Blocks

Mapping Domain β†’ ViewModel

Computer domain = assetManager.GetComputerById(id);
var detailVM = mapper.GenerateComputerDetailViewModel(domain);
// Pass detailVM to Razor view for display

Mapping ViewModel β†’ Domain

[HttpPost]
public IActionResult Edit(ComputerEditViewModel vm)
{
    if (!ModelState.IsValid) return View(vm);
    
    Computer updated = mapper.EditViewModelToComputer(vm);
    assetManager.UpdateComputer(updated);
    return RedirectToAction("Details", new { id = updated.Id });
}

9. πŸ“Œ Conclusion

The ComputerMapper is a vital part of the UI layer that encapsulates all mapping logic for computer assets. By using this service:

  • You centralize transformation rules.
  • You ensure consistency across create, read, update, and history views.
  • You simplify controllers and views by offloading mapping concerns.

Feel free to extend or customize this mapper if your business logic evolves! πŸš€