4473 expand reminder date possibilities (#5190)

* Replaces reminder_day with reminder_schedule

Via db migrations, replaces the simple integer `reminder_day` with the more complex
`reminder_schedule` which is an ical string that can be parsed to a repeating Schedule class.
Adjusts the logic in the `fetch_partners_to_reminder_now_service` to use the repeating schedule.
Updates related tests.

* Adds input for the reminder schedule in the Edit Partner Group page

Builds an ActiveModel, ReminderSchedule, which takes the necessary information
and turns it into an IceCubeSchedule, which is what ultimate get saved in the db.

Builds the form for this reminder schedule. Still needs to conditionally show or hide
sections depending on if the user wants date or day of the week.

* Adds Reminder Schedule fields to New and Edit Organization

Now either while creating new Organization/Partner Groups or editing them,
all the transfers from Reminder Date to Reminder Day have been made.

* Makes the day of week or date hide depending on selection

This uses css for ease and accessibility.

* Adds tests and does refactoring

 Adds a number of refactors, including moving all the create_schedule logic
 to the deadlinable helper, and creates unit and system tests for the new functionality.

* 4473 - Makes same warning appear for reminder date

Reintroduces the functionality of having warnings for having the reminder
date the same as the deadline date.

* Only create new schedule if details have changed

We don't want to create a new schedule if nothing has changed,
as it will reset the start date and potentially mess with those
who have every 2/3/etc months reminders.

* 4473 - Removes Every N Months

All reminders should be Monthly, so every N Months is removed.

Also allows users to select "Last" as an option.

* 4473 - Updates names of Month vs Week fields

Rather than "date" and "week_day", we are now using "day_of_month" and
"day_of_week" for clarity.

* 4473 - fixes reminder day vs deadline display bug

There was a bug in which if the reminder day of the month was the same
as the deadline day, it would dislplay the error message even if the user
changed to the day of the week option. Now the error message is hidden if
the user is selecting the day of the week option.

* Changes made by linter

* Removed references to factored out ReminderSchedule model

* Removed reference to factored out reminder_day

* Removed redundant/outdated additions to the organizations detail page

* Fixed accidentally removing receive_email_on_requests from organization_params during merge

* Updated organization system specs to reflect current organization details page and verify new reminder schedule interface

* Added every_nth_month field to let users specify a monthly frequency for reminders

* Cleaned up _deadline_day_fields.html.erb and reworked it to hook up to new stimulus controller, replaced conditional SASS rule with JS implementation for sake of readability/maintainability

* Updated deadline_day_controller to calculate the reminder and deadline dates using new rrule library

* Reworked deadlinable specs to use explicit, hardcoded values

* Updated check for same reminder and deadline days to only consider dayOfMonth and deadlineDay fields, as exact remidner date will shift when using byDayOfWeek

* Renamed validations to clairfy they validate the day_of_month field and not the reminder date more generally

* Updated should_update_reminder_schedule and create_schedule to be public since they don't have side effects, tweaked should_update_reminder_schedule

* Added specs for remaining deadlinable functions

* Fixed specs using wrong type of params for creating schedules

* Added spec to validate that if a partner has reminders disabled but is part of a group with reminders, it still receives a reminder

* Added spec to verify that the partner group deadline day is prioritized over the organization deadline day

* Removed redundant checks on deadlinable fields from other models' specs

* Fixed labels not being correctly hooked up to radio buttons

* Updated description of deadlines to specify they always happen after the reminder

* Updated deadline_day_controller to let user know when their input violates the between 1 and 28 constraint on dayOfMonth and deadlineDay

* Added specs for shared deadline day form in the three pages where that form is used

* Added spec to verify that the reminder and deadlines dates are consistent across the front and back end

* Fixed spec refering to old radio button id

* Changes made by linter

* Updated and modified documentation to explain how reminder schedules work

* Fixed PartnerGroup not checking if reminder_schedule needs to be updates, added comments explaining need for the check

* Forgot to include Gemfile.lock

* Changes made by linter

* Updated spec to not use Organization.short_name

* Forgot to run linter

* Fixed migration not correctly converting reminder_day to reminder_schedule

* First pass at adding start_date to deadline day form

* Updated tests to consider start date

* Forgot to add tests for get_values_from_reminder_schedule

* Changes made by linter

* Reworked create_schedule to start the schedule at the current date time if a start_date isn't provided

* Reworked wording of deadline day form, updated javascript controller to calculate next reminder day after the current date

* Removed confusing commented out configurations

* Expanded tests to cover all combinations of the order of the start, current, and reminder dates

* Fixed tests not setting deadline_day which made partner_groups fail validation

* Removed unecessary should_update_reminder_schedule and from_ical functions

* Extended untilDate calculation to account for week day rules that would be more than exactly monthylInterval months out

* Updated factories to not set a deadline_day as it was causing issues with deadline_day_fields_shared_example tests

* Changes made by linter

* Renamed reminder schedule field, removed migration that removed reminder_day field, and added first pass at ReminderScheduleService [skip ci]

* Removed validations from ReminderScheduleService that rely on the parent object

* Minor change to make conditional cleaner

* Factored out ReminderScheduleable concern, updated _deadline_day_fields form to use a ReminderScheduleService object instead of an ActiveRecord object [skip ci]

* Slightly reworked how attributes are assigned to the reminder_schedule

* Updated partner groups and admin organizations controller to use the new ReminderScheduleService object

* Updated deadline day fields tests to only fill out the form with dates between 1 and 28

* Exposed IceCube occurs_on? function through ReminderScheduleService and updated FetchPartnersToRemindNowService to use it

* Fixed day_of_week and every_nth_day validations not casting before comparing

* Reverted change to _details because it didn't show 'Not defined' for an empty schedule object

* Updated shared deadline day field tests to reflect the new form

* Forgot to update partner group form to use new deadline_day_fields partial

* Moved test comparing output of FetchPartnersToRemindNowService to what is shown in the form out of the shared examples, as orgs created via the admin interface won't have partners

* Removed outdated test on removed edit_admin_organization_path, moved tests on deadline day form to happen on new_admin_organization_path

* Made reminder_schedule_service params permitted but optional

* Removed reminder schedule definitions from org and partner group factories as they aren't necessary to initializing those models

* Updated tests to use new reminder schedule service

* Updated reminder_schedule_is_empty_or_valid? to not raise errors if the user hasn't filled out the form at all, added a check to partner groups to make sure a valid reminder schedule is present when send_reminders is true

* Teaked custom validation functions to explicitly check for presence of field

* Added tests for the ReminderScheduleService

* Removed old concerns and associated tests

* Changes made by linter

* Addressed linter's warning about using mixed logical operators in an unless condition

* Reworked DeadlineService and exposed IceCube schedule next_occurrence to show user next reminder and deadline date in views

* Added tests to verify reminder and deadilne dates added to organization and partner group views

* Updated the reminder schedule form to instruct users how to set the start date for non-monthly schedules and warn them about same-day schedules likely not firing

* Changes made by linter

* Removed start_date and every_nth_month fields from ReminderScheduleService, now assuming all schedules are monthyl and start today; removed associated tests

* Changed field label to be consistent with reminder day of week label

* Forgot to remove unnecessary test now that start_date isn't tracked

* Changed wording of deadline day field

* Fixed deadline day controller incorrectly predicting deadline day if reminder would be sent on the 31st of a month

* Updated user guide to reflect reduced scope of reminder schedule form

* Fixed deadline_day being checked against day_of_month even for by_day_of_week schedules, added tests to verify

* Forgot to add comment

* Reworked reminder_schedule_is_empty_or_valid? conditionals to be more readable

* Combined multiple asserts into larger it blocks for the sake of performance

* Moved tests that didn't rely on javascript to requests

* Moved definition of safe_add/subtract_days so they can be used in other tests, used them to fix test failing intermitently on the 14th

---------

Co-authored-by: Jesse Landis-Eigsti <[email protected]>

Author: Benjamin-Couey

Gemfile

@@ -94,6 +94,8 @@ gem "flipper-ui"
 gem "geocoder"
 # Generate .ics calendars for use with Google Calendar
 gem 'icalendar', require: false
+# Offers functionality for date reocccurances
+gem "ice_cube"
 # JSON Web Token encoding / decoding (e.g. for links in e-mails)
 gem "jwt"
 # Use Newrelic for logs and APM

Gemfile.lock

@@ -275,7 +275,6 @@ GEM
       concurrent-ruby (~> 1.1)
       webrick (~> 1.7)
       websocket-driver (~> 0.7)
-    ffi (1.17.2)
     ffi (1.17.2-arm64-darwin)
     ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
@@ -784,6 +783,7 @@ DEPENDENCIES
   geocoder
   guard-rspec
   icalendar
+  ice_cube
   importmap-rails (~> 2.2)
   jbuilder
   jwt

app/controllers/admin/organizations_controller.rb

@@ -30,9 +30,9 @@ def new
   end
 
   def create
-    @organization = Organization.new(organization_params)
     @user = User.new(user_params)
-
+    @organization = Organization.new(organization_params)
+    @organization.reminder_schedule.assign_attributes(reminder_schedule_params)
     if @organization.save
       Organization.seed_items(@organization)
       UserInviteService.invite(name: user_params[:name],
@@ -71,10 +71,15 @@ def destroy
 
   def organization_params
     params.require(:organization)
-          .permit(:name, :street, :city, :state, :zipcode, :email, :url, :logo, :intake_location, :default_email_text, :account_request_id, :reminder_day, :deadline_day, :bank_is_set_up,
+          .permit(:name, :street, :city, :state, :zipcode, :email, :url, :logo, :intake_location, :default_email_text, :account_request_id, :bank_is_set_up,
+                  :reminder_schedule_definition, :deadline_day,
                   users_attributes: %i(name email organization_admin), account_request_attributes: %i(ndbn_member_id id))
   end
 
+  def reminder_schedule_params
+    params.require(:organization).fetch(:reminder_schedule_service, {}).permit([*ReminderScheduleService::REMINDER_SCHEDULE_FIELDS])
+  end
+
   def user_params
     params.require(:organization).require(:user).permit(:name, :email)
   end

app/controllers/organizations_controller.rb

@@ -17,9 +17,9 @@ def edit
 
   def update
     @organization = current_organization
-
+    @organization.reminder_schedule.assign_attributes(reminder_schedule_params)
     if OrganizationUpdateService.update(@organization, organization_params)
-      redirect_back(fallback_location: organization_path, notice: "Updated your organization!")
+      redirect_to organization_path, notice: "Updated your organization!"
     else
       flash.now[:error] = @organization.errors.full_messages.join("\n")
       render :edit
@@ -95,7 +95,7 @@ def organization_params
       :name, :street, :city, :state,
       :zipcode, :email, :url, :logo, :intake_location,
       :default_storage_location, :default_email_text, :reminder_email_text,
-      :invitation_text, :reminder_day, :deadline_day,
+      :invitation_text, :reminder_schedule_definition, :deadline_day,
       :repackage_essentials, :distribute_monthly,
       :ndbn_member_id, :enable_child_based_requests,
       :enable_individual_requests, :enable_quantity_based_requests,
@@ -109,6 +109,10 @@ def organization_params
     )
   end
 
+  def reminder_schedule_params
+    params.require(:organization).fetch(:reminder_schedule_service, {}).permit([*ReminderScheduleService::REMINDER_SCHEDULE_FIELDS])
+  end
+
   def request_type_formatter(params)
     if params[:organization][:enable_individual_requests] == "false"
       params[:organization][:enable_child_based_requests] = false

app/controllers/partner_groups_controller.rb

@@ -4,10 +4,12 @@ class PartnerGroupsController < ApplicationController
   def new
     @partner_group = current_organization.partner_groups.new
     set_items_categories
+    @item_categories = current_organization.item_categories
   end
 
   def create
     @partner_group = current_organization.partner_groups.new(partner_group_params)
+    @partner_group.reminder_schedule.assign_attributes(reminder_schedule_params)
     if @partner_group.save
       # Redirect to groups tab in Partner page.
       redirect_to partners_path + "#nav-partner-groups", notice: "Partner group added!"
@@ -21,10 +23,12 @@ def create
   def edit
     @partner_group = current_organization.partner_groups.find(params[:id])
     set_items_categories
+    @item_categories = current_organization.item_categories
   end
 
   def update
     @partner_group = current_organization.partner_groups.find(params[:id])
+    @partner_group.reminder_schedule.assign_attributes(reminder_schedule_params)
     if @partner_group.update(partner_group_params)
       redirect_to partners_path + "#nav-partner-groups", notice: "Partner group edited!"
     else
@@ -52,7 +56,11 @@ def set_partner_group
   end
 
   def partner_group_params
-    params.require(:partner_group).permit(:name, :send_reminders, :deadline_day, :reminder_day, item_category_ids: [])
+    params.require(:partner_group).permit(:name, :send_reminders, :reminder_schedule_definition, :deadline_day, item_category_ids: [])
+  end
+
+  def reminder_schedule_params
+    params.require(:partner_group).fetch(:reminder_schedule_service, {}).permit([*ReminderScheduleService::REMINDER_SCHEDULE_FIELDS])
   end
 
   def set_items_categories

app/javascript/application.js

@@ -28,7 +28,6 @@ import 'controllers'
 
 import 'utils/barcode_items'
 import 'utils/barcode_scan'
-import 'utils/deadline_day_pickers'
 import 'utils/distributions_and_transfers'
 import 'utils/donations'
 import 'utils/purchases'

app/javascript/controllers/deadline_day_controller.js

@@ -0,0 +1,111 @@
+import { Controller } from "@hotwired/stimulus"
+import $ from 'jquery';
+import { RRule } from 'rrule'
+import 'tslib'
+
+const WEEKDAY_NUM_TO_OBJ = {
+  0: RRule.SU,
+  1: RRule.MO,
+  2: RRule.TU,
+  3: RRule.WE,
+  4: RRule.TH,
+  5: RRule.FR,
+  6: RRule.SA
+}
+
+export default class extends Controller {
+  static targets = [
+    'byDayOfMonth', 'byDayOfWeek', 'dayOfMonthFields', 'dayOfMonth',
+    'dayOfWeekFields', 'everyNthDay', 'dayOfWeek', 'deadlineDay', 'reminderText', 'deadlineText'
+  ]
+
+  static dateParser = /(\d{4})-(\d{2})-(\d{2})/;
+  
+  getFirstOccurrenceAfterToday( occurrences, today ) {
+    let index = occurrences.length - 1
+    let firstOccurrence = null
+    while (index >= 0){
+      if (occurrences[index].getTime() > today.getTime()) {
+        firstOccurrence = occurrences[index]
+        index--
+      } else {
+        break
+      }
+    }
+    return firstOccurrence
+  }
+
+  sourceChange() {
+    let reminder_date = null;
+    let deadline_date = null;
+
+    // For now, we are assuming that all schedules are monthly and start on the current date
+    let monthlyInterval = 1;
+    let today = new Date();
+    let untilDate = new Date( today );
+    untilDate.setMonth( untilDate.getMonth() + monthlyInterval + 1 )
+
+    if (this.byDayOfMonthTarget.checked && this.dayOfMonthTarget.value) {
+      const rule = new RRule({
+        dtstart: today,
+        freq: RRule.MONTHLY,
+        interval: monthlyInterval,
+        bymonthday: parseInt(this.dayOfMonthTarget.value),
+        until: untilDate
+      })
+      reminder_date = this.getFirstOccurrenceAfterToday( rule.all(), today )
+    }
+    if (this.byDayOfWeekTarget.checked && this.everyNthDayTarget.value && (this.dayOfWeekTarget.value)) {
+      const rule = new RRule({
+        dtstart: today,
+        freq: RRule.MONTHLY,
+        interval: monthlyInterval,
+        byweekday: WEEKDAY_NUM_TO_OBJ[ parseInt(this.dayOfWeekTarget.value) ].nth( parseInt(this.everyNthDayTarget.value) ),
+        wkst: RRule.SU,
+        until: untilDate
+      })
+      reminder_date = this.getFirstOccurrenceAfterToday( rule.all(), today )
+    }
+    if (reminder_date && this.deadlineDayTarget.value) {
+      deadline_date = new Date(reminder_date.getTime());
+      deadline_date.setDate(parseInt(this.deadlineDayTarget.value))
+      if( reminder_date.getDate() >= parseInt(this.deadlineDayTarget.value)){
+        deadline_date.setMonth( deadline_date.getMonth() + 1 )
+      }
+    }
+
+    if (this.byDayOfMonthTarget.checked && this.dayOfMonthTarget.value
+        && this.deadlineDayTarget.value && this.dayOfMonthTarget.value === this.deadlineDayTarget.value) {
+      $(this.reminderTextTarget).removeClass('text-muted').addClass('text-danger');
+      $(this.reminderTextTarget).text('Reminder day cannot be the same as deadline day.');
+      $(this.deadlineTextTarget).text("");
+    } else {
+      let dayOfMonth = parseInt(this.dayOfMonthTarget.value);
+      let deadlineDay = parseInt(this.deadlineDayTarget.value);
+      if (dayOfMonth < 1 || dayOfMonth > 28){
+        $(this.reminderTextTarget).removeClass('text-muted').addClass('text-danger');
+        $(this.reminderTextTarget).text("Reminder day must be between 1 and 28");
+      } else {
+        $(this.reminderTextTarget).removeClass('text-danger').addClass('text-muted');
+        $(this.reminderTextTarget).text(reminder_date ? `Your next reminder date is ${reminder_date.toDateString()}.` : "");
+      }
+      if (deadlineDay < 1 || deadlineDay > 28){
+        $(this.deadlineTextTarget).removeClass('text-muted').addClass('text-danger');
+        $(this.deadlineTextTarget).text("Deadline day must be between 1 and 28");
+      } else {
+        $(this.deadlineTextTarget).removeClass('text-danger').addClass('text-muted');
+        $(this.deadlineTextTarget).text(deadline_date ? `The deadline on your next reminder email will be ${deadline_date.toDateString()}.` : "");
+      }
+    }
+  }
+
+  monthOrWeekChanged() {
+    $(this.dayOfMonthFieldsTarget).toggleClass("d-none", !this.byDayOfMonthTarget.checked );
+    $(this.dayOfWeekFieldsTarget).toggleClass("d-none", !this.byDayOfWeekTarget.checked );
+  }
+
+  connect() {
+    this.monthOrWeekChanged()
+    this.sourceChange()
+  }
+}

app/javascript/utils/deadline_day_pickers.js

@@ -15,7 +15,7 @@ def notify_deadline(partner)
   private
 
   def deadline_date(partner)
-    date = DeadlineService.new(partner: partner).next_deadline
+    date = DeadlineService.new(deadline_day: DeadlineService.get_deadline_for_partner(partner)).next_deadline
 
     return date if date