Cleaned up TopicUserSpec, introduces clearing of pinned topics

Author: eviltrout

Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
 gem 'active_model_serializers', git: 'git://github.com/rails-api/active_model_serializers.git'
 gem 'ember-rails', git: 'git://github.com/emberjs/ember-rails.git' # so we get the pre version

Gemfile.lock

@@ -71,7 +71,7 @@ PATH
       rails (~> 3.1)
 
 GEM
-  remote: https://rubygems.org/
+  remote: http://rubygems.org/
   specs:
     actionmailer (3.2.12)
       actionpack (= 3.2.12)

app/assets/javascripts/discourse/controllers/topic_controller.js

@@ -255,6 +255,15 @@ Discourse.TopicController = Discourse.ObjectController.extend({
     this.get('content').toggleStar();
   },
 
+  /**
+    Clears the pin from a topic for the currentUser
+
+    @method clearPin
+  **/
+  clearPin: function() {
+    this.get('content').clearPin();
+  },
+
   // Receive notifications for this topic
   subscribe: function() {
     var bus,

app/assets/javascripts/discourse/models/topic.js

@@ -329,6 +329,27 @@ Discourse.Topic = Discourse.Model.extend({
     });
   },
 
+  /**
+    Clears the pin from a topic for the currentUser
+
+    @method clearPin
+  **/
+  clearPin: function() {
+
+    var topic = this;
+
+    // Clear the pin optimistically from the object
+    topic.set('pinned', false);
+
+    $.ajax("/t/" + this.get('id') + "/clear-pin", {
+      type: 'PUT',
+      error: function() {
+        // On error, put the pin back
+        topic.set('pinned', true);
+      }
+    });
+  },
+
   // Is the reply to a post directly below it?
   isReplyDirectlyBelow: function(post) {
     var postBelow, posts;

app/assets/javascripts/discourse/views/topic_footer_buttons_view.js

@@ -68,6 +68,30 @@ Discourse.TopicFooterButtonsView = Ember.ContainerView.extend({
             buffer.push("<i class='icon icon-share'></i>");
           }
         }));
+
+        // Add our clear pin button
+        this.addObject(Discourse.ButtonView.createWithMixins({
+          textKey: 'topic.clear_pin.title',
+          helpKey: 'topic.clear_pin.help',
+          classNameBindings: ['unpinned'],
+
+          // Hide the button if it becomes unpinned
+          unpinned: function() {
+            // When not logged in don't show the button
+            if (!Discourse.get('currentUser')) return 'hidden'
+
+            return this.get('controller.pinned') ? null : 'hidden';
+          }.property('controller.pinned'),
+
+          click: function(buffer) {
+            this.get('controller').clearPin();
+          },
+
+          renderIcon: function(buffer) {
+            buffer.push("<i class='icon icon-pushpin'></i>");
+          }
+        }));
+
       }
 
       this.addObject(Discourse.ButtonView.createWithMixins({

app/controllers/topics_controller.rb

@@ -14,7 +14,9 @@ class TopicsController < ApplicationController
                                           :mute,
                                           :unmute,
                                           :set_notifications,
-                                          :move_posts]
+                                          :move_posts,
+                                          :clear_pin]
+
   before_filter :consider_user_for_promotion, only: :show
 
   skip_before_filter :check_xhr, only: [:avatar, :show, :feed]
@@ -127,16 +129,21 @@ def move_posts
     end
   end
 
-  def timings
+  def clear_pin
+    topic = Topic.where(id: params[:topic_id].to_i).first
+    guardian.ensure_can_see!(topic)
+    topic.clear_pin_for(current_user)
+    render nothing: true
+  end
 
+  def timings
     PostTiming.process_timings(
-        current_user,
-        params[:topic_id].to_i,
-        params[:highest_seen].to_i,
-        params[:topic_time].to_i,
-        (params[:timings] || []).map{|post_number, t| [post_number.to_i, t.to_i]}
+      current_user,
+      params[:topic_id].to_i,
+      params[:highest_seen].to_i,
+      params[:topic_time].to_i,
+      (params[:timings] || []).map{|post_number, t| [post_number.to_i, t.to_i]}
     )
-
     render nothing: true
   end
 

app/models/post.rb

@@ -54,7 +54,7 @@ module HiddenReason
   after_commit :store_unique_post_key, on: :create
 
   after_create do
-    TopicUser.auto_track(user_id, topic_id, TopicUser::NotificationReasons::CREATED_POST)
+    TopicUser.auto_track(user_id, topic_id, TopicUser.notification_reasons[:created_post])
   end
 
   scope :by_newest, order('created_at desc, id desc')

app/models/post_alert_observer.rb

@@ -80,7 +80,7 @@ def create_notification(user, type, post, opts={})
       return unless Guardian.new(user).can_see?(post)
 
       # skip if muted on the topic
-      return if TopicUser.get(post.topic, user).try(:notification_level) == TopicUser::NotificationLevel::MUTED
+      return if TopicUser.get(post.topic, user).try(:notification_level) == TopicUser.notification_levels[:muted]
 
       # Don't notify the same user about the same notification on the same post
       return if user.notifications.exists?(notification_type: type, topic_id: post.topic_id, post_number: post.post_number)
@@ -132,7 +132,7 @@ def notify_post_users(post)
         exclude_user_ids << extract_mentioned_users(post).map(&:id)
         exclude_user_ids << extract_quoted_users(post).map(&:id)
         exclude_user_ids.flatten!
-        TopicUser.where(topic_id: post.topic_id, notification_level: TopicUser::NotificationLevel::WATCHING).includes(:user).each do |tu|
+        TopicUser.where(topic_id: post.topic_id, notification_level: TopicUser.notification_levels[:watching]).includes(:user).each do |tu|
           create_notification(tu.user, Notification.types[:posted], post) unless exclude_user_ids.include?(tu.user_id)
         end
       end

app/models/topic.rb

@@ -83,11 +83,9 @@ def initialize(user)
 
   after_create do
     changed_to_category(category)
-    TopicUser.change(
-                     user_id, id,
-                     notification_level: TopicUser::NotificationLevel::WATCHING,
-                     notifications_reason_id: TopicUser::NotificationReasons::CREATED_TOPIC
-                    )
+    TopicUser.change(user_id, id,
+                     notification_level: TopicUser.notification_levels[:watching],
+                     notifications_reason_id: TopicUser.notification_reasons[:created_topic])
     if archetype == Archetype.private_message
       DraftSequence.next!(user, Draft::NEW_PRIVATE_MESSAGE)
     else
@@ -206,8 +204,17 @@ def links_grouped
   end
 
   def update_status(property, status, user)
+
     Topic.transaction do
-      update_column(property, status)
+
+      # Special case: if it's pinned, update that
+      if property.to_sym == :pinned
+        update_pinned(status)
+      else
+        # otherwise update the column
+        update_column(property, status)
+      end
+
       key = "topic_statuses.#{property}_"
       key << (status ? 'enabled' : 'disabled')
 
@@ -506,7 +513,7 @@ def toggle_star(user, starred)
 
   # Enable/disable the mute on the topic
   def toggle_mute(user, muted)
-    TopicUser.change(user, self.id, notification_level: muted?(user) ? TopicUser::NotificationLevel::REGULAR : TopicUser::NotificationLevel::MUTED )
+    TopicUser.change(user, self.id, notification_level: muted?(user) ? TopicUser.notification_levels[:regular] : TopicUser.notification_levels[:muted] )
   end
 
   def slug
@@ -526,7 +533,17 @@ def relative_url(post_number=nil)
   def muted?(user)
     return false unless user && user.id
     tu = topic_users.where(user_id: user.id).first
-    tu && tu.notification_level == TopicUser::NotificationLevel::MUTED
+    tu && tu.notification_level == TopicUser.notification_levels[:muted]
+  end
+
+  def clear_pin_for(user)
+    return unless user.present?
+
+    TopicUser.change(user.id, id, cleared_pinned_at: Time.now)
+  end
+
+  def update_pinned(status)
+    update_column(:pinned_at, status ? Time.now : nil)
   end
 
   def draft_key
@@ -535,18 +552,18 @@ def draft_key
 
   # notification stuff
   def notify_watch!(user)
-    TopicUser.change(user, id, notification_level: TopicUser::NotificationLevel::WATCHING)
+    TopicUser.change(user, id, notification_level: TopicUser.notification_levels[:watching])
   end
 
   def notify_tracking!(user)
-    TopicUser.change(user, id, notification_level: TopicUser::NotificationLevel::TRACKING)
+    TopicUser.change(user, id, notification_level: TopicUser.notification_levels[:tracking])
   end
 
   def notify_regular!(user)
-    TopicUser.change(user, id, notification_level: TopicUser::NotificationLevel::REGULAR)
+    TopicUser.change(user, id, notification_level: TopicUser.notification_levels[:regular])
   end
 
   def notify_muted!(user)
-    TopicUser.change(user, id, notification_level: TopicUser::NotificationLevel::MUTED)
+    TopicUser.change(user, id, notification_level: TopicUser.notification_levels[:muted])
   end
 end