Added pronouns provider by eliasnogueira · Pull Request #1106 · datafaker-net/datafaker

eliasnogueira · 2024-03-02T19:58:47Z

Description

This PR adds a new provider: Pronouns.

Questions

Question 1

I don't know the release process, so I added this new provider as a 2.1.0 version.
Should we change it to 2.1.1, if it gets merged, or wait until the next release?

Question 3

Should we add it as part of the Name provider?

what-the-diff · 2024-03-02T19:59:03Z

PR Summary

Inclusion of a New Provider Class "Pronouns"
A new provider class known as "Pronouns" has been added. This class is particularly designed with the capability to generate gender-neutral pronouns which can be used across the system.
Integration of "Pronouns" Class into the "BaseProviders" Class
The newly developed "Pronouns" class has been smoothly integrated with the "BaseProviders" class. This enables the generation of pronouns as part of the data that's being created on the system.
Creation of a New File "pronouns.yml"
This PR also includes the creation of a new file named "pronouns.yml". This file holds a list of gender-neutral pronouns predominantly in English.
Addition of a Test Class "PronounsTest"
To verify the functionality of the newly added "Pronouns" provider, a test class labeled "PronounsTest" has been included. This will ensure the seamless operation of the new feature.

kingthorin · 2024-03-02T20:08:30Z

+        - "Tem"
+        - "Em"
+      possessive:
+        - "Her"


kingthorin · 2024-03-02T20:08:48Z

+      possessive:
+        - "Her"
+        - "His"
+        - "Their"


snuyanzin · 2024-03-02T20:59:46Z

it seems it should be rebased since there are conflicts

eliasnogueira · 2024-03-02T21:12:24Z

@snuyanzin should we start a discussion about the artifact release?

From my view, this PR will get merged but not be available until you guys release a new artifact.

Should the version increase automatically and be released when the PR is merged?
Should we wait for a formal release?

I'm curious about the release process, and also happy to help.

kingthorin · 2024-03-02T21:22:55Z

On merge it'll be snapshot yes and available that way. Otherwise yes it'll have to wait for a release.

kingthorin · 2024-03-02T21:28:45Z

This file shouldn't be changed. 2.1.0 was already released

Seems this change was maybe done on a outdated branch?

That's right. I just pushed the merge conflict fix

kingthorin · 2024-03-02T21:30:12Z

 | [Pokemon](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/Pokemon.html)                                             |                                                                                                                                                                                                             | Entertainment | 0.8.0 |
 | [Princess Bride](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/PrincessBride.html)                                |                                                                                                                                                                                                             | Entertainment | 0.8.0 |
 | [Programming Language](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/ProgrammingLanguage.html)                             |                                                                                                                                                                                                             | Base          | 0.8.0 |
+| [Pronouns](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Pronouns.html)                                                    | Gender pronouns are the set of pronouns that an individual uses to reflect that person's own gender identity                                                                                                | Base          | 2.1.0 |


This shouldn't be modified this is part of the release tasks (IIRC)

Correct, but it doesn't hurt.

That's one of the points about release. The code, doc, and version will be there without the artifact generated and publicly available.

I can follow any recommendation.

kingthorin · 2024-03-02T21:31:17Z

+
+/**
+ * This class generates gender neutral pronouns
+ * @since 2.1.0


I believe the next release is slated to be 2.2.0

Waiting for the resolution of this comment #1106 (comment)

kingthorin · 2024-03-02T21:32:40Z

You could add it to the 'full list' in the readme.

bodiam · 2024-03-03T00:37:38Z

+      subjective:
+        - "She"
+        - "He"
+        - "They"


I'm wondering if these things should be uppercased?

bodiam · 2024-03-03T00:38:15Z

+ * This class generates gender neutral pronouns
+ * @since 2.1.0
+ */
+public class Pronouns extends AbstractProvider<BaseProviders> {


Any reason why a new class is used, and not add it to Gender? Gender seems like a reasonable place for this, or not?

That's a good question.
I'm trying to follow the same pattern as the other " self-contained " providers. They have not implemented the fluent interface approach as I could call the class itself or another class.

Example:

faker.gender().pronouns().subjective();

The example above would be implemented in this way:

The Pronouns class still exists

The Gender class would have a pronouns() method returning its new instance

public class Gender extends AbstractProvider<BaseProviders> { // ignoring already existing code public Pronouns pronouns() { return new Pronouns(faker); } }

The Pronouns class as a default toString() in the case the consumer would call only its method

faker.gender().pronouns()

I'm open to any implementation ideas :-)

@bodiam any feedback about this last comment?

same could achieved with

public Pronouns pronouns() { return faker.getPronouns(); }

however no need to make GC happy by creation a new object each time there is a call to pronouns

@eliasnogueira it's a bit comment, not sure what to say :-) I'm not a fan of the fluent interface approach that much, so if you want to keep the Pronouns as a separate class, that's fine.

codecov-commenter · 2024-03-03T09:02:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.32%. Comparing base (b37c566) to head (abc231a).
Report is 19 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1106      +/-   ##
============================================
- Coverage     92.35%   92.32%   -0.03%     
- Complexity     2821     2828       +7     
============================================
  Files           292      293       +1     
  Lines          5609     5618       +9     
  Branches        599      599              
============================================
+ Hits           5180     5187       +7     
  Misses          275      275              
- Partials        154      156       +2

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

bodiam · 2024-03-11T21:43:30Z

 | 2.1.0   | 4                       | 237                       |

-Datafaker comes with a total of 233 data providers:
+Datafaker comes with a total of 237 data providers:


this document is auto generated, no need to update.

bodiam · 2024-03-12T10:13:18Z

Anyone objecting if I merge this?

kingthorin · 2024-03-12T11:40:15Z

Go for it

bodiam · 2024-03-12T11:42:53Z

Thanks @eliasnogueira et al for the work on this!

eliasnogueira · 2024-03-12T18:58:29Z

Thank you guys!

eliasnogueira added 2 commits March 2, 2024 20:24

feat: added the pronouns provider

0462fb1

feat: added the pronouns provider

d2221ca

kingthorin reviewed Mar 2, 2024

View reviewed changes

chore: fix typo

9c84481

kingthorin reviewed Mar 2, 2024

View reviewed changes

bodiam reviewed Mar 3, 2024

View reviewed changes

eliasnogueira added 3 commits March 3, 2024 09:39

chore: fix merge conflicts

8fc24f5

fix: updated the correct number of data providers

c8772a1

fix: fix formatting

abc231a

eliasnogueira requested a review from bodiam March 3, 2024 09:01

bodiam reviewed Mar 11, 2024

View reviewed changes

bodiam merged commit 28ae0a4 into datafaker-net:main Mar 12, 2024

eliasnogueira deleted the added-pronouns-provider branch March 12, 2024 18:58

Conversation

eliasnogueira commented Mar 2, 2024

Description

Questions

Question 1

Question 3

Uh oh!

what-the-diff Bot commented Mar 2, 2024

PR Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

snuyanzin commented Mar 2, 2024

Uh oh!

eliasnogueira commented Mar 2, 2024

Uh oh!

kingthorin commented Mar 2, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kingthorin commented Mar 2, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Mar 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bodiam commented Mar 12, 2024

Uh oh!

kingthorin commented Mar 12, 2024

Uh oh!

bodiam commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eliasnogueira commented Mar 12, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov-commenter commented Mar 3, 2024 •

edited

Loading

bodiam commented Mar 12, 2024 •

edited

Loading