Add node argument to process_name hook

Author: mat-sop

PLUGINS.md

@@ -287,7 +287,7 @@ Hook executed on generation of init code. Result is used as content of `__init__
 ### process_name
 
 ```py
-def process_name(self, name: str) -> str:
+def process_name(self, name: str, node: Optional[Node] = None) -> str:
 ```
 
 Hook executed on processing of GraphQL field, argument or operation name.

ariadne_codegen/client_generators/arguments.py

@@ -62,6 +62,7 @@ def generate(
                 org_name,
                 convert_to_snake_case=self.convert_to_snake_case,
                 plugin_manager=self.plugin_manager,
+                node=variable_definition,
             )
             annotation, used_custom_scalar = self._parse_type_node(
                 variable_definition.type

ariadne_codegen/client_generators/input_types.py

@@ -113,6 +113,7 @@ def _parse_input_definition(
                 org_name,
                 convert_to_snake_case=self.convert_to_snake_case,
                 plugin_manager=self.plugin_manager,
+                node=field,
             )
             annotation, field_type = parse_input_field_type(
                 field.type, custom_scalars=self.custom_scalars

ariadne_codegen/client_generators/package.py

@@ -181,7 +181,10 @@ def add_operation(self, definition: OperationDefinitionNode):
 
         return_type_name = str_to_pascal_case(name.value)
         method_name = process_name(
-            name.value, convert_to_snake_case=True, plugin_manager=self.plugin_manager
+            name.value,
+            convert_to_snake_case=True,
+            plugin_manager=self.plugin_manager,
+            node=definition,
         )
         module_name = method_name
         file_name = f"{module_name}.py"

ariadne_codegen/client_generators/result_types.py

@@ -185,7 +185,7 @@ def _parse_type_definition(
             start=1,
         ):
             field_name = self._get_field_name(field)
-            name = self._process_field_name(field_name)
+            name = self._process_field_name(field_name, field=field)
             field_definition = self._get_field_from_schema(type_name, field.name.value)
             annotation, field_types_names = parse_operation_field(
                 field=field,
@@ -269,13 +269,14 @@ def _get_field_name(self, field: FieldNode) -> str:
             return field.alias.value
         return field.name.value
 
-    def _process_field_name(self, name: str) -> str:
+    def _process_field_name(self, name: str, field: FieldNode) -> str:
         if self.convert_to_snake_case and name == TYPENAME_FIELD_NAME:
             return "__typename__"
         return process_name(
             name,
             convert_to_snake_case=self.convert_to_snake_case,
             plugin_manager=self.plugin_manager,
+            node=field,
         )
 
     def _get_field_from_schema(self, type_name: str, field_name: str) -> GraphQLField:

ariadne_codegen/plugins/base.py

@@ -1,12 +1,13 @@
 import ast
-from typing import Dict, Tuple, Union
+from typing import Dict, Optional, Tuple, Union
 
 from graphql import (
     FieldNode,
     GraphQLEnumType,
     GraphQLInputField,
     GraphQLInputObjectType,
     GraphQLSchema,
+    Node,
     OperationDefinitionNode,
     SelectionSetNode,
     VariableDefinitionNode,
@@ -145,5 +146,6 @@ def generate_scalars_code(self, generated_code: str) -> str:
     def generate_init_code(self, generated_code: str) -> str:
         return generated_code
 
-    def process_name(self, name: str) -> str:
+    # pylint: disable=unused-argument
+    def process_name(self, name: str, node: Optional[Node] = None) -> str:
         return name

ariadne_codegen/plugins/manager.py

@@ -7,6 +7,7 @@
     GraphQLInputField,
     GraphQLInputObjectType,
     GraphQLSchema,
+    Node,
     OperationDefinitionNode,
     SelectionSetNode,
     VariableDefinitionNode,
@@ -187,5 +188,5 @@ def generate_scalars_code(self, generated_code: str) -> str:
     def generate_init_code(self, generated_code: str) -> str:
         return self._apply_plugins_on_object("generate_init_code", generated_code)
 
-    def process_name(self, name: str) -> str:
-        return self._apply_plugins_on_object("process_name", name)
+    def process_name(self, name: str, node: Optional[Node] = None) -> str:
+        return self._apply_plugins_on_object("process_name", name, node=node)

ariadne_codegen/utils.py

@@ -7,6 +7,7 @@
 import isort
 from autoflake import fix_code  # type: ignore
 from black import Mode, format_str
+from graphql import Node
 
 from .plugins.manager import PluginManager
 
@@ -80,6 +81,7 @@ def process_name(
     name: str,
     convert_to_snake_case: bool,
     plugin_manager: Optional[PluginManager] = None,
+    node: Optional[Node] = None,
 ) -> str:
     """Processes the GraphQL name to remove keywords
     and optionally convert to snake_case."""
@@ -89,5 +91,5 @@ def process_name(
     if iskeyword(processed_name):
         processed_name += "_"
     if plugin_manager:
-        processed_name = plugin_manager.process_name(processed_name)
+        processed_name = plugin_manager.process_name(processed_name, node=node)
     return processed_name

tests/conftest.py

@@ -3,7 +3,7 @@
 
 @pytest.fixture
 def mocked_plugin_manager(mocker):
-    def no_effect_method(obj, *_):
+    def no_effect_method(obj, *_, **__):
         return obj
 
     manager = mocker.MagicMock()

tests/plugins/test_manager.py

@@ -326,7 +326,7 @@ def test_generate_init_code_calls_plugins_generate_init_code(
 
 
 def test_process_name_calls_plugins_process_name(plugin_manager_with_mocked_plugins):
-    plugin_manager_with_mocked_plugins.process_name("")
+    plugin_manager_with_mocked_plugins.process_name("", OperationDefinitionNode())
 
     assert plugin_manager_with_mocked_plugins.plugins[0].process_name.called
     assert plugin_manager_with_mocked_plugins.plugins[1].process_name.called