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

✨ Customize versions directly from uuid #5188

Merged
merged 5 commits into from
Aug 6, 2024
Merged

✨ Customize versions directly from uuid #5188

merged 5 commits into from
Aug 6, 2024

Conversation

dubzzz
Copy link
Owner

@dubzzz dubzzz commented Aug 6, 2024

Description

This PR adds the ability to customize the versions of the UUIDs produced by uuid without having to rely on its counterpart version uuidV. It paves the way for the future drop of uuidV.

Follow-up of #5172

Related to issues: #5104 and #5103

ChecklistDon't delete this checklist and make sure you do the following before opening the PR

  • The name of my PR follows gitmoji specification
  • My PR references one of several related issues (if any)
    • New features or breaking changes must come with an associated Issue or Discussion
    • My PR does not add any new dependency without an associated Issue or Discussion
  • My PR includes bumps details, please run yarn bump and flag the impacts properly
  • My PR adds relevant tests and they would have failed without my PR (when applicable)

Advanced

  • Category: ✨ Introduce new features
  • Impacts: Nothing, except an APi offering more options. Generated values are unchanged and shrinker behaves the same

Copy link

codesandbox-ci bot commented Aug 6, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 039b09a:

Sandbox Source
@fast-check/examples Configuration

@dubzzz dubzzz enabled auto-merge (squash) August 6, 2024 22:46
Copy link
Contributor

github-actions bot commented Aug 6, 2024

👋 A preview of the new documentation is available at: http://66b2a871ff3fde0ee66c505d--dubzzz-fast-check.netlify.app

Copy link
Contributor

github-actions bot commented Aug 6, 2024

👋 A preview of the new documentation is available at: http://66b2ab5323256e14c8b49717--dubzzz-fast-check.netlify.app

dubzzz added a commit that referenced this pull request Aug 6, 2024
**Description**

Deprecating `uuidV` in favor of `uuid`. No need to have both now that
`uuid` also offers ways to customize the generated versions (see #5188).

<!-- Please provide a short description and potentially linked issues
justifying the need for this PR -->

<!-- * Your PR is fixing a bug or regression? Check for existing issues
related to this bug and link them -->
<!-- * Your PR is adding a new feature? Make sure there is a related
issue or discussion attached to it -->

<!-- You can provide any additional context to help into understanding
what's this PR is attempting to solve: reproduction of a bug, code
snippets... -->

**Checklist** — _Don't delete this checklist and make sure you do the
following before opening the PR_

- [x] The name of my PR follows [gitmoji](https://gitmoji.dev/)
specification
- [x] My PR references one of several related issues (if any)
- [x] New features or breaking changes must come with an associated
Issue or Discussion
- [x] My PR does not add any new dependency without an associated Issue
or Discussion
- [x] My PR includes bumps details, please run `yarn bump` and flag the
impacts properly
- [x] My PR adds relevant tests and they would have failed without my PR
(when applicable)

<!-- More about contributing at
https://github.com/dubzzz/fast-check/blob/main/CONTRIBUTING.md -->

**Advanced**

<!-- How to fill the advanced section is detailed below! -->

- [x] Category: Deprecate code
- [x] Impacts: Will be dropped on next major

<!-- [Category] Please use one of the categories below, it will help us
into better understanding the urgency of the PR -->
<!-- * ✨ Introduce new features -->
<!-- * 📝 Add or update documentation -->
<!-- * ✅ Add or update tests -->
<!-- * 🐛 Fix a bug -->
<!-- * 🏷️ Add or update types -->
<!-- * ⚡️ Improve performance -->
<!-- * _Other(s):_ ... -->

<!-- [Impacts] Please provide a comma separated list of the potential
impacts that might be introduced by this change -->
<!-- * Generated values: Can your change impact any of the existing
generators in terms of generated values, if so which ones? when? -->
<!-- * Shrink values: Can your change impact any of the existing
generators in terms of shrink values, if so which ones? when? -->
<!-- * Performance: Can it require some typings changes on user side?
Please give more details -->
<!-- * Typings: Is there a potential performance impact? In which cases?
-->
Copy link

codecov bot commented Aug 6, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 10 lines in your changes missing coverage. Please review.

Project coverage is 94.73%. Comparing base (868f9b1) to head (039b09a).
Report is 3 commits behind head on main.

Files Patch % Lines
packages/fast-check/src/arbitrary/uuid.ts 75.75% 8 Missing ⚠️
...trary/_internals/mappers/VersionsApplierForUuid.ts 92.59% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5188      +/-   ##
==========================================
- Coverage   94.80%   94.73%   -0.08%     
==========================================
  Files         230      231       +1     
  Lines        9262     9320      +58     
  Branches     2713     2730      +17     
==========================================
+ Hits         8781     8829      +48     
- Misses        481      491      +10     
Flag Coverage Δ
unit-tests 94.73% <83.33%> (-0.08%) ⬇️
unit-tests-18.x-Linux 94.73% <83.33%> (-0.08%) ⬇️
unit-tests-20.x-Linux 94.73% <83.33%> (-0.08%) ⬇️
unit-tests-22.x-Linux ?
unit-tests-latest-Linux 94.73% <83.33%> (-0.08%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@dubzzz dubzzz merged commit bad17d1 into main Aug 6, 2024
56 of 58 checks passed
@dubzzz dubzzz deleted the uuid-extended branch August 6, 2024 23:06
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

Successfully merging this pull request may close these issues.

1 participant