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.

Sign up for GitHub

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

Add struct entry and struct author_handle #924

Closed
wants to merge 3 commits into from
Closed

Add struct entry and struct author_handle #924

wants to merge 3 commits into from

Commits on Aug 2, 2024

  1. Add JSON reference files for chkentry 

    This commit is to begin the process of updating chkentry(1) to validate
.entry.json and author_handle.json files. The reference files use Landon
as the winner/author as not only do I not want to be conceited :-) but
he's a judge and it works well as a reference. A few notes of interest
here.

The author_handle.reference.json file has the current email address of
the Judges (which changes on a yearly basis). It was not clear if I
should have null instead but this can be decided later.

Where needed the entry_ids and author_handles etc. match in the two
files.

More can be done with this as more is discussed. The other data files
that will be needed for this hacking of chkentry can be added later as
more of the issue is discussed but this is a nice starting point.
    @xexyl
    xexyl committed Aug 2, 2024
    Configuration menu
    Copy the full SHA
    6aba65d View commit details
    Browse the repository at this point in the history

  2. Change email in author_handle reference 

    Make it not a real email.
    @xexyl
    xexyl committed Aug 2, 2024
    Configuration menu
    Copy the full SHA
    0b69ed1 View commit details
    Browse the repository at this point in the history

  3. Add struct entry and struct author_handle 

    These WILL correspond to the .entry.json and the author_handle.json
files in the other repo for chkentry (LATER). SOME (not all) test_foo()
functions have been added and the ones that act on the entry_id and
directory and in hindsight they will have to work together, perhaps even
a new function that is given both strings (to verify that the YYYY in
YYYY_winner matches the YYYY/winner, for instance).

The chkentry has NOT been updated to use these functions as they (and
especially object2entry()) have not been completed and at least one is
missing too (object2author_handle or something like that). It is hoped
that starting this will help discussing what is needed.

Perhaps the most important part of these changes are the new structs but
some of the code that goes along with it has been started, even if in
need of modification, especially the object2foo functions. Going back it
might have been better if just the structs were added but as I started the
others I might as well get them in too.

In other words some of this MIGHT HAVE BEEN PREMATURE but as discussion
briefly started I have done these (it might have been better to just
add the structs but as I wanted to get a bit in I did more, in other
words).

XXX comments have been added accordingly.

New defined macros: for versions of the json files (can be found in the
files in the other repo) and for min/max of directory length (based on
the max handle length - + 5 for the YYYY plus the '/' and '_').
    @xexyl
    xexyl committed Aug 2, 2024
    Configuration menu
    Copy the full SHA
    72fc45f View commit details
    Browse the repository at this point in the history