From 490d38ea133e6739b2e753b6e1679528410caef3 Mon Sep 17 00:00:00 2001
From: Nikita Konovalov <nkonovalov@mirantis.com>
Date: Tue, 13 May 2014 17:17:30 +0400
Subject: [PATCH] Make Timeline configurable

The Timeline events can now be filtered in preferences view.
By default all event types are enabled.

Change-Id: I6099e8491e2f8615273df198df95596d31584870
---
 .../profile_preferences_controller.js         |  4 ++
 .../controllers/story_detail_controller.js    |  4 +-
 src/app/stories/module.js                     | 14 ++++-
 src/app/templates/profile/preferences.html    | 53 +++++++++++++++++++
 .../story/comments/story_created.html         |  2 +-
 .../story/comments/story_details_changed.html |  2 +-
 .../story/comments/task_assignee_changed.html |  2 +-
 .../story/comments/task_created.html          |  2 +-
 .../story/comments/task_deleted.html          |  2 +-
 .../story/comments/task_details_changed.html  |  2 +-
 .../story/comments/task_status_changed.html   |  2 +-
 .../story/comments/user_comment.html          |  2 +-
 src/app/util/constants/timeline_event_type.js | 28 ++++++++++
 13 files changed, 109 insertions(+), 10 deletions(-)
 create mode 100644 src/app/util/constants/timeline_event_type.js

diff --git a/src/app/profile/controller/profile_preferences_controller.js b/src/app/profile/controller/profile_preferences_controller.js
index 67c4a0e1..7abb0d76 100644
--- a/src/app/profile/controller/profile_preferences_controller.js
+++ b/src/app/profile/controller/profile_preferences_controller.js
@@ -23,9 +23,13 @@ angular.module('sb.profile').controller('ProfilePreferencesController',
         'use strict';
 
         $scope.pageSize = Preference.get('page_size');
+        $scope.enabled_event_types = Preference.get('display_events_filter');
 
         $scope.save = function () {
             Preference.set('page_size', $scope.pageSize);
+            Preference.set('display_events_filter',
+                            $scope.enabled_event_types);
+
             $scope.message = 'Preferences Saved!';
         };
     });
\ No newline at end of file
diff --git a/src/app/stories/controllers/story_detail_controller.js b/src/app/stories/controllers/story_detail_controller.js
index 04b1bd35..c0cfbd1a 100644
--- a/src/app/stories/controllers/story_detail_controller.js
+++ b/src/app/stories/controllers/story_detail_controller.js
@@ -19,7 +19,7 @@
  */
 angular.module('sb.story').controller('StoryDetailController',
     function ($log, $scope, $state, $stateParams, $modal, Story,
-              Session, User) {
+              Session, User, Preference) {
         'use strict';
 
         // Parse the ID
@@ -27,6 +27,8 @@ angular.module('sb.story').controller('StoryDetailController',
             parseInt($stateParams.storyId, 10) :
             null;
 
+        $scope.enabled_event_types = Preference.get('display_events_filter');
+
         /**
          * Generic service error handler. Assigns errors to the view's scope,
          * and unsets our flags.
diff --git a/src/app/stories/module.js b/src/app/stories/module.js
index 59241940..e8d73186 100644
--- a/src/app/stories/module.js
+++ b/src/app/stories/module.js
@@ -20,7 +20,8 @@
  */
 angular.module('sb.story', ['ui.router', 'sb.services', 'sb.util',
     'ui.bootstrap'])
-    .config(function ($stateProvider, $urlRouterProvider) {
+    .config(function ($stateProvider, $urlRouterProvider, PreferenceProvider,
+            TimelineEventTypes) {
         'use strict';
 
         // URL Defaults.
@@ -42,4 +43,15 @@ angular.module('sb.story', ['ui.router', 'sb.services', 'sb.util',
                 url: '/{storyId:[0-9]+}',
                 templateUrl: 'app/templates/story/detail.html'
             });
+
+        // Register a preference for filtering timeline events.
+        // By default all types of events should be displayed.
+
+        var events_filter_defaults = {};
+        TimelineEventTypes.forEach(function(type) {
+            events_filter_defaults[type] = true;
+        });
+
+        PreferenceProvider.addPreference('display_events_filter',
+                                         events_filter_defaults);
     });
diff --git a/src/app/templates/profile/preferences.html b/src/app/templates/profile/preferences.html
index 6147a9e2..70023521 100644
--- a/src/app/templates/profile/preferences.html
+++ b/src/app/templates/profile/preferences.html
@@ -56,6 +56,59 @@
 
                 <hr/>
 
+                <div class="form-group">
+                    <label>Timeline events</label>
+
+                    <p class="help-block">
+                        Which types of Timeline events would you like to be
+                        displayed?
+                    </p>
+
+                    <div>
+                        <input type="checkbox" name="enabledTypes"
+                               id="storyCreated"
+                               ng-model="enabled_event_types.story_created">
+                        <label for="storyCreated">Story created</label>
+                        <br/>
+                        <input type="checkbox" name="enabledTypes"
+                               id="storyDetailsChanged"
+                               ng-model="enabled_event_types.story_details_changed">
+                        <label for="storyDetailsChanged">Story details changed</label>
+                        <br/>
+                        <input type="checkbox" name="enabledTypes"
+                               id="taskCreated"
+                               ng-model="enabled_event_types.task_created">
+                        <label for="taskCreated">Task created</label>
+                        <br/>
+                        <input type="checkbox" name="enabledTypes"
+                               id="taskAssigneeChanged"
+                               ng-model="enabled_event_types.task_assignee_changed">
+                        <label for="taskAssigneeChanged">Task assignee changed</label>
+                        <br/>
+                        <input type="checkbox" name="enabledTypes"
+                               id="taskStatusChanged"
+                               ng-model="enabled_event_types.task_status_changed">
+                        <label for="taskStatusChanged">Task status changed</label>
+                        <br/>
+                        <input type="checkbox" name="enabledTypes"
+                               id="taskDetailsChanged"
+                               ng-model="enabled_event_types.task_details_changed">
+                        <label for="taskDetailsChanged">Task details Changed</label>
+                        <br/>
+                        <input type="checkbox" name="enabledTypes"
+                               id="taskDeleted"
+                               ng-model="enabled_event_types.task_deleted">
+                        <label for="taskDeleted">Task deleted</label>
+                        <br/>
+                        <input type="checkbox" name="enabledTypes"
+                               id="userComment"
+                               ng-model="enabled_event_types.user_comment">
+                        <label for="userComment">User comment</label>
+                    </div>
+                </div>
+
+                <hr/>
+
                 <div class="form-group">
                     <button type="button" class="btn btn-default"
                             ng-click="save()">
diff --git a/src/app/templates/story/comments/story_created.html b/src/app/templates/story/comments/story_created.html
index 3e543a33..a352651f 100644
--- a/src/app/templates/story/comments/story_created.html
+++ b/src/app/templates/story/comments/story_created.html
@@ -1,4 +1,4 @@
-<div class="discussion-comment">
+<div class="discussion-comment" ng-show="enabled_event_types.story_created">
     <p class="discussion-comment-author">
         {{ author.full_name }} has created this story.
          <span class="pull-right">{{event.created_at | date: 'medium'}}</span>
diff --git a/src/app/templates/story/comments/story_details_changed.html b/src/app/templates/story/comments/story_details_changed.html
index 5e484a32..7fdfbfe6 100644
--- a/src/app/templates/story/comments/story_details_changed.html
+++ b/src/app/templates/story/comments/story_details_changed.html
@@ -1,4 +1,4 @@
-<div class="discussion-comment">
+<div class="discussion-comment" ng-show="enabled_event_types.story_details_Changed">
     <p class="discussion-comment-author">
         {{ author.full_name }} has updated this story.
          <span class="pull-right">{{event.created_at | date: 'medium'}}</span>
diff --git a/src/app/templates/story/comments/task_assignee_changed.html b/src/app/templates/story/comments/task_assignee_changed.html
index eb635004..7178aaaa 100644
--- a/src/app/templates/story/comments/task_assignee_changed.html
+++ b/src/app/templates/story/comments/task_assignee_changed.html
@@ -1,4 +1,4 @@
-<div class="discussion-comment">
+<div class="discussion-comment" ng-show="enabled_event_types.task_assignee_changed">
     <p class="discussion-comment-author">
         {{author.full_name}} has updated assignee for task {{ event_info.task_title }}:
         {{ event_info.old_assignee_fullname }} ==> {{ event_info.new_assignee_fullname }}
diff --git a/src/app/templates/story/comments/task_created.html b/src/app/templates/story/comments/task_created.html
index 6c48d91a..a0d0e908 100644
--- a/src/app/templates/story/comments/task_created.html
+++ b/src/app/templates/story/comments/task_created.html
@@ -1,4 +1,4 @@
-<div class="discussion-comment">
+<div class="discussion-comment" ng-show="enabled_event_types.task_created">
     <p class="discussion-comment-author">
         {{ author.full_name }} has created a task {{ event_info.task_title }}
          <span class="pull-right">{{event.created_at | date: 'medium'}}</span>
diff --git a/src/app/templates/story/comments/task_deleted.html b/src/app/templates/story/comments/task_deleted.html
index da255754..2fe0ddf4 100644
--- a/src/app/templates/story/comments/task_deleted.html
+++ b/src/app/templates/story/comments/task_deleted.html
@@ -1,4 +1,4 @@
-<div class="discussion-comment">
+<div class="discussion-comment" ng-show="enabled_event_types.task_deleted">
     <p class="discussion-comment-author">
         {{ author.full_name }} has deleted a task {{ event_info.task_title }}
          <span class="pull-right">{{event.created_at | date: 'medium'}}</span>
diff --git a/src/app/templates/story/comments/task_details_changed.html b/src/app/templates/story/comments/task_details_changed.html
index 22841e9f..1ea7249a 100644
--- a/src/app/templates/story/comments/task_details_changed.html
+++ b/src/app/templates/story/comments/task_details_changed.html
@@ -1,4 +1,4 @@
-<div class="discussion-comment">
+<div class="discussion-comment" ng-show="enabled_event_types.task_details_changed">
     <p class="discussion-comment-author">
         {{ author.full_name }} has updated {{ event_info.task_title }}
          <span class="pull-right">{{event.created_at | date: 'medium'}}</span>
diff --git a/src/app/templates/story/comments/task_status_changed.html b/src/app/templates/story/comments/task_status_changed.html
index d4545cef..fe0ac35d 100644
--- a/src/app/templates/story/comments/task_status_changed.html
+++ b/src/app/templates/story/comments/task_status_changed.html
@@ -1,4 +1,4 @@
-<div class="discussion-comment">
+<div class="discussion-comment" ng-show="enabled_event_types.task_status_changed">
     <p class="discussion-comment-author">
         {{author.full_name}} has updated a task {{ event_info.task_title }} status:
         {{ event_info.old_status }} ==> {{ event_info.new_status }}
diff --git a/src/app/templates/story/comments/user_comment.html b/src/app/templates/story/comments/user_comment.html
index 113b869a..357f278e 100644
--- a/src/app/templates/story/comments/user_comment.html
+++ b/src/app/templates/story/comments/user_comment.html
@@ -1,4 +1,4 @@
-<div class="discussion-comment">
+<div class="discussion-comment" ng-show="enabled_event_types.user_comment">
     <p class="discussion-comment-author">
         {{ author.full_name }}
         <span class="pull-right">{{event.created_at | date: 'medium'}}</span>
diff --git a/src/app/util/constants/timeline_event_type.js b/src/app/util/constants/timeline_event_type.js
new file mode 100644
index 00000000..c0204f28
--- /dev/null
+++ b/src/app/util/constants/timeline_event_type.js
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2014 Mirantis Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at
+ *
+ * 	http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+angular.module('sb.util').constant('TimelineEventTypes',
+    [
+        'story_created',
+        'story_details_changed',
+        'task_created',
+        'task_assignee_changed',
+        'task_status_changed',
+        'task_details_changed',
+        'task_deleted',
+        'user_comment'
+    ]
+);
\ No newline at end of file