Fix #2546: Rename OngoingStory to PromotedStory #4704

adhiamboperes · 2022-11-09T17:40:37Z

Explanation

Rename instances of ../recentlyplayed/OngoingStory to PromotedStory.

ongoingStoryListSummaryResultLiveData => promotedStoryListSummaryResultLiveData
fun subscribeToOngoingStoryList => fun subscribeToPromotedStoryList in RecentlyPlayedFragmentPresenter
fun subscribeToOngoingStoryList => fun subscribeToPromotedStoryList in RecentlyPlayedFragment
class name OngoingStoryViewModel => PromotedStoryViewModel
class name OngoingListAdapter => PromotedStoryListAdapter
private class OngoingStoryViewHolder => PromotedStoryViewHolder
interface name OngoingStoryClickListener => PromotedStoryClickListener

Note: ongoing_story_card is used to show stories in the "recently played screen", under "Played within the last week and recommended stories", shown when a user clicks "View all promoted stories" from the home screen. I have renamed it to recently_played_story_card.xml.

promoted_story_card.xml is the layout file used to show promoted stories on the home page.

I removed PromotedStoryClickListener, PromotedStoryListAdapter and PromotedStoryViewModel from Kdoc excemption since the kdocs have been added.

Essential Checklist

The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".)
Any changes to scripts/assets files have their rationale included in the PR explanation.
The PR follows the style guide.
The PR does not contain any unnecessary code changes from Android Studio (reference).
The PR is made from a branch that's not called "develop" and is up-to-date with "develop".
The PR is assigned to the appropriate reviewers (reference).

Renamed to PromotedStoryViewModel alongside usages

Rename to promotedStoryListSummaryResultLiveData

Rename to subscribeToPromotedStoryList

Rename to PromotedStoryListAdapter

The activity previously passed into the adapter constructor had no usages.

Rename to PromotedStoryClickListener

BenHenning

Thanks @adhiamboperes just had a few comments.

Regarding the layouts, when is ongoing_story_card vs. promoted_story_card used? It'd be nice to fix this last case, too, if it's the only other occurrence of "ongoing story" left.

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryClickListener.kt

scripts/assets/kdoc_validity_exemptions.textproto

Also removed the kdoc exemptions for the same

Note: This is the layout file used to show stories in the "recently played screen", under "Played within the last week and recommended stories"

…-android into rename-ongoing-story

adhiamboperes

Thanks @adhiamboperes just had a few comments.

Regarding the layouts, when is ongoing_story_card vs. promoted_story_card used? It'd be nice to fix this last case, too, if it's the only other occurrence of "ongoing story" left.

Note: ongoing_story_card is used to show stories in the "recently played screen", under "Played within the last week and recommended stories", shown when a user clicks "View all promoted stories" from the home screen. I have renamed it to recently_played_story_card.xml.

promoted_story_card.xml is the layout file used to show promoted stories on the home page.

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryClickListener.kt

Add documentation

BenHenning

Thanks @adhiamboperes! I think the content for the new docs is generally good, but there are a few formatting issues to address for consistency and per the style guide. PTAL.

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryClickListener.kt

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryListAdapter.kt

adhiamboperes

I have implemented the KDoc formatting suggestions, PTAL @BenHenning

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryClickListener.kt

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryListAdapter.kt

adhiamboperes · 2022-11-17T15:19:30Z

@BenHenning I'm not sure why the workflows did not run. Could you PTAL?

BenHenning

Thanks @adhiamboperes! PR LGTM.

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryClickListener.kt

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryViewModel.kt

oppiabot · 2022-11-17T23:21:30Z

Unassigning @BenHenning since they have already approved the PR.

oppiabot · 2022-11-17T23:21:33Z

Assigning @rt4914 for code owner reviews. Thanks!

BenHenning · 2022-11-17T23:25:03Z

@adhiamboperes they sometimes hang, though it's a bit rare. I'll update the PR to the latest develop since it needs it, anyway, and that should retrigger a run.

@rt4914 PTAL for codeowners.

rt4914

@adhiamboperes Suggested minor changes. Thanks.

app/src/main/res/layout/recently_played_story_card.xml

Change the id name of ongoing_story_card_view to promoted_story_card_view in recently_played_story_card.xml. Also renamed clickOnOngoingStoryTile to clickOnPromotedStoryTile in PromotedStoryViewModel.

adhiamboperes

@rt4914, PTAL again.

app/src/main/res/layout/recently_played_story_card.xml

rt4914

LGTM

BenHenning

Latest changes LGTM, thanks @adhiamboperes!

oppiabot · 2022-11-21T15:00:41Z

Unassigning @BenHenning since they have already approved the PR.

adhiamboperes added 8 commits November 9, 2022 20:36

Rename recentlyplayed/OngoingStoryViewModel

57d3059

Renamed to PromotedStoryViewModel alongside usages

Rename ongoingStoryListSummaryResultLiveData

0ad6305

Rename to promotedStoryListSummaryResultLiveData

Rename subscribeToOngoingStoryList

5ba4a50

Rename to subscribeToPromotedStoryList

Rename OngoingListAdapter

4f0ba11

Rename to PromotedStoryListAdapter

Remove unused field in PromotedStoryListAdapter

12058f8

The activity previously passed into the adapter constructor had no usages.

Rename instances of ongoingStory to promotedStory

964db6e

Rename OngoingStoryClickListener

2dbc4bb

Rename to PromotedStoryClickListener

Rename OngoingStoryViewHolder to PromotedStoryViewHolder

6a05bca

adhiamboperes assigned BenHenning Nov 10, 2022

adhiamboperes marked this pull request as ready for review November 10, 2022 23:52

adhiamboperes requested review from BenHenning and rt4914 as code owners November 10, 2022 23:52

Merge branch 'develop' into rename-ongoing-story

744d6f7

BenHenning requested changes Nov 12, 2022

View reviewed changes

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryClickListener.kt Show resolved Hide resolved

scripts/assets/kdoc_validity_exemptions.textproto Outdated Show resolved Hide resolved

BenHenning assigned adhiamboperes and unassigned BenHenning Nov 12, 2022

adhiamboperes added 3 commits November 15, 2022 02:21

Add kdocs for promoted story files

358970f

Also removed the kdoc exemptions for the same

Rename ongoing_story_card to recently_played_story_card

ebb8f6b

Note: This is the layout file used to show stories in the "recently played screen", under "Played within the last week and recommended stories"

Merge branch 'rename-ongoing-story' of github.com:adhiamboperes/oppia…

606362e

…-android into rename-ongoing-story

adhiamboperes commented Nov 15, 2022

View reviewed changes

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryClickListener.kt Show resolved Hide resolved

Add kdocs for public methods and fields

463b187

Add documentation

adhiamboperes assigned BenHenning and unassigned adhiamboperes Nov 15, 2022

BenHenning reviewed Nov 15, 2022

View reviewed changes

BenHenning assigned adhiamboperes and unassigned BenHenning Nov 15, 2022

Rectify KDoc formatting

5159eda

adhiamboperes commented Nov 16, 2022

View reviewed changes

adhiamboperes removed their assignment Nov 16, 2022

Merge branch 'develop' into rename-ongoing-story

92bc3e9

adhiamboperes assigned BenHenning and unassigned adhiamboperes Nov 17, 2022

BenHenning approved these changes Nov 17, 2022

View reviewed changes

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryClickListener.kt Outdated Show resolved Hide resolved

app/src/main/java/org/oppia/android/app/home/recentlyplayed/PromotedStoryViewModel.kt Outdated Show resolved Hide resolved

oppiabot bot unassigned BenHenning Nov 17, 2022

oppiabot bot assigned rt4914 Nov 17, 2022

Merge branch 'develop' into rename-ongoing-story

7b82b9f

rt4914 suggested changes Nov 18, 2022

View reviewed changes

app/src/main/res/layout/recently_played_story_card.xml Show resolved Hide resolved

rt4914 assigned adhiamboperes and unassigned rt4914 Nov 18, 2022

Rename leftover ongoing story instances.

2b9e816

Change the id name of ongoing_story_card_view to promoted_story_card_view in recently_played_story_card.xml. Also renamed clickOnOngoingStoryTile to clickOnPromotedStoryTile in PromotedStoryViewModel.

adhiamboperes assigned rt4914 and unassigned adhiamboperes Nov 19, 2022

adhiamboperes commented Nov 19, 2022

View reviewed changes

app/src/main/res/layout/recently_played_story_card.xml Show resolved Hide resolved

rt4914 approved these changes Nov 21, 2022

View reviewed changes

rt4914 assigned adhiamboperes and unassigned rt4914 Nov 21, 2022

oppiabot bot added the PR: LGTM label Nov 21, 2022

Merge branch 'develop' into rename-ongoing-story

24d4909

adhiamboperes assigned BenHenning and unassigned adhiamboperes Nov 21, 2022

BenHenning approved these changes Nov 21, 2022

View reviewed changes

BenHenning enabled auto-merge (squash) November 21, 2022 14:58

oppiabot bot unassigned BenHenning Nov 21, 2022

BenHenning merged commit 3059cc7 into oppia:develop Nov 21, 2022

masclot mentioned this pull request Feb 3, 2023

Replace current recyclerview implementation with BindableAdapter usage #632

Closed

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #2546: Rename OngoingStory to PromotedStory #4704

Fix #2546: Rename OngoingStory to PromotedStory #4704

adhiamboperes commented Nov 9, 2022 •

edited

BenHenning left a comment

adhiamboperes left a comment

BenHenning left a comment

adhiamboperes left a comment

adhiamboperes commented Nov 17, 2022

BenHenning left a comment

oppiabot bot commented Nov 17, 2022

oppiabot bot commented Nov 17, 2022

BenHenning commented Nov 17, 2022

rt4914 left a comment

adhiamboperes left a comment

rt4914 left a comment

BenHenning left a comment

oppiabot bot commented Nov 21, 2022

Fix #2546: Rename OngoingStory to PromotedStory #4704

Fix #2546: Rename OngoingStory to PromotedStory #4704

Conversation

adhiamboperes commented Nov 9, 2022 • edited

Explanation

Essential Checklist

BenHenning left a comment

Choose a reason for hiding this comment

adhiamboperes left a comment

Choose a reason for hiding this comment

BenHenning left a comment

Choose a reason for hiding this comment

adhiamboperes left a comment

Choose a reason for hiding this comment

adhiamboperes commented Nov 17, 2022

BenHenning left a comment

Choose a reason for hiding this comment

oppiabot bot commented Nov 17, 2022

oppiabot bot commented Nov 17, 2022

BenHenning commented Nov 17, 2022

rt4914 left a comment

Choose a reason for hiding this comment

adhiamboperes left a comment

Choose a reason for hiding this comment

rt4914 left a comment

Choose a reason for hiding this comment

BenHenning left a comment

Choose a reason for hiding this comment

oppiabot bot commented Nov 21, 2022

adhiamboperes commented Nov 9, 2022 •

edited