Skip to content
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

Fix for breaking change to gophermap parsing for the upcoming spacecookie release #1

Merged
merged 3 commits into from
Jan 22, 2021
Merged

Fix for breaking change to gophermap parsing for the upcoming spacecookie release #1

merged 3 commits into from
Jan 22, 2021

Conversation

sternenseemann
Copy link
Contributor

The old parsing behavior was unfortunately not completely in line with the behavior of Bucktooth and pygopherd. Since their format is much more convenient for the user, I have opted to break parsing for some situations in the upcoming release in order to have more correct parsing.

This PR contains a few general fixes related to building and installing and a commit to reflect the changes in spacecookie. Feel free to wait with merging until the release is out if you're not comfortable depending on a git version of spacecookie.

Below is the relevant commit message:

For spacecookie >= 0.3.0.0 prefixing with 'i' is no longer needed

The changes are described in detail in the changelog:
https://github.com/sternenseemann/spacecookie/blob/master/CHANGELOG.md#changes-to-networkgopherutilgophermap

In a nutshell we now require a gophermap line which links to another
gopher resource to contain at least one tab character. This makes them
easily distinguishable from info lines and resolves the issue where an
info line would be parsed incorrectly if it started with a valid gopher
file type character.

Unfortunately this also breaks the previous workaround for the issue
which was used in burrow:

  iMy text bla bla

This now can be written as

  My text bla bla

or

  iMy text bla bla\t

to achieve the same result.

This commit adjusts burrow's code for the first variant and updates a
few documentation links.

The changes are described in detail in the changelog:
https://github.com/sternenseemann/spacecookie/blob/master/CHANGELOG.md#changes-to-networkgopherutilgophermap

In a nutshell we now require a gophermap line which links to another
gopher resource to contain at least one tab character. This makes them
easily distinguishable from info lines and resolves the issue where an
info line would be parsed incorrectly if it started with a valid gopher
file type character.

Unfortunately this also breaks the previous workaround for the issue
which was used in burrow:

  iMy text bla bla

This now can be written as

  My text bla bla

or

  iMy text bla bla\t

to achieve the same result.

This commit adjusts burrow's code for the first variant and updates a
few documentation links.
@hyperrealgopher
Copy link
Collaborator

Thank you so much for this quality commit! Sorry I took so long to get around to looking it over and merging it! Great work--very much appreciated!

@hyperrealgopher hyperrealgopher merged commit 35be2fc into someodd:master Jan 22, 2021
@sternenseemann sternenseemann deleted the spacecookie-gophermap-0.3.0.0 branch January 22, 2021 16:03
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.

2 participants