Merge master into release/3

--HG--
branch : release

Author: kazssym

.github/FUNDING.yml

@@ -0,0 +1,9 @@
+# FUNDING.yml - GitHub sponsor button configuration
+# Copyright (C) 2019 Kaz Nishimura
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and
+# this notice are preserved. This file is offered as-is, without any warranty.
+---
+custom:
+  - https://salt.bountysource.com/checkout/amount?team=vx68k

.hgtags

@@ -1,3 +1,4 @@
 6db5290c92e4890dcea7a32d33be1da8ef41b0d1 release/1.0b3
 1fe0824b4525a8e45ec313a041081a267a2660f8 release/1.0b4
 53d49c8c44d12ce03e6c0555d629eb0dc39b6dc5 release/1.0
+3e7041ecfc2e21611c649abff920bc755f6231cc release/2.0

.vscode/settings.json

@@ -7,5 +7,10 @@
         "**/*.rej": true,
         "**/*.orig": true,
         "**/*~": true
-    }
+    },
+    "python.testing.unittestEnabled": true,
+    "python.testing.unittestArgs": [
+        "-s",
+        "test"
+    ]
 }

.vscode/tasks.json

@@ -7,9 +7,10 @@
             "command": "${config:python.pythonPath}",
             "args": [
                 "./setup.py",
-                "test"
+                "build"
             ],
-            "group": "build"
+            "group": "build",
+            "problemMatcher": []
         },
         {
             "label": "Rebuild",
@@ -18,9 +19,10 @@
             "args": [
                 "./setup.py",
                 "clean",
-                "test"
+                "build"
             ],
-            "group": "build"
+            "group": "build",
+            "problemMatcher": []
         },
         {
             "label": "Clean",

MANIFEST.in

@@ -1 +1,2 @@
-include README.md
+include test/prepare.py
+include test/*.b64

README.md

@@ -1,6 +1,6 @@
 # Introduction
 
-The `prcslib` package provides a <dfn>Python API for PRCS</dfn>.
+The [`prcslib` package][prcslib] provides a <dfn>Python API for PRCS</dfn>.
 
 [PRCS][] (Project Revision Control System) is a legacy version control system
 that manages a *project* consisting of multiple files
@@ -9,6 +9,7 @@ and records related changes across them as a unit.
 See the [home page][] for more information about the `prcslib` package.
 
 [home page]: https://vx68k.bitbucket.io/prcslib.py/
+[prcslib]: https://pypi.org/project/prcslib/
 [PRCS]: http://prcs.sourceforge.net/
 
 [![(Chat)](https://img.shields.io/gitter/room/vx68k/prcslib.py.svg)][Gitter room]

azure-pipelines.yml

@@ -14,19 +14,23 @@ stages:
     jobs:
       - job: Build
         pool:
-          vmImage: ubuntu-latest
+          vmImage: ubuntu-16.04
+        container: kazssym/python-prcs:3
         steps:
-          - task: UsePythonVersion@0
           - bash: |
               pip install \
                   "setuptools>=38.6" \
-                  wheel \
-                  tox
+                  unittest-xml-reporting \
+                  wheel
             displayName: Install dependencies
           - bash: |
-              tox
+              python test/prepare.py test/testproject.prcs.b64
+              python -m xmlrunner discover -s test -o test-reports
             displayName: Test
+            env:
+              PRCS_REPOSITORY: /tmp/PRCS
           - task: PublishTestResults@2
+            condition: succeededOrFailed()
           - bash: |
               python ./setup.py sdist bdist_wheel
             displayName: Create archives

prcslib/__init__.py

@@ -42,7 +42,7 @@
 
 # Matching pattern for info records.
 _INFO_RECORD_PATTERN = \
-    re.compile(br"^([^ ]+) ([^ ]+) (.+) by ([^ ]+) ?(\*DELETED\*)?")
+    re.compile(r"^([^ ]+) ([^ ]+) (.+) by ([^ ]+) ?(\*DELETED\*)?")
 
 class PrcsError(Exception):
     """base exception class for the prcslib package
@@ -58,12 +58,16 @@ def __init__(self, error_message):
 
 class PrcsVersion:
     """
-    version identifier on PRCS
+    Version identifier on PRCS
+
+    A version identifier on PRCS is composed of major and minor parts separated
+    by a full stop (U+002E). The former is a string, and the latter is a
+    positive integral number.
     """
 
     def __init__(self, major, minor=None):
         """
-        construct a version identifier
+        Construct a version identifier
         """
         if isinstance(major, PrcsVersion):
             if minor is None:
@@ -81,13 +85,13 @@ def __str__(self):
 
     def major(self):
         """
-        major part of the version identifier
+        Return the major part of the version identifier as a 'str' value
         """
         return self._major
 
     def minor(self):
         """
-        minor part of the version identifier
+        Return the minor part of the version identifier as an 'int' value
         """
         return self._minor
 
@@ -101,27 +105,27 @@ def __init__(self, name):
         self.name = name
 
     def versions(self):
-        """return a dictionary of the summary records for all the versions
+        """
+        return a dictionary of the summary records for all the versions
         """
         out, err, status = self._run_prcs(["info", "-f", self.name])
+        if status != 0:
+            raise PrcsCommandError(err.decode())
 
         versions = {}
-        if not err:
-            # We use iteration over lines so that we can detect parse errors.
-            for line in out.splitlines():
-                match = _INFO_RECORD_PATTERN.match(line)
-                if match:
-                    # Note: the 'prcs info' command returns local times.
-                    project, version, date, author, deleted = match.groups()
-                    versions[version.decode()] = {
-                        "project": project.decode(),
-                        "id": version.decode(),
-                        "date": datetime(*parsedate(date.decode())[0:6]),
-                        "author": author.decode(),
-                        "deleted": bool(deleted),
-                    }
-        else:
-            raise PrcsCommandError(err)
+        # We use iteration over lines so that we can detect parse errors.
+        for line in out.splitlines():
+            match = _INFO_RECORD_PATTERN.match(line.decode())
+            if match:
+                # Note: the 'prcs info' command returns local times.
+                project, version, date, author, deleted = match.groups()
+                versions[version] = {
+                    "project": project,
+                    "id": version,
+                    "date": datetime(*parsedate(date)[0:6]),
+                    "author": author,
+                    "deleted": bool(deleted),
+                }
         return versions
 
     def descriptor(self, version=None):
@@ -142,8 +146,8 @@ def checkout(self, version=None, files=None):
         args.append(self.name)
         args.extend(files)
         __, err, status = self._run_prcs(args)
-        if err:
-            sys.stderr.write(err)
+        if status != 0:
+            raise PrcsCommandError(err.decode())
 
     def _run_prcs(self, args=None, stdin=None):
         """

setup.py

@@ -29,8 +29,11 @@
 from os import path
 from setuptools import setup, find_packages
 
+# Package name.
+PACKAGE_NAME = "prcslib"
+
 # Package version.
-PACKAGE_VERSION = "2.0"
+PACKAGE_VERSION = "3.0"
 
 def long_description():
     """
@@ -47,10 +50,14 @@ def long_description():
 
 if __name__ == "__main__":
     setup(
-        name="prcslib",
+        name=PACKAGE_NAME,
         version=PACKAGE_VERSION,
         description="Python API for PRCS.",
         url="https://vx68k.bitbucket.io/prcslib.py/",
+        project_urls={
+            # Libraries.io will pick the 'Source' location for the repository.
+            "Source": "https://github.com/vx68k/prcslib.py",
+        },
         author="Kaz Nishimura",
         author_email="kazssym@linuxfront.com",
         long_description=long_description(),
@@ -67,6 +74,6 @@ def long_description():
         python_requires=">=2.7",
         zip_safe=True,
 
-        packages=find_packages(exclude=["testsuite", "testsuite.*"]),
+        packages=find_packages(exclude=["test", "test.*"]),
         test_suite="testsuite",
     )

testsuite/__init__.py renamed to test/__init__.py

@@ -0,0 +1,40 @@
+# prepare.py
+# Copyright (C) 2020 Kaz Nishimura
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#
+# SPDX-License-Identifier: MIT
+
+"""
+prepare a PRCS project for tests
+"""
+
+from __future__ import absolute_import
+import sys
+import os
+
+def main():
+    """
+    Prepare a PRCS project by extracting from a package
+    """
+    package = sys.argv[1]
+    return os.system("base64 -d '%s' | prcs unpackage -f -" % package)
+
+if __name__ == "__main__":
+    sys.exit(main() != 0)