various improvements (#15)

Author: andrew87

CHANGELOG.md

@@ -4,6 +4,13 @@ All package updates & migration steps will be listed in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.9.0] - 2024-07-01
+### Added
+- Additional checks to prevent declaring references with `IBaseInfo` and `IBaseStruct`
+### Changed
+- Printing info at runtime will print interface name & identifier
+- Updated README about inheritance
+
 ## [3.8.6] - 2024-06-06
 ### Fixed
 - Missing `using` for `DateTime` & `TimeSpan` usage in structs

Editor/EditorParameterConstants.cs

@@ -18,7 +18,7 @@ internal static class EditorParameterConstants
         /// Ideally it would be the most convenient to use the package version but that requires file I/O to
         /// the package.json which can be costly if we're doing it all of the time.
         /// </summary>
-        public const string InterfaceHashSalt = "7e10aadc-9b6c-41a7-9c7e-ee672e5a21c8";
+        public const string InterfaceHashSalt = "27d36d97-4bdd-48f5-9d75-a4490bf5aecf";
 
         public static string SanitizedDataPath()
         {

Editor/Models/ParameterInterface.cs

@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Reflection;
 using System.Text.RegularExpressions;
+using PocketGems.Parameters.Interface;
 using PocketGems.Parameters.PropertyTypes;
 using PocketGems.Parameters.Util;
 
@@ -92,6 +93,12 @@ public virtual bool Validate(out IReadOnlyList<string> outErrors)
                     errors.Add($"Duplicate property [{propertyName}] in interface [{_type.Name}].");
                 if (EditorParameterConstants.Interface.InvalidReservedPropertyNames.Contains(propertyName.ToLower()))
                     errors.Add($"Property name [{propertyName}] is invalid & reserved.  It cannot be used in interface [{_type.Name}].");
+                if ((ParameterReferencePropertyType.IsReferenceType(propertyType.PropertyInfo, out var genericType) && genericType == typeof(IBaseInfo)) ||
+                    (ParameterReferenceListPropertyType.IsListReferenceType(propertyType.PropertyInfo, out genericType) && genericType == typeof(IBaseInfo)))
+                    errors.Add($"Cannot define {propertyName} as {nameof(ParameterReference)} with {nameof(IBaseInfo)} in {InterfaceName}.");
+                if ((ParameterStructReferencePropertyType.IsReferenceType(propertyType.PropertyInfo, out genericType) && genericType == typeof(IBaseStruct)) ||
+                    (ParameterStructReferenceListPropertyType.IsListReferenceType(propertyType.PropertyInfo, out genericType) && genericType == typeof(IBaseStruct)))
+                    errors.Add($"Cannot define {propertyName} as {nameof(ParameterStructReference)} with {nameof(IBaseStruct)} in {InterfaceName}.");
                 propertyNames.Add(propertyName);
             }
 

Editor/Operations/Code/GenerateImplementationFilesOperation.cs

@@ -28,7 +28,7 @@ public override void Execute(ICodeOperationContext context)
                 var soFilename = CodeGenerator.GenerateScriptableObjectFile(parameterInfo, index, scriptableObjectDir);
                 soFileRemover.UsedFile(soFilename);
 
-                var fbClassFile = CodeGenerator.GenerateFlatBufferClassFile(parameterInfo, flatBufferClassesDir);
+                var fbClassFile = CodeGenerator.GenerateFlatBufferClassFile(parameterInfo, true, flatBufferClassesDir);
                 fbFileRemover.UsedFile(fbClassFile);
                 index++;
             }
@@ -40,7 +40,7 @@ public override void Execute(ICodeOperationContext context)
                 var structFilename = CodeGenerator.GenerateStructFile(parameterStruct, structsDir);
                 structFileRemover.UsedFile(structFilename);
 
-                var fbClassFile = CodeGenerator.GenerateFlatBufferClassFile(parameterStruct, flatBufferClassesDir);
+                var fbClassFile = CodeGenerator.GenerateFlatBufferClassFile(parameterStruct, false, flatBufferClassesDir);
                 fbFileRemover.UsedFile(fbClassFile);
             }
 

Editor/Templates/FlatBufferClass.template

@@ -43,6 +43,10 @@ end
             _fb = fb;
         }
 
+{{~if isInfo~}}
+        public override string ToString() => $"{{interfaceName}}:{_identifier}";
+
+{{~end~}}
         #region  property implementation
 
 {{~for propertyTypeDict in propertyTypeDicts~}}

Editor/Util/CodeGenerator.cs

@@ -206,7 +206,7 @@ public static string GenerateStructFile(IParameterStruct parameterStruct, string
         /// <param name="parameterInterface">Interface to write the class for.</param>
         /// <param name="outputDirectory">Directory to write the class to.</param>
         /// <returns>filepath of the file written</returns>
-        public static string GenerateFlatBufferClassFile(IParameterInterface parameterInterface, string outputDirectory)
+        public static string GenerateFlatBufferClassFile(IParameterInterface parameterInterface, bool isInfo, string outputDirectory)
         {
             if (!Directory.Exists(outputDirectory))
                 Directory.CreateDirectory(outputDirectory);
@@ -241,6 +241,7 @@ public static string GenerateFlatBufferClassFile(IParameterInterface parameterIn
             var args = new Dictionary<string, object>
             {
                 { "isAddressable", IsAddressable() },
+                { "isInfo", isInfo },
                 { "disableSymbol", EditorParameterConstants.Interface.DisableImplementationSymbol },
                 { "namespace", parameterInterface.GeneratedNameSpace },
                 { "className", parameterInterface.FlatBufferClassName(false) },

README/InterfacesAndEnums.md

@@ -73,7 +73,8 @@ Requirements for interfaces are as follows:
 - Interface name must follow the pattern `I[A-Z]+[A-Za-z0-9]*Info`.
 - Visbility must be `public`.
 - Must not have a namespace.
-- Must inherit from or from an interface that inherits `IBaseInfo`.
+- Must inherit from `IBaseInfo` or from an interface that inherits `IBaseInfo`.
+- May inherit from multiple other `Info` interfaces as long as property names do not collide.
 - Must NOT inherit any other external interfaces (e.g. `IEnumerable`).
 - Can only define public property getters. Methods & setters are not allowed.
 - Propery names must follow the pattern `[A-Z]+[A-Za-z0-9]*`.

Tests/Editor/Models/ParameterInfoTest.cs

@@ -32,6 +32,8 @@ public void ValidInterface()
         [TestCase(typeof(IInternalPropertyInfo))] // property is defined as non public
         [TestCase(typeof(IMethodInfo))] // interface defined a method
         [TestCase(typeof(INameSpacedInfo))] // interface has a name space
+        [TestCase(typeof(IReferenceBaseInfo))] // interface has reference to base info
+        [TestCase(typeof(IListReferenceBaseInfo))] // interface has reference to base info
         public void InvalidInterface(Type interfaceType)
         {
             AssertInvalidInterface(new ParameterInfo(interfaceType));

Tests/Editor/Models/ParameterStructTest.cs

@@ -32,6 +32,8 @@ public void ValidInterface()
         [TestCase(typeof(IInternalPropertyStruct))] // property is defined as non public
         [TestCase(typeof(IMethodStruct))] // interface defined a method
         [TestCase(typeof(INameSpacedStruct))] // interface has a name space
+        [TestCase(typeof(IReferenceBaseStruct))] // interface has reference to base struct
+        [TestCase(typeof(IListReferenceBaseStruct))] // interface has reference to base struct
         public void InvalidInterface(Type interfaceType)
         {
             AssertInvalidInterface(new ParameterStruct(interfaceType));

Tests/Editor/Models/TestCode/TestInfos.cs

@@ -1,4 +1,6 @@
 using System.Collections;
+using System.Collections.Generic;
+using PocketGems.Parameters;
 using PocketGems.Parameters.Interface;
 
 // valid interface
@@ -90,3 +92,15 @@ public interface INameSpacedInfo : IBaseInfo
         int MyInt { get; }
     }
 }
+
+// bad: referencing base info
+public interface IReferenceBaseInfo : IBaseInfo
+{
+    ParameterReference<IBaseInfo> MyInfo { get; }
+}
+
+// bad: referencing base info
+public interface IListReferenceBaseInfo : IBaseInfo
+{
+    IReadOnlyList<ParameterReference<IBaseInfo>> MyInfos { get; }
+}