New User Education goes through a server side ComposerMessages check. Composer message for users

eviltrout · eviltrout · commit 7d9a84b496a4 · 2013-09-13T12:23:53.000-04:00
who don't have avatars.
diff --git a/app/assets/javascripts/discourse/controllers/composer_controller.js b/app/assets/javascripts/discourse/controllers/composer_controller.js
@@ -10,7 +10,7 @@ Discourse.ComposerController = Discourse.Controller.extend({
   needs: ['modal', 'topic', 'composerMessages'],
 
   replyAsNewTopicDraft: Em.computed.equal('model.draftKey', Discourse.Composer.REPLY_AS_NEW_TOPIC_KEY),
-
+  checkedMessages: false,
 
   init: function() {
     this._super();
@@ -117,33 +117,18 @@ Discourse.ComposerController = Discourse.Controller.extend({
     });
   },
 
-  _considerNewUserEducation: function() {
-
-    // We don't show education when editing a post.
-    if (this.get('model.editingPost')) return;
-
-    // If creating a topic, use topic_count, otherwise post_count
-    var count = this.get('model.creatingTopic') ? Discourse.User.currentProp('topic_count') : Discourse.User.currentProp('reply_count');
-    if (count >= Discourse.SiteSettings.educate_until_posts) { return; }
-
-    // The user must have typed a reply
-    if (!this.get('typedReply')) return;
-
-    // If visible update the text
-    var educationKey = this.get('model.creatingTopic') ? 'new-topic' : 'new-reply',
-        messageController = this.get('controllers.composerMessages');
-
-    Discourse.ajax("/education/" + educationKey, {dataType: 'html'}).then(function(result) {
-      messageController.popup({
-        templateName: 'composer/education',
-        body: result
-      });
-    });
-
-  }.observes('typedReply', 'model.creatingTopic', 'currentUser.reply_count'),
+  /**
+    Checks to see if a reply has been typed. This is signaled by a keyUp
+    event in a view.
 
+    @method checkReplyLength
+  **/
   checkReplyLength: function() {
-    this.set('typedReply', this.present('model.reply'));
+    if (this.present('model.reply')) {
+      // Notify the composer messages controller that a reply has been typed. Some
+      // messages only appear after typing.
+      this.get('controllers.composerMessages').typedReply()
+    }
   },
 
   /**
@@ -171,11 +156,11 @@ Discourse.ComposerController = Discourse.Controller.extend({
       similarTopics.clear();
       similarTopics.pushObjects(newTopics);
 
-      messageController.popup({
+      messageController.popup(Discourse.ComposerMessage.create({
         templateName: 'composer/similar_topics',
         similarTopics: similarTopics,
         extraClass: 'similar-topics'
-      });
+      }));
     });
 
   },
@@ -203,7 +188,6 @@ Discourse.ComposerController = Discourse.Controller.extend({
 
     var promise = opts.promise || Ember.Deferred.create();
     opts.promise = promise;
-    this.set('typedReply', false);
 
     if (!opts.draftKey) {
       alert("composer was opened without a draft key");
@@ -272,8 +256,10 @@ Discourse.ComposerController = Discourse.Controller.extend({
 
     composer = composer || Discourse.Composer.create();
     composer.open(opts);
+
     this.set('model', composer);
     composer.set('composeState', Discourse.Composer.OPEN);
+    composerMessages.queryFor(this.get('model'));
     promise.resolve();
     return promise;
   },
diff --git a/app/assets/javascripts/discourse/controllers/composer_messages_controller.js b/app/assets/javascripts/discourse/controllers/composer_messages_controller.js
@@ -9,28 +9,92 @@
 Discourse.ComposerMessagesController = Ember.ArrayController.extend({
   needs: ['composer'],
 
+  // Whether we've checked our messages
+  checkedMessages: false,
+
+  /**
+    Initialize the controller
+  **/
   init: function() {
     this._super();
-    this.set('messagesByTemplate', {});
+    this.reset();
   },
 
+  /**
+    Displays a new message
+
+    @method popup
+    @params {Object} msg The message to display
+  **/
   popup: function(msg) {
     var messagesByTemplate = this.get('messagesByTemplate'),
-        existing = messagesByTemplate[msg.templateName];
+        templateName = msg.get('templateName'),
+        existing = messagesByTemplate[templateName];
 
     if (!existing) {
       this.pushObject(msg);
-      messagesByTemplate[msg.templateName] = msg;
+      messagesByTemplate[templateName] = msg;
     }
   },
 
+  /**
+    Closes and hides a message.
+
+    @method closeMessage
+    @params {Object} message The message to dismiss
+  **/
   closeMessage: function(message) {
     this.removeObject(message);
   },
 
+  /**
+    Resets all active messages. For example if composing a new post.
+
+    @method reset
+  **/
   reset: function() {
     this.clear();
     this.set('messagesByTemplate', {});
+    this.set('queuedForTyping', new Em.Set());
+    this.set('checkedMessages', false);
+  },
+
+  /**
+    Called after the user has typed a reply. Some messages only get shown after being
+    typed.
+
+    @method typedReply
+  **/
+  typedReply: function() {
+    var self = this;
+    this.get('queuedForTyping').forEach(function (msg) {
+      self.popup(msg);
+    })
+  },
+
+  /**
+    Figure out if there are any messages that should be displayed above the composer.
+
+    @method queryFor
+    @params {Discourse.Composer} composer The composer model
+  **/
+  queryFor: function(composer) {
+    if (this.get('checkedMessages')) { return; }
+
+    var self = this,
+        queuedForTyping = self.get('queuedForTyping');
+
+    Discourse.ComposerMessage.find(composer).then(function (messages) {
+      self.set('checkedMessages', true);
+      messages.forEach(function (msg) {
+        console.log(msg);
+        if (msg.wait_for_typing) {
+          queuedForTyping.addObject(msg);
+        } else {
+          self.popup(msg);
+        }
+      });
+    });
   }
 
 });
diff --git a/app/assets/javascripts/discourse/models/composer_message.js b/app/assets/javascripts/discourse/models/composer_message.js
@@ -0,0 +1,35 @@
+/**
+  Represents a pop up message displayed over the composer
+
+  @class ComposerMessage
+  @extends Ember.Object
+  @namespace Discourse
+  @module Discourse
+**/
+Discourse.ComposerMessage = Em.Object.extend({});
+
+Discourse.ComposerMessage.reopenClass({
+  /**
+    Look for composer messages given the current composing settings.
+
+    @method find
+    @param {Discourse.Composer} composer The current composer
+    @returns {Discourse.ComposerMessage} the composer message to display (or null)
+  **/
+  find: function(composer) {
+
+    var data = { composerAction: composer.get('action') },
+        topicId = composer.get('topic.id'),
+        postId = composer.get('post.id');
+
+    if (topicId) { data.topic_id = topicId };
+    if (postId)  { data.post_id = postId };
+
+    return Discourse.ajax('/composer-messages', { data: data }).then(function (messages) {
+      return messages.map(function (message) {
+        return Discourse.ComposerMessage.create(message);
+      });
+    });
+  }
+
+})
diff --git a/app/controllers/composer_messages_controller.rb b/app/controllers/composer_messages_controller.rb
@@ -0,0 +1,13 @@
+require_dependency 'composer_messages_finder'
+
+class ComposerMessagesController < ApplicationController
+
+  before_filter :ensure_logged_in
+
+  def index
+    finder = ComposerMessagesFinder.new(current_user, params.slice(:composerAction, :topic_id, :post_id))
+    render_json_dump([finder.find].compact)
+  end
+
+end
+
diff --git a/app/controllers/education_controller.rb b/app/controllers/education_controller.rb
diff --git a/app/controllers/posts_controller.rb b/app/controllers/posts_controller.rb
@@ -177,11 +177,6 @@ def replies
     render_serialized(post.replies, PostSerializer)
   end
 
-  # Returns the "you're creating a post education"
-  def education_text
-
-  end
-
   def bookmark
     post = find_post_from_params
     if current_user
diff --git a/app/helpers/composer_messages_helper.rb b/app/helpers/composer_messages_helper.rb
@@ -0,0 +1,2 @@
+module ComposerMessagesHelper
+end
diff --git a/app/models/user.rb b/app/models/user.rb
@@ -160,6 +160,9 @@ def temporary_key
     key
   end
 
+  def created_topic_count
+    topics.count
+  end
 
   # tricky, we need our bus to be subscribed from the right spot
   def sync_notification_channel_position
@@ -502,6 +505,7 @@ def topic_create_allowed_category_ids
     Category.topic_create_allowed(self.id).select(:id)
   end
 
+
   # Flag all posts from a user as spam
   def flag_linked_posts_as_spam
     admin = Discourse.system_user
diff --git a/app/models/user_history.rb b/app/models/user_history.rb
@@ -46,6 +46,10 @@ def self.with_filters(filters)
     query
   end
 
+  def self.exists_for_user?(user, action_type)
+    self.where(target_user_id: user.id, action: UserHistory.actions[action_type]).exists?
+  end
+
   def new_value_is_json?
     [UserHistory.actions[:change_site_customization], UserHistory.actions[:delete_site_customization]].include?(action)
   end
diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml
@@ -104,6 +104,15 @@ en:
 
       For more guidance, [see our FAQ](/faq). This panel will only appear for your first %{education_posts_text}.
 
+    avatar: |
+      ### How about a new picture for your account?
+
+      You've posted a few topics and replies, but your avatar isn't as unique as you are -- it's the same default avatar all new users have.
+
+      Have you considered **[visiting your user profile](%{profile_path})** and uploading a custom image that represents you?
+
+      It's easier to follow community discussions and find interesting people in conversations when everyone has a unique avatar!
+
 
   activerecord:
     attributes:
diff --git a/config/routes.rb b/config/routes.rb
@@ -105,6 +105,7 @@
   end
 
   get 'session/csrf' => 'session#csrf'
+  get 'composer-messages' => 'composer_messages#index'
 
   resources :users, except: [:show, :update] do
     collection do
@@ -183,7 +184,6 @@
     end
   end
   resources :user_actions
-  resources :education
 
   resources :categories, :except => :show
   get 'category/:id/show' => 'categories#show'
diff --git a/lib/composer_messages_finder.rb b/lib/composer_messages_finder.rb
@@ -0,0 +1,62 @@
+class ComposerMessagesFinder
+
+  def initialize(user, details)
+    @user = user
+    @details = details
+  end
+
+  def find
+    check_education_message ||
+    check_avatar_notification
+  end
+
+  # Determines whether to show the user education text
+  def check_education_message
+    if creating_topic?
+      count = @user.created_topic_count
+      education_key = :education_new_topic
+    else
+      count = @user.topic_reply_count
+      education_key = :education_new_reply
+    end
+
+    if count <= SiteSetting.educate_until_posts
+      education_posts_text = I18n.t('education.until_posts', count: SiteSetting.educate_until_posts)
+      return {templateName: 'composer/education',
+              wait_for_typing: true,
+              body: PrettyText.cook(SiteContent.content_for(education_key, education_posts_text: education_posts_text)) }
+    end
+
+    nil
+  end
+
+  # Should a user be contacted to update their avatar?
+  def check_avatar_notification
+
+    # A user has to be basic at least to be considered for an avatar notification
+    return unless @user.has_trust_level?(:basic)
+
+    # We don't notify users who have avatars or who have been notified already.
+    return if @user.user_stat.has_custom_avatar? || UserHistory.exists_for_user?(@user, :notified_about_avatar)
+
+    # Finally, we don't check users whose avatars haven't been examined
+    return unless UserHistory.exists_for_user?(@user, :checked_for_custom_avatar)
+
+    # If we got this far, log that we've nagged them about the avatar
+    UserHistory.create!(action: UserHistory.actions[:notified_about_avatar], target_user_id: @user.id )
+
+    # Return the message
+    {templateName: 'composer/education', body: PrettyText.cook(I18n.t('education.avatar', profile_path: "/users/#{@user.username_lower}")) }
+  end
+
+  private
+
+    def creating_topic?
+      return @details[:composerAction] == "createTopic"
+    end
+
+    def replying?
+      return @details[:composerAction] == "reply"
+    end
+
+end
diff --git a/spec/components/composer_messages_finder_spec.rb b/spec/components/composer_messages_finder_spec.rb
diff --git a/spec/controllers/composer_messages_controller_spec.rb b/spec/controllers/composer_messages_controller_spec.rb
diff --git a/spec/controllers/education_controller_spec.rb b/spec/controllers/education_controller_spec.rb
diff --git a/spec/models/topic_spec.rb b/spec/models/topic_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+module ComposerMessagesHelper`
	`2`	`+end`