thredded 0.7.0 → 0.8.2

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

@@ -17,12 +17,12 @@
         placeholder:   t('thredded.private_topics.form.title_placeholder_start') %>
 
       <%= render @private_topics %>
-    <% end -%>
 
-    <%= link_to t('thredded.nav.mark_all_read'),
-      mark_all_private_topics_read_path,
-      class: 'thredded--button thredded--button-light thredded--button-wide',
-      method: :put -%>
+      <%= link_to t('thredded.nav.mark_all_read'),
+        mark_all_private_topics_read_path,
+        class: 'thredded--button thredded--button-light thredded--button-wide',
+        method: :put -%>
+    <% end -%>
   <% end %>
 
   <footer>

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

@@ -1,6 +1,7 @@
 <%= form_tag search_path(messageboard),
              method: 'get',
-             class: 'thredded--form thredded--navigation--search thredded--navigation--search-topics' do %>
+             class: 'thredded--form thredded--navigation--search thredded--navigation--search-topics',
+             'data-thredded-turboform' => true do %>
   <%= label_tag :q, t('thredded.search.form.label') %>
   <%= text_field_tag :q, @query,
                      type:        'search',

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

@@ -1,6 +1,6 @@
 <% [:success, :error, :notice, :alert].each do |key| %>
   <% if flash[key] %>
-    <div class="thredded--flash-message thredded--flash-message--<%= key %>" id="flash">
+    <div class="thredded--flash-message thredded--flash-message--<%= key %>" data-thredded-flash-message>
       <%= flash[key] %>
     </div>
   <% end %>

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

@@ -1,6 +1,15 @@
-<%= content_tag(:div, id: "thredded--container", class: thredded_container_classes, data: thredded_container_data) do %>
+<%= content_tag(:div, id: 'thredded--container', class: thredded_container_classes, data: thredded_container_data) do %>
   <%= render 'thredded/shared/header' %>
   <%= render 'thredded/shared/flash_messages' %>
   <%= yield :thredded_page_content %>
   <%= render 'thredded/shared/currently_online' %>
 <%- end %>
+
+<%# If thredded JS is loaded via an [async] script, the JS may
+run before or after DOMContentLoaded. Expose a flag to Thredded
+so it can initialize correctly. %>
+<script data-turbolinks-eval="false">
+  document.addEventListener('DOMContentLoaded', function() {
+    (window.Thredded = window.Thredded || {}).DOMContentLoadedFired = true;
+  });
+</script>

data/app/views/thredded/shared/nav/_moderation.html.erb

@@ -1,6 +1,7 @@
 <% if moderatable_messageboards_ids.present? %>
-  <li class="thredded--user-navigation--item thredded--user-navigation--moderation">
-    <%= link_to pending_moderation_path, rel: 'nofollow' do %>
+  <% current = current_page_moderation? %>
+  <li class="thredded--user-navigation--item thredded--user-navigation--moderation<%= ' thredded--is-current' if current %>">
+    <%= link_to (current ? messageboards_path : pending_moderation_path), rel: 'nofollow' do %>
       <%= inline_svg 'thredded/moderation.svg',
                      class: 'thredded--icon',
                      title: t('thredded.nav.moderation') %>

data/app/views/thredded/shared/nav/_notification_preferences.html.erb

@@ -1,6 +1,8 @@
-<li class="thredded--user-navigation--settings thredded--user-navigation--item">
-  <%= link_to edit_preferences_path(messageboard) do %>
+<% current = current_page_preferences? %>
+<li class="thredded--user-navigation--settings thredded--user-navigation--item<%= ' thredded--is-current' if current %>">
+  <%= link_to current ? (messageboard ? messageboard_topics_path(messageboard) : messageboards_path)
+                      : edit_preferences_path(messageboard) do %>
     <%= inline_svg 'thredded/settings.svg', class: 'thredded--icon', title: t('thredded.nav.settings') %>
     <span class="thredded--nav-text"><%= t('thredded.nav.settings') %></span>
-<% end %>
+  <% end %>
 </li>

data/app/views/thredded/shared/nav/_private_topics.html.erb

@@ -1,5 +1,6 @@
-<li class="thredded--user-navigation--item thredded--user-navigation--private-topics">
-  <%= link_to private_topics_path, rel: 'nofollow' do %>
+<% current = current_page_private_topics? %>
+<li class="thredded--user-navigation--item thredded--user-navigation--private-topics<%= ' thredded--is-current' if current %>">
+  <%= link_to (current ? messageboards_path : private_topics_path), rel: 'nofollow' do %>
     <%= inline_svg 'thredded/private-messages.svg',
                    class: 'thredded--icon',
                    title: t('thredded.nav.private_topics') %>

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

@@ -1,5 +1,10 @@
 <%= form_for [messageboard, topic],
-             html: { class: "thredded--form #{local_assigns[:css_class]}", 'data-thredded-topic-form' => true } do |form| %>
+             html: {
+                 class: "thredded--form #{local_assigns[:css_class]}",
+                 'data-thredded-topic-form' => true,
+                 'data-autocomplete-url' => autocomplete_users_path,
+                 'data-autocomplete-min-length' => Thredded.autocomplete_min_length,
+             } do |form| %>
   <ul class="thredded--form-list on-top">
     <li class="title">
       <%= form.label :title, t('thredded.topics.form.title_label') %>

data/app/views/thredded/topics/_header.html.erb

@@ -12,15 +12,18 @@
   <% if thredded_current_user %>
     <% if topic.followed? %>
       <div class="thredded--topic-header--follow-info">
-        <%= inline_svg 'thredded/follow.svg', class: 'thredded--topic-header--follow-icon' %>
-        <div>
+        <span class="thredded--topic-header--follow-info--reason">
           <%= topic_follow_reason_text topic.follow_reason %>
-          <%= button_to 'Stop following', topic.unfollow_path %>
-        </div>
+        </span>
+        <%= button_to topic.unfollow_path, form: {class: 'thredded--topic-header--follow-info--unfollow'} do %>
+          <%= t('thredded.topics.unfollow') %>
+          <%= inline_svg 'thredded/follow.svg', class: 'thredded--topic-header--follow-icon' %>
+        <% end %>
       </div>
     <% else %>
       <div class="thredded--topic-header--follow-info">
-        <%= button_to 'Follow this topic', topic.follow_path %>
+        <%= button_to t('thredded.topics.follow'), topic.follow_path,
+                      form: {class: 'thredded--topic-header--follow-info--follow'} %>
       </div>
     <% end %>
   <% end %>

data/config/locales/en.yml

@@ -72,20 +72,26 @@ en:
         page_title: :thredded.nav.settings
       form:
         global_preferences_label: Global Settings
-        messageboard_notify_on_mention:
+        messageboard_follow_topics_on_mention:
           hint: >-
             When someone mentions you by your username (eg: @sam) in this messageboard you will follow the topic.
-            You will receive emails with the contents of that post and any replies.
-          label: :thredded.preferences.form.notify_on_mention.label
+          label: :thredded.preferences.form.follow_topics_on_mention.label
+        messageboard_followed_topic_emails:
+          hint: >-
+            When there is a post in a topic you follow on this messageboard you will be sent an email.
+          label: Email notifications for followed topics
+        followed_topic_emails:
+          hint: >-
+            When there is a post in a topic you follow you will receive an email.
+          label: Email notifications for followed topics
         messageboard_preferences_label_html: Notification Settings for <em>%{messageboard}</em>
-        notify_on_mention:
+        follow_topics_on_mention:
           hint: >-
-            When someone mentions you by your username (eg: @sam) you will follow the topic. You will receive emails
-            with the contents of that post and any replies.
+            When someone mentions you by your username (eg: @sam) you will follow the topic.
           label: Follow topics you are mentioned in
         notify_on_message:
           hint: When you are added to a private conversation you will receive an email with its content.
-          label: Private Message Notifications
+          label: Email notifications for private messages
         submit_btn: Update Settings
         title: Settings
       updated_notice: Your settings have been updated.
@@ -124,6 +130,8 @@ en:
       followed_by: 'Followed by:'
       followed_by_noone: No one is following this topic
       followed_notice: You are now following this topic
+      follow: Follow this topic
+      unfollow: Stop following
       following:
         manual: You are following this topic.
         mentioned: You are following this topic because you were mentioned on it.

data/config/locales/pt-BR.yml

@@ -71,22 +71,28 @@ pt-BR:
       edit:
         page_title: :thredded.nav.settings
       form:
+        follow_topics_on_mention:
+          hint: >-
+            Quando alguém mencionar você através do seu usuário (ex.: @sam) você irá receber um e-mail com o conteúdo
+            deste post.
+          label: Siga os tópicos que são mencionados na
+        followed_topic_emails:
+          hint: Quando há um post em um tópico que você siga, você receberá um e-mail.
+          label: Notificações de e-mail para tópicos seguido
         global_preferences_label: Configurações Globais
-        messageboard_notify_on_mention:
+        messageboard_follow_topics_on_mention:
           hint: >-
             Quando alguém mencionar você através do seu usuário (ex.: @sam) neste fórum de mensagens, você irá receber
             um e-mail com o conteúdo deste post.
-          label: :thredded.preferences.form.notify_on_mention.label
+          label: :thredded.preferences.form.follow_topics_on_mention.label
+        messageboard_followed_topic_emails:
+          hint: Quando há um post em um tópico que você siga nesta messageboard será enviado um e-mail.
+          label: Notificações de e-mail para tópicos seguido
         messageboard_preferences_label_html: Configurações de Notificação para <em>%{messageboard}</em>
-        notify_on_mention:
-          hint: >-
-            Quando alguém mencionar você através do seu usuário (ex.: @sam) você irá receber um e-mail com o conteúdo
-            deste post.
-          label: "@ Notificações"
         notify_on_message:
           hint: Quando você for adicionado a uma conversa privada, você receberá um e-mail com o conteúdo desta
             conversa.
-          label: Notificação de Mensagens Privadas
+          label: E-mail notificações de mensagens privadas
         submit_btn: Atualizar Configurações
         title: Configurações
       updated_notice: Suas configurações foram atualizadas.
@@ -122,13 +128,14 @@ pt-BR:
       delete_topic: Remover Tópico
       deleted_notice: Tópico removido
       edit: Editar Tópico
+      follow: Siga este tópico
       followed_by: 'Seguido por:'
       followed_by_noone: Ninguém está seguindo este tópico
-      followed_notice: Você agora está acompanhando este tópico
+      followed_notice: Você agora está seguindo este tópico
       following:
-        manual: Você está acompanhando este tópico.
-        mentioned: Você está acompanhando este tópico porque você foi mencionado nele.
-        posted: Você está acompanhando este tópico porque foi você que o publicou.
+        manual: Você está seguindo este tópico.
+        mentioned: Você está seguindo este tópico porque você foi mencionado nele.
+        posted: Você está seguindo este tópico porque foi você que o publicou.
       form:
         categories_placeholder: Categorias
         content_label: :thredded.posts.form.content_label
@@ -142,7 +149,8 @@ pt-BR:
         page_title: Tópicos dos Resultados da Busca
         results_message: Resultados de Busca para %{query}
       started_by_html: Iniciado %{time_ago} por %{user}
-      unfollowed_notice: Você não está mais acompanhando este tópico
+      unfollow: Pare de seguir
+      unfollowed_notice: Você não está mais seguindo este tópico
       updated_notice: Tópico atualizado
     users:
       last_active_html: Última %{time_ago} ativa

data/config/routes.rb

@@ -56,8 +56,10 @@ Thredded::Engine.routes.draw do
       end
       member do
         get '(page-:page)', action: :show, as: '', constraints: page_constraint
-        post 'follow'
-        post 'unfollow'
+
+        # match (un)follow via get as well so that redirecting back to it after sign in works.
+        match 'follow', via: [:post, :get]
+        match 'unfollow', via: [:post, :get]
       end
       resources :posts, except: [:index, :show], path: ''
     end

data/db/migrate/20160329231848_create_thredded.rb

@@ -32,18 +32,16 @@ class CreateThredded < ActiveRecord::Migration
     DbTextSearch::CaseInsensitive.add_index connection, :thredded_categories, :name, name: :thredded_categories_name_ci
 
     create_table :thredded_messageboards do |t|
-      t.string :name, limit: 255, null: false
+      t.string :name, limit: 191, null: false
       t.string :slug, limit: 191
       t.text :description
       t.integer :topics_count, default: 0
       t.integer :posts_count, default: 0
       t.integer :position, null: false
-      t.boolean :closed, default: false, null: false
       t.references :last_topic
       t.references :messageboard_group
       t.timestamps null: false
       t.index [:messageboard_group_id], name: :index_thredded_messageboards_on_messageboard_group_id
-      t.index [:closed], name: :index_thredded_messageboards_on_closed
       t.index [:slug], name: :index_thredded_messageboards_on_slug
     end
 
@@ -162,8 +160,9 @@ class CreateThredded < ActiveRecord::Migration
 
     create_table :thredded_user_preferences do |t|
       t.references :user, null: false
-      t.boolean :notify_on_mention, default: true, null: false
+      t.boolean :follow_topics_on_mention, default: true, null: false
       t.boolean :notify_on_message, default: true, null: false
+      t.boolean :followed_topic_emails, default: true, null: false
       t.timestamps null: false
       t.index [:user_id], name: :index_thredded_user_preferences_on_user_id
     end
@@ -171,7 +170,8 @@ class CreateThredded < ActiveRecord::Migration
     create_table :thredded_user_messageboard_preferences do |t|
       t.references :user, null: false
       t.references :messageboard, null: false
-      t.boolean :notify_on_mention, default: true, null: false
+      t.boolean :follow_topics_on_mention, default: true, null: false
+      t.boolean :followed_topic_emails, default: true, null: false
       t.timestamps null: false
       t.index [:user_id, :messageboard_id],
               name: :thredded_user_messageboard_preferences_user_id_messageboard_id,

data/db/upgrade_migrations/20161019150201_upgrade_v0_7_to_v0_8.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+class UpgradeV07ToV08 < ActiveRecord::Migration
+  def up
+    closed_messageboards = Thredded::Messageboard.unscoped.where(closed: true).to_a
+    if closed_messageboards.present?
+      fail ActiveRecord::MigrationError, <<-TEXT
+There are #{closed_messageboards.length} closed Messageboards:
+#{closed_messageboards.map { |m| "#{m.name} (id=#{m.id})" }.join("\n")}
+Support for closed messageboards has been removed in thredded v0.8.0.
+Delete or un-close these messageboards and consider using the "paranoia" gem to support soft deletion instead.
+      TEXT
+    end
+    remove_index :thredded_messageboards, name: :index_thredded_messageboards_on_closed
+    remove_column :thredded_messageboards, :closed
+    add_column :thredded_user_preferences, :followed_topic_emails, :boolean, default: true, null: false
+    add_column :thredded_user_messageboard_preferences, :followed_topic_emails, :boolean, default: true, null: false
+    rename_column :thredded_user_preferences, :notify_on_mention, :follow_topics_on_mention
+    rename_column :thredded_user_messageboard_preferences, :notify_on_mention, :follow_topics_on_mention
+    change_column :thredded_messageboards, :name, :string, limit: 191
+  end
+
+  def down
+    change_column :thredded_messageboards, :name, :string, limit: 255
+    rename_column :thredded_user_messageboard_preferences, :follow_topics_on_mention, :notify_on_mention
+    rename_column :thredded_user_preferences, :follow_topics_on_mention, :notify_on_mention
+    remove_column :thredded_user_messageboard_preferences, :followed_topic_emails
+    remove_column :thredded_user_preferences, :followed_topic_emails
+    add_column :thredded_messageboards, :closed, :boolean, default: false, null: false
+    add_index :thredded_messageboards, :closed, name: :index_thredded_messageboards_on_closed
+  end
+end

data/lib/generators/thredded/install/templates/initializer.rb

@@ -59,15 +59,9 @@ Thredded.messageboards_order = :position
 # Email "From:" field will use the following
 # Thredded.email_from = 'no-reply@example.com'
 
-# Incoming email will be directed to this host
-# Thredded.email_incoming_host = 'example.com'
-
 # Emails going out will prefix the "Subject:" with the following string
 # Thredded.email_outgoing_prefix = '[My Forum] '
 
-# Reply to field for email notifications
-# Thredded.email_reply_to = -> postable { "#{postable.hash_id}@#{Thredded.email_incoming_host}" }
-
 # ==> View Configuration
 # Set the layout for rendering the thredded views.
 Thredded.layout = 'thredded/application'
@@ -76,14 +70,18 @@ Thredded.layout = 'thredded/application'
 # Customize the way Thredded handles post formatting.
 
 # Change the default html-pipeline filters used by thredded.
-# E.g. to remove BBCode support:
-# Thredded::ContentFormatter.pipeline_filters -= [HTML::Pipeline::BbcodeFilter]
+# E.g. to replace default emoji filter with your own:
+# Thredded::ContentFormatter.after_markup_filters[
+#   Thredded::ContentFormatter.after_markup_filters.index(HTML::Pipeline::EmojiFilter)] = MyEmojiFilter
 
 # Change the HTML sanitization settings used by Thredded.
 # See the Sanitize docs for more information on the underlying library: https://github.com/rgrove/sanitize/#readme
 # E.g. to allow a custom element <custom-element>:
 # Thredded::ContentFormatter.whitelist[:elements] += %w(custom-element)
 
+# ==> User autocompletion (Private messages and @-mentions)
+# Thredded.autocomplete_min_length = 2 lower to 1 if have 1-letter names -- increase if you want
+
 # ==> Error Handling
 # By default Thredded just renders a flash alert on errors such as Topic not found, or Login required.
 # Below is an example of overriding the default behavior on LoginRequired:
@@ -96,3 +94,17 @@ Thredded.layout = 'thredded/application'
 #     end
 #   end
 # end
+
+# ==> View hooks
+#
+# Customize the UI before/after/replacing individual components.
+# See the full list of view hooks and their arguments by running:
+#
+#     $ grep view_hooks -R --include '*.html.erb' "$(bundle show thredded)"
+#
+# Rails.application.config.to_prepare do
+#   Thredded.view_hooks.post_form.content_text_area.config.before do |form:, **args|
+#     # This is called in the Thredded view context, so all Thredded helpers and URLs are accessible here directly.
+#     'hi'
+#   end
+# end

data/lib/tasks/thredded_tasks.rake

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 namespace :thredded do
-  desc 'Destroy messageboard and all related data'
-  task :destroy, [:slug] => :environment do |_, args|
-    Thredded::MessageboardDestroyer.new(args.slug).run
-  end
-
-  task :nuke, [:slug] => :destroy
-
   namespace :install do
     desc 'Copy emoji to the Rails `public/emoji` directory'
     task :emoji do

data/lib/thredded.rb

@@ -5,15 +5,21 @@ require 'active_record_union'
 require 'db_text_search'
 require 'friendly_id'
 require 'html/pipeline'
-require 'html/pipeline/at_mention_filter'
-require 'html/pipeline/bbcode_filter'
+require 'html/pipeline/sanitization_filter'
 require 'html/pipeline/vimeo/vimeo_filter'
 require 'html/pipeline/youtube/youtube_filter'
+require 'rinku'
 require 'kaminari'
 require 'rb-gravatar'
 require 'active_job'
 require 'inline_svg'
 
+# Require these explictly to make sure they are not reloaded.
+# This allows for configuring them by accessing class methods in the initializer.
+require 'thredded/html_pipeline/at_mention_filter'
+require 'thredded/html_pipeline/autolink_filter'
+require 'thredded/html_pipeline/kramdown_filter'
+
 # Asset compilation
 require 'autoprefixer-rails'
 require 'autosize/rails'
@@ -26,12 +32,11 @@ require 'thredded/engine'
 
 module Thredded
   mattr_accessor \
+    :autocomplete_min_length,
     :active_user_threshold,
     :avatar_url,
     :email_from,
-    :email_incoming_host,
     :email_outgoing_prefix,
-    :email_reply_to,
     :layout,
     :messageboards_order,
     :user_class,
@@ -60,13 +65,22 @@ module Thredded
   self.active_user_threshold = 5.minutes
   self.admin_column = :admin
   self.avatar_url = ->(user) { Gravatar.src(user.email, 128, 'mm') }
-  self.email_reply_to = -> (postable) { "#{postable.hash_id}@#{Thredded.email_incoming_host}" }
   self.layout = 'thredded/application'
   self.moderator_column = :admin
   self.user_name_column = :name
   self.content_visible_while_pending_moderation = true
   self.show_topic_followers = false
   self.messageboards_order = :position
+  self.autocomplete_min_length = 2
+
+  # @return [Thredded::AllViewHooks] View hooks configuration.
+  def self.view_hooks
+    instance = Thredded::AllViewHooks.instance
+    unless instance
+      fail '`Thredded.view_hooks` must be configured in a `Rails.application.config.to_prepare` block!'
+    end
+    instance
+  end
 
   def self.user_display_name_method
     @@user_display_name_method || user_name_column