feature/indexers revamp

src/Kiota.Builder/CodeDOM/CodeClass.cs

@@ -53,9 +53,9 @@ public CodeIndexer? Indexer
                 if (Indexer is CodeIndexer existingIndexer)
                 {
                     RemoveChildElement(existingIndexer);
-                    AddRange(CodeMethod.FromIndexer(existingIndexer, $"By{existingIndexer.SerializationName.CleanupSymbolName().ToFirstCharacterUpperCase()}", true));
+                    AddRange(CodeMethod.FromIndexer(existingIndexer, static x => $"With{x.ToFirstCharacterUpperCase()}", static x => x.ToFirstCharacterUpperCase(), true));
                 }
-                AddRange(CodeMethod.FromIndexer(value, $"By{value.SerializationName.CleanupSymbolName().ToFirstCharacterUpperCase()}", false));
+                AddRange(CodeMethod.FromIndexer(value, static x => $"With{x.ToFirstCharacterUpperCase()}", static x => x.ToFirstCharacterUpperCase(), false));
             }
             else
                 AddRange(value);

src/Kiota.Builder/CodeDOM/CodeIndexer.cs

@@ -27,6 +27,13 @@ public required CodeTypeBase ReturnType
             returnType = value;
         }
     }
+    /// <summary>
+    /// The name of the parameter to use for the indexer.
+    /// </summary>
+    public required string IndexParameterName
+    {
+        get; set;
+    }
     public string SerializationName { get; set; } = string.Empty;
     public CodeDocumentation Documentation { get; set; } = new();
     /// <summary>

src/Kiota.Builder/CodeDOM/CodeMethod.cs

@@ -2,6 +2,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
+using Kiota.Builder.Extensions;
 
 namespace Kiota.Builder.CodeDOM;
 
@@ -74,7 +75,7 @@ public object Clone()
 public class CodeMethod : CodeTerminalWithKind<CodeMethodKind>, ICloneable, IDocumentedElement
 {
     public static readonly CodeParameterKind ParameterKindForConvertedIndexers = CodeParameterKind.Custom;
-    public static CodeMethod FromIndexer(CodeIndexer originalIndexer, string? methodNameSuffix, bool parameterNullable)
+    public static CodeMethod FromIndexer(CodeIndexer originalIndexer, Func<string, string> methodNameCallback, Func<string, string> parameterNameCallback, bool parameterNullable)
     {
         ArgumentNullException.ThrowIfNull(originalIndexer);
         var method = new CodeMethod
@@ -83,7 +84,7 @@ public static CodeMethod FromIndexer(CodeIndexer originalIndexer, string? method
             IsStatic = false,
             Access = AccessModifier.Public,
             Kind = CodeMethodKind.IndexerBackwardCompatibility,
-            Name = originalIndexer.PathSegment + methodNameSuffix,
+            Name = methodNameCallback(originalIndexer.IndexParameterName),
             Documentation = new()
             {
                 Description = originalIndexer.Documentation.Description,
@@ -95,7 +96,7 @@ public static CodeMethod FromIndexer(CodeIndexer originalIndexer, string? method
             method.ReturnType.IsNullable = false;
         var parameter = new CodeParameter
         {
-            Name = "id",
+            Name = parameterNameCallback(originalIndexer.IndexParameterName),
             Optional = false,
             Kind = ParameterKindForConvertedIndexers,
             Documentation = new()

src/Kiota.Builder/KiotaBuilder.cs

@@ -858,6 +858,7 @@ private CodeIndexer CreateIndexer(string childIdentifier, string childType, Open
             ReturnType = new CodeType { Name = childType },
             SerializationName = currentNode.Segment.SanitizeParameterNameForUrlTemplate(),
             PathSegment = parentNode.GetNodeNamespaceFromPath(string.Empty).Split('.').Last(),
+            IndexParameterName = currentNode.Segment.CleanupSymbolName(),
         };
     }
 

src/Kiota.Builder/Refiners/CommonLanguageRefiner.cs

@@ -657,59 +657,15 @@ protected static void MoveClassesWithNamespaceNamesUnderNamespace(CodeElement cu
         }
         CrawlTree(currentElement, MoveClassesWithNamespaceNamesUnderNamespace);
     }
-    protected static void ReplaceIndexersByMethodsWithParameter(CodeElement currentElement, bool parameterNullable, string? methodNameSuffix = default)
+    protected static void ReplaceIndexersByMethodsWithParameter(CodeElement currentElement, bool parameterNullable, Func<string, string> methodNameCallback, Func<string, string> parameterNameCallback)
     {
         if (currentElement is CodeIndexer currentIndexer &&
-            currentElement.Parent is CodeClass indexerParentClass &&
-            indexerParentClass.Parent is CodeNamespace indexerNamespace &&
-            indexerNamespace.Parent is CodeNamespace lookupNamespace)
+            currentElement.Parent is CodeClass indexerParentClass)
         {
             indexerParentClass.RemoveChildElement(currentElement);
-            AddIndexerMethod(indexerParentClass,
-                            methodNameSuffix,
-                            parameterNullable,
-                            currentIndexer,
-                            lookupNamespace);
-        }
-        CrawlTree(currentElement, c => ReplaceIndexersByMethodsWithParameter(c, parameterNullable, methodNameSuffix));
-    }
-    private static void AddIndexerMethod(CodeClass indexerParentClass, string? methodNameSuffix, bool parameterNullable, CodeIndexer currentIndexer, CodeNamespace lookupNamespace)
-    {
-        if (lookupNamespace.Classes
-                            .Where(static x => x.IsOfKind(CodeClassKind.RequestBuilder))
-                            .SelectMany(static x => x.Properties)
-                            .Where(x => x.IsOfKind(CodePropertyKind.RequestBuilder) &&
-                                    x.Type is CodeType xType &&
-                                    xType.TypeDefinition == indexerParentClass)
-                            .Select(static x => x.Parent)
-                            .OfType<CodeClass>()
-                            .FirstOrDefault() is CodeClass parentClassForProperty)
-        {
-            parentClassForProperty.AddMethod(CodeMethod.FromIndexer(currentIndexer, methodNameSuffix, parameterNullable));
-        }
-        else if (lookupNamespace.Classes
-                            .Where(static x => x.IsOfKind(CodeClassKind.RequestBuilder))
-                            .SelectMany(static x => x.Methods)
-                            .Where(x => x.IsOfKind(CodeMethodKind.RequestBuilderWithParameters, CodeMethodKind.RequestBuilderBackwardCompatibility) &&
-                                        x.ReturnType is CodeType xMethodType &&
-                                        xMethodType.TypeDefinition == indexerParentClass)
-                            .Select(static x => x.Parent)
-                            .OfType<CodeClass>()
-                            .FirstOrDefault() is CodeClass parentClassForMethod)
-        {
-            parentClassForMethod.AddMethod(CodeMethod.FromIndexer(currentIndexer, methodNameSuffix, parameterNullable));
-        }
-        else if (lookupNamespace.GetImmediateParentOfType<CodeNamespace>() is CodeNamespace parentNamespace &&
-            parentNamespace.Classes
-                            .Where(static x => x.IsOfKind(CodeClassKind.RequestBuilder))
-                            .SelectMany(static x => x.Methods)
-                            .FirstOrDefault(x => x.IsOfKind(CodeMethodKind.IndexerBackwardCompatibility) &&
-                                x.ReturnType is CodeType xMethodType &&
-                                xMethodType.TypeDefinition == indexerParentClass)
-                            is not null)
-        {
-            indexerParentClass.AddMethod(CodeMethod.FromIndexer(currentIndexer, methodNameSuffix, parameterNullable)); //we already went one up with the previous indexer
+            indexerParentClass.AddMethod(CodeMethod.FromIndexer(currentIndexer, methodNameCallback, parameterNameCallback, parameterNullable));
         }
+        CrawlTree(currentElement, c => ReplaceIndexersByMethodsWithParameter(c, parameterNullable, methodNameCallback, parameterNameCallback));
     }
     internal void DisableActionOf(CodeElement current, params CodeParameterKind[] kinds)
     {

src/Kiota.Builder/Refiners/GoRefiner.cs

@@ -32,7 +32,8 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
             ReplaceIndexersByMethodsWithParameter(
                 generatedCode,
                 false,
-                "ById");
+                static x => $"With{x.ToFirstCharacterUpperCase()}",
+                static x => x.ToFirstCharacterLowerCase());
             FlattenNestedHierarchy(generatedCode);
             FlattenGoParamsFileNames(generatedCode);
             FlattenGoFileNames(generatedCode);

src/Kiota.Builder/Refiners/JavaRefiner.cs

@@ -51,7 +51,10 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
             });
             RemoveClassNamePrefixFromNestedClasses(generatedCode);
             InsertOverrideMethodForRequestExecutorsAndBuildersAndConstructors(generatedCode);
-            ReplaceIndexersByMethodsWithParameter(generatedCode, true);
+            ReplaceIndexersByMethodsWithParameter(generatedCode,
+                true,
+                static x => $"With{x.ToFirstCharacterUpperCase()}",
+                static x => x.ToFirstCharacterLowerCase());
             cancellationToken.ThrowIfCancellationRequested();
             RemoveCancellationParameter(generatedCode);
             ConvertUnionTypesToWrapper(generatedCode,

src/Kiota.Builder/Refiners/PhpRefiner.cs

@@ -37,7 +37,10 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
             cancellationToken.ThrowIfCancellationRequested();
             CorrectParameterType(generatedCode);
             MakeModelPropertiesNullable(generatedCode);
-            ReplaceIndexersByMethodsWithParameter(generatedCode, false, "ById");
+            ReplaceIndexersByMethodsWithParameter(generatedCode,
+                false,
+                static x => $"With{x.ToFirstCharacterUpperCase()}",
+                static x => x.ToFirstCharacterLowerCase());
             cancellationToken.ThrowIfCancellationRequested();
             MoveClassesWithNamespaceNamesUnderNamespace(generatedCode);
             AddDiscriminatorMappingsUsingsToParentClasses(

src/Kiota.Builder/Refiners/PythonRefiner.cs

@@ -20,7 +20,10 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
             DisableActionOf(generatedCode,
             CodeParameterKind.RequestConfiguration);
             cancellationToken.ThrowIfCancellationRequested();
-            ReplaceIndexersByMethodsWithParameter(generatedCode, false, "_by_id");
+            ReplaceIndexersByMethodsWithParameter(generatedCode,
+                false,
+                static x => $"_with_{x.ToSnakeCase()}",
+                static x => x.ToSnakeCase());
             RemoveCancellationParameter(generatedCode);
             CorrectCoreType(generatedCode, CorrectMethodType, CorrectPropertyType, CorrectImplements);
             cancellationToken.ThrowIfCancellationRequested();

src/Kiota.Builder/Refiners/RubyRefiner.cs

@@ -17,7 +17,10 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
         return Task.Run(() =>
         {
             cancellationToken.ThrowIfCancellationRequested();
-            ReplaceIndexersByMethodsWithParameter(generatedCode, false, "_by_id");
+            ReplaceIndexersByMethodsWithParameter(generatedCode,
+                false,
+                static x => $"_with_{x.ToSnakeCase()}",
+                static x => x.ToSnakeCase());
             MoveRequestBuilderPropertiesToBaseType(generatedCode,
                 new CodeUsing
                 {

src/Kiota.Builder/Refiners/SwiftRefiner.cs

@@ -21,7 +21,8 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
             ReplaceIndexersByMethodsWithParameter(
                 generatedCode,
                 false,
-                "ById");
+                static x => $"With{x.ToFirstCharacterUpperCase()}",
+                static x => x.ToFirstCharacterUpperCase());
             cancellationToken.ThrowIfCancellationRequested();
             ReplaceReservedNames(
                 generatedCode,

src/Kiota.Builder/Refiners/TypeScriptRefiner.cs

@@ -26,7 +26,10 @@ public override Task Refine(CodeNamespace generatedCode, CancellationToken cance
                     IsExternal = true
                 }
             });
-            ReplaceIndexersByMethodsWithParameter(generatedCode, false, "ById");
+            ReplaceIndexersByMethodsWithParameter(generatedCode,
+                false,
+                static x => $"with{x.ToFirstCharacterUpperCase()}",
+                static x => x.ToFirstCharacterLowerCase());
             RemoveCancellationParameter(generatedCode);
             CorrectCoreType(generatedCode, CorrectMethodType, CorrectPropertyType, CorrectImplements);
             CorrectCoreTypesForBackingStore(generatedCode, "BackingStoreFactorySingleton.instance.createBackingStore()");

src/Kiota.Builder/Writers/Java/CodeMethodWriter.cs

@@ -377,7 +377,7 @@ private void WriteIndexerBody(CodeMethod codeElement, CodeClass parentClass, Lan
     {
         if (parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters) is CodeProperty pathParametersProperty && codeElement.OriginalIndexer != null)
             conventions.AddParametersAssignment(writer, pathParametersProperty.Type, $"this.{pathParametersProperty.Name}",
-                parameters: (codeElement.OriginalIndexer.IndexType, codeElement.OriginalIndexer.SerializationName, "id"));
+                parameters: (codeElement.OriginalIndexer.IndexType, codeElement.OriginalIndexer.SerializationName, codeElement.OriginalIndexer.IndexParameterName.ToFirstCharacterLowerCase()));
         conventions.AddRequestBuilderBody(parentClass, returnType, writer, conventions.TempDictionaryVarName);
     }
     private void WriteDeserializerBody(CodeMethod codeElement, CodeClass parentClass, LanguageWriter writer, bool inherits)

src/Kiota.Builder/Writers/Php/CodeMethodWriter.cs

@@ -583,7 +583,7 @@ private void WriteIndexerBody(CodeMethod codeElement, CodeClass parentClass, str
         if (parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters) is CodeProperty pathParametersProperty &&
             codeElement.OriginalIndexer != null)
             conventions.AddParametersAssignment(writer, pathParametersProperty.Type, $"$this->{pathParametersProperty.Name}",
-                (codeElement.OriginalIndexer.IndexType, codeElement.OriginalIndexer.SerializationName, "$id"));
+                (codeElement.OriginalIndexer.IndexType, codeElement.OriginalIndexer.SerializationName, $"${codeElement.OriginalIndexer.IndexParameterName.ToFirstCharacterLowerCase()}"));
         conventions.AddRequestBuilderBody(parentClass, returnType, writer, conventions.TempDictionaryVarName, pathParameters);
     }
 

src/Kiota.Builder/Writers/Python/CodeMethodWriter.cs

@@ -117,7 +117,7 @@ private void WriteIndexerBody(CodeMethod codeElement, CodeClass parentClass, str
         if (parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters) is CodeProperty pathParametersProperty &&
             codeElement.OriginalIndexer != null)
             conventions.AddParametersAssignment(writer, pathParametersProperty.Type, $"self.{pathParametersProperty.Name}",
-                (codeElement.OriginalIndexer.IndexType, codeElement.OriginalIndexer.SerializationName, "id"));
+                (codeElement.OriginalIndexer.IndexType, codeElement.OriginalIndexer.SerializationName, codeElement.OriginalIndexer.IndexParameterName.ToSnakeCase()));
         conventions.AddRequestBuilderBody(parentClass, returnType, writer, conventions.TempDictionaryVarName);
     }
     private void WriteRequestBuilderWithParametersBody(CodeMethod codeElement, CodeClass parentClass, string returnType, LanguageWriter writer)

src/Kiota.Builder/Writers/Ruby/CodeMethodWriter.cs

@@ -200,7 +200,7 @@ private void WriteIndexerBody(CodeMethod codeElement, CodeClass parentClass, Lan
         if (parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters) is CodeProperty pathParametersProperty &&
             codeElement.OriginalIndexer != null)
             writer.WriteLines($"{conventions.TempDictionaryVarName} = @{pathParametersProperty.NamePrefix}{pathParametersProperty.Name.ToSnakeCase()}.clone",
-                            $"{conventions.TempDictionaryVarName}[\"{codeElement.OriginalIndexer.SerializationName}\"] = id");
+                            $"{conventions.TempDictionaryVarName}[\"{codeElement.OriginalIndexer.SerializationName}\"] = {codeElement.OriginalIndexer.IndexParameterName.ToSnakeCase()}");
         conventions.AddRequestBuilderBody(parentClass, returnType, writer, conventions.TempDictionaryVarName, $"return {prefix}");
     }
     private void WriteDeserializerBody(CodeClass parentClass, LanguageWriter writer)

src/Kiota.Builder/Writers/TypeScript/CodeMethodWriter.cs

@@ -119,7 +119,7 @@ private void WriteIndexerBody(CodeMethod codeElement, CodeClass parentClass, str
             codeElement.OriginalIndexer != null)
         {
             localConventions.AddParametersAssignment(writer, pathParametersProperty.Type, $"this.{pathParametersProperty.Name}",
-                parameters: (codeElement.OriginalIndexer.IndexType, codeElement.OriginalIndexer.SerializationName, "id"));
+                parameters: (codeElement.OriginalIndexer.IndexType, codeElement.OriginalIndexer.SerializationName, codeElement.OriginalIndexer.IndexParameterName.ToFirstCharacterLowerCase()));
         }
         conventions.AddRequestBuilderBody(parentClass, returnType, writer, conventions.TempDictionaryVarName);
     }

tests/Kiota.Builder.Tests/CodeDOM/CodeClassTests.cs

@@ -66,6 +66,7 @@ public void SetsIndexer()
                 IsExternal = true,
                 IsNullable = true,
             },
+            IndexParameterName = "idxSmth",
         };
         Assert.Single(codeClass.GetChildElements(true).OfType<CodeIndexer>());
         Assert.Throws<ArgumentNullException>(() =>
@@ -88,12 +89,13 @@ public void SetsIndexer()
                 IsExternal = true,
                 IsNullable = true,
             },
+            IndexParameterName = "idx2",
         };
         Assert.Empty(codeClass.GetChildElements(true).OfType<CodeIndexer>());
         var methods = codeClass.GetChildElements(true).OfType<CodeMethod>().Where(x => x.IsOfKind(CodeMethodKind.IndexerBackwardCompatibility)).ToArray();
         Assert.Equal(2, methods.Length);
-        Assert.Equal("ByIdx_smth", methods.FirstOrDefault(x => x.OriginalIndexer.Name.Equals("idx")).Name);
-        Assert.Equal("ByIdx2", methods.FirstOrDefault(x => x.OriginalIndexer.Name.Equals("idx2")).Name);
+        Assert.Equal("WithIdxSmth", methods.FirstOrDefault(static x => x.OriginalIndexer.Name.Equals("idx")).Name);
+        Assert.Equal("WithIdx2", methods.FirstOrDefault(static x => x.OriginalIndexer.Name.Equals("idx2")).Name);
     }
     [Fact]
     public void ThrowsOnAddingEmptyCollections()

tests/Kiota.Builder.Tests/CodeDOM/CodeElementComparerPythonTests.cs

@@ -51,7 +51,8 @@ public void OrdersWithMethodWithinClass()
                 },
                 IndexType = new CodeType {
                     Name = "string"
-                }
+                },
+                IndexParameterName = "param"
             }, new CodeProperty() {
                 Name = "prop",
                 Type = new CodeType {

tests/Kiota.Builder.Tests/CodeDOM/CodeElementComparerTests.cs

@@ -51,7 +51,8 @@ public void OrdersWithMethodWithinClass()
                 },
                 IndexType = new CodeType {
                     Name = "string"
-                }
+                },
+                IndexParameterName = "param"
             }, new CodeProperty() {
                 Name = "prop",
                 Type = new CodeType {
@@ -115,7 +116,8 @@ public void OrdersWithMethodsOutsideOfClass()
                 },
                 IndexType = new CodeType {
                     Name = "string"
-                }
+                },
+                IndexParameterName = "param"
             }, new CodeProperty() {
                 Name = "prop",
                 Type = new CodeType {

tests/Kiota.Builder.Tests/CodeDOM/CodeIndexerTests.cs

@@ -15,7 +15,8 @@ public void IndexerInits()
                 Description = "some description",
             },
             IndexType = new CodeType(),
-            ReturnType = new CodeType()
+            ReturnType = new CodeType(),
+            IndexParameterName = "param",
         };
     }
 }

tests/Kiota.Builder.Tests/Refiners/CSharpLanguageRefinerTests.cs

@@ -227,7 +227,8 @@ public async Task EscapesReservedKeywordsForReservedNamespaceNameSegments()
             {
                 Name = "string",
             },
-            ReturnType = indexerCodeType
+            ReturnType = indexerCodeType,
+            IndexParameterName = "id",
         };
         requestBuilder.Indexer = indexer;
 
@@ -296,7 +297,8 @@ public async Task ConvertsUnionTypesToWrapper()
             IndexType = new CodeType
             {
                 Name = "string"
-            }
+            },
+            IndexParameterName = "id",
         };
         model.Indexer = indexer;
         method.AddParameter(parameter);