feat: add title field and metadata handling for ZIM file creation

[nicolapace]

Fixes #677

I added a Title field in the Zim creation page. This field is automatically filled with the Selection Title reduced to 30 characters. In this way users can change it if they want. This field is required and is of max 30 chars. (I also added a char counter for both the title and the description).

I also added backend validation for the size of zim metadata (title (30) and description (80) as per https://wiki.openzim.org/wiki/Metadata).

I added new unit test for the new "title field" and the validation, for both the backend and the frontend. I also fixed some unit tests and functions to support the new zimtitle field.

Here is the Zim creation page with the new field:

[kelson42]

@nicolapace Thank you for your PR! But the unity for counting is not char, but lexem. There is a javascript/typescript implementation of such a counter in openzim/mwoffliner.

[audiodude]

@nicolapace Thank you for your PR! But the unity for counting is not char, but lexem. There is a javascript/typescript implementation of such a counter in openzim/mwoffliner.

#677 (comment)

What is a lexem and how does it compare to a grapheme? I feel like I'm going to have to read a Chomsky book to implement this PR. 🙃

[audiodude]

This looks really good, great work!

I think the handling of the error conditions on the backend needs to be improved however.

[kelson42]

@audiodude I meant grapheme, sorry. See link given in the issue comment.

[nicolapace]

@audiodude @kelson42 @benoit74 Thanks for the feedback and the suggestions!

I pushed a new commit that addresses the discussed issues, in particular:

• I am now using split-by-grapheme npm package and regex python module to check for num. of graphemes in both frontend and backend as suggested by @kelson42 and @benoit74
• as suggested by @audiodude I changed the validate_zim_metadata() function to Raise exceptions directly and I created new exceptions
• I also added validation for the long_description field as described in https://wiki.openzim.org/wiki/Metadata#Graphemes
• I disable the submit button if inputs are not valid
• I changed unit tests to support the new changes and added some new unit tests (for the long description validation and the handling of graphemes)

(I pushed a new commit instead of amending the last one for better clarity. We can squash them later if you prefer.)

[audiodude]

Looking good, just a few small comments.

[audiodude]

Great work!

[codecov]

Codecov Report

Attention: Patch coverage is 97.14286% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.63%. Comparing base (9a19180) to head (4d30fbd).
Report is 5 commits behind head on main.

Files with missing lines	Patch %	Lines
wp1/zimfarm.py	95.45%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #855      +/-   ##
==========================================
+ Coverage   92.58%   92.63%   +0.05%     
==========================================
  Files          66       66              
  Lines        3546     3573      +27     
==========================================
+ Hits         3283     3310      +27     
  Misses        263      263              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.