├── .coveragerc ├── .gitignore ├── .travis.yml ├── AUTHORS ├── CHANGES.rst ├── LICENSE ├── MANIFEST.in ├── README.rst ├── django_activeurl ├── __about__.py ├── __init__.py ├── conf.py ├── ext │ ├── __init__.py │ └── django_jinja.py ├── models.py ├── templatetags │ ├── __init__.py │ └── activeurl.py └── utils.py ├── docs ├── Makefile ├── _static │ └── .gitkeep ├── _templates │ └── .gitkeep ├── changes.rst ├── conf.py └── index.rst ├── pytest.ini ├── setup.cfg ├── setup.py ├── tests ├── __init__.py ├── jinja_config.py ├── templates │ ├── django │ │ └── django.html │ └── jinja │ │ └── jinja.html ├── test_activeurl.py ├── urls.py └── views.py └── tox.ini /.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | include = 3 | django_activeurl/* 4 | omit = 5 | 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .coverage 2 | .tox 3 | env* 4 | build 5 | dist 6 | *.egg-info 7 | *.egg 8 | *.log 9 | *.pyo 10 | *.pyc 11 | *$py.class 12 | *.sublime-project 13 | *.sublime-workspace 14 | *.sqlite* 15 | docs/build 16 | docs/_build 17 | *.db 18 | __pycache__ 19 | *.bak 20 | *.swp 21 | *.swo 22 | *~ 23 | .cache 24 | htmlcov 25 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | sudo: false 3 | dist: bionic # 18.04 4 | if: (type = push AND branch IN (master)) OR (type = pull_request) 5 | matrix: 6 | fast_finish: true 7 | include: 8 | - python: 2.7 9 | env: TOXENV=py27-flake8 10 | - python: 3.6 11 | env: TOXENV=py36-flake8 12 | 13 | - python: 2.7 14 | env: TOXENV=py27-isort 15 | - python: 3.6 16 | env: TOXENV=py36-isort 17 | 18 | - python: 3.6 19 | env: TOXENV=py36-dj22 20 | - python: 3.6 21 | env: TOXENV=py36-dj30 22 | 23 | - python: 3.6 24 | env: TOXENV=py36-djmaster 25 | 26 | allow_failures: 27 | - python: 3.6 28 | env: TOXENV=py36-djmaster 29 | 30 | cache: 31 | - apt 32 | - pip 33 | 34 | install: 35 | - pip install tox 36 | script: 37 | - tox 38 | after_success: 39 | - pip install codecov 40 | - codecov 41 | 42 | deploy: 43 | provider: pypi 44 | user: hellysmile 45 | password: 46 | secure: "MtYn/E/iO27Vhq8UNYjM7kcLUkKSG19ZVyysZAjoQQHaD7NE6Rc0nrQm6eG6n4LTy3IFKi79o9gDDwayFPSnId7gzGIxpF3tvnzfvM8za6a2tBJOl/J+x1anXwAyX4ifVmH3kkuLfpjch+ruAvU4+xex6U4IRiKg06yr3/DoJs8=" 47 | distributions: sdist bdist_wheel 48 | on: 49 | tags: true 50 | all_branches: true 51 | python: 3.6 52 | condition: $TOXENV = py36-dj20 53 | 54 | notifications: 55 | email: 56 | on_success: never 57 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | For an updated list of authors, view https://github.com/hellysmile/django-activeurl/graphs/contributors. 2 | 3 | If you contribute to this project, feel free to add yourself! 4 | 5 | - @hellysmile (creator): https://github.com/hellysmile 6 | - @tony (on behalf of https://devel.tech): https://github.com/tony 7 | - @jnns: https://github.com/jnns 8 | - @jor123: https://github.com/jor123 9 | - @jonashaag: https://github.com/jonashaag 10 | - @bmispelon: https://github.com/bmispelon 11 | - @wbphp (Ivan): https://github.com/wbphp 12 | - @RossLote: https://github.com/RossLote 13 | -------------------------------------------------------------------------------- /CHANGES.rst: -------------------------------------------------------------------------------- 1 | ========= 2 | Changelog 3 | ========= 4 | 5 | Here you can find the recent changes to django-activeurl 6 | 7 | 0.2.0 January 26th, 2020 8 | ------------------------ 9 | 10 | - Add support for Django 3.0, `#44`_, thanks `@meloncafe`_! 11 | - Drop support for Django versions less than 2.2, `#48`_ 12 | - Travis improvements, sort imports, remove python 3.3/3.4, `#45`_ 13 | 14 | .. _#44: https://github.com/hellysmile/django-activeurl/pull/44 15 | .. _@meloncafe: https://github.com/meloncafe 16 | .. _#45: https://github.com/hellysmile/django-activeurl/pull/45 17 | .. _#48: https://github.com/hellysmile/django-activeurl/pull/48 18 | 19 | 0.1.12 February 16, 2018 20 | ------------------------ 21 | 22 | - Ignore href="#" to fix incompatibilities with bootstrap. 23 | This matches <= 0.1.9 behaviour. 24 | 25 | 0.1.11 October 10, 2017 26 | ----------------------- 27 | 28 | - ignore_params now works with menu="no" 29 | 30 | 0.1.10 July 28, 2017 31 | -------------------- 32 | 33 | - Changelog started 34 | - Added ``ignore_params`` for matching patterns with GET parameters. 35 | 36 | e.g. */path/* will match */path/?param=value* 37 | 38 | To enable this, add ``ignore_params="yes"`` to your ``{% activeurl %}`` 39 | tag:: 40 | 41 | {% activeurl ignore_params="yes" %} 42 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright (c) hellysmile@gmail.com 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst 2 | include LICENSE 3 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ================ 2 | django-activeurl 3 | ================ 4 | 5 | Easy-to-use active URL highlighting for Django 6 | 7 | .. image:: https://img.shields.io/travis/hellysmile/django-activeurl.svg 8 | :target: https://travis-ci.org/hellysmile/django-activeurl 9 | 10 | .. image:: https://img.shields.io/codecov/c/github/hellysmile/django-activeurl.svg 11 | :target: https://codecov.io/gh/hellysmile/django-activeurl 12 | 13 | .. image:: https://img.shields.io/pypi/v/django_activeurl.svg 14 | :target: https://pypi.python.org/pypi/django-activeurl 15 | 16 | Features 17 | ======== 18 | 19 | * automatic highlighting of currently active ```` tags via CSS class 20 | * automatic highlighting of parent ```` tags for menus 21 | * removes boring / hardcoded stuff from your life! 22 | 23 | * href="#" never causes highlighting for compatibility with techniques such as 24 | bootstrap nav. 25 | 26 | Usage 27 | ===== 28 | 29 | After loading the template library via 30 | 31 | .. code-block:: html+django 32 | 33 | {% load activeurl %} 34 | 35 | the following code snippet will be rendered like this if `request.full_path()` starts with `/some_page/`: 36 | 37 | .. code-block:: html+django 38 | 39 | {% activeurl %} 40 | 52 | {% endactiveurl %} 53 | 54 | **Note:** 55 | The content of ``{% activeurl %}…{% endactiveurl %}`` must have valid root tag (i.e. 56 | ``