fix: ProtocolEx compile error on Elixir 1.19 #9
Conversation
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
On Elixir 1.19, `mix compile` fails with:
```
== Compilation error in file lib/panpipe/document.ex ==
** (ProtocolEx.MissingRequiredProtocolDefinition) On Protocol `Elixir.Panpipe.Pandoc.AST.Node` missing a required protocol callback on `Panpipe.Pandoc.Document` of: to_panpipe/1
(protocol_ex 0.4.4) lib/protocol_ex.ex:692: anonymous fn/3 in ProtocolEx.verify_valid_spec_on_module/3
(elixir 1.19.3) lib/enum.ex:1688: Enum."-map/2-lists^map/1-1-"/2
(protocol_ex 0.4.4) lib/protocol_ex.ex:678: ProtocolEx.verify_valid_spec_on_module/3
lib/panpipe/document.ex:36: (file)
```
- `ProtocolEx.MissingRequiredProtocolDefinition`
- missing `to_panpipe/1` for the Pandoc document matcher (the `%{"blocks" => _, "pandoc-api-version" => _}` map)
Although `to_panpipe/1` was present in the `defimpl_ex` in `lib/panpipe/document.ex`, ProtocolEx's compile-time verification could fail to see the exported callback during compilation, causing a hard compilation failure.
- Remove the standalone `defimpl_ex` from `lib/panpipe/document.ex`.
- Handle Pandoc's top-level document map in the fallback implementation of `Panpipe.Pandoc.AST.Node.to_panpipe/1` inside `lib/panpipe/ast/nodes.ex` using a `case` clause.
This keeps the conversion logic in one place and avoids the ProtocolEx per-implementation callback verification ordering issue on Elixir 1.19.
Owner
|
Sorry for the late response. This slipped through over the holidays. Thanks. ❤️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
On Elixir 1.19,
mix compilefails with:ProtocolEx.MissingRequiredProtocolDefinitionto_panpipe/1for the Pandoc document matcher (the%{"blocks" => _, "pandoc-api-version" => _}map)Although
to_panpipe/1was present in thedefimpl_exinlib/panpipe/document.ex, ProtocolEx's compile-time verification could fail to see the exported callback during compilation, causing a hard compilation failure.defimpl_exfromlib/panpipe/document.ex.Panpipe.Pandoc.AST.Node.to_panpipe/1insidelib/panpipe/ast/nodes.exusing acaseclause.This keeps the conversion logic in one place and avoids the ProtocolEx per-implementation callback verification ordering issue on Elixir 1.19.