From a05d3cb4de051bfc11f1233f361f82c35bd28c97 Mon Sep 17 00:00:00 2001 From: Tyler Thrailkill Date: Wed, 20 Mar 2024 16:15:28 -0600 Subject: [PATCH] Add missing functions to property-arbs docs (#3945) --- documentation/docs/proptest/extra_arbs.md | 25 ++++++++++++++--------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/documentation/docs/proptest/extra_arbs.md b/documentation/docs/proptest/extra_arbs.md index 0883cf4d1c8..10803c4d22a 100644 --- a/documentation/docs/proptest/extra_arbs.md +++ b/documentation/docs/proptest/extra_arbs.md @@ -15,32 +15,36 @@ To use, add `io.kotest.extensions:kotest-property-arbs:version` to your build. [](https://search.maven.org/search?q=g:io.kotest.extensions) -| Arb | Details | +| Arb | Details | |----------------------------|---------------------------------------------------------------------------------------------------------------------| | Arb.firstName() | Produces random english or hispanic first names | | Arb.lastName() | Produces random last names based on US census data | | Arb.name() | Produces random first and last names | -| | | +| Arb.logins() | Produces random logins with timestamp, username, location, ip address, and random result, e.g. success | +| Arb.usernames() | Produces random usernames | +| | | | Arb.stockExchanges() | Produces random stock exchanges, eg `New York Stock Exchange / NYSE / US` | -| | | +| | | | Arb.domain() | Produces random domain names, eg `www.wibble.co.uk` | | Arb.country() | Produces random country objects, eg `Botswana / BW / Africa` | | Arb.continent() | Produces random continents from the list of seven | | Arb.zipcode() | Random zipcodes from 01000 to 99999, without validating they are exant | -| | | +| | | | Arb.harryPotterCharacter() | Produces random first and last names from the Harry Potter series | -| | | +| | | | Arb.color() | Produces random named colours, eg, midnight blue | | Arb.brand() | Produces random brand names, eg Betty Crocker | | Arb.products() | Produces random google product categories, eg `Furniture > Office Furniture > Desks` | -| | | -| Arb.vineyards() | Produces random vineyard names, eg `Château Montus Prestige` | -| Arb.wineRegions() | Produces a random wine region, eg `Chassagne-Montrachet` | +| | | +| Arb.vineyards() | Produces random vineyard names, eg `Château Montus Prestige` | +| Arb.wineRegions() | Produces a random wine region, eg `Chassagne-Montrachet` | | Arb.wines() | Combines several wine details producers to return full wine objects | | Arb.wineReviews() | Combines wine producer and adds in random review scores and usernames | +| Arb.wineVarieties() | Random wine variety, e.g. 'Sauvignon Blanc' | +| Arb.wineries() | Random wine producer, e.g. 'Santa Cruz Mountain Vineyard' | | Arb.iceCreamFlavors() | Random ice cream flavors such as `Pistachio` or `Grape Escape` | | Arb.iceCreams() | Random ice cream servings with one or more flavors, cone type and size | -| | | +| | | | Arb.tubeStation() | Produces randomly selected London underground tube stations | | Arb.tubeJourney() | Generates random journeys from a randomly selected start and end underground station | | Arb.airport() | Random real world airport with IATA code | @@ -51,7 +55,6 @@ To use, add `io.kotest.extensions:kotest-property-arbs:version` to your build. | Arb.cluedoWeapons() | Clue/Cluedo weapons, eg `Lead piping` | | Arb.cluedoLocations() | Clue/Cluedo locations, eg `Ballroom` | | Arb.cluedoAccusation() | Clue/Cluedo accusations, eg, `Mrs White / Billiards Room / Rope` | -| Arb.monopolyProperty() | Random (US version) monopoly property with rent, price and color | | Arb.chessPiece() | Chess piece with points | | Arb.chessSquare() | Chesss square with file A-H and rank 1-8 | | Arb.chessMove() | Chess move from square to square with captured piece if any. No validation is performed to check the move is legal. | @@ -59,3 +62,5 @@ To use, add `io.kotest.extensions:kotest-property-arbs:version` to your build. | Arb.transactions() | Transactions with a card number, card type, amount and transaction type | | | | | Arb.cars() | Random car manufacturers | +| | | +| Arb.googleTaxonomy() | Structured taxonomy of random things |