feat: support reading metadata from package.json

Author: agoose77

hatch_nodejs_version/metadata_source.py

@@ -92,6 +92,8 @@ def _parse_repository(self, repository: str | dict[str, str]) -> str:
     def update(self, metadata: dict[str, Any]):
         package = self.load_package_data()
 
+        metadata["name"] = package["name"]
+
         if "author" in package:
             metadata["author"] = self._parse_person(package["author"])
 

tests/conftest.py

@@ -3,11 +3,13 @@
 #
 # SPDX-License-Identifier: MIT
 import errno
+import os
 import shutil
 import stat
 import tempfile
 from contextlib import contextmanager
-import os
+import pathlib
+
 import pytest
 
 
@@ -21,6 +23,27 @@ def create_file(path, contents):
         f.write(contents)
 
 
+@contextmanager
+def create_project(directory):
+    project_dir = directory / "my-app"
+    os.mkdir(project_dir)
+
+    package_dir = project_dir / "my_app"
+    os.mkdir(package_dir)
+
+    touch_file(package_dir / "__init__.py")
+    touch_file(package_dir / "foo.py")
+    touch_file(package_dir / "bar.py")
+    touch_file(package_dir / "baz.py")
+
+    origin = os.getcwd()
+    os.chdir(project_dir)
+    try:
+        yield project_dir
+    finally:
+        os.chdir(origin)
+
+
 def handle_remove_readonly(func, path, exc):  # no cov
     # PermissionError: [WinError 5] Access is denied: '...\\.git\\...'
     if func in (os.rmdir, os.remove, os.unlink) and exc[1].errno == errno.EACCES:
@@ -34,63 +57,13 @@ def handle_remove_readonly(func, path, exc):  # no cov
 def temp_dir():
     directory = tempfile.mkdtemp()
     try:
-        directory = os.path.realpath(directory)
+        directory = pathlib.Path(os.path.realpath(directory))
         yield directory
     finally:
         shutil.rmtree(directory, ignore_errors=False, onerror=handle_remove_readonly)
 
 
-@contextmanager
-def create_project(directory, metadata, version):
-    project_dir = os.path.join(directory, "my-app")
-    os.mkdir(project_dir)
-
-    project_file = os.path.join(project_dir, "pyproject.toml")
-    create_file(project_file, metadata)
-
-    package_dir = os.path.join(project_dir, "my_app")
-    os.mkdir(package_dir)
-
-    package_file = os.path.join(project_dir, "package.json")
-    package = f"""
-{{
-  "name": "my-awesome-package",
-  "version": "{version}",
-  
-}}
-    """
-    create_file(package_file, package)
-
-    other_package_file = os.path.join(project_dir, "other-package.json")
-    create_file(other_package_file, package)
-
-    touch_file(os.path.join(package_dir, "__init__.py"))
-    touch_file(os.path.join(package_dir, "foo.py"))
-    touch_file(os.path.join(package_dir, "bar.py"))
-    touch_file(os.path.join(package_dir, "baz.py"))
-
-    origin = os.getcwd()
-    os.chdir(project_dir)
-    try:
-        yield project_dir
-    finally:
-        os.chdir(origin)
-
-
 @pytest.fixture
-def new_project(temp_dir, request):
-    with create_project(
-        temp_dir,
-        """\
-[build-system]
-requires = ["hatchling", "hatch-vcs"]
-build-backend = "hatchling.build"
-[project]
-name = "my-app"
-dynamic = ["version"]
-[tool.hatch.version]
-source = "nodejs"
-""",
-        request.param,
-    ) as project:
+def project(temp_dir):
+    with create_project(temp_dir) as project:
         yield project

tests/test_metadata_config.py

@@ -0,0 +1,89 @@
+# SPDX-FileCopyrightText: 2022-present Angus Hollands <[email protected]>
+#
+# SPDX-License-Identifier: MIT
+import pytest
+
+from hatch_nodejs_version.metadata_source import NodeJSMetadataSource
+
+
+class TestMetadata:
+    @pytest.mark.parametrize(
+        "alt_package_json",
+        [None, "package-other.json"],
+    )
+    @pytest.mark.parametrize(
+        "pyproject_field",
+        ["urls", "description", "name", "keywords", "author", "maintainers", "license"],
+    )
+    def test_metadata_from_package(self, project, alt_package_json, pyproject_field):
+        # Create a simple project
+        (project / "pyproject.toml").write_text(
+            f"""
+[build - system]
+requires = ["hatchling", "hatch-vcs"]
+build - backend = "hatchling.build"
+[project]
+name = "my-app"
+version = "0.0.0"
+[tool.hatch.metadata.hooks.nodejs]
+ """
+        )
+        package_json = "package.json" if alt_package_json is None else alt_package_json
+        (project / package_json).write_text(
+            """
+{
+  "name": "my-app",
+  "version": "1.0.0",
+  "description": "A terrible package",
+  "keywords": [
+    "what",
+    "is",
+    "the",
+    "time"
+  ],
+  "homepage": "https://where-the-heart-is.com",
+  "bugs": {
+    "url": "https://www.send-help.com",
+    "email": "[email protected]"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Alice Roberts",
+    "email": "[email protected]"
+  },
+  "contributors": [
+        {
+        "name": "Isaac Newton",
+        "email": "[email protected]"
+      }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/some/code.git"
+  }
+}
+"""
+        )
+        config = {} if alt_package_json is None else {"path": alt_package_json}
+        metadata_source = NodeJSMetadataSource(project, config=config)
+
+        metadata = {}
+        metadata_source.update(metadata)
+
+        assert metadata["license"] == "MIT"
+        assert metadata["urls"] == {
+            "bug tracker": "https://www.send-help.com",
+            "repository": "https://github.com/some/code.git",
+            "homepage": "https://where-the-heart-is.com",
+        }
+        assert metadata["author"] == {
+            "name": "Alice Roberts",
+            "email": "[email protected]",
+        }
+
+        assert metadata["maintainers"] == [
+            {"name": "Isaac Newton", "email": "[email protected]"}
+        ]
+        assert metadata["keywords"] == ["what", "is", "the", "time"]
+        assert metadata["description"] == "A terrible package"
+        assert metadata["name"] == "my-app"

tests/test_version_config.py

@@ -2,10 +2,10 @@
 #
 # SPDX-License-Identifier: MIT
 import pytest
+import json
 
 from hatch_nodejs_version.version_source import NodeJSVersionSource
 
-
 GOOD_NODE_PYTHON_VERSIONS = [
     ("1.4.5", "1.4.5"),
     ("1.4.5-a0", "1.4.5a0"),
@@ -33,45 +33,106 @@
 ]
 
 
-class TestDefault:
+class TestVersion:
     @pytest.mark.parametrize(
-        "new_project, python_version",
+        "node_version, python_version",
         GOOD_NODE_PYTHON_VERSIONS,
-        indirect=["new_project"],
     )
-    @pytest.mark.parametrize("config", [{"path": "other-package.json"}, {}])
-    def test_read_correct(self, new_project, python_version, config):
-        version_source = NodeJSVersionSource(new_project, config)
-        data = version_source.get_version_data()
-        assert data["version"] == python_version
+    def test_parse_correct(self, node_version, python_version):
+        node_version_parsed = NodeJSVersionSource.python_version_to_node(python_version)
+        assert node_version_parsed == node_version
 
-    @pytest.mark.parametrize("python_version,node_version", GOOD_NODE_PYTHON_VERSIONS)
-    @pytest.mark.parametrize("config", [{"path": "other-package.json"}, {}])
-    @pytest.mark.parametrize("new_project", ["1.0.0"], indirect=True)
-    def test_write_correct(self, new_project, python_version, node_version, config):
-        version_source = NodeJSVersionSource(new_project, config)
-        data = version_source.get_version_data()
-        version_source.set_version(python_version, data)
-        data = version_source.get_version_data()
-        assert data["version"] == node_version
+    @pytest.mark.parametrize(
+        "python_version",
+        BAD_PYTHON_VERSIONS,
+    )
+    def test_parse_python_incorrect(self, python_version):
+        with pytest.raises(ValueError, match=".* did not match regex"):
+            NodeJSVersionSource.python_version_to_node(python_version)
 
     @pytest.mark.parametrize(
-        "new_project",
+        "node_version",
         BAD_NODE_VERSIONS,
-        indirect=["new_project"],
     )
-    @pytest.mark.parametrize("config", [{"path": "other-package.json"}, {}])
-    def test_read_incorrect(self, new_project, config):
-        version_source = NodeJSVersionSource(new_project, config)
-
+    def test_parse_python_incorrect(self, node_version):
         with pytest.raises(ValueError, match=".* did not match regex"):
-            version_source.get_version_data()
+            NodeJSVersionSource.node_version_to_python(node_version)
 
-    @pytest.mark.parametrize("python_version,", BAD_PYTHON_VERSIONS)
-    @pytest.mark.parametrize("new_project", ["1.0.0"], indirect=True)
-    @pytest.mark.parametrize("config", [{"path": "other-package.json"}, {}])
-    def test_write_incorrect(self, new_project, python_version, config):
-        version_source = NodeJSVersionSource(new_project, config)
+    @pytest.mark.parametrize(
+        "node_version, python_version",
+        GOOD_NODE_PYTHON_VERSIONS,
+    )
+    @pytest.mark.parametrize(
+        "alt_package_json",
+        [None, "package-other.json"],
+    )
+    def test_version_from_package(
+        self, project, node_version, python_version, alt_package_json
+    ):
+        # Create a simple project
+        (project / "pyproject.toml").write_text(
+            """
+[build - system]
+requires = ["hatchling", "hatch-vcs"]
+build - backend = "hatchling.build"
+[project]
+name = "my-app"
+dynamic = ["version"]
+[tool.hatch.version]
+source = "nodejs" 
+ """
+        )
+        package_json = "package.json" if alt_package_json is None else alt_package_json
+        (project / package_json).write_text(
+            f"""
+{{
+  "name": "my-app",
+  "version": "{node_version}"
+}}
+"""
+        )
+        config = {} if alt_package_json is None else {"path": alt_package_json}
+        version_source = NodeJSVersionSource(project, config=config)
         data = version_source.get_version_data()
-        with pytest.raises(ValueError, match=".* did not match regex"):
-            version_source.set_version(python_version, data)
+        assert data['version'] == python_version
+
+    @pytest.mark.parametrize(
+        "node_version, python_version",
+        GOOD_NODE_PYTHON_VERSIONS,
+    )
+    @pytest.mark.parametrize(
+        "alt_package_json",
+        [None, "package-other.json"],
+    )
+    def test_version_to_package(
+        self, project, node_version, python_version, alt_package_json
+    ):
+        package_json = "package.json" if alt_package_json is None else alt_package_json
+        (project / "pyproject.toml").write_text(
+            """
+[build - system]
+requires = ["hatchling", "hatch-vcs"]
+build - backend = "hatchling.build"
+[project]
+name = "my-app"
+dynamic = ["version"]
+[tool.hatch.version]
+source = "nodejs" 
+ """
+        )
+        (project / package_json).write_text(
+            f"""
+{{
+  "name": "my-app",
+  "version": "0.0.0"
+}}
+"""
+        )
+        config = {} if alt_package_json is None else {"path": alt_package_json}
+        version_source = NodeJSVersionSource(project, config=config)
+        version_data = version_source.get_version_data()
+        version_source.set_version(python_version, version_data)
+
+        written_package = json.loads((project / package_json).read_text())
+        assert written_package['version'] == node_version
+