Add external links to Chapter Profile #37

Upasanadhameliya · 2021-10-26T06:26:03Z

What?

Backend

Created a base model called Groups.
Made Chapters a child model class of Groups
Added Many-To-Many relationship in Groups with members and users. Many users can be a part of a group and a user can be involved in multiple groups.
Chapters objects were added to context after ordering by region and name. This was essential for the correct display through regroup template tag.
Added functionality for users to join and leave a Group.
Added GroupsIndexPage from which ChaptersIndexPage inherits.

Frontend

Added Chapters Index Page link to the Home Page
Added Chapters Page containing chapter title, Join/leave button and link to previous page.

Chapters Display on Chapters Index Page

The common fields such as "introduction line" and "content panel" was added into the groups base class and the specific fields were kept in the child class.

Upasanadhameliya · 2021-10-26T06:27:12Z

@brylie I have made some initial commits in the favour of our discussion. I will be adding more changes in the same way. You can review my changes for any corrections/modifications as required.

project/chapters/models.py

brylie · 2021-10-26T08:04:11Z

Looks good so far! I only suggested a minor modification.

Introduction and Details fields were added to the Groups page as all pages inheriting from groups would be requiring these fields.

project/chapters/models.py

Upasanadhameliya · 2021-10-26T08:33:24Z

@brylie I am running into a problem while applying migrations. The following types of errors are being encountered:

Error1

You are trying to add a non-nullable field 'body' to chapter without a default; we can't do that (the database needs something to populate existing rows).
Please select a fix:
 1) Provide a one-off default now (will be set on all existing rows with a null value for this column)
 2) Quit, and let me add a default in models.py

Error2

You are trying to add a non-nullable field 'content' to homepage without a default; we can't do that (the database needs something to populate existing rows).
Please select a fix:
 1) Provide a one-off default now (will be set on all existing rows with a null value for this column)
 2) Quit, and let me add a default in models.py

Error3

You are trying to add a non-nullable field 'groups_ptr' to chapter without a default; we can't do that (the database needs something to populate existing rows).
Please select a fix:
 1) Provide a one-off default now (will be set on all existing rows with a null value for this column)
 2) Quit, and let me add a default in models.py

The error that I am encountering might be referenced in this issue

brylie · 2021-10-26T09:00:44Z

Delete your existing db.sqlite and then run python manage.py makemigrations. Note, you can set the body and content fields to be nullable with null=True and blank=True.

1. Single introduction field was added of the type RichText field. 2. The "content" field in the home/models.py/ : HomePage was made to be optional due to the default value restriction during migrations. 3. Reformatted the home and chapters models using black.

Upasanadhameliya · 2021-10-28T06:27:10Z

Hey @brylie I have been brainstorming about our issue and I tried to create some test data for the same. So currently the countries are getting rendered with their regions in separate boxes. But won't you want to list all the countries of the same region together? Like in the following example won't you want japan to be under india?

Forgive my basic illustration done with paint 😆

brylie · 2021-10-28T06:38:53Z

Yes, we want to group chapters by region. Since grouping data by an attribute is such a common need, Django provides the regrouo template tag. Let's regroup the chapters by region. Pick suitable Bootstrap components to display the regrouped chapters.

A limitation of {% regroup %} was it's inability to order the groups before grouping and thus had to be grouped explicitly. Also added links to return to the parent pages from the child pages.

The many-to-many relationship was used to add or remove a particular user to the selected chapter. Now a single user can join one or more chapters and a single chapter can contain one or more users as well.

Upasanadhameliya · 2021-10-29T09:49:26Z

@brylie I have implemented the user membership feature in the chapters. You might want to check it out. Currently I am using query string parameter on the button to achieve this, but there might be a better way to do it. I might even consider using ajax to prevent page refresh. Feel free to give some suggestions for the same!

brylie · 2021-10-29T10:53:35Z

I might even consider using ajax to prevent page refresh.

For dynamic portions of the page that should update without a refresh, let's use HTMX. We basically need to define a view that returns the HTML fragment for the user membership component. When the user clicks the button, HTMX will make a request to the membership widget view and insert the returned HTML fragment into the template.

brylie · 2021-10-29T10:55:08Z

However, we might want to live with the page refresh for this iteration unless AJAX/HTMX seems reasonable to add in the first pass.

Upasanadhameliya · 2021-11-01T04:16:21Z

@brylie so should I make this pull request ready for review? Is there any additional change you would like me to implement before I do so?

brylie · 2021-11-01T07:43:29Z

Yeah, let's mark this as ready for review. If you agree that the AJAX would be a good enhancement for the group membership button, please open a feature request, so we remember to come back around to that enhancement.

project/chapters/models.py

It was a bad practice for updating the database using a get method, which was the case with chapter membership. The new method implemented uses a POST method, along with form validation to ensure site safety and security and preventing url/sql injection or other hacking techniques.

project/chapters/templates/chapters/chapter.html

ChaptersIndexPage was made to inherit from the abstract Page model so that the code becomes easier to maintain. Other types of Groups and their Index Pages would be created easily by just inheriting from Groups and GroupsIndexPage.

project/chapters/models.py

project/chapters/templates/chapters/chapter.html

project/home/templates/home/home_page.html

brylie · 2021-11-10T10:16:51Z

The overall direction and code architecture here look great! There are just a few minor considerations that I've mentioned in the review comments.

Instead of specifying a hardcoded class "Chapter", the subpage class was derived from the object and the child objects were fetched and ordered accordingly. The models were reformatted with black.

It wasn't preferrable to redirect the unauthenticated users to login page and it was best to not render the join group button to non authenticated users.

brylie · 2021-11-11T08:21:05Z

Great work! This is a significant PR :-)

Upasanadhameliya · 2021-11-11T09:48:23Z

Yeah thank you! 😄

Upasanadhameliya added 2 commits October 26, 2021 10:55

Added groups model to chapters

8f65deb

Chapters inheriting from Groups

95a4b2d

The common fields such as "introduction line" and "content panel" was added into the groups base class and the specific fields were kept in the child class.

brylie requested changes Oct 26, 2021

View reviewed changes

project/chapters/models.py Outdated Show resolved Hide resolved

Added fields to Groups

e440206

Introduction and Details fields were added to the Groups page as all pages inheriting from groups would be requiring these fields.

brylie requested changes Oct 26, 2021

View reviewed changes

project/chapters/models.py Outdated Show resolved Hide resolved

Upasanadhameliya added 2 commits October 28, 2021 10:05

Added homepage migration

7d1d137

Upasanadhameliya added 4 commits October 28, 2021 13:37

Added members to groups as a many to many relationship

82891d8

Added link to chapters index from home page

03be904

Solved the grouping of regions in chapters index

0b0e60d

A limitation of {% regroup %} was it's inability to order the groups before grouping and thus had to be grouped explicitly. Also added links to return to the parent pages from the child pages.

Added the logic to join a chapter or leave a chapter

3c3f7ee

The many-to-many relationship was used to add or remove a particular user to the selected chapter. Now a single user can join one or more chapters and a single chapter can contain one or more users as well.

Upasanadhameliya mentioned this pull request Nov 2, 2021

Add AJAX/HTMX support for chapter membership button #41

Closed

Upasanadhameliya added 3 commits November 2, 2021 10:20

Merge branch 'develop' into chapterprofile

8448e91

Reformatted models using black

e8d9382

Added comments

5dcf909

Upasanadhameliya marked this pull request as ready for review November 2, 2021 05:08

brylie requested changes Nov 2, 2021

View reviewed changes

project/chapters/models.py Outdated Show resolved Hide resolved

brylie requested changes Nov 2, 2021

View reviewed changes

project/chapters/models.py Show resolved Hide resolved

Reformatted files with black

15f113d

brylie requested changes Nov 3, 2021

View reviewed changes

project/chapters/templates/chapters/chapter.html Outdated Show resolved Hide resolved

project/chapters/templates/chapters/chapter.html Outdated Show resolved Hide resolved

project/chapters/templates/chapters/chapter.html Outdated Show resolved Hide resolved

Upasanadhameliya added 2 commits November 10, 2021 09:59

Added GroupsIndexPage

2832a14

ChaptersIndexPage was made to inherit from the abstract Page model so that the code becomes easier to maintain. Other types of Groups and their Index Pages would be created easily by just inheriting from Groups and GroupsIndexPage.

Added i18n tags and removed parent page link

99b7adf

brylie requested changes Nov 10, 2021

View reviewed changes

project/chapters/models.py Outdated Show resolved Hide resolved

brylie requested changes Nov 10, 2021

View reviewed changes

project/chapters/models.py Outdated Show resolved Hide resolved

brylie requested changes Nov 10, 2021

View reviewed changes

project/chapters/models.py Outdated Show resolved Hide resolved

brylie requested changes Nov 10, 2021

View reviewed changes

project/chapters/models.py Outdated Show resolved Hide resolved

brylie reviewed Nov 10, 2021

View reviewed changes

project/chapters/models.py Outdated Show resolved Hide resolved

brylie requested changes Nov 10, 2021

View reviewed changes

project/chapters/templates/chapters/chapter.html Show resolved Hide resolved

brylie requested changes Nov 10, 2021

View reviewed changes

project/home/templates/home/home_page.html Outdated Show resolved Hide resolved

Upasanadhameliya added 5 commits November 11, 2021 10:02

Get Context in Groups Index Page was made more generic

ea078b3

Instead of specifying a hardcoded class "Chapter", the subpage class was derived from the object and the child objects were fetched and ordered accordingly. The models were reformatted with black.

Shortened and cleaned the get_context() of Group model

1ec55ad

Deleted irrelevant comment in Group model serve() method

7f687c8

Restricted the join group form to only authenticated users

d568ed0

It wasn't preferrable to redirect the unauthenticated users to login page and it was best to not render the join group button to non authenticated users.

Removed .specific to refer to child pages from home page

46a18d3

brylie approved these changes Nov 11, 2021

View reviewed changes

brylie merged commit 8e85e78 into Wagify:develop Nov 11, 2021

Upasanadhameliya mentioned this pull request Nov 15, 2021

Add website and social media links to chapter profile #42

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add external links to Chapter Profile #37

Add external links to Chapter Profile #37

Upasanadhameliya commented Oct 26, 2021 •

edited by brylie

Loading

Upasanadhameliya commented Oct 26, 2021

brylie commented Oct 26, 2021

Upasanadhameliya commented Oct 26, 2021

brylie commented Oct 26, 2021

Upasanadhameliya commented Oct 28, 2021

brylie commented Oct 28, 2021

Upasanadhameliya commented Oct 29, 2021

brylie commented Oct 29, 2021

brylie commented Oct 29, 2021

Upasanadhameliya commented Nov 1, 2021

brylie commented Nov 1, 2021

brylie commented Nov 10, 2021

brylie commented Nov 11, 2021

Upasanadhameliya commented Nov 11, 2021

Add external links to Chapter Profile #37

Add external links to Chapter Profile #37

Conversation

Upasanadhameliya commented Oct 26, 2021 • edited by brylie Loading

What?

Backend

Frontend

Chapters Display on Chapters Index Page

Upasanadhameliya commented Oct 26, 2021

brylie commented Oct 26, 2021

Upasanadhameliya commented Oct 26, 2021

brylie commented Oct 26, 2021

Upasanadhameliya commented Oct 28, 2021

brylie commented Oct 28, 2021

Upasanadhameliya commented Oct 29, 2021

brylie commented Oct 29, 2021

brylie commented Oct 29, 2021

Upasanadhameliya commented Nov 1, 2021

brylie commented Nov 1, 2021

brylie commented Nov 10, 2021

brylie commented Nov 11, 2021

Upasanadhameliya commented Nov 11, 2021

Upasanadhameliya commented Oct 26, 2021 •

edited by brylie

Loading