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

Add Digitale Keilschrift Bibliothek to Ext Nos #593

Merged
merged 2 commits into from
Jan 5, 2025

Conversation

ejimsan
Copy link
Member

@ejimsan ejimsan commented Jan 5, 2025

Summary by Sourcery

New Features:

  • Added a new field for the Digitale Keilschrift Bibliothek external number.

Copy link
Contributor

sourcery-ai bot commented Jan 5, 2025

Reviewer's Guide by Sourcery

This pull request adds support for the Digitale Keilschrift Bibliothek external number to the fragment external numbers model, schema, and tests.

ER diagram showing the updated Fragment External Numbers structure

erDiagram
    FRAGMENT ||--o| EXTERNAL_NUMBERS : has
    EXTERNAL_NUMBERS {
        string digitale_keilschrift_bibliothek
        string philadelphia_number
        string achemenet_number
        string nabucco_number
        string yale_peabody_number
        string[] oracc_numbers
        string[] seal_numbers
    }
Loading

Class diagram showing the addition of Digitale Keilschrift Bibliothek to ExternalNumbers

classDiagram
    class ExternalNumbers {
        +str digitale_keilschrift_bibliothek
        +str philadelphia_number
        +str achemenet_number
        +str nabucco_number
        +str yale_peabody_number
        +Sequence[str] oracc_numbers
        +Sequence[str] seal_numbers
        +get_digitale_keilschrift_bibliothek() str
    }
    note for ExternalNumbers "Added new field and getter for Digitale Keilschrift Bibliothek"
Loading

File-Level Changes

Change Details Files
Added digitale_keilschrift_bibliothek field to the ExternalNumbers class.
  • Added a new property digitale_keilschrift_bibliothek to the ExternalNumbers class to store the Digitale Keilschrift Bibliothek number.
  • Added a getter method for the digitale_keilschrift_bibliothek property.
ebl/fragmentarium/domain/fragment_external_numbers.py
Added digitale_keilschrift_bibliothek field to the ExternalNumbersSchema.
  • Added a digitale_keilschrift_bibliothek field to the ExternalNumbersSchema to handle serialization and deserialization of the Digitale Keilschrift Bibliothek number.
  • Set the data_key to digitaleKeilschriftBibliothek to match the API naming convention.
ebl/fragmentarium/application/fragment_fields_schemas.py
Added digitale_keilschrift_bibliothek field to the FragmentFactory.
  • Added a digitale_keilschrift_bibliothek field to the FragmentFactory to generate test data for the Digitale Keilschrift Bibliothek number.
  • Used a sequence to generate unique values for the field in tests.
ebl/tests/factories/fragment.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ejimsan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider maintaining alphabetical ordering of fields by moving 'digitale_keilschrift_bibliothek' before 'nabucco_number' in the ExternalNumbers class definition
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codeclimate bot commented Jan 5, 2025

Code Climate has analyzed commit 55ff492 and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category Count
Complexity 1

The test coverage on the diff in this pull request is 80.0% (75% is the threshold).

This pull request will bring the total coverage in the repository to 91.4% (0.0% change).

View more on Code Climate.

@ejimsan ejimsan merged commit 7393468 into master Jan 5, 2025
12 checks passed
@ejimsan ejimsan deleted the digitale-keilschrift-bibliothek branch January 5, 2025 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant