thredded 0.6.3 → 0.7.0

data/app/helpers/thredded/application_helper.rb

@@ -3,6 +3,19 @@ module Thredded
   module ApplicationHelper
     include ::Thredded::UrlsHelper
 
+    def thredded_container_data
+      {
+        'thredded-page-id' => content_for(:thredded_page_id),
+        'thredded-root-url' => thredded.root_path
+      }
+    end
+
+    def thredded_container_classes
+      ['thredded--main-container', content_for(:thredded_page_id)].tap do |classes|
+        classes << 'thredded--is-moderator' if moderatable_messageboards_ids
+      end
+    end
+
     # Render the page container with the supplied block as content.
     def thredded_page(&block)
       # enable the host app to easily check whether a thredded view is being rendered:
@@ -17,6 +30,17 @@ module Thredded
       render partial: 'thredded/users/link', locals: { user: user }
     end
 
+    # @param user [Thredded.user_class]
+    # @return [String] wrapped @mention string
+    def user_mention(user)
+      username = user.send(Thredded.user_name_column)
+      if username.include?(' ')
+        %(@"#{username}")
+      else
+        "@#{username}"
+      end
+    end
+
     # @param datetime [DateTime]
     # @param default [String] a string to return if time is nil.
     # @return [String] html_safe datetime presentation
@@ -42,6 +66,18 @@ module Thredded
       ]
     end
 
+    # @param follow_reason ['manual', 'posted', 'mentioned', nil]
+    def topic_follow_reason_text(follow_reason)
+      if follow_reason
+        # rubocop:disable Metrics/LineLength
+        # i18n-tasks-use t('thredded.topics.following.manual') t('thredded.topics.following.posted') t('thredded.topics.following.mentioned')
+        # rubocop:enable Metrics/LineLength
+        t("thredded.topics.following.#{follow_reason}")
+      else
+        t('thredded.topics.not_following')
+      end
+    end
+
     def unread_private_topics_count
       @unread_private_topics_count ||=
         if signed_in?

data/app/models/concerns/thredded/topic_common.rb

@@ -9,7 +9,7 @@ module Thredded
                  class_name:  Thredded.user_class,
                  foreign_key: 'last_user_id'
 
-      scope :order_recently_updated_first, -> { order(updated_at: :desc, id: :desc) }
+      scope :order_recently_posted_first, -> { order(last_post_at: :desc, id: :desc) }
       scope :on_page, -> (page_num) { page(page_num) }
 
       validates :hash_id, presence: true, uniqueness: true
@@ -51,7 +51,7 @@ module Thredded
         reads       = reads_class.arel_table
         joins(topics.join(reads, Arel::Nodes::OuterJoin)
                 .on(topics[:id].eq(reads[:postable_id]).and(reads[:user_id].eq(user.id))).join_sources)
-          .merge(reads_class.where(reads[:id].eq(nil).or(reads[:read_at].lt(topics[:updated_at]))))
+          .merge(reads_class.where(reads[:id].eq(nil).or(reads[:read_at].lt(topics[:last_post_at]))))
       end
 
       private

data/app/models/concerns/thredded/user_topic_read_state_common.rb

@@ -9,7 +9,7 @@ module Thredded
 
     # @return [Boolean]
     def read?
-      postable.updated_at.to_i <= read_at.to_i
+      postable.last_post_at <= read_at
     end
 
     module ClassMethods

data/app/models/thredded/messageboard.rb

@@ -20,6 +20,12 @@ module Thredded
 
     validates :name, uniqueness: true, length: { maximum: 60 }, presence: true
     validates :topics_count, numericality: true
+    validates :position, presence: true, on: :update
+    before_save :ensure_position, on: :create
+
+    def ensure_position
+      self.position ||= (created_at || Time.zone.now).to_i
+    end
 
     has_many :categories, dependent: :destroy
     has_many :user_messageboard_preferences, dependent: :destroy
@@ -31,7 +37,8 @@ module Thredded
     has_many :user_details, through: :posts
     has_many :messageboard_users,
              inverse_of:  :messageboard,
-             foreign_key: :thredded_messageboard_id
+             foreign_key: :thredded_messageboard_id,
+             dependent: :destroy
     has_many :recently_active_user_details,
              -> { merge(Thredded::MessageboardUser.recently_active) },
              class_name: 'Thredded::UserDetail',
@@ -49,11 +56,32 @@ module Thredded
 
     has_many :post_moderation_records, inverse_of: :messageboard, dependent: :delete_all
 
-    default_scope { where(closed: false).order(topics_count: :desc) }
-
+    default_scope { where(closed: false) }
+    # rubocop:disable Style/Lambda
     scope :top_level_messageboards, -> { where(group: nil) }
     scope :by_messageboard_group, ->(group) { where(group: group.id) }
-
+    scope :ordered, ->(order = Thredded.messageboards_order) {
+      case order
+      when :position
+        self
+      when :created_at_asc
+        ordered_by_created_at_asc
+      when :last_post_at_desc
+        ordered_by_last_post_at_desc
+      when :topics_count_desc
+        ordered_by_topics_count_desc
+      end.ordered_by_position.order(id: :asc)
+    }
+    scope :ordered_by_position, ->() { order(position: :asc) }
+    scope :ordered_by_created_at_asc, ->() { order(created_at: :asc) }
+    scope :ordered_by_last_post_at_desc, ->() {
+      joins('LEFT JOIN thredded_topics AS last_topics ON thredded_messageboards.last_topic_id = last_topics.id')
+        .order('COALESCE(last_topics.last_post_at, thredded_messageboards.created_at) DESC')
+    }
+    scope :ordered_by_topics_count_desc, ->() {
+      order(topics_count: :desc)
+    }
+    # rubocop:enable Style/Lambda
     def last_user
       last_topic.try(:last_user)
     end
@@ -67,9 +95,8 @@ module Thredded
 
     def update_last_topic!
       return if destroyed?
-      update_column(
-        :last_topic_id, topics.order_recently_updated_first.moderation_state_visible_to_all.select(:id).first.try(:id)
-      )
+      self.last_topic = topics.order_recently_posted_first.moderation_state_visible_to_all.first
+      save! if last_topic_id_changed?
     end
   end
 end

data/app/models/thredded/messageboard_group.rb

@@ -6,6 +6,13 @@ module Thredded
              foreign_key: :messageboard_group_id,
              dependent: :nullify
 
-    validates :name, presence: true
+    scope :ordered, -> { order(position: :asc, id: :asc) }
+    validates :name, presence: true, uniqueness: true
+    validates :position, presence: true, on: :update
+    before_save :ensure_position, on: :create
+
+    def ensure_position
+      self.position ||= Time.zone.now.to_i
+    end
   end
 end

data/app/models/thredded/null_user.rb

@@ -38,5 +38,9 @@ module Thredded
     def thredded_user_preference
       Thredded::UserPreference.new
     end
+
+    def thredded_display_name
+      to_s
+    end
   end
 end

data/app/models/thredded/post_moderation_record.rb

@@ -39,7 +39,7 @@ module Thredded
         post:                      post,
         post_content:              post.content,
         post_user:                 post.user,
-        post_user_name:            post.user.try(:send, Thredded.user_name_column),
+        post_user_name:            post.user.try(:thredded_display_name),
         messageboard_id:           post.messageboard_id,
       )
     end

data/app/models/thredded/private_post.rb

@@ -47,7 +47,11 @@ module Thredded
                   else
                     self
                   end
-      postable.update_columns(last_user_id: last_post.user_id, updated_at: last_post.updated_at)
+      postable.update_columns(
+        last_user_id: last_post.user_id,
+        last_post_at: last_post.updated_at,
+        updated_at: Time.zone.now
+      )
     end
   end
 end

data/app/models/thredded/stats.rb

@@ -18,7 +18,7 @@ module Thredded
     private
 
     def messageboards
-      @messageboards ||= Messageboard.all
+      @messageboards ||= Messageboard.ordered
     end
   end
 end

data/app/models/thredded/topic.rb

@@ -67,11 +67,13 @@ module Thredded
              class_name: 'Thredded::UserTopicFollow',
              inverse_of: :topic,
              dependent: :destroy
-    has_many :following_users,
+    has_many :followers,
              class_name: Thredded.user_class,
              source: :user,
              through: :user_follows
 
+    delegate :name, to: :messageboard, prefix: true
+
     after_commit :update_messageboard_last_topic, on: :update, if: -> { previous_changes.include?('moderation_state') }
     after_update :update_last_user_and_time_from_last_post!, if: -> { previous_changes.include?('moderation_state') }
 
@@ -126,11 +128,11 @@ module Thredded
       scope = scope.moderation_state_visible_to_all if moderation_state_visible_to_all?
       last_post = scope.select(:user_id, :created_at).first
       if last_post
-        update_columns(last_user_id: last_post.user_id, updated_at: last_post.created_at)
+        update_columns(last_user_id: last_post.user_id, last_post_at: last_post.created_at, updated_at: Time.zone.now)
       else
         # Either a visible topic is left with no visible posts, or an invisible topic is left with no posts at all.
         # This shouldn't happen in stock Thredded.
-        update_columns(last_user_id: nil, updated_at: created_at)
+        update_columns(last_user_id: nil, last_post_at: created_at, updated_at: Time.zone.now)
       end
     end
 

data/app/models/thredded/user_detail.rb

@@ -10,6 +10,8 @@ module Thredded
     has_many :private_topics, class_name: 'Thredded::PrivateTopic', foreign_key: :user_id, primary_key: :user_id
     has_many :posts, class_name: 'Thredded::Post', foreign_key: :user_id, primary_key: :user_id
     has_many :private_posts, class_name: 'Thredded::PrivatePost', foreign_key: :user_id, primary_key: :user_id
+    has_many :messageboard_users, class_name: 'Thredded::MessageboardUser', foreign_key: :thredded_user_detail_id,
+                                  inverse_of: :user_detail, dependent: :destroy
 
     scope :recently_active, -> { where(arel_table[:last_seen_at].gt(Thredded.active_user_threshold.ago)) }
 

data/app/models/thredded/user_extender.rb

@@ -62,8 +62,10 @@ module Thredded
       false
     end
 
-    def following?(topic)
-      UserTopicFollow.find_by(topic_id: topic.id, user: self)
+    def thredded_display_name
+      send(Thredded.user_display_name_method).presence || fail(<<-ERROR)
+        User.#{Thredded.user_display_name_method} must not be empty: please set make sure non nil or configure Thredded.user_display_name_method")
+      ERROR
     end
   end
 end

data/app/models/thredded/user_topic_follow.rb

@@ -13,8 +13,19 @@ module Thredded
     alias_attribute :postable_id, :topic_id
     alias_attribute :postable, :topic
 
+    # Creates a follow or finds the existing one.
+    #
+    # This method is safe to call concurrently from different processes. Lookup and creation happen in a transaction.
+    # If an ActiveRecord::RecordNotUnique error is raised, the find is retried.
+    #
+    # @return [Thredded::UserTopicFollow]
     def self.create_unless_exists(user_id, topic_id, reason = :manual)
-      create_with(reason: reason).find_or_create_by(user_id: user_id, topic_id: topic_id)
+      transaction(requires_new: true) do
+        create_with(reason: reason).find_or_create_by(user_id: user_id, topic_id: topic_id)
+      end
+    rescue ActiveRecord::RecordNotUnique
+      # The record has been created from another connection, retry to find it.
+      retry
     end
   end
 end

data/app/view_models/thredded/base_topic_view.rb

@@ -5,7 +5,7 @@ module Thredded
   class BaseTopicView
     delegate :title,
              :posts_count,
-             :updated_at,
+             :last_post_at,
              :created_at,
              :user,
              :last_user,

data/app/view_models/thredded/messageboard_group_view.rb

@@ -4,6 +4,17 @@ module Thredded
   class MessageboardGroupView
     delegate :name, to: :@group, allow_nil: true
     attr_reader :group, :messageboards
+
+    # @param messageboard_scope [ActiveRecord::Relation]
+    # @return [Array<MessageboardGroupView>]
+    def self.grouped(messageboard_scope)
+      messageboard_scope.preload(last_topic: [:last_user])
+        .eager_load(:group)
+        .order('coalesce(thredded_messageboard_groups.position, 0) asc, thredded_messageboard_groups.id asc').ordered
+        .group_by(&:group)
+        .map { |(group, messageboards)| MessageboardGroupView.new(group, messageboards) }
+    end
+
     # @param group Thredded::MessageboardGroup
     # @param messageboards [Thredded::TopicCommon]
     def initialize(group, messageboards)

data/app/view_models/thredded/topic_view.rb

@@ -2,8 +2,8 @@
 module Thredded
   # A view model for Topic.
   class TopicView < BaseTopicView
-    delegate :categories, :id, :blocked?, :last_moderation_record,
-             :last_post,
+    delegate :categories, :id, :blocked?, :last_moderation_record, :followers,
+             :last_post, :messageboard_id, :messageboard_name,
              to: :@topic
 
     # @param topic [TopicCommon]
@@ -31,6 +31,15 @@ module Thredded
       ].compact
     end
 
+    # @return [Boolean] whether the topic is followed by the current user.
+    def followed?
+      @follow
+    end
+
+    def follow_reason
+      @follow.try(:reason)
+    end
+
     def can_moderate?
       @policy.moderate?
     end
@@ -50,5 +59,9 @@ module Thredded
     def unfollow_path
       Thredded::UrlsHelper.unfollow_messageboard_topic_path(@topic.messageboard, @topic)
     end
+
+    def messageboard_path
+      Thredded::UrlsHelper.messageboard_topics_path(@topic.messageboard)
+    end
   end
 end

data/app/views/thredded/messageboards/_messageboard.html.erb

@@ -14,8 +14,8 @@
     <% if messageboard.last_topic %>
       <p class="thredded--messageboard--byline">
         <%= t 'thredded.messageboard.last_updated_by_html',
-              time_ago: time_ago(messageboard.last_topic.updated_at),
-              user:     messageboard.last_user %>
+              time_ago: time_ago(messageboard.last_topic.last_post_at),
+              user:     messageboard.last_user.thredded_display_name %>
       </p>
     <% end %>
   <% end %>

data/app/views/thredded/moderation/_post.html.erb

@@ -3,7 +3,7 @@
   <%= render 'thredded/posts_common/header_with_user_and_topic',
              post:           post,
              post_user_link: if post.user
-                               link_to(post.user, user_moderation_path(post.user.id))
+                               link_to(post.user.thredded_display_name, user_moderation_path(post.user.id))
                              else
                                content_tag :em, t('thredded.null_user_name')
                              end

data/app/views/thredded/moderation/_post_moderation_record.html.erb

@@ -28,7 +28,7 @@
   <article class="thredded--post">
     <% post_user_link = capture do %>
       <% if record.post_user %>
-        <%= link_to record.post_user, user_moderation_path(record.post_user.id) %>
+        <%= link_to record.post_user.thredded_display_name, user_moderation_path(record.post_user.id) %>
       <% else %>
         <%= safe_join [record.post_user_name, content_tag(:em, t('thredded.null_user_name'))].compact, ', ' %>
       <% end %>

data/app/views/thredded/moderation/user.html.erb

@@ -7,7 +7,7 @@
 <%= render 'nav' %>
 <%= thredded_page do %>
   <h1 class="thredded--moderation--user--title">
-    <%= image_tag Thredded.avatar_url.call(user), class: 'thredded--user--avatar' %><%= user %>
+    <%= image_tag Thredded.avatar_url.call(user), class: 'thredded--user--avatar' %><%= user.thredded_display_name %>
   </h1>
   <ul class="thredded--moderation--user--info">
     <li><%= t 'thredded.users.user_since_html', time_ago: time_ago(user.created_at) %></li>

data/app/views/thredded/moderation/users.html.erb

@@ -20,7 +20,7 @@
       <% @users.each do |user| %>
         <tr>
           <td>
-            <%= link_to user, user_moderation_path(user.id), class: 'thredded--link' %>
+            <%= link_to user.thredded_display_name, user_moderation_path(user.id), class: 'thredded--link' %>
           </td>
           <td>
             <%= render 'user_moderation_state', user: user %>

data/app/views/thredded/private_topic_mailer/message_notification.html.erb

@@ -3,7 +3,7 @@
 <hr />
 
 <p>
-  This email was sent to you because <%= @topic.user %> included you in a
+  This email was sent to you because <%= @topic.user.thredded_display_name %> included you in a
   private topic, "<%= link_to @topic.title, @topic %>".
   <%= link_to 'Go here', @topic %> to view the conversation.
 </p>

data/app/views/thredded/private_topic_mailer/message_notification.text.erb

@@ -2,7 +2,7 @@
 <%               # as this is only sent on first post, doesn't need to define order %>
 ---
 
-This email was sent to you because <%= @topic.user %>
+This email was sent to you because <%= @topic.user.thredded_display_name %>
 included you in the private topic "<%= @topic.title %>".
 Go here to view the conversation:
   <%= url_for @topic %>

data/app/views/thredded/private_topics/_private_topic.html.erb

@@ -8,7 +8,7 @@
   </h1>
 
   <cite class="thredded--topics--updated-by">
-    <%= time_ago private_topic.updated_at %>
+    <%= time_ago private_topic.last_post_at%>
     <%= user_link private_topic.last_user %>
   </cite>
 

data/app/views/thredded/shared/_currently_online.html.erb

@@ -8,7 +8,7 @@
       <% users.each do |user| %>
         <li class="thredded--currently-online--user">
           <img class="thredded--currently-online--avatar" src="<%= Thredded.avatar_url.call(user) %>" alt=""/>
-          <%= user %>
+          <%= user.thredded_display_name %>
         </li>
       <% end %>
     </ul>

data/app/views/thredded/shared/_nav.html.erb

@@ -2,7 +2,7 @@
   <ul class="thredded--user-navigation<%= ' thredded--user-navigation-standalone' if Thredded.standalone_layout? %>">
     <% if signed_in? && Thredded.standalone_layout? %>
       <li class="thredded--user-navigation--profile thredded--user-navigation--item">
-        <%= link_to thredded_current_user, user_path(thredded_current_user) %>
+        <%= link_to thredded_current_user.thredded_display_name, user_path(thredded_current_user) %>
       </li>
     <% end %>