#51: Small refactor - change case for new enums, and rename params.

MatthewBAllen · MatthewBAllen · commit 31cb8c98ba85 · 2025-09-24T15:37:35.000-05:00
closes #51
diff --git a/src/EssSharp.Abstractions/Concrete/EssMemberSearchOptions.cs b/src/EssSharp.Abstractions/Concrete/EssMemberSearchOptions.cs
@@ -1,14 +1,12 @@
 ﻿using System;
-using System.Collections.Generic;
-using System.Text;
 
 namespace EssSharp
 {
     [Flags]
     public enum EssMemberSearchOptions
     {
-        MEMBERSONLY                = 1 << 0,
-        MEMBERSANDALIASES          = 1 << 1,
-        FORCECASESENSITIVE         = 1 << 2
+        membersOnly                = 1 << 0,
+        membersAndAliases          = 1 << 1,
+        forceCaseSensitive         = 1 << 2
     }
 }
diff --git a/src/EssSharp.Abstractions/Concrete/EssMemberSearchType.cs b/src/EssSharp.Abstractions/Concrete/EssMemberSearchType.cs
@@ -1,13 +1,9 @@
-﻿using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace EssSharp.Concrete
+﻿namespace EssSharp
 {
     public enum EssMemberSearchType
     {
-        SEARCH,
-        WILDSEARCH,
-        DTSMEMBERS
+        search,
+        wildSearch,
+        dtsMembers
     }
 }
diff --git a/src/EssSharp.Abstractions/IEssCube.cs b/src/EssSharp.Abstractions/IEssCube.cs
@@ -3,7 +3,7 @@
 using System.IO;
 using System.Threading.Tasks;
 using System.Threading;
-using EssSharp.Concrete;
+using EssSharp;
 
 namespace EssSharp
 {
@@ -437,21 +437,21 @@ public interface IEssCube : IEssObject
         /// </summary>
         /// <param name="search"></param>
         /// <param name="isCaseSensitive"></param>
-        /// <param name="queryOptions"></param>
+        /// <param name="searchOptions"></param>
         /// <param name="fields"></param>
         /// <param name="limit"></param>
-        public List<IEssMember> GetMembersSelected(string search = null, string dimensionName = null, string aliasName = null, bool isCaseSensitive = false, EssMemberSearchType queryType = EssMemberSearchType.SEARCH, EssMemberSearchOptions queryOptions = EssMemberSearchOptions.MEMBERSONLY, EssMemberFields? fields = null, int limit = 50);
+        public List<IEssMember> GetMembersSelected(string search = null, string dimensionName = null, string aliasName = null, bool isCaseSensitive = false, EssMemberSearchType searchType = EssMemberSearchType.search, EssMemberSearchOptions searchOptions = EssMemberSearchOptions.membersOnly, EssMemberFields? fields = null, int limit = 50);
 
         /// <summary>
         /// 
         /// </summary>
         /// <param name="search"></param>
         /// <param name="isCaseSensitive"></param>
-        /// <param name="queryOptions"></param>
+        /// <param name="searchOptions"></param>
         /// <param name="fields"></param>
         /// <param name="limit"></param>
         /// <param name="cancellationToken"></param>
-        public Task<List<IEssMember>> GetMembersSelectedAsync(string search = null, string dimensionName = null, string aliasName = null, bool isCaseSensitive = false, EssMemberSearchType queryType = EssMemberSearchType.SEARCH, EssMemberSearchOptions queryOptions = EssMemberSearchOptions.MEMBERSONLY, EssMemberFields? fields = null, int limit = 50, CancellationToken cancellationToken = default);
+        public Task<List<IEssMember>> GetMembersSelectedAsync(string search = null, string dimensionName = null, string aliasName = null, bool isCaseSensitive = false, EssMemberSearchType searchType = EssMemberSearchType.search, EssMemberSearchOptions searchOptions = EssMemberSearchOptions.membersOnly, EssMemberFields? fields = null, int limit = 50, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// 
diff --git a/src/EssSharp.Integration/GetServerObjectTests.cs b/src/EssSharp.Integration/GetServerObjectTests.cs
@@ -1,7 +1,6 @@
 ﻿using System;
 using System.Net;
 using System.Threading.Tasks;
-using EssSharp.Concrete;
 using EssSharp.Integration.Setup;
 
 using Xunit;
@@ -226,10 +225,10 @@ public async Task Essbase_AfterReportCreation_CanGetMembersByAlias()
                 .GetCubeAsync("Basic");
             
             //Get all members that contain "100" in name.
-            var queryType = EssMemberSearchType.WILDSEARCH;
-            var queryOptions = EssMemberSearchOptions.MEMBERSONLY;
+            var searchType = EssMemberSearchType.wildSearch;
+            var queryOptions = EssMemberSearchOptions.membersOnly;
 
-            var members = await cube.GetMembersSelectedAsync(search: "100", isCaseSensitive: false, queryType: queryType, queryOptions: queryOptions, fields: null, limit:500);
+            var members = await cube.GetMembersSelectedAsync(search: "100", isCaseSensitive: false, searchType: searchType, searchOptions: queryOptions, fields: null, limit:500);
 
             Assert.Equal(6, members.Count);
             Assert.Equal("100-30", members[2].Name);
@@ -238,26 +237,26 @@ public async Task Essbase_AfterReportCreation_CanGetMembersByAlias()
                 members.ForEach(mem => mem.Name.Contains("100"));
             });
 
-            queryType = EssMemberSearchType.DTSMEMBERS;
-            queryOptions = EssMemberSearchOptions.MEMBERSANDALIASES;
+            searchType = EssMemberSearchType.dtsMembers;
+            queryOptions = EssMemberSearchOptions.membersAndAliases;
 
-            var dtsFromMembersSelected = await cube.GetMembersSelectedAsync(queryType: queryType, queryOptions: queryOptions);
+            var dtsFromMembersSelected = await cube.GetMembersSelectedAsync(searchType: searchType, searchOptions: queryOptions);
             var dtsFromDTSMethod = await cube.GetDynamicTimeSeriesMembersAsync();
 
             Assert.Equal(2, dtsFromMembersSelected.Count);
             Assert.Equal(dtsFromDTSMethod[0].Name, dtsFromMembersSelected[0].Name);
 
-            queryType = EssMemberSearchType.SEARCH;
-            queryOptions = EssMemberSearchOptions.MEMBERSANDALIASES;
+            searchType = EssMemberSearchType.search;
+            queryOptions = EssMemberSearchOptions.membersAndAliases;
 
-            var memberByAlias = await cube.GetMembersSelectedAsync(search: "Cola", queryType: queryType, queryOptions: queryOptions);
+            var memberByAlias = await cube.GetMembersSelectedAsync(search: "Cola", searchType: searchType, searchOptions: queryOptions);
 
             Assert.Single(memberByAlias);
             Assert.Equal("Cola", memberByAlias[0].ActiveAliasName);
 
-            queryType = EssMemberSearchType.WILDSEARCH;
+            searchType = EssMemberSearchType.wildSearch;
 
-            var memberByAliasCaseSensitive = await cube.GetMembersSelectedAsync(search: "cola", isCaseSensitive: true, queryType: queryType, queryOptions: queryOptions);
+            var memberByAliasCaseSensitive = await cube.GetMembersSelectedAsync(search: "cola", isCaseSensitive: true, searchType: searchType, searchOptions: queryOptions);
 
             Assert.Empty(memberByAliasCaseSensitive);
         }
diff --git a/src/EssSharp/EssCube.cs b/src/EssSharp/EssCube.cs
@@ -7,7 +7,7 @@
 using System.Threading.Tasks;
 
 using EssSharp.Api;
-using EssSharp.Concrete;
+using EssSharp;
 using EssSharp.Model;
 
 namespace EssSharp
@@ -786,11 +786,11 @@ public IEssGrid GetGrid() =>
 
         /// <inheritdoc />
         /// <returns></returns>
-        public List<IEssMember> GetMembersSelected( string search = null, string dimensionName = null, string aliasName = null, bool isCaseSensitive = false, EssMemberSearchType queryType = EssMemberSearchType.SEARCH, EssMemberSearchOptions queryOptions = EssMemberSearchOptions.MEMBERSONLY, EssMemberFields? fields = null, int limit = 50 ) => GetMembersSelectedAsync(search, dimensionName, aliasName, isCaseSensitive, queryType, queryOptions, fields, limit).GetAwaiter().GetResult();
+        public List<IEssMember> GetMembersSelected( string search = null, string dimensionName = null, string aliasName = null, bool isCaseSensitive = false, EssMemberSearchType searchType = EssMemberSearchType.search, EssMemberSearchOptions searchOptions = EssMemberSearchOptions.membersOnly, EssMemberFields? fields = null, int limit = 50 ) => GetMembersSelectedAsync(search, dimensionName, aliasName, isCaseSensitive, searchType, searchOptions, fields, limit).GetAwaiter().GetResult();
 
         /// <inheritdoc />
         /// <returns></returns>
-        public async Task<List<IEssMember>> GetMembersSelectedAsync( string search = null, string dimensionName = null, string aliasName = null, bool isCaseSensitive = false, EssMemberSearchType queryType = EssMemberSearchType.SEARCH, EssMemberSearchOptions queryOptions = EssMemberSearchOptions.MEMBERSONLY, EssMemberFields? fields = null, int limit = 50, CancellationToken cancellationToken = default )
+        public async Task<List<IEssMember>> GetMembersSelectedAsync( string search = null, string dimensionName = null, string aliasName = null, bool isCaseSensitive = false, EssMemberSearchType searchType = EssMemberSearchType.search, EssMemberSearchOptions searchOptions = EssMemberSearchOptions.membersOnly, EssMemberFields? fields = null, int limit = 50, CancellationToken cancellationToken = default )
         {
             try
             {
@@ -800,13 +800,13 @@ public IEssGrid GetGrid() =>
                 if ( fields?.HasFlag(EssMemberFields.dataStorageType) is false )
                     fields |= EssMemberFields.dataStorageType;
 
-                if (queryType == EssMemberSearchType.WILDSEARCH)
-                    search = $@"*{search}*";
+                if (searchType == EssMemberSearchType.wildSearch)
+                    search = $@"*{search?.Trim('*')}*";
 
                 if ( isCaseSensitive )
-                    queryOptions |= EssMemberSearchOptions.FORCECASESENSITIVE;
+                    searchOptions |= EssMemberSearchOptions.forceCaseSensitive;
 
-                if ( await api.OutlineGetMembersSelectedAsync(app: _application?.Name, cube: _cube?.Name, queryType: queryType.ToString(), queryOptions: queryOptions.ToDelimitedString(), search: search, dimensionName: dimensionName, aliasName: aliasName, fields: fields?.ToDelimitedString(), limit: limit, cancellationToken: cancellationToken).ConfigureAwait(false) is not { } membersList )
+                if ( await api.OutlineGetMembersSelectedAsync(app: _application?.Name, cube: _cube?.Name, queryType: searchType.ToString().ToUpperInvariant(), queryOptions: searchOptions.ToDelimitedString(), search: search, dimensionName: dimensionName, aliasName: aliasName, fields: fields?.ToDelimitedString(), limit: limit, cancellationToken: cancellationToken).ConfigureAwait(false) is not { } membersList )
                     throw new Exception("Cannot get Members.");
 
                 return membersList.ToEssSharpList(this) ?? new List<IEssMember>();
diff --git a/src/EssSharp/Extensions/Extensions.cs b/src/EssSharp/Extensions/Extensions.cs
@@ -911,7 +911,7 @@ internal static string ToDelimitedString( this EssMemberSearchOptions queryOptio
             {
                 if ( queryOption.HasFlag(value) )
                 {
-                    values.Add(value.ToString());
+                    values.Add(value.ToString().ToUpperInvariant());
                 }
             }
 

Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,12 @@`
`1`	`1`	`using System;`
`2`		`-using System.Collections.Generic;`
`3`		`-using System.Text;`
`4`	`2`
`5`	`3`	`namespace EssSharp`
`6`	`4`	`{`
`7`	`5`	`[Flags]`
`8`	`6`	`public enum EssMemberSearchOptions`
`9`	`7`	`{`
`10`		`- MEMBERSONLY = 1 << 0,`
`11`		`- MEMBERSANDALIASES = 1 << 1,`
`12`		`- FORCECASESENSITIVE = 1 << 2`
	`8`	`+ membersOnly = 1 << 0,`
	`9`	`+ membersAndAliases = 1 << 1,`
	`10`	`+ forceCaseSensitive = 1 << 2`
`13`	`11`	`}`
`14`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,9 @@`
`1`		`-using System;`
`2`		`-using System.Collections.Generic;`
`3`		`-using System.Text;`
`4`		`-`
`5`		`-namespace EssSharp.Concrete`
	`1`	`+namespace EssSharp`
`6`	`2`	`{`
`7`	`3`	`public enum EssMemberSearchType`
`8`	`4`	`{`
`9`		`- SEARCH,`
`10`		`- WILDSEARCH,`
`11`		`- DTSMEMBERS`
	`5`	`+ search,`
	`6`	`+ wildSearch,`
	`7`	`+ dtsMembers`
`12`	`8`	`}`
`13`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -911,7 +911,7 @@ internal static string ToDelimitedString( this EssMemberSearchOptions queryOptio`
`911`	`911`	`{`
`912`	`912`	`if ( queryOption.HasFlag(value) )`
`913`	`913`	`{`
`914`		`- values.Add(value.ToString());`
	`914`	`+ values.Add(value.ToString().ToUpperInvariant());`
`915`	`915`	`}`
`916`	`916`	`}`
`917`	`917`