Sorting things out

[visr]

Fixes #1976.
Fixes most of #601.

[visr]

I removed the sorting information from the docs. We can add it back with Quarto using code so it won't be wrong again:

using Ribasim
using StructArrays: StructVector
using Legolas: AbstractRecord

"""
Get a string describing the sorting of a table type.

julia> sort_info(Ribasim.BasinTimeV1)
"Sorted by: node_id, time."
"""
function sort_info(table_type::Type{<:AbstractRecord})::String
    # create an empty table to get the sort by function
    table = StructVector{table_type}(undef, 0)
    # extract the column names from the getproperty calls in the expression
    by = Ribasim.sort_by(table)
    codeinfo = Base.uncompressed_ast(only(methods(by)))
    is_getproperty(ex) = ex isa Expr && ex.args[1].name == :getproperty
    cols = [ex.args[3].value for ex in codeinfo.code if is_getproperty(ex)]
    return "Sorted by: $(join(cols, ", "))."
end

using Test
@test sort_info(Ribasim.BasinStaticV1) == "Sorted by: node_id."
@test sort_info(Ribasim.BasinTimeV1) == "Sorted by: time, node_id."

There are just a few places tables that don't have a Julia schema like Basin / area and Terminal that do have sorting in Python.