From 0a8c07cc0773a1e3c109a3ccfa8b95896b7d75a8 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 18 Jun 2017 20:24:32 -0400 Subject: simplify date operators by making SDate.GetHashCode() return unique ordered values, expand unit tests (#307) --- src/StardewModdingAPI/Utilities/SDate.cs | 180 ++++++++++--------------------- 1 file changed, 56 insertions(+), 124 deletions(-) (limited to 'src/StardewModdingAPI/Utilities') diff --git a/src/StardewModdingAPI/Utilities/SDate.cs b/src/StardewModdingAPI/Utilities/SDate.cs index fdeffe80..5f7ff030 100644 --- a/src/StardewModdingAPI/Utilities/SDate.cs +++ b/src/StardewModdingAPI/Utilities/SDate.cs @@ -13,6 +13,9 @@ namespace StardewModdingAPI.Utilities /// The internal season names in order. private readonly string[] Seasons = { "spring", "summer", "fall", "winter" }; + /// The number of seasons in a year. + private int SeasonsInYear => this.Seasons.Length; + /// The number of days in a season. private readonly int DaysInSeason = 28; @@ -77,10 +80,8 @@ namespace StardewModdingAPI.Utilities // handle season transition if (day > this.DaysInSeason || day < 1) { - // get current season index - int curSeasonIndex = Array.IndexOf(this.Seasons, this.Season); - if (curSeasonIndex == -1) - throw new InvalidOperationException($"The current season '{this.Season}' wasn't recognised."); + // get season index + int curSeasonIndex = this.GetSeasonIndex(); // get season offset int seasonOffset = day / this.DaysInSeason; @@ -94,7 +95,7 @@ namespace StardewModdingAPI.Utilities } // validate - if(year < 1) + if (year < 1) throw new ArithmeticException($"Adding {offset} days to {this} would result in invalid date {day:00} {season} {year}."); // return new date @@ -116,157 +117,88 @@ namespace StardewModdingAPI.Utilities /********* ** Operator methods *********/ - - /// - /// Equality operator. Tests the date being equal to each other - /// - /// The first date being compared - /// The second date being compared + /// Get whether one date is equal to another. + /// The base date to compare. + /// The other date to compare. /// The equality of the dates - public static bool operator ==(SDate s1, SDate s2) + public static bool operator ==(SDate date, SDate other) { - if (s1.Day == s2.Day && s1.Year == s2.Year && s1.Season == s2.Season) - return true; - else - return false; + return date?.GetHashCode() == other?.GetHashCode(); } - /// - /// Inequality operator. Tests the date being not equal to each other - /// - /// The first date being compared - /// The second date being compared - /// The inequality of the dates - public static bool operator !=(SDate s1, SDate s2) + /// Get whether one date is not equal to another. + /// The base date to compare. + /// The other date to compare. + public static bool operator !=(SDate date, SDate other) { - if (s1.Day == s2.Day && s1.Year == s2.Year && s1.Season == s2.Season) - return false; - else - return true; + return date?.GetHashCode() != other?.GetHashCode(); } - /// - /// Less than operator. Tests the date being less than to each other - /// - /// The first date being compared - /// The second date being compared - /// If the dates are less than - public static bool operator >(SDate s1, SDate s2) + /// Get whether one date is more than another. + /// The base date to compare. + /// The other date to compare. + public static bool operator >(SDate date, SDate other) { - if (s1.Year > s2.Year) - return true; - else if (s1.Year == s2.Year) - { - if (s1.Season == "winter" && s2.Season != "winter") - return true; - else if (s1.Season == s2.Season && s1.Day > s2.Day) - return true; - if (s1.Season == "fall" && (s2.Season == "summer" || s2.Season == "spring")) - return true; - if (s1.Season == "summer" && s2.Season == "spring") - return true; - } - - return false; + return date?.GetHashCode() > other?.GetHashCode(); } - /// - /// Less or equal than operator. Tests the date being less than or equal to each other - /// - /// The first date being compared - /// The second date being compared - /// If the dates are less than or equal than - public static bool operator >=(SDate s1, SDate s2) + /// Get whether one date is more than or equal to another. + /// The base date to compare. + /// The other date to compare. + public static bool operator >=(SDate date, SDate other) { - if (s1.Year > s2.Year) - return true; - else if (s1.Year == s2.Year) - { - if (s1.Season == "winter" && s2.Season != "winter") - return true; - else if (s1.Season == s2.Season && s1.Day >= s2.Day) - return true; - if (s1.Season == "fall" && (s2.Season == "summer" || s2.Season == "spring")) - return true; - if (s1.Season == "summer" && s2.Season == "spring") - return true; - } - - return false; + return date?.GetHashCode() >= other?.GetHashCode(); } - /// - /// Greater or equal than operator. Tests the date being greater than or equal to each other - /// - /// The first date being compared - /// The second date being compared - /// If the dates are greater than or equal than - public static bool operator <=(SDate s1, SDate s2) + /// Get whether one date is less than or equal to another. + /// The base date to compare. + /// The other date to compare. + public static bool operator <=(SDate date, SDate other) { - if (s1.Year < s2.Year) - return true; - else if (s1.Year == s2.Year) - { - if (s1.Season == s2.Season && s1.Day <= s2.Day) - return true; - else if (s1.Season == "spring" && s2.Season != "spring") - return true; - if (s1.Season == "summer" && (s2.Season == "fall" || s2.Season == "winter")) - return true; - if (s1.Season == "fall" && s2.Season == "winter") - return true; - } - - return false; + return date?.GetHashCode() <= other?.GetHashCode(); } - /// - /// Greater than operator. Tests the date being greater than to each other - /// - /// The first date being compared - /// The second date being compared - /// If the dates are greater than - public static bool operator <(SDate s1, SDate s2) + /// Get whether one date is less than another. + /// The base date to compare. + /// The other date to compare. + public static bool operator <(SDate date, SDate other) { - if (s1.Year < s2.Year) - return true; - else if (s1.Year == s2.Year) - { - if (s1.Season == s2.Season && s1.Day < s2.Day) - return true; - else if (s1.Season == "spring" && s2.Season != "spring") - return true; - if (s1.Season == "summer" && (s2.Season == "fall" || s2.Season == "winter")) - return true; - if (s1.Season == "fall" && s2.Season == "winter") - return true; - } - - return false; + return date?.GetHashCode() < other?.GetHashCode(); } - /// - /// Overrides the equals function. - /// + /// Overrides the equals function. /// Object being compared. /// The equalaity of the object. public override bool Equals(object obj) { - return base.Equals(obj); + return obj is SDate other && this == other; } - /// - /// This returns the hashcode of the object - /// - /// The hashcode of the object. + /// Get a hash code which uniquely identifies a date. public override int GetHashCode() { - return base.GetHashCode(); + // return the number of days since 01 spring Y1 + int yearIndex = this.Year - 1; + return + yearIndex * this.DaysInSeason * this.SeasonsInYear + + this.GetSeasonIndex() * this.DaysInSeason + + this.Day; } + /********* ** Private methods *********/ + /// Get the current season index. + /// The current season wasn't recognised. + private int GetSeasonIndex() + { + int index = Array.IndexOf(this.Seasons, this.Season); + if (index == -1) + throw new InvalidOperationException($"The current season '{this.Season}' wasn't recognised."); + return index; + } + /// Get the real index in an array which should be treated as a two-way loop. /// The index in the looped array. /// The number of elements in the array. -- cgit