Smufolib

What's new

- Fix issue with unicode hex values not converting properly in `converters.toUniName` and `converters.toDecimal`.
- Fix issue with parameter handling in `error.generateTypeError`.
- Fixed normalization issues of `EngravingDefaults` attributes and `Request` paths.
- Update tests.

What's new

- Fixed issue with tuple handling in `pointUtils.getPoints`.
- Fixed issue with `stdUtils.validateClassAttribute` inadvertantly raising an exception on missing attributes.
- Improved tests.

Breaking Changes ⚠️

Old font and glyph `lib` keys have been replaced with new keys to comply with the [reverse domain naming scheme](https://unifiedfontobject.org/versions/ufo3/conventions/#reverse-domain-naming-schemes) recommended by the [UFO](http://unifiedfontobject.org/) specification.

Migration Instructions

To migrate your data, run the provided migration script on a single `.ufo` file or a folder of multiple files in your terminal:
bash
update-keys <path-to-file-or-folder>

New Features and Improvements

General

- Added a property setter to `Range.smufl`.
- Changed parameter name `dependency` to `dependencyInfo`.
- Added digit check to secure parsing of integer tuples in `smufolib.cfg`
- Added a `round` parameter to `Smufl.toUnits`.

Error Handling

- Updated the `spaces` attribute in `Smufl` and `EngravingDefaults` to raise an exception if the `font` or `font.info.unitsPerEm` attributes are `None` when the value is being set.
- Updated `EngravingDefaults` to disallow setting attributes if `font` is None.
- Remove automatic items and type checks in `error.validateType` to simplify and streamline the validation logic.
- Removed argument duplication check in `cli.commonParser` (to rely on `argparse.ArgumentError`)
- Added `"missingDependencyError"` to `error.ERROR_TEMPLATES` to handle cases where a dependency is missing.

Code Quality

- Added a suite of tests encompassing the entire library and implemented coverage tracking
- Implemented linting and formatting with [ruff](https://github.com/astral-sh/ruff).

Bug Fixes

- `Smufl` and `EngravingDefaults` An exception is no longer raised when calling `__eq__` and `__hash__` on the `Smufl` or `EngravingDefaults` objects.
- Updated `Smufl.codepoint` to interact properly with `BaseGlyph.unicode`.
- Fixed an issue where Smufl.classes would return None instead of an empty tuple (`()`) when `Smufl.font` is not `None`.
- Fixed an issue with `engravingDefaults.update` not updating selected attributes correctly.
- Fixed and issue with lacking spaces between compound error messages.

New Features
- added setters for:
- `smufl.engravingDefaults`
- `smufl.codepoint` (value is implicitly normalized by `converters.toDecimal` to avoid duplication)

Bug Fixes
- fixed minor bugs in:
- `normalizers.normalizeEngravingDefaultsAttr`
- `importID.py`
- Fixed bugs with colors and coordinate value conversion in `importAnchors.py`

Documentation
- Added examples to:
- `converters.py`
- `pointUtils.py`
- `stdUtils.py`
- `error.py`
- Added documentation of external module imports to `normalizers.py`
- Documented read-only aspect of properties in`smufl.py`
- Added module docstrings to utility modules
- Replaceed list table of error templates with csv table directive in `utils.rst`
- Corrected broken reference links in:
- `utils.rst`
- `scripts.rst`
- `normalizers.py`
- `cleanFont.py`
- `getting_started.rst`
- Corrected typo in tagline of `pyproject.toml`

This version simply corrects the discrepant version numbering in pyprojec.toml, bringing GitHub and PYPI releases in line.

**Changes:**

- all modules:
- updated docstrings with new exceptions, language and cross
references; changed variable names from explicit
inline :code: to default role
- updated linting directives to short form
- updated type hints and corrected mypy errors
- changed various parameter names to be more descriptive
- tests:
- added test for all functions in:
- test_stdUtils.py (except verbosePrint and doNothing)
- test_normalizers.py
- removed malfunctioning tests in test_pointUtils.py
- corrected change error assertion type in test_toNumber in
test_converters.py
- scripts:
- refactored code with new helpers and normalizers
- implemented stdUtils.verbosePrint() and revised messages for
consistency.
- revised progress bar implementation for clarity and consistency
- changed addHelp setting to reflect new default
- new commonParser `description` based on program summary line
in docstring of program function
- calculateEngravingDefaults.py
- added ability to override 'textFontFamily'
- added new table of default settings to
calculateEngravingdefaluts() docstring
- readme.rst:
- updated to reflect changes to getting_started.rst
- smufolib.cfg:
- added color values to [color.marks] and [color.anchors]
- changed comment prefix from ';' to ''
- dev/generate_options_table.py
- added docstring
- moved logic to main function
- added script excecution guard
- corrected relative path to table file
- converters.py:
- created toIntIfWhole() general purpose equivalent
to calculateEngravingDefaults._normalizeMeasurement() function
- cli.py
- changed commonParser `addHelp` default to True
- added createHelpFormatter() function to combine argparse help
formatters
- deleted formatter from help_formatter in commonParser
- implemented the option to add boolean arguments as on/off
flags without default values in commonParser()
- added customHelpers functionality to commonParser()
- refactored commonParser() code with new nested helper functions
- error.py:
- new module for streamlined exception handling
- updated and added new exceptions and normalizers to all
modules and scripts and documented extensively
- moved URLWarning from request.py to error.py
- engravingDefaults.py
- added override of BaseObject function raiseNotImplementedError
to EngravingDefaults
- replaced _normalizeMeasurement() with converters.toIntIfWhole()
- pointUtils.py
- revised to return iterator instead of tuple and take any
font-related object
- fixed concatenation error in getCompositePoints function
- stdUtils.py
- added doNothing function
- added verbosePrint function
- added getSummary() function to get summary lines from
docstrings and implemented in all scripts
- smufl.py:
- added override of BaseObject function raiseNotImplementedError
to Smufl
- fixed errors in 'suffix' property
- renamed 'componentGlyphs' poperty to 'componentNames'
- added new 'componentGlyphs' property to get ligature
components as Glyph objects
- docs:
- changed smufolib.cfg examples in configuration.rst to
litteralinclude directives
- added exclusion of raiseNotImplementedError to objects.rst
- updatd language in request.rst
- updated language and examples in getting_started.rst
- updated conf.py settings

**Full Changelog**: https://github.com/knutnergaard/smufolib/compare/v0.1.5...v0.2.0