threddedDANIEL 0.14.5

data/db/upgrade_migrations/20161113161801_upgrade_v0_8_to_v0_9.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'thredded/base_migration'
+
+# rubocop:disable Metrics/MethodLength
+class UpgradeV08ToV09 < Thredded::BaseMigration
+  def up
+    create_table :thredded_notifications_for_private_topics do |t|
+      t.references :user, null: false, index: false, type: user_id_type
+      t.string :notifier_key, null: false, limit: 90
+      t.boolean :enabled, default: true, null: false
+      t.index %i[user_id notifier_key],
+              name: 'thredded_notifications_for_private_topics_unique', unique: true
+    end
+    create_table :thredded_notifications_for_followed_topics do |t|
+      t.references :user, null: false, index: false, type: user_id_type
+      t.string :notifier_key, null: false, limit: 90
+      t.boolean :enabled, default: true, null: false
+      t.index %i[user_id notifier_key],
+              name: 'thredded_notifications_for_followed_topics_unique', unique: true
+    end
+    create_table :thredded_messageboard_notifications_for_followed_topics do |t|
+      t.references :user, null: false, index: false, type: user_id_type
+      t.references :messageboard, null: false, index: false, type: column_type(:thredded_messageboards, :id)
+      t.string :notifier_key, null: false, limit: 90
+      t.boolean :enabled, default: true, null: false
+      t.index %i[user_id messageboard_id notifier_key],
+              name: 'thredded_messageboard_notifications_for_followed_topics_unique', unique: true
+    end
+
+    Thredded::UserPreference.all.each do |pref|
+      pref.notifications_for_private_topics.create(notifier_key: 'email', enabled: pref.notify_on_message)
+      pref.notifications_for_followed_topics.create(notifier_key: 'email', enabled: pref.followed_topic_emails)
+    end
+    Thredded::UserMessageboardPreference.pluck(:user_id, :messageboard_id, :followed_topic_emails)
+      .each do |user_id, messageboard_id, emails|
+      Thredded::MessageboardNotificationsForFollowedTopics.create(
+        user_id: user_id,
+        messageboard_id: messageboard_id,
+        notifier_key: 'email',
+        enabled: emails
+      )
+    end
+
+    remove_column :thredded_user_preferences, :notify_on_message
+    remove_column :thredded_user_preferences, :followed_topic_emails
+    remove_column :thredded_user_messageboard_preferences, :followed_topic_emails
+  end
+
+  def down
+    add_column :thredded_user_preferences, :notify_on_message, :boolean, default: true, null: false
+    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
+
+    drop_table :thredded_messageboard_notifications_for_followed_topics
+    drop_table :thredded_notifications_for_followed_topics
+    drop_table :thredded_notifications_for_private_topics
+  end
+end
+# rubocop:enable Metrics/MethodLength

data/db/upgrade_migrations/20170125033319_upgrade_v0_9_to_v0_10.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'thredded/base_migration'
+
+class UpgradeV09ToV010 < Thredded::BaseMigration
+  def up
+    remove_foreign_key :thredded_messageboard_users, :thredded_messageboards
+    add_foreign_key :thredded_messageboard_users, :thredded_messageboards,
+                    column: :thredded_messageboard_id, on_delete: :cascade
+    remove_foreign_key :thredded_messageboard_users, :thredded_user_details
+    add_foreign_key :thredded_messageboard_users, :thredded_user_details,
+                    column: :thredded_user_detail_id, on_delete: :cascade
+
+    create_table :thredded_user_post_notifications do |t|
+      t.references :user, null: false, index: false, type: user_id_type
+      t.references :post, null: false, index: false, type: column_type(:thredded_posts, :id)
+      t.datetime :notified_at, null: false
+      t.index :post_id, name: :index_thredded_user_post_notifications_on_post_id
+      t.index %i[user_id post_id], name: :index_thredded_user_post_notifications_on_user_id_and_post_id, unique: true
+    end
+
+    add_foreign_key :thredded_user_post_notifications,
+                    Thredded.user_class.table_name, column: :user_id, on_delete: :cascade
+    add_foreign_key :thredded_user_post_notifications,
+                    :thredded_posts, column: :post_id, on_delete: :cascade
+  end
+
+  def down
+    drop_table :thredded_user_post_notifications
+
+    remove_foreign_key :thredded_messageboard_users, :thredded_user_details
+    add_foreign_key :thredded_messageboard_users, :thredded_user_details
+    remove_foreign_key :thredded_messageboard_users, :thredded_messageboards
+    add_foreign_key :thredded_messageboard_users, :thredded_messageboards
+  end
+end

data/db/upgrade_migrations/20170312131417_upgrade_thredded_v0_10_to_v0_11.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'thredded/base_migration'
+
+class UpgradeThreddedV010ToV011 < Thredded::BaseMigration
+  def up
+    drop_table :thredded_post_notifications
+    add_column :thredded_user_preferences, :auto_follow_topics, :boolean, default: false, null: false
+    add_column :thredded_user_messageboard_preferences, :auto_follow_topics, :boolean, default: false, null: false
+  end
+
+  def down
+    remove_column :thredded_user_messageboard_preferences, :auto_follow_topics
+    remove_column :thredded_user_preferences, :auto_follow_topics
+    create_table :thredded_post_notifications do |t|
+      t.string :email, limit: 191, null: false
+      t.references :post, null: false, index: false
+      t.timestamps null: false
+      t.string :post_type, limit: 191
+      t.index %i[post_id post_type], name: :index_thredded_post_notifications_on_post
+    end
+  end
+end

data/db/upgrade_migrations/20170420163138_upgrade_thredded_v0_11_to_v0_12.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'thredded/base_migration'
+
+class UpgradeThreddedV011ToV012 < Thredded::BaseMigration
+  def up
+    FriendlyId::Slug.transaction do
+      FriendlyId::Slug.where(sluggable_type: 'Thredded::Topic').where(
+        slug: FriendlyId::Slug.group(:slug).having('count(id) > 1').select(:slug)
+      ).group_by(&:slug).each_value do |slugs|
+        slugs.from(1).each(&:delete)
+      end
+      FriendlyId::Slug.where(sluggable_type: 'Thredded::Topic')
+        .update_all(scope: nil)
+    end
+    Thredded::Topic.all.find_each do |topic|
+      # re-generate the slug
+      topic.title_will_change!
+      topic.save!
+    end
+    remove_index :thredded_topics, name: :index_thredded_topics_on_messageboard_id_and_slug
+    add_index :thredded_topics, [:slug], name: :index_thredded_topics_on_slug, unique: true
+  end
+
+  def down
+    fail ActiveRecord::MigrationError::IrreversibleMigration
+  end
+end

data/db/upgrade_migrations/20170811090735_upgrade_thredded_v0_13_to_v_014.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'thredded/base_migration'
+
+class UpgradeThreddedV013ToV014 < Thredded::BaseMigration
+  def change
+    add_column :thredded_messageboards, :locked, :boolean, null: false, default: false
+    remove_index :thredded_user_details,
+                 name: :index_thredded_user_details_on_user_id
+    add_index :thredded_user_details,
+              :user_id,
+              name: :index_thredded_user_details_on_user_id,
+              unique: true
+    remove_index :thredded_user_preferences,
+                 name: :index_thredded_user_preferences_on_user_id
+    add_index :thredded_user_preferences,
+              :user_id,
+              name: :index_thredded_user_preferences_on_user_id,
+              unique: true
+  end
+end

data/lib/generators/thredded/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create an initializer with description of configuration and defaults.
+
+Example:
+    rails generate thredded:install
+
+    This will create:
+        config/initializers/thredded.rb

data/lib/generators/thredded/install/install_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Thredded
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def set_source_paths
+        @source_paths = [
+          File.expand_path('../templates', __FILE__),
+          File.expand_path('../../../../..', __FILE__),
+        ]
+      end
+
+      def copy_initializer_file
+        copy_file \
+          'initializer.rb',
+          'config/initializers/thredded.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+# Thredded configuration
+
+# ==> User Configuration
+# The name of the class your app uses for your users.
+# By default the engine will use 'User' but if you have another name
+# for your user class - change it here.
+Thredded.user_class = 'User'
+
+# User name column, used in @mention syntax and *must* be unique.
+# This is the column used to search for users' names if/when someone is @ mentioned.
+Thredded.user_name_column = :name
+
+# User display name method, by default thredded uses the user_name_column defined above
+# You may want to use :to_s or some more elaborate method
+# Thredded.user_display_name_method = :to_s
+
+# The path (or URL) you will use to link to your users' profiles.
+# When linking to a user, Thredded will use this lambda to spit out
+# the path or url to your user. This lambda is evaluated in the view context.
+# If the lambda returns nil, a span element is returned instead of a link; so
+# setting this to always return nil effectively disables all user links.
+Thredded.user_path = lambda do |user|
+  user_path = :"#{Thredded.user_class_name.demodulize.underscore}_path"
+  main_app.respond_to?(user_path) ? main_app.send(user_path, user) : "/users/#{user.to_param}"
+end
+
+# This method is used by Thredded controllers and views to fetch the currently signed-in user
+Thredded.current_user_method = :"current_#{Thredded.user_class_name.demodulize.underscore}"
+
+# User avatar URL. rb-gravatar gem is used by default:
+Thredded.avatar_url = ->(user) { Gravatar.src(user.email, 156, 'mm') }
+
+# ==> Database Configuration
+# By default, thredded uses integers for record ID route constraints.
+# For integer based IDs (default):
+# Thredded.routes_id_constraint = /[1-9]\d*/
+# For UUID based IDs (example):
+# Thredded.routes_id_constraint = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
+
+# ==> Permissions Configuration
+# By default, thredded uses a simple permission model, where all the users can post to all message boards,
+# and admins and moderators are determined by a flag on the users table.
+
+# The name of the moderator flag column on the users table.
+Thredded.moderator_column = :admin
+# The name of the admin flag column on the users table.
+Thredded.admin_column = :admin
+
+# Whether posts and topics pending moderation are visible to regular users.
+Thredded.content_visible_while_pending_moderation = true
+
+# Whether users that are following a topic are listed on topic page.
+Thredded.show_topic_followers = false
+
+# This model can be customized further by overriding a handful of methods on the User model.
+# For more information, see app/models/thredded/user_extender.rb.
+
+# ==> Ordering configuration
+
+# How to calculate the position of messageboards in a list:
+# :position            (default) set the position manually (new messageboards go to the bottom, by creation timestamp)
+# :last_post_at_desc   most recent post first
+# :topics_count_desc   most topics first
+Thredded.messageboards_order = :position
+
+# ==> Email Configuration
+# Email "From:" field will use the following
+# Thredded.email_from = 'no-reply@example.com'
+
+# Emails going out will prefix the "Subject:" with the following string
+# Thredded.email_outgoing_prefix = '[My Forum] '
+#
+# The parent mailer for all Thredded mailers
+# Thredded.parent_mailer = 'ActionMailer::Base'
+
+# ==> View Configuration
+# Set the layout for rendering the thredded views.
+Thredded.layout = 'thredded/application'
+
+# ==> URLs
+# How Thredded generates URL slugs from text.
+
+# Default:
+# Thredded.slugifier = ->(input) { input.parameterize }
+
+# If your forum is in a language other than English, you might want to use the babosa gem instead
+# Thredded.slugifier = ->(input) { Babosa::Identifier.new(input).normalize.transliterate(:russian).to_s }
+
+# ==> Post Content Formatting
+# Customize the way Thredded handles post formatting.
+
+# Change the default html-pipeline filters used by thredded.
+# 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:
+#
+# Rails.application.config.to_prepare do
+#   Thredded::ApplicationController.module_eval do
+#     rescue_from Thredded::Errors::LoginRequired do |exception|
+#       @message = exception.message
+#       render template: 'sessions/new', status: :forbidden
+#     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
+
+# ==> Topic following
+#
+# By default, a user will be subscribed to a topic they've created. Uncomment this to not subscribe them:
+#
+# Thredded.auto_follow_when_creating_topic = false
+#
+# By default, a user will be subscribed to (follow) a topic they post in. Uncomment this to not subscribe them:
+#
+# Thredded.auto_follow_when_posting_in_topic = false
+#
+# By default, a user will be subscribed to the topic they get @-mentioned in.
+# Individual users can disable this in the Notification Settings.
+# To change the default for all users, simply change the default value of the `follow_topics_on_mention` column
+# of the `thredded_user_preferences` and `thredded_user_messageboard_preferences` tables.
+
+# ==> Notifiers
+#
+# Change how users can choose to be notified, by adding notifiers here, or removing the initializer altogether
+#
+# default:
+# Thredded.notifiers = [Thredded::EmailNotifier.new]
+#
+# none:
+# Thredded.notifiers = []
+#
+# add in (must install separate gem (under development) as well):
+# Thredded.notifiers = [Thredded::EmailNotifier.new, Thredded::PushoverNotifier.new(ENV['PUSHOVER_APP_ID'])]

data/lib/tasks/thredded_tasks.rake

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+namespace :thredded do
+  namespace :install do
+    desc 'Copy emoji to the Rails `public/emoji` directory'
+    task :emoji do
+      require 'emoji'
+
+      target = Rails.application.root.join('public')
+      STDERR.puts "Copying emoji to #{target}"
+      `mkdir -p '#{target}' && cp -Rp '#{Emoji.images_path}/emoji' '#{target}'`
+    end
+  end
+end

data/lib/thredded.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+# Backend
+require 'pundit'
+require 'active_record_union'
+require 'db_text_search'
+require 'friendly_id'
+require 'html/pipeline'
+require 'html/pipeline/sanitization_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/formatting_demo_content'
+require 'thredded/html_pipeline/at_mention_filter'
+require 'thredded/html_pipeline/autolink_filter'
+require 'thredded/html_pipeline/kramdown_filter'
+require 'thredded/html_pipeline/onebox_filter'
+require 'thredded/html_pipeline/wrap_iframes_filter'
+
+# Asset compilation
+require 'autoprefixer-rails'
+require 'timeago_js'
+require 'sprockets/es6'
+
+require 'thredded/version'
+require 'thredded/engine'
+require 'thredded/errors'
+
+require 'thredded/view_hooks/config'
+require 'thredded/view_hooks/renderer'
+
+# Require these explicitly so that they do not need to be required if used in the initializer:
+require 'thredded/content_formatter'
+require 'thredded/email_transformer'
+require 'thredded/base_notifier'
+
+require 'thredded/collection_to_strings_with_cache_renderer'
+
+module Thredded
+  mattr_accessor \
+    :autocomplete_min_length,
+    :active_user_threshold,
+    :avatar_url,
+    :email_from,
+    :email_outgoing_prefix,
+    :layout,
+    :messageboards_order,
+    :routes_id_constraint,
+    :user_display_name_method,
+    :user_name_column,
+    :user_path
+
+  # @return [Symbol] The name of the method used by Thredded controllers and views to fetch the currently signed-in user
+  mattr_accessor :current_user_method
+
+  # @return [Symbol] The name of the moderator flag column on the users table for the default permissions model
+  mattr_accessor :moderator_column
+
+  # @return [Symbol] The name of the admin flag column on the users table for the default permissions model
+  mattr_accessor :admin_column
+
+  # @return [Boolean] Whether posts that are pending moderation are visible to regular users.
+  mattr_accessor :content_visible_while_pending_moderation
+
+  # @return [Array] The notifiers, by default just the EmailNotifier
+  mattr_accessor :notifiers
+
+  # @return [Boolean] Whether users that are following a topic are listed on topic page.
+  mattr_accessor :show_topic_followers
+
+  # @return [Symbol] The name of the method used by Thredded to display users
+  mattr_accessor :user_display_name_method
+
+  # @return [String] The name of the parent mailer class for Thredded mailers.
+  mattr_accessor :parent_mailer
+  self.parent_mailer = 'ActionMailer::Base'
+
+  # @return [Proc] The proc that Thredded uses to generate URL slugs from text.
+  mattr_accessor :slugifier
+  self.slugifier = ->(input) { input.parameterize }
+
+  # @return [Boolean] Whether the user should get subscribed to a new topic they've created.
+  mattr_accessor :auto_follow_when_creating_topic
+  self.auto_follow_when_creating_topic = true
+
+  # @return [Boolean] Whether the user should get subscribed to a topic after posting in it.
+  mattr_accessor :auto_follow_when_posting_in_topic
+  self.auto_follow_when_posting_in_topic = true
+
+  # @return [String] The name of the user class
+  mattr_reader :user_class_name
+
+  self.active_user_threshold = 5.minutes
+  self.admin_column = :admin
+  self.avatar_url = ->(user) { Gravatar.src(user.email, 156, 'mm') }
+  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
+  self.routes_id_constraint = /[1-9]\d*/
+
+  # @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.notifiers
+    @@notifiers ||= [Thredded::EmailNotifier.new] # rubocop:disable Style/ClassVars
+  end
+
+  def self.notifiers=(notifiers)
+    notifiers.each { |notifier| BaseNotifier.validate_notifier(notifier) }
+    @@notifiers = notifiers # rubocop:disable Style/ClassVars
+  end
+
+  def self.user_display_name_method
+    @@user_display_name_method || user_name_column
+  end
+
+  # @param value [:position, :topics_count_desc, :last_post_at_desc]
+  def self.messageboards_order=(value)
+    case value
+    when :position, :topics_count_desc, :last_post_at_desc
+      @@messageboards_order = value # rubocop:disable Style/ClassVars
+    else
+      fail ArgumentError, "Unexpected value for Thredded.messageboards_order: #{value}"
+    end
+  end
+
+  # @param user_class_name [String]
+  def self.user_class=(user_class_name)
+    unless user_class_name.is_a?(String)
+      fail "Thredded.user_class must be set to a String, got #{user_class_name.inspect}"
+    end
+    @@user_class_name = user_class_name # rubocop:disable Style/ClassVars
+  end
+
+  # @return [Class<Thredded::UserExtender>] the user class from the host application.
+  def self.user_class
+    # This is nil before the initializer is installed.
+    return nil if @@user_class_name.nil?
+    @@user_class_name.constantize
+  end
+
+  # @param view_context [Object] context to execute the lambda in.
+  # @param user [Thredded.user_class]
+  # @return [String] path to the user evaluated in the specified context.
+  def self.user_path(view_context, user)
+    view_context.instance_exec(user, &@@user_path)
+  end
+
+  # Whether the layout is a thredded layout as opposed to the application layout.
+  def self.standalone_layout?
+    layout.is_a?(String) && layout.start_with?('thredded/')
+  end
+
+  # Returns a view for the given posts' scope, applying read permission filters to the scope.
+  # Can be used in main_app, e.g. for showing the recent user posts on the profile page.
+  #
+  # @param scope [ActiveRecord::Relation<Thredded::Post>] the posts scope for which to return the view.
+  # @param current_user [Thredded.user_class, nil] the user viewing the posts.
+  # @return [PostsPageView]
+  def self.posts_page_view(scope:, current_user:)
+    current_user ||= Thredded::NullUser.new
+    PostsPageView.new(
+      current_user,
+      Pundit.policy_scope!(current_user, scope)
+        .where(messageboard_id: Pundit.policy_scope!(current_user, Thredded::Messageboard.all).pluck(:id))
+        .includes(:postable)
+    )
+  end
+
+  # @api private
+  def self.rails_gte_51?
+    @rails_gte_51 = (Rails.gem_version >= Gem::Version.new('5.1.0')) if @rails_gte_51.nil?
+    @rails_gte_51
+  end
+end