Make it compatible with standard liquid (#28)

* Construct a scalefold to remodel using lark-parser

* Remove old codes, implement tag relationship handling.

* Start adding tests for standard liquid mode

* Fix top-level tokenization with compact tags

* Complete all functionalities of shopify's liquid

* Update pyproject.toml

* Update .travis.yml

* Update pyproject.toml

* Add dateutil to dev deps

* Better debug message with parsed tree and rendered fragments for Tags.

* Update README

* Finish implementation

* Add ternary filter in grammar

* Add dot, subscript, star, keyword and complex filters

* Add tag from, import and python

* Fix linting styles

* Add type hints

* Add part of docs.

* Complete docs.

* Fix typos in docs.

* Fix docs.

* Update README

* Update README

Author: pwwang

.github/workflows/build.yml

@@ -0,0 +1,60 @@
+name: Build and Deploy
+
+on: [push, pull_request]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python # Set Python version
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pylint
+          python -m pip install poetry
+          poetry install -v
+      - name: Run pylint
+        run: pylint liquid
+      - name: Test with pytest
+        run: poetry run pytest tests/ --junitxml=junit/test-results-${{ matrix.python-version }}.xml
+      - name: Upload pytest test results
+        uses: actions/upload-artifact@v2
+        with:
+          name: pytest-results-${{ matrix.python-version }}
+          path: junit/test-results-${{ matrix.python-version }}.xml
+        # Use always() to always run this step to publish test results when there are test failures
+        if: ${{ always() }}
+      - name: Run codacy-coverage-reporter
+        uses: codacy/codacy-coverage-reporter-action@master
+        if: matrix.python-version == 3.8
+        with:
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          coverage-reports: .coverage.xml
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python # Set Python version
+        uses: actions/setup-python@v2
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install poetry
+      - name: Publish to PyPI
+        run: poetry publish --build -u ${{ secrets.PYPI_USER }} -p ${{ secrets.PYPI_PASSWORD }}
+        if: success()

.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: Build Docs
+
+on: [push]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python # Set Python version
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install poetry
+          poetry install -v
+      - name: Update docs
+        run: |
+          poetry run python -m pip install mkdocs
+          poetry run python -m pip install -r docs/requirements.txt
+          cd docs
+          cp ../README.md index.md
+          cd ..
+          poetry run mkdocs gh-deploy --clean --force
+        if: success()
+
+  fix-index:
+    needs: docs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+      - name: Fix index.html
+        run: |
+          echo ':: head of index.html - before ::'
+          head index.html
+          sed -i '1,5{/^$/d}' index.html
+          echo ':: head of index.html - after ::'
+          head index.html
+        if: success()
+      - name: Commit changes
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git commit -m "Add changes" -a
+        if: success()
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+        if: success()

.gitignore

@@ -111,3 +111,4 @@ poetry.lock
 *.bak
 
 .vscode
+docs/api/

.pre-commit-config.yaml

@@ -15,6 +15,7 @@ repos:
     -   id: masterpylintrc
         name: Overwrite local .pylintrc by master one
         entry: cp ../.pylintrc ./.pylintrc
+        files: ./.pylintrc
         pass_filenames: false
         always_run: true
         language: system
@@ -40,13 +41,6 @@ repos:
         language: system
         files: pyproject.toml
         pass_filenames: false
-    -   id: api
-        name: Generate API documentation
-        entry: bash -c
-        args: ['python api.py > docs/api.md']
-        language: system
-        pass_filenames: false
-        files: ^liquid/.+$
     -   id: pytest
         name: Run pytest
         entry: pytest

.pylintrc

@@ -145,7 +145,10 @@ disable=print-statement,
         no-name-in-module,
         no-member,
         broad-except,
-        cyclic-import
+        cyclic-import,
+        too-few-public-methods,
+        unbalanced-tuple-unpacking,
+        no-self-use
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -211,7 +214,7 @@ ignore-comments=yes
 ignore-docstrings=yes
 
 # Ignore imports when computing similarities.
-ignore-imports=no
+ignore-imports=yes
 
 # Minimum lines number of a similarity.
 min-similarity-lines=4
@@ -298,18 +301,21 @@ good-names=i,
            j,
            k,
            x,
-		   y,
+           y,
            z,
            np,
            nn,
+           ns,
            t,
            t0,
+           to,
            ex,
            rc,
            eq,
            do,
            by,
            tf,
+           op,
            Run,
            _
 

.travis.yml

@@ -4,6 +4,7 @@ matrix:
   include:
     - python: 3.6
     - python: 3.7
+    - python: 3.8
       dist: xenial
 before_install:
   - pip install poetry

README.md

@@ -1,54 +1,68 @@
 # liquidpy
 A port of [liquid][1] template engine for python
 
-[![Pypi][2]][9] [![Github][3]][10] [![PythonVers][4]][9] [![ReadTheDocs building][13]][8] [![Travis building][5]][11] [![Codacy][6]][12] [![Codacy coverage][7]][12]
+[![Pypi][2]][9] [![Github][3]][10] [![PythonVers][4]][9] [![Codacy][6]][12] [![Codacy coverage][7]][12] ![Docs building][13] ![Building][5]
+
+This is compatible with [standard Liquid][1] template engine. Variations, such as Shopify and Jekyll are not fully supported yet.
 
 ## Install
 ```shell
-pip install liquidpy
+pip install -U liquidpy
 ```
 
-## Current status and plans
-- Note that this branch is not fully compatible with shopify's liquid. For compatible versions, please check branches [lark][14] and [larkone][15].
-- This branch is current NOT safe agaist malicious input ([#22][16]), so we tried to re-implement the engine using `lark-parser`. However, both versions were very slow for lexer.
-- With branch `lark`, we tried to tokenize each tag and parse the content of the tags later using independent parsers, while with `larkone`, we tried to put all grammars together, and made it into a universal parser. However, both of them are slow, due to tokenization of whole tags (`raw` and `comment`) and literals (See `grammar.lark` in the code).
-- If you have a better grammar or idea for tokenization, you are very welcome to submit issues or PRs (writing naive lexer is just too much work).
-- We left some APIs to extend the `lark` ones with some functions from `master`. However, it won't happen before we find a faster lexer.
-- A temporary plan for the `master` branch is to do some security check to address [#22][16].
-
-## Full Documentation
-[ReadTheDocs][8]
-
 ## Baisic usage
 ```python
 from liquid import Liquid
 liq = Liquid('{{a}}')
-ret = liq.render(a = 1)
+ret = liq.render(a=1)
 # ret == '1'
 
-# load template from a file
-liq = Liquid('/path/to/template', liquid_from_file=True)
+# with environments pre-loaded
+liq = Liquid('{{a}}', a=1)
+ret = liq.render()
+# ret == '1'
+
+# With debug on:
+liq = Liquid('{{a}}', liquid_config={'debug': True})
+```
+
+## Python mode
+
+We also support a python mode template engine, which acts more pythonic and powerful.
+```python
+from liquid import Liquid
+# standard liquid doesn't support this
+liq = Liquid('{{a + 1}}', {'mode': 'python'})
+ret = liq.render(a=1)
+# ret == '2'
 ```
-With environments:
+
+Both modes can accept a path, a file-like object or a stream for the template:
 ```python
-liq = Liquid('{{a | os.path.basename}}', os=__import__('os'))
-ret = liq.render(a="path/to/file.txt")
-# ret == 'file.txt'
+Liquid('/path/to/template')
+# or
+with open('/path/to/template') as f:
+    Liquid(f)
 ```
 
+## Full Documentation
+- Liquid's [documentation][1]
+- Liquidpy's [documentation][14]
+
+## Backward compatiblility warning
+
+`v0.6.0+` is a remodeled version to make it compatible with standard liquid engine. If you are using a previous version, stick with it. `0.6.0+` is not fully compatible with previous versions.
+
 [1]: https://shopify.github.io/liquid/
 [2]: https://img.shields.io/pypi/v/liquidpy.svg?style=flat-square
 [3]: https://img.shields.io/github/tag/pwwang/liquidpy.svg?style=flat-square
 [4]: https://img.shields.io/pypi/pyversions/liquidpy.svg?style=flat-square
-[5]: https://img.shields.io/travis/pwwang/liquidpy.svg?style=flat-square
+[5]: https://img.shields.io/github/workflow/status/pwwang/liquidpy/Build%20and%20Deploy?style=flat-square
 [6]: https://img.shields.io/codacy/grade/aed04c099cbe42dabda2b42bae557fa4?style=flat-square
 [7]: https://img.shields.io/codacy/coverage/aed04c099cbe42dabda2b42bae557fa4?style=flat-square
 [8]: https://liquidpy.readthedocs.io/en/latest/
 [9]: https://pypi.org/project/liquidpy/
 [10]: https://github.com/pwwang/liquidpy
-[11]: https://travis-ci.org/pwwang/liquidpy
 [12]: https://app.codacy.com/manual/pwwang/liquidpy/dashboard
-[13]: https://img.shields.io/readthedocs/liquidpy?style=flat-square
-[14]: https://github.com/pwwang/liquidpy/tree/lark
-[15]: https://github.com/pwwang/liquidpy/tree/larkone
-[16]: https://github.com/pwwang/liquidpy/issues/22
+[13]: https://img.shields.io/github/workflow/status/pwwang/liquidpy/Build%20Docs?label=docs&style=flat-square
+[14]: https://pwwang.github.io/liquidpy/

README.rst

@@ -34,35 +34,58 @@ A port of `liquid <https://shopify.github.io/liquid/>`_ template engine for pyth
    :alt: Codacy coverage
  <https://app.codacy.com/manual/pwwang/liquidpy/dashboard>`_
 
+This is compatible with `standard Liquid <https://shopify.github.io/liquid/>`_ template engine. Variations, such as Shopify and Jekyll are not fully supported yet.
+
 Install
 -------
 
 .. code-block:: shell
 
    pip install liquidpy
 
-Full Documentation
-------------------
-
-`ReadTheDocs <https://liquidpy.readthedocs.io/en/latest/>`_
-
 Baisic usage
 ------------
 
 .. code-block:: python
 
    from liquid import Liquid
    liq = Liquid('{{a}}')
-   ret = liq.render(a = 1)
+   ret = liq.render(a=1)
    # ret == '1'
 
-   # load template from a file
-   liq = Liquid('/path/to/template', liquid_from_file=True)
+   # with environments pre-loaded
+   liq = Liquid('{{a}}', a=1)
+   ret = liq.render()
+   # ret == '1'
+
+   # With debug on:
+   liq = Liquid('{{a}}', liquid_config={'debug': True})
+
+Python mode
+-----------
+
+We also support a python mode template engine, which acts more pythonic and powerful.
 
-With environments:
+.. code-block:: python
+
+   from liquid import Liquid
+   # standard liquid doesn't support this
+   liq = Liquid('{{a + 1}}', {'mode': 'python'})
+   ret = liq.render(a=1)
+   # ret == '2'
+
+Both modes can accept a path, a file-like object or a stream for the template:
 
 .. code-block:: python
 
-   liq = Liquid('{{a | os.path.basename}}', os=__import__('os'))
-   ret = liq.render(a="path/to/file.txt")
-   # ret == 'file.txt'
+   Liquid('/path/to/template')
+   # or
+   with open('/path/to/template') as f:
+       Liquid(f)
+
+Full Documentation
+------------------
+
+
+* Liquid's `documentation <https://shopify.github.io/liquid/>`_
+* Liquidpy's `documentation <https://pwwang.github.io/liquidpy/>`_