feat: Incremental & streaming quotes, v3.0.0

.editorconfig

@@ -106,8 +106,9 @@ csharp_style_prefer_method_group_conversion = true:silent
 csharp_style_prefer_top_level_statements = true:silent
 csharp_style_prefer_primary_constructors = true:suggestion
 
-# Expression-bodied Members
+# Expression-bodied members
 csharp_style_expression_bodied_methods = true:silent
+csharp_style_expression_bodied_operators = true:silent
 csharp_style_expression_bodied_properties = true:silent
 csharp_style_expression_bodied_indexers = true:silent
 csharp_style_expression_bodied_accessors = true:silent
@@ -148,8 +149,7 @@ csharp_new_line_before_members_in_anonymous_types = false
 csharp_new_line_between_query_expression_clauses = false
 
 # Diagnostic analyzer suppressions
-dotnet_diagnostic.CA1303.severity  = none    # Passing literals as localized parameters
-dotnet_diagnostic.CA2263.severity  = none    # Prefer generic overload type parameter
-dotnet_diagnostic.CS1591.severity  = silent  # Missing XML comment for publicly visible type or member
-dotnet_diagnostic.IDE0058.severity = none    # Unused expression value
-dotnet_diagnostic.IDE0072.severity = silent  # Missing cases in switch statement
+dotnet_diagnostic.IDE0058.severity = none    # Unused expression value, use _ discard variable
+
+# remove this when no-longer supporting pre-9.0 frameworks
+dotnet_diagnostic.IDE0330.severity = none    # Prefer 'System.Threading.Lock'

.gitattributes

@@ -1,2 +1,2 @@
 # Normalize line endings.
-* text=lf
+* text=auto eol=lf

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -23,7 +23,7 @@ body:
       render: csharp
       placeholder: |
         // example (put your own code here)
-        IEnumerable<EmaResult> results = quotes.GetEma(14);
+        IReadOnlyList<EmaResult> results = quotes.GetEma(14);
     validations:
       required: false
   - type: textarea

.github/workflows/deploy-package.yml

@@ -34,6 +34,12 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: "9.x"
+          dotnet-quality: "ga"
+
       - name: Setup GitVersion
         uses: gittools/actions/gitversion/[email protected]
         with:
@@ -51,21 +57,8 @@ jobs:
       - name: Compose version
         id: compose
         run: |
-          ver=${{ steps.gitversion.outputs.majorMinorPatch }}${{ inputs.preview && '-preview.' || '' }}${{ inputs.preview && steps.gitversion.outputs.preReleaseNumber || inputs.preview && github.run_number || '' }}
-          echo "version=$ver" >> "$GITHUB_OUTPUT"
-
-      - name: Update release notes URL
-        uses: jacobtomlinson/gha-find-replace@v3
-        with:
-          find: "<PackageReleaseNotes>https://github.com/DaveSkender/Stock.Indicators/releases</PackageReleaseNotes>"
-          replace: "<PackageReleaseNotes>https://github.com/DaveSkender/Stock.Indicators/releases/tag/${{ steps.compose.outputs.version }}</PackageReleaseNotes>"
-          regex: false
-
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: "9.x"
-          dotnet-quality: "ga"
+          composed_version=${{ steps.gitversion.outputs.majorMinorPatch }}${{ inputs.preview && '-preview.' || '' }}${{ inputs.preview && steps.gitversion.outputs.preReleaseNumber || inputs.preview && github.run_number || '' }}
+          echo "version=$composed_version" >> "$GITHUB_OUTPUT"
 
       - name: Build library
         run: >

.github/workflows/test-examples.yml

@@ -2,12 +2,12 @@ name: Examples
 
 on:
   push:
-    branches: ["main"]
+    branches: ["main","v3"]
     paths:
       - docs/examples/**
 
   pull_request:
-    branches: ["main"]
+    branches: ["main","v3"]
     paths:
       - docs/examples/**
       - ".github/workflows/test-examples.yml"

.github/workflows/test-indicators.yml

@@ -2,7 +2,7 @@ name: Indicators
 
 on:
   push:
-    branches: ["main"]
+    branches: ["main","v3"]
 
   pull_request:
     types: [opened, synchronize, reopened]
@@ -21,16 +21,17 @@ jobs:
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
         dotnet-version: ["9.x"]
-        # TODO: restore when runners have 9.x on all
+        # TODO: restore when GitHub Action runners
+        #      have .NET 9.x SDK default installed
         # ["2.1.x", "6.x", "9.x"]
 
     env:
 
       # identifying primary configuration so only one reports coverage
       IS_PRIMARY: ${{ matrix.os == 'ubuntu-latest' && matrix.dotnet-version == '9.x' }}
 
-      # .NET SDK versions in the matrix that support `ga` quality spec
-      #   versions before 5.x do not support it
+      # .NET SDK versions in the matrix that support
+      # `dotnet-quality: 'ga'`, not supported before 5.x
       SUPPORT_GA: ${{ contains(fromJson('["6.x", "9.x"]'), matrix.dotnet-version) }}
 
     steps:
@@ -39,19 +40,11 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup .NET
-        id: dotnet-new
         uses: actions/setup-dotnet@v4
-        if: env.SUPPORT_GA == 'true'
         with:
           dotnet-version: ${{ matrix.dotnet-version }}
           dotnet-quality: "ga"
 
-      - name: Setup .NET (older)
-        uses: actions/setup-dotnet@v4
-        if: env.SUPPORT_GA == 'false'
-        with:
-          dotnet-version: ${{ matrix.dotnet-version }}
-
       - name: Build library
         run: >
           dotnet build
@@ -60,41 +53,29 @@ jobs:
           -warnAsError
 
       - name: Test indicators
-        env:
-          ALPACA_KEY: ${{ secrets.ALPACA_KEY }}
-          ALPACA_SECRET: ${{ secrets.ALPACA_SECRET }}
         run: >
-          dotnet test tests/indicators/Tests.Indicators.csproj
+          dotnet test
           --configuration Release
+          --settings tests/tests.unit.runsettings
+          --results-directory ./test-results
           --no-build
           --verbosity normal
           --logger trx
           --collect:"XPlat Code Coverage"
-          --results-directory ./test-indicators
 
       # the remaining steps are only needed from one primary instance
 
-      - name: Test other items
-        if: env.IS_PRIMARY == 'true'
-        run: >
-          dotnet test tests/other/Tests.Other.csproj
-          --configuration Release
-          --no-build
-          --verbosity normal
-          --logger trx
-          --results-directory ./test-other
-
       - name: Post test summary
         uses: dorny/test-reporter@v1
         if: env.IS_PRIMARY == 'true' && always()
         with:
           name: Test results
-          path: ./test-indicators/**/*.trx
+          path: ./test-results/**/*.trx
           reporter: dotnet-trx
 
       - name: Publish coverage to Codacy
         uses: codacy/codacy-coverage-reporter-action@v1
         if: env.IS_PRIMARY == 'true'
         with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
-          coverage-reports: ./test-indicators/**/coverage.cobertura.xml
+          coverage-reports: ./test-results/**/coverage.cobertura.xml

.github/workflows/test-integration.yml

@@ -0,0 +1,58 @@
+name: Indicators
+
+on:
+  push:
+    branches: ["main","v3"]
+
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  test:
+    name: integration tests
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      actions: read
+      checks: write
+
+    steps:
+
+      - name: Checkout source
+        uses: actions/checkout@v4
+
+      - name: Setup .NET
+        id: dotnet-new
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: "9.x"
+          dotnet-quality: "ga"
+
+      - name: Build library
+        run: >
+          dotnet build
+          --configuration Release
+          --property:ContinuousIntegrationBuild=true
+          -warnAsError
+
+      - name: Test integrations
+        env:
+          ALPACA_KEY: ${{ secrets.ALPACA_KEY }}
+          ALPACA_SECRET: ${{ secrets.ALPACA_SECRET }}
+        run: >
+          dotnet test
+          --configuration Release
+          --settings tests/tests.integration.runsettings
+          --results-directory ./test-results
+          --no-build
+          --verbosity normal
+          --logger trx
+
+      - name: Post test summary
+        uses: dorny/test-reporter@v1
+        if: always()
+        with:
+          name: Test results
+          path: ./test-results/**/*.trx
+          reporter: dotnet-trx

.github/workflows/test-performance.yml

@@ -42,12 +42,29 @@ jobs:
           --configuration Release
           --property:ContinuousIntegrationBuild=true
 
-      - name: Benchmark indicators
+      - name: Test performance
         working-directory: tests/performance
         run: dotnet run -c Release
 
+      - name: Save test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-summaries
+          path: tests/performance/BenchmarkDotNet.Artifacts/results
+
       - name: Publish summary
         working-directory: tests/performance/BenchmarkDotNet.Artifacts/results
         run: |
           echo "### Package version ${{ steps.gitversion.outputs.fullSemVer }}" >> $GITHUB_STEP_SUMMARY
-          cat Tests.Performance.IndicatorPerformance-report-github.md >> $GITHUB_STEP_SUMMARY
+
+          echo "## Series indicators" >> $GITHUB_STEP_SUMMARY
+          cat Performance.SeriesIndicators-report-github.md >> $GITHUB_STEP_SUMMARY
+
+          echo "## Stream indicators (with Quote caching)" >> $GITHUB_STEP_SUMMARY
+          cat Performance.StreamIndicators-report-github.md >> $GITHUB_STEP_SUMMARY
+
+          echo "## Incrementing buffer-style indicators" >> $GITHUB_STEP_SUMMARY
+          cat Performance.BufferLists-report-github.md >> $GITHUB_STEP_SUMMARY
+
+          echo "## Utilities" >> $GITHUB_STEP_SUMMARY
+          cat Performance.Utility-report-github.md >> $GITHUB_STEP_SUMMARY

.github/workflows/test-website-a11y.yml

@@ -1,8 +1,10 @@
 name: Website
 
 on:
+  push:
+    branches: ["v3"]
   pull_request:
-    branches: [main]
+    branches: ["main"]
     paths:
       - 'docs/**'
       - ".github/workflows/test-website-a11y.yml"

.github/workflows/test-website-links.yml

@@ -1,8 +1,10 @@
 name: Website
 
 on:
+  push:
+    branches: ["v3"]
   pull_request:
-    branches: [main]
+    branches: ["main"]
     paths:
       - 'docs/**'
       - ".github/workflows/test-website-links.yml"

.gitignore

@@ -111,12 +111,13 @@ $tf/
 # Guidance Automation Toolkit
 *.gpState
 
-# ReSharper is a .NET coding add-in
+# ReSharper IDE extension
 _ReSharper*/
 *.[Rr]e[Ss]harper
 *.DotSettings.user
+*.DotSettings
 
-# JustCode is a .NET coding add-in
+# JustCode IDE extension
 .JustCode
 
 # TeamCity is a build add-in
@@ -218,7 +219,7 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk 
+# Including strong name files can present a security risk
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
@@ -314,7 +315,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output 
+# Azure Stream Analytics local run output
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
@@ -323,11 +324,11 @@ ASALocalRun/
 # NVidia Nsight GPU debugger configuration file
 *.nvuser
 
-# MFractors (Xamarin productivity tool) working folder 
+# MFractors (Xamarin productivity tool) working folder
 .mfractor/
 
 # Jekyll site
 _site/
 
 # zip artifacts
-.DS_Store
+.DS_Store

.vscode/extensions.json

@@ -0,0 +1,12 @@
+{
+    "recommendations": [
+        "codacy-app.codacy",
+        "adrianwilczynski.user-secrets",
+        "github.vscode-github-actions",
+        "github.vscode-pull-request-github",
+        "mechatroner.rainbow-csv",
+        "dotjoshjohnson.xml",
+        "redhat.vscode-yaml",
+        "vunguyentuan.vscode-css-variables"
+    ]
+}