pytest-httpchain-jsonref 0.2.1__tar.gz → 0.3.0__tar.gz

{pytest_httpchain_jsonref-0.2.1 → pytest_httpchain_jsonref-0.3.0}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.3
 Name: pytest-httpchain-jsonref
-Version: 0.2.1
+Version: 0.3.0
 Summary: JSON reference ($ref) support for pytest-httpchain
 Author: Alexander Eresov
 Author-email: Alexander Eresov <aeresov@gmail.com>
 Requires-Dist: deepmerge>=2.0
+Requires-Dist: pytest-httpchain-core
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 

{pytest_httpchain_jsonref-0.2.1 → pytest_httpchain_jsonref-0.3.0}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "pytest-httpchain-jsonref"
-version = "0.2.1"
+version = "0.3.0"
 description = "JSON reference ($ref) support for pytest-httpchain"
 readme = "README.md"
 requires-python = ">=3.13"
 authors = [{ name = "Alexander Eresov", email = "aeresov@gmail.com" }]
-dependencies = ["deepmerge>=2.0"]
+dependencies = ["deepmerge>=2.0", "pytest-httpchain-core"]
 
 [build-system]
 requires = ["uv_build>=0.7.21,<0.8.0"]

pytest_httpchain_jsonref-0.3.0/src/pytest_httpchain_jsonref/exceptions.py

@@ -0,0 +1,5 @@
+from pytest_httpchain_core import HttpChainError
+
+
+class ReferenceResolverError(HttpChainError):
+    """Exception for reference resolution errors."""

{pytest_httpchain_jsonref-0.2.1 → pytest_httpchain_jsonref-0.3.0}/src/pytest_httpchain_jsonref/loader.py

@@ -7,15 +7,18 @@ from pytest_httpchain_jsonref.plumbing.reference import ReferenceResolver
 
 
 def load_json(path: Path, max_parent_traversal_depth: int = 3, root_path: Path | None = None) -> dict[str, Any]:
-    """Load JSON from file and resolve all $ref statements with circular reference protection.
+    """Load JSON from file and resolve all $include/$merge/$ref statements with circular reference protection.
+
+    All three directives ($include, $merge, $ref) work identically. $include and $merge are preferred
+    as they avoid conflicts with VS Code's JSON Schema validation (which treats $ref specially).
 
     Args:
         path: Path to the JSON file to load
-        max_parent_traversal_depth: Maximum number of parent directory traversals allowed in $ref paths
+        max_parent_traversal_depth: Maximum number of parent directory traversals allowed in reference paths
         root_path: Optional root directory for resolving references (e.g., pytest's rootdir)
 
     Returns:
-        Dictionary with all $ref statements resolved
+        Dictionary with all $include/$ref statements resolved
 
     Raises:
         ReferenceResolverError: If the file cannot be loaded or parsed, if merge conflicts occur, or if circular references are detected

{pytest_httpchain_jsonref-0.2.1 → pytest_httpchain_jsonref-0.3.0}/src/pytest_httpchain_jsonref/plumbing/path.py

@@ -46,6 +46,11 @@ class PathValidator:
         # Try resolving from different base paths in order of preference
         paths_to_try = [base_path]
 
+        # Add CWD so that paths like "tests/common.json" resolve from where the user runs the tool
+        cwd = Path.cwd()
+        if cwd.resolve() not in (base_path_resolved, root_path_resolved):
+            paths_to_try.append(cwd)
+
         # Add root_path if it's different from base_path
         if root_path_resolved != base_path_resolved:
             paths_to_try.append(root_path)

{pytest_httpchain_jsonref-0.2.1 → pytest_httpchain_jsonref-0.3.0}/src/pytest_httpchain_jsonref/plumbing/reference.py

@@ -14,6 +14,9 @@ from pytest_httpchain_jsonref.plumbing.path import PathValidator
 
 REF_PATTERN = re.compile(r"^(?P<file>[^#]+)?(?:#(?P<pointer>/.*))?$")
 
+# Supported reference keys: $include/$merge (preferred, avoids VS Code conflicts) and $ref (legacy)
+REF_KEYS = ("$include", "$merge", "$ref")
+
 
 class ReferenceResolver:
     """Resolves JSON references ($ref) in documents."""
@@ -54,8 +57,7 @@ class ReferenceResolver:
             ReferenceResolverError: If the file cannot be loaded or references cannot be resolved
         """
         try:
-            with open(path, encoding="utf-8") as f:
-                data = json.load(f)
+            data = json.loads(path.read_text(encoding="utf-8"))
 
             # If root_path wasn't provided, find a suitable one by going up the directory tree
             # up to max_parent_traversal_depth levels
@@ -79,7 +81,7 @@ class ReferenceResolver:
         root_data: Any,
     ) -> Any:
         match data:
-            case dict() if "$ref" in data:
+            case dict() if self._get_ref_key(data):
                 return self._resolve_single_ref(data, current_path, root_data)
             case dict():
                 return {key: self._resolve_refs(value, current_path, root_data) for key, value in data.items()}
@@ -88,17 +90,26 @@ class ReferenceResolver:
             case _:
                 return data
 
+    def _get_ref_key(self, data: dict[str, Any]) -> str | None:
+        """Get the reference key ($include or $ref) if present in data."""
+        for key in REF_KEYS:
+            if key in data:
+                return key
+        return None
+
     def _resolve_single_ref(
         self,
         data: dict[str, Any],
         current_path: Path,
         root_data: Any,
     ) -> Any:
-        ref_value = data["$ref"]
+        ref_key = self._get_ref_key(data)
+        assert ref_key is not None
+        ref_value = data[ref_key]
         match = REF_PATTERN.match(ref_value)
 
         if not match:
-            raise ReferenceResolverError(f"Invalid $ref format: {ref_value}")
+            raise ReferenceResolverError(f"Invalid {ref_key} format: {ref_value}")
 
         file_path = match.group("file")
         pointer = match.group("pointer") or ""
@@ -174,7 +185,7 @@ class ReferenceResolver:
         current_path: Path,
         root_data: Any,
     ) -> Any:
-        siblings = {k: v for k, v in ref_dict.items() if k != "$ref"}
+        siblings = {k: v for k, v in ref_dict.items() if k not in REF_KEYS}
 
         if not siblings:
             return referenced_data
@@ -192,8 +203,7 @@ class ReferenceResolver:
 
     def _load_json_file(self, path: Path) -> dict[str, Any]:
         """Load JSON file content."""
-        with open(path, encoding="utf-8") as f:
-            return json.load(f)
+        return json.loads(path.read_text(encoding="utf-8"))
 
     def _create_child_resolver(self) -> Self:
         """Create a child resolver with inherited state."""

pytest_httpchain_jsonref-0.2.1/src/pytest_httpchain_jsonref/exceptions.py

@@ -1,2 +0,0 @@
-class ReferenceResolverError(Exception):
-    """Base exception for reference resolution errors."""