fix!: ensure HTML ID attributes are unique

[BenGale93]

Summary

Previously, if you had multiple GT HTML tables inside a single document, that had column names in common, you would have repeated HTML ID attributes. This PR makes these ID attributes unique by prepending the table ID, if it exists.

Related GitHub Issues and PRs

• Ref: Use of ID attributes #594

Checklist

• I understand and agree to the Code of Conduct.
• I have followed the Style Guide for Python Code as best as possible for the submitted code.
• I have added pytest unit tests for any new functionality.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.85%. Comparing base (2256e36) to head (09a6fb7).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #607      +/-   ##
==========================================
+ Coverage   90.84%   90.85%   +0.01%     
==========================================
  Files          46       46              
  Lines        5417     5423       +6     
==========================================
+ Hits         4921     4927       +6     
  Misses        496      496              

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

[rich-iannone]

This looks great, thanks! However, it looks like the formatting used for the new ID values shouldn't have a space. According to a W3Schools page:

The id name must contain at least one character, cannot start with a number, and must not contain whitespaces (spaces, tabs, etc.).

Could you revise to use a hyphen instead?

[BenGale93]

Just updated it. I also applied the same rule to the column label and updated the test to have a column with a space in the name to demonstrate that.

[rich-iannone]

Just noting for the future (nothing needs to be done here) but the stub doesn't really have an ID value (I suppose the column that created the stub labels could be it?) and it often won't have a label unless tab_stubhead() was called.

The issue with all this is that for the stubhead <th> element we get id="", which is invalid HTML according to https://validator.w3.org/nu/.

[rich-iannone]

This is so close, but I have a few suggested changes.

[rich-iannone]

@BenGale93 Sorry to reverse course here a bit, but I did notice that if labels are used to compose element IDs, there's a good chance one might get duplicate ID values (since labels can be user-modified but column names are immutable and usually always unique). Could you address these changes? I tried out all of the suggested changes locally and tests pass and the element IDs look reasonable to me.

[BenGale93]

@rich-iannone makes total sense. Will work on this in a few hours time. Thanks for the review!

[rich-iannone]

LGTM!