Move achievement item use form to ProblemSet page.

[somiaj]

Move the achievement item use forms from the achievement page to the problem set page. The primary goal is to make less likely a student applies an achievement to the wrong set or problem when using drop down menus to select between multiple sets and problems on the achievements page, by placing the use item form on the set they wish to apply it to.

If achievement items are enabled, this adds a button to the bottom of the problem set page to "Use Achievement Reward" which opens a modal with a list of all available achievement items that can be used on the current set. Since the items now have access to the merged set and problem records, they can use this to both determine if the item
can be used, and include it in the form output. This makes the output more useful, stating what the extended due date is, or what the current and final grade would be when using an item.

If no achievement items are usable the button is disabled with a hover explaining why. Achievement items can also
no longer be used when acting as another user. In this case the button is also disabled. I decided to not setup a permission for this, because to me the items are for students, instructors can override the student data in other ways.

The achievement page now lists all earned items (including count), with a description that to use an item they must go to the set they wish to use it on and click the "Use Achievement Reward" button. When acting as a user this list shows up as well, so instructors can see what achievements a student still has available but not use them.

This is built on top of #2523 so I could update all achievement items and test them. So that should be merged first.

I have modified the gateway achievements temporarily. Due to the new setup I didn't implement applying extensions to the test versions, now the achievements only apply extensions to the template set. This is partly due to #2646, with comments that a better setup needs to be done (my thought is only allow extending open test versions that end at the same time as the template test vs ones that have a timer set).

Here is an achievement to give you 15 of all achievement items to test. If you want to test the unlimited use, set the count to a negative number.

$globalData->{AddNewTestGW} += 15;
$globalData->{DoubleProb} += 15;
$globalData->{DoubleSet} += 15;
$globalData->{DuplicateProb} += 15;
$globalData->{ExtendDueDate} += 15;
$globalData->{ExtendDueDateGW} += 15;
$globalData->{ExtendReducedDate} += 15;
$globalData->{FullCreditProb} += 15;
$globalData->{FullCreditSet} += 15;
$globalData->{HalfCreditProb} += 15;
$globalData->{HalfCreditSet} += 15;
$globalData->{NoReducedCred} += 15;
$globalData->{ReducedCred} += 15;
$globalData->{ResetIncorrectAttempts} += 15;
$globalData->{ResurrectGW} += 15;
$globalData->{ResurrectHW} += 15;
$globalData->{SuperExtendDueDate} += 15;
$globalData->{SuperExtendReducedDate} += 15;
$globalData->{Surprise} += 5;

return 1;

[Alex-Jordan]

I made some typo suggested edits (which you could ignore in GH and just fold into your next commit if you like). And I left some other comments about certain wording. I haven't done a comprehensive review of all the wordings.

This will be better than what we have now. I think this came up in discussion at a recent meeting, do I remember right?

I think on the Achievements page, the Reward item titles no longer need the fs-3 class. With that there, now that all the form content is gone, it looks too heavy.

Now there are three buttons:

Download Hardcopy for Current Set
Use Achievement Reward
Email Instructor

I wonder if it would look better (in a wide enough screen) like:

Download PDF                Use Reward                   Email Instructor

Perhaps beyond the scope of this PR, but if those buttons became icons and were placed more near the top of the page, I think it would be better. That includes "Email Instructor" on other pages besides a problem page. Maybe this is just my opinion.

[somiaj]

@Alex-Jordan thanks, I rebased the branch onto develop and updated all the typos.

[somiaj]

@Alex-Jordan I updated a bunch of your suggestions. Leaving the button layout alone for now. If it is agreed to change I can wrap it in here, or it can be a future PR.

[Alex-Jordan]

I believe all current achievements reward items are something you apply to a set. (Possibly to a problem or problems within a set.)

Would it make sense to ever have an achievement reward item that does not apply to a particular set? Like a reward item where across the course, all exercises where you earned partial credit get elevated to 100%. Or an item that reopens all sets but reduced credit is in effect. Grant additional attempts to all problems across the course. Etc.

If such an item existed, how do you imagine giving students the ability to use it? Would it just always show up among the items in the modal dialog for the "Use Achievement Item" button in any set's problem list page? Or would such things be activatable from the Achievements page? Before we do away with the ability to activate these from the Achievements page, I wanted to ask if we are sure that would be OK.

[somiaj]

My original approach was to allow this 'Use Achievement Reward' button to be used on multiple pages, and the can_use method just needs to be able to know what page to be able to adjust how it determines if it is usable or not. So it should be possible to extend things so they work better from any page. Initially I put the button on both set and problem pages, but the problem page led to lots of issues about using it with an undefined, or for show me another. So I just settled and moving the button only to the problem set page for now since it has access to the set record and all problem records without additional database calls.

That being said, if things a need arises to allow using achievements from different pages, it should be setup to make adding that feature not too difficult, but I would think about that for future work. I just stuck to a single page for now for simplicity and currently we don't have such achievements.

[Alex-Jordan]

OK, it's good that however things are working for this, it is extensible to possible future situations.

[drgrice1]

There is a problem with this pull request that needs to be fixed. If $achievementItemsEnabled is false (i.e. if Enable Achievement Rewards is set to False in the course configuration), then the Use Achievement Reward button should not be shown as it currently is in this pull request.

[somiaj]

@drgrice1 thanks for catching that, should be fixed now.

[drgrice1]

This generally looks good. However, there seem to be several typos and inconsistency in the language for several of the rewards. Also there are few UI details that could use improvement.

Also, there is something odd with the Surprise achievement. The oddity is in the develop branch as well, and somewhat remedied in this pull request, but not completely. You removed the submit button for the reward that doesn't do anything, but yet the item still shows Mysterious Package (with Ribbons) (n remaining) on the achievements page even though there is no way to use it or decrease the number of remaining rewards in this case.

[somiaj]

@drgrice1 Thanks for the review. I have committed all your suggested changes and removed the number of remaining items from the remaining title of the Surprise achievement item.

I am currently out of town so I am unable to test the changes, I just had some down time to commit them. I will test further when I return home next week.

[drgrice1]

I think this is looking good now. I think this will be a much nicer way to use achievement rewards. Thanks for your work on this.