Merge pull request #93 from sdispater/revamp-1.0

Initial work towards 1.0

Author: sdispater

.coveragerc

@@ -1,3 +1,4 @@
 [report]
 omit =
   cleo/_compat.py
+  cleo/_utils.py

.flake8

@@ -0,0 +1,18 @@
+[flake8]
+max-line-length = 88
+ignore = E501, E203, W503
+per-file-ignores =
+    __init__.py:F401
+exclude =
+    .git
+    __pycache__
+    setup.py
+    build
+    dist
+    releases
+    .venv
+    .tox
+    .mypy_cache
+    .pytest_cache
+    .vscode
+    .github

.github/workflows/tests.yml

@@ -16,114 +16,62 @@ jobs:
         run: |
           pip install pre-commit
           pre-commit run --all-files
-  Linux:
+
+  Tests:
     needs: Linting
-    runs-on: ubuntu-latest
+    name: ${{ matrix.os }} / ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}-latest
     strategy:
       matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, pypy2, pypy3]
+        os: [Ubuntu, MacOS, Windows]
+        python-version: [3.6, 3.7, 3.8, 3.9]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Get full python version
-      id: full-python-version
-      run: |
-        echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
-    - name: Install and set up Poetry
-      run: |
-        curl -fsS -o get-poetry.py https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py
-        python get-poetry.py --preview -y
-        source $HOME/.poetry/env
-        poetry config virtualenvs.in-project true
-    - name: Set up cache
-      uses: actions/cache@v1
-      with:
-        path: .venv
-        key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
-    - name: Install dependencies
-      run: |
-        source $HOME/.poetry/env
-        poetry install
-    - name: Test
-      run: |
-        source $HOME/.poetry/env
-        poetry run pytest -q tests
-        poetry install
+      - uses: actions/checkout@v2
 
-  MacOS:
-    needs: Linting
-    runs-on: macos-latest
-    strategy:
-      matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, pypy2, pypy3]
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
 
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Get full python version
-      id: full-python-version
-      run: |
-        echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
-    - name: Install and set up Poetry
-      run: |
-        curl -fsS -o get-poetry.py https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py
-        python get-poetry.py --preview -y
-        source $HOME/.poetry/env
-        poetry config virtualenvs.in-project true
-    - name: Set up cache
-      uses: actions/cache@v1
-      with:
-        path: .venv
-        key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
-    - name: Install dependencies
-      run: |
-        source $HOME/.poetry/env
-        poetry install
-    - name: Test
-      run: |
-        source $HOME/.poetry/env
-        poetry run pytest -q tests
-  Windows:
-    needs: Linting
-    runs-on: windows-latest
-    strategy:
-      matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8]
+      - name: Get full python version
+        id: full-python-version
+        shell: bash
+        run: |
+          echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
+    
+      - name: Install Poetry
+        shell: bash
+        run: |
+          curl -fsS -o get-poetry.py https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py
+          python get-poetry.py --preview -y
+          echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+          echo "%USERPROFILE%/.poetry/bin" >> $GITHUB_PATH
 
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Get full python version
-      id: full-python-version
-      shell: bash
-      run: |
-        echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
-    - name: Install and setup Poetry
-      run: |
-        Invoke-WebRequest https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py -O get-poetry.py
-        python get-poetry.py --preview -y
-        $env:Path += ";$env:Userprofile\.poetry\bin"
-        poetry config virtualenvs.in-project true
-    - name: Set up cache
-      uses: actions/cache@v1
-      with:
-        path: .venv
-        key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
-    - name: Install dependencies
-      run: |
-        $env:Path += ";$env:Userprofile\.poetry\bin"
-        poetry install
-    - name: Test
-      run: |
-        $env:Path += ";$env:Userprofile\.poetry\bin"
-        poetry run pytest -q tests
+      - name: Setup Poetry
+        shell: bash
+        run: |
+          poetry config virtualenvs.in-project true
+
+      - name: Set up cache
+        uses: actions/cache@v2
+        id: cache
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Ensure cache is healthy
+        if: steps.cache.outputs.cache-hit == 'true'
+        shell: bash
+        run: timeout 10s poetry run pip --version || rm -rf .venv
+
+      - name: Install dependencies
+        shell: bash
+        run: |
+          poetry install
+    
+      - name: Run tests
+        shell: bash
+        run: |
+          poetry run pytest -q tests
+          poetry install

.pre-commit-config.yaml

@@ -1,6 +1,5 @@
 repos:
 -   repo: https://github.com/ambv/black
-    rev: stable
+    rev: 20.8b1
     hooks:
     - id: black
-      python_version: python3.6

cleo/__init__.py

@@ -1,9 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from .application import Application
-from .commands import Command
-from .helpers import argument, option
-from .testers import ApplicationTester, CommandTester
-
-
-__version__ = "0.8.1"

cleo/_compat.py

@@ -1,52 +1,15 @@
 # -*- coding: utf-8 -*-
 
+import shlex
+import subprocess
 import sys
 
-PY2 = sys.version_info[0] == 2
 
-if PY2:
-    long = long
-    unicode = unicode
-    basestring = basestring
-else:
-    long = int
-    unicode = str
-    basestring = str
+WINDOWS = sys.platform == "win32"
 
 
-def decode(string, encodings=None):
-    if not PY2 and not isinstance(string, bytes):
-        return string
+def shell_quote(token: str) -> str:
+    if WINDOWS:
+        return subprocess.list2cmdline([token])
 
-    if PY2 and isinstance(string, unicode):
-        return string
-
-    if encodings is None:
-        encodings = ["utf-8", "latin1", "ascii"]
-
-    for encoding in encodings:
-        try:
-            return string.decode(encoding)
-        except (UnicodeEncodeError, UnicodeDecodeError):
-            pass
-
-    return string.decode(encodings[0], errors="ignore")
-
-
-def encode(string, encodings=None):
-    if not PY2 and isinstance(string, bytes):
-        return string
-
-    if PY2 and isinstance(string, str):
-        return string
-
-    if encodings is None:
-        encodings = ["utf-8", "latin1", "ascii"]
-
-    for encoding in encodings:
-        try:
-            return string.encode(encoding)
-        except (UnicodeEncodeError, UnicodeDecodeError):
-            pass
-
-    return string.encode(encodings[0], errors="ignore")
+    return shlex.quote(token)

cleo/_utils.py

@@ -0,0 +1,104 @@
+import math
+
+from html.parser import HTMLParser
+from typing import List
+
+from pylev import levenshtein
+
+
+class TagStripper(HTMLParser):
+    def __init__(self) -> None:
+        super().__init__(convert_charrefs=False)
+
+        self.reset()
+        self.fed = []
+
+    def handle_data(self, d) -> None:
+        self.fed.append(d)
+
+    def handle_entityref(self, name) -> None:
+        self.fed.append("&%s;" % name)
+
+    def handle_charref(self, name) -> None:
+        self.fed.append("&#%s;" % name)
+
+    def get_data(self) -> str:
+        return "".join(self.fed)
+
+
+def _strip(value) -> str:
+    s = TagStripper()
+    s.feed(value)
+    s.close()
+
+    return s.get_data()
+
+
+def strip_tags(value):
+    value = str(value)
+    while "<" in value and ">" in value:
+        new_value = _strip(value)
+        if value.count("<") == new_value.count("<"):
+            break
+
+        value = new_value
+
+    return value
+
+
+def find_similar_names(name, names):  # type: (str, List[str]) -> List[str]
+    """
+    Finds names similar to a given command name.
+    """
+    threshold = 1e3
+    distance_by_name = {}
+    suggested_names = []
+
+    for actual_name in names:
+        # Get Levenshtein distance between the input and each command name
+        distance = levenshtein(name, actual_name)
+
+        is_similar = distance <= len(name) / 3
+        is_sub_string = actual_name.find(name) != -1
+
+        if is_similar or is_sub_string:
+            distance_by_name[actual_name] = (
+                distance,
+                actual_name.find(name) if is_sub_string else float("inf"),
+            )
+
+    # Only keep results with a distance below the threshold
+    distance_by_name = {
+        k: v for k, v in distance_by_name.items() if v[0] < 2 * threshold
+    }
+
+    # Display results with shortest distance first
+    for k, v in sorted(distance_by_name.items(), key=lambda i: (i[1][0], i[1][1])):
+        if k not in suggested_names:
+            suggested_names.append(k)
+
+    return suggested_names
+
+
+_TIME_FORMATS = [
+    (0, "< 1 sec"),
+    (2, "1 sec"),
+    (59, "secs", 1),
+    (60, "1 min"),
+    (3600, "mins", 60),
+    (5400, "1 hr"),
+    (86400, "hrs", 3600),
+    (129600, "1 day"),
+    (604800, "days", 86400),
+]
+
+
+def format_time(secs):  # type: (float) -> str
+    for fmt in _TIME_FORMATS:
+        if secs > fmt[0]:
+            continue
+
+        if len(fmt) == 2:
+            return fmt[1]
+
+        return "{} {}".format(math.ceil(secs / fmt[2]), fmt[1])