From 502713fdbbb129aa1492d51b4bfe5ecabf9656a9 Mon Sep 17 00:00:00 2001 From: kjac Date: Thu, 23 Feb 2023 16:57:49 +0100 Subject: [PATCH] Rename models as per new naming conventions + clean up duplicate models --- .../Document/CreateDocumentController.cs | 4 ++-- .../Document/UpdateDocumentController.cs | 4 ++-- .../Factories/DocumentEditingFactory.cs | 16 ++++++++-------- .../Factories/IDocumentEditingFactory.cs | 4 ++-- ...eBase.cs => ContentCreateRequestModelBase.cs} | 2 +- ...lBase.cs => ContentUpdateRequestModelBase.cs} | 2 +- .../ViewModels/Content/ValueViewModelBase.cs | 12 ------------ ...ateModel.cs => DocumentCreateRequestModel.cs} | 2 +- ...ateModel.cs => DocumentUpdateRequestModel.cs} | 2 +- .../Document/DocumentValueViewModel.cs | 2 +- 10 files changed, 19 insertions(+), 31 deletions(-) rename src/Umbraco.Cms.Api.Management/ViewModels/Content/{ContentModelCreateBase.cs => ContentCreateRequestModelBase.cs} (74%) rename src/Umbraco.Cms.Api.Management/ViewModels/Content/{ContentUpdateModelBase.cs => ContentUpdateRequestModelBase.cs} (71%) delete mode 100644 src/Umbraco.Cms.Api.Management/ViewModels/Content/ValueViewModelBase.cs rename src/Umbraco.Cms.Api.Management/ViewModels/Document/{DocumentCreateModel.cs => DocumentCreateRequestModel.cs} (63%) rename src/Umbraco.Cms.Api.Management/ViewModels/Document/{DocumentUpdateModel.cs => DocumentUpdateRequestModel.cs} (58%) diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Document/CreateDocumentController.cs b/src/Umbraco.Cms.Api.Management/Controllers/Document/CreateDocumentController.cs index 4b52328755..bcae8d7ed2 100644 --- a/src/Umbraco.Cms.Api.Management/Controllers/Document/CreateDocumentController.cs +++ b/src/Umbraco.Cms.Api.Management/Controllers/Document/CreateDocumentController.cs @@ -29,9 +29,9 @@ public class CreateDocumentController : DocumentControllerBase [ProducesResponseType(StatusCodes.Status201Created)] [ProducesResponseType(StatusCodes.Status400BadRequest)] [ProducesResponseType(StatusCodes.Status404NotFound)] - public async Task Create(DocumentCreateModel createModel) + public async Task Create(DocumentCreateRequestModel createRequestModel) { - ContentCreateModel model = _documentEditingFactory.MapCreateModel(createModel); + ContentCreateModel model = _documentEditingFactory.MapCreateModel(createRequestModel); Attempt result = await _contentEditingService.CreateAsync(model, CurrentUserId(_backOfficeSecurityAccessor)); return result.Success diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Document/UpdateDocumentController.cs b/src/Umbraco.Cms.Api.Management/Controllers/Document/UpdateDocumentController.cs index fec8277ce2..f115a4aaed 100644 --- a/src/Umbraco.Cms.Api.Management/Controllers/Document/UpdateDocumentController.cs +++ b/src/Umbraco.Cms.Api.Management/Controllers/Document/UpdateDocumentController.cs @@ -35,7 +35,7 @@ public class UpdateDocumentController : DocumentControllerBase [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status400BadRequest)] [ProducesResponseType(StatusCodes.Status404NotFound)] - public async Task Update(Guid key, DocumentUpdateModel updateModel) + public async Task Update(Guid key, DocumentUpdateRequestModel updateRequestModel) { IContent? content = _contentService.GetById(key); if (content == null) @@ -43,7 +43,7 @@ public class UpdateDocumentController : DocumentControllerBase return NotFound(); } - ContentUpdateModel model = _documentEditingFactory.MapUpdateModel(updateModel); + ContentUpdateModel model = _documentEditingFactory.MapUpdateModel(updateRequestModel); Attempt result = await _contentEditingService.UpdateAsync(content, model, CurrentUserId(_backOfficeSecurityAccessor)); return result.Success diff --git a/src/Umbraco.Cms.Api.Management/Factories/DocumentEditingFactory.cs b/src/Umbraco.Cms.Api.Management/Factories/DocumentEditingFactory.cs index 6f38c34222..2491b68150 100644 --- a/src/Umbraco.Cms.Api.Management/Factories/DocumentEditingFactory.cs +++ b/src/Umbraco.Cms.Api.Management/Factories/DocumentEditingFactory.cs @@ -5,20 +5,20 @@ namespace Umbraco.Cms.Api.Management.Factories; internal sealed class DocumentEditingFactory : ContentEditingFactory, IDocumentEditingFactory { - public ContentCreateModel MapCreateModel(DocumentCreateModel createModel) + public ContentCreateModel MapCreateModel(DocumentCreateRequestModel createRequestModel) { - ContentCreateModel model = MapContentEditingModel(createModel); - model.ContentTypeKey = createModel.ContentTypeKey; - model.TemplateKey = createModel.TemplateKey; - model.ParentKey = createModel.ParentKey; + ContentCreateModel model = MapContentEditingModel(createRequestModel); + model.ContentTypeKey = createRequestModel.ContentTypeKey; + model.TemplateKey = createRequestModel.TemplateKey; + model.ParentKey = createRequestModel.ParentKey; return model; } - public ContentUpdateModel MapUpdateModel(DocumentUpdateModel updateModel) + public ContentUpdateModel MapUpdateModel(DocumentUpdateRequestModel updateRequestModel) { - ContentUpdateModel model = MapContentEditingModel(updateModel); - model.TemplateKey = updateModel.TemplateKey; + ContentUpdateModel model = MapContentEditingModel(updateRequestModel); + model.TemplateKey = updateRequestModel.TemplateKey; return model; } diff --git a/src/Umbraco.Cms.Api.Management/Factories/IDocumentEditingFactory.cs b/src/Umbraco.Cms.Api.Management/Factories/IDocumentEditingFactory.cs index f65a291fc7..12a24a777e 100644 --- a/src/Umbraco.Cms.Api.Management/Factories/IDocumentEditingFactory.cs +++ b/src/Umbraco.Cms.Api.Management/Factories/IDocumentEditingFactory.cs @@ -5,7 +5,7 @@ namespace Umbraco.Cms.Api.Management.Factories; public interface IDocumentEditingFactory { - ContentCreateModel MapCreateModel(DocumentCreateModel createModel); + ContentCreateModel MapCreateModel(DocumentCreateRequestModel createRequestModel); - ContentUpdateModel MapUpdateModel(DocumentUpdateModel updateModel); + ContentUpdateModel MapUpdateModel(DocumentUpdateRequestModel updateRequestModel); } diff --git a/src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentModelCreateBase.cs b/src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentCreateRequestModelBase.cs similarity index 74% rename from src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentModelCreateBase.cs rename to src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentCreateRequestModelBase.cs index 12f50e7fb1..be12938dab 100644 --- a/src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentModelCreateBase.cs +++ b/src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentCreateRequestModelBase.cs @@ -1,6 +1,6 @@ namespace Umbraco.Cms.Api.Management.ViewModels.Content; -public abstract class ContentCreateModelBase +public abstract class ContentCreateRequestModelBase : ContentModelBase where TValueModel : ValueModelBase where TVariantModel : VariantModelBase diff --git a/src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentUpdateModelBase.cs b/src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentUpdateRequestModelBase.cs similarity index 71% rename from src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentUpdateModelBase.cs rename to src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentUpdateRequestModelBase.cs index c8ebbd84d5..d0834ff57a 100644 --- a/src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentUpdateModelBase.cs +++ b/src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentUpdateRequestModelBase.cs @@ -1,6 +1,6 @@ namespace Umbraco.Cms.Api.Management.ViewModels.Content; -public abstract class ContentUpdateModelBase +public abstract class ContentUpdateRequestModelBase : ContentModelBase where TValueModel : ValueModelBase where TVariantModel : VariantModelBase diff --git a/src/Umbraco.Cms.Api.Management/ViewModels/Content/ValueViewModelBase.cs b/src/Umbraco.Cms.Api.Management/ViewModels/Content/ValueViewModelBase.cs deleted file mode 100644 index 9dacaa9f2b..0000000000 --- a/src/Umbraco.Cms.Api.Management/ViewModels/Content/ValueViewModelBase.cs +++ /dev/null @@ -1,12 +0,0 @@ -namespace Umbraco.Cms.Api.Management.ViewModels.Content; - -public abstract class ValueViewModelBase -{ - public string? Culture { get; set; } - - public string? Segment { get; set; } - - public string Alias { get; set; } = string.Empty; - - public object? Value { get; set; } -} diff --git a/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentCreateModel.cs b/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentCreateRequestModel.cs similarity index 63% rename from src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentCreateModel.cs rename to src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentCreateRequestModel.cs index 40a7ddbecc..e63c8e9b83 100644 --- a/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentCreateModel.cs +++ b/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentCreateRequestModel.cs @@ -2,7 +2,7 @@ namespace Umbraco.Cms.Api.Management.ViewModels.Document; -public class DocumentCreateModel : ContentCreateModelBase +public class DocumentCreateRequestModel : ContentCreateRequestModelBase { public Guid ContentTypeKey { get; set; } diff --git a/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentUpdateModel.cs b/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentUpdateRequestModel.cs similarity index 58% rename from src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentUpdateModel.cs rename to src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentUpdateRequestModel.cs index 3bb4c780cd..75eecfbf5f 100644 --- a/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentUpdateModel.cs +++ b/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentUpdateRequestModel.cs @@ -2,7 +2,7 @@ namespace Umbraco.Cms.Api.Management.ViewModels.Document; -public class DocumentUpdateModel : ContentUpdateModelBase +public class DocumentUpdateRequestModel : ContentUpdateRequestModelBase { public Guid? TemplateKey { get; set; } } diff --git a/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentValueViewModel.cs b/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentValueViewModel.cs index c8211460cb..555e4f29bb 100644 --- a/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentValueViewModel.cs +++ b/src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentValueViewModel.cs @@ -2,6 +2,6 @@ namespace Umbraco.Cms.Api.Management.ViewModels.Document; -public class DocumentValueViewModel : ValueViewModelBase +public class DocumentValueViewModel : ValueModelBase { }