Merge branch 'release/v.0.0.2'

Author: paonath

README.md

@@ -1,2 +1,63 @@
 # PH.Entities.Abstractions [![NuGet Badge](https://buildstats.info/nuget/PH.Entities.Abstractions)](https://www.nuget.org/packages/PH.Entities.Abstractions/)
 Abstractions for Entities: simple collection of interfaces
+
+## Data
+
+ - `IEntity` and `IEntity<TKey>` 
+ - `IDeleteableEntity` and `IDeleteableEntity<TKey>` 
+ - `INamedEntity` and `INamedEntity<TKey>` 
+ 
+
+### Examples
+
+
+#### IEntity
+```csharp
+
+/// <summary>
+/// Entity example using <see cref="IEntity{TKey}"/>
+/// </summary>
+/// <seealso cref="Guid" />
+public class EntitySample : IEntity<Guid>
+{
+	/// <summary>
+	///   Gets or sets the primary key identifier.
+	/// </summary>
+	/// <value>
+	///   The identifier.
+	/// </value>
+	public Guid Id { get; set; }
+
+	/// <summary>
+	/// Gets or sets a nullable date. Just for add another prop...
+	/// </summary>
+	/// <value>
+	/// a nullable date.
+	/// </value>
+	public DateTime? ANullableDate { get; set; }
+}
+
+```
+#### IDeleteableEntity
+```csharp
+
+public class MyClass : IDeleteableEntity<long>
+{
+    /// <summary>
+    ///   Gets or sets the primary key identifier.
+    /// </summary>
+    /// <value>
+    ///   The identifier.
+    /// </value>
+    public long Id      { get; set; }
+    
+    /// <summary>
+    ///   Gets or sets a value indicating whether this <see cref="IDeleteableEntity{TKey}" /> is deleted.
+    /// </summary>
+    /// <value>
+    ///   <c>true</c> if deleted; otherwise, <c>false</c>.
+    /// </value>
+    public bool Deleted { get; set; }
+}
+
+```

src/PH.Entities.Abstractions/PH.Entities.Abstractions.sln

@@ -3,7 +3,12 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.4.33205.214
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PH.Entities.Abstractions", "PH.Entities.Abstractions\PH.Entities.Abstractions.csproj", "{3D6813C4-7955-4937-B70E-8C611934A58D}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PH.Entities.Abstractions", "PH.Entities.Abstractions\PH.Entities.Abstractions.csproj", "{3D6813C4-7955-4937-B70E-8C611934A58D}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{BAB3524A-3B99-41AB-AE6D-DF5EC2F1B444}"
+	ProjectSection(SolutionItems) = preProject
+		..\..\README.md = ..\..\README.md
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

src/PH.Entities.Abstractions/PH.Entities.Abstractions/IDeleteableEntity.cs

@@ -12,9 +12,8 @@ namespace PH.Entities.Abstractions
 	/// <summary>
 	///   Entity with <see cref="Deleted" /> property for "soft-deleting"
 	/// </summary>
-	/// <typeparam name="TKey">The type of the key.</typeparam>
 	/// <seealso cref="PH.Entities.Abstractions.IEntity&lt;TKey&gt;" />
-	public interface IDeleteableEntity<TKey> : IEntity<TKey> where TKey : IEquatable<TKey>
+	public interface IDeleteableEntity : IEntity
 	{
 		/// <summary>
 		///   Gets or sets a value indicating whether this <see cref="IDeleteableEntity{TKey}" /> is deleted.
@@ -24,4 +23,14 @@ public interface IDeleteableEntity<TKey> : IEntity<TKey> where TKey : IEquatable
 		/// </value>
 		bool Deleted { get; set; }
 	}
+
+	/// <summary>
+	///   Entity with <see cref="IDeleteableEntity.Deleted" /> property for "soft-deleting"
+	/// </summary>
+	/// <typeparam name="TKey">The type of the key.</typeparam>
+	/// <seealso cref="PH.Entities.Abstractions.IEntity&lt;TKey&gt;" />
+	public interface IDeleteableEntity<TKey> : IEntity<TKey> , IDeleteableEntity where TKey : IEquatable<TKey>
+	{
+		
+	}
 }

src/PH.Entities.Abstractions/PH.Entities.Abstractions/IEntity.cs

@@ -9,11 +9,18 @@
 
 namespace PH.Entities.Abstractions
 {
+	/// <summary>
+	/// Entity interface
+	/// </summary>
+	public interface IEntity
+	{
+	}
+
 	/// <summary>
 	///   Entity with <see cref="Id" /> property as Primary Key
 	/// </summary>
 	/// <typeparam name="TKey">The type of the key.</typeparam>
-	public interface IEntity<TKey> where TKey : IEquatable<TKey>
+	public interface IEntity<TKey> : IEntity where TKey : IEquatable<TKey>
 	{
 		/// <summary>
 		///   Gets or sets the primary key identifier.

src/PH.Entities.Abstractions/PH.Entities.Abstractions/INamedEntity.cs

@@ -0,0 +1,31 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace PH.Entities.Abstractions
+{
+	/// <summary>
+	/// Entity interface with <see cref="Name"/> property.
+	/// </summary>
+	/// <seealso cref="PH.Entities.Abstractions.IEntity" />
+	public interface INamedEntity : IEntity
+	{
+		/// <summary>
+		/// Gets or sets the name.
+		/// </summary>
+		/// <value>
+		/// The name.
+		/// </value>
+		string Name { get; set; }
+	}
+
+	/// <summary>
+	/// Entity interface with <see cref="INamedEntity.Name"/> property.
+	/// </summary>
+	/// <typeparam name="TKey">The type of the key.</typeparam>
+	/// <seealso cref="PH.Entities.Abstractions.IEntity" />
+	public interface INamedEntity<TKey> : IEntity<TKey>, INamedEntity where TKey : IEquatable<TKey>
+	{
+	}
+}

src/PH.Entities.Abstractions/PH.Entities.Abstractions/PH.Entities.Abstractions.csproj

@@ -17,10 +17,10 @@
 
     <PackageTags>entity,database,sql,nosql</PackageTags>
 
-    <PackageVersion>0.0.1</PackageVersion>
-    <AssemblyVersion>0.0.1</AssemblyVersion>
-    <FileVersion>0.0.1</FileVersion>
-    <Version>0.0.1</Version>
+    <PackageVersion>0.0.2</PackageVersion>
+    <AssemblyVersion>0.0.2</AssemblyVersion>
+    <FileVersion>0.0.2</FileVersion>
+    <Version>0.0.2</Version>
 
     <Authors>Paolo Innocenti</Authors>
     <Copyright>Copyright PH $([System.DateTime]::UtcNow.ToString("yyyy")) (c) paonath@gmail.com. All rights reserved.</Copyright>

src/PH.Entities.Abstractions/PH.Entities.Abstractions/Sample.cs

@@ -0,0 +1,54 @@
+using System;
+
+namespace PH.Entities.Abstractions
+{
+	/// <summary>
+	/// Sample class just for write docs
+	/// </summary>
+	internal class Sample
+	{
+		/// <summary>
+		/// Entity example using <see cref="IEntity{TKey}"/>
+		/// </summary>
+		/// <seealso cref="Guid" />
+		internal class EntitySample : IEntity<Guid>
+		{
+			/// <summary>
+			///   Gets or sets the primary key identifier.
+			/// </summary>
+			/// <value>
+			///   The identifier.
+			/// </value>
+			public Guid Id { get; set; }
+
+			/// <summary>
+			/// Gets or sets a nullable date. Just for add another prop...
+			/// </summary>
+			/// <value>
+			/// a nullable date.
+			/// </value>
+			public DateTime? ANullableDate { get; set; }
+		}
+
+
+		internal class MyClass : IDeleteableEntity<long>
+		{
+			/// <summary>
+			///   Gets or sets the primary key identifier.
+			/// </summary>
+			/// <value>
+			///   The identifier.
+			/// </value>
+			public long Id      { get; set; }
+
+			/// <summary>
+			///   Gets or sets a value indicating whether this <see cref="IDeleteableEntity{TKey}" /> is deleted.
+			/// </summary>
+			/// <value>
+			///   <c>true</c> if deleted; otherwise, <c>false</c>.
+			/// </value>
+			public bool Deleted { get; set; }
+		}
+
+	}
+}