Skip to content

Commit

Permalink
2.4.0 Documentation (#1363)
Browse files Browse the repository at this point in the history
* 2.4.0 Documentation
  • Loading branch information
bodiam authored Sep 30, 2024
1 parent 1543ee9 commit 8a86952
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 12 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,20 @@ In the pom.xml, add the following fragment to the `dependencies` section:
<dependency>
<groupId>net.datafaker</groupId>
<artifactId>datafaker</artifactId>
<version>2.3.1</version>
<version>2.4.0</version>
</dependency>
```

For Gradle users, add the following to your build.gradle file.

```groovy
dependencies {
implementation 'net.datafaker:datafaker:2.3.1'
implementation 'net.datafaker:datafaker:2.4.0'
}
```

You can also use the snapshot version (`2.3.2-SNAPSHOT`), which automatically gets published
You can also use the snapshot version (`2.4.1-SNAPSHOT`), which automatically gets published
after every push to the main branch of this repository. Binary repository URL for snapshots download is
`https://s01.oss.sonatype.org/content/repositories/snapshots/`.

Expand Down
9 changes: 7 additions & 2 deletions docs/documentation/providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,10 @@ Number of providers per Datafaker version
| 2.1.0 | 1 | 236 |
| 2.2.0 | 2 | 238 |
| 2.3.0 | 9 | 247 |
| 2.3.1 | 1 | 248 |
| 2.4.0 | 2 | 250 |

Datafaker comes with a total of 247 data providers:
Datafaker comes with a total of 250 data providers:

| Name | Description | Group | Since |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-------|
Expand Down Expand Up @@ -106,6 +108,7 @@ Datafaker comes with a total of 247 data providers:
| [Dog](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Dog.html) | | Base | 0.8.0 |
| [Domain](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Domain.html) | A domain name generator. | Base | 0.9.0 |
| [Doraemon](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/Doraemon.html) | | Entertainment | 1.7.0 |
| [Dota2](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/videogame/Dota2.html) | Dota 2 is a multiplayer online battle arena (MOBA) game developed and published by Valve Corporation. | Videogame | 2.3.1 |
| [Dragon Ball](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/DragonBall.html) | | Entertainment | 0.8.0 |
| [Driving License](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/DrivingLicense.html) | | Base | 1.5.0 |
| [Drone](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Drone.html) | An unmanned aerial vehicle (UAV), commonly known as a drone, is an aircraft without any human pilot, crew, or passengers on board. | Base | 1.7.0 |
Expand All @@ -127,6 +130,7 @@ Datafaker comes with a total of 247 data providers:
| [Final Fantasy XIV](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/videogame/FinalFantasyXIV.html) | Final Fantasy XIV is an MMORPG and features a persistent world in which players can interact with each other and the environment. | Videogame | 2.0.0 |
| [Final Space](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/FinalSpace.html) | Final Space is an adult animated space opera comedy drama television series. | Entertainment | 1.6.0 |
| [Finance](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Finance.html) | | Base | 0.8.0 |
| [Financial Terms](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/FinancialTerms.html) | Provides financial terms. | Base | 2.4.0 |
| [Food](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/food/Food.html) | | Food | 0.8.0 |
| [Football](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/sport/Football.html) | | Sport | 1.5.0 |
| [Formula1](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/sport/Formula1.html) | | Sport | 1.2.0 |
Expand Down Expand Up @@ -158,7 +162,7 @@ Datafaker comes with a total of 247 data providers:
| [How IMet Your Mother](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/HowIMetYourMother.html) | | Entertainment | 0.8.0 |
| [How To Train Your Dragon](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/HowToTrainYourDragon.html) | How to Train Your Dragon is a 2010 American computer-animated action fantasy film loosely based on the 2003 book of the same name by Cressida Cowell. | Entertainment | 1.8.0 |
| [Id Number](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/IdNumber.html) | | Base | 0.8.0 |
| [Image](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Image.html) | Generates base64 encoded PNG, GIF, JPG and SVG images. | Base | 2.3.0 |
| [Image](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Image.html) | Generates base64 encoded raster and vector images. | Base | 2.3.0 |
| [Industry Segments](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/IndustrySegments.html) | | Base | 1.5.0 |
| [Internet](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Internet.html) | | Base | 0.8.0 |
| [Job](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Job.html) | | Base | 0.8.0 |
Expand Down Expand Up @@ -277,6 +281,7 @@ Datafaker comes with a total of 247 data providers:
| [Warhammer Fantasy](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/videogame/WarhammerFantasy.html) | Warhammer Fantasy is a tabletop miniature wargame with a medieval fantasy theme. | Videogame | 1.8.0 |
| [Weather](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Weather.html) | A generator for weather data. | Base | 0.8.0 |
| [Witcher](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/Witcher.html) | | Entertainment | 0.8.0 |
| [Word](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Word.html) | | Base | 2.4.0 |
| [World Of Warcraft](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/videogame/WorldOfWarcraft.html) | World of Warcraft is a massively multiplayer online role-playing game released in 2004 by Blizzard Entertainment. | Videogame | 1.8.0 |
| [Yoda](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Yoda.html) | | Base | 0.8.0 |
| [Zelda](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/videogame/Zelda.html) | The Legend of Zelda is an action-adventure game franchise created by the Japanese game designers Shigeru Miyamoto and Takashi Tezuka. | Videogame | 0.8.0 |
Expand Down
2 changes: 1 addition & 1 deletion docs/releases/2.3.1.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Datafaker 2.3.1 (SNAPSHOT)
# Datafaker 2.3.1 (14 July 2024)

A few small bugs, mostly related to performance and JPMS, sneaked into our 2.3.0 release, and this release should address most of them.

Expand Down
48 changes: 48 additions & 0 deletions docs/releases/2.4.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Datafaker 2.4.0 (30 September 2024)

We've now reached the milestone of 250 different data providers! General words, financial terms and Dota2 are some of the new additions to our list.

Did you know it's even possible to generate fake images (JPG, PNG, SVG and more) using Datafaker?

## New Contributors

Thank you all for your contributions, we couldn't have done it without you. A special shout out to our new contributors:

* @panic08 made their first contribution in https://github.com/datafaker-net/datafaker/pull/1315
* @ly1012 made their first contribution in https://github.com/datafaker-net/datafaker/pull/1354
* @ksy-ke made their first contribution in https://github.com/datafaker-net/datafaker/pull/1357

## What's Changed
* 2.3.1 Release documentation by @bodiam in https://github.com/datafaker-net/datafaker/pull/1299
* Cleaned up some unused configuration, and added some initial support … by @bodiam in https://github.com/datafaker-net/datafaker/pull/1300
* Fixed JPG MIME. by @bodiam in https://github.com/datafaker-net/datafaker/pull/1302
* Added Codecov token by @bodiam in https://github.com/datafaker-net/datafaker/pull/1304
* Added more customization options for generating different types of im… by @bodiam in https://github.com/datafaker-net/datafaker/pull/1305
* Add article about BigQuery Sink in Datafaker Gen by @RVRhub in https://github.com/datafaker-net/datafaker/pull/1308
* Add Dota 2 VideoGameProvider by @panic08 in https://github.com/datafaker-net/datafaker/pull/1315
* Removed unused fields and method. by @bodiam in https://github.com/datafaker-net/datafaker/pull/1318
* Added support for adjectives, adverbs, conjunctions, interjections, n… by @bodiam in https://github.com/datafaker-net/datafaker/pull/1317
* Provides financial terms. by @bodiam in https://github.com/datafaker-net/datafaker/pull/1319
* Support stream generation with JavaObjectTransformer by @gatear in https://github.com/datafaker-net/datafaker/pull/1313
* generate ID Number together with birthday and gender by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1316
* Add support for Romanian ID numbers by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1323
* Refactoring: Relationship.any() by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1331
* convert class Interval to record by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1333
* simplify EnFile: don't collect a static list that is needed only once by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1332
* improve error handling and logging by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1311
* Refactor FakeValues by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1335
* extract duplicate methods "toJavaNames" to a single place by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1336
* fix IDEA warnings by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1337
* Add tier() and neutralItem() methods in Dota2 VideoGameProvider and update data by @panic08 in https://github.com/datafaker-net/datafaker/pull/1342
* #1343 search locales in all JAR files, not only in "datafaker*.jar" by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1349
* #1343 simplify code for returning all available locales by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1350
* Feature/greek philosophers el gr by @gvrettos in https://github.com/datafaker-net/datafaker/pull/1352
* fix: the last digit of ChineseIdNumber by @ly1012 in https://github.com/datafaker-net/datafaker/pull/1354
* Ukrainian id number generator by @ksy-ke in https://github.com/datafaker-net/datafaker/pull/1357
* translated MD cities to RU by @ksy-ke in https://github.com/datafaker-net/datafaker/pull/1359

**Full Changelog**: https://github.com/datafaker-net/datafaker/compare/v2.3.1...v2.4.0

## Providers added

See https://www.datafaker.net/documentation/providers/
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Datafaker 2.3.2 (SNAPSHOT)
# Datafaker 2.4.1 (SNAPSHOT)


## New Contributors
Expand Down
9 changes: 5 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ plugins:
# Customization
extra:
datafaker:
version: 2.3.1
snapshot: 2.3-2-SNAPSHOT
version: 2.4.0
snapshot: 2.4-1-SNAPSHOT

# Page tree
nav:
Expand All @@ -103,15 +103,16 @@ nav:
- Performance:
- Datafaker 1.4.0: documentation/performance140.md
- Datafaker 1.7.0: documentation/performance170.md
- Javadoc: 'https://s01.oss.sonatype.org/service/local/repositories/releases/archive/net/datafaker/datafaker/2.3.1/datafaker-2.3.1-javadoc.jar/!/index.html'
- Javadoc: 'https://s01.oss.sonatype.org/service/local/repositories/releases/archive/net/datafaker/datafaker/2.4.0/datafaker-2.4.0-javadoc.jar/!/index.html'
- Contributing: documentation/contributing.md
- First time contributor: documentation/first-time-contributor.md
- License: documentation/license.md
# - Changelog:
# - Changes: changelog/index.md
# - How to upgrade: upgrade.md
- Releases:
- 2.3.2-SNAPSHOT: releases/2.3.2-SNAPSHOT.md
- 2.4.1-SNAPSHOT: releases/2.4.1-SNAPSHOT.md
- 2.4.0: releases/2.4.0.md
- 2.3.1: releases/2.3.1.md
- 2.3.0: releases/2.3.0.md
- 2.2.2: releases/2.2.2.md
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/net/datafaker/providers/base/Word.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


/**
* Since 2.4.0
* @since 2.4.0
*/
public class Word extends AbstractProvider<BaseProviders> {

Expand Down

0 comments on commit 8a86952

Please sign in to comment.