Merge pull request #309 from yuriys-kentico/issue-308-metadata-servic…

…e-loading-default-language Issue 308 metadata service loading default language
Kentico · Aug 7, 2019 · 66ae5b3 · 66ae5b3
2 parents 6f3eea9 + fd1bd22
commit 66ae5b3
Show file tree

Hide file tree

Showing 3 changed files with 100 additions and 12 deletions.
diff --git a/KenticoInspector.Core/AbstractReport.cs b/KenticoInspector.Core/AbstractReport.cs
@@ -9,25 +9,33 @@ namespace KenticoInspector.Core
     {
         protected readonly IReportMetadataService reportMetadataService;
 
+        private ReportMetadata<T> metadata;
+
         public AbstractReport(IReportMetadataService reportMetadataService)
         {
             this.reportMetadataService = reportMetadataService;
         }
 
         public string Codename => GetCodename(this.GetType());
 
-        public static string GetCodename(Type reportType)
-        {
-            return GetDirectParentNamespace(reportType);
-        }
-
         public abstract IList<Version> CompatibleVersions { get; }
 
         public virtual IList<Version> IncompatibleVersions => new List<Version>();
 
+        public ReportMetadata<T> Metadata
+        {
+            get
+            {
+                return metadata ?? (metadata = reportMetadataService.GetReportMetadata<T>(Codename));
+            }
+        }
+
         public abstract IList<string> Tags { get; }
 
-        public ReportMetadata<T> Metadata => reportMetadataService.GetReportMetadata<T>(Codename);
+        public static string GetCodename(Type reportType)
+        {
+            return GetDirectParentNamespace(reportType);
+        }
 
         public abstract ReportResults GetResults();
 

diff --git a/KenticoInspector.Core/Services/Interfaces/IReportMetadataService.cs b/KenticoInspector.Core/Services/Interfaces/IReportMetadataService.cs
@@ -4,6 +4,8 @@ namespace KenticoInspector.Core.Services.Interfaces
 {
     public interface IReportMetadataService : IService
     {
+        string DefaultCultureName { get; }
+
         string CurrentCultureName { get; }
 
         ReportMetadata<T> GetReportMetadata<T>(string reportCodename) where T : new();

diff --git a/KenticoInspector.Infrastructure/Services/ReportMetadataService.cs b/KenticoInspector.Infrastructure/Services/ReportMetadataService.cs
@@ -1,30 +1,108 @@
-using KenticoInspector.Core.Models;
-using KenticoInspector.Core.Services.Interfaces;
+using System;
 using System.IO;
 using System.Threading;
+
+using KenticoInspector.Core.Models;
+using KenticoInspector.Core.Services.Interfaces;
+
 using YamlDotNet.Serialization;
 using YamlDotNet.Serialization.NamingConventions;
 
 namespace KenticoInspector.Core.Helpers
 {
     public class ReportMetadataService : IReportMetadataService
     {
+        public string DefaultCultureName => "en-US";
+
         public string CurrentCultureName => Thread.CurrentThread.CurrentCulture.Name;
 
         public ReportMetadata<T> GetReportMetadata<T>(string reportCodename) where T : new()
         {
-            var yamlPath = $"{DirectoryHelper.GetExecutingDirectory()}\\{reportCodename}\\Metadata\\{CurrentCultureName}.yaml";
-            return DeserializeYaml<ReportMetadata<T>>(yamlPath);
+            var metadataDirectory = $"{DirectoryHelper.GetExecutingDirectory()}\\{reportCodename}\\Metadata\\";
+
+            var reportMetadata = GetReportMetadataInternal<T>(metadataDirectory, CurrentCultureName);
+
+            var isCurrentCultureDefaultCulture = CurrentCultureName == DefaultCultureName;
+            if (!isCurrentCultureDefaultCulture)
+            {
+                var defaultReportMetadata = GetReportMetadataInternal<T>(metadataDirectory, DefaultCultureName);
+                reportMetadata = GetMergedMetadata(defaultReportMetadata, reportMetadata);
+            }
+
+            return reportMetadata;
         }
 
-        public T DeserializeYaml<T>(string path)
+
+        private ReportMetadata<T> GetReportMetadataInternal<T>(string metadataDirectory, string cultureName) where T : new()
         {
-            var deserializer = new DeserializerBuilder()
+            var reportMetadataPath = $"{metadataDirectory}{cultureName}.yaml";
+            var reportMetadataPathExists = File.Exists(reportMetadataPath);
+            return reportMetadataPathExists 
+                ? DeserializeYaml<ReportMetadata<T>>(reportMetadataPath) 
+                : new ReportMetadata<T>();
+        }
+
+        private T DeserializeYaml<T>(string path)
+        {
+            var deserializerBuilder = new DeserializerBuilder()
                 .WithNamingConvention(new CamelCaseNamingConvention())
+                .IgnoreUnmatchedProperties();
+
+            var deserializer = deserializerBuilder
                 .Build();
 
             var yamlFile = File.ReadAllText(path);
+
             return deserializer.Deserialize<T>(yamlFile);
         }
+
+        private ReportMetadata<T> GetMergedMetadata<T>(ReportMetadata<T> defaultMetadata, ReportMetadata<T> overrideMetadata) where T : new()
+        {
+            var mergedMetadata = new ReportMetadata<T>
+            {
+                Details = new ReportDetails(),
+                Terms = new T()
+            };
+
+            mergedMetadata.Details.Name = overrideMetadata.Details?.Name ?? defaultMetadata.Details.Name;
+            mergedMetadata.Details.ShortDescription = overrideMetadata.Details?.ShortDescription ?? defaultMetadata.Details.ShortDescription;
+            mergedMetadata.Details.LongDescription = overrideMetadata.Details?.LongDescription ?? defaultMetadata.Details.LongDescription;
+
+            RecursivelySetPropertyValues(typeof(T), defaultMetadata.Terms, overrideMetadata.Terms, mergedMetadata.Terms);
+
+            return mergedMetadata;
+        }
+
+        private static void RecursivelySetPropertyValues(Type objectType, object defaultObject, object overrideObject, object targetObject)
+        {
+            var objectTypeProperties = objectType.GetProperties();
+
+            foreach (var objectTypeProperty in objectTypeProperties)
+            {
+                var objectTypePropertyType = objectTypeProperty.PropertyType;
+
+                var defaultObjectPropertyValue = objectTypeProperty.GetValue(defaultObject);
+
+                object overrideObjectPropertyValue = null;
+
+                if (overrideObject != null)
+                {
+                    overrideObjectPropertyValue = objectTypeProperty.GetValue(overrideObject);
+                }
+
+                if (objectTypePropertyType.Namespace == objectType.Namespace)
+                {
+                    var targetObjectPropertyValue = Activator.CreateInstance(objectTypePropertyType);
+
+                    objectTypeProperty.SetValue(targetObject, targetObjectPropertyValue);
+
+                    RecursivelySetPropertyValues(objectTypePropertyType, defaultObjectPropertyValue, overrideObjectPropertyValue, targetObjectPropertyValue);
+                }
+                else
+                {
+                    objectTypeProperty.SetValue(targetObject, overrideObjectPropertyValue ?? defaultObjectPropertyValue);
+                }
+            }
+        }
     }
 }