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

Create interface for Services and replace static methods with instance methods closes #110 #318

Merged
merged 1 commit into from
Aug 30, 2023
Merged

Create interface for Services and replace static methods with instance methods closes #110 #318

merged 1 commit into from
Aug 30, 2023

Conversation

samirromdhani
Copy link
Contributor

@samirromdhani samirromdhani commented Aug 21, 2023 •
edited
Loading

Fix #110

This pull tries to rearrange the services in a more logical way and replace static methods with instance methods.

[creation] Interfaces implemented by existing services.
[update] UtilityClass is moved to the util package.

BREAKING CHANGE: 💥 in sct-commons:

  • The services which provide static methods are moved from scl to commons package.
    Now those services implements interfaces, no static methods.
    Expect for PrivateService which is an UtilityClass is renamed to PrivateUtils and moved from scl to util package.

@samirromdhani samirromdhani linked an issue Aug 21, 2023 that may be closed by this pull request
Create interface for Services and replace static methods with instance methods #110
Closed
@samirromdhani samirromdhani force-pushed the refactor/110-create-interface-for-services-and-replace-static-methods-with-instance-methods branch 6 times, most recently from 2934c31 to 7ae1629 Compare August 23, 2023 10:47
@samirromdhani samirromdhani marked this pull request as ready for review August 23, 2023 15:18
@samirromdhani samirromdhani changed the title [WIP] Create interface for Services and replace static methods with instance methods closes #110 Create interface for Services and replace static methods with instance methods closes #110 Aug 23, 2023
gleizesDor
gleizesDor reviewed Aug 24, 2023
View reviewed changes
sct-app/src/main/java/org/lfenergy/compas/sct/app/SclAutomationService.java Outdated Show resolved Hide resolved
sct-commons/src/main/java/org/lfenergy/compas/sct/commons/service/ISubstationService.java Outdated Show resolved Hide resolved
sct-commons/src/main/java/org/lfenergy/compas/sct/commons/service/IExtRefService.java Outdated Show resolved Hide resolved
sct-commons/src/main/java/org/lfenergy/compas/sct/commons/service/IHmiService.java Outdated Show resolved Hide resolved
sct-commons/src/main/java/org/lfenergy/compas/sct/commons/service/ISclService.java Outdated Show resolved Hide resolved
sct-commons/src/main/java/org/lfenergy/compas/sct/commons/service/ISclService.java Outdated Show resolved Hide resolved
sct-commons/src/main/java/org/lfenergy/compas/sct/commons/service/impl/ExtRefService.java Outdated Show resolved Hide resolved
sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/PrivateLinkedToSTDs.java Outdated Show resolved Hide resolved
sct-app/src/test/java/org.lfenergy.compas.sct.app/SclAutomationServiceIntegrationTest.java Show resolved Hide resolved
@samirromdhani samirromdhani force-pushed the refactor/110-create-interface-for-services-and-replace-static-methods-with-instance-methods branch 7 times, most recently from 916e96a to 343295f Compare August 28, 2023 12:03
@samirromdhani samirromdhani self-assigned this Aug 28, 2023
@samirromdhani samirromdhani force-pushed the refactor/110-create-interface-for-services-and-replace-static-methods-with-instance-methods branch from 9fe0f18 to cef23b3 Compare August 29, 2023 08:08
@samirromdhani samirromdhani force-pushed the refactor/110-create-interface-for-services-and-replace-static-methods-with-instance-methods branch from 4cb0715 to ef9d944 Compare August 30, 2023 09:20
@samirromdhani
refactor(#110): Create interface for Services and replace static meth…
c13fce6 
…ods with instance methods

closes #110

BREAKING CHANGE: 💥 in sct-commons:
  The services which provide static methods are moved from scl to commons package.
  Now  those services implements interfaces, no static methods.
  Expect for PrivateService which is an UtilityClass is renamed to PrivateUtils and moved from scl to util package.

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>

refactor(#110): give PrivateService the new name PrivateUtils and change the package from scl to util.

Changing the name of PrivateService to PrivateUtils and move it from scl to util package , closes #110

refactor(#110): update SclAutomationService

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>

refactor(#110): check review part1

use @requiredargsconstructor, instead of @NoArgsConstructor.
use Camel case for PrivateLinkedToStds

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>

refactor(#110): check review part2 [use mockito properly]

Remove unused test package.
Use latest version of mockito.
Fix related to version 5.4.0

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>

refactor(#110): review part3 [naming] remove prefix 'I' and add suffix 'Editor'

The interfaces are moved from scl to api package.

add package doc

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>

refactor(#110): review part4 [seperate SclService features ]

SclEditor (interface) spec are reduced by adding ReadOnly and Write One

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>

refactor(#110): sonar review

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>

docs(#110): update demo project and quickstart page

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>
@samirromdhani samirromdhani force-pushed the refactor/110-create-interface-for-services-and-replace-static-methods-with-instance-methods branch from ef9d944 to c13fce6 Compare August 30, 2023 09:22
@samirromdhani samirromdhani merged commit 4c89e11 into develop Aug 30, 2023
7 checks passed
@samirromdhani samirromdhani deleted the refactor/110-create-interface-for-services-and-replace-static-methods-with-instance-methods branch August 30, 2023 09:25
@samirromdhani samirromdhani mentioned this pull request Aug 30, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gleizesDor gleizesDor gleizesDor approved these changes

@massifben massifben massifben approved these changes

@AliouDIAITE AliouDIAITE Awaiting requested review from AliouDIAITE

Assignees

@samirromdhani samirromdhani

Labels
javadoc
Projects
CoMPAS Pull Request Overview Board
Status: Done
CoMPAS SCT Board
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create interface for Services and replace static methods with instance methods
3 participants
@samirromdhani @massifben @gleizesDor