Merge pull request #137 from skttl/v8upgrade

Port to V8

Author: skttl

build/package.proj

@@ -18,7 +18,7 @@
 	<PropertyGroup>
 		<ProjectName>Our.Umbraco.DocTypeGridEditor</ProjectName>
 		<PackageName>Doc Type Grid Editor</PackageName>
-		<MinUmbracoVersion>7.6.0</MinUmbracoVersion>
+		<MinUmbracoVersion>8.0.0</MinUmbracoVersion>
 		<Readme>Doc Type Grid Editor is an advanced grid editor for Umbraco 7</Readme>
 		<AuthorName>Matt Brailsford, Lee Kelleher</AuthorName>
 		<AuthorUrl>https://github.com/umco/umbraco-doc-type-grid-editor/graphs/contributors</AuthorUrl>
@@ -31,7 +31,7 @@
 	<PropertyGroup>
 		<PackageId>Our.Umbraco.DocTypeGridEditor</PackageId>
 		<NuGetPackageName>Doc Type Grid Editor for Umbraco</NuGetPackageName>
-		<Copyright>Copyright &#169; 2017 UMCO</Copyright>
+		<Copyright>Copyright &#169; 2019 UMCO</Copyright>
 		<Owners>Matt Brailsford, Lee Kelleher</Owners>
 		<IconUrl>https://our.umbraco.org/media/wiki/145708/635623742802070736_dtgepng.png</IconUrl>
 		<Tags>umbraco grid document type editor</Tags>

docs/developers-guide.md

@@ -30,8 +30,8 @@ With the **Doc Type Grid Editor** then, we bridge that gap, allowing you to reus
 
 Before you get started, there are a number of things you will need:
 
-1. .NET 4.5+
-2. Umbraco 7.6.0+
+1. .NET 4.7.2+
+2. Umbraco 8.0.2+
 3. The **Doc Type Grid Editor** package installed
 
 ---
@@ -40,6 +40,8 @@ Before you get started, there are a number of things you will need:
 
 The **Doc Type Grid Editor** is configured via the grid.editors.config.js config file located in the `~/Config` folder. A default configuration should be installed along with the package, but for details on the configuration options, please see below.
 
+You can also add your editors using a package.manifest file in a folder in the `~/App_Plugins` folder.
+
 #### Example
 
 ```javascript
@@ -55,6 +57,7 @@ The **Doc Type Grid Editor** is configured via the grid.editors.config.js config
             "allowedDocTypes": [...],
             "nameTemplate": "",
             "enablePreview": true,
+			"largeDialog": true,
             "viewPath": "/Views/Partials/Grid/Editors/DocTypeGridEditor/",
             "previewViewPath": "/Views/Partials/Grid/Editors/DocTypeGridEditor/Previews/",
             "previewCssFilePath": "",
@@ -84,7 +87,9 @@ The **Doc Type Grid Editor** supports 3 config options, all of which are optiona
 |-----------------|----------|-------------|
 | AllowedDocTypes | String[] | An array of doc type aliases of which should be allowed to be selected in the grid editor. Strings can be REGEX patterns to allow matching groups of doc types in a single entry. e.g. "Widget$" will match all doc types with an alias ending in "Widget". However if a single doc type is matched, (aka **Single Doc Type Mode**), then dropdown selection stage (in the DTGE panel) will be skipped. |
 | EnablePreview   | Boolean  | Enables rendering a preview of the grid cell in the grid editor. |
+| LargeDialog     | Boolean  | Makes the editing dialog larger. Especially useful for grid editors with complex property editors. |
 | ViewPath        | String   | Set's an alternative view path for where the **Doc Type Grid Editor** should look for views when rendering. Defaults to `~/Views/Partials/` |
+| ShowDocTypeSelectAsGrid | Boolean | Makes the content type selection dialog render a grid, in stead of the default list with descriptions |
 
 ---
 
@@ -175,7 +180,7 @@ By inheriting from the `DocTypeGridEditorSurfaceController` base class, you'll a
 
 | Member                                            | Type              | Description |
 |---------------------------------------------------|-------------------|-------------|
-| Model                                             | IPublishedContent | The IPublishedContent instance for you cells data. |
+| Model                                             | IPublishedElement | The IPublishedElement instance of your cell's data. |
 | ViewPath                                          | String            | A reference to the currently configured ViewPath |
 | CurrentPartialView(object model = null)           | Method            | Helper method to return you to the default partial view for this cell. If no model is passed in, the standard Model will be passed down. |
 | PartialView(string viewName, object model = null) | Method            | Helper method to return you to an alternative partial view for this cell. If no model is passed in, the standard Model will be passed down. |

src/Our.Umbraco.DocTypeGridEditor/Bootstrap.cs

@@ -1,38 +1,35 @@
 using System;
 using Newtonsoft.Json;
-using Our.Umbraco.DocTypeGridEditor.Web.Mvc;
-using Umbraco.Core;
+using Umbraco.Core.Composing;
 using Umbraco.Core.Sync;
 using Umbraco.Web.Cache;
 
 namespace Our.Umbraco.DocTypeGridEditor
 {
-    internal class Bootstrap : ApplicationEventHandler
-    {
-        protected override void ApplicationStarting(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
-        {
-            if (DefaultDocTypeGridEditorSurfaceControllerResolver.HasCurrent == false)
-            {
-                DefaultDocTypeGridEditorSurfaceControllerResolver.Current = new DefaultDocTypeGridEditorSurfaceControllerResolver();
-            }
-        }
 
-        protected override void ApplicationStarted(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
+    public class Bootstrap : IUserComposer
+    {
+        public void Compose(Composition composition)
         {
             DataTypeCacheRefresher.CacheUpdated += (sender, e) =>
             {
                 if (e.MessageType == MessageType.RefreshByJson)
                 {
-                    var payload = JsonConvert.DeserializeAnonymousType((string)e.MessageObject, new[] { new { Id = default(int), UniqueId = default(Guid) } });
+                    var payload = JsonConvert.DeserializeAnonymousType((string) e.MessageObject,
+                        new[] {new {Id = default(int), UniqueId = default(Guid)}});
                     if (payload != null)
                     {
                         foreach (var item in payload)
                         {
-                            applicationContext.ApplicationCache.RuntimeCache.ClearCacheItem(
-                                string.Concat("Our.Umbraco.DocTypeGridEditor.Web.Extensions.ContentTypeServiceExtensions.GetAliasById_", item.UniqueId));
+                            Current.AppCaches.RuntimeCache.ClearByKey(
+                                string.Concat(
+                                    "Our.Umbraco.DocTypeGridEditor.Web.Extensions.ContentTypeServiceExtensions.GetAliasById_",
+                                    item.UniqueId));
 
-                            applicationContext.ApplicationCache.RuntimeCache.ClearCacheItem(
-                                string.Concat("Our.Umbraco.DocTypeGridEditor.Helpers.DocTypeGridEditorHelper.GetPreValuesCollectionByDataTypeId_", item.Id));
+                            Current.AppCaches.RuntimeCache.ClearByKey(
+                                string.Concat(
+                                    "Our.Umbraco.DocTypeGridEditor.Helpers.DocTypeGridEditorHelper.GetPreValuesCollectionByDataTypeId_",
+                                    item.Id));
                         }
                     }
                 }
@@ -42,17 +39,20 @@ protected override void ApplicationStarted(UmbracoApplicationBase umbracoApplica
             {
                 if (e.MessageType == MessageType.RefreshByJson)
                 {
-                    var payload = JsonConvert.DeserializeAnonymousType((string)e.MessageObject, new[] { new { Alias = default(string) } });
+                    var payload = JsonConvert.DeserializeAnonymousType((string) e.MessageObject,
+                        new[] {new {Alias = default(string)}});
                     if (payload != null)
                     {
                         foreach (var item in payload)
                         {
-                            applicationContext.ApplicationCache.RuntimeCache.ClearCacheItem(
-                                string.Concat("Our.Umbraco.DocTypeGridEditor.Helpers.DocTypeGridEditorHelper.GetContentTypesByAlias_", item.Alias));
+                            Current.AppCaches.RuntimeCache.ClearByKey(
+                                string.Concat(
+                                    "Our.Umbraco.DocTypeGridEditor.Helpers.DocTypeGridEditorHelper.GetContentTypesByAlias_",
+                                    item.Alias));
 
                             // NOTE: Unsure how to get the doctype GUID, without hitting the database?
                             // So we end up clearing the entire cache for this key. [LK:2018-01-30]
-                            applicationContext.ApplicationCache.RuntimeCache.ClearCacheByKeySearch(
+                            Current.AppCaches.RuntimeCache.ClearByKey(
                                 "Our.Umbraco.DocTypeGridEditor.Helpers.DocTypeGridEditorHelper.GetContentTypeAliasByGuid_");
                         }
                     }

src/Our.Umbraco.DocTypeGridEditor/Composing/Current.cs

@@ -0,0 +1,24 @@
+using Our.Umbraco.DocTypeGridEditor.Web.Controllers;
+using System;
+using Umbraco.Core;
+
+namespace Our.Umbraco.DocTypeGridEditor.Composing
+{
+    public class Current
+    {
+
+        private static Type _defaultDocTypeGridEditorSurfaceControllerType;
+
+        // internal - can only be accessed through Composition at compose time
+        internal static Type DefaultDocTypeGridEditorSurfaceControllerType
+        {
+            get => _defaultDocTypeGridEditorSurfaceControllerType;
+            set
+            {
+                if (value.IsOfGenericType(typeof(DocTypeGridEditorSurfaceController<>)) == false)
+                    throw new InvalidOperationException($"The Type specified ({value}) is not of type {typeof(DocTypeGridEditorSurfaceController<>)}");
+                _defaultDocTypeGridEditorSurfaceControllerType = value;
+            }
+        }
+    }
+}

src/Our.Umbraco.DocTypeGridEditor/Extensions/ContentTypeServiceExtensions.cs

@@ -1,6 +1,6 @@
 using System;
-using Umbraco.Core;
 using Umbraco.Core.Cache;
+using Umbraco.Web.Composing;
 using Umbraco.Core.Services;
 
 namespace Our.Umbraco.DocTypeGridEditor.Extensions
@@ -9,12 +9,16 @@ internal static class ContentTypeServiceExtensions
     {
         public static string GetAliasByGuid(this IContentTypeService contentTypeService, Guid id)
         {
-            return ApplicationContext.Current.ApplicationCache.RuntimeCache.GetCacheItem<string>(
+            var cache = Current.AppCaches.RequestCache;
+
+            return cache.GetCacheItem<string>(
                 string.Concat("Our.Umbraco.DocTypeGridEditor.Web.Extensions.ContentTypeServiceExtensions.GetAliasById_", id),
-                () => ApplicationContext.Current
-                    .DatabaseContext
-                    .Database
-                    .ExecuteScalar<string>("SELECT [cmsContentType].[alias] FROM [cmsContentType] INNER JOIN [umbracoNode] ON [cmsContentType].[nodeId] = [umbracoNode].[id] WHERE [umbracoNode].[uniqueID] = @0", id));
+                () =>
+                {
+                    using (var scope = Current.ScopeProvider.CreateScope(autoComplete:true))
+                        return scope.Database.ExecuteScalar<string>("SELECT [cmsContentType].[alias] FROM [cmsContentType] INNER JOIN [umbracoNode] ON [cmsContentType].[nodeId] = [umbracoNode].[id] WHERE [umbracoNode].[uniqueID] = @0", id);
+
+                });
         }
     }
-}
+}