Merge pull request #872 from LeXofLeviafan/flask-admin-v2

migrating to Flask-Admin v2

Author: jarun

bukuserver/README.md

@@ -36,6 +36,8 @@ $ # regular/venv install
 $ pip3 install "buku[server]"
 $ # pipx install
 $ pipx install "buku[server]"
+$ # with locales
+$ pipx install "buku[server,locales]"
 ```
 
 #### From source
@@ -45,6 +47,8 @@ $ git clone https://github.com/jarun/buku
 $ cd buku
 $ # regular/venv install
 $ pip3 install ".[server]"
+$ # with locales
+$ pip3 install ".[server,locales]"
 ```
 
 #### Using Docker
@@ -134,7 +138,7 @@ _**²**_ if input is invalid, the default value will be used if defined
 
 _**³**_ `BUKUSERVER_DB_FILE` can be a DB name (plain filename without extension; cannot contain `.`). The specified DB with `.db` extension is located in default DB directory (which you can override with `BUKU_DEFAULT_DBDIR`).
 
-_**⁴**_ `BUKUSERVER_LOCALE` requires either `flask_babel` or `flask_babelex` installed
+_**⁴**_ `BUKUSERVER_LOCALE` requires buku to be installed with `[locales]`
 
 _**⁵**_ the value for `BUKUSERVER_REVERSE_PROXY_PATH` is recommended to include preceding slash and not have trailing slash (i.e. use `/foo` not `/foo/`)
 

bukuserver/__init__.py

@@ -1,8 +1,5 @@
-try:  # as per Flask-Admin-1.6.1
-    try:
-        from flask_babelex import gettext, ngettext, pgettext, lazy_gettext, lazy_pgettext, LazyString
-    except ImportError:
-        from flask_babel import gettext, ngettext, pgettext, lazy_gettext, lazy_pgettext, LazyString
+try:
+    from flask_babel import gettext, ngettext, pgettext, lazy_gettext, lazy_pgettext, LazyString
 except ImportError:
     from flask_admin.babel import gettext as _gettext, ngettext, lazy_gettext
     gettext = lambda s, *a, **kw: (s if not kw else _gettext(s, *a, **kw))

bukuserver/requirements.txt

@@ -1,5 +1,5 @@
 arrow>=1.2.2
-Flask-Admin>=1.6.1,<2
+Flask-Admin>=2.0.0
 flask-paginate>=2022.1.8
 Flask-WTF>=1.0.1
 Flask>=2.2.2

bukuserver/server.py

@@ -11,6 +11,7 @@
 from flask import Flask, redirect, request, url_for
 from flask.cli import FlaskGroup
 from flask_admin import Admin
+from flask_admin.theme import Bootstrap4Theme
 from flasgger import Swagger
 
 from buku import BukuDb, __version__
@@ -35,13 +36,9 @@ def get_bool_from_env_var(key: str, default_value: bool = False) -> bool:
 
 
 def init_locale(app, context_processor=lambda: {}):
-    try:  # as per Flask-Admin-1.6.1
-        try:
-            from flask_babelex import Babel
-            Babel(app).localeselector(lambda: app.config['BUKUSERVER_LOCALE'])
-        except ImportError:
-            from flask_babel import Babel
-            Babel().init_app(app, locale_selector=lambda: app.config['BUKUSERVER_LOCALE'])
+    try:
+        from flask_babel import Babel
+        Babel().init_app(app, locale_selector=lambda: app.config['BUKUSERVER_LOCALE'])
         app.context_processor(lambda: {'lang': app.config['BUKUSERVER_LOCALE'] or 'en', **context_processor()})
     except Exception as e:
         app.jinja_env.add_extension('jinja2.ext.i18n')
@@ -99,7 +96,7 @@ def create_app(db_file=None):
         app.config['REVERSE_PROXY_PATH'] = reverse_proxy_path
         ReverseProxyPrefixFix(app)
     bukudb = BukuDb(dbfile=db_file)
-    app.config['FLASK_ADMIN_SWATCH'] = (os.getenv('BUKUSERVER_THEME') or 'default').lower()
+    theme = (os.getenv('BUKUSERVER_THEME') or 'default').lower()
     app.config['BUKUSERVER_LOCALE'] = os.getenv('BUKUSERVER_LOCALE') or 'en'
     _dir = os.path.dirname(os.path.realpath(__file__))
     app.config['SWAGGER'] = {'title': 'Bukuserver API', 'doc_dir': os.path.join(_dir, 'apidocs')}
@@ -118,7 +115,7 @@ def shell_context():
     app.jinja_env.globals.update(_p=_p, dbfile=bukudb.dbfile, dbname=bukudb.dbname)
 
     admin = Admin(
-        app, name='buku server', template_mode='bootstrap4',
+        app, name='buku server', theme=Bootstrap4Theme(swatch=theme),
         index_view=views.CustomAdminIndexView(
             template='bukuserver/home.html', url='/'
         )

bukuserver/templates/bukuserver/lib.html

@@ -143,12 +143,11 @@
 {% macro page_size_custom() %}
   <script>
     $(document).ready(function() {
-      const SIZES = [20, 50, 100];  // hardcoded list; see page_size_form() in admin/model/layout.html
       let pageSize = url => new URL(url || location.host).searchParams.get('page_size');
       $(`.nav.nav-tabs .dropdown-menu`).each(function () {
         let _sizes = $(`a.dropdown-item`, this).map(function () {return pageSize(this.href)}).get();
-        if (SIZES.every((x, i) => x == _sizes[i]))
-          $('a', this).last().clone().text({{ _('custom')|tojson }}).attr('href', `#`).on('click', () => {
+        if (_sizes.length > 2 && _sizes.length == new Set(_sizes).size)  // 3+ links; each link has different pagesize
+          $('a', this).last().clone().text({{ _('custom')|tojson }}).removeClass('active').attr('href', `#`).on('click', () => {
             let page = prompt({{ _('Set custom page size (empty for default)')|tojson }}, pageSize(location) || '');
             if (Number(page) || (page == "")) {
               let search = new URL(location).searchParams;

bukuserver/views.py

@@ -195,13 +195,20 @@ def __init__(self, bukudb: buku.BukuDb, *args, **kwargs):
         custom_model = types.SimpleNamespace(bukudb=bukudb, __name__='bookmark')
         super().__init__(custom_model, *args, **kwargs)
 
+    @property
+    def url_render_mode(self):
+        return app_param('URL_RENDER_MODE', DEFAULT_URL_RENDER_MODE)
+
     @property
     def page_size(self):
         return app_param('PER_PAGE', DEFAULT_PER_PAGE)
 
     @property
-    def url_render_mode(self):
-        return app_param('URL_RENDER_MODE', DEFAULT_URL_RENDER_MODE)
+    def page_size_options(self):
+        return tuple(sorted(set([self.page_size] + list(super().page_size_options))))
+
+    def get_safe_page_size(self, page_size):  # un-enforcing the restriction
+        return (page_size if self.can_set_page_size and page_size > 0 else self.page_size)
 
     def create_form(self, obj=None):
         form = super().create_form(obj)
@@ -464,6 +471,13 @@ def __init__(self, bukudb, *args, **kwargs):
     def page_size(self):
         return app_param('PER_PAGE', DEFAULT_PER_PAGE)
 
+    @property
+    def page_size_options(self):
+        return tuple(sorted(set([self.page_size] + list(super().page_size_options))))
+
+    def get_safe_page_size(self, page_size):  # un-enforcing the restriction
+        return (page_size if self.can_set_page_size and page_size > 0 else self.page_size)
+
     @expose('/refresh', methods=['POST'])
     def refresh(self):
         self._refresh()

setup.py

@@ -10,6 +10,8 @@
 with open('README.md', encoding='utf-8') as f:
     long_description = f.read()
 
+server_locales_require = ['Flask-Admin[translation]']
+
 tests_require = [
     'attrs>=17.4.0',
     'beautifulsoup4>=4.6.0',
@@ -27,13 +29,12 @@
     'setuptools>=41.0.1',
     'vcrpy>=1.13.0',
     'lxml',
-    'flask_babel',
-]
+] + server_locales_require
 
 
 server_require = [
     "arrow>=1.2.2",
-    "Flask-Admin>=1.6.1,<2",
+    "Flask-Admin>=2.0.0",
     "flask-paginate>=2022.1.8",
     "Flask-WTF>=1.0.1",
     "Flask>=2.2.2",
@@ -72,6 +73,7 @@
     extras_require={
         "tests": tests_require + server_require,
         "server": server_require,
+        "locales": server_locales_require,
         "docs": [
             "myst-parser>=0.17.0",
             "sphinx-rtd-theme>=1.0.0",

tests/test_setup.py

@@ -13,20 +13,12 @@ def m_setup(**_):
 
     return setup
 
+_reqs = lambda path: [s for s in pathlib.Path(path).read_text(encoding='utf8', errors='surrogateescape').splitlines()
+                      if not s.startswith('#') and s != 'setuptools']
 
-def test_bukuserver_requirement(setup_obj):
-    assert [
-        x
-        for x in pathlib.Path("bukuserver/requirements.txt").read_text(encoding="utf8", errors="surrogateescape").splitlines()
-        if "flask-reverse-proxy-fix" not in x
-    ] == setup_obj.server_require
 
+def test_bukuserver_requirement(setup_obj):
+    assert sorted(_reqs('bukuserver/requirements.txt')) == sorted(setup_obj.server_require)
 
 def test_buku_requirement(setup_obj):
-    assert sorted(
-        [
-            x
-            for x in pathlib.Path("requirements.txt").read_text(encoding="utf8", errors="surrogateescape").splitlines()
-            if not x.startswith('#') and x != 'setuptools'
-        ]
-    ) == sorted(setup_obj.install_requires)
+    assert sorted(_reqs('requirements.txt')) == sorted(setup_obj.install_requires)

tests/test_views.py

@@ -250,7 +250,7 @@ def test_update(bukudb, client, override):
 @pytest.mark.slow
 @pytest.mark.parametrize('redirect, uri, args', [
     ('_add_another', '/bookmark/new/', {'url': '/bookmark/'}),
-    ('_continue_editing', '/bookmark/edit/', {'id': '1'}),
+    ('_continue_editing', '/bookmark/edit/', {'id': '1', 'url': '/bookmark/'}),
 ])
 def test_update_redirect(bukudb, client, redirect, uri, args):
     _add_rec(bukudb, 'http://example.org')
@@ -412,22 +412,22 @@ def test_env_theme(theme, client):
     'en': {f'//ul{xpath_cls("nav navbar-nav")}/li/a/text()': ['Home', 'Bookmarks', 'Tags', 'Statistic'],
            f'//ul{xpath_cls("nav nav-tabs")}/li/a/text()': ['List (1)', 'Create', 'Random', 'Reorder', 'Add Filter', '10 items'],
            f'//td{xpath_cls("list-buttons-column")}/a/@title': ['View Record', 'Edit Record'],
-           f'//td{xpath_cls("list-buttons-column")}/form/button/@title': ['Delete record']},
+           f'//td{xpath_cls("list-buttons-column")}/form/button/@title': ['Delete Record']},
     'de': {f'//ul{xpath_cls("nav navbar-nav")}/li/a/text()': ['Start', 'Lesezeichen', 'Schilder', 'Statistik'],
            f'//ul{xpath_cls("nav nav-tabs")}/li/a/text()':
                ['Liste (1)', 'Erstellen', 'Zufälliger', 'Neu anordnen', 'Filter hinzufügen', '10 Elemente'],
            f'//td{xpath_cls("list-buttons-column")}/a/@title': ['Eintrag ansehen', 'Eintrag bearbeiten'],
-           f'//td{xpath_cls("list-buttons-column")}/form/button/@title': ['Delete record']},  # ['Datensatz löschen']},
+           f'//td{xpath_cls("list-buttons-column")}/form/button/@title': ['Datenzatz löschen']},
     'fr': {f'//ul{xpath_cls("nav navbar-nav")}/li/a/text()': ['Accueil', 'Signets', 'Étiquettes', 'Statistique'],
            f'//ul{xpath_cls("nav nav-tabs")}/li/a/text()':
-               ['Liste (1)', 'Créer', 'Aléatoire', 'Réorganiser', 'Ajouter un filtre', '10 items'],
+               ['Liste (1)', 'Créer', 'Aléatoire', 'Réorganiser', 'Ajouter un filtre', '10 articles'],
            f'//td{xpath_cls("list-buttons-column")}/a/@title': ['Afficher L\'enregistrement', 'Modifier enregistrement'],
-           f'//td{xpath_cls("list-buttons-column")}/form/button/@title': ['Delete record']},  # ['Supprimer l\'enregistrement']},
+           f'//td{xpath_cls("list-buttons-column")}/form/button/@title': ['Supprimer l\'enregistrement']},
     'ru': {f'//ul{xpath_cls("nav navbar-nav")}/li/a/text()': ['Главная', 'Закладки', 'Теги', 'Статистика'],
            f'//ul{xpath_cls("nav nav-tabs")}/li/a/text()':
                ['Список (1)', 'Создать', 'Случайная', 'Изменить порядок', 'Добавить Фильтр', '10 элементы'],
            f'//td{xpath_cls("list-buttons-column")}/a/@title': ['Просмотр записи', 'Редактировать запись'],
-           f'//td{xpath_cls("list-buttons-column")}/form/button/@title': ['Delete record']},  # ['Удалить запись']},
+           f'//td{xpath_cls("list-buttons-column")}/form/button/@title': ['Удалить запись']},
 }
 locale = env_fixture('BUKUSERVER_LOCALE', params=['en', 'de', 'fr', 'ru', None])