/// <summary>
/// Splits a reporting period into units-of-time by a specified granularity.
/// </summary>
/// <param name="reportingPeriod">The reporting period to split.</param>
/// <param name="granularity">The granularity to use when splitting.</param>
/// <param name="overflowStrategy">
/// OPTIONAL strategy to use when <paramref name="granularity"/> is less granular than
/// the <paramref name="reportingPeriod"/> and, when splitting, the resulting units-of-time
/// cannot be aligned with the start and end of the reporting period.
/// For example, splitting March 2015 - February 2017 by year results in 2015,2016,2017,
/// however only 2016 is fully contained within the reporting period.
/// The reporting period is missing January 2015 - February 2015 and March 2017 to December 2017.
/// DEFAULT is to throw when this happens.
/// </param>
/// <returns>
/// Returns the units-of-time that split the specified reporting period by the specified granularity.
/// The units-of-time will always be in the specified granularity, regardless of the granularity
/// of the reporting period (e.g. splitting a fiscal month reporting period using yearly granularity
/// will return <see cref="FiscalYear"/> objects).
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="reportingPeriod"/> has an <see cref="UnitOfTimeGranularity.Unbounded"/> component.</exception>
/// <exception cref="ArgumentException"><paramref name="granularity"/> is <see cref="UnitOfTimeGranularity.Invalid"/>.</exception>
/// <exception cref="ArgumentException"><paramref name="granularity"/> is <see cref="UnitOfTimeGranularity.Unbounded"/>.</exception>
/// <exception cref="ArgumentException"><paramref name="overflowStrategy"/> is not <see cref="OverflowStrategy.ThrowOnOverflow"/>.</exception>
/// <exception cref="InvalidOperationException">There was some overflow when splitting.</exception>
public static IReadOnlyList <UnitOfTime> Split(
this ReportingPeriod reportingPeriod,
UnitOfTimeGranularity granularity,
OverflowStrategy overflowStrategy = OverflowStrategy.ThrowOnOverflow)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} has an {nameof(UnitOfTimeGranularity.Unbounded)} component."));
}
if (granularity == UnitOfTimeGranularity.Invalid)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Invalid}'"), (Exception)null);
}
if (granularity == UnitOfTimeGranularity.Unbounded)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Unbounded}'"), (Exception)null);
}
if ((overflowStrategy != OverflowStrategy.ThrowOnOverflow) && (overflowStrategy != OverflowStrategy.DiscardOverflow))
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(overflowStrategy)}' is not one of {{{OverflowStrategy.ThrowOnOverflow}, {OverflowStrategy.DiscardOverflow}}}."), (Exception)null);
}
var reportingPeriodGranularity = reportingPeriod.GetUnitOfTimeGranularity();
IReadOnlyList <UnitOfTime> result;
if (reportingPeriodGranularity == granularity)
{
result = reportingPeriod.GetUnitsWithin();
}
else if (reportingPeriodGranularity.IsLessGranularThan(granularity))
{
result = reportingPeriod.MakeMoreGranular(granularity).GetUnitsWithin();
}
else
{
var lessGranularReportingPeriod = reportingPeriod.MakeLessGranular(
granularity,
throwOnMisalignment: overflowStrategy == OverflowStrategy.ThrowOnOverflow);
result = lessGranularReportingPeriod.GetUnitsWithin();
if (overflowStrategy == OverflowStrategy.DiscardOverflow)
{
result = result.Where(reportingPeriod.Contains).ToList();
}
}
return(result);
}
/// <summary>
/// Converts the the specified reporting period into the least
/// granular possible, but equivalent, reporting period.
/// </summary>
/// <param name="reportingPeriod">The reporting period to operate on.</param>
/// <returns>
/// A reporting period that addresses the same set of time as <paramref name="reportingPeriod"/>,
/// but is the least granular version possible of that reporting period.
/// Any reporting period with one unbounded and one bounded component will be returned
/// as-is (e.g. Unbounded to 12/31/2017 will not be converted to Unbounded to CalendarYear 2017).
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod"/> is null.</exception>
public static ReportingPeriod ToLeastGranular(
this ReportingPeriod reportingPeriod)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
ReportingPeriod result;
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
result = reportingPeriod.DeepClone();
}
else
{
var targetGranularity = reportingPeriod.GetUnitOfTimeGranularity().OneNotchLessGranular();
if (targetGranularity == UnitOfTimeGranularity.Unbounded)
{
result = reportingPeriod.DeepClone();
}
else
{
try
{
result = reportingPeriod.MakeLessGranular(targetGranularity).ToLeastGranular();
}
catch (InvalidOperationException)
{
result = reportingPeriod.DeepClone();
}
}
}
return(result);
}