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.

Sign up for GitHub

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

Jump to bottom

Implement iterable assertion #1592

Merged
merged 4 commits into from
Feb 11, 2024
Merged

Implement iterable assertion #1592

merged 4 commits into from
Feb 11, 2024
+132 −2

Conversation

koddsson
Copy link
Member

Pulled this out of #1583 so that these PRs make more logical sense.

This PR implemensts a iterable/isIterable assertion that checks a given object for Symbol.iterator but notably excludes string which does have Symbol.iterator but we don't consider to be "iterable".

@koddsson koddsson marked this pull request as ready for review January 28, 2024 16:06
@koddsson koddsson requested a review from a team as a code owner January 28, 2024 16:06
@koddsson koddsson mentioned this pull request Jan 28, 2024
Merged
keithamus
keithamus reviewed Jan 28, 2024
View reviewed changes
Copy link
Member

@keithamus keithamus left a comment

Choose a reason for hiding this comment

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

I’m curious why explicitly disallow string for this check?

@koddsson
Copy link
Member Author

I’m curious why explicitly disallow string for this check?

You know, I don't remember why I put that in there. I have a vague memory of the sameMembers test needing this but looking at this in isolations makes me think that's probably a oversight.

43081j
43081j previously approved these changes Jan 28, 2024
View reviewed changes
keithamus
keithamus requested changes Jan 28, 2024
View reviewed changes
Copy link
Member

@keithamus keithamus left a comment

Choose a reason for hiding this comment

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

Is this bit meant to be part of this PR?

@koddsson
Copy link
Member Author

Is this bit meant to be part of this PR?

Not sure if GitHub is glitching but I can't see what this is referring to. I assume it's the isSubsetOf changes in which case, it shouldn't have been included and I've removed those changes. Thanks :)

keithamus
keithamus previously approved these changes Jan 29, 2024
View reviewed changes
Copy link
Member

@keithamus keithamus left a comment

Choose a reason for hiding this comment

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

I think this is good but I am still a little uneasy about overloading .an() too much.

@43081j
Copy link
Contributor

43081j commented Jan 29, 2024

I think this is good but I am still a little uneasy about overloading .an() too much.

curious, do you prefer .is.iterable then? just so we're all on the same page for other changes in future

im guessing you're unsure of leaning heavily on an for many things, since over time chai would mostly be that one chain

@keithamus
Copy link
Member

I'd prefer each assertion (especially core assertions) to map to something that a user can reproduce with a single expression. It makes it far easier for us to document, and for users to internalise. If they know .an() is just Chai's shorthand for [Symbol.toStringTag] = then that's an easier way to think about it than having a mental lookup table to some alternative logic.

@43081j
Copy link
Contributor

43081j commented Jan 29, 2024

makes sense to me 👍

thanks for the explanation, i do agree

@koddsson
Copy link
Member Author

I think this is good but I am still a little uneasy about overloading .an() too much.

I'm happy to change this. I'd rather nip this in the bud now than trying to untangle it later.

keithamus
keithamus approved these changes Feb 11, 2024
View reviewed changes
Copy link
Member

@keithamus keithamus left a comment

Choose a reason for hiding this comment

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

Great stuff

@koddsson koddsson merged commit d504573 into chaijs:main Feb 11, 2024
5 checks passed
@koddsson koddsson deleted the introduce-iterable-assertion branch February 11, 2024 10:40
This was referenced May 26, 2024
Open
Closed
@lholmquist lholmquist mentioned this pull request May 30, 2024
Closed
@taeb3 taeb3 mentioned this pull request May 31, 2024
Open
@anand-py anand-py mentioned this pull request Jun 2, 2024
Open
This was referenced Jul 22, 2024
Open
Open
@OKEAMAH OKEAMAH mentioned this pull request Jul 23, 2024
Merged
This was referenced Jul 23, 2024
Open
Open
Open
Open
Open
Open
@mechanicalpete mechanicalpete mentioned this pull request Jul 24, 2024
Merged
This was referenced Jul 25, 2024
Open
Open
Open
@dlminvestments dlminvestments mentioned this pull request Jul 25, 2024
Open
This was referenced Jul 26, 2024
Open
Open
@LLotme LLotme mentioned this pull request Jul 27, 2024
Merged
This was referenced Jul 27, 2024
Open
Open
Open
Open
Open
This was referenced Aug 1, 2024
Open
Open
This was referenced Aug 16, 2024
Open
Open
Open
Merged
@H1B0B0 H1B0B0 mentioned this pull request Aug 23, 2024
Merged
solaris007 added a commit to adobe/spacecat-shared that referenced this pull request Aug 27, 2024
@renovate @solaris007
chore(deps): update external major (major) (#346)
7a48f16 
[![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://togithub.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://togithub.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://togithub.com/actions/setup-java/compare/v3...v4)

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

</details>

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

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

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

#### What's Changed

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

#### New Contributors

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

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

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

[Compare
Source](https://togithub.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://togithub.com/koddsson) in
[chaijs/chai#1593
- Cleanup jsdoc comments by
[@&#8203;koddsson](https://togithub.com/koddsson) in
[chaijs/chai#1596
- Convert comments in "legal comments" format to jsdoc or normal
comments by [@&#8203;koddsson](https://togithub.com/koddsson) in
[chaijs/chai#1598
- Implement `iterable` assertion by
[@&#8203;koddsson](https://togithub.com/koddsson) in
[chaijs/chai#1592
- Assert interface fix by
[@&#8203;developer-bandi](https://togithub.com/developer-bandi) in
[chaijs/chai#1601
- Set support in same members by
[@&#8203;koddsson](https://togithub.com/koddsson) in
[chaijs/chai#1583
- Fix publish script by
[@&#8203;koddsson](https://togithub.com/koddsson) in
[chaijs/chai#1602

#### New Contributors

- [@&#8203;developer-bandi](https://togithub.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://togithub.com/chaijs/chai/releases/tag/v5.0.3)

[Compare
Source](https://togithub.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://togithub.com/chaijs/chai/releases/tag/v5.0.2)

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

#### What's Changed

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

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

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

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

#### New Contributors

- [@&#8203;Izzur](https://togithub.com/Izzur) made their first
contribution in
[chaijs/chai#1413
- [@&#8203;stevenjoezhang](https://togithub.com/stevenjoezhang) made
their first contribution in
[chaijs/chai#1400
- [@&#8203;43081j](https://togithub.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://togithub.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 <1872195+solaris007@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@keithamus keithamus keithamus approved these changes

@43081j 43081j Awaiting requested review from 43081j

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@koddsson @43081j @keithamus