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.

Sign up for GitHub

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

Jump to bottom

fix(#1701): Events page displays year for events scheduled to start or end at a future year #2500

Merged
merged 15 commits into from
Sep 26, 2024
Merged

fix(#1701): Events page displays year for events scheduled to start or end at a future year #2500

merged 15 commits into from
Sep 26, 2024

Conversation

alvindera97
Copy link
Contributor

@alvindera97 alvindera97 commented Aug 8, 2024 •
edited
Loading

What

Closes

@alvindera97
Add Methods To Check If Event Starts And Ends This Year
1502c10
@alvindera97
Set Up Templates For Querying Start And End Years
4198812 
Passed variables to the time_tag template [time_tag.html] that checks if an event was scheduled to start or end with the current year.
@alvindera97
Insert New Test Data And Update test_views.py
ff1ad8b 
More events are created to test particular scenarios of events especially events set to start or end at a future year.
@alvindera97
Time Tag Now Shows Year For Events With Details Not Within The Curren…
e3125d9 
…t Year

The time tag now displays the year when an event will occur. This is only for events that have been scheduled to start or end in at a future year. The accompanying functional tests have also been included.
@alvindera97
Move All Test Data To Functional Test
178742b 
All test data concerning the provision of data to serve the functional tests have been moved to the functional test.
As it improves readability.
All other test data at test_views.py was reset
to accommodate for the reduction in number of test data instances.
@alvindera97
Functional Test For Displaying Year Of Event For Future Events Now Im…
e0fdf7c 
…plemented With Unit Tests
@alvindera97
Remove Functional Test For Displaying Year Of Future Event
115af08 
Since the current CI at the main branch does not support selenium [web driver] operations, the functional test which depends on selenium to run has been removed.
@alvindera97
Handle Case When Call To Next Event Returns None
aa4d55b
@alvindera97
Fix Erroneous Addition To Dev Requirements
207a0af 
This error was introduced in 115af08
@alvindera97
Merge remote-tracking branch 'upstream/main' into fix-issue-1701
c7cfabd
@alvindera97 alvindera97 mentioned this pull request Aug 8, 2024
Closed
@alvindera97
Copy link
Contributor Author

alvindera97 commented Aug 28, 2024 •
edited
Loading

Good day everyone, I hope you're all doing well.

I initially worked on this issue (#1701) some time ago, and it was opened in 2020. The problem involved events with start or end dates that are not in the current year (i.e. not matching datetime.datetime.now().year on the server). These events were displayed without indicating the year, which could cause confusion for users.

While event names often include the year, displaying the year directly with the event dates on the frontend provides additional clarity and improves user experience by avoiding any ambiguity.

If possible, I'd appreciate a review of my pull request. I’m happy to answer any questions you may have and will do my best to clarify any details.

Thank you for your time, and I look forward to your feedback.

Best regards,
Godwin

@alvindera97
Copy link
Contributor Author

After reviewing some other pull requests on the repo, I decided that adding screenshots of before and after would better give a visual summary of what has been done

Before:

Screenshot from 2024-09-15 17-01-50

After:

Screenshot from 2024-09-15 16-57-00

@JacobCoffee JacobCoffee changed the title Fix issue 1701: Events page displays year for events scheduled to start or end at a future year fix(#1701): Events page displays year for events scheduled to start or end at a future year Sep 16, 2024
alvindera97 and others added 4 commits September 20, 2024 15:13
@alvindera97
Refactor Tests For Relevant Year String Rendering At Events Page
6a18a62 
- Updated the test methods `test_scheduled_to_start_this_year_method` and `test_scheduled_to_end_this_year_method` to better reflect event scheduling edge cases.
- Added assertions to verify when events are not scheduled to start or end within the current year.
- Utilize `unittest.mock` to clamp down datetime-sensitive tests.
@alvindera97
Merge remote-tracking branch 'origin/main' into fix-issue-1701
23569b9
@alvindera97
Merge remote-tracking branch 'upstream/main' into fix-issue-1701
c4db8d4
@JacobCoffee
Merge branch 'main' into fix-issue-1701
1150e6a
JacobCoffee
JacobCoffee approved these changes Sep 26, 2024
View reviewed changes
Copy link
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

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

image lgtm

events/tests/test_models.py Outdated Show resolved Hide resolved
events/tests/test_models.py Outdated Show resolved Hide resolved
events/tests/test_models.py Outdated Show resolved Hide resolved
@JacobCoffee
Copy link
Member

Thanks for your continued contributions, @alvindera97! Very much appreciated :)

@JacobCoffee JacobCoffee merged commit c33a664 into python:main Sep 26, 2024
3 checks passed
ewdurbin added a commit that referenced this pull request Sep 30, 2024
@JacobCoffee @ewdurbin
@dependabot @miketheman @alvindera97
release: push latest changes (#2620)
733d59c 
* fix: display active events, fix time not displaying for some events (#2556)

* fix: display active events, fix time not displaying for some events

* test: passing events view tests

* style: different icon

* Update views.py

Co-authored-by: Ee Durbin <[email protected]>

---------

Co-authored-by: Ee Durbin <[email protected]>

* Bump django-admin-interface from 0.24.2 to 0.28.9 (#2589)

Bumps [django-admin-interface](https://github.com/fabiocaccamo/django-admin-interface) from 0.24.2 to 0.28.9.
- [Release notes](https://github.com/fabiocaccamo/django-admin-interface/releases)
- [Changelog](https://github.com/fabiocaccamo/django-admin-interface/blob/main/CHANGELOG.md)
- [Commits](fabiocaccamo/django-admin-interface@0.24.2...0.28.9)

---
updated-dependencies:
- dependency-name: django-admin-interface
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jacob Coffee <[email protected]>

* Bump django-pipeline from 3.0.0 to 3.1.0 (#2549)

Bumps [django-pipeline](https://github.com/jazzband/django-pipeline) from 3.0.0 to 3.1.0.
- [Release notes](https://github.com/jazzband/django-pipeline/releases)
- [Changelog](https://github.com/jazzband/django-pipeline/blob/master/HISTORY.rst)
- [Commits](jazzband/django-pipeline@3.0.0...3.1.0)

---
updated-dependencies:
- dependency-name: django-pipeline
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump factory-boy from 3.2.1 to 3.3.1 (#2548)

Bumps [factory-boy](https://github.com/FactoryBoy/factory_boy) from 3.2.1 to 3.3.1.
- [Changelog](https://github.com/FactoryBoy/factory_boy/blob/master/docs/changelog.rst)
- [Commits](FactoryBoy/factory_boy@3.2.1...3.3.1)

---
updated-dependencies:
- dependency-name: factory-boy
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix(frontend): add help text to story form (#2594)

* fix(frontend): add help text to story form

Closes #2364

* chore: source migration

* fix: use meta class overrides instead

* feat: linkify

* Bump python-decouple from 3.4 to 3.8 (#2596)

Bumps [python-decouple](https://github.com/henriquebastos/python-decouple) from 3.4 to 3.8.
- [Release notes](https://github.com/henriquebastos/python-decouple/releases)
- [Changelog](https://github.com/HBNetwork/python-decouple/blob/master/CHANGELOG.md)
- [Commits](HBNetwork/python-decouple@v3.4...v3.8)

---
updated-dependencies:
- dependency-name: python-decouple
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jacob Coffee <[email protected]>

* deps: no mo boto (#2598)

* Bump django-tastypie from 0.14.6 to 0.14.7 (#2602)

Bumps [django-tastypie](https://github.com/django-tastypie/django-tastypie) from 0.14.6 to 0.14.7.
- [Release notes](https://github.com/django-tastypie/django-tastypie/releases)
- [Commits](django-tastypie/django-tastypie@v0.14.6...v0.14.7)

---
updated-dependencies:
- dependency-name: django-tastypie
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump cssselect from 1.1.0 to 1.2.0 (#2606)

Bumps [cssselect](https://github.com/scrapy/cssselect) from 1.1.0 to 1.2.0.
- [Changelog](https://github.com/scrapy/cssselect/blob/master/CHANGES)
- [Commits](scrapy/cssselect@v1.1.0...v1.2.0)

---
updated-dependencies:
- dependency-name: cssselect
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chores & docs: clean up some inaccuracies in getting started (#2600)

* chore: remove obsolete version entry from compose

Currently raises a warning:

   the attribute `version` is obsolete, it will be ignored,
   please remove it to avoid potential confusion

Signed-off-by: Mike Fiedler <[email protected]>

* docs: staging site does not exist

Signed-off-by: Mike Fiedler <[email protected]>

* docs: format the link to be clickable

Signed-off-by: Mike Fiedler <[email protected]>

* docs: use what's currently in docker-compose.yml

Signed-off-by: Mike Fiedler <[email protected]>

* docs: remove version specificity

Signed-off-by: Mike Fiedler <[email protected]>

---------

Signed-off-by: Mike Fiedler <[email protected]>

* fix(#1701): Events page displays year for events scheduled to start or end at a future year (#2500)

* Add Methods To Check If Event Starts And Ends This Year

* Set Up Templates For Querying Start And End Years

Passed variables to the time_tag template [time_tag.html] that checks if an event was scheduled to start or end with the current year.

* Insert New Test Data And Update test_views.py

More events are created to test particular scenarios of events especially events set to start or end at a future year.

* Time Tag Now Shows Year For Events With Details Not Within The Current Year

The time tag now displays the year when an event will occur. This is only for events that have been scheduled to start or end in at a future year. The accompanying functional tests have also been included.

* Move All Test Data To Functional Test

All test data concerning the provision of data to serve the functional tests have been moved to the functional test.
As it improves readability.
All other test data at test_views.py was reset
to accommodate for the reduction in number of test data instances.

* Functional Test For Displaying Year Of Event For Future Events Now Implemented With Unit Tests

* Remove Functional Test For Displaying Year Of Future Event

Since the current CI at the main branch does not support selenium [web driver] operations, the functional test which depends on selenium to run has been removed.

* Handle Case When Call To Next Event Returns None

* Fix Erroneous Addition To Dev Requirements

This error was introduced in 115af08

* Refactor Tests For Relevant Year String Rendering At Events Page

- Updated the test methods `test_scheduled_to_start_this_year_method` and `test_scheduled_to_end_this_year_method` to better reflect event scheduling edge cases.
- Added assertions to verify when events are not scheduled to start or end within the current year.
- Utilize `unittest.mock` to clamp down datetime-sensitive tests.

---------

Co-authored-by: Jacob Coffee <[email protected]>

* infra: enable the waf (#2613)

* fix(infra): use new site names (#2614)

* chore: avoid running Actions twice on PR (#2615)

* chore: avoid running Actions twice on PR

Refs: https://github.com/orgs/community/discussions/57827#discussioncomment-6579237

* chore: run once

* add a static container for handling local frontend dev (#2619)

* add a static container for handling local frontend dev

* resulting css files

* Improve static deploy (#2609)

* Add a utility for purging Fastly by Surrogate-Key

* add a postdeploy step to purge surroage-keys for static files

---------

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Mike Fiedler <[email protected]>
Co-authored-by: Ee Durbin <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Mike Fiedler <[email protected]>
Co-authored-by: Nwokolo Godwin Chidera <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk left review comments

@JacobCoffee JacobCoffee JacobCoffee approved these changes

@ewdurbin ewdurbin Awaiting requested review from ewdurbin ewdurbin is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Calendar events should show the year for events which are not in the current year
3 participants
@alvindera97 @JacobCoffee @hugovk