Merge pull request #2 from Carnagion/development

Carnagion · web-flow · commit 6eb6cdfd830c · 2022-06-29T16:52:20.000+02:00
Merge v1.0.1 into stable
diff --git a/Mod.cs b/Mod.cs
@@ -238,16 +238,16 @@ public static Metadata Load(string directoryPath)
                     directoryNode.InnerText = directoryPath;
                     document.DocumentElement.AppendChild(directoryNode);
                     
-                    Metadata metadata = new Serializer().Deserialize<Metadata>(document.DocumentElement)!;
-                    return metadata.IsValid() ? metadata : throw new ModLoadException(directoryPath, "Invalid metadata");
+                    return new Serializer().Deserialize<Metadata>(document.DocumentElement)!;
                 }
                 catch (Exception exception) when (exception is not ModLoadException)
                 {
                     throw new ModLoadException(directoryPath, exception);
                 }
             }
             
-            private bool IsValid()
+            [AfterDeserialization]
+            private void IsValid()
             {
                 // Check that the incompatible, load before, and load after lists don't have anything in common or contain the mod's own ID
                 bool invalidLoadOrder = this.Id.Yield()
@@ -260,7 +260,10 @@ private bool IsValid()
                 bool invalidDependencies = this.Dependencies
                     .Intersect(this.Incompatible)
                     .Any();
-                return !(invalidLoadOrder || invalidDependencies);
+                if (invalidLoadOrder || invalidDependencies)
+                {
+                    throw new ModLoadException(this.Directory, "Invalid metadata");
+                }
             }
         }
     }
diff --git a/ModLoader.cs b/ModLoader.cs
@@ -40,7 +40,7 @@ public static Mod LoadMod(string modDirectoryPath, bool executeAssemblies = true
             ModLoader.loadedMods.Add(mod.Meta.Id, mod);
             if (executeAssemblies)
             {
-                ModLoader.StartupMods(mod.Yield());
+                ModLoader.StartupMod(mod);
             }
             return mod;
         }
@@ -59,24 +59,20 @@ public static IEnumerable<Mod> LoadMods(IEnumerable<string> modDirectoryPaths, b
             mods.ForEach(mod => ModLoader.loadedMods.Add(mod.Meta.Id, mod));
             if (executeAssemblies)
             {
-                ModLoader.StartupMods(mods);
+                mods.ForEach(ModLoader.StartupMod);
             }
             return mods;
         }
-        
-        private static void StartupMods(IEnumerable<Mod> mods)
+
+        private static void StartupMod(Mod mod)
         {
             // Invoke all static methods annotated with [Startup] along with the supplied parameters (if any)
-            foreach ((MethodInfo method, ModStartupAttribute attribute) in from mod in mods 
-                                                                           from assembly in mod.Assemblies
-                                                                           from type in assembly.GetTypes() 
-                                                                           from method in type.GetMethods(BindingFlags.NonPublic | BindingFlags.Public) 
-                                                                           let attribute = method.GetCustomAttribute<ModStartupAttribute>() 
-                                                                           where attribute is not null 
-                                                                           select (method, attribute))
-            {
-                method.Invoke(null, attribute.Parameters);
-            }
+            (from assembly in mod.Assemblies
+             from type in assembly.GetTypes()
+             from method in type.GetMethods(BindingFlags.NonPublic | BindingFlags.Public)
+             let attribute = method.GetCustomAttribute<ModStartupAttribute>()
+             where attribute is not null
+             select (method, attribute)).ForEach(pair => pair.method.Invoke(null, pair.attribute.Parameters));
         }
         
         [MustUseReturnValue]
diff --git a/Modot.csproj b/Modot.csproj
@@ -4,36 +4,26 @@
         <Nullable>enable</Nullable>
         <TargetFramework>netstandard2.1</TargetFramework>
         <RootNamespace>Godot.Modding</RootNamespace>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <!-- Workaround as Godot does not know how to properly load NuGet packages -->
         <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <PackageVersion>1.0.0</PackageVersion>
+        <PackageVersion>1.0.1</PackageVersion>
         <Title>Modot</Title>
         <Authors>Carnagion</Authors>
         <Description>A mod loader and API for applications made using Godot, with the ability to load C# assemblies, XML data, and resource packs at runtime.</Description>
         <RepositoryUrl>https://github.com/Carnagion/Modot</RepositoryUrl>
         <PackageLicenseFile>LICENSE</PackageLicenseFile>
     </PropertyGroup>
-    <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
-      <DocumentationFile>C:\Users\Indraneel\Projects\Modot\.mono\temp\bin\Debug\Modot.xml</DocumentationFile>
-    </PropertyGroup>
-    <PropertyGroup Condition=" '$(Configuration)' == 'ExportDebug' ">
-      <DocumentationFile>C:\Users\Indraneel\Projects\Modot\.mono\temp\bin\ExportDebug\Modot.xml</DocumentationFile>
-    </PropertyGroup>
-    <PropertyGroup Condition=" '$(Configuration)' == 'ExportRelease' ">
-      <DocumentationFile>C:\Users\Indraneel\Projects\Modot\.mono\temp\bin\ExportRelease\Modot.xml</DocumentationFile>
-    </PropertyGroup>
-    <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
-        <PackageReference Include="GDSerializer" Version="1.0.0" />
-    </ItemGroup>
     <ItemGroup>
-        <PackageReference Include="GDLogger" Version="1.0.0" />
-        <PackageReference Include="JetBrains.Annotations" Version="2022.1.0" />
+        <PackageReference Include="GDLogger" Version="1.0.1"/>
+        <PackageReference Include="GDSerializer" Version="1.1.0"/>
+        <PackageReference Include="JetBrains.Annotations" Version="2022.1.0"/>
     </ItemGroup>
     <ItemGroup>
-        <Content Include=".gitignore" />
-        <Content Include="LICENSE" />
-        <Content Include="README.md" />
+        <Content Include=".gitignore"/>
+        <Content Include="LICENSE"/>
+        <Content Include="README.md"/>
     </ItemGroup>
     <ItemGroup>
         <None Include="LICENSE" Pack="true" PackagePath=""/>
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ A more detailed explanation of all features along with instructions on usage is
 Simply include the following lines in a Godot project's `.csproj` file (either by editing the file manually or letting an IDE install the package):
 ```xml
 <ItemGroup>
-    <PackageReference Include="Modot" Version="1.0.0"/>
+    <PackageReference Include="Modot" Version="1.0.1"/>
 </ItemGroup>
  ```
 

Original file line number	Diff line number	Diff line change
`@@ -238,16 +238,16 @@ public static Metadata Load(string directoryPath)`
`238`	`238`	`directoryNode.InnerText = directoryPath;`
`239`	`239`	`document.DocumentElement.AppendChild(directoryNode);`
`240`	`240`
`241`		`- Metadata metadata = new Serializer().Deserialize<Metadata>(document.DocumentElement)!;`
`242`		`- return metadata.IsValid() ? metadata : throw new ModLoadException(directoryPath, "Invalid metadata");`
	`241`	`+ return new Serializer().Deserialize<Metadata>(document.DocumentElement)!;`
`243`	`242`	`}`
`244`	`243`	`catch (Exception exception) when (exception is not ModLoadException)`
`245`	`244`	`{`
`246`	`245`	`throw new ModLoadException(directoryPath, exception);`
`247`	`246`	`}`
`248`	`247`	`}`
`249`	`248`
`250`		`- private bool IsValid()`
	`249`	`+ [AfterDeserialization]`
	`250`	`+ private void IsValid()`
`251`	`251`	`{`
`252`	`252`	`// Check that the incompatible, load before, and load after lists don't have anything in common or contain the mod's own ID`
`253`	`253`	`bool invalidLoadOrder = this.Id.Yield()`
`@@ -260,7 +260,10 @@ private bool IsValid()`
`260`	`260`	`bool invalidDependencies = this.Dependencies`
`261`	`261`	`.Intersect(this.Incompatible)`
`262`	`262`	`.Any();`
`263`		`- return !(invalidLoadOrder \|\| invalidDependencies);`
	`263`	`+ if (invalidLoadOrder \|\| invalidDependencies)`
	`264`	`+ {`
	`265`	`+ throw new ModLoadException(this.Directory, "Invalid metadata");`
	`266`	`+ }`
`264`	`267`	`}`
`265`	`268`	`}`
`266`	`269`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public static Mod LoadMod(string modDirectoryPath, bool executeAssemblies = true`
`40`	`40`	`ModLoader.loadedMods.Add(mod.Meta.Id, mod);`
`41`	`41`	`if (executeAssemblies)`
`42`	`42`	`{`
`43`		`- ModLoader.StartupMods(mod.Yield());`
	`43`	`+ ModLoader.StartupMod(mod);`
`44`	`44`	`}`
`45`	`45`	`return mod;`
`46`	`46`	`}`
`@@ -59,24 +59,20 @@ public static IEnumerable<Mod> LoadMods(IEnumerable<string> modDirectoryPaths, b`
`59`	`59`	`mods.ForEach(mod => ModLoader.loadedMods.Add(mod.Meta.Id, mod));`
`60`	`60`	`if (executeAssemblies)`
`61`	`61`	`{`
`62`		`- ModLoader.StartupMods(mods);`
	`62`	`+ mods.ForEach(ModLoader.StartupMod);`
`63`	`63`	`}`
`64`	`64`	`return mods;`
`65`	`65`	`}`
`66`		`-`
`67`		`- private static void StartupMods(IEnumerable<Mod> mods)`
	`66`	`+`
	`67`	`+ private static void StartupMod(Mod mod)`
`68`	`68`	`{`
`69`	`69`	`// Invoke all static methods annotated with [Startup] along with the supplied parameters (if any)`
`70`		`- foreach ((MethodInfo method, ModStartupAttribute attribute) in from mod in mods`
`71`		`- from assembly in mod.Assemblies`
`72`		`- from type in assembly.GetTypes()`
`73`		`- from method in type.GetMethods(BindingFlags.NonPublic \| BindingFlags.Public)`
`74`		`- let attribute = method.GetCustomAttribute<ModStartupAttribute>()`
`75`		`- where attribute is not null`
`76`		`- select (method, attribute))`
`77`		`- {`
`78`		`- method.Invoke(null, attribute.Parameters);`
`79`		`- }`
	`70`	`+ (from assembly in mod.Assemblies`
	`71`	`+ from type in assembly.GetTypes()`
	`72`	`+ from method in type.GetMethods(BindingFlags.NonPublic \| BindingFlags.Public)`
	`73`	`+ let attribute = method.GetCustomAttribute<ModStartupAttribute>()`
	`74`	`+ where attribute is not null`
	`75`	`+ select (method, attribute)).ForEach(pair => pair.method.Invoke(null, pair.attribute.Parameters));`
`80`	`76`	`}`
`81`	`77`
`82`	`78`	`[MustUseReturnValue]`