From 4f4df628b7c3e2d8ffd8c0690f33974d189c76e7 Mon Sep 17 00:00:00 2001
From: Henddher Pedroza <henddher.pedroza@gmail.com>
Date: Sun, 28 Oct 2018 09:43:01 -0500
Subject: [PATCH] #1704: Update _RE_DBREF to match '(#Number)' so that it
 aliases to '(#Number)'

---
 evennia/prototypes/prototypes.py |  4 +--
 evennia/prototypes/tests.py      | 52 ++++++++++++++++++++++----------
 2 files changed, 38 insertions(+), 18 deletions(-)

diff --git a/evennia/prototypes/prototypes.py b/evennia/prototypes/prototypes.py
index 833316cf59..020c6c84cf 100644
--- a/evennia/prototypes/prototypes.py
+++ b/evennia/prototypes/prototypes.py
@@ -33,7 +33,7 @@ _PROTOTYPE_TAG_CATEGORY = "from_prototype"
 _PROTOTYPE_TAG_META_CATEGORY = "db_prototype"
 PROT_FUNCS = {}
 
-_RE_DBREF = re.compile(r"(?<!\$obj\()(#[0-9]+)")
+_RE_DBREF = re.compile(r"\$dbref\((\#[0-9]+)\)")
 
 
 class PermissionError(RuntimeError):
@@ -576,7 +576,7 @@ def protfunc_parser(value, available_functions=None, testing=False, stacktrace=F
 
     available_functions = PROT_FUNCS if available_functions is None else available_functions
 
-    # insert $obj(#dbref) for #dbref
+    # $dbref(#Number) becomes $obj(#Number)
     value = _RE_DBREF.sub("$obj(\\1)", value)
 
     result = inlinefuncs.parse_inlinefunc(
diff --git a/evennia/prototypes/tests.py b/evennia/prototypes/tests.py
index fe75ccf4ec..6091c2a06f 100644
--- a/evennia/prototypes/tests.py
+++ b/evennia/prototypes/tests.py
@@ -263,23 +263,36 @@ class TestProtFuncs(EvenniaTest):
                      "key": "ExampleObj"}
 
     def test_RE_DBREF(self):
-        def check_RE_DBREF(value, expected_value):
+        def check_RE_DBREF(value, expected_value,
+                exp_is_match, exp_is_search):
             try:
-                result = (
-                    protlib._RE_DBREF.match(value),
-                    protlib._RE_DBREF.search(value),
-                    protlib._RE_DBREF.sub("$obj(\\1)", value)
-                )
-                assert expected_value == result[2]
-            except Exception:
-                self.fail()
-                pass
+                mm = protlib._RE_DBREF.match(value)
+                ms = protlib._RE_DBREF.search(value)
+                sub1 = protlib._RE_DBREF.sub("$obj(\\1)", value)
+                assert expected_value == sub1
+                assert (exp_is_match and mm) or (not exp_is_match and mm is None)
+                assert (exp_is_search and ms) or (not exp_is_search and ms is None)
+            except Exception as e:
+                self.fail("%r" % ((value, mm, ms, expected_value, exp_is_match, exp_is_search, e),))
 
-        check_RE_DBREF('#1234', '#1234')
-        check_RE_DBREF('(#1234)', '(#1234)')
-        check_RE_DBREF('obj(#1234)', 'obj(#1234)')
-        check_RE_DBREF('$obj(#1234)', '$obj(#1234)')
-        check_RE_DBREF('obj($obj(#1234))', 'obj($obj(#1234))')
+        check_RE_DBREF('1234', '1234', False, False)
+        check_RE_DBREF('#1234', '#1234', False, False)
+        check_RE_DBREF('(#1234)', '(#1234)', False, False)
+        check_RE_DBREF('obj(#1234)', 'obj(#1234)', False, False)
+        check_RE_DBREF('dbref(#1234)', 'dbref(#1234)', False, False)
+        check_RE_DBREF('$obj(#1234)', '$obj(#1234)', False, False)
+        check_RE_DBREF('$dbref(#1234)', '$obj(#1234)', True, True)
+        check_RE_DBREF('obj($obj(#1234))', 'obj($obj(#1234))', False, False)
+        check_RE_DBREF('obj($dbref(#1234))', 'obj($obj(#1234))', False, True)
+        check_RE_DBREF('some #1234 value', 'some #1234 value', False, False)
+        check_RE_DBREF('some (#1234) value', 'some (#1234) value', False, False)
+        check_RE_DBREF('some obj(#1234) value', 'some obj(#1234) value', False, False)
+        check_RE_DBREF('some dbref(#1234) value', 'some dbref(#1234) value', False, False)
+        check_RE_DBREF('some $dbref(#1234) value', 'some $obj(#1234) value', False, True)
+        check_RE_DBREF('some obj($obj(#1234) value)', 'some obj($obj(#1234) value)', False, False)
+        check_RE_DBREF('some obj($dbref(#1234) value)', 'some obj($obj(#1234) value)', False, True)
+        check_RE_DBREF('some dbref($obj(#1234) value)', 'some dbref($obj(#1234) value)', False, False)
+        check_RE_DBREF('some dbref($dbref(#1234) value)', 'some dbref($obj(#1234) value)', False, True)
 
     @mock.patch("evennia.prototypes.protfuncs.base_random", new=mock.MagicMock(return_value=0.5))
     @mock.patch("evennia.prototypes.protfuncs.base_randint", new=mock.MagicMock(return_value=5))
@@ -331,15 +344,22 @@ class TestProtFuncs(EvenniaTest):
         self.assertEqual(protlib.protfunc_parser(
             "$eval({'test': '1', 2:3, 3: $toint(3.5)})"), {'test': '1', 2: 3, 3: 3})
 
+        self.assertEqual(protlib.protfunc_parser("obj(#1)", session=self.session), 'obj(#1)')
         self.assertEqual(protlib.protfunc_parser("$obj(#1)", session=self.session), '#1')
+        self.assertEqual(protlib.protfunc_parser("dbref(#1)", session=self.session), 'dbref(#1)')
+        self.assertEqual(protlib.protfunc_parser("$dbref(#1)", session=self.session), '#1')
+        self.assertEqual(protlib.protfunc_parser("$badfunc(#1)", session=self.session), '<UNKNOWN>')
         self.assertEqual(protlib.protfunc_parser("stone(#12345)", session=self.session), 'stone(#12345)')
         self.assertEqual(protlib.protfunc_parser("#1", session=self.session), '#1')
         self.assertEqual(protlib.protfunc_parser("#12345", session=self.session), '#12345')
         self.assertEqual(protlib.protfunc_parser("nothing(#1)", session=self.session), 'nothing(#1)')
         self.assertEqual(protlib.protfunc_parser("(#12345)", session=self.session), '(#12345)')
         self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6')
-        self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6')
+        self.assertEqual(protlib.protfunc_parser("obj(Char)", session=self.session), 'obj(Char)')
         self.assertEqual(protlib.protfunc_parser("$objlist(#1)", session=self.session), ['#1'])
+        self.assertEqual(protlib.protfunc_parser("objlist(#1)", session=self.session), 'objlist(#1)')
+        self.assertEqual(protlib.protfunc_parser("dbref(Char)", session=self.session), 'dbref(Char)')
+        self.assertEqual(protlib.protfunc_parser("$dbref(Char)", session=self.session), '<UNKNOWN>')