thredded 0.4.0 → 0.5.0

data/app/models/thredded/private_topic.rb

@@ -14,6 +14,10 @@ module Thredded
     belongs_to :user,
                class_name: Thredded.user_class,
                inverse_of: :thredded_private_topics
+    belongs_to :user_detail,
+               primary_key:   :user_id,
+               foreign_key:   :user_id,
+               inverse_of:    :private_topics
 
     has_many :posts,
              class_name:  'Thredded::PrivatePost',
@@ -54,6 +58,10 @@ module Thredded
       false
     end
 
+    def user_detail
+      super || build_user_detail
+    end
+
     def should_generate_new_friendly_id?
       title_changed?
     end

data/app/models/thredded/topic.rb

@@ -3,6 +3,7 @@ require_dependency 'thredded/topics_search'
 module Thredded
   class Topic < ActiveRecord::Base
     include TopicCommon
+    include ContentModerationState
 
     scope :for_messageboard, -> messageboard { where(messageboard_id: messageboard.id) }
 
@@ -53,6 +54,14 @@ module Thredded
              foreign_key: :postable_id,
              inverse_of: :postable,
              dependent: :destroy
+    has_many :user_follows,
+             class_name: 'Thredded::UserTopicFollow',
+             inverse_of: :topic,
+             dependent: :destroy
+    has_many :following_users,
+             class_name: Thredded.user_class,
+             source: :user,
+             through: :user_follows
 
     def self.find_by_slug!(slug)
       friendly.find(slug)
@@ -60,10 +69,40 @@ module Thredded
       raise Thredded::Errors::TopicNotFound
     end
 
+    class << self
+      private
+
+      # @param user [Thredded.user_class]
+      # @return [ByPostableLookup]
+      def follows_by_topic_hash(user)
+        Thredded::TopicCommon::CachingHash.from_relation(
+          Thredded::UserTopicFollow.where(user_id: user.id, topic_id: current_scope.map(&:id))
+        )
+      end
+
+      public
+
+      # @param user [Thredded.user_class]
+      # @return [Array<[TopicCommon, UserTopicReadStateCommon, UserTopicFollow]>]
+      def with_read_and_follow_states(user)
+        null_read_state = Thredded::NullUserTopicReadState.new
+        return current_scope.zip([null_read_state, nil]) if user.thredded_anonymous?
+        read_states_by_topic = read_states_by_postable_hash(user)
+        follows_by_topic = follows_by_topic_hash(user)
+        current_scope.map do |topic|
+          [topic, read_states_by_topic[topic] || null_read_state, follows_by_topic[topic]]
+        end
+      end
+    end
+
     def public?
       true
     end
 
+    def user_detail
+      super || build_user_detail
+    end
+
     def should_generate_new_friendly_id?
       title_changed?
     end

data/app/models/thredded/user_detail.rb

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 module Thredded
   class UserDetail < ActiveRecord::Base
+    include ModerationState
+
     belongs_to :user, class_name: Thredded.user_class, inverse_of: :thredded_user_detail
     validates :user_id, presence: true
 
     has_many :topics, class_name: 'Thredded::Topic', foreign_key: :user_id, primary_key: :user_id
+    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
 
     scope :recently_active, -> { where(arel_table[:last_seen_at].gt(Thredded.active_user_threshold.ago)) }
+
+    before_save :set_moderation_state_changed_at
+
+    private
+
+    def set_moderation_state_changed_at
+      self.moderation_state_changed_at = Time.current if moderation_state_changed?
+    end
   end
 end

data/app/models/thredded/user_extender.rb

@@ -27,6 +27,7 @@ module Thredded
         opt.has_many :thredded_private_users, class_name: 'Thredded::PrivateUser'
         opt.has_many :thredded_topic_read_states, class_name: 'Thredded::UserTopicReadState'
         opt.has_many :thredded_private_topic_read_states, class_name: 'Thredded::UserPrivateTopicReadState'
+        opt.has_many :thredded_topic_follows, class_name: 'Thredded::UserTopicFollow'
         opt.has_one :thredded_user_detail, class_name: 'Thredded::UserDetail'
         opt.has_one :thredded_user_preference, class_name: 'Thredded::UserPreference'
       end
@@ -35,14 +36,27 @@ module Thredded
                through:    :thredded_private_users,
                class_name: 'Thredded::PrivateTopic',
                source:     :private_topic
+
+      with_options dependent: :nullify, class_name: 'Thredded::PostModerationRecord' do |opt|
+        opt.has_many :thredded_post_moderation_records, foreign_key: 'post_user_id', inverse_of: :post_user
+        opt.has_many :thredded_post_moderated_records, foreign_key: 'moderator_id', inverse_of: :moderator
+      end
     end
 
     def thredded_user_preference
       super || build_thredded_user_preference
     end
 
+    def thredded_user_detail
+      super || build_thredded_user_detail
+    end
+
     def thredded_anonymous?
       false
     end
+
+    def following?(topic)
+      UserTopicFollow.find_by(topic_id: topic.id, user: self)
+    end
   end
 end

data/app/models/thredded/user_topic_follow.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Thredded
+  class UserTopicFollow < ActiveRecord::Base
+    enum reason: [:manual, :posted, :mentioned]
+
+    belongs_to :user, inverse_of: :thredded_topic_follows
+    belongs_to :topic, inverse_of: :user_follows
+
+    validates :user_id, presence: true
+    validates :topic_id, presence: true
+
+    # shim to behave like postable-related (though actually only ever related to topic)
+    alias_attribute :postable_id, :topic_id
+    alias_attribute :postable, :topic
+
+    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)
+    end
+  end
+end

data/app/policies/thredded/messageboard_policy.rb

@@ -1,6 +1,21 @@
 # frozen_string_literal: true
 module Thredded
   class MessageboardPolicy
+    # The scope of readable messageboards
+    class Scope
+      # @param user [Thredded.user_class]
+      # @param scope [ActiveRecord::Relation<Thredded::Messageboard>]
+      def initialize(user, scope)
+        @user = user
+        @scope = scope
+      end
+
+      # @return [ActiveRecord::Relation<Thredded::Messageboards>]
+      def resolve
+        @scope.merge(@user.thredded_can_read_messageboards)
+      end
+    end
+
     # @param user [Thredded.user_class]
     # @param messageboard [Thredded::Messageboard]
     def initialize(user, messageboard)

data/app/policies/thredded/post_policy.rb

@@ -2,6 +2,22 @@
 require_dependency 'thredded/topic_policy'
 module Thredded
   class PostPolicy
+    # The scope of readable posts.
+    # MessageboardPolicy must be applied separately.
+    class Scope
+      # @param user [Thredded.user_class]
+      # @param scope [ActiveRecord::Relation<Thredded::Post>]
+      def initialize(user, scope)
+        @user = user
+        @scope = scope
+      end
+
+      # @return [ActiveRecord::Relation<Thredded::Post>]
+      def resolve
+        @scope.moderation_state_visible_to_user(@user)
+      end
+    end
+
     # @param user [Thredded.user_class]
     # @param post [Thredded::Post]
     def initialize(user, post)
@@ -14,7 +30,7 @@ module Thredded
     end
 
     def read?
-      TopicPolicy.new(@user, @post.postable).read?
+      TopicPolicy.new(@user, @post.postable).read? && @post.moderation_state_visible_to_user?(@user)
     end
 
     def update?

data/app/policies/thredded/private_post_policy.rb

@@ -10,7 +10,7 @@ module Thredded
     end
 
     def create?
-      @user.thredded_admin? || @post.postable.users.include?(@user)
+      @user.thredded_admin? || @post.postable.users.include?(@user) && !@user.thredded_user_detail.blocked?
     end
 
     def read?

data/app/policies/thredded/private_topic_policy.rb

@@ -9,7 +9,7 @@ module Thredded
     end
 
     def create?
-      !@user.thredded_anonymous?
+      !@user.thredded_anonymous? && !@user.thredded_user_detail.blocked?
     end
 
     def read?

data/app/policies/thredded/topic_policy.rb

@@ -1,6 +1,23 @@
 # frozen_string_literal: true
+require_dependency 'thredded/messageboard_policy'
 module Thredded
   class TopicPolicy
+    # The scope of readable topics.
+    # MessageboardPolicy must be applied separately.
+    class Scope
+      # @param user [Thredded.user_class]
+      # @param scope [ActiveRecord::Relation<Thredded::Topic>]
+      def initialize(user, scope)
+        @user = user
+        @scope = scope
+      end
+
+      # @return [ActiveRecord::Relation<Thredded::Topic>]
+      def resolve
+        @scope.moderation_state_visible_to_user(@user)
+      end
+    end
+
     # @param user [Thredded.user_class]
     # @param topic [Thredded::Topic]
     def initialize(user, topic)
@@ -14,7 +31,7 @@ module Thredded
     end
 
     def read?
-      @messageboard_user_permission.read?
+      @messageboard_user_permission.read? && @topic.moderation_state_visible_to_user?(@user)
     end
 
     def update?

data/app/view_models/thredded/base_topic_view.rb

@@ -39,18 +39,5 @@ module Thredded
     def path
       Thredded::UrlsHelper.topic_path(@topic, page: @read_state.page)
     end
-
-    def self.inherited(subclass)
-      subclass.extend ClassMethods
-    end
-
-    module ClassMethods
-      def from_user(topic, user)
-        read_state = if user && !user.thredded_anonymous?
-                       topic.association(:user_read_states).klass.find_by(user_id: user.id, postable_id: topic.id)
-                     end
-        new(topic, read_state, Pundit.policy!(user, topic))
-      end
-    end
   end
 end

data/app/view_models/thredded/post_view.rb

@@ -8,6 +8,9 @@ module Thredded
              :created_at,
              :user,
              :to_model,
+             :pending_moderation?,
+             :approved?,
+             :blocked?,
              to: :@post
 
     # @param post [Thredded::PostCommon]
@@ -38,7 +41,11 @@ module Thredded
         I18n.locale,
         @post,
         @post.user,
-        [can_update?, can_destroy?].map { |p| p ? '+' : '-' } * ''
+        [
+          !@post.private_topic_post? && @post.pending_moderation? && !Thredded.content_visible_while_pending_moderation,
+          can_update?,
+          can_destroy?
+        ].map { |p| p ? '+' : '-' } * ''
       ]
     end
   end

data/app/view_models/thredded/posts_page_view.rb

@@ -6,22 +6,20 @@ module Thredded
   # A view model for a page of PostViews.
   class PostsPageView
     delegate :to_ary,
-             to: :@topic_views
+             to: :@post_views
     delegate :total_pages,
              :current_page,
              :limit_value,
-             to: :@topics_page_scope
+             to: :@paginated_scope
 
     # @return [Thredded::BaseTopicView]
     attr_reader :topic
 
     # @param user [Thredded.user_class] the user who is viewing the posts page
-    # @param topic [Thredded::TopicCommon]
-    # @param posts_page_scope [ActiveRecord::Relation<Thredded::PostCommon>]
-    def initialize(user, topic, posts_page_scope)
-      @topics_page_scope = posts_page_scope
-      @topic_views = posts_page_scope.map { |post| PostView.new(post, Pundit.policy!(user, post)) }
-      @topic = "#{posts_page_scope.reflect_on_association(:postable).klass}View".constantize.from_user(topic, user)
+    # @param paginated_scope [ActiveRecord::Relation<Thredded::PostCommon>]
+    def initialize(user, paginated_scope)
+      @paginated_scope = paginated_scope
+      @post_views      = paginated_scope.map { |post| PostView.new(post, Pundit.policy!(user, post)) }
     end
   end
 end

data/app/view_models/thredded/private_topic_view.rb

@@ -5,5 +5,13 @@ module Thredded
     def edit_path
       Thredded::UrlsHelper.edit_private_topic_path(@topic)
     end
+
+    def self.from_user(topic, user)
+      read_state = if user && !user.thredded_anonymous?
+                     UserPrivateTopicReadState
+                       .find_by(user_id: user.id, postable_id: topic.id)
+                   end
+      new(topic, read_state, Pundit.policy!(user, topic))
+    end
   end
 end

data/app/view_models/thredded/private_topics_page_view.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require_dependency 'thredded/private_topic_view'
+module Thredded
+  # A view model for a page of BaseTopicViews.
+  class PrivateTopicsPageView
+    delegate :to_ary,
+             :blank?,
+             :empty?,
+             to: :@topic_views
+    delegate :total_pages,
+             :current_page,
+             :limit_value,
+             to: :@topics_page_scope
+
+    # @param user [Thredded.user_class] the user who is viewing the posts page
+    # @param topics_page_scope [ActiveRecord::Relation<Thredded::Topic>]
+    def initialize(user, topics_page_scope)
+      @topics_page_scope = topics_page_scope
+      @topic_views = @topics_page_scope.with_read_states(user).map do |(topic, read_state)|
+        PrivateTopicView.new(topic, read_state, Pundit.policy!(user, topic))
+      end
+    end
+  end
+end

data/app/view_models/thredded/topic_posts_page_view.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require_dependency 'thredded/posts_page_view'
+module Thredded
+  # A view model for a page of PostViews of a Topic.
+  class TopicPostsPageView < PostsPageView
+    # @return [Thredded::BaseTopicView]
+    attr_reader :topic
+
+    # @param user [Thredded.user_class] the user who is viewing the posts page
+    # @param topic [Thredded::TopicCommon]
+    # @param paginated_scope [ActiveRecord::Relation<Thredded::PostCommon>]
+    def initialize(user, topic, paginated_scope)
+      super(user, paginated_scope)
+      @topic = "#{paginated_scope.reflect_on_association(:postable).klass}View".constantize.from_user(topic, user)
+    end
+  end
+end

data/app/view_models/thredded/topic_view.rb

@@ -2,13 +2,31 @@
 module Thredded
   # A view model for Topic.
   class TopicView < BaseTopicView
-    delegate :categories,
+    delegate :categories, :id,
              to: :@topic
 
+    # @param topic [TopicCommon]
+    # @param read_state [UserTopicReadStateCommon, nil]
+    # @param policy [#destroy?]
+    def initialize(topic, read_state, follow, policy)
+      super(topic, read_state, policy)
+      @follow = follow
+    end
+
+    def self.from_user(topic, user)
+      read_state = follow = nil
+      if user && !user.thredded_anonymous?
+        read_state = UserTopicReadState.find_by(user_id: user.id, postable_id: topic.id)
+        follow = UserTopicFollow.find_by(user_id: user.id, topic_id: topic.id)
+      end
+      new(topic, read_state, follow, Pundit.policy!(user, topic))
+    end
+
     def states
       super + [
         (:locked if @topic.locked?),
         (:sticky if @topic.sticky?),
+        (@follow ? :following : :notfollowing)
       ].compact
     end
 
@@ -19,5 +37,13 @@ module Thredded
     def destroy_path
       Thredded::UrlsHelper.messageboard_topic_path(@topic.messageboard, @topic)
     end
+
+    def follow_path
+      Thredded::UrlsHelper.follow_messageboard_topic_path(@topic.messageboard, @topic)
+    end
+
+    def unfollow_path
+      Thredded::UrlsHelper.unfollow_messageboard_topic_path(@topic.messageboard, @topic)
+    end
   end
 end