Merge pull request #4 from Gibe/release/1.0.0

Release/1.0.0

Author: tristanjthompson

.github/README.md

@@ -1,31 +1,66 @@
-# Models Builder .Property Override 
+# Umbraco.Community.ModelsBuilder.PropertyOverride 
 
 [![Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.ModelsBuilder.PropertyOverride?color=cc9900)](https://www.nuget.org/packages/Umbraco.Community.ModelsBuilder.PropertyOverride/)
 [![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.ModelsBuilder.PropertyOverride?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.ModelsBuilder.PropertyOverride)
 [![GitHub license](https://img.shields.io/github/license/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride?color=8AB803)](../LICENSE)
 
-TODO: describe your package
+This package re-introduces functionality for overriding ModelsBuilder property implementations that was lost in Umbraco 9+.
 
-<!--
-Including screenshots is a really good idea! 
+Umbraco versions 13.x - 15.x are supported.
 
-If you put images into /docs/screenshots, then you would reference them in this readme as, for example:
+Properties can be marked up with a re-implemented `[ImplementPropertyType("alias")]` attribute, which causes them to be ignored when generating models through the default ModelsBuilder.
 
-<img alt="..." src="https://github.com/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride/blob/develop/docs/screenshots/screenshot.png">
--->
+In addition, classes can be marked up with `[ImplementAllPropertyTypes]`, which causes all properties on the class to be ignored, this is functionally equivalent to adding `[ImplementPropertyType("alias")]` to every property on the class.
+
+Legacy (Umbraco 8.x) documentation for the `[ImplementPropertyType("alias")]` attribute can be found [here](https://our.umbraco.com/Documentation/Reference/Templating/Modelsbuilder/Control-Generation-vpre8_5#implement-property-type).
+
+## Examples
+
+`[ImplementPropertyType("alias")]` to ignore properties on an individual basis:
+
+```
+using Umbraco.Cms.Infrastructure.ModelsBuilder;
+
+namespace ModelsBuilder.PropertyOverride.TestSite.Models
+{
+    public partial class Home
+    {
+        [ImplementPropertyType("content")]
+        public global::Umbraco.Cms.Core.Models.Blocks.BlockListModel Content => this.Value<global::Umbraco.Cms.Core.Models.Blocks.BlockListModel>(_publishedValueFallback, "content");
+
+        [ImplementPropertyType("title")]
+        public virtual string Title => this.Value<string>(_publishedValueFallback, "title");
+    }
+}
+```
+
+`[ImplementAllPropertyTypes]` to ignore all properties:
+
+```
+using Umbraco.Cms.Infrastructure.ModelsBuilder;
+
+namespace ModelsBuilder.PropertyOverride.TestSite.Models
+{
+    [ImplementAllPropertyTypes]
+    public partial class HomePageBlock 
+    {
+        public virtual global::Umbraco.Cms.Core.Models.MediaWithCrops Image { get; set; }
+        public virtual string SubTitle { get; set; }
+        public virtual string Title { get; set; }
+    }
+}
+```
 
 ## Installation
 
-Add the package to an existing Umbraco website (v13+) from nuget:
+Add the package to an existing Umbraco website (Umbraco 13+) from nuget:
 
 `dotnet add package Umbraco.Community.ModelsBuilder.PropertyOverride`
 
-TODO *provide any other instructions for someone using your package*
-
 ## Contributing
 
-Contributions to this package are most welcome! Please read the [Contributing Guidelines](CONTRIBUTING.md).
+Contributions to this package are most welcome!
 
 ## Acknowledgments
 
-TODO
+[tristanjthompson](https://github.com/tristanjthompson) & [zade107](http://github/zade107)

docs/README_nuget.md

@@ -2,6 +2,65 @@
 
 [![Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.ModelsBuilder.PropertyOverride?color=cc9900)](https://www.nuget.org/packages/Umbraco.Community.ModelsBuilder.PropertyOverride/)
 [![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.ModelsBuilder.PropertyOverride?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.ModelsBuilder.PropertyOverride)
-[![GitHub license](https://img.shields.io/github/license/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride?color=8AB803)](https://github.com/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride/blob/main/LICENSE)
+[![GitHub license](https://img.shields.io/github/license/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride?color=8AB803)](../LICENSE)
 
-TODO: describe your package for nuget audience
+This package provides functionality for overriding Models Builder property implementations.
+
+Umbraco versions 13.x - 15.x are supported.
+
+Properties can be marked up with a re-implemented `[ImplementPropertyType("alias")]` attribute, which causes them to be ignored when generating models through the default Models Builder.
+
+In addition, classes can be marked up with `[ImplementAllPropertyTypes]`, which causes all properties on the class to be ignored, this is functionally equivalent to adding `[ImplementPropertyType("alias")]` to every property on the class.
+
+Legacy (8.x) documentation for the `[ImplementPropertyType("alias")]` attribute can be found [here](https://our.umbraco.com/Documentation/Reference/Templating/Modelsbuilder/Control-Generation-vpre8_5#implement-property-type).
+
+## Examples
+
+`[ImplementPropertyType("alias")]` to ignore properties on an individual basis:
+
+```
+using Umbraco.Cms.Infrastructure.ModelsBuilder;
+
+namespace ModelsBuilder.PropertyOverride.TestSite.Models
+{
+    public partial class Home
+    {
+        [ImplementPropertyType("content")]
+        public global::Umbraco.Cms.Core.Models.Blocks.BlockListModel Content => this.Value<global::Umbraco.Cms.Core.Models.Blocks.BlockListModel>(_publishedValueFallback, "content");
+
+        [ImplementPropertyType("title")]
+        public virtual string Title => this.Value<string>(_publishedValueFallback, "title");
+    }
+}
+```
+
+`[ImplementAllPropertyTypes]` to ignore all properties:
+
+```
+using Umbraco.Cms.Infrastructure.ModelsBuilder;
+
+namespace ModelsBuilder.PropertyOverride.TestSite.Models
+{
+    [ImplementAllPropertyTypes]
+    public partial class HomePageBlock 
+    {
+        public virtual global::Umbraco.Cms.Core.Models.MediaWithCrops Image { get; set; }
+        public virtual string SubTitle { get; set; }
+        public virtual string Title { get; set; }
+    }
+}
+```
+
+## Installation
+
+Add the package to an existing Umbraco website (v13+) from nuget:
+
+`dotnet add package Umbraco.Community.ModelsBuilder.PropertyOverride`
+
+## Contributing
+
+Contributions to this package are most welcome!
+
+## Acknowledgments
+
+[tristanjthompson](https://github.com/tristanjthompson) & [zade107](http://github/zade107)

src/ModelsBuilder.PropertyOverride.TestSite/Models/Generated/HomePageBlock.generated.cs

@@ -48,29 +48,5 @@ public HomePageBlock(IPublishedElement content, IPublishedValueFallback publishe
 		}
 
 		// properties
-
-		///<summary>
-		/// Image
-		///</summary>
-		[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Umbraco.ModelsBuilder.Embedded", "13.0.0+9dfb300")]
-		[global::System.Diagnostics.CodeAnalysis.MaybeNull]
-		[ImplementPropertyType("image")]
-		public virtual global::Umbraco.Cms.Core.Models.MediaWithCrops Image => this.Value<global::Umbraco.Cms.Core.Models.MediaWithCrops>(_publishedValueFallback, "image");
-
-		///<summary>
-		/// Sub title
-		///</summary>
-		[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Umbraco.ModelsBuilder.Embedded", "13.0.0+9dfb300")]
-		[global::System.Diagnostics.CodeAnalysis.MaybeNull]
-		[ImplementPropertyType("subTitle")]
-		public virtual string SubTitle => this.Value<string>(_publishedValueFallback, "subTitle");
-
-		///<summary>
-		/// Title
-		///</summary>
-		[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Umbraco.ModelsBuilder.Embedded", "13.0.0+9dfb300")]
-		[global::System.Diagnostics.CodeAnalysis.MaybeNull]
-		[ImplementPropertyType("title")]
-		public virtual string Title => this.Value<string>(_publishedValueFallback, "title");
 	}
 }

src/ModelsBuilder.PropertyOverride.TestSite/Models/HomePageBlock.cs

@@ -0,0 +1,12 @@
+using Umbraco.Cms.Infrastructure.ModelsBuilder;
+
+namespace ModelsBuilder.PropertyOverride.TestSite.Models
+{
+    [ImplementAllPropertyTypes]
+    public partial class HomePageBlock 
+    {
+        public virtual global::Umbraco.Cms.Core.Models.MediaWithCrops Image { get; set; }
+        public virtual string SubTitle { get; set; }
+        public virtual string Title { get; set; }
+    }
+}

src/ModelsBuilder.PropertyOverride.TestSite/umbraco/Data/Umbraco.sqlite.db-shm

@@ -0,0 +1,10 @@
+namespace Umbraco.Cms.Infrastructure.ModelsBuilder
+{
+    /// <summary>
+    /// Attribute which can be used to ignore every property when building models.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
+    public class ImplementAllPropertyTypesAttribute : Attribute
+    {
+    }
+}

src/ModelsBuilder.PropertyOverride.TestSite/umbraco/Data/Umbraco.sqlite.db-wal

@@ -12,7 +12,7 @@
     <PackageTags>umbraco;umbraco-marketplace</PackageTags>
     <RootNamespace>Umbraco.Community.ModelsBuilder.PropertyOverride</RootNamespace>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
-    <Version>0.1.0</Version>
+    <Version>1.0.0</Version>
     <Authors>Gibe Digital</Authors>
     <Copyright>$([System.DateTime]::UtcNow.ToString(`yyyy`)) © Gibe Digital</Copyright>
     <PackageProjectUrl>https://github.com/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride</PackageProjectUrl>

src/ModelsBuilder.PropertyOverride/Attributes/ImplementAllPropertyTypesAttribute.cs

@@ -93,6 +93,12 @@ private IList<TypeModel> FilterForImplementedProperties(IList<TypeModel> typeMod
                     continue;
                 }
 
+                if (underlyingType.GetCustomAttribute<ImplementAllPropertyTypesAttribute>(inherit: true) is not null)
+                {
+                    model.Properties.Clear();
+                    continue;
+                }
+
                 var aliasOverrides = underlyingType
                         .GetProperties()
                         .Where(propertyInfo => propertyInfo.GetCustomAttribute<GeneratedCodeAttribute>(inherit: true) is null)

src/ModelsBuilder.PropertyOverride/ModelsBuilder.PropertyOverride.csproj

@@ -1,14 +1,15 @@
 {
-    "$schema": "https://marketplace.umbraco.com/umbraco-marketplace-schema.json", 
-    "AuthorDetails": {
-      "Name": "Gibe Digital",
-      "ImageUrl": "https://github.com/Gibe.png"
-    },
-    "Category": "",
-    "Description": "",
-    "LicenseTypes": [ "Free" ],
-    "IssueTrackerUrl": "https://github.com/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride/issues",
-    "PackageType": "Package",
-    "Tags": [],
-    "Title": "ModelsBuilder Property Override"
-  }
+  "$schema": "https://marketplace.umbraco.com/umbraco-marketplace-schema.json",
+  "AuthorDetails": {
+    "Name": "Gibe Digital",
+    "Url": "https://github.com/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride",
+    "ImageUrl": "https://github.com/Gibe.png",
+    "SyncContributorsFromRepository": true
+  },
+  "Description": "Re-implementation of the ImplementPropertyType functionality to tell ModelsBuilder not to generate properties.",
+  "DocumentationUrl": "https://github.com/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride",
+  "IssueTrackerUrl": "https://github.com/Gibe/Umbraco.Community.ModelsBuilder.PropertyOverride/issues",
+  "PackageType": "Package",
+  "Category": "Developer Tools",
+  "Tags": [ "modelsbuilder", "backoffice" ]
+}