jschalk / jaar

Cross-cultural communication engine built on customizable economic systems. Produces personalized agendas, calendars, finance reports for users.
0 stars 1 forks source link

175 enable documentation process #311

Closed jschalk closed 2 months ago

jschalk commented 2 months ago

Summary by Sourcery

Refactor the codebase to replace 'doerunit' and 'doerheir' with 'teamunit' and 'teamheir', introducing new classes for team management and updating all related test cases to reflect these changes.

Enhancements:

Tests:

sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request implements a significant refactoring, replacing the concept of "doer" with "team" throughout the codebase. The changes primarily involve renaming variables, functions, and classes, updating import statements, and adjusting related logic to reflect this new terminology. The core functionality remains largely the same, but the naming convention has been updated to better reflect the collaborative nature of the system.

File-Level Changes

Change Details Files
Renamed 'doer' related concepts to 'team' throughout the codebase
  • Renamed DoerUnit to TeamUnit
  • Renamed DoerHeir to TeamHeir
  • Updated function names (e.g., set_grouphold to set_teamlink)
  • Modified variable names to reflect the new 'team' terminology
  • Updated import statements to use new module names
  • Adjusted class attributes and method names
src/bud/test_bud_settle/test_tree_traverse_reason_team.py
src/gift/test_atom/test_atom_config.py
src/bud/idea.py
src/gift/legible.py
src/bud/test_bud/test_bud_json.py
src/gift/change.py
src/bud/test__idea/test_idea_active_status.py
src/gift/test_change/test_change_after_bud.py
src/bud/bud.py
src/bud/test_bud_settle/test_z_agenda.py
src/listen/test_listen/test_agendas_duty_job.py
src/listen/test_listen/test_agendas_voice_action.py
src/listen/listen_graphic.py
src/listen/test_special_func/test_add_pledge.py
src/bud/examples/example_buds.py
src/listen/examples/example_listen.py
Updated configuration and model files to reflect the 'team' terminology
  • Modified atom configuration to use 'teamlink' instead of 'grouphold'
  • Updated database models to use 'Teamlink' instead of 'GroupHold'
  • Adjusted stone format configurations
src/gift/atom_config.json
src/gift/atom_config.py
src/normal_db/test/test_normal_models.py
src/normal_db/normal_models.py
src/stone/stone_config.py
src/stone/stone_formats/stone_format_00024_bud_idea_teamlink_v0_0_0.json
Implemented new TeamUnit and TeamHeir classes
  • Created TeamUnit class with methods for managing teamlinks
  • Implemented TeamHeir class with logic for inheritance and owner identification
  • Added unit tests for new TeamUnit and TeamHeir classes
src/bud/reason_team.py
src/bud/test_/test_reason_team.py
Added new AtomRow class for handling atom data
  • Implemented AtomRow class with methods for managing atom categories and data
  • Added unit tests for AtomRow class
src/gift/atom.py
src/gift/test_atom/test_atom_row.py
Updated test configurations and documentation
  • Added rebuild_bool option to pytest configuration
  • Updated README with new conflict resolution approach
conftest.py
README.md

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.