General refactorings

osu.Game.Tests/Visual/Collections/TestSceneCollectionDialog.cs

@@ -18,7 +18,7 @@ namespace osu.Game.Tests.Visual.Collections
         {
             Children = new Drawable[]
             {
-                new ManageCollectionDialog { State = { Value = Visibility.Visible } },
+                new ManageCollectionsDialog { State = { Value = Visibility.Visible } },
                 dialogOverlay = new DialogOverlay()
             };
         }

osu.Game/Collections/BeatmapCollection.cs

@@ -0,0 +1,47 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System;
+using osu.Framework.Bindables;
+using osu.Game.Beatmaps;
+
+namespace osu.Game.Collections
+{
+    /// <summary>
+    /// A collection of beatmaps grouped by a name.
+    /// </summary>
+    public class BeatmapCollection
+    {
+        /// <summary>
+        /// Invoked whenever any change occurs on this <see cref="BeatmapCollection"/>.
+        /// </summary>
+        public event Action Changed;
+
+        /// <summary>
+        /// The collection's name.
+        /// </summary>
+        public readonly Bindable<string> Name = new Bindable<string>();
+
+        /// <summary>
+        /// The beatmaps contained by the collection.
+        /// </summary>
+        public readonly BindableList<BeatmapInfo> Beatmaps = new BindableList<BeatmapInfo>();
+
+        /// <summary>
+        /// The date when this collection was last modified.
+        /// </summary>
+        public DateTimeOffset LastModifyDate { get; private set; } = DateTimeOffset.UtcNow;
+
+        public BeatmapCollection()
+        {
+            Beatmaps.CollectionChanged += (_, __) => onChange();
+            Name.ValueChanged += _ => onChange();
+        }
+
+        private void onChange()
+        {
+            LastModifyDate = DateTimeOffset.Now;
+            Changed?.Invoke();
+        }
+    }
+}

osu.Game/Collections/BeatmapCollectionManager.cs

@@ -21,7 +21,7 @@ namespace osu.Game.Collections
     public class BeatmapCollectionManager : CompositeDrawable
     {
         /// <summary>
-        /// Database version in YYYYMMDD format (matching stable).
+        /// Database version in stable-compatible YYYYMMDD format.
         /// </summary>
         private const int database_version = 30000000;
 
@@ -213,29 +213,4 @@ namespace osu.Game.Collections
             save();
         }
     }
-
-    public class BeatmapCollection
-    {
-        /// <summary>
-        /// Invoked whenever any change occurs on this <see cref="BeatmapCollection"/>.
-        /// </summary>
-        public event Action Changed;
-
-        public readonly Bindable<string> Name = new Bindable<string>();
-
-        public readonly BindableList<BeatmapInfo> Beatmaps = new BindableList<BeatmapInfo>();
-
-        public DateTimeOffset LastModifyTime { get; private set; }
-
-        public BeatmapCollection()
-        {
-            LastModifyTime = DateTimeOffset.UtcNow;
-
-            Beatmaps.CollectionChanged += (_, __) =>
-            {
-                LastModifyTime = DateTimeOffset.Now;
-                Changed?.Invoke();
-            };
-        }
-    }
 }

osu.Game/Collections/ManageCollectionsDialog.cs

@@ -13,7 +13,7 @@ using osuTK;
 
 namespace osu.Game.Collections
 {
-    public class ManageCollectionDialog : OsuFocusedOverlayContainer
+    public class ManageCollectionsDialog : OsuFocusedOverlayContainer
     {
         private const double enter_duration = 500;
         private const double exit_duration = 200;
@@ -21,7 +21,7 @@ namespace osu.Game.Collections
         [Resolved]
         private BeatmapCollectionManager collectionManager { get; set; }
 
-        public ManageCollectionDialog()
+        public ManageCollectionsDialog()
         {
             Anchor = Anchor.Centre;
             Origin = Anchor.Centre;

osu.Game/OsuGame.cs

@@ -618,7 +618,7 @@ namespace osu.Game
             loadComponentSingleFile(CreateUpdateManager(), Add, true);
 
             // overlay elements
-            loadComponentSingleFile(new ManageCollectionDialog(), overlayContent.Add, true);
+            loadComponentSingleFile(new ManageCollectionsDialog(), overlayContent.Add, true);
             loadComponentSingleFile(beatmapListing = new BeatmapListingOverlay(), overlayContent.Add, true);
             loadComponentSingleFile(dashboard = new DashboardOverlay(), overlayContent.Add, true);
             loadComponentSingleFile(news = new NewsOverlay(), overlayContent.Add, true);

osu.Game/Screens/Select/Carousel/DrawableCarouselBeatmap.cs

@@ -52,7 +52,7 @@ namespace osu.Game.Screens.Select.Carousel
         private BeatmapCollectionManager collectionManager { get; set; }
 
         [Resolved(CanBeNull = true)]
-        private ManageCollectionDialog manageCollectionDialog { get; set; }
+        private ManageCollectionsDialog manageCollectionsDialog { get; set; }
 
         private IBindable<StarDifficulty> starDifficultyBindable;
         private CancellationTokenSource starDifficultyCancellationSource;
@@ -227,9 +227,9 @@ namespace osu.Game.Screens.Select.Carousel
                 if (beatmap.OnlineBeatmapID.HasValue && beatmapOverlay != null)
                     items.Add(new OsuMenuItem("Details", MenuItemType.Standard, () => beatmapOverlay.FetchAndShowBeatmap(beatmap.OnlineBeatmapID.Value)));
 
-                var collectionItems = collectionManager.Collections.OrderByDescending(c => c.LastModifyTime).Take(3).Select(createCollectionMenuItem).ToList();
+                var collectionItems = collectionManager.Collections.OrderByDescending(c => c.LastModifyDate).Take(3).Select(createCollectionMenuItem).ToList();
-                if (manageCollectionDialog != null)
+                if (manageCollectionsDialog != null)
-                    collectionItems.Add(new OsuMenuItem("More...", MenuItemType.Standard, manageCollectionDialog.Show));
+                    collectionItems.Add(new OsuMenuItem("More...", MenuItemType.Standard, manageCollectionsDialog.Show));
 
                 items.Add(new OsuMenuItem("Add to...") { Items = collectionItems });
 

osu.Game/Screens/Select/Carousel/DrawableCarouselBeatmapSet.cs

@@ -39,7 +39,7 @@ namespace osu.Game.Screens.Select.Carousel
         private BeatmapCollectionManager collectionManager { get; set; }
 
         [Resolved(CanBeNull = true)]
-        private ManageCollectionDialog manageCollectionDialog { get; set; }
+        private ManageCollectionsDialog manageCollectionsDialog { get; set; }
 
         private readonly BeatmapSetInfo beatmapSet;
 
@@ -148,9 +148,9 @@ namespace osu.Game.Screens.Select.Carousel
                 if (dialogOverlay != null)
                     items.Add(new OsuMenuItem("Delete", MenuItemType.Destructive, () => dialogOverlay.Push(new BeatmapDeleteDialog(beatmapSet))));
 
-                var collectionItems = collectionManager.Collections.OrderByDescending(c => c.LastModifyTime).Take(3).Select(createCollectionMenuItem).ToList();
+                var collectionItems = collectionManager.Collections.OrderByDescending(c => c.LastModifyDate).Take(3).Select(createCollectionMenuItem).ToList();
-                if (manageCollectionDialog != null)
+                if (manageCollectionsDialog != null)
-                    collectionItems.Add(new OsuMenuItem("More...", MenuItemType.Standard, manageCollectionDialog.Show));
+                    collectionItems.Add(new OsuMenuItem("More...", MenuItemType.Standard, manageCollectionsDialog.Show));
 
                 items.Add(new OsuMenuItem("Add all to...") { Items = collectionItems });
 

osu.Game/Screens/Select/CollectionFilter.cs

@@ -3,21 +3,45 @@
 
 using System.Linq;
 using JetBrains.Annotations;
+using osu.Framework.Bindables;
 using osu.Game.Beatmaps;
 using osu.Game.Collections;
 
 namespace osu.Game.Screens.Select
 {
+    /// <summary>
+    /// A <see cref="BeatmapCollection"/> filter.
+    /// </summary>
     public class CollectionFilter
     {
+        /// <summary>
+        /// The collection to filter beatmaps from.
+        /// May be null to not filter by collection (include all beatmaps).
+        /// </summary>
         [CanBeNull]
         public readonly BeatmapCollection Collection;
 
+        /// <summary>
+        /// The name of the collection.
+        /// </summary>
+        [NotNull]
+        public readonly Bindable<string> CollectionName;
+
+        /// <summary>
+        /// Creates a new <see cref="CollectionFilter"/>.
+        /// </summary>
+        /// <param name="collection">The collection to filter beatmaps from.</param>
         public CollectionFilter([CanBeNull] BeatmapCollection collection)
         {
             Collection = collection;
+            CollectionName = Collection?.Name.GetBoundCopy() ?? new Bindable<string>("All beatmaps");
         }
 
+        /// <summary>
+        /// Whether the collection contains a given beatmap.
+        /// </summary>
+        /// <param name="beatmap">The beatmap to check.</param>
+        /// <returns>Whether <see cref="Collection"/> contains <paramref name="beatmap"/>.</returns>
         public virtual bool ContainsBeatmap(BeatmapInfo beatmap)
             => Collection?.Beatmaps.Any(b => b.Equals(beatmap)) ?? true;
     }

osu.Game/Screens/Select/CollectionFilterDropdown.cs

@@ -19,6 +19,9 @@ using osuTK;
 
 namespace osu.Game.Screens.Select
 {
+    /// <summary>
+    /// A dropdown to select the <see cref="CollectionFilter"/> to filter beatmaps using.
+    /// </summary>
     public class CollectionFilterDropdown : OsuDropdown<CollectionFilter>
     {
         private readonly IBindableList<BeatmapCollection> collections = new BindableList<BeatmapCollection>();
@@ -64,6 +67,7 @@ namespace osu.Game.Screens.Select
         /// </summary>
         private void filterChanged(ValueChangedEvent<CollectionFilter> filter)
         {
+            // Binding the beatmaps will trigger a collection change event, which results in an infinite-loop. This is rebound later, when it's safe to do so.
             beatmaps.CollectionChanged -= filterBeatmapsChanged;
 
             if (filter.OldValue?.Collection != null)
@@ -122,7 +126,7 @@ namespace osu.Game.Screens.Select
             private void updateBindable()
             {
                 collectionName.UnbindAll();
-                collectionName.BindTo(SelectedItem.Value.Collection?.Name ?? new Bindable<string>("All beatmaps"));
+                collectionName.BindTo(SelectedItem.Value.CollectionName);
                 collectionName.BindValueChanged(_ => updateText(), true);
             }
 
@@ -164,7 +168,7 @@ namespace osu.Game.Screens.Select
                 : base(item)
             {
                 collectionBeatmaps = Item.Collection?.Beatmaps.GetBoundCopy();
-                collectionName = Item.Collection?.Name.GetBoundCopy() ?? new Bindable<string>("All beatmaps");
+                collectionName = Item.CollectionName.GetBoundCopy();
             }
 
             [BackgroundDependencyLoader]

osu.Game/Screens/Select/FilterCriteria.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using JetBrains.Annotations;
 using osu.Game.Beatmaps;
 using osu.Game.Rulesets;
 using osu.Game.Screens.Select.Filter;
@@ -51,6 +52,10 @@ namespace osu.Game.Screens.Select
             }
         }
 
+        /// <summary>
+        /// The collection to filter beatmaps from.
+        /// </summary>
+        [CanBeNull]
         public CollectionFilter Collection;
 
         public struct OptionalRange<T> : IEquatable<OptionalRange<T>>