Merge pull request #69 from levlaz/feature-search

Feature search

Author: levlaz

app/main/forms.py

@@ -19,3 +19,7 @@ class ShareForm(Form):
 class NotebookForm(Form):
     title = StringField('Title:', validators=[Required()])
     submit = SubmitField('Submit')
+
+class SearchForm(Form):
+    search_field = StringField()
+    submit = SubmitField('Search')

app/main/views.py

@@ -183,6 +183,18 @@ def notebook(id):
         abort(403)
     return render_template('app/notebook.html', notebook=notebook, notes=notebook._show_notes())
 
+@main.route('/search')
+@login_required
+def search():
+    form = SearchForm()
+    if request.args.get('search_field', ''):
+        query = request.args.get('search_field', '')
+        results = Note.query.search(query).all()
+        if len(results) == 0:
+            flash('Hmm, we did not find any braindumps matching your search. Try again?')
+        return render_template('app/search.html', form=form, notes=results)
+    return render_template('app/search.html', form=form)
+
 
 @main.route('/shutdown')
 def server_shutdown():

app/models.py

@@ -8,9 +8,17 @@
 from datetime import datetime
 from app.exceptions import ValidationError
 
+# Full Text Search
+from flask.ext.sqlalchemy import SQLAlchemy, BaseQuery
+from sqlalchemy_searchable import SearchQueryMixin
+from sqlalchemy_searchable import make_searchable
+from sqlalchemy_utils.types import TSVectorType
+
 import bleach
 import hashlib
 
+make_searchable()
+
 @login_manager.user_loader
 def load_user(user_id):
     return User.query.get(int(user_id))
@@ -179,7 +187,11 @@ def to_json(self):
     def __repr__(self):
         return '<User {0}>'.format(self.username)
 
+class NoteQuery(BaseQuery, SearchQueryMixin):
+    pass
+
 class Note(db.Model):
+    query_class = NoteQuery
     __tablename__ = 'notes'
     id = db.Column(db.Integer, primary_key=True)
     title = db.Column(db.String(200))
@@ -192,6 +204,9 @@ class Note(db.Model):
 
     tags = db.relationship("Tag", secondary=note_tag, backref="Note", passive_deletes=True)
 
+    # Full Text Search
+    search_vector = db.Column(TSVectorType('title', 'body'))
+
     def to_json(self):
         json_note = {
             'url': url_for('api.get_note', id=self.id, _external=True),

app/templates/app/app_base.html

@@ -21,6 +21,9 @@
             <li class="sidebar-item">
                 <a href="/"><img class="app-logo" src="{{ url_for('static', filename='images/logo.png')}}"></img></a>
             </li>
+            <li class="sidebar-item" data-toggle="tooltip" data-placement="right" title="Search">
+                <a href="/search"><span class="nav-item glyphicon glyphicon-search" aria-hidden="true"></a></span>
+            </li>
             <li class="sidebar-item" data-toggle="tooltip" data-placement="right" title="Add a Note">
                 <a href="/add"><span class="nav-item glyphicon glyphicon-plus" aria-hidden="true"></a></span>
             </li>

app/templates/app/search.html

@@ -0,0 +1,24 @@
+{% extends "app/app_base.html" %}
+{% import "bootstrap/wtf.html" as wtf %}
+{% import "_macros.html" as macros %}
+
+{% block title %}BrainDump{% endblock %}
+
+{% block page_content %}
+
+      <h1 class="top"> Search for Anything </h1>
+
+      <form class="form form-horizontal" action="/search" role="form">
+          {{ wtf.form_field(form.search_field) }}
+          {{ wtf.form_field(form.submit, class="btn btn-default form-group") }}
+        </form>
+
+      {% include 'app/_notes.html' %}
+
+
+{% endblock %}
+
+{% block scripts %}
+{{ super() }}
+<script src="{{ url_for('static', filename='js/libs/marked.js') }}"></script>
+{% endblock %}

migrations/versions/488e3dae5a17_add_full_text_search.py

@@ -0,0 +1,38 @@
+"""Add Full Text Search
+
+Revision ID: 488e3dae5a17
+Revises: 34fa673d7905
+Create Date: 2015-12-07 10:49:44.124657
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '488e3dae5a17'
+down_revision = '34fa673d7905'
+
+from alembic import op
+import sqlalchemy as sa
+import sqlalchemy_utils
+from sqlalchemy_searchable import sync_trigger
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    conn = op.get_bind()
+    op.drop_table('sections')
+    op.add_column('notes', sa.Column('search_vector', sqlalchemy_utils.types.ts_vector.TSVectorType(), nullable=True))
+    op.create_index('ix_notes_search_vector', 'notes', ['search_vector'], unique=False, postgresql_using='gin')
+    ### end Alembic commands ###
+    sync_trigger(conn, 'notes', 'search_vector', ['title', 'body'])
+
+def downgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index('ix_notes_search_vector', table_name='notes')
+    op.drop_column('notes', 'search_vector')
+    op.create_table('sections',
+    sa.Column('id', sa.INTEGER(), nullable=False),
+    sa.Column('title', sa.VARCHAR(length=200), autoincrement=False, nullable=True),
+    sa.Column('notebook_id', sa.INTEGER(), autoincrement=False, nullable=True),
+    sa.ForeignKeyConstraint(['notebook_id'], [u'notebooks.id'], name=u'sections_notebook_id_fkey'),
+    sa.PrimaryKeyConstraint('id', name=u'sections_pkey')
+    )
+    ### end Alembic commands ###

requirements.txt

@@ -16,23 +16,28 @@ Markdown==2.6.4
 MarkupSafe==0.23
 Pygments==2.0.2
 SQLAlchemy==1.0.9
+SQLAlchemy-Searchable==0.9.3
+SQLAlchemy-Utils==0.31.4
 WTForms==2.0.2
 Werkzeug==0.11.2
 alembic==0.8.3
 argparse==1.2.1
 bleach==1.4.2
 blinker==1.4
 coverage==4.0.2
+decorator==4.0.4
 dominate==2.1.16
 html5lib==0.9999999
 httpie==0.9.2
 itsdangerous==0.24
 psycopg2==2.6.1
+pyparsing==2.0.6
 python-editor==0.4
 requests==2.8.1
 selenium==2.48.0
 six==1.10.0
 unittest-xml-reporting==1.13.0
+validators==0.9
 visitor==0.1.2
 wheel==0.24.0
 wsgiref==0.1.2