Change all magic methods to start with a dollar sign to signify they aren't normal.

Author: adamghill

django_unicorn/views.py

@@ -347,15 +347,15 @@ def message(request: HttpRequest, component_name: str = None) -> JsonResponse:
             else:
                 (method_name, params) = parse_call_method_name(call_method_name)
 
-                if method_name == "refresh":
+                if method_name == "$refresh":
                     # Handle the refresh special action
                     component = UnicornView.create(
                         component_id=component_request.id,
                         component_name=component_name,
                         use_cache=True,
                         request=request,
                     )
-                elif method_name == "reset":
+                elif method_name == "$reset":
                     # Handle the reset special action
                     component = UnicornView.create(
                         component_id=component_request.id,
@@ -367,13 +367,13 @@ def message(request: HttpRequest, component_name: str = None) -> JsonResponse:
                     #  Explicitly remove all errors and prevent validation from firing before render()
                     component.errors = {}
                     is_reset_called = True
-                elif method_name == "toggle":
+                elif method_name == "$toggle":
                     for property_name in params:
                         property_value = _get_property_value(component, property_name)
                         property_value = not property_value
 
                         _set_property_value(component, property_name, property_value)
-                elif method_name == "validate":
+                elif method_name == "$validate":
                     # Handle the validate special action
                     validate_all_fields = True
                 else:

example/unicorn/templates/unicorn/hello-world-test.html

@@ -1,5 +1,5 @@
 <div>
-    <button unicorn:click="reset">Reset the component</button>
+    <button unicorn:click="$reset">Reset the component</button>
     <br />
     <br />
 

example/unicorn/templates/unicorn/html-inputs.html

@@ -8,7 +8,7 @@ <h2>Checkbox</h2>
     <div>
         <h2>Boolean Toggles</h2>
         {% if another_check %}YAYAYA{% else %}Noooooooo{% endif %}<br />
-        <button unicorn:click="toggle('is_checked', 'another_check')" id="toggle-check">Toggle booleans</button>
+        <button unicorn:click="$toggle('is_checked', 'another_check')" id="toggle-check">Toggle booleans</button>
     </div>
 
     <div>

example/unicorn/templates/unicorn/models.html

@@ -101,6 +101,6 @@ <h4>PK: {{ flavor.pk }}</h4>
     </div>
     <br />
 
-    <button unicorn:click="refresh">Refresh</button>
-    <button unicorn:click="reset">Reset</button>
+    <button unicorn:click="$refresh">$refresh</button>
+    <button unicorn:click="$reset">$reset</button>
 </div>

example/unicorn/templates/unicorn/objects.html

@@ -73,6 +73,6 @@
         </ul>
     </div>
 
-    <button u:click="reset">reset</button>
-    <button u:click="refresh">refresh</button>
+    <button u:click="$reset">$reset</button>
+    <button u:click="$refresh">$refresh</button>
 </div>

example/unicorn/templates/unicorn/text-inputs.html

@@ -1,5 +1,5 @@
 <div>
-    <button unicorn:click="reset">Reset the component</button>
+    <button unicorn:click="$reset">Reset the component</button>
     <br />
     <br />
 

example/unicorn/templates/unicorn/validation.html

@@ -48,10 +48,10 @@
             <a href="blob" unicorn:click.prevent="text='prevent?'">set_text_no_validation()</a>
             <button unicorn:click="set_text_no_validation">set_text_no_validation()</button>
             <button unicorn:click="set_text_with_validation">set_text_with_validation()</button>
-            <button unicorn:click="validate">validate()</button>
-            <button unicorn:click="reset">reset()</button>
-            <button unicorn:click="reset()">reset() 2</button>
-            <button unicorn:click="refresh">refresh()</button>
+            <button unicorn:click="$validate">$validate</button>
+            <button unicorn:click="$reset">$reset</button>
+            <button unicorn:click="$reset()">$reset()</button>
+            <button unicorn:click="$refresh">$refresh</button>
         </div>
     </div>
 </div>

tests/views/message/test_call_method.py

@@ -69,7 +69,7 @@ def test_message_call_method_toggle(client):
     data = {}
     message = {
         "actionQueue": [
-            {"payload": {"name": "toggle('check')"}, "type": "callMethod",}
+            {"payload": {"name": "$toggle('check')"}, "type": "callMethod",}
         ],
         "data": data,
         "checksum": generate_checksum(orjson.dumps(data)),
@@ -91,7 +91,7 @@ def test_message_call_method_nested_toggle(client):
     data = {}
     message = {
         "actionQueue": [
-            {"payload": {"name": "toggle('nested.check')"}, "type": "callMethod",}
+            {"payload": {"name": "$toggle('nested.check')"}, "type": "callMethod",}
         ],
         "data": data,
         "checksum": generate_checksum(orjson.dumps(data)),

tests/views/message/test_db_input.py

@@ -21,7 +21,7 @@ def test_message_db_input_update(client):
                 },
                 "type": "dbInput",
             },
-            {"type": "callMethod", "payload": {"name": "refresh", "params": []}},
+            {"type": "callMethod", "payload": {"name": "$refresh", "params": []}},
         ],
         "data": data,
         "checksum": generate_checksum(orjson.dumps(data)),
@@ -68,7 +68,7 @@ def test_message_db_input_create(client):
                 },
                 "type": "dbInput",
             },
-            {"type": "callMethod", "payload": {"name": "refresh", "params": []}},
+            {"type": "callMethod", "payload": {"name": "$refresh", "params": []}},
         ],
         "data": data,
         "checksum": generate_checksum(orjson.dumps(data)),