Merge pull request #488 from MongoEngine/example_app_style_update

insspb · web-flow · commit f8af88092424 · 2022-07-23T23:36:15.000+03:00
Changed: Example app view style
diff --git a/example_app/app.py b/example_app/app.py
@@ -2,8 +2,8 @@
 from flask_debugtoolbar import DebugToolbarExtension
 from pymongo import monitoring
 
+from example_app import views
 from example_app.models import db
-from example_app.views import index, pagination
 from flask_mongoengine.panels import mongo_command_logger
 
 app = flask.Flask("example_app")
@@ -38,8 +38,8 @@
 db.init_app(app)
 
 
-app.add_url_rule("/", view_func=index)
-app.add_url_rule("/pagination", view_func=pagination)
+app.add_url_rule("/", view_func=views.index, methods=["GET", "POST"])
+app.add_url_rule("/pagination", view_func=views.pagination, methods=["GET", "POST"])
 
 if __name__ == "__main__":
     app.run(host="0.0.0.0", port=8000)
diff --git a/example_app/compose/flask/Dockerfile b/example_app/compose/flask/Dockerfile
@@ -7,5 +7,6 @@ RUN apt-get update && \
 RUN groupadd -r flask && useradd -r -g flask flask
 COPY --chown=flask . /flask_mongoengine
 RUN pip install --upgrade pip  \
-    && pip install -e /flask_mongoengine[toolbar,wtf]
+    && pip install -e /flask_mongoengine[toolbar,wtf] \
+    && pip install Faker
 WORKDIR /flask_mongoengine
diff --git a/example_app/models.py b/example_app/models.py
@@ -1,6 +1,7 @@
 import datetime
 
 from flask_mongoengine import MongoEngine
+from flask_mongoengine.wtf.orm import model_form
 
 db = MongoEngine()
 
@@ -10,3 +11,6 @@ class Todo(db.Document):
     text = db.StringField()
     done = db.BooleanField(default=False)
     pub_date = db.DateTimeField(default=datetime.datetime.now)
+
+
+TodoForm = model_form(Todo)
diff --git a/example_app/static/style.css b/example_app/static/style.css
diff --git a/example_app/templates/index.html b/example_app/templates/index.html
@@ -1,13 +1,18 @@
 {% extends "layout.html" %}
 {% block body %}
-  {% for todo in todos %}
-    <div>
-      <h2>{{ todo.title }}</h2>
-      {{ todo.text|safe }}
-    </div>
-  {% else %}
-    <em>Unbelievable.  No todos here so far <a href="/add">Add one</a></em>
-  {% endfor %}
-  <br/>
-  <a href="{{ url_for('pagination') }}">See pagination</a>
+  <p>This is demo application that shows Flask-Mongoengine features and integrations.</p>
+  <p>Feel free to open Flask debug toolbar after any action to check executed database requests.</p>
+  <p>If you use this application for first time, it is good idea to generate some fake data.</p>
+  <p>
+    Data will be generated inside docker container database.
+    Two databases will be used to show Flask Debug Panel integration capabilities.
+  </p>
+  <p>You can also delete all data, to test forms only.</p>
+  {% if message %}
+  <p><mark>{{ message }}</mark></p>
+  {% endif %}
+  <form action="{{ url_for("index") }}" method="post">
+    <input type="submit" name="button" value="Generate data"/>
+    <input type="submit" name="button" value="Delete data"/>
+  </form>
 {% endblock %}
diff --git a/example_app/templates/layout.html b/example_app/templates/layout.html
@@ -1,14 +1,19 @@
 <!doctype html>
-<html>
+<html lang="en">
 <head>
-<title>Flask MongoEngine</title>
-<link rel=stylesheet type=text/css href="{{ url_for('static', filename='style.css') }}">
+  <title>Flask MongoEngine</title>
+  <link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css">
 </head>
 <body>
-<div class=page>
-  <h1>Toolbar example</h1>
+<nav>
+  <ul>
+    <li><a href="{{ url_for("index") }}">Home</a></li>
+    <li><a href="{{ url_for("pagination") }}">Pagination</a></li>
+  </ul>
+</nav>
+<div>
   <div>
-  {% block body %}{% endblock %}
+    {% block body %}{% endblock %}
   </div>
 </div>
 </body>
diff --git a/example_app/templates/pagination.html b/example_app/templates/pagination.html
@@ -2,34 +2,68 @@
 
 {# Macro for creating navigation links #}
 {% macro render_navigation(pagination, endpoint) %}
-    <div class=pagination>
-        {% for page in pagination.iter_pages() %}
-            {% if page %}
-                {% if page != pagination.page %}
-                    <a href="{{ url_for(endpoint, page=page) }}">{{ page }}</a>
-                {% else %}
-                    <strong>{{ page }}</strong>
-                {% endif %}
-            {% else %}
-                <span class=ellipsis>…</span>
-            {% endif %}
-        {% endfor %}
-    </div>
+  <div>
+    {% for page in pagination.iter_pages() %}
+      {% if page %}
+        {% if page != pagination.page %}
+          <a href="{{ url_for(endpoint, page=page) }}">{{ page }}</a>
+        {% else %}
+          <strong>{{ page }}</strong>
+        {% endif %}
+      {% else %}
+        <span>nothing to show</span>
+      {% endif %}
+    {% endfor %}
+  </div>
 {% endmacro %}
 
-{% block body %}
-
-<div class="todos">
-    <ul>
-        {% for todo in todos_page.items %}
-            <li>{{ todo.title }}</li>
-        {% endfor %}
-    </ul>
-</div>
+{% macro with_errors(field) %}
+  <div class="form_field">
+    {% if field.errors %}
+      {% set css_class = 'has_error ' + kwargs.pop('class', '') %}
+      {{ field.label }}{{ field(class=css_class, **kwargs) }}{% if field.flags.required %}*{% endif %}
+      <ul class="errors">{% for error in field.errors %}
+        <li>{{ error|e }}</li>{% endfor %}</ul>
+    {% else %}
+      {{ field.label }}{{ field(**kwargs) }}{% if field.flags.required %}*{% endif %}
+    {% endif %}
+  </div>
+{% endmacro %}
 
-<div class="navigation">
-    {{ render_navigation(todos_page, 'pagination') }}
-</div>
+{% block body %}
 
+  <div>
+    <table>
+      <thead>
+      <tr>
+        <th>Title</th>
+        <th>Text</th>
+        <th>Done</th>
+        <th>Publication date</th>
+      </tr>
+      </thead>
+      <tbody>
+      {% for todo in todos_page.items %}
+        <tr>
+          <td>{{ todo.title }}</td>
+          <td>{{ todo.text }}</td>
+          <td>{{ todo.done }}</td>
+          <td>{{ todo.pub_date }}</td>
+        </tr>
+      {% endfor %}
+      </tbody>
+    </table>
+  </div>
+  <div>
+    {{ render_navigation(todos_page, "pagination") }}
+  </div>
+  <div>
+    <form method="POST" action="{{ url_for("pagination") }}">
+      {% for field in form %}
+        {{ with_errors(field, style='font-weight: bold') }}
+      {% endfor %}
+      <input type="submit" value="Create">
+    </form>
+  </div>
 
 {% endblock %}
diff --git a/example_app/views.py b/example_app/views.py
@@ -1,37 +1,78 @@
-import flask
+"""Demo views for example application."""
+from faker import Faker
+from flask import render_template, request
 from mongoengine.context_managers import switch_db
 
+from example_app import models
 
-def index():
-    from models import Todo
-
-    with switch_db(Todo, "default") as Todo:
-        # As a list to test debug toolbar
-        Todo.objects().delete()  # Removes
-        Todo(title="Simple todo A", text="12345678910").save()  # Insert
-        Todo(title="Simple todo B", text="12345678910").save()  # Insert
-        Todo(title="Simple todo C", text="12345678910").save()  # Insert
+
+def generate_data():
+    """Generates fake data for all supported models and views."""
+    fake = Faker(locale=["en_US"])
+
+    with switch_db(models.Todo, "default"):
+        models.Todo.objects().delete()  # Removes
+        models.Todo(
+            title="Simple todo A", text=fake.sentence(), done=False
+        ).save()  # Insert
+        models.Todo(
+            title="Simple todo B", text=fake.sentence(), done=True
+        ).save()  # Insert
+        models.Todo(
+            title="Simple todo C", text=fake.sentence(), done=True
+        ).save()  # Insert
         # Bulk insert
-        bulk = (Todo(title="Bulk 1"), Todo(title="Bulk 2"))
-        Todo.objects().insert(bulk)
-        Todo.objects(title__contains="B").order_by("-title").update(
+        bulk = (
+            models.Todo(title="Bulk 1", text=fake.sentence(), done=False),
+            models.Todo(title="Bulk 2", text=fake.sentence(), done=True),
+        )
+        models.Todo.objects().insert(bulk)
+        models.Todo.objects(title__contains="B").order_by("-title").update(
             set__text="Hello world"
         )  # Update
-        Todo.objects(title__contains="C").order_by("-title").delete()  # Removes
-        todos = list(Todo.objects.order_by("-title", "done")[2:10])
-        todos = Todo.objects.all().order_by("-title")
-    return flask.render_template("index.html", todos=todos)
+        models.Todo.objects(title__contains="C").order_by("-title").delete()  # Removes
 
+    with switch_db(models.Todo, "secondary"):
+        models.Todo.objects().delete()
+        for _ in range(10):
+            models.Todo(
+                title=fake.text(max_nb_chars=59),
+                text=fake.sentence(),
+                done=fake.pybool(),
+                pub_date=fake.date(),
+            ).save()
 
-def pagination():
-    from models import Todo
 
-    with switch_db(Todo, "secondary") as Todo:
-        Todo.objects().delete()
-        for i in range(10):
-            Todo(title=f"Simple todo {i}", text="12345678910").save()
+def delete_data():
+    """Clear database."""
+    with switch_db(models.Todo, "default"):
+        models.Todo.objects().delete()
+    with switch_db(models.Todo, "secondary"):
+        models.Todo.objects().delete()
+
+
+def index():
+    """Return page with welcome words and instructions."""
+    message = None
+    if request.method == "POST":
+        if request.form["button"] == "Generate data":
+            generate_data()
+            message = "Fake data generated"
+        if request.form["button"] == "Delete data":
+            delete_data()
+            message = "All data deleted"
+    return render_template("index.html", message=message)
+
+
+def pagination():
+    """Return pagination and easy form demonstration."""
+    form = models.TodoForm()
 
-        page_num = int(flask.request.args.get("page") or 1)
-        todos_page = Todo.objects.paginate(page=page_num, per_page=3)
+    with switch_db(models.Todo, "secondary"):
+        if request.method == "POST":
+            form.validate_on_submit()
+            form.save()
+        page_num = int(request.args.get("page") or 1)
+        todos_page = models.Todo.objects.paginate(page=page_num, per_page=3)
 
-    return flask.render_template("pagination.html", todos_page=todos_page)
+    return render_template("pagination.html", todos_page=todos_page, form=form)
