thredded 0.2.2 → 0.3.0

data/app/forms/thredded/user_preferences_form.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+module Thredded
+  class UserPreferencesForm
+    include ActiveModel::Model
+
+    # @return [Thredded::Messageboard, nil]
+    attr_reader :messageboard
+
+    validate :validate_children
+
+    delegate :notify_on_mention, :notify_on_mention=,
+             :notify_on_message, :notify_on_message=,
+             to: :user_preference
+
+    delegate :notify_on_mention, :notify_on_mention=,
+             to: :user_messageboard_preference,
+             prefix: :messageboard
+
+    # @param user [Thredded.user_class]
+    # @param messageboard [Thredded::Messageboard, nil]
+    def initialize(user:, messageboard: nil, params: {})
+      @user = user
+      @messageboard = messageboard
+      super(params)
+    end
+
+    # @return [Boolean]
+    def save
+      return false unless valid?
+      Thredded::UserPreference.transaction do
+        user_preference.save!
+        user_messageboard_preference.save! if messageboard
+      end
+      true
+    end
+
+    private
+
+    # @return [Thredded::UserPreference]
+    def user_preference
+      @user_preference ||= @user.thredded_user_preference
+    end
+
+    # @return [Thredded::UserMessageboardPreference, nil]
+    def user_messageboard_preference
+      return nil unless @messageboard
+      @user_messageboard_preference ||=
+        user_preference.messageboard_preferences.where(messageboard_id: @messageboard.id).first_or_initialize
+    end
+
+    def validate_children
+      promote_errors(user_preference.errors) if user_preference.invalid?
+      promote_errors(user_messageboard_preference.errors, :messageboard) if messageboard && user_messageboard_preference.invalid?
+    end
+
+    def promote_errors(child_errors, prefix = nil)
+      child_errors.each do |attribute, message|
+        errors.add([prefix, attribute].compact.join('_'), message)
+      end
+    end
+  end
+end

data/app/helpers/thredded/application_helper.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
 module Thredded
   module ApplicationHelper
+    include ::Thredded::UrlsHelper
+
     # 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:
@@ -8,12 +11,6 @@ module Thredded
       render partial: 'thredded/shared/page'
     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 user [Thredded.user_class, Thredded::NullUser]
     # @return [String] html_safe link to the user
     def user_link(user)
@@ -30,12 +27,14 @@ module Thredded
       super(collection, args.reverse_merge(views_prefix: 'thredded'))
     end
 
-    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(messageboard, post.postable, post)
-      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
   end
 end

data/app/helpers/thredded/urls_helper.rb

@@ -0,0 +1,103 @@
+# 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]
+    # @return [String] URL of the topic page with the post anchor.
+    def post_url(post, params = {})
+      params = params.dup
+      params[:anchor] ||= dom_id(post)
+      params[:page] ||= post.page
+      topic_url(post.postable, params)
+    end
+
+    # @param post [Post, PrivatePost]
+    # @return [String] path to the topic page with the post anchor.
+    def post_path(post, params = {})
+      post_url(post, params.merge(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 PATCH PUT POST 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
+        super(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
+  end
+end

data/app/jobs/thredded/activity_updater_job.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
 module Thredded
   class ActivityUpdaterJob < ::ActiveJob::Base
     queue_as :default
 
     def perform(user_id, messageboard_id)
-      now = Time.zone.now
+      now = Time.current
 
-      user_detail = Thredded::UserDetail.for_user_id(user_id)
-      user_detail.update_column(:last_seen_at, now)
+      user_detail = Thredded::UserDetail.where(user_id: user_id).first_or_initialize
+      user_detail.update!(last_seen_at: now)
 
       Thredded::MessageboardUser
         .where(

data/app/jobs/thredded/at_notifier_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Thredded
   class AtNotifierJob < ::ActiveJob::Base
     queue_as :default

data/app/jobs/thredded/notify_private_topic_users_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Thredded
   class NotifyPrivateTopicUsersJob < ::ActiveJob::Base
     queue_as :default

data/app/mailer_previews/thredded/base_mailer_preview.rb

@@ -0,0 +1,101 @@
+# 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
+#{mention_users.map { |u| "@#{u}" } * ', '}, if we synthesize the driver, we can get to the HDD panel through the `1080p EXE` bus!
+I'll program the **redundant** SMTP array, that should monitor the SMS microchip!
+MARKDOWN
+    end
+
+    def mock_topic(attr = {})
+      Topic.new(
+        attr.reverse_merge(
+          title:        'A test topic',
+          slug:         'a-test-topic',
+          created_at:   3.days.ago,
+          id:           1 + rand(1334),
+          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
+      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,
+        ))
+    end
+
+    def mock_private_topic(attr = {})
+      PrivateTopic.new(
+        attr.reverse_merge(
+          title:       'A test private topic',
+          slug:        'a-test-private-topic',
+          created_at:  3.days.ago,
+          id:          1 + rand(1334),
+          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
+      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,
+        ))
+    end
+
+    def mock_messageboard(attr = {})
+      Messageboard.new(
+        attr.reverse_merge(
+          name:         'A test messageboard',
+          slug:         'a-test-messageboard',
+          description:  'Test messageboard description',
+          closed:       false,
+          created_at:   1.month.ago,
+          id:           1 + rand(1334),
+          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
+  end
+end

data/app/mailer_previews/thredded/post_mailer_preview.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Thredded
+  # Previews for the PostMailer
+  class PostMailerPreview < BaseMailerPreview
+    def at_notification
+      PostMailer.at_notification(
+        mock_post(content: mock_content(mention_users: %w(glebm joel))),
+        %w(glebm@test.com joel@test.com))
+    end
+  end
+end

data/app/mailer_previews/thredded/private_post_mailer_preview.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Thredded
+  # Previews for the PrivatePostMailer
+  class PrivatePostMailerPreview < BaseMailerPreview
+    def at_notification
+      PrivatePostMailer.at_notification(
+        mock_private_post(content: mock_content(mention_users: %w(glebm joel))),
+        %w(glebm@test.com joel@test.com))
+    end
+  end
+end

data/app/mailer_previews/thredded/private_topic_mailer_preview.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Thredded
+  # Previews for the PrivateTopicMailer
+  class PrivateTopicMailerPreview < BaseMailerPreview
+    def message_notification
+      PrivateTopicMailer.message_notification(
+        mock_private_topic.tap do |private_topic|
+          private_topic.posts = [
+            mock_private_post(content: mock_content(mention_users: ['glebm']), postable: private_topic)
+          ]
+        end,
+        %w(glebm@test.com joel@test.com))
+    end
+  end
+end

data/app/mailers/thredded/base_mailer.rb

@@ -1,4 +1,17 @@
+# frozen_string_literal: true
 module Thredded
   class BaseMailer < ActionMailer::Base
+    helper ::Thredded::UrlsHelper
+
+    protected
+
+    # Find a record by ID, or return the passed record.
+    # @param [Class<ActiveRecord::Base>] klass
+    # @param [Fixnum, String, klass] id_or_record
+    # @return [klass]
+    def find_record(klass, id_or_record)
+      # Check by name because in development the Class might have been reloaded after id was initialized
+      id_or_record.class.name == klass.name ? id_or_record : klass.find(id_or_record)
+    end
   end
 end

data/app/mailers/thredded/post_mailer.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+require_dependency 'thredded/topic_email_view'
 module Thredded
   class PostMailer < Thredded::BaseMailer
     def at_notification(post_id, emails)
-      @post                = Post.find(post_id)
-      email_details        = TopicEmailDecorator.new(@post.postable)
+      @post                = find_record Post, post_id
+      email_details        = TopicEmailView.new(@post.postable)
       headers['X-SMTPAPI'] = email_details.smtp_api_tag('at_notification')
 
       mail from:     email_details.no_reply,

data/app/mailers/thredded/private_post_mailer.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+require_dependency 'thredded/topic_email_view'
 module Thredded
   class PrivatePostMailer < Thredded::BaseMailer
     def at_notification(post_id, emails)
-      @post                = PrivatePost.find(post_id)
-      email_details        = TopicEmailDecorator.new(@post.postable)
+      @post                = find_record PrivatePost, post_id
+      email_details        = TopicEmailView.new(@post.postable)
       headers['X-SMTPAPI'] = email_details.smtp_api_tag('at_notification')
 
       mail from:     email_details.no_reply,

data/app/mailers/thredded/private_topic_mailer.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+require_dependency 'thredded/topic_email_view'
 module Thredded
   class PrivateTopicMailer < Thredded::BaseMailer
     def message_notification(private_topic_id, emails)
-      @topic               = PrivateTopic.find(private_topic_id)
-      email_details        = TopicEmailDecorator.new(@topic)
+      @topic               = find_record PrivateTopic, private_topic_id
+      email_details        = TopicEmailView.new(@topic)
       headers['X-SMTPAPI'] = email_details.smtp_api_tag('private_topic_mailer')
 
       mail from:     email_details.no_reply,

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'set'
+module Thredded
+  # Excludes pagination routes in addition to the given list of reserved words.
+  class FriendlyIdReservedWordsAndPagination
+    PAGINATION_PATTERN = /\Apage-\d+\z/i
+
+    def initialize(words = [])
+      @words = Set.new(words)
+    end
+
+    def include?(slug)
+      @words.include?(slug) || slug =~ PAGINATION_PATTERN
+    end
+  end
+end