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

Set support in same members #1583

Merged
merged 9 commits into from
Feb 12, 2024
Merged

Conversation

koddsson
Copy link
Member

@koddsson koddsson commented Jan 26, 2024

Fixes #1468

Add Set support to members/sameMembers. While doing that I want to introduce a iterable assertion that I think could be useful.

@43081j
Copy link
Contributor

43081j commented Jan 27, 2024

should we try support all iterables? may be possible by looking for Symbol.iterator? 🤔

just wondering if we want it to support something which isn't a set or array but is iterable

@keithamus
Copy link
Member

I think supporting iterators generally is a good idea. Otherwise though this is a good step forward.

@koddsson
Copy link
Member Author

should we try support all iterables? may be possible by looking for Symbol.iterator? 🤔

just wondering if we want it to support something which isn't a set or array but is iterable

I think supporting iterators generally is a good idea. Otherwise though this is a good step forward.

Yes! I wanted to change this:

https://github.com/chaijs/chai/pull/1583/files#diff-e3056660026d4431cbb909136ea4290116f5f8be089125a67d6e9ba8f364402dR3145-R3151

to new Assertion(obj, flagMsg, ssfi, true).to.be.an('iterable'); but ran into issues so I'm coming back to it.

@koddsson
Copy link
Member Author

Something that I found is that string has Symbol.iterator so there might be some edge-cases.

lib/chai/core/assertions.js Outdated Show resolved Hide resolved
lib/chai/core/assertions.js Outdated Show resolved Hide resolved
lib/chai/core/assertions.js Outdated Show resolved Hide resolved
@@ -3136,26 +3142,29 @@ function isSubsetOf(_subset, _superset, cmp, contains, ordered) {
* @api public
*/

Assertion.addMethod('members', function (subset, msg) {
Assertion.addMethod('iterable', function(msg) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 this is good

@koddsson
Copy link
Member Author

I was gonna point this PR to #1592 but I guess I can't because it's on a different remote. In any case, I split out the iterable assertion into it's own PR which I think we should merge first and then land this fix.

@koddsson
Copy link
Member Author

I think this is good but might benefit from more tests.

@koddsson koddsson marked this pull request as ready for review February 11, 2024 11:05
@koddsson koddsson requested a review from a team as a code owner February 11, 2024 11:05
@koddsson koddsson merged commit 1ba37b5 into chaijs:main Feb 12, 2024
5 checks passed
@koddsson koddsson deleted the set-support-in-same-members branch February 12, 2024 12:32
solaris007 added a commit to adobe/spacecat-shared that referenced this pull request Aug 27, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change | Age | Adoption | Passing |
Confidence |
|---|---|---|---|---|---|---|---|
| [actions/setup-java](https://github.com/actions/setup-java) | action
| major | `v3` -> `v4` |
[![age](https://developer.mend.io/api/mc/badges/age/github-tags/actions%2fsetup-java/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/github-tags/actions%2fsetup-java/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/github-tags/actions%2fsetup-java/v3/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/github-tags/actions%2fsetup-java/v3/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
| [chai](http://chaijs.com) ([source](https://github.com/chaijs/chai))
| devDependencies | major | [`4.5.0` ->
`5.1.1`](https://renovatebot.com/diffs/npm/chai/4.5.0/5.1.1) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/chai/4.5.0/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/chai/4.5.0/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>actions/setup-java (actions/setup-java)</summary>

### [`v4`](https://github.com/actions/setup-java/compare/v3...v4)

[Compare
Source](https://github.com/actions/setup-java/compare/v3...v4)

</details>

<details>
<summary>chaijs/chai (chai)</summary>

### [`v5.1.1`](https://github.com/chaijs/chai/releases/tag/v5.1.1)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.1.0...v5.1.1)

#### What's Changed

- Set up ESLint for JSDoc comments by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1605
- build(deps-dev): bump ip from 1.1.8 to 1.1.9 by
[@&#8203;dependabot](https://github.com/dependabot) in
[chaijs/chai#1608
- Correct Mocha import instructions by
[@&#8203;MattiSG](https://github.com/MattiSG) in
[chaijs/chai#1611
- fix: support some virtual contexts in `toThrow` by
[@&#8203;43081j](https://github.com/43081j) in
[chaijs/chai#1609

#### New Contributors

- [@&#8203;MattiSG](https://github.com/MattiSG) made their first
contribution in
[chaijs/chai#1611

**Full Changelog**:
chaijs/chai@v5.1.0...v5.1.1

### [`v5.1.0`](https://github.com/chaijs/chai/releases/tag/v5.1.0)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.3...v5.1.0)

#### What's Changed

- Remove useless guards and add parentheses to constuctors by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1593
- Cleanup jsdoc comments by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1596
- Convert comments in "legal comments" format to jsdoc or normal
comments by [@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1598
- Implement `iterable` assertion by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1592
- Assert interface fix by
[@&#8203;developer-bandi](https://github.com/developer-bandi) in
[chaijs/chai#1601
- Set support in same members by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1583
- Fix publish script by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1602

#### New Contributors

- [@&#8203;developer-bandi](https://github.com/developer-bandi) made
their first contribution in
[chaijs/chai#1601

**Full Changelog**:
chaijs/chai@v5.0.3...v5.1.0

### [`v5.0.3`](https://github.com/chaijs/chai/releases/tag/v5.0.3)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.2...v5.0.3)

Fix bad v5.0.2 publish.

**Full Changelog**:
chaijs/chai@v5.0.2...v5.0.3

### [`v5.0.2`](https://github.com/chaijs/chai/releases/tag/v5.0.2)

[Compare
Source](https://github.com/chaijs/chai/compare/v5.0.0...v5.0.2)

#### What's Changed

- build(deps): bump nanoid and mocha by
[@&#8203;dependabot](https://github.com/dependabot) in
[chaijs/chai#1558
- remove `bump-cli` by [@&#8203;koddsson](https://github.com/koddsson)
in
[chaijs/chai#1559
- Update developer dependencies by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1560
- fix: removes `??` for node compat (5.x) by
[@&#8203;43081j](https://github.com/43081j) in
[chaijs/chai#1576
- Update `loupe` to latest version by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1579
- Re-enable some webkit tests by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1580
- Remove a bunch of if statements in test/should.js by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1581
- Remove a bunch of unused files by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1582
- Fix 1564 by [@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1566

**Full Changelog**:
chaijs/chai@v5.0.1...v5.0.2

### [`v5.0.0`](https://github.com/chaijs/chai/releases/tag/v5.0.0)

[Compare
Source](https://github.com/chaijs/chai/compare/v4.5.0...v5.0.0)

#### BREAKING CHANGES

- Chai now only supports EcmaScript Modules (ESM). This means your tests
will need to either have `import {...} from 'chai'` or `import('chai')`.
`require('chai')` will cause failures in nodejs. If you're using ESM and
seeing failures, it may be due to a bundler or transpiler which is
incorrectly converting import statements into require calls.
-   Dropped support for Internet Explorer.
-   Dropped support for NodeJS < 18.
- Minimum supported browsers are now Firefox 100, Safari 14.1, Chrome
100, Edge 100. Support for browsers prior to these versions is "best
effort" (bug reports on older browsers will be assessed individually and
may be marked as wontfix).

#### What's Changed

- feat: use chaijs/loupe for inspection by
[@&#8203;pcorpet](https://github.com/pcorpet) in
[chaijs/chai#1401
- docs: fix URL in README by [@&#8203;Izzur](https://github.com/Izzur)
in
[chaijs/chai#1413
- Remove `get-func-name` dependency by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1416
- Convert Makefile script to npm scripts by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1424
- Clean up README badges by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1422
- fix: package.json - deprecation warning on exports field by
[@&#8203;stevenjoezhang](https://github.com/stevenjoezhang) in
[chaijs/chai#1400
- fix: deep-eql bump package to support symbols by
[@&#8203;snewcomer](https://github.com/snewcomer) in
[chaijs/chai#1458
- ES module conversion PoC by
[@&#8203;43081j](https://github.com/43081j) in
[chaijs/chai#1498
- chore: drop commonjs support by
[@&#8203;43081j](https://github.com/43081j) in
[chaijs/chai#1503
- Update pathval by [@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1527
- Update check-error by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1528
- update `deep-eql` to latest version by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1542
- Inline `type-detect` as a simple function by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1544
- Update loupe by [@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1545
- Typo 'Test an object' not 'Test and object' by
[@&#8203;mavaddat](https://github.com/mavaddat) in
[chaijs/chai#1460
- Update `assertion-error` to it's latest major version! by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1543
- Replacing Karma with Web Test Runner by
[@&#8203;koddsson](https://github.com/koddsson) in
[chaijs/chai#1546

#### New Contributors

- [@&#8203;Izzur](https://github.com/Izzur) made their first
contribution in
[chaijs/chai#1413
- [@&#8203;stevenjoezhang](https://github.com/stevenjoezhang) made
their first contribution in
[chaijs/chai#1400
- [@&#8203;43081j](https://github.com/43081j) made their first
contribution in
[chaijs/chai#1498

**Full Changelog**:
chaijs/chai@4.3.1...v5.0.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 2pm on Monday" in timezone
Europe/Zurich, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View the
[repository job
log](https://developer.mend.io/github/adobe/spacecat-shared).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4yNi4xIiwidXBkYXRlZEluVmVyIjoiMzguMjYuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Dominique Jäggi <[email protected]>
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.

assert.sameMembers should work for sets
3 participants