Refactor EF extensions

[knackebrot]

Add missing XML documentation, use standard ArgumentOutOfRangeException overload, remove unnecessary overload and use default parameters instead.

Summary by CodeRabbit

• Refactor

  • Enhanced pagination API: parameters now accept sensible defaults and cancellation tokens; obsolete overload removed.
  • Stricter validation and standardized argument checking (including negative total counts).
  • Optimized subset retrieval to avoid unnecessary queries when page offset exceeds total items.

• Documentation

  • Updated docs to reflect new parameter defaults, exception behavior, and cancellation semantics.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Updates to two Entity Framework pagination extension methods: ToPagedListAsync<T> signatures now accept optional totalSetCount = null and CancellationToken = default; validation and null-checks refactored; total-count and subset retrieval logic adjusted; an obsolete overload removed; XML docs updated to reflect new behavior and exceptions.

Changes

Cohort / File(s)	Summary
EF Core extensions src/X.PagedList.EF/PagedListExtensions.cs	Made totalSetCount and cancellationToken optional (= null, = default); replaced null-check with ArgumentNullException.ThrowIfNull; standardized ArgumentOutOfRangeException checks for pageNumber/pageSize; added negative totalSetCount validation; compute totalCount from provided value or CountAsync; fetch subset only when skip < totalCount; removed obsolete overload; updated XML docs.
EF6/EntityFramework extensions src/X.PagedList.EntityFramework/PagedListExtensions.cs	Same signature and logic changes as above: optional totalSetCount/cancellationToken, tighter validations, conditional subset retrieval based on skip < totalCount, obsolete overload removal, and XML documentation updates.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 I twitch my whiskers, code in paw,
Optional counts now rest in awe,
Checks refined, the pages flow,
Skip and count in tidy row,
Hooray — async hops on we go!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Refactor EF extensions' is too vague and generic. It doesn't clearly indicate the specific changes made, such as adding XML documentation, standardizing parameter validation, or removing overloads.	Use a more descriptive title that highlights the main change, e.g., 'Make EF extension parameters optional with default values' or 'Standardize ToPagedListAsync parameter handling'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@src/X.PagedList.EF/PagedListExtensions.cs`:
- Around line 29-31: The XML documentation for the PagedListExtensions member
contains an unclosed <exception> tag; update the doc comment in
PagedListExtensions.cs (the XML summary/exception/seealso block for the
PagedList-related method) by adding the missing closing </exception> tag after
the ArgumentOutOfRangeException description so the <seealso
cref="PagedList{T}"/> tag is correctly nested and the XML is well-formed.

In `@src/X.PagedList.EntityFramework/PagedListExtensions.cs`:
- Around line 29-32: The XML doc for the method in PagedListExtensions has an
unclosed <exception> tag for the ArgumentOutOfRangeException; fix it by adding
the missing </exception> closing tag after the ArgumentOutOfRangeException
description so all <exception> elements are properly closed (keep the other tags
like <seealso cref="PagedList{T}"/> intact).

🧹 Nitpick comments (2)

src/X.PagedList.EF/PagedListExtensions.cs (1)

55-55: Potential integer overflow in skip calculation.

For large values of pageNumber and pageSize, the multiplication could overflow. Consider using checked arithmetic or validating the inputs don't exceed safe bounds.

♻️ Option: Use checked arithmetic

-        int skip = (pageNumber - 1) * pageSize;
+        int skip = checked((pageNumber - 1) * pageSize);

src/X.PagedList.EntityFramework/PagedListExtensions.cs (1)

59-59: Potential integer overflow in skip calculation.

Same concern as in the EF Core version — consider using checked arithmetic for safety.

♻️ Option: Use checked arithmetic

-        int skip = (pageNumber - 1) * pageSize;
+        int skip = checked((pageNumber - 1) * pageSize);