[ksqlDb.RestApi.Client]: added KSqlDBRestApiClientOptions ctor argument for KSqlDbRestApiClient

Author: tomasfabian

ksqlDb.RestApi.Client/KSql/Query/Context/KSqlDBRestApiClientOptions.cs

@@ -0,0 +1,13 @@
+namespace ksqlDB.RestApi.Client.KSql.Query.Context
+{
+  /// <summary>
+  /// Options class for ksqlDB REST API client configuration.
+  /// </summary>
+  public sealed class KSqlDBRestApiClientOptions
+  {
+    /// <summary>
+    /// Gets or sets a value indicating whether table or stream name should be pluralized from the item name (by default: true).
+    /// </summary>
+    public bool ShouldPluralizeFromItemName { get; set; } = true;
+  }
+}

ksqlDb.RestApi.Client/KSql/RestApi/Generators/StatementGenerator.cs

@@ -105,6 +105,9 @@ public string CreateOrReplaceTable<T>(EntityCreationMetadata creationMetadata)
     /// <returns>A string representing a KSQL statement for creating or replacing a stream or table.</returns>
     private string CreateOrReplace<T>(StatementContext statementContext, EntityCreationMetadata creationMetadata, bool? ifNotExists)
     {
+      if (creationMetadata.ShouldPluralizeEntityName == null)
+        creationMetadata = creationMetadata with { ShouldPluralizeEntityName = true };
+
       string ksql = new CreateEntity(modelBuilder).Print<T>(statementContext, creationMetadata, ifNotExists);
 
       return ksql;

ksqlDb.RestApi.Client/KSql/RestApi/IKSqlDbRestApiClient.cs

@@ -10,6 +10,9 @@
 
 namespace ksqlDB.RestApi.Client.KSql.RestApi;
 
+/// <summary>
+/// Represents a client for interacting with the KSQL REST API.
+/// </summary>
 public interface IKSqlDbRestApiClient : IKSqlDbCreateRestApiClient, IKSqlDbAssertionsRestApiClient, IKSqlDbDropRestApiClient
 {
   /// <summary>

ksqlDb.RestApi.Client/KSql/RestApi/KSqlDbRestApiClient.cs

@@ -22,26 +22,69 @@
 using Microsoft.Extensions.Logging;
 using IHttpClientFactory = ksqlDB.RestApi.Client.KSql.RestApi.Http.IHttpClientFactory;
 using ksqlDb.RestApi.Client.KSql.RestApi.Statements.Providers;
+using ksqlDB.RestApi.Client.KSql.Query.Context;
 
 namespace ksqlDB.RestApi.Client.KSql.RestApi;
 
+/// <summary>
+/// Represents a client for interacting with the KSQL REST API.
+/// </summary>
 public class KSqlDbRestApiClient : IKSqlDbRestApiClient
 {
   private readonly EntityProvider entityProvider = new();
   private readonly IHttpClientFactory httpClientFactory;
   private readonly ModelBuilder modelBuilder;
+  private readonly KSqlDBRestApiClientOptions clientOptions;
   private readonly StatementGenerator statementGenerator;
   private readonly ILogger? logger;
 
+  /// <summary>
+  /// Initializes a new instance of the <see cref="KSqlDbRestApiClient"/> class.
+  /// </summary>
+  /// <param name="httpClientFactory">The factory to create <see cref="HttpClient"/> instances.</param>
+  /// <param name="loggerFactory">The factory to create <see cref="ILogger"/> instances. This parameter is optional.</param>
+  /// <exception cref="ArgumentNullException">Thrown when <paramref name="httpClientFactory"/> is null.</exception>
   public KSqlDbRestApiClient(IHttpClientFactory httpClientFactory, ILoggerFactory? loggerFactory = null)
     : this(httpClientFactory, new ModelBuilder(), loggerFactory)
   {
   }
 
+  /// <summary>
+  /// Initializes a new instance of the <see cref="KSqlDbRestApiClient"/> class.
+  /// </summary>
+  /// <param name="httpClientFactory">The factory to create <see cref="HttpClient"/> instances.</param>
+  /// <param name="loggerFactory">The factory to create <see cref="ILogger"/> instances. This parameter is optional.</param>
+  /// <param name="clientOptions">The options for configuring the KSqlDB REST API client.</param>
+  /// <exception cref="ArgumentNullException">Thrown when <paramref name="httpClientFactory"/> is null.</exception>
+  public KSqlDbRestApiClient(IHttpClientFactory httpClientFactory, KSqlDBRestApiClientOptions clientOptions, ILoggerFactory? loggerFactory = null)
+    : this(httpClientFactory, new ModelBuilder(), clientOptions, loggerFactory)
+  {
+  }
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="KSqlDbRestApiClient"/> class.
+  /// </summary>
+  /// <param name="httpClientFactory">The factory to create <see cref="HttpClient"/> instances.</param>
+  /// <param name="modelBuilder">The model builder used to construct the models.</param>
+  /// <param name="loggerFactory">The factory to create <see cref="ILogger"/> instances. This parameter is optional.</param>
   public KSqlDbRestApiClient(IHttpClientFactory httpClientFactory, ModelBuilder modelBuilder, ILoggerFactory? loggerFactory = null)
+    : this(httpClientFactory, modelBuilder, new KSqlDBRestApiClientOptions(), loggerFactory)
+  {
+  }
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="KSqlDbRestApiClient"/> class.
+  /// </summary>
+  /// <param name="httpClientFactory">The factory to create <see cref="HttpClient"/> instances.</param>
+  /// <param name="modelBuilder">The model builder used to construct the models.</param>
+  /// <param name="loggerFactory">The factory to create <see cref="ILogger"/> instances. This parameter is optional.</param>
+  /// <param name="clientOptions">The options for configuring the KSqlDB REST API client.</param>
+  /// <exception cref="ArgumentNullException">Thrown when <paramref name="httpClientFactory"/> is null.</exception>
+  public KSqlDbRestApiClient(IHttpClientFactory httpClientFactory, ModelBuilder modelBuilder, KSqlDBRestApiClientOptions clientOptions, ILoggerFactory? loggerFactory = null)
   {
     this.httpClientFactory = httpClientFactory ?? throw new ArgumentNullException(nameof(httpClientFactory));
     this.modelBuilder = modelBuilder;
+    this.clientOptions = clientOptions;
 
     if (loggerFactory != null)
       logger = loggerFactory.CreateLogger(LoggingCategory.Name);
@@ -191,6 +234,9 @@ public Task<HttpResponseMessage> CreateStreamAsync<T>(EntityCreationMetadata cre
     ArgumentNullException.ThrowIfNull(creationMetadata);
 #endif
 
+    if (creationMetadata.ShouldPluralizeEntityName == null)
+      creationMetadata = creationMetadata with {ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName};
+
     var ksql = statementGenerator.CreateStream<T>(creationMetadata, ifNotExists);
 
     return ExecuteAsync(ksql, cancellationToken);
@@ -211,6 +257,9 @@ public Task<HttpResponseMessage> CreateOrReplaceStreamAsync<T>(EntityCreationMet
     ArgumentNullException.ThrowIfNull(creationMetadata);
 #endif
 
+    if (creationMetadata.ShouldPluralizeEntityName == null)
+      creationMetadata = creationMetadata with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var ksql = statementGenerator.CreateOrReplaceStream<T>(creationMetadata);
 
     return ExecuteAsync(ksql, cancellationToken);
@@ -232,7 +281,12 @@ public Task<HttpResponseMessage> CreateSourceStreamAsync<T>(EntityCreationMetada
     ArgumentNullException.ThrowIfNull(creationMetadata);
 #endif
 
-    creationMetadata.IsReadOnly = true;
+    if (creationMetadata.ShouldPluralizeEntityName == null)
+      creationMetadata = creationMetadata with
+      {
+        ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName,
+        IsReadOnly = true
+      };
 
     var ksql = statementGenerator.CreateStream<T>(creationMetadata, ifNotExists);
 
@@ -255,6 +309,9 @@ public Task<HttpResponseMessage> CreateTableAsync<T>(EntityCreationMetadata crea
     ArgumentNullException.ThrowIfNull(creationMetadata);
 #endif
 
+    if (creationMetadata.ShouldPluralizeEntityName == null)
+      creationMetadata = creationMetadata with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var ksql = statementGenerator.CreateTable<T>(creationMetadata, ifNotExists);
 
     return ExecuteAsync(ksql, cancellationToken);
@@ -276,7 +333,12 @@ public Task<HttpResponseMessage> CreateSourceTableAsync<T>(EntityCreationMetadat
     ArgumentNullException.ThrowIfNull(creationMetadata);
 #endif
 
-    creationMetadata.IsReadOnly = true;
+    if (creationMetadata.ShouldPluralizeEntityName == null)
+      creationMetadata = creationMetadata with
+      {
+        ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName,
+        IsReadOnly = true
+      };
 
     var ksql = statementGenerator.CreateTable<T>(creationMetadata, ifNotExists);
 
@@ -298,6 +360,9 @@ public Task<HttpResponseMessage> CreateOrReplaceTableAsync<T>(EntityCreationMeta
     ArgumentNullException.ThrowIfNull(creationMetadata);
 #endif
 
+    if (creationMetadata.ShouldPluralizeEntityName == null)
+      creationMetadata = creationMetadata with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var ksql = statementGenerator.CreateOrReplaceTable<T>(creationMetadata);
 
     return ExecuteAsync(ksql, cancellationToken);
@@ -321,6 +386,7 @@ private Task<HttpResponseMessage> ExecuteAsync(string ksql, CancellationToken ca
   public Task<HttpResponseMessage> CreateTypeAsync<T>(CancellationToken cancellationToken = default)
   {
     var properties = new TypeProperties();
+
     return CreateTypeAsync<T>(properties, cancellationToken);
   }
 
@@ -335,7 +401,11 @@ public Task<HttpResponseMessage> CreateTypeAsync<T>(CancellationToken cancellati
   /// <returns>Http response object.</returns>
   public Task<HttpResponseMessage> CreateTypeAsync<T>(string typeName, CancellationToken cancellationToken = default)
   {
-    var properties = new TypeProperties { EntityName = typeName };
+    var properties = new TypeProperties
+    {
+      EntityName = typeName
+    };
+
     return CreateTypeAsync<T>(properties, cancellationToken);
   }
 
@@ -350,6 +420,9 @@ public Task<HttpResponseMessage> CreateTypeAsync<T>(string typeName, Cancellatio
   /// <returns>Http response object.</returns>
   public Task<HttpResponseMessage> CreateTypeAsync<T>(TypeProperties properties, CancellationToken cancellationToken = default)
   {
+    if (properties.ShouldPluralizeEntityName == null)
+      properties = properties with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var ksql = new TypeGenerator(modelBuilder).Print<T>(properties);
 
     return ExecuteAsync(ksql, cancellationToken);
@@ -363,6 +436,9 @@ public Task<HttpResponseMessage> CreateTypeAsync<T>(TypeProperties properties, C
   /// <returns>Http response object.</returns>
   public Task<HttpResponseMessage> DropTypeAsync<T>(DropTypeProperties dropTypeProperties, CancellationToken cancellationToken = default)
   {
+    if (dropTypeProperties.ShouldPluralizeEntityName == null)
+      dropTypeProperties = dropTypeProperties with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var typeName = entityProvider.GetFormattedName<T>(dropTypeProperties);
     string dropStatement = StatementTemplates.DropType(typeName);
 
@@ -413,6 +489,10 @@ public Task<HttpResponseMessage> DropTypeIfExistsAsync(string typeName, Cancella
   /// <returns>Http response object.</returns>
   public Task<HttpResponseMessage> InsertIntoAsync<T>(T entity, InsertProperties? insertProperties = null, CancellationToken cancellationToken = default)
   {
+    insertProperties ??= new InsertProperties();
+    if (insertProperties.ShouldPluralizeEntityName == null)
+      insertProperties = insertProperties with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var insertStatement = ToInsertStatement(entity, insertProperties);
 
     var httpResponseMessage = ExecuteStatementAsync(insertStatement, cancellationToken);
@@ -429,6 +509,10 @@ public Task<HttpResponseMessage> InsertIntoAsync<T>(T entity, InsertProperties?
   /// <returns>A <see cref="KSqlDbStatement"/></returns>
   public KSqlDbStatement ToInsertStatement<T>(InsertValues<T> insertValues, InsertProperties? insertProperties = null)
   {
+    insertProperties ??= new InsertProperties();
+    if (insertProperties.ShouldPluralizeEntityName == null)
+      insertProperties = insertProperties with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var insertStatement = new CreateInsert(modelBuilder).Generate(insertValues, insertProperties);
 
     return new KSqlDbStatement(insertStatement);
@@ -443,6 +527,10 @@ public KSqlDbStatement ToInsertStatement<T>(InsertValues<T> insertValues, Insert
   /// <returns>A <see cref="KSqlDbStatement"/></returns>
   public KSqlDbStatement ToInsertStatement<T>(T entity, InsertProperties? insertProperties = null)
   {
+    insertProperties ??= new InsertProperties();
+    if (insertProperties.ShouldPluralizeEntityName == null)
+      insertProperties = insertProperties with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var insertStatement = new CreateInsert(modelBuilder).Generate(entity, insertProperties);
 
     return new KSqlDbStatement(insertStatement);
@@ -746,6 +834,9 @@ public Task<HttpResponseMessage> DropStreamAsync(string streamName, Cancellation
   /// <returns></returns>
   public Task<HttpResponseMessage> DropTableAsync<T>(DropFromItemProperties dropFromItemProperties, CancellationToken cancellationToken = default)
   {
+    if (dropFromItemProperties.ShouldPluralizeEntityName == null)
+      dropFromItemProperties = dropFromItemProperties with { ShouldPluralizeEntityName = clientOptions.ShouldPluralizeFromItemName };
+
     var tableName = entityProvider.GetFormattedName<T>(dropFromItemProperties);
     string dropStatement = StatementTemplates.DropTable(tableName, dropFromItemProperties.UseIfExistsClause, dropFromItemProperties.DeleteTopic);
 

ksqlDb.RestApi.Client/KSql/RestApi/Statements/CreateEntity.cs

@@ -42,7 +42,7 @@ internal string Print<T>(StatementContext statementContext, EntityCreationMetada
   private void PrintProperties<T>(StatementContext statementContext, EntityCreationMetadata metadata)
   {
     var ksqlProperties = new List<string>();
-    metadata ??= new EntityCreationMetadata();
+
     foreach (var memberInfo in Members<T>(metadata.IncludeReadOnlyProperties))
     {
       var type = GetMemberType(memberInfo);

ksqlDb.RestApi.Client/KSql/RestApi/Statements/CreateInsert.cs

@@ -18,16 +18,15 @@ public CreateInsert(ModelBuilder modelBuilder)
     this.modelBuilder = modelBuilder;
   }
 
-  internal string Generate<T>(T entity, InsertProperties? insertProperties = null)
+  internal string Generate<T>(T entity, InsertProperties insertProperties)
   {
     return Generate(new InsertValues<T>(entity), insertProperties);
   }
 
-  internal string Generate<T>(InsertValues<T> insertValues, InsertProperties? insertProperties = null)
+  internal string Generate<T>(InsertValues<T> insertValues, InsertProperties insertProperties)
   {
-    if (insertValues == null) throw new ArgumentNullException(nameof(insertValues));
-
-    insertProperties ??= new InsertProperties();
+    if (insertProperties.ShouldPluralizeEntityName == null)
+      insertProperties = insertProperties with { ShouldPluralizeEntityName = true };
 
     var entityName = EntityProvider.GetFormattedName<T>(insertProperties);
 

ksqlDb.RestApi.Client/KSql/RestApi/Statements/EntityCreationMetadata.cs

@@ -39,7 +39,7 @@ internal EntityCreationMetadata()
   /// <summary>
   /// By setting the value of this field to "true" the entity name will be automatically pluralized during code generation. 
   /// </summary>
-  public bool ShouldPluralizeEntityName { get; set; } = true;
+  public bool? ShouldPluralizeEntityName { get; set; }
 
   /// <summary>
   /// By default, the topic is assumed to contain non-windowed data. If the data is windowed, i.e., was created using ksqlDB using a query that contains a WINDOW clause, then the WINDOW_TYPE property can be used to provide the window type. Valid values are SESSION, HOPPING, and TUMBLING.

ksqlDb.RestApi.Client/KSql/RestApi/Statements/Properties/EntityProperties.cs

@@ -15,7 +15,7 @@ public record EntityProperties : IEntityProperties
     /// <summary>
     /// Gets or sets a value indicating whether the entity name should be pluralized.
     /// </summary>
-    public bool ShouldPluralizeEntityName { get; init; } = true;
+    public bool? ShouldPluralizeEntityName { get; init; }
 
     /// <summary>
     /// Gets or sets the identifier escaping type.

ksqlDb.RestApi.Client/KSql/RestApi/Statements/Properties/IEntityProperties.cs

@@ -12,7 +12,7 @@ public interface IEntityProperties
     /// <summary>
     /// Gets a value indicating whether the entity name should be pluralized.
     /// </summary>
-    public bool ShouldPluralizeEntityName { get; }
+    public bool? ShouldPluralizeEntityName { get; }
 
     /// <summary>
     /// Gets the identifier escaping type.