Merge pull request #70 from mistercrunch/dash_slug

Adding url slug support for dashboard model

panoramix/migrations/versions/1a48a5411020_adding_slug_to_dash.py

@@ -0,0 +1,23 @@
+"""adding slug to dash
+
+Revision ID: 1a48a5411020
+Revises: 289ce07647b
+Create Date: 2015-12-04 09:42:16.973264
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '1a48a5411020'
+down_revision = '289ce07647b'
+
+from alembic import op
+import sqlalchemy as sa
+
+def upgrade():
+    op.add_column('dashboards', sa.Column('slug', sa.String(length=255), nullable=True))
+    op.create_unique_constraint(None, 'dashboards', ['slug'])
+
+
+def downgrade():
+    op.drop_constraint(None, 'dashboards', type_='unique')
+    op.drop_column('dashboards', 'slug')

panoramix/models.py

@@ -134,6 +134,7 @@ class Dashboard(Model, AuditMixinNullable):
     position_json = Column(Text)
     description = Column(Text)
     css = Column(Text)
+    slug = Column(String(255), unique=True)
     slices = relationship(
         'Slice', secondary=dashboard_slices, backref='dashboards')
 
@@ -142,7 +143,7 @@ class Dashboard(Model, AuditMixinNullable):
 
     @property
     def url(self):
-        return "/panoramix/dashboard/{}/".format(self.id)
+        return "/panoramix/dashboard/{}/".format(self.slug or self.id)
 
     def dashboard_link(self):
         return '<a href="{self.url}">{self.dashboard_title}</a>'.format(self=self)

panoramix/views.py

@@ -210,7 +210,8 @@ appbuilder.add_view(
 class DashboardModelView(PanoramixModelView, DeleteMixin):
     datamodel = SQLAInterface(models.Dashboard)
     list_columns = ['dashboard_link', 'created_by', 'changed_by', 'changed_on']
-    edit_columns = ['dashboard_title', 'slices', 'position_json', 'css']
+    edit_columns = [
+        'dashboard_title', 'slug', 'slices', 'position_json', 'css']
     add_columns = edit_columns
     base_order = ('changed_on','desc')
     description_columns = {
@@ -223,7 +224,13 @@ class DashboardModelView(PanoramixModelView, DeleteMixin):
             "The css for individual dashboards can be altered here, or "
             "in the dashboard view where changes are immediatly "
             "visible"),
+        'slug': "To get a readable URL for your dashboard",
     }
+    def pre_add(self, obj):
+        obj.slug = obj.slug.strip() or None
+
+    def pre_update(self, obj):
+        self.pre_add(obj)
 
 
 appbuilder.add_view(
@@ -424,15 +431,16 @@ class Panoramix(BaseView):
                 mimetype="application/json")
 
     @has_access
-    @expose("/dashboard/<id_>/")
-    def dashboard(self, id_):
+    @expose("/dashboard/<identifier>/")
+    def dashboard(self, identifier):
         session = db.session()
-        dashboard = (
-            session
-            .query(models.Dashboard)
-            .filter(models.Dashboard.id == id_)
-            .first()
-        )
+        qry = session.query(models.Dashboard)
+        if identifier.isdigit():
+            qry = qry.filter_by(id=int(identifier))
+        else:
+            qry = qry.filter_by(slug=identifier)
+
+        dashboard = qry.first()
         pos_dict = {}
         if dashboard.position_json:
             pos_dict = {