Merge pull request #8 from HansBug/dev/refactor

dev(hansbug): refactor

.github/workflows/badge.yml

@@ -13,11 +13,13 @@ jobs:
     if: "!contains(github.event.head_commit.message, 'ci skip')"
     strategy:
       matrix:
-        python-version: [ 3.7 ]
+        python-version:
+          - '3.8'
+
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Download cloc

.github/workflows/doc.yml

@@ -17,7 +17,8 @@ jobs:
     if: "!contains(github.event.head_commit.message, 'ci skip')"
     strategy:
       matrix:
-        python-version: [ 3.7 ]
+        python-version:
+          - '3.8'
 
     services:
       plantuml:
@@ -26,9 +27,9 @@ jobs:
           - 18080:8080
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.github/workflows/lint.yml

@@ -1,6 +1,7 @@
 name: Code Lint
 
-on: [ push, pull_request ]
+on:
+  push:
 
 jobs:
   test:
@@ -14,16 +15,18 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 20
       - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          sudo apt-get install -y libxml2-dev libxslt-dev python-dev  # need by pypy3
+          sudo apt-get update -y
+          sudo apt-get install -y tree make wget curl cloc graphviz
+          dot -V
           python -m pip install --upgrade pip
           pip install --upgrade flake8 setuptools wheel twine
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

.github/workflows/release.yml

@@ -18,11 +18,11 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 20
       - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Set up python dependences

.github/workflows/sync.yml

@@ -2,20 +2,19 @@ name: Repository Sync
 
 on:
   push:
-  pull_request:
   schedule:
-    - cron:  '0 1 * * *'
+    - cron: '0 1 * * *'
 
 jobs:
   sync:
     runs-on: ubuntu-latest
     steps:
-    - name: Mirror the Github organization repos to Gitee
-      uses: Yikun/hub-mirror-action@master
-      with:
-        src: github/HansBug
-        dst: gitee/hansbug
-        dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}
-        dst_token:  ${{ secrets.GITEE_TOKEN }}
-        static_list: "plantumlcli"
-        force_update: true
+      - name: Mirror the Github organization repos to Gitee
+        uses: Yikun/hub-mirror-action@master
+        with:
+          src: github/HansBug
+          dst: gitee/hansbug
+          dst_key: ${{ secrets.GITEE_PRIVATE_KEY }}
+          dst_token: ${{ secrets.GITEE_TOKEN }}
+          static_list: "plantumlcli"
+          force_update: true

.github/workflows/test.yml

@@ -2,7 +2,6 @@ name: Code Test
 
 on:
   push:
-  pull_request:
   schedule:
     - cron: '0 0 1 * *'
 
@@ -17,26 +16,24 @@ jobs:
         os:
           - 'ubuntu-latest'
         python-version:
-          - '3.6'
           - '3.7'
           - '3.8'
           - '3.9'
-          - 'pypy-3.6'
-          - 'pypy-3.8'
+          - '3.10'
+          - '3.11'
+          - 'pypy-3.7'
+          - 'pypy-3.9'
         java-version:
           - '8'
         plantuml-server-version:
           - 'latest'
+          - 'jetty-v1.2023.6'
           - 'jetty-v1.2021.14'
-          - 'jetty-v1.2020.19'
           - 'jetty-v1.2019.11'
         plantuml-version:
+          - '1.2023.6'
           - '1.2021.12'
-        assistant-plantuml-version:
-          - '1.2021.12'
-          - '1.2020.19'
           - '1.2019.13'
-          - '1.2018.14'
           - '1.2017.20'
 
     services:
@@ -47,30 +44,24 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 20
       - name: Set up system dependences on linux
         if: ${{ runner.os == 'Linux' }}
         run: |
-          sudo apt-get update
-          sudo apt-get install -y tree cloc wget curl make
-          sudo apt-get install -y graphviz
-          sudo dot -c
-          sudo apt-get install -y libxml2-dev libxslt-dev python-dev  # need by pypy3
-      - name: Load testfile
-        env:
-          TESTFILE_VERSION: 0.0.1
-        run: |
-          git clone "https://github.com/HansBug/plantumlcli-testfile" "demo"
+          sudo apt-get update -y
+          sudo apt-get install -y tree make wget curl cloc graphviz
+          dot -V
       - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Set up java ${{ matrix.java-version }}
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v3
         with:
           java-version: ${{ matrix.java-version }}
+          distribution: temurin
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -87,32 +78,20 @@ jobs:
           tree .
           cloc plantuml
           cloc test
-      - name: Test the plantuml in use (${{ matrix.plantuml-version }} and ${{ matrix.assistant-plantuml-version }})
+      - name: Test the plantuml in use (jar ${{ matrix.plantuml-version }}, server ${{ matrix.plantuml-server-version }})
         env:
-          TEST_PLANTUML_HOST: http://localhost:18080
+          PLANTUML_HOST: http://localhost:18080
         run: |
-          java -jar demo/jar/plantuml.${{ matrix.plantuml-version }}.jar -version
-          java -jar demo/jar/plantuml.${{ matrix.assistant-plantuml-version }}.jar -version
-          curl -L "${TEST_PLANTUML_HOST}/txt/SoWkIImgAStDuNBAJrBGjLDmpCbCJbMmKiX8pSd9vt98pKi1IG80"
+          curl -L "${PLANTUML_HOST}/txt/SoWkIImgAStDuNBAJrBGjLDmpCbCJbMmKiX8pSd9vt98pKi1IG80"
       - name: Run unittest
         env:
-          PRIMARY_JAR_VERSION: ${{ matrix.plantuml-version }}
-          ASSISTANT_JAR_VERSION: ${{ matrix.assistant-plantuml-version }}
-          TEST_PLANTUML_HOST: http://localhost:18080
+          PLANTUML_JAR_VERSION: ${{ matrix.plantuml-version }}
+          PLANTUML_HOST: http://localhost:18080
           TIMEOUT: '30'
         run: |
-          source env.sh
           make unittest WORKERS=${WORKERS}
-      - name: Run benchmark
-        env:
-          PRIMARY_JAR_VERSION: ${{ matrix.plantuml-version }}
-          ASSISTANT_JAR_VERSION: ${{ matrix.assistant-plantuml-version }}
-          TEST_PLANTUML_HOST: http://localhost:18080
-        run: |
-          source env.sh
-          make benchmark
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml

.gitignore

@@ -477,4 +477,5 @@ __pycache__
 *.svg
 *.latex
 *.eps
-/get-pip.py
+/get-pip.py
+!/test/testfile/**/*

Makefile

@@ -1,4 +1,4 @@
-.PHONY: docs pdocs test unittest benchmark
+.PHONY: docs pdocs test unittest
 
 RERUN       ?=
 RERUN_DELAY ?=
@@ -43,9 +43,6 @@ unittest:
 		$(if ${CI}${ACTUAL_RERUN},--reruns ${ACTUAL_RERUN} --reruns-delay ${ACTUAL_RERUN_DELAY},) \
 		$(if ${ACTUAL_TIMEOUT},--timeout=${ACTUAL_TIMEOUT},)
 
-benchmark:
-	pytest ${RANGE_TEST_DIR} -sv -m benchmark --durations=0
-
 docs:
 	$(MAKE) -C "${DOC_DIR}" build
 pdocs:

docs/source/_shims/plantumlcli

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-from plantumlcli.entrance.cli import cli as plantumlcli_cli
+from plantumlcli.entry.cli import cli as plantumlcli_cli
 
 if __name__ == '__main__':
     plantumlcli_cli()

docs/source/conf.py

@@ -118,7 +118,7 @@
 # a list of plugins themes.
 #
 html_theme = 'sphinx_rtd_theme'
-htmlhelp_basename = 'TreeValue'
+htmlhelp_basename = 'plantumlcli'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the plugins static files,

plantumlcli/models/base.py

@@ -51,16 +51,16 @@ def __init__(self):
     def autoload(cls, *args, **kwargs):
         """
         Autoload plantuml object from given arguments
-        :return: auto-loaded plantuml object
+        :return: autoloaded plantuml object
         """
-        raise NotImplementedError
+        raise NotImplementedError  # pragma: no cover
 
     def _check_version(self, version: str):
         pass
 
     @abstractmethod
     def _get_version(self) -> str:
-        raise NotImplementedError
+        raise NotImplementedError  # pragma: no cover
 
     @property
     def version(self) -> str:
@@ -92,7 +92,7 @@ def test(self) -> bool:
 
     @abstractmethod
     def _generate_uml_data(self, type_: PlantumlResourceType, code: str) -> bytes:
-        raise NotImplementedError
+        raise NotImplementedError  # pragma: no cover
 
     def dump(self, path: str, type_: Union[int, str, PlantumlResourceType], code: str):
         """
@@ -135,7 +135,7 @@ def __repr__(self):
 
 def try_plantuml(cls: Type[_Tp], *args, **kwargs) -> Tuple[bool, Union[Optional[_Tp], Exception]]:
     """
-    Try initialize plantuml object
+    Try to initialize plantuml object
     :param cls: plantuml class
     :param args: arguments
     :param kwargs: key-word arguments

plantumlcli/models/local.py

@@ -1,18 +1,17 @@
 import os
 import re
+import shutil
 from tempfile import TemporaryDirectory, NamedTemporaryFile
 from typing import Tuple, Optional, Mapping, Any
 
-import where
-
 from .base import Plantuml, PlantumlResourceType
 from ..utils import load_binary_file, save_text_file, CommandLineExecuteError, execute
 
 PLANTUML_JAR_ENV = 'PLANTUML_JAR'
 
 
 def find_java_from_env() -> Optional[str]:
-    return where.first('java')
+    return shutil.which('java')
 
 
 def find_java(java: Optional[str] = None) -> Optional[str]:
@@ -64,7 +63,7 @@ def __init__(self, java: str, plantuml: str):
         _check_local(self.__java, self.__plantuml)
 
     @classmethod
-    def autoload(cls, java: str = None, plantuml: str = None, **kwargs) -> 'LocalPlantuml':
+    def autoload(cls, java: Optional[str] = None, plantuml: Optional[str] = None, **kwargs) -> 'LocalPlantuml':
         """
         Autoload LocalPlantuml object from given parameters and the environment
         :param java: java executable file path

requirements-test.txt

@@ -5,3 +5,8 @@ pytest-mock~=3.6.1
 pytest-rerunfailures~=10.2
 pytest-timeout~=2.0.2
 more-itertools>=7,<8
+testtools>=2
+coverage>=5
+mock>=4.0.3
+huggingface_hub
+pysyslimit>=0.5.0

requirements.txt

@@ -1,8 +1,9 @@
 where~=1.0
 click>=7.0
 colorama~=0.4
-requests~=2.12
+requests>=2.12
 urlobject~=2.4
 pyquery~=1.4
 prettytable~=1.0
-chardet~=3.0
+chardet~=3.0
+hbutils>=0.9.0

setup.py

@@ -46,7 +46,7 @@ def _load_req(file: str):
     url='https://github.com/HansBug/plantumlcli',
 
     # environment
-    python_requires=">=3.6",
+    python_requires=">=3.7",
     install_requires=requirements,
     tests_require=group_requirements['test'],
     extras_require=group_requirements,
@@ -56,10 +56,11 @@ def _load_req(file: str):
         'License :: OSI Approved :: Apache Software License',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: Implementation :: PyPy'
     ],
     include_package_data=True,
@@ -70,7 +71,7 @@ def _load_req(file: str):
     },
     entry_points={
         'console_scripts': [
-            'plantumlcli=plantumlcli.entrance.cli:cli'
+            'plantumlcli=plantumlcli.entry.cli:cli'
         ]
     },
 )