Subject tag changes

[jimchamp]

Supplants #9843

General Changes

• Two general tag types defined:
  • Collection tags
    • Tag type: collection
  • Subject tags
    • Tag types: subject, person, place, time
• Subject tags now have a body property
  • This will be rendered as the main content on a tag page

Tag model

• Tag.find() updated to return multiple values

  • Now returns a list of matching tag keys
  • tag_type no longer a required parameter

• Tag.create() updated to take a dict representation of a Tag

  • Tag dict validations are expected to occur before create is called
  • Tag.create() now returns the newly created Tag object (instead of a key)
    • Prevents redundant calls to Infogami

Tag page templates

General Tag view - /templates/type/tag/view.html

• Updated means of deriving a related subject_key
• Renders Tag.body to the page (if the tag is a subject tag)
• Sanitizes and formats the description and body

Type-specific edit page and form controls - /templates/type/tag/{tag_type}

• Two new directories:
  • /templates/type/tag/subject
  • /templates/type/tag/collection
• Each directory has:
  • edit.html - Form used for editing an existing tag or creating a new tag
  • edit_form_inputs - Contains form inputs appropriate for the tag type

Generic "Add Tag" form

• Now populated with subject and collection edit_form_inputs templates
• When selected subject type changes, unrelated form elements are hidden

Subject page

• Disambiguation section added
  • Included links to the Tag views of subject tags with a similar name
• Tagging flow:
  • "Edit" button copy changed to "Tag"
  • "Tag" button is only present on subject page if no subject tag of the same name and type was found when the page was rendered
  • General flow:
    • Patron clicks "Tag" on a subject page
    • Patron fills out and submits the "Add Tag" form
    • Patron is redirected to the newly created Tag page
      • Link to associated subject page included on this page

addtag.py

• unflatten calls on patron input have been removed
  • unflatten is used specifically for book edit form data
• Added type-specific validation functions
• Added handler for type-specific edits

Missing from this PR

• Subject tag body is not automatically generated
  • Attempted to add the same components that are used by the subject page, but HTML becomes malformed after sanitize and format calls
• Types in URLs (/tags/OL123T/{tag_type}/{tag_label})
  • Requires refactor of ReadableUrlProcessor

Technical

Testing

Screenshot

Stakeholders

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 0% with 30 lines in your changes missing coverage. Please review.

Project coverage is 17.33%. Comparing base (347bff9) to head (0f30126).
Report is 136 commits behind head on master.

Files with missing lines	Patch %	Lines
openlibrary/plugins/openlibrary/js/tag-form.js	0.00%	22 Missing and 4 partials ⚠️
openlibrary/plugins/openlibrary/js/index.js	0.00%	3 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #10138      +/-   ##
==========================================
+ Coverage   17.12%   17.33%   +0.20%     
==========================================
  Files          89       90       +1     
  Lines        4752     4822      +70     
  Branches      831      855      +24     
==========================================
+ Hits          814      836      +22     
- Misses       3428     3461      +33     
- Partials      510      525      +15     

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