feat(#11): support 'select' in HXLocation

[krikkiteer]

Description

• adds support for 'select' param of HXLocation
• extends the HXLocation tests for 'select'
• fixes a typo in CONTRIBUTING.md

Closes

resolves issue #11

Summary by Sourcery

Add the 'select' attribute to HXLocation types, constructors, and response serialization, update tests to cover it, and correct a documentation typo

New Features:

• Support the 'select' parameter in HXLocation responses

Documentation:

• Fix typo in CONTRIBUTING.rst

Tests:

• Extend HXLocation tests to verify 'select' behavior

[sourcery-ai]

Reviewer's Guide

This PR introduces support for the select parameter in HXLocation by extending the response model, type definitions, and tests, along with a minor documentation typo fix.

Updated class diagram for HXLocation and LocationType

classDiagram
    class HTMXResponse {
        %% Base class, details not directly modified by this PR
    }

    class HXLocation {
        +__init__(path: str, source: str | None, event: str | None, target: str | None, select: str | None, swap: ReSwapMethod | None, hx_headers: dict[str, Any] | None, values: dict[str, str] | None, **kwargs) void
    }
    HXLocation --|> HTMXResponse

    class LocationType {
        <<TypedDict>>
        path: str
        source: str | None
        event: str | None
        target: str | None
        select: str | None
        swap: ReSwapMethod | None
        values: dict[str, str] | None
        hx_headers: dict[str, Any] | None
    }
    HXLocation ..> LocationType : uses

Loading

File-Level Changes

Change	Details	Files
Support select in HXLocation initialization and serialization	Added select parameter to HXLocation constructor signature Included select in the JSON output mapping Extended the TypedDict to define the select field	litestar_htmx/response.py litestar_htmx/types.py
Extend HXLocation tests to verify select behavior	Added select="#content" to the test handler invocation Updated the expected JSON spec string to include the select field	tests/test_htmx_response.py
Correct a typo in contribution guidelines	Fixed a spelling/formatting typo in the contributing documentation	CONTRIBUTING.rst

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @krikkiteer - I've reviewed your changes - here's some feedback:

• Update the HXLocation class docstring (and any public API docs) to include the new select parameter so it's discoverable by users.
• Consider refactoring the manual JSON string construction into building a dict and using json.dumps for consistent key ordering and easier future extensions.
• Add a test case to verify that when select is not provided (None) the key is omitted from the serialized HX-Location header payload.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}