Skip to content

Conversation

@tech-andgar
Copy link
Owner

@tech-andgar tech-andgar commented Sep 18, 2025

Add a new method that returns a record with success and error values for destructuring.
Include documentation and tests for the new functionality.

Summary by Sourcery

Introduce a getBoth method to Result that returns a record containing both success and error values for easy destructuring using Dart 3 record patterns

New Features:

  • Add getBoth method on Result to return a Dart 3 record with optional success and error fields

Documentation:

  • Document getBoth usage in README with example code for record destructuring

Tests:

  • Add tests verifying getBoth returns correct record for Success and Failure cases

Add a new method that returns a record with success and error values for destructuring.
Include documentation and tests for the new functionality.
@sourcery-ai
Copy link

sourcery-ai bot commented Sep 18, 2025

Reviewer's Guide

This PR introduces a new getBoth method on the ResultDart hierarchy to return a Dart 3 record for easy destructuring of success and error values, and adds corresponding documentation and unit tests.

File-Level Changes

Change Details Files
Add getBoth API to ResultDart interface and its implementations
  • Declared ({S? success, F? error}) getBoth() in the sealed base class with doc comments
  • Implemented getBoth in Success to return (success, null)
  • Implemented getBoth in Failure to return (null, error)
lib/src/result_dart_base.dart
Document getBoth usage in README
  • Added a new section showing example of destructuring record with getBoth
  • Explained return values and null handling in the README
README.md
Add unit tests for getBoth behavior
  • Created a test group for getBoth
  • Added test case for success returning non-null success and null error
  • Added test case for failure returning null success and non-null error
test/src/result_dart_base_test.dart

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@tech-andgar
Copy link
Owner Author

@sourcery-ai title

@sourcery-ai sourcery-ai bot changed the title feat(result): add getBoth method for Dart 3 record patterns Add getBoth method for record destructuring Sep 18, 2025
@tech-andgar tech-andgar merged commit e0107be into main Sep 18, 2025
tech-andgar added a commit that referenced this pull request Sep 18, 2025
Add `getBoth` method for record destructuring
@tech-andgar tech-andgar deleted the feature/add-getboth-method branch September 18, 2025 06:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants