thredded 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a49cf4f5b1bb361db1653f027efaf34c1de3dc6
-  data.tar.gz: f1cabfe3e1c3d3c20a25242447fe0cbddf813f7e
+  metadata.gz: 3ff5d29c06fad4e64cf4fa4b1577d77785a29453
+  data.tar.gz: 2a6196cbbcff86edd7e418e9b0bdb6bd2bb7ce23
 SHA512:
-  metadata.gz: b85be66c122e1eec83513d29ff3c7934f6000b8437623458719367f9bea60ca3aa34b30cd2eb9ff05e414f088d4d203cf456e1653f962c01e791b1a3cb2b70ef
-  data.tar.gz: 065b6e28bf583efa655c1ffca1c65857708ae85a60699a8010e1a4eec0477ea9583c4573f5ba7579ced0343877b442d87dc121fe77692607fcb3499a98d85862
+  metadata.gz: 944f979a29481faaf886de134b5d2e1ee7dee38d26597292d630c10406a9910e6b064a9b23ba1a26b31a65548a23a7a4cb3e3ed539e84830d8fdc150492e5e86
+  data.tar.gz: d87c3e1584e457bbd771114d548fdf143c90d8adb12f1c4393c7b41f1cb594b68bf6ed3cb05e48827ce3df04db7d5a9f9463f853e4896f51032576c9f989d702

data/README.md

@@ -56,7 +56,7 @@ Then, see the rest of this Readme for more information about using and customizi
 Add the gem to your Gemfile:
 
 ```ruby
-gem 'thredded', '~> 0.9.3'
+gem 'thredded', '~> 0.9.4'
 ```
 
 Add the Thredded [initializer] to your parent app by running the install generator.
@@ -323,7 +323,7 @@ You can also turn off the email notifier totally, or add other notifiers (e.g. P
 
 ## I18n
 
-Thredded is mostly internationalized. It is currently available in English, Brazilian Portuguese, and Spanish.
+Thredded is mostly internationalized. It is currently available in English, Brazilian Portuguese, Polish, and Spanish.
 We welcome PRs adding support for new languages.
 
 If you use thredded in languages other than English, you probably want to add `rails-i18n` to your Gemfile.
@@ -511,8 +511,9 @@ change_column_default :thredded_user_details, :moderation_state, 1 # approved
 
 The following official plugins are available for Thredded:
 
-* [BBCode](https://github.com/thredded/thredded-bbcode) formatting for posts, e.g. `[b]for bold[/b]`.
-* [Code Syntax Highlighting](https://github.com/thredded/thredded-markdown_coderay) using Coderay.
+* [BBCode](https://github.com/thredded/thredded-bbcode) formatting for posts, e.g. `[b]for bold[/b]`. Can be used alongside Markdown.
+* [Code Syntax Highlighting in Markdown](https://github.com/thredded/thredded-markdown_coderay) using Coderay.
+* [TeX math via KaTeX in Markdown](https://github.com/thredded/thredded-markdown_katex), fast, accessible, JS-free math rendering.
 
 Thredded is built for extensibility, and writing plugins for it is easy. If you plan on extending Thredded functionality
 in a way others may benefit from, please consider making it a plugin.

data/app/assets/javascripts/thredded/components/post_form.es6

@@ -1,3 +1,5 @@
+//= require ./preview_area
+
 (($) => {
   const COMPONENT_SELECTOR = '[data-thredded-post-form]';
 
@@ -9,6 +11,9 @@
     init($nodes) {
       let $textarea = $nodes.find(this.textareaSelector);
       this.autosize($textarea);
+      $nodes.each(function() {
+        new ThreddedPreviewArea($(this));
+      });
       new ThreddedMentionAutocompletion($).init($nodes);
     }
 

data/app/assets/javascripts/thredded/components/preview_area.es6

@@ -0,0 +1,52 @@
+//= require ./preview_area
+
+(function($) {
+  const PREVIEW_AREA_SELECTOR = '[data-thredded-preview-area]';
+  const PREVIEW_AREA_POST_SELECTOR = '[data-thredded-preview-area-post]';
+
+  class ThreddedPreviewArea {
+
+    constructor($form) {
+      const $preview = $form.find(PREVIEW_AREA_SELECTOR);
+      if (!$preview.length) return;
+      this.$form = $form;
+      const $textarea = $form.find('textarea');
+      this.textarea = $textarea.get(0);
+      this.preview = $preview.get(0);
+      this.previewPost = $form.find(PREVIEW_AREA_POST_SELECTOR).get(0);
+      this.previewUrl = this.preview.getAttribute('data-thredded-preview-url');
+
+      const onChange = Thredded.debounce(() => {
+        this.updatePreview()
+      }, 200, false);
+
+      this.textarea.addEventListener('input', onChange, false);
+      // Listen to the jQuery change event as that's what is triggered by plugins such as jQuery.textcomplete.
+      $textarea.on('change', onChange);
+
+      this.requestId = 0;
+    }
+
+    updatePreview() {
+      this.requestId++;
+      const requestId = this.requestId;
+      $.ajax({
+        type: this.$form.attr('method'),
+        url: this.previewUrl,
+        data: this.$form.serialize(),
+      }).done((data) => {
+        if (requestId == this.requestId) {
+          // Ignore older responses received out-of-order
+          this.onPreviewResponse(data);
+        }
+      });
+    }
+
+    onPreviewResponse(data) {
+      this.preview.style.display = 'block';
+      this.previewPost.innerHTML = data;
+    }
+  }
+
+  window.ThreddedPreviewArea = ThreddedPreviewArea;
+})(jQuery);

data/app/assets/javascripts/thredded/components/topic_form.es6

@@ -16,6 +16,9 @@
 
     init($nodes) {
       $nodes.find(this.textareaSelector).autosize();
+      $nodes.each(function() {
+        new ThreddedPreviewArea($(this));
+      });
       new ThreddedMentionAutocompletion($).init($nodes);
       $nodes.filter(this.compactSelector).
         on('focus', this.titleSelector, e => {

data/app/assets/javascripts/thredded/core/debounce.es6

@@ -0,0 +1,32 @@
+//= require ./thredded
+
+/**
+ * Return a function, that, as long as it continues to be invoked, will
+ * not be triggered. The function will be called after it stops being
+ * called for `wait` milliseconds. If `immediate` is passed, trigger the
+ * function on the leading edge, instead of the trailing.
+ * Based on https://john-dugan.com/javascript-debounce/.
+ *
+ * @param {Function} func
+ * @param {Number} wait in milliseconds
+ * @param {Boolean} immediate
+ * @returns {Function}
+ */
+window.Thredded.debounce = function(func, wait, immediate) {
+  let timeoutId = null;
+  return function() {
+    const context = this, args = arguments;
+    const later = function() {
+      timeoutId = null;
+      if (!immediate) {
+        func.apply(context, args);
+      }
+    };
+    const callNow = immediate && !timeoutId;
+    clearTimeout(timeoutId);
+    timeoutId = setTimeout(later, wait || 200);
+    if (callNow) {
+      func.apply(context, args);
+    }
+  };
+};

data/app/assets/javascripts/thredded/core/hide_soft_keyboard.es6

@@ -1,4 +1,5 @@
-window.Thredded = window.Thredded || {};
+//= require ./thredded
+
 window.Thredded.hideSoftKeyboard = () => {
   const activeElement = document.activeElement;
   if (!activeElement || !activeElement.blur) return;

data/app/assets/javascripts/thredded/core/mention_autocompletion.es6

@@ -41,7 +41,7 @@ class ThreddedMentionAutocompletion {
       },
       replace  ({name, match}) {
         let prefix = match[1];
-        if (name.indexOf(" ") > -1) {
+        if (/[. ]/.test(name)) {
           return `${prefix}"${name}" `
         } else {
           return `${prefix}${name} `
@@ -51,4 +51,4 @@ class ThreddedMentionAutocompletion {
   }
 }
 
-ThreddedMentionAutocompletion.MATCH_RE = /(^@|\s@)"?((?:\w| )+)$/;
+ThreddedMentionAutocompletion.MATCH_RE = /(^@|\s@)"?([\w. ]+)$/;

data/app/assets/javascripts/thredded/core/on_page_load.es6

@@ -1,3 +1,5 @@
+//= require ./thredded
+
 (() => {
   const isTurbolinks = 'Turbolinks' in window && window.Turbolinks.supported;
   const isTurbolinks5 = isTurbolinks && 'clearCache' in window.Turbolinks;
@@ -11,8 +13,6 @@
     onPageLoadFiredOnce = true;
   };
 
-  window.Thredded = window.Thredded || {};
-
   // Fires the callback on DOMContentLoaded or a Turbolinks page load.
   // If called from an async script on the first page load, and the DOMContentLoad event
   // has already fired, will execute the callback immediately.

data/app/assets/javascripts/thredded/core/thredded.es6

@@ -0,0 +1 @@
+window.Thredded = window.Thredded || {};

data/app/assets/stylesheets/thredded/_thredded.scss

@@ -30,3 +30,4 @@
 @import "components/topic-delete";
 @import "components/topic-header";
 @import "components/topics";
+@import "components/preview_area";

data/app/assets/stylesheets/thredded/components/_pagination.scss

@@ -1,6 +1,5 @@
 .thredded--pagination {
   border-top: $thredded-base-border;
-  margin-top: $thredded-base-spacing;
   padding-top: $thredded-base-spacing;
   text-align: center;
 
@@ -24,3 +23,13 @@
     }
   }
 }
+
+.thredded--pagination-top > .thredded--pagination {
+  border-bottom: $thredded-base-border;
+  margin-bottom: $thredded-base-spacing;
+  padding-bottom: $thredded-base-spacing;
+}
+
+.thredded--pagination-bottom > .thredded--pagination {
+  margin-top: $thredded-base-spacing;
+}

data/app/assets/stylesheets/thredded/components/_preview_area.scss

@@ -0,0 +1,11 @@
+.thredded--preview-area {
+  display: none;
+
+  &--title {
+    @extend %thredded--heading;
+  }
+
+  &--post {
+    margin-bottom: $thredded-base-spacing;
+  }
+}

data/app/controllers/concerns/thredded/new_private_topic_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Thredded
+  # @api private
+  module NewPrivateTopicParams
+    protected
+
+    def new_private_topic_params
+      params
+        .require(:private_topic)
+        .permit(:title, :content, :user_ids, user_ids: [])
+        .merge(
+          user: thredded_current_user,
+          ip: request.remote_ip
+        ).tap { |p| adapt_user_ids! p }
+    end
+
+    private
+
+    # select2 returns a string of IDs joined with commas.
+    def adapt_user_ids!(p)
+      p[:user_ids] = p[:user_ids].split(',') if p[:user_ids].is_a?(String)
+    end
+  end
+end

data/app/controllers/concerns/thredded/new_topic_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Thredded
+  # @api private
+  module NewTopicParams
+    protected
+
+    def new_topic_params
+      params
+        .fetch(:topic, {})
+        .permit(:title, :locked, :sticky, :content, category_ids: [])
+        .merge(
+          messageboard: messageboard,
+          user: thredded_current_user,
+          ip: request.remote_ip,
+        )
+    end
+  end
+end

data/app/controllers/concerns/thredded/render_preview.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Thredded
+  module RenderPreview
+    protected
+
+    def render_preview
+      if request.xhr?
+        render layout: false
+      else
+        @preview_content = render_to_string(layout: false)
+        render template: 'thredded/shared/preview'
+      end
+    end
+  end
+end

data/app/controllers/thredded/post_previews_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Thredded
+  class PostPreviewsController < Thredded::ApplicationController
+    include Thredded::RenderPreview
+
+    # Preview a new post
+    def preview
+      @post = Post.new(post_params)
+      @post.postable = Topic.friendly_find!(params[:topic_id])
+      render_preview
+    end
+
+    # Preview an update to an existing post
+    def update
+      @post = Post.find(params[:post_id])
+      @post.assign_attributes(post_params)
+      render_preview
+    end
+
+    private
+
+    def post_params
+      params.require(:post)
+        .permit(:content)
+        .merge(user: thredded_current_user, messageboard: messageboard)
+    end
+  end
+end

data/app/controllers/thredded/posts_controller.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module Thredded
+  # This currently handles both {Post}s and {PrivatePost}s.
+  # TODO: split up the PrivatePost functionality into a separate controller.
   class PostsController < Thredded::ApplicationController
     include ActionView::RecordIdentifier
 

data/app/controllers/thredded/private_post_previews_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Thredded
+  class PrivatePostPreviewsController < Thredded::ApplicationController
+    include Thredded::RenderPreview
+
+    # Preview a new post
+    def preview
+      @private_post = PrivatePost.new(private_post_params)
+      @private_post.postable = PrivateTopic.friendly_find!(params[:private_topic_id])
+      render_preview
+    end
+
+    # Preview an update to an existing post
+    def update
+      @private_post = PrivatePost.find(params[:private_post_id])
+      @private_post.assign_attributes(private_post_params)
+      render_preview
+    end
+
+    private
+
+    def private_post_params
+      params.require(:post)
+        .permit(:content)
+        .merge(user: thredded_current_user)
+    end
+  end
+end

data/app/controllers/thredded/private_topic_previews_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Thredded
+  class PrivateTopicPreviewsController < Thredded::ApplicationController
+    include Thredded::NewPrivateTopicParams
+    include Thredded::RenderPreview
+
+    def preview
+      form = PrivateTopicForm.new(new_private_topic_params)
+      @private_post = form.post
+      @private_post.postable = form.private_topic
+      render_preview
+    end
+  end
+end

data/app/controllers/thredded/private_topics_controller.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 module Thredded
   class PrivateTopicsController < Thredded::ApplicationController
+    include Thredded::NewPrivateTopicParams
+
     before_action :thredded_require_login!
 
     def index
@@ -85,20 +87,5 @@ module Thredded
         .require(:private_topic)
         .permit(:title)
     end
-
-    def new_private_topic_params
-      params
-        .require(:private_topic)
-        .permit(:title, :content, :user_ids, user_ids: [])
-        .merge(
-          user: thredded_current_user,
-          ip:   request.remote_ip
-        ).tap { |p| adapt_user_ids! p }
-    end
-
-    # select2 returns a string of IDs joined with commas.
-    def adapt_user_ids!(p)
-      p[:user_ids] = p[:user_ids].split(',') if p[:user_ids].is_a?(String)
-    end
   end
 end

data/app/controllers/thredded/topic_previews_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Thredded
+  class TopicPreviewsController < Thredded::ApplicationController
+    include Thredded::NewTopicParams
+    include Thredded::RenderPreview
+
+    def preview
+      form = TopicForm.new(new_topic_params)
+      @post = form.post
+      @post.postable = form.topic
+      render_preview
+    end
+  end
+end

data/app/controllers/thredded/topics_controller.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-# rubocop:disable Metrics/ClassLength
 module Thredded
   class TopicsController < Thredded::ApplicationController
+    include Thredded::NewTopicParams
+
     before_action :thredded_require_login!,
                   only: %i(edit new update create destroy follow unfollow)
     after_action :update_user_activity
@@ -147,20 +148,8 @@ module Thredded
         .permit(:title, :locked, :sticky, category_ids: [])
     end
 
-    def new_topic_params
-      params
-        .fetch(:topic, {})
-        .permit(:title, :locked, :sticky, :content, category_ids: [])
-        .merge(
-          messageboard: messageboard,
-          user: thredded_current_user,
-          ip: request.remote_ip,
-        )
-    end
-
     def current_page
       (params[:page] || 1).to_i
     end
   end
 end
-# rubocop:enable Metrics/ClassLength

data/app/mailer_previews/thredded/private_topic_mailer_preview.rb

@@ -3,10 +3,12 @@ module Thredded
   # Previews for the PrivateTopicMailer
   class PrivateTopicMailerPreview < BaseMailerPreview
     def message_notification
+      post = mock_private_post(content: mock_content(mention_users: ['glebm']))
       PrivateTopicMailer.message_notification(
         mock_private_topic(posts: [
-                             mock_private_post(content: mock_content(mention_users: ['glebm']))
+                             post
                            ]),
+        post,
         %w(glebm@test.com joel@test.com)
       )
     end

data/app/mailers/thredded/private_topic_mailer.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 module Thredded
   class PrivateTopicMailer < Thredded::BaseMailer
-    def message_notification(private_topic_id, emails)
+    def message_notification(private_topic_id, post_id, emails)
       @topic               = find_record Thredded::PrivateTopic, private_topic_id
+      @post                = find_record Thredded::PrivatePost, post_id
       email_details        = Thredded::TopicEmailView.new(@topic)
       headers['X-SMTPAPI'] = email_details.smtp_api_tag('private_topic_mailer')
 

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

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 module Thredded
+  # @abstract Classes that include this module are expected to implement {#readers}.
+  # @!method readers
+  #     @abstract
+  #     @return [ActiveRecord::Relation<Thredded.user_class>] users from that can read this post.
   module PostCommon
     extend ActiveSupport::Concern
 
@@ -36,6 +40,14 @@ module Thredded
       postable.first_post == self
     end
 
+    # @return [ActiveRecord::Relation<Thredded.user_class>] users from the list of user names that can read this post.
+    # @api private
+    def readers_from_user_names(user_names)
+      DbTextSearch::CaseInsensitive
+        .new(readers, Thredded.user_name_column)
+        .in(user_names)
+    end
+
     private
 
     def ensure_user_detail

data/app/models/thredded/post.rb

@@ -42,11 +42,9 @@ module Thredded
       false
     end
 
-    # @return [ActiveRecord::Relation<Thredded.user_class>] users from the list of user names that can read this post.
-    def readers_from_user_names(user_names)
-      DbTextSearch::CaseInsensitive
-        .new(Thredded.user_class.thredded_messageboards_readers([messageboard]), Thredded.user_name_column)
-        .in(user_names)
+    # @return [ActiveRecord::Relation<Thredded.user_class>] users that can read this post.
+    def readers
+      Thredded.user_class.thredded_messageboards_readers([messageboard])
     end
 
     private

data/app/models/thredded/private_post.rb

@@ -27,11 +27,14 @@ module Thredded
       true
     end
 
-    # @return [ActiveRecord::Relation<Thredded.user_class>] users from the list of user names that can read this post.
-    def readers_from_user_names(user_names)
-      DbTextSearch::CaseInsensitive
-        .new(postable.users, Thredded.user_name_column)
-        .in(user_names)
+    # @return [ActiveRecord::Relation<Thredded.user_class>] users that can read this post.
+    def readers
+      collection_proxy = postable.users
+      if persisted?
+        collection_proxy.scope
+      else
+        Thredded.user_class.where(id: collection_proxy.to_a.map(&:id))
+      end
     end
 
     private

data/app/notifiers/thredded/email_notifier.rb

@@ -18,7 +18,7 @@ module Thredded
       users = exclude_previously_notified(post, users)
       return unless users.present?
       PrivateTopicMailer
-        .message_notification(post.postable.id, users.map(&:email))
+        .message_notification(post.postable.id, post.id, users.map(&:email))
         .deliver_now
       MembersMarkedNotified.new(post, users).run
     end

data/app/view_hooks/thredded/all_view_hooks.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 module Thredded
   class AllViewHooks
+    # @return [PostsCommon]
+    attr_reader :posts_common
     # @return [PostForm]
     attr_reader :post_form
     # @return [ModerationUserPage]
@@ -19,16 +21,34 @@ module Thredded
     end
 
     def initialize
+      @posts_common = PostsCommon.new
       @post_form = PostForm.new
       @moderation_user_page = ModerationUserPage.new
     end
 
+    # View hooks for collections of public or private posts.
+    class PostsCommon
+      # @return [Thredded::AllViewHooks::ViewHook]
+      attr_reader :pagination_top
+      # @return [Thredded::AllViewHooks::ViewHook]
+      attr_reader :pagination_bottom
+
+      def initialize
+        @pagination_top = ViewHook.new
+        @pagination_bottom = ViewHook.new
+      end
+    end
+
     class PostForm
       # @return [Thredded::AllViewHooks::ViewHook]
       attr_reader :content_text_area
 
+      # @return [Thredded::AllViewHooks::ViewHook]
+      attr_reader :preview_area
+
       def initialize
         @content_text_area = ViewHook.new
+        @preview_area = ViewHook.new
       end
     end
 

data/app/view_models/thredded/private_topic_view.rb

@@ -15,5 +15,9 @@ module Thredded
                    end
       new(topic, read_state, Pundit.policy!(user, topic))
     end
+
+    def new_post_preview_path
+      Thredded::UrlsHelper.preview_new_private_topic_private_post_path(@topic)
+    end
   end
 end

data/app/view_models/thredded/topic_view.rb

@@ -63,5 +63,9 @@ module Thredded
     def messageboard_path
       Thredded::UrlsHelper.messageboard_topics_path(@topic.messageboard)
     end
+
+    def new_post_preview_path
+      Thredded::UrlsHelper.preview_new_messageboard_topic_post_path(@topic.messageboard, @topic)
+    end
   end
 end

data/app/views/thredded/post_previews/preview.html.erb

@@ -0,0 +1 @@
+<%= @post.filtered_content(self) %>

data/app/views/thredded/post_previews/update.html.erb

@@ -0,0 +1 @@
+<%= @post.filtered_content(self) %>

data/app/views/thredded/posts/_form.html.erb

@@ -1,6 +1,7 @@
 <%= render 'thredded/posts_common/form',
            topic: topic,
            post: post,
+           preview_url: preview_url,
            content_label: t('thredded.posts.form.content_label'),
            button_text: button_text,
            button_submitting_text: local_assigns.key?(:button_submitting_text) ? button_submitting_text : nil %>

data/app/views/thredded/posts/edit.html.erb

@@ -12,6 +12,8 @@
                messageboard: (messageboard unless @post.private_topic_post?),
                topic:        topic,
                post:         @post,
+               preview_url:  (@post.private_topic_post? ? private_topic_private_post_preview_path(@post.postable, @post)
+                                                        : messageboard_topic_post_preview_path(messageboard, @post.postable, @post)),
                button_text:  t('thredded.posts.form.update_btn'),
                button_submitting_text: t('thredded.posts.form.update_btn_submitting')%>
   </section>