code analysis fixes (#970)

* remove List from public API
* code cleanup (general)

Author: DaveSkender

.editorconfig

@@ -90,7 +90,7 @@ dotnet_diagnostic.IDE0071.severity=suggestion
 dotnet_diagnostic.IDE0047.severity=suggestion
 csharp_indent_labels = no_change
 csharp_prefer_simple_using_statement = true:suggestion
-csharp_prefer_braces = true:silent
+csharp_prefer_braces = true:suggestion
 csharp_style_prefer_method_group_conversion = true:silent
 csharp_style_expression_bodied_methods = true:suggestion
 csharp_style_expression_bodied_constructors = false:suggestion
@@ -143,7 +143,7 @@ dotnet_style_allow_statement_immediately_after_block_experimental= false:silent
 
 # Naming rules
 
-dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
+dotnet_naming_rule.interface_should_be_begins_with_i.severity = warning
 dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
 dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
 

.github/build.main.yml

@@ -9,7 +9,7 @@ pool:
   vmImage: "ubuntu-latest"
 
 workspace:
-    clean: all
+  clean: all
 
 variables:
   BuildConfiguration: "Release"
@@ -18,34 +18,43 @@ steps:
   - task: gitversion/setup@0
     displayName: use GitVersion 5.x
     inputs:
-      versionSpec: '5.x'
+      versionSpec: "5.x"
 
   - task: gitversion/execute@0
     displayName: get GitVersion
     inputs:
       useConfigFile: true
-      configFilePath: 'gitversion.yml'
+      configFilePath: "gitversion.yml"
       updateAssemblyInfo: true
 
   - task: UseDotNet@2
     displayName: "use .NET SDK 7.0.x"
     inputs:
       version: 7.0.x
-      includePreviewVersions: true
+      includePreviewVersions: false
 
   - task: DotNetCoreCLI@2
     displayName: build
     inputs:
+      command: "build"
       projects: "**/*.csproj"
-      arguments: "--configuration $(BuildConfiguration) /p:Version=$(GitVersion.NuGetVersion) /p:ContinuousIntegrationBuild=true"
+      arguments: >
+        --configuration $(BuildConfiguration)
+        /p:Version=$(GitVersion.NuGetVersion)
+        /p:ContinuousIntegrationBuild=true
+        /warnaserror
 
   - task: DotNetCoreCLI@2
     displayName: "test indicators"
     inputs:
       command: test
       testRunTitle: "Indicator Tests"
       projects: "tests/indicators/Tests.Indicators.csproj"
-      arguments: '--configuration $(BuildConfiguration) --no-restore --no-build --collect:"XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=cobertura'
+      arguments: >
+        --configuration $(BuildConfiguration)
+        --no-restore
+        --no-build
+        --collect:"XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=cobertura
       publishTestResults: true
 
   - task: DotNetCoreCLI@2
@@ -54,7 +63,11 @@ steps:
       command: test
       testRunTitle: "External Tests"
       projects: "tests/external/Tests.Other.csproj"
-      arguments: "--configuration $(BuildConfiguration) --no-restore --no-build /p:CollectCoverage=false"
+      arguments: >
+        --configuration $(BuildConfiguration)
+        --no-restore
+        --no-build
+        /p:CollectCoverage=false
       publishTestResults: true
 
   - task: PublishCodeCoverageResults@1
@@ -87,6 +100,6 @@ steps:
   - task: PublishPipelineArtifact@1
     displayName: "save artifacts"
     inputs:
-      targetPath: '$(Pipeline.Workspace)/a'
-      artifact: 'packages'
-      publishLocation: 'pipeline'
+      targetPath: "$(Pipeline.Workspace)/a"
+      artifact: "packages"
+      publishLocation: "pipeline"

.vscode/settings.json

@@ -47,6 +47,7 @@
     "chandeliertype",
     "chartable",
     "chikou",
+    "Cobertura",
     "daveskender",
     "Dema",
     "Detrended",
@@ -93,6 +94,8 @@
     "Mrkt",
     "Mulloy",
     "Munehisa",
+    "nobuild",
+    "nupkg",
     "Quong",
     "Renko",
     "Schaff",
@@ -101,6 +104,7 @@
     "Siepman",
     "Skender",
     "Smma",
+    "snupkg",
     "Soudack",
     "Starc",
     "Stoch",
@@ -116,6 +120,7 @@
     "Vitali",
     "Vwap",
     "Vwma",
+    "warnaserror",
     "Woodie"
   ],
   "cSpell.ignorePaths": [

docs/guide.md

@@ -61,7 +61,8 @@ using Skender.Stock.Indicators;
 IEnumerable<Quote> quotes = GetHistoryFromFeed("MSFT");
 
 // calculate 20-period SMA
-IEnumerable<SmaResult> results = quotes.GetSma(20);
+IEnumerable<SmaResult> results = quotes
+  .GetSma(20);
 
 // use results as needed for your use case (example only)
 foreach (SmaResult r in results)

docs/performance.md

@@ -30,11 +30,11 @@ var results = quotes
 
 ### Using tuple quotes
 
-`quotes.ToTuple()` is a method for converting any `TQuote` collection to a simple [tuple](https://docs.microsoft.com/dotnet/csharp/language-reference/builtin-types/value-tuples) `(DateTime, double)` formatted `List`.  Most indicators in our library will accept this tuple format.  With that said, there are many indicators that also require the full OHLCV quote format, so it cannot be used universally.
+`quotes.ToTupleCollection()` is a method for converting any `TQuote` collection to a simple [tuple](https://docs.microsoft.com/dotnet/csharp/language-reference/builtin-types/value-tuples) `(DateTime, double)` formatted `Collection`.  Most indicators in our library will accept this tuple format.  With that said, there are many indicators that also require the full OHLCV quote format, so it cannot be used universally.
 
 ### Sort quotes
 
-`quotes.ToSortedList()` sorts any collection of `TQuote` or tuple `(DateTime, double)` and returns it as a `List` sorted by ascending `Date`.  You do not need to sort quotes before using library indicators; however, if you are creating [custom indicators]({{site.baseurl}}/custom-indicators/#content) it's important to analyze `quotes` in a proper sequence.
+`quotes.ToSortedCollection()` sorts any collection of `TQuote` or tuple `(DateTime, double)` and returns it as a `Collection` sorted by ascending `Date`.  You do not need to sort quotes before using library indicators; however, if you are creating [custom indicators]({{site.baseurl}}/custom-indicators/#content) it's important to analyze `quotes` in a proper sequence.
 
 ### Resize quote history
 
@@ -156,7 +156,7 @@ See [individual indicator pages]({{site.baseurl}}/indicators/#content) for infor
 
 ### Using tuple results
 
-`results.ToTuple(nullTo)` is a method for converting results collections to a simpler `(DateTime Date, double? Value)` formatted [tuple](https://docs.microsoft.com/dotnet/csharp/language-reference/builtin-types/value-tuples) `List`.
+`results.ToTupleCollection(nullTo)` is a method for converting results collections to a simpler `(DateTime Date, double? Value)` formatted [tuple](https://docs.microsoft.com/dotnet/csharp/language-reference/builtin-types/value-tuples) `Collection`.
 
 This is not required in normal use; however, the last option may be useful for users who create [custom indicators]({{site.baseurl}}/custom-indicators/#content).
 
@@ -173,7 +173,7 @@ A few options to consider:
 
 ### Sort results
 
-`results.ToSortedList()` sorts any collection of indicator results and returns it as a `List` sorted by ascending `Date`.  Results from the library indicators are already sorted, so you'd only potentially need this if you're creating [custom indicators]({{site.baseurl}}/custom-indicators/#content).
+`results.ToSortedCollection()` sorts any collection of indicator results and returns it as a `Collection` sorted by ascending `Date`.  Results from the library indicators are already sorted, so you'd only potentially need this if you're creating [custom indicators]({{site.baseurl}}/custom-indicators/#content).
 
 ## Utilities for numerical analysis
 

docs/utilities.md

@@ -1,13 +1,18 @@
 namespace Skender.Stock.Indicators;
 
-public static class Numerics
+public static class Numerix
 {
     // STANDARD DEVIATION
     public static double StdDev(this double[] values)
     {
         // ref: https://stackoverflow.com/questions/2253874/standard-deviation-in-linq
         // and then modified to an iterative model without LINQ, for performance improvement
 
+        if (values is null)
+        {
+            throw new ArgumentNullException(nameof(values), "StdDev values cannot be null.");
+        }
+
         double sd = 0;
         int n = values.Length;
         if (n > 1)
@@ -36,9 +41,23 @@ public static double StdDev(this double[] values)
     // SLOPE of BEST FIT LINE
     public static double Slope(double[] x, double[] y)
     {
-        // TODO: add better error handling for mismatch size arrays
+        // validate parameters
+        if (x is null)
+        {
+            throw new ArgumentNullException(nameof(x), "Slope X values cannot be null.");
+        }
+
+        if (y is null)
+        {
+            throw new ArgumentNullException(nameof(y), "Slope Y values cannot be null.");
+        }
+
+        if (x.Length != y.Length)
+        {
+            throw new ArgumentException("Slope X and Y arrays must be the same size.");
+        }
 
-        int length = Math.Min(x.Length, y.Length);
+        int length = x.Length;
 
         // get averages for period
         double sumX = 0;

src/_common/Numerics.cs src/_common/Numerix.cssrc/_common/Numerics.cs renamed to src/_common/Numerix.cs

@@ -5,6 +5,8 @@ namespace Skender.Stock.Indicators;
 // OBSOLETE IN v2.0.0
 public static partial class Indicator
 {
+#pragma warning disable CA1002 // Do not expose generic lists
+
     // 2.4.1
     [ExcludeFromCodeCoverage]
     [Obsolete("Rename 'ToBasicTuple(..)' to 'ToTuple(..)' to fix.", false)]
@@ -19,4 +21,6 @@ public static partial class Indicator
     public static List<(DateTime Date, double Value)> ToResultTuple(
         this IEnumerable<IReusableResult> basicData)
         => basicData.ToTuple();
+
+#pragma warning restore CA1002 // Do not expose generic lists
 }

src/_common/ObsoleteV2.cs

@@ -1,3 +1,4 @@
+using System.Collections.ObjectModel;
 using System.Globalization;
 
 namespace Skender.Stock.Indicators;
@@ -20,7 +21,7 @@ public static partial class QuoteUtility
             .Select(x => x.ToTuple(candlePart));
 
     // sort quotes
-    public static List<TQuote> ToSortedList<TQuote>(
+    internal static List<TQuote> ToSortedList<TQuote>(
         this IEnumerable<TQuote> quotes)
         where TQuote : IQuote => quotes
             .OrderBy(x => x.Date)
@@ -29,7 +30,15 @@ public static List<TQuote> ToSortedList<TQuote>(
     // TUPLE QUOTES
 
     // convert quotes to tuple list
-    public static List<(DateTime, double)> ToTuple<TQuote>(
+    public static Collection<(DateTime, double)> ToTupleCollection<TQuote>(
+        this IEnumerable<TQuote> quotes,
+        CandlePart candlePart)
+        where TQuote : IQuote
+        => quotes
+            .ToTuple(candlePart)
+            .ToCollection();
+
+    internal static List<(DateTime, double)> ToTuple<TQuote>(
         this IEnumerable<TQuote> quotes,
         CandlePart candlePart)
         where TQuote : IQuote => quotes
@@ -38,8 +47,15 @@ public static List<TQuote> ToSortedList<TQuote>(
             .ToList();
 
     // convert tuples to list, with sorting
-    public static List<(DateTime, double)> ToSortedList(
-        this IEnumerable<(DateTime date, double value)> tuples) => tuples
+    public static Collection<(DateTime, double)> ToSortedCollection(
+        this IEnumerable<(DateTime date, double value)> tuples)
+        => tuples
+            .ToSortedList()
+            .ToCollection();
+
+    internal static List<(DateTime, double)> ToSortedList(
+        this IEnumerable<(DateTime date, double value)> tuples)
+        => tuples
             .OrderBy(x => x.date)
             .ToList();
 

src/_common/Quotes/Quote.Converters.cs

@@ -1,3 +1,5 @@
+using System.Collections.ObjectModel;
+
 namespace Skender.Stock.Indicators;
 
 // HELPER FUNCTIONS
@@ -34,7 +36,7 @@ public static IEnumerable<TResult> Condense<TResult>(
         List<TResult> resultsList = results
             .ToList();
 
-        _ = resultsList
+        resultsList
             .RemoveAll(match:
                 x => x.Value is null or (double and double.NaN));
 
@@ -126,14 +128,20 @@ public static IEnumerable<TResultR> SyncIndex<TResultR, TResultM>(
                 }
             }
 
-            _ = resultsList.RemoveAll(x => toRemove.Contains(x));
+            resultsList.RemoveAll(x => toRemove.Contains(x));
         }
 
         return resultsList.ToSortedList();
     }
 
     // CONVERT TO TUPLE (default with pruning)
-    public static List<(DateTime Date, double Value)> ToTuple(
+    public static Collection<(DateTime Date, double Value)> ToTupleCollection(
+        this IEnumerable<IReusableResult> reusable)
+        => reusable
+            .ToTuple()
+            .ToCollection();
+
+    internal static List<(DateTime Date, double Value)> ToTuple(
         this IEnumerable<IReusableResult> reusable)
     {
         List<(DateTime date, double value)> prices = new();
@@ -152,7 +160,7 @@ public static IEnumerable<TResultR> SyncIndex<TResultR, TResultM>(
     }
 
     // CONVERT TO TUPLE with nullable value option and no pruning
-    public static List<(DateTime Date, double? Value)> ToTuple(
+    internal static List<(DateTime Date, double? Value)> ToTuple(
         this IEnumerable<IReusableResult> reusable,
         NullTo nullTo)
     {
@@ -170,9 +178,17 @@ public static IEnumerable<TResultR> SyncIndex<TResultR, TResultM>(
     }
 
     // RETURN SORTED LIST of RESULTS
-    public static List<TResult> ToSortedList<TResult>(
+    public static Collection<TResult> ToSortedCollection<TResult>(
         this IEnumerable<TResult> results)
-        where TResult : IResult => results
+        where TResult : IResult
+        => results
+            .ToSortedList()
+            .ToCollection();
+
+    internal static List<TResult> ToSortedList<TResult>(
+        this IEnumerable<TResult> results)
+        where TResult : IResult
+        => results
             .OrderBy(x => x.Date)
             .ToList();