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

Text annotation #7081

Closed
wants to merge 9 commits into from
Closed

Conversation

umututku03
Copy link
Contributor

@umututku03 umututku03 commented May 17, 2024

Proposed Changes

This pull request adds new validations to the TextAnnotation model and updates the corresponding tests to ensure data integrity. Specifically, it ensures that:

  • The line_start and line_end attributes must be greater than or equal to 1.
  • The column_start and column_end attributes must be greater than or equal to 0.

Motivation

These changes are motivated by the need to prevent invalid values for line and column numbers in the TextAnnotation model, ensuring that the data stored is always within a valid range. This enhancement improves the robustness and reliability of the application.

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality) X
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests) X
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

@umututku03 umututku03 marked this pull request as draft May 17, 2024 02:51
@umututku03 umututku03 marked this pull request as ready for review May 24, 2024 15:28
@coveralls
Copy link
Collaborator

coveralls commented May 24, 2024

Pull Request Test Coverage Report for Build 9259697777

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 18 of 18 (100.0%) changed or added relevant lines in 2 files are covered.
  • 27 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.05%) to 91.426%

Files with Coverage Reduction New Missed Lines %
app/assets/javascripts/Components/submission_file_manager.jsx 27 51.57%
Totals Coverage Status
Change from base Build 9089556497: 0.05%
Covered Lines: 40014
Relevant Lines: 43093

💛 - Coveralls

@umututku03 umututku03 requested a review from david-yz-liu May 24, 2024 15:54
Copy link
Collaborator

@david-yz-liu david-yz-liu left a comment

Choose a reason for hiding this comment

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

@umututku03 good job! In addition to the inline comments I left, please make sure to add yourself to the list of contributors.

Changelog.md Outdated Show resolved Hide resolved
spec/models/text_annotation_spec.rb Outdated Show resolved Hide resolved
@umututku03 umututku03 requested a review from david-yz-liu May 27, 2024 20:43
@@ -6,6 +6,7 @@

### ✨ New features and improvements

- Added validations to the `TextAnnotation` model to ensure `line_start` and `line_end` are >= 1, and `column_start` and `column_end` are >= 0. (#7081)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Add entries to the bottom of the list (within each subsection)

@umututku03 umututku03 closed this Jun 11, 2024
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.

3 participants