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

Feature/1797 maned report page #2454

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

richard-jones
Copy link
Contributor

@richard-jones richard-jones commented Mar 4, 2025


Add reporting features for Managing Editors

Adds new search controls and a generalised csv exporter to produce journal and application reports

This PR...

  • has scripts to run
  • has migrations to run
  • adds new infrastructure
  • changes the CI pipeline
  • affects the public site
  • affects the editorial area
  • affects the publisher area
  • affects the monitoring

Developer Checklist

Developers should review and confirm each of these items before requesting review

  • Code meets acceptance criteria from issue
  • Unit tests are written and all pass
  • User Test Scripts (if required) are written and have been run through
  • Project's coding standards are met
    • No deprecated methods are used
    • No magic strings/numbers - all strings are in constants or messages files
    • ES queries are wrapped in a Query object rather than inlined in the code
    • Where possible our common library functions have been used (e.g. dates manipulated via dates)
    • Cleaned up commented out code, etc
    • Urls are constructed with url_for not hard-coded
  • Code documentation and related non-code documentation has all been updated
  • Migration has been created and tested
  • There is a recent merge from develop

Reviewer Checklist

Reviewers should review and confirm each of these items before approval
If there are multiple reviewers, this section should be duplicated for each reviewer

  • Code meets acceptance criteria from issue
  • Unit tests are written and all pass
  • User Test Scripts (if required) are written and have been run through
  • Project's coding standards are met
    • No deprecated methods are used
    • No magic strings/numbers - all strings are in constants or messages files
    • ES queries are wrapped in a Query object rather than inlined in the code
    • Where possible our common library functions have been used (e.g. dates manipulated via dates)
    • Cleaned up commented out code, etc
    • Urls are constructed with url_for not hard-coded
  • Code documentation and related non-code documentation has all been updated
  • Migation has been created and tested
  • There is a recent merge from develop

Testing

Functional Test scripts are under "Report Export" in testbook:

https://doaj.github.io/doaj-docs/feature/1797_maned_report_page/testbook/index.html#report_export/report_export_application
https://doaj.github.io/doaj-docs/feature/1797_maned_report_page/testbook/index.html#report_export/report_export_journal

Deployment

No deployment considerations

Copy link
Contributor

@RK206 RK206 left a comment

Choose a reason for hiding this comment

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

Looks good to me. Works as expected

{# }#}
{# });#}
{# });#}
{# });#}
Copy link
Contributor

Choose a reason for hiding this comment

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

Leftover commented-out code - can this be deleted?

<link rel="stylesheet" href="/static/vendor/edges/css/bs3.DateHistogramSelectorRenderer.css?v={{config.get('DOAJ_VERSION')}}">
<style>
#reporting_tools_divider hr {
Copy link
Contributor

Choose a reason for hiding this comment

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

I didn't see other facet dividers—could this be generalized? I suggest moving it to a SCSS file (_search.scss should work), and using a class (eg. facet-divider) instead of an ID.

}

.doaj-multidaterange-facet a {
Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't found this class in the code, can this be removed? If not then I suggest moving it to a scss file as well.

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