thredded 1.0.1 → 1.2.0

data/lib/thredded/collection_to_strings_with_cache_renderer.rb

@@ -47,7 +47,8 @@ module Thredded
 
         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)
+            cache.write(cache_key, rendered, expires_in: expires_in)
+            cached_partials[cache_key] = rendered
           end]
         end
       end
@@ -59,16 +60,16 @@ module Thredded
       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)
+        key = expanded_cache_key(item, view, digest_path)
         ordered_keys << key
         hash[key] = item
       end
     end
 
-    def expanded_cache_key(key, view, template, digest_path)
+    def expanded_cache_key(key, view, digest_path)
       key = combined_fragment_cache_key(
         view,
-        cache_fragment_name(view, key, virtual_path: template.virtual_path, digest_path: digest_path)
+        cache_fragment_name(view, key, digest_path: digest_path)
       )
       key.frozen? ? key.dup : key # #read_multi & #write may require mutability, Dalli 2.6.0.
     end
@@ -82,34 +83,38 @@ module Thredded
       else
         collection.each_slice(collection.size / num_threads).map do |slice|
           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)
+              render_partials_serial(view_context.dup, slice, dup_opts(opts))
             end
           end
         end.flat_map(&:value)
       end
     end
 
-    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
+    # `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
+    def dup_opts(opts)
+      if opts[:locals]
+        opts = opts.dup
+        # sometimes have a thread safe :users_provider, preserve that for performance reasons
+        # hence not doing a deep_dup
+        opts[:locals] = opts[:locals].dup
+        opts
+      else
+        opts.dup
       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
+
+    # @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
 
@@ -121,42 +126,16 @@ module Thredded
       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 cache_fragment_name(view, key, digest_path:)
+      view.cache_fragment_name(key, digest_path: digest_path)
+    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 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)
-      end
+    def render_partial(partial_renderer, view_context, opts)
+      partial_renderer.render(view_context, opts, nil).body
     end
   end
 end

data/lib/thredded/compat.rb

@@ -4,31 +4,23 @@ 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
+      def rails_gte_71?
+        @rails_gte_71 = (Rails.gem_version >= Gem::Version.new('7.1.0')) if @rails_gte_71.nil?
+        @rails_gte_71
       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
+      def rails_gte_72?
+        @rails_gte_72 = (Rails.gem_version >= Gem::Version.new('7.2.0')) if @rails_gte_72.nil?
+        @rails_gte_72
       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
+      # @api private
+      # TODO: inline this or put it somewhere else as it's no longer specific to a rails version
+      def association_preloader(records:, associations:, scope:)
+        ActiveRecord::Associations::Preloader.new(
+          records: records, associations: associations, scope: scope
+        ).call
       end
     end
   end

data/lib/thredded/content_formatter.rb

@@ -8,7 +8,15 @@ module Thredded
       attr_accessor :allowlist
 
       # TODO: v2.0: drop alias and just use allowlist
-      alias_attribute :whitelist, :allowlist
+      # @deprecated use allowlist
+      def whitelist
+        ActiveSupport::Deprecation.warn(<<~MESSAGE.squish)
+          ContentFormatter.whitelist is deprecated and will be removed in Thredded 2.0.
+          Use ContentFormatter.allowlist instead
+        MESSAGE
+
+        allowlist
+      end
 
       # Filters that run before processing the markup.
       # input: markup, output: markup.
@@ -30,17 +38,8 @@ module Thredded
       # 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
+        HTML::Pipeline::SanitizationFilter::ALLOWLIST
       end
     end
 
@@ -150,15 +149,9 @@ 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 || '',
-        option => ContentFormatter.allowlist
+        allowlist: ContentFormatter.allowlist
       }
     end
   end

data/lib/thredded/database_seeder.rb

@@ -10,6 +10,7 @@ rescue NameError
 end
 # rubocop:enable HandleExceptions
 module Thredded
+  # rubocop:disable Metrics/MethodLength
   class DatabaseSeeder # rubocop:disable Metrics/ClassLength
     module LogTime
       def self.included(base)
@@ -60,8 +61,16 @@ module Thredded
     def self.with_seeder_tweaks
       # Disable callbacks to avoid creating notifications and performing unnecessary updates
       DISABLE_COUNTER_CACHE.each do |klass|
-        klass.send(:alias_method, :original_each_counter_cached_associations, :each_counter_cached_associations)
-        klass.send(:define_method, :each_counter_cached_associations) {}
+        if Thredded::Compat.rails_gte_72?
+          klass.class_eval do
+            class_attribute :original_counter_cached_association_names
+            self.original_counter_cached_association_names = counter_cached_association_names
+            self.counter_cached_association_names = []
+          end
+        else
+          klass.send(:alias_method, :original_each_counter_cached_associations, :each_counter_cached_associations)
+          klass.send(:define_method, :each_counter_cached_associations) {}
+        end
       end
       SKIP_CALLBACKS.each { |(klass, *args)| delete_callbacks(klass, *args) }
       WRITEABLE_READONLY_ATTRIBUTES.each { |(klass, attr)| klass.readonly_attributes.delete(attr) }
@@ -71,9 +80,15 @@ module Thredded
     ensure
       # Re-enable callbacks and counter cache
       DISABLE_COUNTER_CACHE.each do |klass|
-        klass.send(:remove_method, :each_counter_cached_associations)
-        klass.send(:alias_method, :each_counter_cached_associations, :original_each_counter_cached_associations)
-        klass.send(:remove_method, :original_each_counter_cached_associations)
+        if Thredded::Compat.rails_gte_72?
+          klass.class_eval do
+            self.counter_cached_association_names = original_counter_cached_association_names
+          end
+        else
+          klass.send(:remove_method, :each_counter_cached_associations)
+          klass.send(:alias_method, :each_counter_cached_associations, :original_each_counter_cached_associations)
+          klass.send(:remove_method, :original_each_counter_cached_associations)
+        end
       end
       SKIP_CALLBACKS.each do |(klass, *args)|
         args = args.dup
@@ -150,9 +165,7 @@ module Thredded
     end
 
     def user_details
-      @user_details ||= users.each_with_object({}) do |user, hash|
-        hash[user] = user.thredded_user_detail
-      end
+      @user_details ||= users.index_with(&:thredded_user_detail)
     end
 
     def first_messageboard
@@ -175,7 +188,7 @@ module Thredded
       end
     end
 
-    log_method_time def update_messageboards_data(**) # `**` for Ruby < 2.5, see https://bugs.ruby-lang.org/issues/10856
+    log_method_time def update_messageboards_data(**)
       log 'Updating messageboards data...'
       Messageboard.all.each do |messageboard|
         messageboard.update_last_topic!
@@ -330,7 +343,7 @@ module Thredded
     class FirstMessageboard < FirstSeedData
       MODEL_CLASS = Messageboard
 
-      log_method_time def create(**) # `**` for Ruby < 2.5, see https://bugs.ruby-lang.org/issues/10856
+      log_method_time def create(**)
         log 'Creating a messageboard...'
         @first_messageboard = FactoryBot.create(
           :messageboard,
@@ -384,7 +397,8 @@ module Thredded
     class Posts < CollectionSeedData
       MODEL_CLASS = Post
 
-      log_method_time def create(count: (1..1), topics: seeder.topics) # rubocop:disable Metrics/MethodLength
+      log_method_time def create(count: (1..1), topics: seeder.topics)
+        # rubocop:disable Metrics/MethodLength
         log "Creating #{count} additional posts in each topic..."
         topics.flat_map do |topic|
           last_post_at = random_duration(0..256.hours).ago
@@ -446,4 +460,5 @@ module Thredded
       end
     end
   end
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/thredded/db_tools.rb

@@ -10,11 +10,7 @@ module Thredded
         verbose_was = ActiveRecord::Migration.verbose
         ActiveRecord::Migration.verbose = !quiet
         migrate =
-          if Thredded::Compat.rails_gte_60?
-            -> { ActiveRecord::MigrationContext.new(paths, ActiveRecord::SchemaMigration).migrate(nil, &filter) }
-          else # Rails 5.2
-            -> { ActiveRecord::MigrationContext.new(paths).migrate(nil, &filter) }
-          end
+          -> { ActiveRecord::MigrationContext.new(paths).migrate(nil, &filter) }
         if quiet
           silence_active_record(&migrate)
         else

data/lib/thredded/engine.rb

@@ -20,5 +20,14 @@ module Thredded
         thredded_manifest.js
       ]
     end
+
+    config.after_initialize do |app|
+      if !Rails.env.production? && app.assets.preprocessors.keys.exclude?('text/scss')
+        fail [
+          'Thredded requires a Sass compiler to be registered in Sprockets.',
+          %(Please add "sassc-rails" or "dartsass-sprockets" to your application Gemfile.),
+        ].join(' ')
+      end
+    end
   end
 end

data/lib/thredded/version.rb

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

data/lib/thredded.rb

@@ -2,7 +2,6 @@
 
 # Backend
 require 'pundit'
-require 'active_record_union'
 require 'db_text_search'
 require 'friendly_id'
 require 'html/pipeline'
@@ -29,7 +28,6 @@ require 'thredded/users_provider'
 require 'autoprefixer-rails'
 require 'timeago_js'
 require 'sprockets/es6'
-require 'sassc-rails'
 
 require 'thredded/version'
 require 'thredded/compat'