Merge branch 'master' of https://github.com/Benoss/django-elasticsearch-debug-toolbar

Author: dbreen

.flake8

@@ -0,0 +1,9 @@
+[flake8]
+select = ANN,B,B9,BLK,C,D,DAR,E,F,I,S,W
+ignore = E203,E501,W503,D100,D415,D104,B008,B902
+max-line-length = 200
+max-complexity = 40
+application-import-names = tests
+import-order-style = google
+docstring-convention = google
+per-file-ignores = tests/*:S101,E402

.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,77 @@
+name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - django-version: "2.2.0"
+            python-version: "3.8"
+          - django-version: "3.2.0"
+            python-version: "3.8"
+          - django-version: "4.0.0"
+            python-version: "3.8"
+          - django-version: "2.2.0"
+            python-version: "3.10"
+          - django-version: "3.2.0"
+            python-version: "3.10"
+          - django-version: "4.0.0"
+            python-version: "3.10"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Upgrade pip version
+      run: |
+        python -m pip install -U pip
+
+    - name: Install test requirements/linters
+      run: pip install -r tests/requirements.txt
+
+    - name: Upgrade django version
+      run: |
+        python -m pip install "Django~=${{ matrix.django-version }}"
+
+    - name: Run pre-commit
+      run: pre-commit run --all-files
+
+
+  build-n-publish:
+    needs: tests
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+    - name: Publish distribution 📦 to Test PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      continue-on-error: true
+      with:
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -41,6 +41,7 @@ coverage.xml
 .mr.developer.cfg
 .project
 .pydevproject
+.pytest_cache
 
 # Rope
 .ropeproject

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+repos:
+    # github will run `pre-commit run --hook-stage manual -a` and then manually black and flake8
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+    -   id: check-yaml
+        stages: [commit, push, manual]
+    -   id: check-json
+        stages: [commit, push, manual]
+    -   id: end-of-file-fixer
+        stages: [commit, push, manual]
+    -   id: trailing-whitespace
+        stages: [commit, push, manual]
+-   repo: local
+    hooks:
+    -   id: isort
+        name: isort
+        entry: isort --profile black
+        language: system
+        types: [python]
+        stages: [commit, push, manual]
+    -   id: black
+        name: black
+        entry: black
+        language: system
+        types: [python]
+        stages: [commit, push, manual]
+    -   id: flake8
+        name: flake8
+        entry: flake8
+        language: system
+        types: [python]
+        stages: [commit, push, manual]
+    -   id: tests
+        name: pytest
+        entry: pytest
+        pass_filenames: false
+        language: system
+        types: [python]
+        stages: [commit, push, manual]

.travis.yml

@@ -1,3 +1,13 @@
+3.0.2
+* Just CI auto deploy fixes
+
+3.0.0
+* Compatible with Debug toolbar 3.x
+* Compatible with Django 4.0 (Requires python 3.8+)
+* Remove python 3.6 and 3.7
+* Add Python 3.8 3.9 3.10
+* Remove travis switch to github actions
+
 2.0.0
 * Remove python 2.x
 * Compatible with Debug toolbar 2.x
@@ -6,4 +16,4 @@
 Added duplicate detection and query hash
 
 0.1.0
-* Initial release
+* Initial release

CHANGES

@@ -16,4 +16,4 @@ 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.
+THE SOFTWARE.

LICENSE

@@ -8,7 +8,8 @@ A Django Debug Toolbar panel for Elasticsearch
 About
 ------------
 
-Breaking changes: 
+Breaking changes:
+* django-elasticsearch-debug-toolbar 3.x is compatible with Django Debug Toolbar 3.x (elasticsearch <8.0.0)
 * django-elasticsearch-debug-toolbar 2.x is compatible with Django Debug Toolbar 2.x
 * django-elasticsearch-debug-toolbar 1.x is compatible with Django Debug Toolbar 1.x
 
@@ -31,7 +32,7 @@ or install the development version from source::
 
     pip install git+git@github.com:Benoss/django-elasticsearch-debug-toolbar.git
 
-* Then add ``elastic_panel`` to your ``INSTALLED_APPS`` so that we can find the templates in the panel. 
+* Then add ``elastic_panel`` to your ``INSTALLED_APPS`` so that we can find the templates in the panel.
 * Also, add ``'elastic_panel.panel.ElasticDebugPanel'`` to your ``DEBUG_TOOLBAR_PANELS``.
 
 Usage
@@ -48,4 +49,3 @@ Uses the `MIT` license.
 
 * Django Debug Toolbar: https://github.com/django-debug-toolbar/django-debug-toolbar
 * MIT: http://opensource.org/licenses/MIT
-

README.md

@@ -1,12 +1,12 @@
-from django.conf import settings
-from django.template.loader import render_to_string
-from django.utils.translation import ugettext_lazy as _
-from debug_toolbar.panels import Panel
-from debug_toolbar.utils import ThreadCollector, get_stack, tidy_stacktrace, render_stacktrace, \
-    get_module_path, hidden_paths
 import hashlib
 import json
+import traceback
 
+from debug_toolbar.panels import Panel
+from debug_toolbar.utils import ThreadCollector, get_stack, tidy_stacktrace, render_stacktrace, \
+    get_module_path, hidden_paths
+from django.templatetags.static import static
+from django.utils.translation import gettext_lazy as _
 from elasticsearch.connection.base import Connection
 
 # Patching og the orginal elasticsearch log_request
@@ -66,20 +66,26 @@ class ElasticDebugPanel(Panel):
     nb_duplicates = 0
     nb_queries = 0
 
+    @property
     def nav_title(self):
         return _("Elastic Queries")
 
+    @property
     def nav_subtitle(self):
         default_str = "{} queries {:.2f}ms".format(self.nb_queries, self.total_time)
         if self.nb_duplicates > 0:
             default_str += " {} DUPE".format(self.nb_duplicates)
         return default_str
 
-    def url(self):
-        return ""
-
+    @property
     def title(self):
-        return self.nav_title()
+        return self.nav_title
+
+    @property
+    def scripts(self):
+        scripts = super().scripts
+        scripts.append(static("elastic_panel/js/elastic_panel.js"))
+        return scripts
 
     def process_request(self, request):
         collector.clear_collection()

elastic_panel/panel.py

@@ -16,7 +16,7 @@ var showHandler = function(e) {
         toggle(this.nextElementSibling)
     }
 
-    arrow = this.children[0]
+    var arrow = this.children[0];
     arrow.textContent = arrow.textContent == uarr ? darr : uarr
 
     toggle(this.parentNode.nextElementSibling)
@@ -29,8 +29,8 @@ for (var e of document.querySelectorAll('a.elasticShowTemplate')) {
 }
 
 var textHandler = function(e) {
-    selection = window.getSelection();
-    range = document.createRange();
+    var selection = window.getSelection();
+    var range = document.createRange();
     range.selectNodeContents(this.parentNode.nextElementSibling.querySelector('code'));
     selection.removeAllRanges();
     selection.addRange(range);