feat: migrate part of existing medical provider under specific healthcare providers (#1137) #1179

filipowm · 2024-04-28T22:11:33Z

This is initial PR to migrate existing Medical provider. The next one will be to migrate BloodType and Disease providers. Then I will move on adding new ones.

I marked Medical provider as deprecated since 2.4.0, yet I'm not sure whether it shouldn't be 2.3.0 or some other.

…viders

…e providers

what-the-diff · 2024-04-28T22:11:51Z

PR Summary

Introduction of 'HealthcareProviders' Interface
To enable better handling and organization, we introduced the HealthcareProviders interface and categorized it into specific classes namely CareProvider, Medication, MedicalProcedure, and Observation.
Deprecating 'Medical' Class
The older Medical class with its methods have been sunsetted. This move aims to promote the usage of the new, more specific healthcare-geared classes for a more precise data representation.
Inclusion of Healthcare-related Files
Entries pertinent to healthcare files have been inserted within the service/files directory via EnFile.
Addition of Healthcare-related YAML Files
We have added healthcare-related YAML files care_provider.yml, medical_procedure.yml, medication.yml, observation.yml in the resources/en directory to facilitate proper structuring of healthcare data.
Tests for New Classes
To ensure the robustness and efficacy of the newly implemented classes, test cases have been designed and added for CareProvider, Medication, and Observation classes.

erikpragt-connectid · 2024-04-29T02:07:37Z

src/main/java/net/datafaker/providers/healthcare/CareProvider.java

+import net.datafaker.providers.base.AbstractProvider;
+
+/**
+ * Generate random types of health care providers


All providers require a "since" property, so I think a since 2.3.0 would be good, even though we might release this as part of 2.2.3, not sure yet.

Got it. I added it in all new classes and interface.

erikpragt-connectid · 2024-04-29T02:08:37Z

src/main/java/net/datafaker/providers/base/Medical.java

    }

+    /**
+     * @deprecated since 2.4.0. For removal in 3.0.0 version. Use {@link net.datafaker.providers.healthcare.CareProvider#medicalProfession()} instead.


I probably wouldn't add the "for removal in". The 3.0.0 can be released next week, or it can be done 5 years from now, that's hard to say, we usually keep these things around 1-2 releases, and then remove them.

Ok, adjusted.

src/test/java/net/datafaker/providers/healthcare/MedicalProcedureTest.java

… classes

snuyanzin · 2024-04-29T17:01:25Z

src/main/java/net/datafaker/providers/healthcare/CareProvider.java

+
+    /**
+     * Generate random hospital name
+     * @return A hospital name


Why do we need javadoc which just repeats the actual method name here and in the rest?
IMHO: if javadoc can not bring more info than existing name then probably we don't need that javadoc

Yeah, I agree too. However existing codebase is inconsistent, cause in some places there are such dummy javadocs, in other not. So I preferred to add it cause I didn't know which one you prefer.

So I will remove those.

snuyanzin · 2024-04-29T17:06:44Z

src/main/java/net/datafaker/providers/base/Medical.java

+ * @deprecated since 2.3.0. This faker is deprecated due to migration
+ * to healthcare-specific aggregated into {@link net.datafaker.providers.healthcare.HealthcareFaker} fakers with similar methods.
 */
+@Deprecated(since = "2.3.0", forRemoval = true)


If we are going to remove it
what is the replacement for Medical#diseaseName and Medical#diagnosisCode?

I will add it in next PR, cause it touches Disease which I mentioned.

codecov-commenter · 2024-04-29T22:37:28Z

Codecov Report

Attention: Patch coverage is 71.42857% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 92.15%. Comparing base (b37c566) to head (bae4c1a).
Report is 84 commits behind head on main.

Files	Patch %	Lines
...atafaker/providers/healthcare/HealthcareFaker.java	20.00%	8 Missing ⚠️

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

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1179      +/-   ##
============================================
- Coverage     92.35%   92.15%   -0.20%     
- Complexity     2821     2861      +40     
============================================
  Files           292      299       +7     
  Lines          5609     5676      +67     
  Branches        599      601       +2     
============================================
+ Hits           5180     5231      +51     
- Misses          275      292      +17     
+ Partials        154      153       -1

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

bodiam · 2024-05-01T10:33:43Z

I think this PR is good to go right? Any objections if I merge it?

kingthorin

LGTM

bodiam · 2024-05-01T12:22:43Z

Thanks @filipowm , it's merged!

filipowm added 2 commits April 29, 2024 00:07

feat: migrate existing medical provider under specific healthcare pro…

4b2e4a6

…viders

test: add tests for migrated medical provider into specific healthcar…

2b586c0

…e providers

filipowm force-pushed the feat/initialize-healthcare-providers branch from 75c6919 to 31b8045 Compare April 28, 2024 22:26

chore: format module-info to use spaces instead of tabs

7a9ca5e

filipowm force-pushed the feat/initialize-healthcare-providers branch from 31b8045 to 7a9ca5e Compare April 28, 2024 22:29

erikpragt-connectid reviewed Apr 29, 2024

View reviewed changes

src/test/java/net/datafaker/providers/healthcare/MedicalProcedureTest.java Show resolved Hide resolved

filipowm added 2 commits April 29, 2024 10:10

chore: adjust deprecation notices to 2.3.0 and add since label to new…

8ca8477

… classes

chore: apply spotless to fix formatting issues

991714b

filipowm force-pushed the feat/initialize-healthcare-providers branch from f56e2a0 to 991714b Compare April 29, 2024 11:33

snuyanzin reviewed Apr 29, 2024

View reviewed changes

remove unnecessary javadocs

bae4c1a

kingthorin approved these changes May 1, 2024

View reviewed changes

bodiam merged commit cd4c93f into datafaker-net:main May 1, 2024

feat: migrate part of existing medical provider under specific healthcare providers (#1137) #1179

feat: migrate part of existing medical provider under specific healthcare providers (#1137) #1179

Uh oh!

Conversation

filipowm commented Apr 28, 2024

Uh oh!

what-the-diff bot commented Apr 28, 2024

PR Summary

Uh oh!

erikpragt-connectid Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

filipowm Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

erikpragt-connectid Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

filipowm Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

snuyanzin Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

kingthorin Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

filipowm Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

snuyanzin Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

filipowm Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

bodiam commented May 1, 2024

Uh oh!

kingthorin left a comment

Choose a reason for hiding this comment

Uh oh!

bodiam commented May 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

erikpragt-connectid Apr 29, 2024 •

edited

Loading

snuyanzin Apr 29, 2024 •

edited

Loading

codecov-commenter commented Apr 29, 2024 •

edited

Loading