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.

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

Move all model class items from SERVICE files to shared/models.py #441

Open
JordoHeffernan opened this issue Feb 13, 2024 · 0 comments
Open
Assignees
Labels
Refactor Code that needs revision/refactoring

Comments

@JordoHeffernan
Copy link
Contributor

JordoHeffernan commented Feb 13, 2024

As a secureli contributor, I want shared models to be located in a central location

AC

  1. create a new file called models.py in the shared directory (create it if it does not yet exist)
  2. Move any model classes that exist at the top of files in the Services directory to the new file IF they are reused in multiple files (depending on order of operations, these files may now live in their respective modules)
    a. models that are only used in the file in which they're defined should be left as is.
  3. Move existing code that are in one off files in the models directory to shared/models.py
    a. delete models directory after this is done.
  4. Update any and all dependent imports (VS code should do this for you)

Notes

  • working branch to split off of: refactor/secureli-000-modular-refactor
@JordoHeffernan JordoHeffernan changed the title Move all model class items in SERVICE file to models/services.py Move all model class items in SERVICE files to models/services.py Feb 13, 2024
@JordoHeffernan JordoHeffernan changed the title Move all model class items in SERVICE files to models/services.py Move all model class items from SERVICE files to shared/models.py Feb 20, 2024
@blonienc blonienc added the Refactor Code that needs revision/refactoring label Feb 20, 2024
@kevin-orlando kevin-orlando self-assigned this Feb 22, 2024
kevin-orlando added a commit that referenced this issue Mar 7, 2024
secureli-440
secureli-441

<!-- Include general description here -->
closes #440 #441

Moves commonly used action and service models into shared models folder

## Changes
<!-- A detailed list of changes -->
* Move action models
* Move service models
* Remove unused action+service models

## Testing
<!--
Mention updated tests and any manual testing performed.
Are aspects not yet tested or not easily testable?
Feel free to include screenshots if appropriate.
 -->
*

## Clean Code Checklist
<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->
- [ ] Meets acceptance criteria for issue
- [ ] New logic is covered with automated tests
- [ ] Appropriate exception handling added
- [ ] Thoughtful logging included
- [ ] Documentation is updated
- [ ] Follow-up work is documented in TODOs
- [ ] TODOs have a ticket associated with them
- [ ] No commented-out code included


<!--
Github-flavored markdown reference:
https://docs.github.com/en/get-started/writing-on-github
-->

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Isaac Heist <IHeist@eagle.org>
Co-authored-by: Jordan Heffernan <44213782+JordoHeffernan@users.noreply.github.com>
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Kathleen Hogan <56691584+kathleen-hogan-slalom@users.noreply.github.com>
Co-authored-by: Kathleen Hogan <kathleenhogan@thessagroup.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Refactor Code that needs revision/refactoring
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants