Skip to content

Conversation

@saibotk
Copy link
Member

@saibotk saibotk commented Aug 13, 2025

Updated the Readme to mention the new native Laravel Blueprint methods instead of ours and also removed some leftovers from v1.

Also marked the 2.0.1 release to get the last bugfix out :)

Summary by CodeRabbit

  • Documentation
    • Added Unreleased 2.0.1 entry with a “Fixed” note about casts after serialization in queueable anonymous event listeners (credit @Henridv, Support casting from WKT representation #149).
    • Introduced a deprecation policy for most PostGIS schema methods; recommend Laravel’s native geometry/geography. Only Box2D, Box3D, and GeometryCollection (incl. M/Z/ZM variants) remain supported.
    • Updated guidance, examples, note blocks, and table of contents; removed outdated image and added a Security Vulnerabilities entry.

@saibotk saibotk requested a review from studnitz August 13, 2025 08:53
@saibotk saibotk self-assigned this Aug 13, 2025
@coderabbitai
Copy link

coderabbitai bot commented Aug 13, 2025

📝 Walkthrough

Walkthrough

Adds a 2.0.1 (Unreleased) entry to CHANGELOG with a fixed note and updates README to deprecate most PostGIS schema methods, recommending Laravel’s built-in geometry/geography types while listing the remaining non-deprecated magellan types.

Changes

Cohort / File(s) Summary
Changelog Update
CHANGELOG.md
Added Unreleased 2.0.1 entry with a fix note referencing cast usage after serialization in queueable anonymous event listeners.
README Deprecations & Restructure
README.md
Documented deprecation of most magellan Schema Blueprint methods; emphasized using Laravel geometry/geography methods; listed non-deprecated special types (Box2D, Box3D, GeometryCollection variants); removed schema-method image; updated TOC, notes, and examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested labels

skip-changelog

Suggested reviewers

  • studnitz

Poem

In footnotes I thump, in headings I cheer,
Deprecations hop in, the path now clear.
Boxes and collections, still safe to roam,
Geometry goes native—a comfy new home.
Ears up, 2.0.1 draws near—
A rabbit signs off: docs are here! 🐇✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release-2.0.1

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
README.md (2)

34-41: Fix markdown list indentation (MD007) in the Table of Contents.

markdownlint flags these as over-indented. Switch to two-space indentation for nested list items.

Apply this diff:

-    - [Example Setup](#example-setup)
-    - [Insert/Update](#insertupdate)
-    - [Insert/Update with different SRID](#insertupdate-with-different-srid)
-    - [Select](#select)
-    - [Using PostGIS functions in queries](#using-postgis-functions-in-queries)
-    - [Alias in select](#alias-in-select)
-    - [Geometry or Geography](#geometry-or-geography)
-    - [Autocast for BBox or geometries](#autocast-for-bbox-or-geometries)
+  - [Example Setup](#example-setup)
+  - [Insert/Update](#insertupdate)
+  - [Insert/Update with different SRID](#insertupdate-with-different-srid)
+  - [Select](#select)
+  - [Using PostGIS functions in queries](#using-postgis-functions-in-queries)
+  - [Alias in select](#alias-in-select)
+  - [Geometry or Geography](#geometry-or-geography)
+  - [Autocast for BBox or geometries](#autocast-for-bbox-or-geometries)
-    - [Database Name Prepending (Cross Database Connections)](#database-name-prepending-cross-database-connections)
+  - [Database Name Prepending (Cross Database Connections)](#database-name-prepending-cross-database-connections)

Also applies to: 43-43


136-151: Good: explicit list of non-deprecated schema methods; ensure consistency with examples elsewhere.

This section clearly lists the supported magellan methods going forward. As a follow-up, audit remaining examples in the README that still use deprecated methods (e.g., table creation using magellanPoint) and either update them to Laravel’s native methods or label them as legacy.

I can sweep the README and propose a patch to replace or annotate deprecated usages for consistency. Want me to proceed?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e50ed42 and b0f137a.

⛔ Files ignored due to path filters (1)
  • art/magellan_schema.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

34-34: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


35-35: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


36-36: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


37-37: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


38-38: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


39-39: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


40-40: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


41-41: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


43-43: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

🔇 Additional comments (2)
CHANGELOG.md (1)

10-15: Release entry looks good; ensure the 2.0.1 tag and GH release are created to avoid dead links.

The 2.0.1 section is well-formed and fits Keep a Changelog. Once merged, make sure to push the git tag 2.0.1 and create the corresponding GitHub release so the link resolves.

Would you like me to draft the GitHub release notes using this CHANGELOG entry for the 2.0.1 tag?

README.md (1)

140-140: Validate the example syntax for Laravel’s native geometry column.

The comment shows ->geometry('location', 'POINT', 4326). Verify this aligns with Laravel 11/12’s Blueprint API to avoid confusing users.

If confirmed otherwise, I can update the example to the correct signature across supported Laravel versions.

@saibotk saibotk merged commit 71a2e01 into main Aug 13, 2025
16 checks passed
@saibotk saibotk deleted the release-2.0.1 branch August 13, 2025 09:25
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.

3 participants