-
Notifications
You must be signed in to change notification settings - Fork 20
Restore GeoInterfaceRecipes as empty stub package #213
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
evetion
merged 6 commits into
JuliaGeo:main
from
repro-code:restore-geointerfacerecipes
Jan 19, 2026
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b3b6d43
Add GeoInterfaceRecipes/Project.toml
repro-code 3f0c6cf
Add GeoInterfaceRecipes/src/GeoInterfaceRecipes.jl
repro-code 35e9d28
Add GeoInterfaceRecipes/test/runtests.jl
repro-code acf8d46
Add GeoInterfaceRecipes/LICENSE
repro-code 299f4eb
Add GeoInterfaceRecipes/README.md
repro-code f004943
Redirect macros to extensions.
evetion File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2022 Julia Computing | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| name = "GeoInterfaceRecipes" | ||
| uuid = "0329782f-3d07-4b52-b9f6-d3137cf03c7a" | ||
| version = "1.0.3" | ||
| authors = ["JuliaGeo and contributors"] | ||
|
|
||
| [deps] | ||
| GeoInterface = "cf35fbd7-0cd7-5166-be24-54bfbe79505f" | ||
| RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01" | ||
|
|
||
| [compat] | ||
| GeoInterface = "1.5" | ||
| RecipesBase = "1" | ||
| julia = "1.9" | ||
|
|
||
| [extras] | ||
| Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" | ||
| Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" | ||
|
|
||
| [targets] | ||
| test = ["Plots", "Test"] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # GeoInterfaceRecipes.jl | ||
|
|
||
| **This package is deprecated.** | ||
|
|
||
| Plotting recipes for GeoInterface geometries are now built directly into [GeoInterface.jl](https://github.com/JuliaGeo/GeoInterface.jl) as package extensions: | ||
|
|
||
| - **Plots.jl support**: Load `GeoInterface` with `Plots` and recipes work automatically | ||
| - **Makie.jl support**: Load `GeoInterface` with `Makie` and `GeometryBasics` for Makie plotting | ||
|
|
||
| ## Migration | ||
|
|
||
| No action is needed. Simply remove `GeoInterfaceRecipes` from your dependencies and use `GeoInterface` directly with your preferred plotting package. | ||
|
|
||
| ```julia | ||
| using GeoInterface | ||
| using Plots # or using Makie | ||
|
|
||
| # Plotting just works | ||
| plot(my_geometry) | ||
| ``` | ||
|
|
||
| This empty package exists only to provide a smooth upgrade path for users who had GeoInterfaceRecipes.jl in their dependencies. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| module GeoInterfaceRecipes | ||
| using RecipesBase | ||
| using GeoInterface | ||
|
|
||
| export @enable_geo_plots | ||
|
|
||
| # This package is deprecated. Plotting recipes are now built into GeoInterface.jl | ||
| # as package extensions. See: | ||
| # - GeoInterfaceRecipesBaseExt for Plots.jl support | ||
| # - GeoInterfaceMakieExt for Makie.jl support | ||
|
|
||
| # This stub package exists only to allow smooth upgrades for users who had | ||
| # GeoInterfaceRecipes.jl installed. No action is needed - simply load | ||
| # GeoInterface with Plots or Makie and the recipes will work automatically. | ||
|
|
||
| macro enable(typ) | ||
| :(GeoInterface.@enable_plots RecipesBase $(esc(typ))) | ||
| end | ||
|
|
||
| # Compat | ||
| macro enable_geo_plots(typ) | ||
| :(GeoInterface.@enable_plots RecipesBase $(esc(typ))) | ||
| end | ||
|
|
||
| end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| using GeoInterfaceRecipes | ||
| using GeoInterface | ||
| using Plots | ||
| using Test | ||
|
|
||
|
|
||
| abstract type MyAbstractGeom{N} end | ||
| # Implement interface | ||
| struct MyPoint{N} <: MyAbstractGeom{N} end | ||
| struct MyCurve{N} <: MyAbstractGeom{N} end | ||
| struct MyLinearRing{N} <: MyAbstractGeom{N} end | ||
| struct MyLineString{N} <: MyAbstractGeom{N} end | ||
| struct MyPolygon{N} <: MyAbstractGeom{N} end | ||
| struct MyMultiPoint{N} <: MyAbstractGeom{N} end | ||
| struct MyMultiCurve{N} <: MyAbstractGeom{N} end | ||
| struct MyMultiPolygon{N} <: MyAbstractGeom{N} end | ||
| struct MyCollection{N} <: MyAbstractGeom{N} end | ||
| struct MyFeature end | ||
| struct MyFeatureCollection end | ||
|
|
||
| GeoInterfaceRecipes.@enable MyAbstractGeom | ||
| GeoInterfaceRecipes.@enable MyFeature | ||
| # Test legacy interface | ||
| GeoInterfaceRecipes.@enable_geo_plots MyFeatureCollection | ||
|
|
||
| GeoInterface.isgeometry(::MyAbstractGeom) = true | ||
| GeoInterface.is3d(::GeoInterface.AbstractGeometryTrait, ::MyAbstractGeom{N}) where {N} = N == 3 | ||
| GeoInterface.ncoord(::GeoInterface.AbstractGeometryTrait, geom::MyAbstractGeom{N}) where {N} = N | ||
| GeoInterface.coordnames(::GeoInterface.AbstractGeometryTrait, ::MyAbstractGeom{2}) = (:X, :Y) | ||
| GeoInterface.coordnames(::GeoInterface.AbstractGeometryTrait, ::MyAbstractGeom{3}) = (:X, :Y, :Z) | ||
|
|
||
| GeoInterface.geomtrait(::MyPoint) = GeoInterface.PointTrait() | ||
| GeoInterface.getcoord(::GeoInterface.PointTrait, geom::MyPoint{2}, i::Integer) = (rand(1:10), rand(11:20))[i] | ||
| GeoInterface.getcoord(::GeoInterface.PointTrait, geom::MyPoint{3}, i::Integer) = (rand(1:10), rand(11:20), rand(21:30))[i] | ||
|
|
||
| GeoInterface.geomtrait(::MyCurve) = GeoInterface.LineStringTrait() | ||
| GeoInterface.ngeom(::GeoInterface.LineStringTrait, geom::MyCurve) = 3 | ||
| GeoInterface.getgeom(::GeoInterface.LineStringTrait, geom::MyCurve{N}, i) where {N} = MyPoint{N}() | ||
| GeoInterface.convert(::Type{MyCurve}, ::GeoInterface.LineStringTrait, geom) = geom | ||
|
|
||
| GeoInterface.geomtrait(::MyLinearRing) = GeoInterface.LinearRingTrait() | ||
| GeoInterface.ngeom(::GeoInterface.LinearRingTrait, geom::MyLinearRing) = 3 | ||
| GeoInterface.getgeom(::GeoInterface.LinearRingTrait, geom::MyLinearRing{N}, i) where {N} = MyPoint{N}() | ||
| GeoInterface.convert(::Type{MyLinearRing}, ::GeoInterface.LinearRingTrait, geom) = geom | ||
|
|
||
| GeoInterface.geomtrait(::MyLineString) = GeoInterface.LineStringTrait() | ||
| GeoInterface.ngeom(::GeoInterface.LineStringTrait, geom::MyLineString) = 3 | ||
| GeoInterface.getgeom(::GeoInterface.LineStringTrait, geom::MyLineString{N}, i) where {N} = MyPoint{N}() | ||
| GeoInterface.convert(::Type{MyLineString}, ::GeoInterface.LineStringTrait, geom) = geom | ||
|
|
||
| GeoInterface.geomtrait(::MyPolygon) = GeoInterface.PolygonTrait() | ||
| GeoInterface.ngeom(::GeoInterface.PolygonTrait, geom::MyPolygon) = 2 | ||
| GeoInterface.getgeom(::GeoInterface.PolygonTrait, geom::MyPolygon{N}, i) where {N} = MyCurve{N}() | ||
|
|
||
| GeoInterface.geomtrait(::MyMultiPolygon) = GeoInterface.MultiPolygonTrait() | ||
| GeoInterface.ngeom(::GeoInterface.MultiPolygonTrait, geom::MyMultiPolygon) = 2 | ||
| GeoInterface.getgeom(::GeoInterface.MultiPolygonTrait, geom::MyMultiPolygon{N}, i) where {N} = MyPolygon{N}() | ||
|
|
||
| GeoInterface.geomtrait(::MyMultiPoint) = GeoInterface.MultiPointTrait() | ||
| GeoInterface.ngeom(::GeoInterface.MultiPointTrait, geom::MyMultiPoint) = 10 | ||
| GeoInterface.getgeom(::GeoInterface.MultiPointTrait, geom::MyMultiPoint{N}, i) where {N} = MyPoint{N}() | ||
|
|
||
| GeoInterface.geomtrait(geom::MyCollection) = GeoInterface.GeometryCollectionTrait() | ||
| GeoInterface.ncoord(::GeoInterface.GeometryCollectionTrait, geom::MyCollection{N}) where {N} = N | ||
| GeoInterface.ngeom(::GeoInterface.GeometryCollectionTrait, geom::MyCollection) = 4 | ||
| GeoInterface.getgeom(::GeoInterface.GeometryCollectionTrait, geom::MyCollection{N}, i) where {N} = MyMultiPolygon{N}() | ||
|
|
||
| GeoInterface.trait(::MyFeature) = FeatureTrait() | ||
| GeoInterface.trait(::MyFeatureCollection) = FeatureCollectionTrait() | ||
| GeoInterface.getfeature(::GeoInterface.FeatureCollectionTrait, geom::MyFeatureCollection, i) = MyFeature() | ||
| GeoInterface.getfeature(::GeoInterface.FeatureCollectionTrait, geom::MyFeatureCollection) = [MyFeature(), MyFeature()] | ||
| GeoInterface.geometry(geom::MyFeature) = rand((MyPolygon{2}(), MyMultiPolygon{2}())) | ||
| GeoInterface.nfeature(::GeoInterface.FeatureTrait, geom::MyFeature) = 1 | ||
|
|
||
| @testset "plot" begin | ||
| # We just check if they actually run | ||
| # 2d | ||
| plot(MyPoint{2}()) | ||
| plot(MyCurve{2}()) | ||
| plot(MyLinearRing{2}()) | ||
| plot(MyLineString{2}()) | ||
| plot(MyMultiPoint{2}()) | ||
| plot(MyPolygon{2}()) | ||
| plot(MyMultiPolygon{2}()) | ||
| plot(MyCollection{2}()) | ||
| # 3d | ||
| plot(MyPoint{3}()) | ||
| plot(MyCurve{3}()) | ||
| plot(MyLinearRing{3}()) | ||
| plot(MyLineString{3}()) | ||
| plot(MyMultiPoint{3}()) | ||
| plot(MyPolygon{3}()) | ||
| plot(MyMultiPolygon{3}()) | ||
| plot(MyCollection{3}()) | ||
| plot(MyFeature()) | ||
| plot(MyFeatureCollection()) | ||
| end |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it a breaking change to delete the macro? Maybe we should offer at least a stub macro that throws a deprecation warning?
Otherwise this should be v2.0 technically.
Other than that, this looks good.
This could also just forward the expression to the macro that is now in GeoInterface which would be a non breaking change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, I see now this is missing the RecipesBase = "1" dependency. The idea is, as soon as you load this package, the extension is guaranteed to trigger (which currently causes the compilation warning we're trying to prevent). So this should be non-breaking.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably need to update the compat to julia 1.10 so extensions are guaranteed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What I mean by breaking change is that this macro will no longer exist
https://github.com/JuliaGeo/LibGEOS.jl/blob/09921624ba36eb53f470ae99758dd65324e742ab/src/geo_interface.jl#L290
So this package would have to at least load RecipesBase (via
using) and provide a macro that doesn't error when used in this way to be non-breaking (what the macro does is then kind of immaterial although it would be great to forward it toGeoInterface.@enable_plots)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Btw you can invoke macros as functions so long as you provide the file and line information
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, using RecipesBase + a stub macro it is. I don't think you can forward though without getting into overlap again, I rather keep it non-functional.