♻️Move extension methods to UnitInfo (#1579)

Extension methods on collections of a specific item type is not always
easy to read or reason about.

- Convert to static utility methods and move to `UnitInfo`, the type of
item the methods take.
- Change to `internal`

Author: angularsen

UnitsNet/CustomCode/QuantityInfo/QuantityInfoExtensions.cs

@@ -26,62 +26,6 @@ public static IEnumerable<QuantityInfo> GetQuantitiesWithBaseDimensions(this IEn
         return quantityInfos.Where(info => info.BaseDimensions.Equals(baseDimensions));
     }
 
-    /// <summary>
-    ///     Filters a collection of unit information based on the specified base units.
-    /// </summary>
-    /// <typeparam name="TUnitInfo">The type of the unit information.</typeparam>
-    /// <param name="unitInfos">The collection of unit information to filter.</param>
-    /// <param name="baseUnits">The base units to filter by.</param>
-    /// <returns>An <see cref="IEnumerable{T}" /> containing the unit information that matches the specified base units.</returns>
-    /// <exception cref="ArgumentNullException">Thrown when <paramref name="baseUnits" /> is null.</exception>
-    public static IEnumerable<TUnitInfo> GetUnitInfosFor<TUnitInfo>(this IEnumerable<TUnitInfo> unitInfos, BaseUnits baseUnits)
-        where TUnitInfo : UnitInfo
-    {
-        if (baseUnits is null)
-        {
-            throw new ArgumentNullException(nameof(baseUnits));
-        }
-
-        return unitInfos.Where(unitInfo => unitInfo.BaseUnits.IsSubsetOf(baseUnits));
-    }
-
-    /// <summary>
-    ///     Gets the <see cref="UnitInfo" /> whose <see cref="BaseUnits" /> is a subset of <paramref name="baseUnits" />.
-    /// </summary>
-    /// <example>
-    ///     Length.Info.GetUnitInfoFor(unitSystemWithFootAsLengthUnit) returns <see cref="UnitInfo" /> for
-    ///     <see cref="LengthUnit.Foot" />.
-    /// </example>
-    /// <param name="unitInfos">The collection of unit information to filter.</param>
-    /// <param name="baseUnits">The <see cref="BaseUnits" /> to check against.</param>
-    /// <returns>
-    ///     The <see cref="UnitInfo" /> that has <see cref="BaseUnits" /> that is a subset of
-    ///     <paramref name="baseUnits" />.
-    /// </returns>
-    /// <exception cref="ArgumentNullException"><paramref name="baseUnits" /> is null.</exception>
-    /// <exception cref="InvalidOperationException">No unit was found that is a subset of <paramref name="baseUnits" />.</exception>
-    /// <exception cref="InvalidOperationException">
-    ///     More than one unit was found that is a subset of
-    ///     <paramref name="baseUnits" />.
-    /// </exception>
-    public static TUnitInfo GetUnitInfoFor<TUnitInfo>(this IEnumerable<TUnitInfo> unitInfos, BaseUnits baseUnits)
-        where TUnitInfo : UnitInfo
-    {
-        using IEnumerator<TUnitInfo> enumerator = unitInfos.GetUnitInfosFor(baseUnits).GetEnumerator();
-        if (!enumerator.MoveNext())
-        {
-            throw new InvalidOperationException($"No unit was found that is a subset of {nameof(baseUnits)}");
-        }
-
-        TUnitInfo firstUnitInfo = enumerator.Current!;
-        if (enumerator.MoveNext())
-        {
-            throw new InvalidOperationException($"More than one unit was found that is a subset of {nameof(baseUnits)}");
-        }
-
-        return firstUnitInfo;
-    }
-    
     /// <summary>
     ///     Retrieves the default unit for a specified quantity and unit system.
     /// </summary>

UnitsNet/QuantityInfo.cs

@@ -70,7 +70,7 @@ public UnitInfo BaseUnitInfo
     {
         get => GetGenericBaseUnitInfo();
     }
-    
+
     /// <inheritdoc cref="BaseUnitInfo" />
     protected internal abstract UnitInfo GetGenericBaseUnitInfo();
 
@@ -93,13 +93,13 @@ public IReadOnlyList<UnitInfo> UnitInfos
     /// <inheritdoc />
     public UnitInfo GetUnitInfoFor(BaseUnits baseUnits)
     {
-        return UnitInfos.GetUnitInfoFor(baseUnits);
+        return UnitInfo.GetUnitWithBase(UnitInfos, baseUnits);
     }
 
     /// <inheritdoc />
     public IEnumerable<UnitInfo> GetUnitInfosFor(BaseUnits baseUnits)
     {
-        return UnitInfos.GetUnitInfosFor(baseUnits);
+        return UnitInfo.GetUnitsWithBase(UnitInfos, baseUnits);
     }
 
     /// <summary>
@@ -142,7 +142,7 @@ protected QuantityInfo(string name, Type quantityType, BaseDimensions baseDimens
     {
         get => GetBaseUnitInfo();
     }
-    
+
     /// <inheritdoc cref="BaseUnitInfo" />
     protected internal abstract UnitInfo<TUnit> GetBaseUnitInfo();
 
@@ -179,28 +179,28 @@ public UnitInfo<TUnit> this[TUnit unit]
     /// <returns>An <see cref="UnitInfo{TUnit}" /> instance containing information about the specified unit.</returns>
     /// <exception cref="ArgumentException">Thrown if the specified unit is not valid for this quantity.</exception>
     protected internal abstract UnitInfo<TUnit> GetUnitInfo(TUnit unit);
-    
+
     //  /// <inheritdoc cref="QuantityInfo.TryGetUnitInfo" />
     // public abstract bool TryGetUnitInfo(TUnit unit, [NotNullWhen(true)] out UnitInfo<TUnit>? unitInfo);
-    
+
     /// <inheritdoc cref="QuantityInfo.GetUnitInfoFor" />
     public new UnitInfo<TUnit> GetUnitInfoFor(BaseUnits baseUnits)
     {
-        return UnitInfos.GetUnitInfoFor(baseUnits);
+        return UnitInfo.GetUnitWithBase(UnitInfos, baseUnits);
     }
-    
+
     /// <inheritdoc cref="QuantityInfo.GetUnitInfosFor" />
     public new IEnumerable<UnitInfo<TUnit>> GetUnitInfosFor(BaseUnits baseUnits)
     {
-        return UnitInfos.GetUnitInfosFor(baseUnits);
+        return UnitInfo.GetUnitsWithBase(UnitInfos, baseUnits);
     }
-    
+
     /// <inheritdoc cref="QuantityInfo.From" />
     public IQuantity<TUnit> From(double value, TUnit unit)
     {
         return CreateGenericQuantity(value, unit);
     }
-    
+
     /// <inheritdoc cref="From(double,TUnit)" />
     protected internal abstract IQuantity<TUnit> CreateGenericQuantity(double value, TUnit unit);
 
@@ -286,7 +286,7 @@ protected QuantityInfoBase(string name, TQuantity zero, BaseDimensions baseDimen
 
     private QuantityFromDelegate<TQuantity, TUnit> FromDelegate { get; }
 
-    
+
     #region Implementation of IQuantityInfo<TQuantity, TUnit>
 
     /// <inheritdoc cref="IQuantityInfo.Zero" />
@@ -307,13 +307,13 @@ protected QuantityInfoBase(string name, TQuantity zero, BaseDimensions baseDimen
     /// <inheritdoc cref="IQuantityInfo.GetUnitInfosFor" />
     public new IEnumerable<TUnitInfo> GetUnitInfosFor(BaseUnits baseUnits)
     {
-        return UnitInfos.GetUnitInfosFor(baseUnits);
+        return UnitInfo.GetUnitsWithBase(UnitInfos, baseUnits);
     }
 
     /// <inheritdoc cref="IQuantityInfo.GetUnitInfoFor" />
     public new TUnitInfo GetUnitInfoFor(BaseUnits baseUnits)
     {
-        return UnitInfos.GetUnitInfoFor(baseUnits);
+        return UnitInfo.GetUnitWithBase(UnitInfos, baseUnits);
     }
 
     /// <summary>
@@ -334,7 +334,7 @@ TQuantity IQuantityInstanceInfo<TQuantity>.Create(double value, UnitKey unitKey)
     }
 
     #endregion
-    
+
     #region Overrides of QuantityInfo<TUnit>
 
     /// <inheritdoc />
@@ -393,9 +393,9 @@ public class QuantityInfo<TQuantity, TUnit> : QuantityInfoBase<TQuantity, TUnit,
 
     [DebuggerBrowsable(DebuggerBrowsableState.Never)]
     private readonly UnitInfo<TQuantity, TUnit>[] _unitInfos;
-    
+
     #if NET
-    
+
     /// <summary>
     ///     Initializes a new instance of the <see cref="QuantityInfo{TQuantity, TUnit}" /> class using the default quantity name.
     /// </summary>
@@ -413,7 +413,7 @@ public QuantityInfo(TUnit baseUnit, IEnumerable<IUnitDefinition<TUnit>> unitMapp
         : this(typeof(TQuantity).Name, baseUnit, unitMappings, baseDimensions, TQuantity.From, unitAbbreviations)
     {
     }
-    
+
     /// <summary>
     ///     Initializes a new instance of the <see cref="QuantityInfo{TQuantity, TUnit}" /> class.
     /// </summary>
@@ -432,7 +432,7 @@ public QuantityInfo(string name, TUnit baseUnit, IEnumerable<IUnitDefinition<TUn
         : this(name, baseUnit, unitMappings, TQuantity.From(0, baseUnit), baseDimensions, TQuantity.From, unitAbbreviations)
     {
     }
-    
+
     #endif
 
     /// <summary>
@@ -454,7 +454,7 @@ public QuantityInfo(TUnit baseUnit, IEnumerable<IUnitDefinition<TUnit>> unitMapp
         : this(typeof(TQuantity).Name, baseUnit, unitMappings, baseDimensions, fromDelegate, unitAbbreviations)
     {
     }
-    
+
     /// <summary>
     ///     Initializes a new instance of the <see cref="QuantityInfo{TQuantity, TUnit}" /> class.
     /// </summary>
@@ -554,7 +554,7 @@ public sealed override IReadOnlyList<UnitInfo<TQuantity, TUnit>> UnitInfos
     #endregion
 
     #region Explicit implementation of IQuantityInfo<TUnit>
-    
+
     // [DebuggerBrowsable(DebuggerBrowsableState.Never)]
     // IReadOnlyCollection<UnitInfo<TUnit>> IQuantityInfo<TUnit>.UnitInfos
     // {
@@ -605,13 +605,13 @@ public sealed override IReadOnlyList<UnitInfo<TQuantity, TUnit>> UnitInfos
     //     get => Zero;
     // }
 
-    
+
     // /// <inheritdoc />
     // TQuantity IQuantityInstanceInfo<TQuantity>.Create(QuantityValue value, UnitKey unitKey)
     // {
     //     return From(value, unitKey.ToUnit<TUnit>());
     // }
-    
+
     #endregion
 
     #region Implementation of IQuantityInfo<TQuantity,TUnit>

UnitsNet/UnitInfo.cs

@@ -1,9 +1,7 @@
 // Licensed under MIT No Attribution, see LICENSE file at the root.
 // Copyright 2013 Andreas Gullberg Larsen ([email protected]). Maintained at https://github.com/angularsen/UnitsNet.
 
-using System;
-using System.Diagnostics;
-using UnitsNet.Units;
+using System.Linq;
 
 namespace UnitsNet;
 
@@ -37,13 +35,13 @@ protected internal UnitInfo(IUnitDefinition mapping)
         PluralName = mapping.PluralName;
         BaseUnits = mapping.BaseUnits;
     }
-    
+
     /// <inheritdoc />
     public override string ToString()
     {
         return Name;
     }
-    
+
     #region Implementation of IUnitDefinition
 
     /// <inheritdoc />
@@ -70,7 +68,7 @@ public Enum Value
 
     /// <inheritdoc cref="Value" />
     protected abstract Enum GetUnitValue();
-    
+
     /// <summary>
     ///     Get the parent quantity information.
     /// </summary>
@@ -84,10 +82,10 @@ public QuantityInfo QuantityInfo
     {
         get => GetGenericInfo();
     }
-    
+
     /// <inheritdoc cref="QuantityInfo" />
     protected internal abstract QuantityInfo GetGenericInfo();
-    
+
     /// <summary>
     ///     Gets the unique key representing the unit type and its corresponding value.
     /// </summary>
@@ -96,7 +94,7 @@ public QuantityInfo QuantityInfo
     ///     as it avoids the boxing that would normally occur when casting the enum to <see cref="Enum" />.
     /// </remarks>
     public abstract UnitKey UnitKey { get; }
-    
+
     /// <summary>
     ///     Name of the quantity this unit belongs to.
     /// </summary>
@@ -106,7 +104,7 @@ public string QuantityName
     {
         get => QuantityInfo.Name;
     }
-    
+
     /// <summary>
     ///     Creates an instance of <see cref="IQuantity" /> from the specified <paramref name="value" />.
     /// </summary>
@@ -124,6 +122,63 @@ public IQuantity From(double value)
     protected internal abstract IQuantity CreateGenericQuantity(double value);
 
     #endregion
+
+    /// <summary>
+    ///     Filters a collection of unit information based on the specified base units.
+    /// </summary>
+    /// <typeparam name="TUnitInfo">The type of the unit information.</typeparam>
+    /// <param name="unitInfos">The collection of unit information to filter.</param>
+    /// <param name="baseUnits">The base units to filter by.</param>
+    /// <returns>An <see cref="IEnumerable{T}" /> containing the unit information that matches the specified base units.</returns>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="baseUnits" /> is null.</exception>
+    internal static IEnumerable<TUnitInfo> GetUnitsWithBase<TUnitInfo>(IEnumerable<TUnitInfo> unitInfos, BaseUnits baseUnits)
+        where TUnitInfo : UnitInfo
+    {
+        if (baseUnits is null)
+        {
+            throw new ArgumentNullException(nameof(baseUnits));
+        }
+
+        return unitInfos.Where(unitInfo => unitInfo.BaseUnits.IsSubsetOf(baseUnits));
+    }
+
+    /// <summary>
+    ///     Gets the <see cref="UnitInfo" /> whose <see cref="UnitsNet.BaseUnits" /> is a subset of <paramref name="baseUnits" />.
+    /// </summary>
+    /// <example>
+    ///     Length.Info.GetUnitInfoFor(unitSystemWithFootAsLengthUnit) returns <see cref="UnitInfo" /> for
+    ///     <see cref="LengthUnit.Foot" />.
+    /// </example>
+    /// <param name="unitInfos">The collection of unit information to filter.</param>
+    /// <param name="baseUnits">The <see cref="UnitsNet.BaseUnits" /> to check against.</param>
+    /// <returns>
+    ///     The <see cref="UnitInfo" /> that has <see cref="UnitsNet.BaseUnits" /> that is a subset of
+    ///     <paramref name="baseUnits" />.
+    /// </returns>
+    /// <exception cref="ArgumentNullException"><paramref name="baseUnits" /> is null.</exception>
+    /// <exception cref="InvalidOperationException">No unit was found that is a subset of <paramref name="baseUnits" />.</exception>
+    /// <exception cref="InvalidOperationException">
+    ///     More than one unit was found that is a subset of
+    ///     <paramref name="baseUnits" />.
+    /// </exception>
+    internal static TUnitInfo GetUnitWithBase<TUnitInfo>(IEnumerable<TUnitInfo> unitInfos, BaseUnits baseUnits)
+        where TUnitInfo : UnitInfo
+    {
+        using IEnumerator<TUnitInfo> enumerator = GetUnitsWithBase(unitInfos, baseUnits).GetEnumerator();
+
+        if (!enumerator.MoveNext())
+        {
+            throw new InvalidOperationException($"No unit was found that is a subset of {nameof(baseUnits)}");
+        }
+
+        TUnitInfo firstUnitInfo = enumerator.Current!;
+        if (enumerator.MoveNext())
+        {
+            throw new InvalidOperationException($"More than one unit was found that is a subset of {nameof(baseUnits)}");
+        }
+
+        return firstUnitInfo;
+    }
 }
 
 /// <inheritdoc cref="UnitInfo"/> />