Add beginning_of_week option to weekday_options_for_select

[DRBragg]

Summary

In #42979 the suggestion was made to include an option to allow users to set "Monday" as the first day on the list.

weekday_options_for_select(begin_on_monday: true)
# => "<option value=\"Monday\">Monday</option>\n<option value=\"Tuesday\">Tuesday</option>\n
# <option value=\"Wednesday\">Wednesday</option>\n<option value=\"Thursday\">Thursday</option>\n
# <option value=\"Friday\">Friday</option>\n<option value=\"Saturday\">Saturday</option>\n
# <option value=\"Sunday\">Sunday</option>"

NOTE: If you are using indexes as values Sundays value will remain 0 for consistency with Ruby and the I18n day names array.

weekday_options_for_select(begin_on_monday: true, index_as_value: true)
# => "<option value=\"1\">Monday</option>\n<option value=\"2\">Tuesday</option>\n
# <option value=\"3\">Wednesday</option>\n<option value=\"4\">Thursday</option>\n
# <option value=\"5\">Friday</option>\n<option value=\"6\">Saturday</option>\n
# <option value=\"0\">Sunday</option>"

[p8]

In Active Support Date has a beginning_of_week method.
There also is Rails.application.config.beginning_of_week.
Maybe the option should be beginning_of_week that defaults to Rails.application.config.beginning_of_week?
That would allow beginning on saturday as well.

[DRBragg]

In Active Support Date has a beginning_of_week method.
There also is Rails.application.config.beginning_of_week.
Maybe the option should be beginning_of_week that defaults to Rails.application.config.beginning_of_week?
That would allow beginning on saturday as well.

Yea, I had thought about using that but thought it wasn't worth having to handle all the days of the week. Maybe that isn't an issue and we should just handle/allow for any day? I just wasn't sure why you would want to do that but I also didn't think about Saturday.

[DRBragg]

@p8 What would you think about only handling :sunday, :monday, or :saturday as beginning_of_week options since it seems those are the only options world wide? We'll make it so it defaults to Rails.application.config.beginning_of_week but if it's any day but the aforementioned we basically ignore it? Or do you think it's worth handling any and all days?

Here's basically what I'm thinking:

def weekday_options_for_select(selected = nil, index_as_value: false, day_format: :day_names, beginning_of_week: Date.beginning_of_week)
  rotations = { sunday: 0, monday: 1, saturday: -1 }
  day_names = I18n.translate("date.#{day_format}")
  day_names = day_names.map.with_index.to_a if index_as_value
  day_names = day_names.rotate(rotations.fetch(beginning_of_week, 1))

  options_for_select(day_names, selected)
end

Or something like that

[DRBragg]

@p8 I made the change, let me know what you think.

[DRBragg]

Ping or bump (not sure what the SOP is here)

[kaspth]

Sweet, gotta have the commits squashed too! The test failures look unrelated.

[kaspth]

We support all days now, and can just omit these specific references:

Suggested change

	# * <tt>:beginning_of_week</tt> - Defaults to Date.beginning_of_week, accepts
	# :sunday, :monday, or :saturday values to set the first day on the list.
	# * <tt>:beginning_of_week</tt> - Defaults to Date.beginning_of_week.

[DRBragg]

Good call

[kaspth]

The Action View builds passed and the failures were on main in components that this didn't touch.

Thanks so much @DRBragg, dig how this turned out 🙌

[DRBragg]

The Action View builds passed and the failures were on main in components that this didn't touch.

Thanks so much @DRBragg, dig how this turned out 🙌

Thank YOU so much @kaspth, for all the great feedback and for sticking with me through this! You rock dude, so so much!

[zzak]

@DRBragg @kaspth I find it odd that the default behavior changed to use Monday as the start of the week, but the index value still starts at 0 with Sunday 🤔

[DRBragg]

It's is a little odd but since Date.beginning_of_week defaults to Monday in Rails it's what works best in a Rails context. If you set config.beginning_of_week = :sunday in your config file this will default to Sunday instead

[zzak]

@DRBragg Right, but if Date.beginning_of_week defaults to Monday, that explains why "Monday" is the first <option> in the select but doesn't explain why "Sunday" has the 0 index, and "Monday" is 1. Is it a bug? 🤔

[DRBragg]

Sunday is 0 because I18n.translate("date.day_names") returns an array where Sunday is the first item, Date::DAYS_INTO_WEEK returns a hash where the value of the key :sunday is 0, and in Ruby calling wday on a date that is a Sunday will return 0. I'm not 100% why Date.beginning_of_week defaults to Monday