Merge pull request #9 from agoose77/feat-add-labels

agoose77 · web-flow · commit e4da3d3fd726 · 2022-09-12T09:35:57.000+01:00
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,20 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 22.8.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        name: isort
+-   repo: https://github.com/pycqa/flake8
+    rev: 5.0.4
+    hooks:
+    -   id: flake8
diff --git a/README.md b/README.md
@@ -6,9 +6,11 @@
 
 -----
 This package provides two Hatch plugins:
-- [version source plugin](https://hatch.pypa.io/latest/plugins/version-source/) that reads/writes the package version from the `version` field of the NodeJS `package.json` file.
-- [metadata hook plugin](https://hatch.pypa.io/latest/plugins/metadata-hook/) that reads PEP 621 metadata from the NodeJS `package.json` file.
 
+- [version source plugin](https://hatch.pypa.io/latest/plugins/version-source/) that reads/writes the package version
+  from the `version` field of the NodeJS `package.json` file.
+- [metadata hook plugin](https://hatch.pypa.io/latest/plugins/metadata-hook/) that reads PEP 621 metadata from the
+  NodeJS `package.json` file.
 
 **Table of Contents**
 
@@ -45,17 +47,19 @@ The [version source plugin](https://hatch.pypa.io/latest/plugins/version-source/
     [version]
     source = "nodejs"
     ```
-  
+
 ### Semver
 
 The semver specification defines the following version sections:
+
 - `major`
 - `minor`
 - `patch`
 - `pre-release`
 - `build`
 
 Meanwhile, [PEP 440](https://peps.python.org/pep-0440/#version-scheme) defines:
+
 - `epoch`
 - `major`
 - `minor`
@@ -64,21 +68,22 @@ Meanwhile, [PEP 440](https://peps.python.org/pep-0440/#version-scheme) defines:
 - `post-release`
 - `dev-release`
 
-In order to ensure round-trip support, and ensure semantic consistency between NodeJS and Python, this plugin only accepts the common version parts:
+In order to ensure round-trip support, and ensure semantic consistency between NodeJS and Python, this plugin only
+accepts the common version parts:
+
 - `major`
 - `minor`
 - `patch`
 - `pre-release`
 
-e.g. `1.2.3-rc0`.  
+e.g. `1.2.3-rc0`.
 
 ### Version source options
 
 | Option        | Type | Default       | Description                                |
 |---------------| --- |---------------|--------------------------------------------|
 | `path`        | `str` | `package.json` | Relative path to the `package.json` file. |
 
-
 ## Metadata hook
 
 The [metadata hook plugin](https://hatch.pypa.io/dev/plugins/metadata-hook/reference/) name is `nodejs`.
@@ -97,12 +102,14 @@ The [metadata hook plugin](https://hatch.pypa.io/dev/plugins/metadata-hook/refer
 
 ### Metadata hook options
 
-| Option                        | Type            | Default        | Description                                                                                                |
-|-------------------------------|-----------------|----------------|------------------------------------------------------------------------------------------------------------|
-| `path`                        | `str`           | `package.json` | Relative path to the `package.json` file.                                                                  |
-| `fields`                      | `list` of `str` | `None`         | Optional list of `pyproject.toml` fields to take from their counterparts in `package.json`.                |
-| `contributors-as-maintainers` | `bool`          | `True`         | Whether contributors in `package.json` should be considered maintainers (otherwise, treat them as authors).|
-
+| Option                        | Type            | Default          | Description                                                                                                 |
+|-------------------------------|-----------------|------------------|-------------------------------------------------------------------------------------------------------------|
+| `path`                        | `str`           | `"package.json"` | Relative path to the `package.json` file.                                                                   |
+| `fields`                      | `list` of `str` | `None`           | Optional list of `pyproject.toml` fields to take from their counterparts in `package.json`.                 |
+| `contributors-as-maintainers` | `bool`          | `True`           | Whether contributors in `package.json` should be considered maintainers (otherwise, treat them as authors). |
+| `bugs-label`                  | `str`           | `"Bug Tracker"`  | The key in the URLs table of `pyproject.toml` that is populated by the `bugs` field in `package.json`       |
+| `homepage-label`              | `str`           | `"Homepage"`     | The key in the URLs table of `pyproject.toml` that is populated by the `homepage` field in `package.json`   |
+| `repository-label`            | `str`           | `"Repository"`   | The key in the URLs table of `pyproject.toml` that is populated by the `repository` field in `package.json` |
 
 ## License
 
diff --git a/hatch_nodejs_version/metadata_source.py b/hatch_nodejs_version/metadata_source.py
@@ -30,6 +30,9 @@ def __init__(self, *args, **kwargs):
         self.__path = None
         self.__fields = None
         self.__contributors_as_maintainers = None
+        self.__homepage_label = None
+        self.__bugs_label = None
+        self.__repository_label = None
 
     @property
     def path(self) -> str:
@@ -57,21 +60,66 @@ def fields(self) -> None | set[str]:
                     isinstance(fields, list) and all(isinstance(f, str) for f in fields)
                 ):
                     raise TypeError(
-                        "Option `fields` for build hook `{}` must be a list of strings".format(
-                            self.PLUGIN_NAME
-                        )
+                        "Option `fields` for build hook `{}` "
+                        "must be a list of strings".format(self.PLUGIN_NAME)
                     )
                 self.__fields = set(fields)
         return self.__fields
 
     @property
     def contributors_as_maintainers(self) -> bool:
         if self.__contributors_as_maintainers is None:
-            self.__contributors_as_maintainers = self.config.get(
+            contributors_as_maintainers = self.config.get(
                 "contributors-as-maintainers", True
             )
+            if not isinstance(contributors_as_maintainers, bool):
+                raise TypeError(
+                    "Option `contributors-as-maintainers` for build hook `{}` "
+                    "must be a boolean".format(self.PLUGIN_NAME)
+                )
+            self.__contributors_as_maintainers = contributors_as_maintainers
         return self.__contributors_as_maintainers
 
+    @property
+    def homepage_label(self) -> bool:
+        if self.__homepage_label is None:
+            homepage_label = self.config.get("homepage-label", "Homepage")
+
+            if not isinstance(homepage_label, str):
+                raise TypeError(
+                    "Option `homepage-label` for build hook `{}` "
+                    "must be a string".format(self.PLUGIN_NAME)
+                )
+            self.__homepage_label = homepage_label
+        return self.__homepage_label
+
+    @property
+    def bugs_label(self) -> bool:
+        if self.__bugs_label is None:
+            bug_tracker_label = self.config.get("bugs-label", "Bug Tracker")
+
+            if not isinstance(bug_tracker_label, str):
+                raise TypeError(
+                    "Option `bugs-label` for build hook `{}` must be a string".format(
+                        self.PLUGIN_NAME
+                    )
+                )
+            self.__bugs_label = bug_tracker_label
+        return self.__bugs_label
+
+    @property
+    def repository_label(self) -> bool:
+        if self.__repository_label is None:
+            bug_tracker_label = self.config.get("repository-label", "Repository")
+
+            if not isinstance(bug_tracker_label, str):
+                raise TypeError(
+                    "Option `repository-label` for build hook `{}` "
+                    "must be a string".format(self.PLUGIN_NAME)
+                )
+            self.__repository_label = bug_tracker_label
+        return self.__repository_label
+
     def load_package_data(self):
         path = os.path.normpath(os.path.join(self.root, self.path))
         if not os.path.isfile(path):
@@ -129,19 +177,17 @@ def update(self, metadata: dict[str, Any]):
             authors = [self._parse_person(package["author"])]
 
         if "contributors" in package:
-            contributors = [
-                self._parse_person(p) for p in package["contributors"]
-            ]
+            contributors = [self._parse_person(p) for p in package["contributors"]]
             if self.contributors_as_maintainers:
                 maintainers = contributors
             else:
                 authors = [*(authors or []), *contributors]
 
         if authors is not None:
-            new_metadata['authors'] = authors
+            new_metadata["authors"] = authors
 
         if maintainers is not None:
-            new_metadata['maintainers'] = maintainers
+            new_metadata["maintainers"] = maintainers
 
         if "keywords" in package:
             new_metadata["keywords"] = package["keywords"]
@@ -155,13 +201,13 @@ def update(self, metadata: dict[str, Any]):
         # Construct URLs
         urls = {}
         if "homepage" in package:
-            urls["homepage"] = package["homepage"]
+            urls[self.homepage_label] = package["homepage"]
         if "bugs" in package:
             bugs_url = self._parse_bugs(package["bugs"])
             if bugs_url is not None:
-                urls["bug tracker"] = bugs_url
+                urls[self.bugs_label] = bugs_url
         if "repository" in package:
-            urls["repository"] = self._parse_repository(package["repository"])
+            urls[self.repository_label] = self._parse_repository(package["repository"])
 
         # Write URLs
         if urls:
diff --git a/tests/test_metadata_config.py b/tests/test_metadata_config.py
@@ -5,7 +5,6 @@
 
 from hatch_nodejs_version.metadata_source import NodeJSMetadataHook
 
-
 TRIVIAL_PYPROJECT_CONTENTS = """
 [build-backend]
 requires = ["hatchling", "hatch-vcs"]
@@ -16,7 +15,7 @@
 [tool.hatch.metadata.hooks.nodejs]
 """
 
-DEMO_PACKAGE_CONTENTS = """
+TRIVIAL_PACKAGE_CONTENTS = """
 {
   "name": "my-app",
   "version": "1.0.0",
@@ -50,12 +49,12 @@
 }
 """
 
-EXPECTED_METADATA = {
+TRIVIAL_EXPECTED_METADATA = {
     "license": "MIT",
     "urls": {
-        "bug tracker": "https://www.send-help.com",
-        "repository": "https://github.com/some/code.git",
-        "homepage": "https://where-the-heart-is.com",
+        "Bug Tracker": "https://www.send-help.com",
+        "Repository": "https://github.com/some/code.git",
+        "Homepage": "https://where-the-heart-is.com",
     },
     "authors": [
         {
@@ -79,14 +78,14 @@ def test_all_metadata(self, project, alt_package_json):
         # Create a simple project
         package_json = "package.json" if alt_package_json is None else alt_package_json
         (project / "pyproject.toml").write_text(TRIVIAL_PYPROJECT_CONTENTS)
-        (project / package_json).write_text(DEMO_PACKAGE_CONTENTS)
+        (project / package_json).write_text(TRIVIAL_PACKAGE_CONTENTS)
 
         config = {} if alt_package_json is None else {"path": alt_package_json}
         metadata = {}
         metadata_source = NodeJSMetadataHook(project, config=config)
         metadata_source.update(metadata)
 
-        assert metadata == EXPECTED_METADATA
+        assert metadata == TRIVIAL_EXPECTED_METADATA
 
     @pytest.mark.parametrize(
         "pyproject_field",
@@ -103,7 +102,7 @@ def test_all_metadata(self, project, alt_package_json):
     def test_subset_metadata(self, project, pyproject_field):
         # Create a simple project
         (project / "pyproject.toml").write_text(TRIVIAL_PYPROJECT_CONTENTS)
-        (project / "package.json").write_text(DEMO_PACKAGE_CONTENTS)
+        (project / "package.json").write_text(TRIVIAL_PACKAGE_CONTENTS)
 
         config = {"fields": [pyproject_field]}
 
@@ -113,26 +112,26 @@ def test_subset_metadata(self, project, pyproject_field):
 
         assert pyproject_field in metadata
         assert len(metadata) == len(config["fields"])
-        assert metadata[pyproject_field] == EXPECTED_METADATA[pyproject_field]
+        assert metadata[pyproject_field] == TRIVIAL_EXPECTED_METADATA[pyproject_field]
 
     def test_contributors_as_maintainers(self, project):
         # Create a simple project
         (project / "pyproject.toml").write_text(TRIVIAL_PYPROJECT_CONTENTS)
-        (project / "package.json").write_text(DEMO_PACKAGE_CONTENTS)
+        (project / "package.json").write_text(TRIVIAL_PACKAGE_CONTENTS)
 
         metadata = {}
         metadata_source = NodeJSMetadataHook(
             project, config={"contributors-as-maintainers": True}
         )
         metadata_source.update(metadata)
 
-        assert metadata["authors"] == EXPECTED_METADATA["authors"]
-        assert metadata["maintainers"] == EXPECTED_METADATA["maintainers"]
+        assert metadata["authors"] == TRIVIAL_EXPECTED_METADATA["authors"]
+        assert metadata["maintainers"] == TRIVIAL_EXPECTED_METADATA["maintainers"]
 
     def test_contributors_as_authors(self, project):
         # Create a simple project
         (project / "pyproject.toml").write_text(TRIVIAL_PYPROJECT_CONTENTS)
-        (project / "package.json").write_text(DEMO_PACKAGE_CONTENTS)
+        (project / "package.json").write_text(TRIVIAL_PACKAGE_CONTENTS)
 
         metadata = {}
         metadata_source = NodeJSMetadataHook(
@@ -142,5 +141,27 @@ def test_contributors_as_authors(self, project):
 
         assert (
             metadata["authors"]
-            == EXPECTED_METADATA["authors"] + EXPECTED_METADATA["maintainers"]
+            == TRIVIAL_EXPECTED_METADATA["authors"]
+            + TRIVIAL_EXPECTED_METADATA["maintainers"]
+        )
+
+    def test_labels(self, project):
+        # Create a simple project
+        (project / "pyproject.toml").write_text(TRIVIAL_PYPROJECT_CONTENTS)
+        (project / "package.json").write_text(TRIVIAL_PACKAGE_CONTENTS)
+
+        metadata = {}
+        metadata_source = NodeJSMetadataHook(
+            project,
+            config={
+                "repository-label": "the-repository",
+                "bugs-label": "the-bug-tracker",
+                "homepage-label": "the-homepage",
+            },
         )
+        metadata_source.update(metadata)
+
+        urls = metadata["urls"]
+        assert urls["the-repository"] == "https://github.com/some/code.git"
+        assert urls["the-bug-tracker"] == "https://www.send-help.com"
+        assert urls["the-homepage"] == "https://where-the-heart-is.com"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[flake8]`
	`2`	`+max-line-length = 88`
	`3`	`+extend-ignore = E203`