Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to register your own content provider for default template content #11317

Merged
merged 9 commits into from
Oct 27, 2021

Conversation

matthewcare
Copy link
Contributor

@matthewcare matthewcare commented Oct 7, 2021

Prerequisites

  • I have added steps to test this contribution in the description below

Description

Added functionality which allows you to register your own "default view content provider" for custom content generation when creating new templates in the back office.

Updated all tests, and marked the old method obsolete. I didn't remove it, as the class is public, and someone could have been using it.

It's my first time going this deep into the Umbraco source code, so if there are any files out of place, or not seeming to be in keep with the style, let me know and I'll move things about.
I put the registrations in a builder file that seems to be in keep with "file" stuff, I hope it's correct,

Testing

Create your custom provider

public class CustomViewContentProvider : IDefaultViewContentProvider
{
   public string GetDefaultFileContent(string layoutPageAlias = null, string modelClassName = null,
                       string modelNamespace = null,  string modelNamespaceAlias = null) => "super content";
}

and then register it

services.AddUnique<IDefaultViewContentProvider, CustomViewContentProvider>();
or as part of an IUmbracoBuilder
builder.SetDefaultViewContentProvider<CustomViewContentProvider>()

Create some templates in the back end, and verify the output is correct.

Add the ability to register your own content provider, so that you can change the content which is injeted into new templates
Obsolete old static method
Register new interfaces / classes (hopefully in the correct buidler)
Follow the convention of having a method on IUmbracoBuilder which allows you to set a custom content provider
Fix all of the unit / integration tests
Update integration tests to remove references to ViewHelper, to make the tests more focused on what they should be testing
Remove a string that gets appended to the default file content.
@umbrabot
Copy link

umbrabot commented Oct 7, 2021

Hi there @matthewcare, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

  • It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
  • The automated tests all pass (see "Checks" tab on this PR)
  • The level of security for this contribution is the same or improved
  • The level of performance for this contribution is the same or improved
  • Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
  • If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
  • The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

Add original ctor in case someone was using it, else this would be a breaking change
…t-view-content

# Conflicts:
#	src/Umbraco.Tests.UnitTests/Umbraco.Core/Templates/DefaultViewContentProviderTests.cs
#	src/Umbraco.Tests.UnitTests/Umbraco.Core/Templates/ViewHelperTests.cs
#	tests/Umbraco.Tests.UnitTests/Umbraco.Core/Templates/ViewHelperTests.cs
Copy link
Member

@bergmania bergmania left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but there are a breaking change we need to handle..

src/Umbraco.Core/IO/ViewHelper.cs Outdated Show resolved Hide resolved
Prevent breaking change by creating a new ctor

Update obsolete message
Use the static service provider in the obsolete ctor
Integration tests failing due to multiple ctors. Marking correct one for DI usage
@bergmania bergmania merged commit af5be82 into umbraco:v9/contrib Oct 27, 2021
@bergmania
Copy link
Member

Thanks @matthewcare 💪

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants