com.wallstop-studios.unity-helpers 2.0.0-rc81.7 → 2.0.0

package/scripts/lint-tests.ps1

@@ -0,0 +1,156 @@
+Param(
+  [switch]$VerboseOutput
+)
+
+Set-StrictMode -Version Latest
+$ErrorActionPreference = 'Stop'
+
+function Write-Info($msg) {
+  if ($VerboseOutput) { Write-Host "[lint-tests] $msg" -ForegroundColor Cyan }
+}
+
+# Heuristics and allowlists
+$testRoots = @('Tests')
+$allowedHelperFiles = @(
+  'Tests/Runtime/Visuals/VisualsTestHelpers.cs'
+)
+
+$destroyPattern = [regex]'(?<!UNH-SUPPRESS).*\b(?:UnityEngine\.)?Object\.(?:DestroyImmediate|Destroy)\s*\((?<arg>[^)]*)\)'
+$createAssignObjectPattern = [regex]'(?<var>\b\w+)\s*=\s*new\s+(?<type>GameObject|Texture2D|Material|Mesh|Camera)\s*\('
+$createInlineTrackPattern = [regex]'\bTrack\s*\(\s*new\s+(?:GameObject|Texture2D|Material|Mesh|Camera)\s*\('
+$createSoAssignPattern = [regex]'(?<var>\b\w+)\s*=\s*ScriptableObject\.CreateInstance\s*<'
+
+# Returns true if line contains an allowlisted helper file path
+function Is-AllowlistedFile([string]$relPath) {
+  foreach ($a in $allowedHelperFiles) {
+    if ($relPath -replace '\\','/' -ieq $a) { return $true }
+  }
+  return $false
+}
+
+function Get-RelativePath([string]$path) {
+  $root = (Get-Location).Path
+  return ($path.Substring($root.Length).TrimStart([System.IO.Path]::DirectorySeparatorChar))
+}
+
+$violations = @()
+
+foreach ($root in $testRoots) {
+  if (-not (Test-Path $root)) { continue }
+  Get-ChildItem -Recurse -Include *.cs -Path $root | ForEach-Object {
+    $file = $_.FullName
+    $rel = Get-RelativePath $file
+    $content = Get-Content $file
+    $text = $content -join "`n"
+
+    if (Is-AllowlistedFile $rel) {
+      return
+    }
+
+    # Skip meta or non-source
+    if ($file -like '*.meta') { return }
+
+    # Check destroy calls; allow if argument var was tracked earlier in file
+    $lineIndex = 0
+    foreach ($line in $content) {
+      $lineIndex++
+      if ($destroyPattern.IsMatch($line)) {
+        $m = $destroyPattern.Match($line)
+        $arg = ($m.Groups['arg'].Value).Trim()
+        # Extract variable token before any commas or closing paren
+        $varName = $arg -replace ',.*','' -replace '\)',''
+        $allowed = $false
+        if (-not [string]::IsNullOrWhiteSpace($varName)) {
+          # Search up to 100 lines above for Track(varName)
+          $searchStart = [Math]::Max(0, $lineIndex - 100)
+          for ($i = $searchStart; $i -lt $lineIndex; $i++) {
+            if ($content[$i] -match "Track\s*\(\s*$varName\b") { $allowed = $true; break }
+          }
+        }
+        if (-not $allowed) {
+          $violations += (@{
+            Path=$rel; Line=$lineIndex; Message="UNH001: Avoid direct destroy in tests; track object and let teardown clean up (or add // UNH-SUPPRESS)"
+          })
+        }
+      }
+    }
+
+    # Check untracked new allocations via assignment (var = new Type(...))
+    $assignMatches = $createAssignObjectPattern.Matches($text)
+    foreach ($am in $assignMatches) {
+      $var = $am.Groups['var'].Value
+      if ([string]::IsNullOrWhiteSpace($var)) { continue }
+      # Find the index of this match in terms of line
+      $prefix = $text.Substring(0, $am.Index)
+      $lineNo = ($prefix -split "`n").Length
+      # Look ahead 10 lines for Track(var)
+      $endLine = [Math]::Min($content.Count, $lineNo + 10)
+      $found = $false
+      for ($j = $lineNo; $j -le $endLine; $j++) {
+        if ($content[$j-1] -match "Track\s*\(\s*$var\b") { $found = $true; break }
+      }
+      if (-not $found) {
+        $violations += (@{
+          Path=$rel; Line=$lineNo; Message="UNH002: Unity object allocation should be tracked: add Track($var)"
+        })
+      }
+    }
+
+    # Check inline Track(new ...) OK; but find bare inline new ... in args without Track
+    if ($text -match '\bnew\s+(GameObject|Texture2D|Material|Mesh|Camera)\s*\(') {
+      # If Track(new ...) not present at all, flag a generic warning at file level
+      if (-not $createInlineTrackPattern.IsMatch($text)) {
+        # locate first occurrence for line number
+        $m = [regex]::Match($text, '\bnew\s+(GameObject|Texture2D|Material|Mesh|Camera)\s*\(')
+        $lineNo = (($text.Substring(0, $m.Index)) -split "`n").Length
+        $violations += (@{
+          Path=$rel; Line=$lineNo; Message="UNH002: Inline Unity object creation should be passed to Track(new …)"
+        })
+      }
+    }
+
+    # Check ScriptableObject.CreateInstance<T>() assigned, ensure tracked
+    $soMatches = $createSoAssignPattern.Matches($text)
+    foreach ($sm in $soMatches) {
+      $var = $sm.Groups['var'].Value
+      if ([string]::IsNullOrWhiteSpace($var)) { continue }
+      $prefix = $text.Substring(0, $sm.Index)
+      $lineNo = ($prefix -split "`n").Length
+      $found = $false
+      $endLine = [Math]::Min($content.Count, $lineNo + 10)
+      for ($j = $lineNo; $j -le $endLine; $j++) {
+        if ($content[$j-1] -match "Track\s*\(\s*$var\b") { $found = $true; break }
+      }
+      if (-not $found) {
+        $violations += (@{
+          Path=$rel; Line=$lineNo; Message="UNH002: ScriptableObject instance should be tracked: add Track($var)"
+        })
+      }
+    }
+
+    # Enforce CommonTestBase inheritance only if file creates Unity objects and is under Runtime/ or Editor/
+    $createsUnity = ($assignMatches.Count -gt 0) -or ($text -match '\bnew\s+(GameObject|Texture2D|Material|Mesh|Camera)\s*\(') -or ($soMatches.Count -gt 0)
+    if ($createsUnity) {
+      $usesBase = ($text -match ':\s*CommonTestBase')
+      if (-not $usesBase) {
+        # Only enforce for test classes; skip helper-only files
+        if ($text -match '\bnamespace\s+WallstopStudios') {
+          $violations += (@{
+            Path=$rel; Line=1; Message="UNH003: Test classes creating Unity objects should inherit CommonTestBase (Editor or Runtime variant)"
+          })
+        }
+      }
+    }
+  }
+}
+
+if ($violations.Count -gt 0) {
+  Write-Host "Test lifecycle lint failed:" -ForegroundColor Red
+  foreach ($v in $violations) {
+    Write-Host ("{0}:{1}: {2}" -f $v.Path, $v.Line, $v.Message) -ForegroundColor Yellow
+  }
+  exit 1
+} else {
+  Write-Info "No issues found in test code."
+}
+

package/scripts/lint-tests.ps1.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 7e3d3f61549d89e47b9d98c36a04b816
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/scripts/normalize-eol.ps1

@@ -0,0 +1,68 @@
+param(
+    [switch]$DryRun,
+    [switch]$VerboseOutput
+)
+
+$ErrorActionPreference = 'Stop'
+
+# Extensions to normalize (tracked by git)
+$extensions = @(
+    'cs','csproj','sln',
+    'json','yaml','yml','md','xml','uxml','uss',
+    'shader','hlsl','compute','cginc',
+    'asmdef','asmref','meta','ps1'
+)
+
+function Get-TrackedFiles {
+    $files = (git ls-files -z) -split "`0" | Where-Object { $_ -ne '' }
+    return $files | Where-Object {
+        $ext = [System.IO.Path]::GetExtension($_).TrimStart('.').ToLowerInvariant()
+        $extensions -contains $ext
+    }
+}
+
+function To-CrLf([string]$text) {
+    $tmp = $text -replace "`r`n", "`n" -replace "`r", "`n"
+    return $tmp -replace "`n", "`r`n"
+}
+
+$changed = 0
+$eolFixed = 0
+$bomRemoved = 0
+$modified = New-Object System.Collections.Generic.List[string]
+
+$tracked = Get-TrackedFiles
+foreach ($path in $tracked) {
+    try { $bytes = [System.IO.File]::ReadAllBytes($path) } catch { continue }
+
+    $hasBom = $false
+    if ($bytes.Length -ge 3) {
+        $hasBom = ($bytes[0] -eq 0xEF -and $bytes[1] -eq 0xBB -and $bytes[2] -eq 0xBF)
+    }
+
+    if ($hasBom) {
+        $text = [System.Text.Encoding]::UTF8.GetString($bytes, 3, $bytes.Length - 3)
+    } else {
+        $text = [System.Text.Encoding]::UTF8.GetString($bytes)
+    }
+
+    $normalized = To-CrLf $text
+
+    $fileChanged = $false
+    if ($normalized -ne $text) { $fileChanged = $true; $eolFixed++ }
+    # Remove BOM if present (we enforce UTF-8 without BOM)
+    if ($hasBom) { $fileChanged = $true; $bomRemoved++ }
+
+    if ($fileChanged) {
+        if (-not $DryRun) {
+            # Write UTF-8 without BOM
+            [System.IO.File]::WriteAllBytes($path, [System.Text.Encoding]::UTF8.GetBytes($normalized))
+        }
+        $changed++
+        $modified.Add($path) | Out-Null
+        if ($VerboseOutput) { Write-Host "Fixed: $path" }
+    }
+}
+
+Write-Host "Files fixed: $changed (EOL:$eolFixed, BOMRemoved:$bomRemoved)"
+if ($DryRun -and $changed -gt 0) { exit 2 }

package/scripts/normalize-eol.ps1.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 4c8be086a2bcaf142b37f4c3aa421e31
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/scripts.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 43fb65b3c591a4b4cb66a5f7fbe48671
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/Sprites/ProjectAnimationSettings.cs

@@ -1,50 +0,0 @@
-namespace WallstopStudios.UnityHelpers.Editor.Sprites
-{
-#if UNITY_EDITOR
-    using UnityEngine;
-
-    public sealed class ProjectAnimationSettings : ScriptableObject
-    {
-        public string lastAnimationPath = "Assets";
-
-        private static ProjectAnimationSettings _instance;
-        private const string SettingsPath = "Assets/Editor/ProjectAnimationSettings.asset";
-
-        public static ProjectAnimationSettings Instance
-        {
-            get
-            {
-                if (_instance != null)
-                {
-                    return _instance;
-                }
-
-                _instance = UnityEditor.AssetDatabase.LoadAssetAtPath<ProjectAnimationSettings>(
-                    SettingsPath
-                );
-
-                if (_instance != null)
-                {
-                    return _instance;
-                }
-
-                _instance = CreateInstance<ProjectAnimationSettings>();
-                if (!UnityEditor.AssetDatabase.IsValidFolder("Assets/Editor"))
-                {
-                    UnityEditor.AssetDatabase.CreateFolder("Assets", "Editor");
-                }
-                UnityEditor.AssetDatabase.CreateAsset(_instance, SettingsPath);
-                UnityEditor.AssetDatabase.SaveAssets();
-                UnityEditor.AssetDatabase.Refresh();
-                Debug.Log("Created ProjectAnimationSettings at: " + SettingsPath);
-                return _instance;
-            }
-        }
-
-        public void Save()
-        {
-            UnityEditor.EditorUtility.SetDirty(this);
-        }
-    }
-#endif
-}

package/Editor/Sprites/ProjectAnimationSettings.cs.meta

@@ -1,3 +0,0 @@
-fileFormatVersion: 2
-guid: 101e4c7dfdbb4bc082723ef60653c695
-timeCreated: 1748360618

package/Editor/Sprites/TextureSettingsApplier.cs

@@ -1,178 +0,0 @@
-namespace WallstopStudios.UnityHelpers.Editor.Sprites
-{
-#if UNITY_EDITOR
-    using System;
-    using System.Collections.Generic;
-    using System.IO;
-    using System.Linq;
-    using UnityEditor;
-    using UnityEngine;
-    using Core.Attributes;
-    using Core.Extension;
-    using WallstopStudios.UnityHelpers.Utils;
-    using Object = UnityEngine.Object;
-
-    public sealed class TextureSettingsApplier : ScriptableWizard
-    {
-        public bool applyReadOnly;
-        public bool isReadOnly;
-        public bool applyMipMaps;
-        public bool generateMipMaps;
-        public bool applyWrapMode;
-
-        [WShowIf(nameof(applyWrapMode))]
-        public TextureWrapMode wrapMode = TextureWrapMode.Clamp;
-
-        public bool applyFilterMode;
-
-        [WShowIf(nameof(applyFilterMode))]
-        public FilterMode filterMode = FilterMode.Trilinear;
-
-        public TextureImporterCompression compression = TextureImporterCompression.CompressedHQ;
-        public bool useCrunchCompression = true;
-        public TextureResizeAlgorithm textureResizeAlgorithm = TextureResizeAlgorithm.Bilinear;
-        public int maxTextureSize = SetTextureImportData.MaxTextureSize;
-        public TextureImporterFormat textureFormat = TextureImporterFormat.Automatic;
-        public List<string> spriteFileExtensions = new() { ".png" };
-
-        public List<Texture2D> textures = new();
-
-        [Tooltip(
-            "Drag a folder from Unity here to apply the configuration to all settings under it. No sprites are modified if no directories are provided."
-        )]
-        public List<Object> directories = new();
-
-        [MenuItem("Tools/Wallstop Studios/Unity Helpers/Texture Settings Applier")]
-        public static void CreateAnimation()
-        {
-            _ = DisplayWizard<TextureSettingsApplier>("Texture Settings Directory Applier", "Set");
-        }
-
-        private void OnWizardCreate()
-        {
-            HashSet<string> uniqueDirectories = new();
-            foreach (Object directory in directories)
-            {
-                string assetPath = AssetDatabase.GetAssetPath(directory);
-                if (Directory.Exists(assetPath))
-                {
-                    _ = uniqueDirectories.Add(assetPath);
-                }
-            }
-
-            int textureCount = 0;
-            HashSet<string> processedPaths = new();
-            foreach (
-                Texture2D texture in textures
-                    ?.Distinct()
-                    .OrderBy(texture => texture != null ? texture.name : string.Empty)
-                    ?? Enumerable.Empty<Texture2D>()
-            )
-            {
-                if (texture == null)
-                {
-                    continue;
-                }
-
-                string assetPath = AssetDatabase.GetAssetPath(texture);
-                if (
-                    processedPaths.Add(Application.dataPath + assetPath)
-                    && TryUpdateTextureSettings(assetPath)
-                )
-                {
-                    ++textureCount;
-                }
-            }
-
-            Queue<string> directoriesToCheck = new(uniqueDirectories);
-            while (directoriesToCheck.TryDequeue(out string directoryPath))
-            {
-                foreach (string fullFilePath in Directory.EnumerateFiles(directoryPath))
-                {
-                    if (!spriteFileExtensions.Contains(Path.GetExtension(fullFilePath)))
-                    {
-                        continue;
-                    }
-
-                    int index = fullFilePath.LastIndexOf(
-                        directoryPath,
-                        StringComparison.OrdinalIgnoreCase
-                    );
-                    if (index < 0)
-                    {
-                        continue;
-                    }
-
-                    string filePath = fullFilePath.Substring(index);
-                    if (processedPaths.Add(fullFilePath) && TryUpdateTextureSettings(filePath))
-                    {
-                        ++textureCount;
-                    }
-                }
-
-                foreach (string subDirectory in Directory.EnumerateDirectories(directoryPath))
-                {
-                    int index = subDirectory.LastIndexOf(
-                        directoryPath,
-                        StringComparison.OrdinalIgnoreCase
-                    );
-                    if (index < 0)
-                    {
-                        continue;
-                    }
-
-                    directoriesToCheck.Enqueue(subDirectory.Substring(index));
-                }
-            }
-
-            this.Log($"Processed {textureCount} textures.");
-            if (0 < textureCount)
-            {
-                AssetDatabase.Refresh();
-            }
-        }
-
-        private bool TryUpdateTextureSettings(string filePath)
-        {
-            TextureImporter textureImporter = AssetImporter.GetAtPath(filePath) as TextureImporter;
-            if (textureImporter == null)
-            {
-                return false;
-            }
-
-            textureImporter.SetPlatformTextureSettings(
-                new TextureImporterPlatformSettings
-                {
-                    resizeAlgorithm = textureResizeAlgorithm,
-                    maxTextureSize = maxTextureSize,
-                    format = textureFormat,
-                    textureCompression = compression,
-                    crunchedCompression = useCrunchCompression,
-                }
-            );
-            if (applyReadOnly)
-            {
-                textureImporter.isReadable = !isReadOnly;
-            }
-
-            if (applyMipMaps)
-            {
-                textureImporter.mipmapEnabled = generateMipMaps;
-            }
-
-            if (applyWrapMode)
-            {
-                textureImporter.wrapMode = wrapMode;
-            }
-
-            if (applyFilterMode)
-            {
-                textureImporter.filterMode = filterMode;
-            }
-
-            textureImporter.SaveAndReimport();
-            return true;
-        }
-    }
-#endif
-}

package/Editor/Sprites/TextureSettingsApplier.cs.meta

@@ -1,3 +0,0 @@
-fileFormatVersion: 2
-guid: 23e3474825574ecfa1084d4d4ca83ebd
-timeCreated: 1720666563

package/Runtime/Core/Attributes/ParentComponent.cs

@@ -1,189 +0,0 @@
-namespace WallstopStudios.UnityHelpers.Core.Attributes
-{
-    using System;
-    using System.Collections;
-    using System.Collections.Generic;
-    using System.Linq;
-    using System.Reflection;
-    using Extension;
-    using Helper;
-    using JetBrains.Annotations;
-    using UnityEngine;
-
-    [AttributeUsage(AttributeTargets.Field)]
-    [MeansImplicitUse]
-    public sealed class ParentComponentAttribute : Attribute
-    {
-        public bool optional = false;
-        public bool includeInactive = true;
-        public bool onlyAncestors = false;
-    }
-
-    public static class ParentComponentExtensions
-    {
-        private static readonly Dictionary<
-            Type,
-            (FieldInfo field, ParentComponentAttribute attribute, Action<object, object> setter)[]
-        > FieldsByType = new();
-
-        public static void AssignParentComponents(this Component component)
-        {
-            Type componentType = component.GetType();
-            (
-                FieldInfo field,
-                ParentComponentAttribute attribute,
-                Action<object, object> setter
-            )[] fields = FieldsByType.GetOrAdd(
-                componentType,
-                type =>
-                {
-                    FieldInfo[] fields = type.GetFields(
-                        BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic
-                    );
-                    return fields
-                        .Select(field =>
-                            field.IsAttributeDefined(out ParentComponentAttribute attribute)
-                                ? (field, attribute, ReflectionHelpers.GetFieldSetter(field))
-                                : (null, null, null)
-                        )
-                        .Where(tuple => tuple.attribute != null)
-                        .ToArray();
-                }
-            );
-
-            foreach (
-                (
-                    FieldInfo field,
-                    ParentComponentAttribute attribute,
-                    Action<object, object> setter
-                ) in fields
-            )
-            {
-                Type fieldType = field.FieldType;
-                bool isArray = fieldType.IsArray;
-                Type parentComponentType = isArray ? fieldType.GetElementType() : fieldType;
-                bool foundParent;
-                if (attribute.onlyAncestors)
-                {
-                    Transform parent = component.transform.parent;
-                    if (parent == null)
-                    {
-                        foundParent = false;
-                    }
-                    else if (isArray)
-                    {
-                        Component[] parentComponents = parent.GetComponentsInParent(
-                            parentComponentType,
-                            attribute.includeInactive
-                        );
-                        foundParent = 0 < parentComponents.Length;
-
-                        Array correctTypedArray = ReflectionHelpers.CreateArray(
-                            parentComponentType,
-                            parentComponents.Length
-                        );
-                        Array.Copy(parentComponents, correctTypedArray, parentComponents.Length);
-                        setter(component, correctTypedArray);
-                    }
-                    else if (
-                        fieldType.IsGenericType
-                        && fieldType.GetGenericTypeDefinition() == typeof(List<>)
-                    )
-                    {
-                        parentComponentType = fieldType.GenericTypeArguments[0];
-
-                        Component[] parents = parent.GetComponentsInParent(
-                            parentComponentType,
-                            attribute.includeInactive
-                        );
-
-                        IList instance = ReflectionHelpers.CreateList(
-                            parentComponentType,
-                            parents.Length
-                        );
-
-                        foundParent = false;
-                        foreach (Component parentComponent in parents)
-                        {
-                            instance.Add(parentComponent);
-                            foundParent = true;
-                        }
-
-                        setter(component, instance);
-                    }
-                    else
-                    {
-                        Component childComponent = parent.GetComponentInParent(
-                            parentComponentType,
-                            attribute.includeInactive
-                        );
-                        foundParent = childComponent != null;
-                        if (foundParent)
-                        {
-                            setter(component, childComponent);
-                        }
-                    }
-                }
-                else
-                {
-                    if (isArray)
-                    {
-                        Component[] parentComponents = component.GetComponentsInParent(
-                            parentComponentType,
-                            attribute.includeInactive
-                        );
-                        foundParent = 0 < parentComponents.Length;
-
-                        Array correctTypedArray = ReflectionHelpers.CreateArray(
-                            parentComponentType,
-                            parentComponents.Length
-                        );
-                        Array.Copy(parentComponents, correctTypedArray, parentComponents.Length);
-                        setter(component, correctTypedArray);
-                    }
-                    else if (
-                        fieldType.IsGenericType
-                        && fieldType.GetGenericTypeDefinition() == typeof(List<>)
-                    )
-                    {
-                        parentComponentType = fieldType.GenericTypeArguments[0];
-                        Component[] parents = component.GetComponentsInParent(
-                            parentComponentType,
-                            attribute.includeInactive
-                        );
-
-                        IList instance = ReflectionHelpers.CreateList(
-                            parentComponentType,
-                            parents.Length
-                        );
-
-                        foundParent = false;
-                        foreach (Component parentComponent in parents)
-                        {
-                            instance.Add(parentComponent);
-                            foundParent = true;
-                        }
-                        setter(component, instance);
-                    }
-                    else
-                    {
-                        Component childComponent = component.GetComponentInParent(
-                            parentComponentType,
-                            attribute.includeInactive
-                        );
-                        foundParent = childComponent != null;
-                        if (foundParent)
-                        {
-                            setter(component, childComponent);
-                        }
-                    }
-                }
-
-                if (!foundParent && !attribute.optional)
-                {
-                    component.LogError($"Unable to find parent component of type {fieldType}");
-                }
-            }
-        }
-    }
-}