Merge pull request #12 from synercoder/develop

Preparing release rc02

Author: synercoder

.github/workflows/dotnet-core.yml

@@ -1,5 +1,8 @@
 name: .NET Core
 on:
+  push:
+    branches:
+      - develop
   pull_request:
   release:
     types:

Directory.Build.props

@@ -44,4 +44,14 @@
     <LangVersion>8.0</LangVersion>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
+    <DefineConstants>$(DefineConstants);SUPPORTS_HASHCODE</DefineConstants>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(TargetFramework)' == 'netcoreapp2.1'">
+    <DefineConstants>$(DefineConstants);SUPPORTS_HASHCODE</DefineConstants>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
+    <DefineConstants>$(DefineConstants);SUPPORTS_HASHCODE</DefineConstants>
+  </PropertyGroup>
+
 </Project>

README.md

@@ -2,5 +2,9 @@
 
 Primitives with types attached (think mm, cm, in, px) that can be used for 2D graphics.
 
+## Build status
+
+Develop: ![.NET Core](https://github.com/synercoder/Primitives/workflows/.NET%20Core/badge.svg?branch=develop)
+
 ## License
 This project is licensed under MIT license.

src/Directory.Build.props

@@ -2,6 +2,7 @@
 <Project>
 
   <PropertyGroup>
+    <TargetFrameworks>netcoreapp3.1;netcoreapp2.1;netstandard2.1;netstandard2.0;netstandard1.6</TargetFrameworks>
     <MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileDirectory)..\Directory.Build.props</MSBuildAllProjects>
     <SynercodingProjectCategory>src</SynercodingProjectCategory>
   </PropertyGroup>

src/Synercoding.Primitives/Extensions/SizeExtensions.cs

@@ -33,7 +33,7 @@ public static Size Expand(this Size size, Spacing spacing)
         /// <param name="size">The size to base the <see cref="Rectangle"/> on</param>
         /// <returns>A new <see cref="Rectangle"/></returns>
         public static Rectangle AsRectangle(this Size size)
-            => new Rectangle(new UnitValue(0, size.Width.Unit), new UnitValue(0, size.Height.Unit), size.Width, size.Height);
+            => new Rectangle(new Value(0, size.Width.Unit), new Value(0, size.Height.Unit), size.Width, size.Height);
 
         /// <summary>
         /// Get a <see cref="Size"/> where the Width and Height are switched

src/Synercoding.Primitives/PackageDetails.props

@@ -10,7 +10,12 @@
     <Product>Synercoding.Primitives</Product>
     <Title>Synercoding.Primitives</Title>
     <Description>Primitives with types attached (think mm, cm, in, px) that can be used for 2D graphics.</Description>
-    <PackageReleaseNotes>Initial alpha release.</PackageReleaseNotes>
+    <PackageReleaseNotes>- Removed implicit double conversion, to easy to make a mistake with the wrong unit type
+- Added equality and inequality operators to all structs
+- Added multiple target-frameworks
+- Added multiplication operator for Value on other side
+- Renamed UnitValue to Value
+- Fixed a few nullability warnings</PackageReleaseNotes>
   </PropertyGroup>
 
 </Project>

src/Synercoding.Primitives/Point.cs

@@ -16,16 +16,16 @@ namespace Synercoding.Primitives
         /// <param name="unit">The unit type of the coordinates</param>
         public Point(double x, double y, Unit unit)
         {
-            X = new UnitValue(x, unit);
-            Y = new UnitValue(y, unit);
+            X = new Value(x, unit);
+            Y = new Value(y, unit);
         }
 
         /// <summary>
         /// Constructor for a <see cref="Point"/>
         /// </summary>
         /// <param name="x">The X coordinate</param>
         /// <param name="y">The Y coordinate</param>
-        public Point(UnitValue x, UnitValue y)
+        public Point(Value x, Value y)
         {
             X = x;
             Y = y;
@@ -36,7 +36,7 @@ public Point(UnitValue x, UnitValue y)
         /// </summary>
         /// <param name="x">Out parameter for the <see cref="X"/> property</param>
         /// <param name="y">Out parameter for the <see cref="Y"/> property</param>
-        public void Deconstruct(out UnitValue x, out UnitValue y)
+        public void Deconstruct(out Value x, out Value y)
         {
             x = X;
             y = Y;
@@ -51,12 +51,12 @@ public static Point Origin
         /// <summary>
         /// The X coordinate
         /// </summary>
-        public UnitValue X { get; }
+        public Value X { get; }
 
         /// <summary>
         /// The Y coordinate
         /// </summary>
-        public UnitValue Y { get; }
+        public Value Y { get; }
 
         /// <inheritdoc />
         public Point ConvertTo(Unit unit)
@@ -71,10 +71,8 @@ public override int GetHashCode()
             => HashCode.Combine(X, Y);
 
         /// <inheritdoc />
-        public override bool Equals(object obj)
-        {
-            return obj is Point unit && Equals(unit);
-        }
+        public override bool Equals(object? obj)
+            => obj is Point unit && Equals(unit);
 
         /// <inheritdoc />
         public bool Equals(Point other)
@@ -89,5 +87,23 @@ public bool Equals(Point other)
         /// <inheritdoc />
         public override string ToString()
             => $"X: {X}, Y: {Y}";
+
+        /// <summary>
+        ///  Returns a value that indicates whether two specified <see cref="Point"/> values are equal.
+        /// </summary>
+        /// <param name="left">The first value to compare.</param>
+        /// <param name="right">The second value to compare.</param>
+        /// <returns>true if left and right are equal; otherwise, false.</returns>
+        public static bool operator ==(Point left, Point right)
+            => left.Equals(right);
+
+        /// <summary>
+        ///  Returns a value that indicates whether two specified <see cref="Point"/> values are not equal.
+        /// </summary>
+        /// <param name="left">The first value to compare.</param>
+        /// <param name="right">The second value to compare.</param>
+        /// <returns>true if left and right are not equal; otherwise, false.</returns>
+        public static bool operator !=(Point left, Point right)
+            => !( left == right );
     }
 }

src/Synercoding.Primitives/Rectangle.cs

@@ -18,10 +18,10 @@ namespace Synercoding.Primitives
         /// <param name="unit">The unit type of the coordinates</param>
         public Rectangle(double llx, double lly, double urx, double ury, Unit unit)
         {
-            LLX = new UnitValue(llx, unit);
-            LLY = new UnitValue(lly, unit);
-            URX = new UnitValue(urx, unit);
-            URY = new UnitValue(ury, unit);
+            LLX = new Value(llx, unit);
+            LLY = new Value(lly, unit);
+            URX = new Value(urx, unit);
+            URY = new Value(ury, unit);
         }
 
         /// <summary>
@@ -31,7 +31,7 @@ public Rectangle(double llx, double lly, double urx, double ury, Unit unit)
         /// <param name="lly">The lower left y coordinate</param>
         /// <param name="urx">The upper right x coordinate</param>
         /// <param name="ury">The upper right y coordinate</param>
-        public Rectangle(UnitValue llx, UnitValue lly, UnitValue urx, UnitValue ury)
+        public Rectangle(Value llx, Value lly, Value urx, Value ury)
         {
             LLX = llx;
             LLY = lly;
@@ -70,7 +70,7 @@ public void Deconstruct(out Point location, out Size size)
         /// <param name="lly">The out parameter for the lower left y coordinate</param>
         /// <param name="urx">The out parameter for the upper right x coordinate</param>
         /// <param name="ury">The out parameter for the upper right y coordinate</param>
-        public void Deconstruct(out UnitValue llx, out UnitValue lly, out UnitValue urx, out UnitValue ury)
+        public void Deconstruct(out Value llx, out Value lly, out Value urx, out Value ury)
         {
             llx = LLX;
             lly = LLY;
@@ -87,33 +87,33 @@ public static Rectangle Zero
         /// <summary>
         /// The lower left x coordinate
         /// </summary>
-        public UnitValue LLX { get; }
+        public Value LLX { get; }
 
         /// <summary>
         /// The lower left y coordinate
         /// </summary>
-        public UnitValue LLY { get; }
+        public Value LLY { get; }
 
         /// <summary>
         /// The upper right x coordinate
         /// </summary>
-        public UnitValue URX { get; }
+        public Value URX { get; }
 
         /// <summary>
         /// The upper right y coordinate
         /// </summary>
-        public UnitValue URY { get; }
+        public Value URY { get; }
 
         /// <summary>
         /// The width of this <see cref="Rectangle"/>
         /// </summary>
-        public UnitValue Width
+        public Value Width
             => URX - LLX;
 
         /// <summary>
         /// The height of this <see cref="Rectangle"/>
         /// </summary>
-        public UnitValue Height
+        public Value Height
             => URY - LLY;
 
         /// <summary>
@@ -143,10 +143,8 @@ public override int GetHashCode()
             => HashCode.Combine(LLX, LLY, URX, URY);
 
         /// <inheritdoc/>
-        public override bool Equals(object obj)
-        {
-            return obj is Rectangle unit && Equals(unit);
-        }
+        public override bool Equals(object? obj)
+            => obj is Rectangle unit && Equals(unit);
 
         /// <inheritdoc/>
         public bool Equals(Rectangle other)
@@ -163,5 +161,23 @@ public bool Equals(Rectangle other)
         /// <inheritdoc/>
         public override string ToString()
             => $"LLX {LLX}, LLY {LLY}, URX {URX}, URY {URY}";
+
+        /// <summary>
+        ///  Returns a value that indicates whether two specified <see cref="Rectangle"/> values are equal.
+        /// </summary>
+        /// <param name="left">The first value to compare.</param>
+        /// <param name="right">The second value to compare.</param>
+        /// <returns>true if left and right are equal; otherwise, false.</returns>
+        public static bool operator ==(Rectangle left, Rectangle right)
+            => left.Equals(right);
+
+        /// <summary>
+        ///  Returns a value that indicates whether two specified <see cref="Rectangle"/> values are not equal.
+        /// </summary>
+        /// <param name="left">The first value to compare.</param>
+        /// <param name="right">The second value to compare.</param>
+        /// <returns>true if left and right are not equal; otherwise, false.</returns>
+        public static bool operator !=(Rectangle left, Rectangle right)
+            => !( left == right );
     }
 }

src/Synercoding.Primitives/Size.cs

@@ -16,16 +16,16 @@ namespace Synercoding.Primitives
         /// <param name="unit">The unit of the <see cref="Size"/></param>
         public Size(double width, double height, Unit unit)
         {
-            Width = new UnitValue(width, unit);
-            Height = new UnitValue(height, unit);
+            Width = new Value(width, unit);
+            Height = new Value(height, unit);
         }
 
         /// <summary>
         /// Constructor for a <see cref="Size"/>
         /// </summary>
         /// <param name="width">The width parameter</param>
         /// <param name="height">The height parameter</param>
-        public Size(UnitValue width, UnitValue height)
+        public Size(Value width, Value height)
         {
             Width = width;
             Height = height;
@@ -36,7 +36,7 @@ public Size(UnitValue width, UnitValue height)
         /// </summary>
         /// <param name="width">Out parameter for the <see cref="Width"/> property</param>
         /// <param name="height">Out parameter for the <see cref="Height"/> property</param>
-        public void Deconstruct(out UnitValue width, out UnitValue height)
+        public void Deconstruct(out Value width, out Value height)
         {
             width = Width;
             height = Height;
@@ -51,12 +51,12 @@ public static Size Empty
         /// <summary>
         /// The width property
         /// </summary>
-        public UnitValue Width { get; }
+        public Value Width { get; }
 
         /// <summary>
         /// The height property
         /// </summary>
-        public UnitValue Height { get; }
+        public Value Height { get; }
 
         /// <summary>
         /// Get the <see cref="Primitives.Orientation"/> of the size
@@ -73,8 +73,8 @@ public Orientation Orientation
         public Size ConvertTo(Unit unit)
         {
             return new Size(
-                width: Width.ConvertTo(unit),
-                height: Height.ConvertTo(unit),
+                width: Width.ConvertTo(unit).Raw,
+                height: Height.ConvertTo(unit).Raw,
                 unit);
         }
 
@@ -83,10 +83,8 @@ public override int GetHashCode()
             => HashCode.Combine(Width, Height);
 
         /// <inheritdoc/>
-        public override bool Equals(object obj)
-        {
-            return obj is Size unit && Equals(unit);
-        }
+        public override bool Equals(object? obj)
+            => obj is Size unit && Equals(unit);
 
         /// <inheritdoc/>
         public bool Equals(Size other)
@@ -101,5 +99,23 @@ public bool Equals(Size other)
         /// <inheritdoc/>
         public override string ToString()
             => $"W: {Width}, H: {Height}";
+
+        /// <summary>
+        ///  Returns a value that indicates whether two specified <see cref="Size"/> values are equal.
+        /// </summary>
+        /// <param name="left">The first value to compare.</param>
+        /// <param name="right">The second value to compare.</param>
+        /// <returns>true if left and right are equal; otherwise, false.</returns>
+        public static bool operator ==(Size left, Size right)
+            => left.Equals(right);
+
+        /// <summary>
+        ///  Returns a value that indicates whether two specified <see cref="Size"/> values are not equal.
+        /// </summary>
+        /// <param name="left">The first value to compare.</param>
+        /// <param name="right">The second value to compare.</param>
+        /// <returns>true if left and right are not equal; otherwise, false.</returns>
+        public static bool operator !=(Size left, Size right)
+            => !( left == right );
     }
 }