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.

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

Inconsistent naming of structured data artifacts #67

Closed
skuzzle opened this issue Feb 9, 2023 · 0 comments
Closed

Inconsistent naming of structured data artifacts #67

skuzzle opened this issue Feb 9, 2023 · 0 comments
Milestone

Comments

@skuzzle
Copy link
Owner

skuzzle commented Feb 9, 2023

Currently we provide these structured data artifacts:

  • XML: snapshot-tests-jaxb
  • XML: snapshot-tests-jaxb-jakarta
  • JSON: snapshot-tests-jackson
  • HTML: snapshot-tests-html

The naming is obviously inconsistent as it sometime states the technology (jaxb, jackson) and sometimes states the structure (html).

Both information might be valuable to some consumer though so it is not easy to come up with a consistent naming that includes all the information.

I tend to prefer the following naming scheme:

  • XML: snapshot-tests-xml-legacy (jaxb with javax. namespaces + xmlunit)
  • XML: snapshot-tests-xml (jaxb with jakarta. namespaces + xmlunit)
  • JSON: snapshot-tests-json (jackson + jsonassert)
  • HTML: snapshot-tests-html (jsoup + xmlunit)

For backward compatibility we can leave the existing artifacts and make them transitively pull in the new module. This also allows to print a deprecation warning in projects that are still referencing the old modules.

When we're at it: we should also think about separating the public API from the implementation. We can split off the contents of the de.skuzzle.test.snapshot and de.skuzzle.test.snapshot.data.text package into a new -api module. This can be done only after #17 has been finished

@skuzzle skuzzle added this to the 1.10.0 milestone Feb 27, 2023
@skuzzle skuzzle mentioned this issue Feb 28, 2023
@skuzzle skuzzle closed this as completed Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant