thredded 0.16.15 → 1.0.1

data/lib/thredded/collection_to_strings_with_cache_renderer.rb

@@ -22,17 +22,18 @@ module Thredded
     def render_collection_to_strings_with_cache( # rubocop:disable Metrics/ParameterLists
       view_context, collection:, partial:, expires_in:, render_threads: self.class.render_threads, locals: {}, **opts
     )
-      template = @lookup_context.find_template(partial, [], true, locals, {})
+      template = @lookup_context.find_template(partial, [], true, locals.keys, {})
       collection = collection.to_a
-      instrument(:collection, identifier: template.identifier, count: collection.size) do |instrumentation_payload|
+      ActiveSupport::Notifications.instrument(:collection,
+                                              identifier: template.identifier,
+                                              count: collection.size) do |instrumentation_payload|
         return [] if collection.blank?
-        keyed_collection = collection.each_with_object({}) do |item, hash|
-          key = ActiveSupport::Cache.expand_cache_key(
-            view_context.cache_fragment_name(item, virtual_path: template.virtual_path), :views
-          )
-          # #read_multi & #write may require key mutability, Dalli 2.6.0.
-          hash[key.frozen? ? key.dup : key] = item
-        end
+
+        # Result is a hash with the key represents the
+        # key used for cache lookup and the value is the item
+        # on which the partial is being rendered
+        keyed_collection, ordered_keys = collection_by_cache_keys(collection, view_context, template)
+
         cache = collection_cache
         cached_partials = cache.read_multi(*keyed_collection.keys)
         instrumentation_payload[:cache_hits] = cached_partials.size if instrumentation_payload
@@ -44,9 +45,9 @@ module Thredded
           partial: partial, locals: locals, **opts
         ).each
 
-        keyed_collection.map do |cache_key, item|
-          [item, cached_partials[cache_key] || rendered_partials.next.tap do |rendered|
-            cache.write(cache_key, rendered, expires_in: expires_in)
+        ordered_keys.map do |cache_key|
+          [keyed_collection[cache_key], cached_partials[cache_key] || rendered_partials.next.tap do |rendered|
+            cached_partials[cache_key] = cache.write(cache_key, rendered, expires_in: expires_in)
           end]
         end
       end
@@ -54,16 +55,24 @@ module Thredded
 
     private
 
-    def collection_cache
-      if ActionView::PartialRenderer.respond_to?(:collection_cache)
-        # Rails 5.0+
-        ActionView::PartialRenderer.collection_cache
-      else
-        # Rails 4.2.x
-        Rails.application.config.action_controller.cache_store
+    def collection_by_cache_keys(collection, view, template)
+      digest_path = digest_path_from_template(view, template)
+
+      collection.each_with_object([{}, []]) do |item, (hash, ordered_keys)|
+        key = expanded_cache_key(item, view, template, digest_path)
+        ordered_keys << key
+        hash[key] = item
       end
     end
 
+    def expanded_cache_key(key, view, template, digest_path)
+      key = combined_fragment_cache_key(
+        view,
+        cache_fragment_name(view, key, virtual_path: template.virtual_path, digest_path: digest_path)
+      )
+      key.frozen? ? key.dup : key # #read_multi & #write may require mutability, Dalli 2.6.0.
+    end
+
     # @return [Array<String>]
     def render_partials(view_context, collection:, render_threads:, **opts)
       return [] if collection.empty?
@@ -72,25 +81,79 @@ module Thredded
         render_partials_serial(view_context, collection, opts)
       else
         collection.each_slice(collection.size / num_threads).map do |slice|
-          Thread.start { render_partials_serial(view_context.dup, slice, opts) }
+          Thread.start do
+            # `ActionView::PartialRenderer` mutates the contents of `opts[:locals]`, `opts[:locals][:as]` in particular:
+            # https://github.com/rails/rails/blob/v6.0.2.1/actionview/lib/action_view/renderer/partial_renderer.rb#L379
+            # https://github.com/rails/rails/blob/v6.0.2.1/actionview/lib/action_view/renderer/partial_renderer.rb#L348-L356
+            opts[:locals] = opts[:locals].dup if opts[:locals]
+            ActiveRecord::Base.connection_pool.with_connection do
+              render_partials_serial(view_context.dup, slice, opts)
+            end
+          end
         end.flat_map(&:value)
       end
     end
 
-    # @param [Array<Object>] collection
-    # @param [Hash] opts
-    # @param view_context
-    # @return [Array<String>]
-    def render_partials_serial(view_context, collection, opts)
-      partial_renderer = ActionView::PartialRenderer.new(@lookup_context)
-      collection.map { |object| render_partial(partial_renderer, view_context, opts.merge(object: object)) }
+    if Thredded::Compat.rails_gte_61?
+      # @param [Array<Object>] collection
+      # @param [Hash] opts
+      # @param view_context
+      # @return [Array<String>]
+      def render_partials_serial(view_context, collection, opts)
+        # https://github.com/rails/rails/pull/38594
+        collection.map do |object|
+          renderer = ActionView::ObjectRenderer.new(@lookup_context, opts)
+          renderer.render_object_with_partial(object, opts[:partial], view_context, nil).body
+        end
+      end
+    else
+      def render_partials_serial(view_context, collection, opts)
+        partial_renderer = ActionView::PartialRenderer.new(@lookup_context)
+        collection.map { |object| render_partial(partial_renderer, view_context, **opts.merge(object: object)) }
+      end
     end
 
-    if Rails::VERSION::MAJOR >= 6
+    def collection_cache
+      ActionView::PartialRenderer.collection_cache
+    end
+
+    def combined_fragment_cache_key(view, key)
+      view.combined_fragment_cache_key(key)
+    end
+
+    if Thredded::Compat.rails_gte_60?
+      def cache_fragment_name(view, key, virtual_path:, digest_path:)
+        if Thredded::Compat.rails_gte_61?
+          view.cache_fragment_name(key, digest_path: digest_path)
+        else
+          view.cache_fragment_name(key, virtual_path: virtual_path, digest_path: digest_path)
+        end
+      end
+
+      def digest_path_from_template(view, template)
+        view.digest_path_from_template(template)
+      end
+
       def render_partial(partial_renderer, view_context, opts)
         partial_renderer.render(view_context, opts, nil).body
       end
     else
+      def cache_fragment_name(_view, key, virtual_path:, digest_path:)
+        if digest_path
+          ["#{virtual_path}:#{digest_path}", key]
+        else
+          [virtual_path, key]
+        end
+      end
+
+      def digest_path_from_template(view, template)
+        ActionView::Digestor.digest(
+          name: template.virtual_path,
+          finder: @lookup_context,
+          dependencies: view.view_cache_dependencies
+        ).presence
+      end
+
       def render_partial(partial_renderer, view_context, opts)
         partial_renderer.render(view_context, opts, nil)
       end

data/lib/thredded/compat.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Thredded
+  module Compat
+    class << self
+      # @api private
+      def rails_gte_60?
+        @rails_gte_60 = (Rails.gem_version >= Gem::Version.new('6.0.0')) if @rails_gte_60.nil?
+        @rails_gte_60
+      end
+
+      # @api private
+      def rails_gte_61?
+        @rails_gte_61 = (Rails.gem_version >= Gem::Version.new('6.1.0')) if @rails_gte_61.nil?
+        @rails_gte_61
+      end
+
+      if Rails.gem_version >= Gem::Version.new('7.0.0')
+        # @api private
+        def association_preloader(records:, associations:, scope:)
+          ActiveRecord::Associations::Preloader.new(
+            records: records, associations: associations, scope: scope
+          ).call
+        end
+      else
+        # @api private
+        def association_preloader(records:, associations:, scope:)
+          ActiveRecord::Associations::Preloader.new.preload(
+            records, associations, scope
+          )
+        end
+      end
+    end
+  end
+end

data/lib/thredded/content_formatter.rb

@@ -4,8 +4,11 @@ module Thredded
   # Generates HTML from content source.
   class ContentFormatter
     class << self
-      # Sanitization whitelist options.
-      attr_accessor :whitelist
+      # Sanitization allowlist options.
+      attr_accessor :allowlist
+
+      # TODO: v2.0: drop alias and just use allowlist
+      alias_attribute :whitelist, :allowlist
 
       # Filters that run before processing the markup.
       # input: markup, output: markup.
@@ -26,16 +29,29 @@ module Thredded
       # Filters that run after sanitization
       # input: sanitized html, output: html
       attr_accessor :after_sanitization_filters
+
+      # TODO: v1.1: only allow html-pipeline >= 2.14.1 and drop this
+      def sanitization_filter_uses_allowlist?
+        defined?(HTML::Pipeline::SanitizationFilter::ALLOWLIST)
+      end
+
+      def sanitization_filter_allowlist_config
+        if sanitization_filter_uses_allowlist?
+          HTML::Pipeline::SanitizationFilter::ALLOWLIST
+        else
+          HTML::Pipeline::SanitizationFilter::WHITELIST
+        end
+      end
     end
 
-    self.whitelist = HTML::Pipeline::SanitizationFilter::WHITELIST.deep_merge(
-      elements: HTML::Pipeline::SanitizationFilter::WHITELIST[:elements] + %w[abbr iframe span figure figcaption],
-      transformers: HTML::Pipeline::SanitizationFilter::WHITELIST[:transformers] + [
+    self.allowlist = sanitization_filter_allowlist_config.deep_merge(
+      elements: sanitization_filter_allowlist_config[:elements] + %w[abbr iframe span figure figcaption],
+      transformers: sanitization_filter_allowlist_config[:transformers] + [
         ->(env) {
           next unless env[:node_name] == 'a'
           a_tag = env[:node]
           a_tag['href'] ||= '#'
-          if a_tag['href'] =~ %r{^(?:[a-z]+:)?//}
+          if %r{^(?:[a-z]+:)?//}.match?(a_tag['href'])
             a_tag['target'] = '_blank'
             a_tag['rel']    = 'nofollow noopener'
           end
@@ -49,7 +65,7 @@ module Thredded
         'img'    => %w[src longdesc class],
         'th'     => %w[style],
         'td'     => %w[style],
-        :all     => HTML::Pipeline::SanitizationFilter::WHITELIST[:attributes][:all] +
+        :all     => sanitization_filter_allowlist_config[:attributes][:all] +
           %w[aria-expanded aria-label aria-labelledby aria-live aria-hidden aria-pressed role],
       },
       css: {
@@ -134,9 +150,15 @@ module Thredded
 
     # @return [Hash] options for HTML::Pipeline.new
     def content_pipeline_options
+      option = if self.class.sanitization_filter_uses_allowlist?
+                 :allowlist
+               else
+                 # TODO: v1.1: only allow html-pipeline >= 2.14.1 and drop this
+                 :whitelist
+               end
       {
         asset_root: Rails.application.config.action_controller.asset_host || '',
-        whitelist: ContentFormatter.whitelist
+        option => ContentFormatter.allowlist
       }
     end
   end

data/lib/thredded/database_seeder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'factory_bot'
-require_relative '../../spec/support/features/fake_content'
+require_relative '../../spec/support/system/fake_content'
 
 # rubocop:disable HandleExceptions
 begin
@@ -40,6 +40,7 @@ module Thredded
     end
 
     include LogTime
+    include Thredded::ApplicationHelper
 
     SKIP_CALLBACKS = [
       [Thredded::Post, :commit, :after, :update_parent_last_user_and_time_from_last_post, on: %i[create destroy]],
@@ -131,7 +132,13 @@ module Thredded
     end
 
     def fake_post_contents
-      @fake_post_contents ? @fake_post_contents.sample : FakeContent.post_content
+      with_mentions(@fake_post_contents ? @fake_post_contents.sample : FakeContent.post_content)
+    end
+
+    def with_mentions(post, mentions_count: rand(3))
+      return post if mentions_count.zero?
+
+      ([post] + Array.new(mentions_count).map { user_mention(@users.sample) }).join(' ')
     end
 
     def first_user
@@ -255,9 +262,9 @@ module Thredded
 
       delegate :log, to: :seeder
 
-      def find_or_create(*args)
+      def find_or_create(*args, **kwargs)
         return @stored if @stored
-        @stored = (find || create(*args))
+        @stored = (find || create(*args, **kwargs))
       end
 
       def range_of_dates_in_order(up_to: Time.zone.now, count: 1)

data/lib/thredded/db_tools.rb

@@ -10,12 +10,10 @@ module Thredded
         verbose_was = ActiveRecord::Migration.verbose
         ActiveRecord::Migration.verbose = !quiet
         migrate =
-          if Rails.gem_version >= Gem::Version.new('6.0.0.rc2')
+          if Thredded::Compat.rails_gte_60?
             -> { ActiveRecord::MigrationContext.new(paths, ActiveRecord::SchemaMigration).migrate(nil, &filter) }
-          elsif Rails::VERSION::STRING >= '5.2'
+          else # Rails 5.2
             -> { ActiveRecord::MigrationContext.new(paths).migrate(nil, &filter) }
-          else
-            -> { ActiveRecord::Migrator.migrate(paths, &filter) }
           end
         if quiet
           silence_active_record(&migrate)
@@ -61,7 +59,7 @@ module Thredded
           silence_active_record do
             ActiveRecord::Base.transaction do
               statements.each do |statement|
-                connection.execute(statement) unless statement =~ /(BEGIN TRANSACTION|COMMIT)/
+                connection.execute(statement) unless /(BEGIN TRANSACTION|COMMIT)/.match?(statement)
               end
             end
           end

data/lib/thredded/email_transformer.rb

@@ -17,8 +17,8 @@ module Thredded
     end
     @transformers = [Onebox, Spoiler]
 
-    # @param doc [Nokogiri::HTML::Document]
-    def self.call(doc)
+    # @param dom [Nokogiri::HTML::Document]
+    def self.call(doc, *)
       transformers.each { |transformer| transformer.call(doc) }
     end
   end

data/lib/thredded/engine.rb

@@ -12,7 +12,7 @@ module Thredded
 
     config.to_prepare do
       Thredded::AllViewHooks.reset_instance!
-      Thredded.user_class.send(:include, Thredded::UserExtender) if Thredded.user_class
+      Thredded.user_class&.send(:include, Thredded::UserExtender)
     end
 
     initializer 'thredded.setup_assets' do

data/lib/thredded/formatting_demo_content.rb

@@ -7,35 +7,35 @@ module Thredded
       attr_accessor :parts
     end
     self.parts = [
-      <<-'MARKDOWN',
-#### Spoilers
+      <<~'MARKDOWN',
+        #### Spoilers
 
-Use `<spoiler></spoiler>` tags to create spoiler boxes like this one:
+        Use `<spoiler></spoiler>` tags to create spoiler boxes like this one:
 
-<spoiler>
-Harry Potter books are better than the movies.
+        <spoiler>
+        Harry Potter books are better than the movies.
 
-![nyancat](https://storage.googleapis.com/glebm-stuff/nyancat.gif)
+        ![nyancat](https://storage.googleapis.com/glebm-stuff/nyancat.gif)
 
-https://www.youtube.com/watch?v=5lBBUPVuusM
-</spoiler>
+        https://www.youtube.com/watch?v=5lBBUPVuusM
+        </spoiler>
 
-#### Oneboxes
+        #### Oneboxes
 
-URLs of supported resources are replaced with boxes like these:
+        URLs of supported resources are replaced with boxes like these:
 
-**Twitter** `https://twitter.com/thredded/status/838824533477982209`:
-https://twitter.com/thredded/status/838824533477982209
-**StackExchange** `http://codegolf.stackexchange.com/questions/45701`:
-http://codegolf.stackexchange.com/questions/45701
-**Amazon** `https://www.amazon.co.uk/dp/0521797071`:
-https://www.amazon.co.uk/dp/0521797071
-**YouTube** `https://www.youtube.com/watch?v=1QP7elXwpLw`:
-https://www.youtube.com/watch?v=1QP7elXwpLw
-**Google Maps** `https://goo.gl/maps/R6nj3Qwf2LR2`:
-https://goo.gl/maps/R6nj3Qwf2LR2
+        **Twitter** `https://twitter.com/thredded/status/838824533477982209`:
+        https://twitter.com/thredded/status/838824533477982209
+        **StackExchange** `http://codegolf.stackexchange.com/questions/45701`:
+        http://codegolf.stackexchange.com/questions/45701
+        **Amazon** `https://www.amazon.co.uk/dp/0521797071`:
+        https://www.amazon.co.uk/dp/0521797071
+        **YouTube** `https://www.youtube.com/watch?v=1QP7elXwpLw`:
+        https://www.youtube.com/watch?v=1QP7elXwpLw
+        **Google Maps** `https://goo.gl/maps/R6nj3Qwf2LR2`:
+        https://goo.gl/maps/R6nj3Qwf2LR2
 
-Many more resources are [supported](https://github.com/discourse/onebox/tree/master/lib/onebox/engine). Powered by the [onebox](https://github.com/discourse/onebox) library.
+        Many more resources are [supported](https://github.com/discourse/onebox/tree/main/lib/onebox/engine). Powered by the [onebox](https://github.com/discourse/onebox) library.
       MARKDOWN
     ]
   end

data/lib/thredded/html_pipeline/at_mention_filter.rb

@@ -47,7 +47,7 @@ module Thredded
         return if names.blank? || @users_provider.nil?
         @users_provider.call(names, @users_provider_scope).each do |user|
           name = user.send(Thredded.user_name_column)
-          maybe_quoted_name = name =~ /[., ()]/ ? %("#{name}") : name
+          maybe_quoted_name = /[., ()]/.match?(name) ? %("#{name}") : name
           url = Thredded.user_path(@view_context, user)
           text_node_html.gsub!(
             /(^|[\s>])(@#{Regexp.escape maybe_quoted_name})([^a-z\d]|$)/i,

data/lib/thredded/html_pipeline/onebox_filter.rb

@@ -24,7 +24,7 @@ module Thredded
             next unless env[:node_name] == 'a'
             a_tag = env[:node]
             a_tag['href'] ||= '#'
-            if a_tag['href'] =~ %r{^(?:[a-z]+:)?//}
+            if %r{^(?:[a-z]+:)?//}.match?(a_tag['href'])
               a_tag['target'] = '_blank'
               a_tag['rel']    = 'nofollow noopener'
             else
@@ -68,9 +68,9 @@ module Thredded
 
       def render_onebox(url)
         preview = Onebox.preview(url, onebox_options(url))
-        if context[:onebox_placeholders]
+        if context[:onebox_placeholders] && (placeholder_html = preview.placeholder_html.presence)
           %(<p><a href="#{ERB::Util.html_escape(url)}" target="_blank" rel="nofollow noopener">) \
-          "#{preview.placeholder_html}</a></p>"
+          "#{placeholder_html}</a></p>"
         else
           preview.to_s.strip
         end

data/lib/thredded/html_pipeline/utils.rb

@@ -40,7 +40,7 @@ module Thredded
       end
 
       def node_name?(node, node_name)
-        node && node.node_name && node.node_name.casecmp(node_name).zero?
+        node&.node_name && node.node_name.casecmp(node_name).zero?
       end
     end
   end

data/lib/thredded/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Thredded
-  VERSION = '0.16.15'
+  VERSION = '1.0.1'
 end

data/lib/thredded.rb

@@ -9,7 +9,7 @@ require 'html/pipeline'
 require 'html/pipeline/sanitization_filter'
 require 'rinku'
 require 'kaminari'
-require 'rb-gravatar'
+require 'rails_gravatar'
 require 'active_job'
 require 'inline_svg'
 
@@ -32,6 +32,7 @@ require 'sprockets/es6'
 require 'sassc-rails'
 
 require 'thredded/version'
+require 'thredded/compat'
 require 'thredded/engine'
 require 'thredded/errors'
 
@@ -48,15 +49,6 @@ require 'thredded/collection_to_strings_with_cache_renderer'
 
 require 'thredded/webpack_assets'
 
-if Rails::VERSION::MAJOR < 5
-  begin
-    require 'where-or'
-  rescue LoadError
-    $stderr.puts "\nthredded: Please add gem 'where-or' to your Gemfile"
-    exit 1 # rubocop:disable Rails/Exit
-  end
-end
-
 module Thredded # rubocop:disable Metrics/ModuleLength
   class << self
     #== User
@@ -252,22 +244,10 @@ module Thredded # rubocop:disable Metrics/ModuleLength
           .includes(:postable)
       )
     end
-
-    # @api private
-    def rails_gte_51?
-      @rails_gte_51 = (Rails.gem_version >= Gem::Version.new('5.1.0')) if @rails_gte_51.nil?
-      @rails_gte_51
-    end
-
-    # @api private
-    def rails_supports_csp_nonce?
-      @rails_supports_csp_nonce = (Rails.gem_version >= Gem::Version.new('5.2.0')) if @rails_supports_csp_nonce.nil?
-      @rails_supports_csp_nonce
-    end
   end
 
   self.user_name_column = :name
-  self.avatar_url = ->(user) { Gravatar.src(user.email, 156, 'mm') }
+  self.avatar_url = ->(user) { RailsGravatar.src(user.email, 156, 'mm') }
   self.admin_column = :admin
 
   self.content_visible_while_pending_moderation = true