threddedDANIEL 0.14.5

data/app/helpers/thredded/application_helper.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Thredded
+  module ApplicationHelper
+    include ::Thredded::UrlsHelper
+    include ::Thredded::NavHelper
+    include ::Thredded::RenderHelper
+
+    # @return [AllViewHooks] View hooks configuration.
+    def view_hooks
+      @view_hooks ||= Thredded.view_hooks
+    end
+
+    def thredded_container_data
+      {
+        'thredded-locale' => I18n.locale,
+        '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' unless moderatable_messageboards_ids.empty?
+      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:
+      content_for :thredded, true
+      content_for :thredded_page_content, &block
+      render partial: 'thredded/shared/page'
+    end
+
+    # @param user [Thredded.user_class, Thredded::NullUser]
+    # @return [String] html_safe link to the user
+    def user_link(user)
+      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
+    def time_ago(datetime, default: '-', html_options: {})
+      return content_tag :time, default if datetime.nil?
+      html_options = html_options.dup
+      is_current_year = datetime.year == Time.current.year
+      if datetime > 4.days.ago
+        content = t 'thredded.time_ago', time: time_ago_in_words(datetime)
+        html_options['data-time-ago'] = true unless html_options.key?('data-time-ago')
+      else
+        content = I18n.l(datetime.to_date,
+                         format: (is_current_year ? :short : :long))
+      end
+      html_options[:title] = I18n.l(datetime) unless html_options.key?(:title)
+      time_tag datetime, content, html_options
+    end
+
+    # @param posts [Thredded::PostsPageView, Array<Thredded::PostView>]
+    # @param partial [String]
+    # @param content_partial [String]
+    def render_posts(posts, partial: 'thredded/posts/post', content_partial: 'thredded/posts/content', locals: {})
+      posts_with_contents = render_collection_to_strings_with_cache(
+        partial: content_partial, collection: posts, as: :post, expires_in: 1.week
+      )
+      render partial: partial, collection: posts_with_contents, as: :post_and_content, locals: locals
+    end
+
+    def paginate(collection, args = {})
+      super(collection, args.reverse_merge(views_prefix: 'thredded'))
+    end
+
+    # @param topic [BaseTopicView]
+    # @return [Array<String>]
+    def topic_css_classes(topic)
+      [
+        *topic.states.map { |s| "thredded--topic-#{s}" },
+        *(topic.categories.map { |c| "thredded--topic-category-#{c.name}" } if topic.respond_to?(:categories)),
+        *('thredded--private-topic' if topic.is_a?(Thredded::PrivateTopicView))
+      ]
+    end
+
+    # @param follow_reason ['manual', 'posted', 'mentioned', 'auto', 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') t('thredded.topics.following.auto')
+        # 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 thredded_signed_in?
+          Thredded::PrivateTopic
+            .for_user(thredded_current_user)
+            .unread(thredded_current_user)
+            .count
+        else
+          0
+        end
+    end
+
+    def moderatable_messageboards_ids
+      @moderatable_messageboards_ids ||=
+        thredded_current_user.thredded_can_moderate_messageboards.pluck(:id)
+    end
+
+    def posts_pending_moderation_count
+      @posts_pending_moderation_count ||=
+        Thredded::Post.where(messageboard_id: moderatable_messageboards_ids).pending_moderation.count
+    end
+  end
+end

data/app/helpers/thredded/nav_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'set'
+module Thredded
+  module NavHelper
+    USER_NAV_MODERATION_PAGES = Set.new(
+      %w[
+        thredded--pending-moderation
+        thredded--moderation-activity
+        thredded--moderation-history
+        thredded--moderation-users
+        thredded--moderation-user
+      ]
+    )
+
+    USER_NAV_PREFERENCES_PAGES = Set.new(
+      %w[
+        thredded--preferences
+      ]
+    )
+
+    USER_NAV_PRIVATE_TOPICS_PAGES = Set.new(
+      %w[
+        thredded--new-private-topic
+        thredded--private-topics-index
+        thredded--private-topic-show
+      ]
+    )
+
+    def current_page_preferences?
+      USER_NAV_PREFERENCES_PAGES.include?(content_for(:thredded_page_id))
+    end
+
+    def current_page_moderation?
+      USER_NAV_MODERATION_PAGES.include?(content_for(:thredded_page_id))
+    end
+
+    def current_page_private_topics?
+      USER_NAV_PRIVATE_TOPICS_PAGES.include?(content_for(:thredded_page_id))
+    end
+  end
+end

data/app/helpers/thredded/render_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Thredded
+  module RenderHelper
+    # @param collection [Array<T>]
+    # @param partial [String]
+    # @param expires_in [ActiveSupport::Duration]
+    # @return Array<[T, String]>
+    def render_collection_to_strings_with_cache(collection:, partial:, expires_in:, **opts)
+      Thredded::CollectionToStringsWithCacheRenderer.new(lookup_context).render_collection_to_strings_with_cache(
+        self, collection: collection, partial: partial, expires_in: expires_in, **opts
+      )
+    end
+  end
+end

data/app/helpers/thredded/urls_helper.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Thredded
+  module UrlsHelper
+    class << self
+      include Thredded::Engine.routes.url_helpers
+      include Thredded::UrlsHelper
+    end
+
+    # @param user [Thredded.user_class, Thredded::NullUser]
+    # @return [String] path to the user as specified by {Thredded.user_path}
+    def user_path(user)
+      Thredded.user_path(self, user)
+    end
+
+    # @param topic [Topic, PrivateTopic, UserTopicDecorator, UserPrivateTopicDecorator]
+    # @return [String]
+    def topic_url(topic, params = {})
+      if params[:page] == 1
+        params = params.dup
+        params.delete(:page)
+      end
+      if topic.private?
+        private_topic_url(
+          topic.slug,
+          params
+        )
+      else
+        messageboard_topic_url(
+          topic.messageboard.slug,
+          topic.slug,
+          params
+        )
+      end
+    end
+
+    # @param topic [Topic, PrivateTopic, UserTopicDecorator, UserPrivateTopicDecorator]
+    # @return [String] path to the latest unread page of the given topic.
+    def topic_path(topic, params = {})
+      topic_url(topic, params.merge(only_path: true))
+    end
+
+    # @param post [Post, PrivatePost]
+    # @param user [Thredded.user_class] the current user
+    # @return [String] URL of the topic page with the post anchor.
+    def post_url(post, user:, **params)
+      params = params.dup
+      params[:anchor] ||= ActionView::RecordIdentifier.dom_id(post)
+      params[:page] ||= post.private_topic_post? ? post.page : post.page(user: user)
+      topic_url(post.postable, params)
+    end
+
+    # @param post [Post, PrivatePost]
+    # @param user [Thredded.user_class] the current user
+    # @return [String] path to the topic page with the post anchor.
+    def post_path(post, user:, **params)
+      post_url(post, params.merge(user: user, only_path: true))
+    end
+
+    # @param post [Post, PrivatePost]
+    # @return [String] path to the Edit Post page.
+    def edit_post_path(post)
+      if post.private_topic_post?
+        edit_private_topic_private_post_path(post.postable, post)
+      else
+        edit_messageboard_topic_post_path(post.messageboard, post.postable, post)
+      end
+    end
+
+    # @param post [Post, PrivatePost]
+    # @return [String] path to the DELETE endpoint.
+    def delete_post_path(post)
+      if post.private_topic_post?
+        private_topic_private_post_path(post.postable, post)
+      else
+        messageboard_topic_post_path(post.messageboard, post.postable, post)
+      end
+    end
+
+    # @param messageboard [Thredded::Messageboard, nil]
+    # @param params [Hash] additional params
+    # @return [String] the URL to the global or messageboard edit preferences page.
+    def edit_preferences_url(messageboard = nil, params = {})
+      if messageboard.try(:persisted?)
+        edit_messageboard_preferences_url(messageboard, params)
+      else
+        edit_global_preferences_url(params)
+      end
+    end
+
+    # @param messageboard [Thredded::Messageboard, nil]
+    # @param params [Hash] additional params
+    # @return [String] the path to the global or messageboard edit preferences page.
+    def edit_preferences_path(messageboard = nil, params = {})
+      edit_preferences_url(messageboard, params.merge(only_path: true))
+    end
+
+    # @param messageboard [Thredded::Messageboard, nil]
+    # @return [String] the path to the global or messageboard search.
+    def search_path(messageboard = nil)
+      if messageboard.try(:persisted?)
+        messageboard_search_path(messageboard)
+      else
+        messageboards_search_path
+      end
+    end
+
+    def quote_post_path(post)
+      if post.private_topic_post?
+        quote_private_topic_private_post_path(post.postable, post)
+      else
+        quote_messageboard_topic_post_path(post.messageboard, post.postable, post)
+      end
+    end
+
+    def mark_unread_path(post, _params = {})
+      if post.private_topic_post?
+        mark_as_unread_private_topic_private_post_path(post.postable, post)
+      else
+        mark_as_unread_messageboard_topic_post_path(post.messageboard, post.postable, post)
+      end
+    end
+
+    # @param post [Post, PrivatePost]
+    # @return [String] post permalink path
+    def permalink_path(post)
+      if post.private_topic_post?
+        private_post_permalink_path(post)
+      else
+        post_permalink_path(post)
+      end
+    end
+  end
+end

data/app/jobs/thredded/activity_updater_job.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Thredded
+  class ActivityUpdaterJob < ::ActiveJob::Base
+    queue_as :default
+
+    def perform(user_id, messageboard_id)
+      now = Time.current
+
+      user_detail = Thredded::UserDetail.find_or_initialize_by(user_id: user_id)
+      user_detail.update!(last_seen_at: now)
+
+      Thredded::MessageboardUser
+        .find_or_initialize_by(
+          thredded_messageboard_id: messageboard_id,
+          thredded_user_detail_id: user_detail.id
+        )
+        .update!(last_seen_at: now)
+    end
+  end
+end

data/app/jobs/thredded/auto_follow_and_notify_job.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Thredded
+  class AutoFollowAndNotifyJob < ::ActiveJob::Base
+    queue_as :default
+
+    def perform(post_id)
+      post = Thredded::Post.find(post_id)
+
+      Thredded::AutofollowUsers.new(post).run
+      Thredded::NotifyFollowingUsers.new(post).run
+    end
+  end
+end

data/app/jobs/thredded/notify_private_topic_users_job.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Thredded
+  class NotifyPrivateTopicUsersJob < ::ActiveJob::Base
+    queue_as :default
+
+    def perform(private_post_id)
+      private_post = Thredded::PrivatePost.find(private_post_id)
+      NotifyPrivateTopicUsers.new(private_post).run
+    end
+  end
+end

data/app/mailer_previews/thredded/base_mailer_preview.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Thredded
+  # A base class for Thredded mailer previews.
+  # @abstract
+  class BaseMailerPreview
+    def self.preview_classes
+      RailsEmailPreview.find_preview_classes File.expand_path('..', File.dirname(__FILE__))
+    end
+
+    protected
+
+    def mock_content(mention_users: [])
+      <<-MARKDOWN
+Hey #{mention_users.map { |u| "@#{u}" } * ', '}!
+All of the basic [Markdown](https://kramdown.gettalong.org/quickref.html) formatting is supported (powered by [Kramdown](https://kramdown.gettalong.org)).
+
+Additionally, Markdown is extended to support the following:
+
+#{Thredded::FormattingDemoContent.parts.join("\n")}
+      MARKDOWN
+    end
+
+    def mock_topic(attr = {})
+      fail 'Do not assign ID here or a has_many association might get updated' if attr.key?(:id)
+      Thredded::Topic.new(
+        attr.reverse_merge(
+          title:        'A test topic',
+          slug:         'a-test-topic',
+          created_at:   3.days.ago,
+          last_user:    mock_user,
+          locked:       [false, true].sample,
+          messageboard: mock_messageboard,
+          posts_count:  1 + rand(42),
+          sticky:       [false, true].sample,
+          updated_at:   Time.zone.now,
+          user:         mock_user,
+        )
+      )
+    end
+
+    def mock_post(attr = {})
+      topic = attr[:postable] || mock_topic
+      Thredded::Post.new(
+        attr.reverse_merge(
+          content:      'A test post',
+          created_at:   Time.zone.now,
+          id:           1 + rand(1334),
+          messageboard: topic.messageboard,
+          postable:     topic,
+          updated_at:   Time.zone.now,
+          user:         topic.last_user,
+        )
+      ).tap { |m| mock_post_cache_key! m }
+    end
+
+    def mock_private_topic(attr = {})
+      fail 'Do not assign ID here or a has_many association might get updated' if attr.key?(:id)
+      Thredded::PrivateTopic.new(
+        attr.reverse_merge(
+          title:       'A test private topic',
+          slug:        'a-test-private-topic',
+          created_at:  3.days.ago,
+          last_user:   mock_user,
+          posts_count: 1 + rand(42),
+          updated_at:  Time.zone.now,
+          user:        mock_user,
+        )
+      )
+    end
+
+    def mock_private_post(attr = {})
+      private_topic = attr[:postable] || mock_private_topic
+      Thredded::PrivatePost.new(
+        attr.reverse_merge(
+          content:    'A test private post',
+          created_at: Time.zone.now,
+          id:         1 + rand(1334),
+          postable:   private_topic,
+          updated_at: Time.zone.now,
+          user:       private_topic.last_user,
+        )
+      ).tap { |m| mock_post_cache_key! m }
+    end
+
+    def mock_messageboard(attr = {})
+      fail 'Do not assign ID here or a has_many association might get updated' if attr.key?(:id)
+      Thredded::Messageboard.new(
+        attr.reverse_merge(
+          name:         'A test messageboard',
+          slug:         'a-test-messageboard',
+          description:  'Test messageboard description',
+          created_at:   1.month.ago,
+          posts_count:  rand(1337),
+          topics_count: rand(42),
+          updated_at:   Time.zone.now,
+        )
+      )
+    end
+
+    def mock_user(attr = {})
+      name = %w[Alice Bob].sample
+      Thredded.user_class.new(
+        attr.reverse_merge(
+          Thredded.user_name_column => name,
+          email:                    "#{name.downcase}@test.com",
+        )
+      )
+    end
+
+    def mock_post_cache_key!(post)
+      orig_key = post.cache_key
+      post.define_singleton_method :cache_key do
+        orig_key.sub(/new$/, "preview-#{Digest.hexencode(Digest::SHA2.new.digest(content))}")
+      end
+    end
+  end
+end