Merge pull request #16 from Crequency/dev=main

Dynesshely · web-flow · commit c3b549f94311 · 2023-09-02T21:03:14.000+08:00
[Pull Request] Improvements under `Math` and `Graphics` namespace
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: [Crequency, Dynesshely] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+# github: [Crequency, Dynesshely] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 
 # patreon: # Replace with a single Patreon username
 # open_collective: # Replace with a single Open Collective username
diff --git a/.github/workflows/auto-release.yml b/.github/workflows/auto-release.yml
@@ -50,7 +50,7 @@ jobs:
       uses: softprops/action-gh-release@v1
       with:
         tag_name: v${{ env.version }}
-        name: Daily Release v${{ env.version }}
+        name: Weekly Release v${{ env.version }}
         body: Auto release by Actions.
         draft: false
         prerelease: true
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -48,18 +48,18 @@ jobs:
           dotnet test -c Release
 
       - name: Add to GitHub Repo
-        if: ${{ matrix.os == 'ubuntu-latest' }}
+        if: ${{ matrix.os == 'ubuntu-latest' && github.event_name != 'pull_request' }}
         run: |
           nuget sources add -name github -Source https://nuget.pkg.github.com/Crequency/index.json -Username Crequency -Password ${{ secrets.GitHubToken }}
 
       - name: Install NuGet
-        if: ${{ matrix.os == 'ubuntu-latest' }}
+        if: ${{ matrix.os == 'ubuntu-latest' && github.event_name != 'pull_request' }}
         uses: nuget/setup-nuget@v1
         with:
           nuget-version: "6.x"
 
       - name: Publish Package to GitHub and NuGet
-        if: ${{ matrix.os == 'ubuntu-latest' }}
+        if: ${{ matrix.os == 'ubuntu-latest' && github.event_name != 'pull_request' }}
         run: |
-          nuget push ./Common.BasicHelper/bin/Release/*.nupkg -Source https://api.nuget.org/v3/index.json -SkipDuplicate -ApiKey ${{ secrets.NugetKey }} -NoSymbol
-          nuget push ./Common.BasicHelper/bin/Release/*.nupkg -Source github -SkipDuplicate
+          nuget push ./Common.BasicHelper/bin/Release/*.nupkg -Source github -SkipDuplicate -Verbosity detailed
+          nuget push ./Common.BasicHelper/bin/Release/*.nupkg -Source https://api.nuget.org/v3/index.json -SkipDuplicate -ApiKey ${{ secrets.NugetKey }} -NoSymbol -Verbosity detailed
diff --git a/.gitlab/merge_request_templates/default.md b/.gitlab/merge_request_templates/default.md
@@ -1,4 +1,4 @@
-## What does this PR do?
+## What does this MR do?
 
 <!-- Briefly describe what this PR is about -->
 
diff --git a/Common.BasicHelper.Samples/Program.cs b/Common.BasicHelper.Samples/Program.cs
@@ -1,4 +1,5 @@
 ﻿using Common.BasicHelper.Core.Shell;
+using Common.BasicHelper.Graphics.Screen;
 using Common.BasicHelper.Utils.Extensions;
 using System.Web;
 
@@ -20,19 +21,32 @@
 
 app.UseHttpsRedirection();
 
+static bool parameterNullCheck(string? param, string? name = null)
+{
+    return param == "," || param == $"{{{name}}}" || param.IsNullOrWhiteSpace();
+}
+
+app.MapGet("/", () => Results.Redirect("/swagger/index.html"));
+
+app.MapGet("/Graphics/Screen/Resolution/Parse/{resolution}.{descr?}",
+    (string resolution, string? descr) => Resolution.Parse(
+        resolution, parameterNullCheck(descr, nameof(descr)) ? null : descr
+    )
+)
+.WithName("ParseSolution")
+.WithOpenApi();
+
 app.MapGet("/Utils/Extensions/StringHelper/ExecuteAsCommand/{cmd}.{args?}",
     (string cmd, string? args) => cmd.ExecuteAsCommand(
-        args == "," || args == "{args}" || args.IsNullOrWhiteSpace()
-        ? null : HttpUtility.UrlDecode(args)
+        parameterNullCheck(args, nameof(args)) ? null : HttpUtility.UrlDecode(args)
     )
 )
 .WithName("ExecuteAsCommand")
 .WithOpenApi();
 
 app.MapGet("/Utils/Extensions/StringHelper/ExecuteAsCommandAsync/{cmd}.{args?}",
     async (string cmd, string? args) => await cmd.ExecuteAsCommandAsync(
-        args == "," || args == "{args}" || args.IsNullOrWhiteSpace()
-        ? null : HttpUtility.UrlDecode(args)
+        parameterNullCheck(args, nameof(args)) ? null : HttpUtility.UrlDecode(args)
     )
 )
 .WithName("ExecuteAsCommandAsync")
diff --git a/Common.BasicHelper.Test/Math/Expression_Tests.cs b/Common.BasicHelper.Test/Math/Expression_Tests.cs
@@ -47,4 +47,49 @@ public void Test_Expression()
 
         Assert.AreEqual(expr, tree.Result);
     }
+
+    [TestMethod()]
+    public void Test_ToString()
+    {
+        var expr = "(39 / 3) + (16 * 5) - ((24 ** 2) + 5 + 7)";
+
+        var tree = new Expression()
+        {
+            Type = CalculationType.Add,
+            Left = new()
+            {
+                Type = CalculationType.Division,
+                Left = Expression.FromValue(39),
+                Right = Expression.FromValue(3)
+            },
+            Right = new()
+            {
+                Type = CalculationType.Substraction,
+                Left = new()
+                {
+                    Type = CalculationType.Multiply,
+                    Left = Expression.FromValue(16),
+                    Right = Expression.FromValue(5),
+                },
+                Right = new()
+                {
+                    Type = CalculationType.Add,
+                    Left = new()
+                    {
+                        Type = CalculationType.Power,
+                        Left = Expression.FromValue(24),
+                        Right = Expression.FromValue(2)
+                    },
+                    Right = new()
+                    {
+                        Type = CalculationType.Add,
+                        Left = Expression.FromValue(5),
+                        Right = Expression.FromValue(7)
+                    }
+                }
+            }
+        };
+
+        Assert.AreEqual(expr, tree.ToString());
+    }
 }
diff --git a/Common.BasicHelper/Graphics/Screen/Resolution.cs b/Common.BasicHelper/Graphics/Screen/Resolution.cs
@@ -2,6 +2,7 @@
 using Common.BasicHelper.Utils.Extensions;
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace Common.BasicHelper.Graphics.Screen;
 
@@ -50,10 +51,10 @@ public class Resolution
 
     public double? AspectRatio => Width / Height;
 
-    public string Description { get; set; } = string.Empty;
+    public string? Description { get; set; }
 
     /// <summary>
-    /// 宽高整数化
+    /// Integerize width and height
     /// </summary>
     public Resolution Integerization()
     {
@@ -65,10 +66,10 @@ public Resolution Integerization()
     }
 
     /// <summary>
-    /// 根据字符串返回分辨率对象
+    /// Returns a resolution object based on a string
     /// </summary>
-    /// <param name="input">字符串: 宽x高@刷新率</param>
-    /// <returns>分辨率对象</returns>
+    /// <param name="input">Format: {Width}x{Height}@{FPS}</param>
+    /// <returns>Resolution object</returns>
     public static Resolution Parse(string input)
     {
         var res_fps = input.Split('@');
@@ -77,7 +78,7 @@ public static Resolution Parse(string input)
         var resolution = new Resolution
         {
             Width = Convert.ToDouble(res[0]),
-            Height = Convert.ToDouble(res[1])
+            Height = Convert.ToDouble(res[1]),
         };
 
         if (res_fps.Length == 2) resolution.FramePerSecond = Convert.ToDouble(res_fps[1]);
@@ -87,27 +88,30 @@ public static Resolution Parse(string input)
     }
 
     /// <summary>
-    /// 根据字符串返回分辨率对象
+    /// Returns a resolution object based on a string
     /// </summary>
-    /// <param name="input">字符串: 宽x高@刷新率</param>
-    /// <param name="descr">字符串: 描述信息</param>
-    /// <returns>分辨率对象</returns>
-    public static Resolution Parse(string input, string descr)
+    /// <param name="input">Format: {Width}x{Height}@{FPS}</param>
+    /// <param name="descr">Description</param>
+    /// <returns>Resolution object</returns>
+    public static Resolution Parse(string input, string? descr = null)
     {
         var resolution = Parse(input);
 
-        resolution.Description = descr;
+        if (descr is null)
+            resolution.Description = resolutions.FirstOrDefault((x) => x.Equals(resolution))?.Description;
+        else
+            resolution.Description = descr;
 
         return resolution;
     }
 
     /// <summary>
-    /// 建议分辨率
+    /// Suggest content resolution
     /// </summary>
-    /// <param name="screen">理想屏幕</param>
-    /// <param name="content">理想内容</param>
-    /// <param name="actual">实际屏幕</param>
-    /// <returns>建议的内容尺寸</returns>
+    /// <param name="screen">Target screen resolution</param>
+    /// <param name="content">Target content resolution</param>
+    /// <param name="actual">Actual screen resolution</param>
+    /// <returns>Suggested content resolution</returns>
     public static Resolution Suggest(Resolution screen, Resolution content, Resolution actual)
     {
         //  理想内容面积与理想屏幕面积之比
@@ -145,20 +149,8 @@ public static Resolution Suggest(Resolution screen, Resolution content, Resoluti
         return suggest;
     }
 
-    /// <summary>
-    /// 重载运算符: 除法
-    /// </summary>
-    /// <param name="a">分辨率1</param>
-    /// <param name="b">分辨率2</param>
-    /// <returns>面积之比</returns>
     public static double? operator /(Resolution a, Resolution b) => a.Area / b.Area;
 
-    /// <summary>
-    /// 重载运算符: 加法
-    /// </summary>
-    /// <param name="a">分辨率1</param>
-    /// <param name="b">分辨率2</param>
-    /// <returns>分辨率</returns>
     public static Resolution operator +(Resolution a, Resolution b) => new()
     {
         Width = a.Width + b.Width,
@@ -167,40 +159,19 @@ public static Resolution Suggest(Resolution screen, Resolution content, Resoluti
         Description = $"{a.Description}\nPlus\n{b.Description}"
     };
 
-    /// <summary>
-    /// 重写 ToString() 方法
-    /// </summary>
-    /// <returns>表示分辨率及刷新率的字符串</returns>
     public override string ToString() =>
         $"{Width}x{Height}{(FramePerSecond is null ? "" : "@")}{FramePerSecond}";
 
-    /// <summary>
-    /// 重写 Equals() 方法
-    /// </summary>
-    /// <param name="obj">目标比较分辨率</param>
-    /// <returns>是否相等</returns>
     public override bool Equals(object obj)
     {
         if (obj is not Resolution)
             ErrorCodes.CB0017.BuildMessage(parameterName: nameof(Equals)).Throw<ArgumentException>();
 
-        return GetHashCode() == obj.GetHashCode();
+        var target = obj as Resolution;
 
-        //if (obj is not Resolution res) return false;
-
-        //if (Width.Equals(res.Width) && Height.Equals(res.Height))
-        //    if (FramePerSecond != null && res.FramePerSecond != null)
-        //        if (FramePerSecond.Equals(res.FramePerSecond))
-        //            return true;
-        //        else return false;
-        //    else return true;
-        //else return false;
+        return Width == target?.Width && Height == target?.Height && FramePerSecond == target?.FramePerSecond;
     }
 
-    /// <summary>
-    /// 重写 GetHashCode() 方法
-    /// </summary>
-    /// <returns>哈希值</returns>
     public override int GetHashCode() => (int)(
         0
         + (Area.GetHashCode() ^ AspectRatio.GetHashCode())
diff --git a/Common.BasicHelper/Math/Expression.cs b/Common.BasicHelper/Math/Expression.cs
@@ -1,3 +1,5 @@
+using System.Collections.Generic;
+
 namespace Common.BasicHelper.Math;
 
 public enum CalculationType
@@ -16,9 +18,33 @@ public class Expression
 
     public CalculationType Type { get => type; set => type = value; }
 
-    public Expression? Left { get; set; }
+    public Expression? Parent { get; set; }
+
+    private Expression? left;
 
-    public Expression? Right { get; set; }
+    public Expression? Left
+    {
+        get => left;
+        set
+        {
+            left = value;
+            if (left is not null)
+                left!.Parent = this;
+        }
+    }
+
+    private Expression? right;
+
+    public Expression? Right
+    {
+        get => right;
+        set
+        {
+            right = value;
+            if (right is not null)
+                right!.Parent = this;
+        }
+    }
 
     private double? givenValue = null;
 
@@ -31,13 +57,49 @@ public double Result
         }
     }
 
+    public static Dictionary<CalculationType, string> CalculationTypeStrings = new()
+    {
+        { CalculationType.Unknown, "?" },
+        { CalculationType.Add, "+" },
+        { CalculationType.Substraction, "-" },
+        { CalculationType.Multiply, "*" },
+        { CalculationType.Division, "/" },
+        { CalculationType.Power, "**" },
+    };
+
+    public static List<CalculationType> CalculationTypeOrder = new()
+    {
+        CalculationType.Power,
+        CalculationType.Multiply,
+        CalculationType.Division,
+        CalculationType.Add,
+        CalculationType.Substraction,
+        CalculationType.Unknown,
+    };
+
     public static Expression FromValue(double value)
     {
         return new()
         {
             Result = value
         };
     }
+
+    public override string ToString()
+    {
+        if (type == CalculationType.Unknown && givenValue is not null)
+        {
+            return givenValue.ToString();
+        }
+
+        var shouldAddBrackets = true
+            && Parent is not null
+            && (CalculationTypeOrder.IndexOf(type) < CalculationTypeOrder.IndexOf(Parent.type));
+
+        var baseStr = $"{Left?.ToString()} {CalculationTypeStrings[type]} {Right?.ToString()}";
+
+        return $"{(shouldAddBrackets ? "(" : "")}{baseStr}{(shouldAddBrackets ? ")" : "")}";
+    }
 }
 
 
diff --git a/README.md b/README.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## What does this PR do?`
	`1`	`+## What does this MR do?`
`2`	`2`
`3`	`3`	`<!-- Briefly describe what this PR is about -->`
`4`	`4`