Merge pull request #275 from nowsprinting/chore/paginator

Remove componentType property from paginators

Author: nowsprinting

README.md

@@ -159,12 +159,13 @@ public class MyIntegrationTest
     public async Task FindButtonInScrollView()
     {
         var finder = new GameObjectFinder();
-        var matcher = new NameMatcher("Button_10");
 
-        var scrollView = GameObject.Find("Scroll View");
-        var scrollRect = scrollView.GetComponent<ScrollRect>();
+        var scrollViewMatcher = new NameMatcher("Scroll View");
+        var scrollViewResult = await finder.FindByMatcherAsync(scrollViewMatcher);
+        var scrollRect = scrollViewResult.GameObject.GetComponent<ScrollRect>();
         var paginator = new UguiScrollRectPaginator(scrollRect);
 
+        var matcher = new NameMatcher("Button_10");
         var result = await finder.FindByMatcherAsync(matcher, paginator: paginator);
         var button = result.GameObject;
     }
@@ -468,13 +469,18 @@ For example, the built-in `ButtonMatcher` class's `IsMatch` method returns `true
 If your game title uses a custom pageable or scrollable UI components (e.g., Scroller, Carousel, Paged dialog), you can implement the `IPaginator` interface.
 The custom paginator can be specified as an argument to the `GameObjectFinder.FindByMatcherAsync` method.
 
-A paginator must implement the following methods and properties:
+A paginator must implement the following methods:
 
-- `ComponentType` property to return the type of UI component that the paginator controls
 - `ResetAsync` method to navigate to the top page
 - `NextPageAsync` method to navigate to the next page
 - `HasNextPage` property to return whether there is a next page
 
+In addition, the constructor must meet the following requirements:
+
+- A paginator must have a constructor with one or more parameters
+- The first parameter of the constructor is a pageable or scrollable component to be controlled
+- The type of the first parameter must be a subclass of `MonoBehaviour`
+
 
 
 ### IOperator interface

Runtime/Paginators/IPaginator.cs

@@ -1,7 +1,7 @@
 // Copyright (c) 2023-2025 Koji Hasegawa.
 // This software is released under the MIT License.
 
-using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 using Cysharp.Threading.Tasks;
 
@@ -11,13 +11,18 @@ namespace TestHelper.UI.Paginators
     /// Interface for pagination controller for finding <c>GameObject</c> on pageable or scrollable UI components (e.g., <c>ScrollRect</c>, Carousel, Paged dialog).
     /// Provides intuitive pagination operations as page navigation functionality, enabling auxiliary operations in the <see cref="GameObjectFinder"/>.
     /// </summary>
+    /// <remarks>
+    /// The implementation class must meet the following requirements:
+    /// <list type="bullet">
+    ///     <item>A paginator must have a constructor with one or more parameters</item>
+    ///     <item>The first parameter of the constructor is a pageable or scrollable component to be controlled</item>
+    ///     <item>The type of the first parameter must be a subclass of <c>MonoBehaviour</c></item>
+    /// </list>
+    /// <seealso cref="TestHelper.UI.Paginators.IPaginatorTest"/>
+    /// </remarks>
+    [SuppressMessage("ReSharper", "InvalidXmlDocComment")]
     public interface IPaginator
     {
-        /// <summary>
-        /// Pageable or scrollable UI component type.
-        /// </summary>
-        Type ComponentType { get; }
-
         /// <summary>
         /// Move the page position to the beginning.
         /// For scroll components, the display position (top, bottom, left, or right) depends on the implementation.

Runtime/Paginators/UguiScrollRectPaginator.cs

@@ -14,25 +14,27 @@ namespace TestHelper.UI.Paginators
     /// </summary>
     public class UguiScrollRectPaginator : IPaginator
     {
-        /// <inheritdoc />
-        public Type ComponentType => typeof(ScrollRect);
-
         private readonly ScrollRect _scrollRect;
         private bool _isHorizontalAtEnd;
 
         /// <summary>
-        /// Constructor.
+        /// Constructor that takes a scroller instance.
         /// </summary>
         /// <param name="scrollRect">ScrollRect to be controlled</param>
         /// <exception cref="ArgumentNullException">When scrollRect is null</exception>
         public UguiScrollRectPaginator(ScrollRect scrollRect)
         {
-            _scrollRect = scrollRect ?? throw new ArgumentNullException(nameof(scrollRect));
+            if (!scrollRect)
+            {
+                throw new ArgumentNullException(nameof(scrollRect));
+            }
 
-            if (_scrollRect.content == null)
+            if (!scrollRect.content)
             {
                 throw new ArgumentNullException(nameof(scrollRect.content), "ScrollRect.content is null");
             }
+
+            _scrollRect = scrollRect;
         }
 
         /// <inheritdoc />

Runtime/Paginators/UguiScrollbarPaginator.cs

@@ -14,19 +14,21 @@ namespace TestHelper.UI.Paginators
     /// </summary>
     public class UguiScrollbarPaginator : IPaginator
     {
-        /// <inheritdoc />
-        public Type ComponentType => typeof(Scrollbar);
-
         private readonly Scrollbar _scrollbar;
 
         /// <summary>
-        /// Constructor.
+        /// Constructor that takes a scroller instance.
         /// </summary>
         /// <param name="scrollbar">Scrollbar to be controlled</param>
         /// <exception cref="ArgumentNullException">When scrollbar is null</exception>
         public UguiScrollbarPaginator(Scrollbar scrollbar)
         {
-            _scrollbar = scrollbar ?? throw new ArgumentNullException(nameof(scrollbar));
+            if (!scrollbar)
+            {
+                throw new ArgumentNullException(nameof(scrollbar));
+            }
+
+            _scrollbar = scrollbar;
         }
 
         /// <inheritdoc />

Tests/Runtime/Paginators/IPaginatorTest.cs

@@ -0,0 +1,54 @@
+// Copyright (c) 2023-2025 Koji Hasegawa.
+// This software is released under the MIT License.
+
+using System;
+using System.Linq;
+using System.Reflection;
+using NUnit.Framework;
+using UnityEngine;
+
+namespace TestHelper.UI.Paginators
+{
+    [TestFixture]
+    public class IPaginatorTest
+    {
+        private static Type[] GetPaginators()
+        {
+            var interfaceType = typeof(IPaginator);
+            return AppDomain.CurrentDomain.GetAssemblies()
+                .SelectMany(assembly =>
+                {
+                    try
+                    {
+                        return assembly.GetTypes();
+                    }
+                    catch (ReflectionTypeLoadException ex)
+                    {
+                        return ex.Types.Where(t => t != null);
+                    }
+                    catch
+                    {
+                        return Enumerable.Empty<Type>();
+                    }
+                })
+                .Where(t => t != null && interfaceType.IsAssignableFrom(t) && t.IsClass && !t.IsAbstract)
+                .ToArray();
+        }
+
+        /// <summary>
+        /// Verify that the paginators and supported component type can be obtained via reflection.
+        /// </summary>
+        [TestCaseSource(nameof(GetPaginators))]
+        public void Constructor_HasOneParameterAndSubclassOfMonoBehaviour(Type paginatorType)
+        {
+            var ctor = paginatorType.GetConstructors()
+                .OrderBy(x => x.GetParameters().Length)
+                .FirstOrDefault(x => x.GetParameters().Length > 0);
+            Assume.That(ctor, Is.Not.Null, "A paginator must have a constructor with one or more parameters.");
+
+            var parameterType = ctor.GetParameters()[0].ParameterType;
+            Assert.That(parameterType.IsSubclassOf(typeof(MonoBehaviour)), Is.True,
+                "The first parameter of the constructor is a pageable or scrollable component to be controlled, which must be a subclass of MonoBehaviour.");
+        }
+    }
+}

Tests/Runtime/Paginators/IPaginatorTest.cs.meta

@@ -26,16 +26,6 @@ public void SetUp()
             _bothScrollView = GameObject.Find("Both Scroll View");
         }
 
-        [Test]
-        [LoadScene(TestScene)]
-        public void ComponentType_ReturnsScrollbar()
-        {
-            var scrollRect = _horizontalScrollView.GetComponent<ScrollRect>();
-            var sut = new UguiScrollRectPaginator(scrollRect);
-
-            Assert.That(sut.ComponentType, Is.EqualTo(typeof(ScrollRect)));
-        }
-
         [Test]
         [LoadScene(TestScene)]
         public void Constructor_ValidScrollRect_ObjectCreatedSuccessfully()

Tests/Runtime/Paginators/UguiScrollRectPaginatorTest.cs

@@ -43,16 +43,6 @@ public void SetUp()
             }
         }
 
-        [Test]
-        [LoadScene(TestScene)]
-        public void ComponentType_ReturnsScrollbar()
-        {
-            var scrollbar = _horizontalScrollbar.GetComponent<Scrollbar>();
-            var sut = new UguiScrollbarPaginator(scrollbar);
-
-            Assert.That(sut.ComponentType, Is.EqualTo(typeof(Scrollbar)));
-        }
-
         [Test]
         [LoadScene(TestScene)]
         public void Constructor_ValidScrollbar_ObjectCreatedSuccessfully()