thredded 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c38b0b431b19a2a3bcb74955be64a67835d60870754e65436e8498ca67729bc8
-  data.tar.gz: 1b9827d5ed79af58f52c86e5badb430e1b44dfaff0381fde2390ad08ce436b26
+  metadata.gz: 19cde941264a9f9b9427694c27cc5f2a668fd18debbfe459d3fc58087e5636bf
+  data.tar.gz: 0d4eec1e395f2265783f9283ad958ec2a7f486a017bb961af87b26c2fd711c20
 SHA512:
-  metadata.gz: 43a2362878a9949d88097d77efe90c7997483e1c70f0fb505ffff1fa06e2097036d6ae6aff829120a406bac06b9e1cbb0879c1b614cf0c8205f837044a6fb105
-  data.tar.gz: 6f59d7de62c088da6ef53bb474ab02bdc666313ff5e050f86c3a1414a7371d93d60874008dc2ce68b8df8a7601754fe9771fef1804e11e1a4060620968465917
+  metadata.gz: f7d6aa4fd6d1eaecda06e839b757d6fa2bbf7fd24ae6ef4ba3c238a5d8880baeff1be6b9ee2aae21b34c8f844d0aa5eb5c41a1f70e7841cbe867a900e29b980a
+  data.tar.gz: 04af99833299683e35b13468e957bd75880a1627db1ff6c9ab53e1678f99842b273cc50ed529c9cddeedb7600c0d54b404550fd8858a7901346d6c72df77bdb2

data/README.md

@@ -1,6 +1,6 @@
 # Thredded [![Code Climate](https://codeclimate.com/github/thredded/thredded/badges/gpa.svg)](https://codeclimate.com/github/thredded/thredded) [![Travis-CI](https://api.travis-ci.org/thredded/thredded.svg?branch=main)](https://travis-ci.org/thredded/thredded/) [![Test Coverage](https://codeclimate.com/github/thredded/thredded/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded/coverage) [![Inline docs](http://inch-ci.org/github/thredded/thredded.svg?branch=main)](http://inch-ci.org/github/thredded/thredded) [![Gitter](https://badges.gitter.im/thredded/thredded.svg)](https://gitter.im/thredded/thredded?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
-_Thredded_ is a Rails 5.2+ forum/messageboard engine. Its goal is to be as simple and feature rich as possible.
+_Thredded_ is a Rails 6.0+ forum/messageboard engine. Its goal is to be as simple and feature rich as possible.
 
 Some of the features currently in Thredded:
 
@@ -38,6 +38,7 @@ Table of Contents
   * [Adding Thredded to an existing Rails app](#adding-thredded-to-an-existing-rails-app)
   * [Upgrading an existing install](#upgrading-an-existing-install)
   * [Migrating from Forem](#migrating-from-forem)
+* [Rails compatibility](#rails-compatibility)
 * [Views and other assets](#views-and-other-assets)
   * [Standalone layout](#standalone-layout)
   * [Application layout](#application-layout)
@@ -96,7 +97,7 @@ Then, see the rest of this Readme for more information about using and customizi
 Add the gem to your Gemfile:
 
 ```ruby
-gem 'thredded', '~> 1.0'
+gem 'thredded', '~> 1.1'
 ```
 
 Add the Thredded [initializer] to your parent app by running the install generator.
@@ -155,6 +156,15 @@ to Thredded.
 [forem-to-thredded]: https://github.com/thredded/thredded/wiki/Migrate-from-Forem
 [Forem]: https://github.com/rubysherpas/forem
 
+## Rails compatibility
+
+| Rails  | Latest Thredded  |
+| ------------- |------------------|
+| Rails 6.0+ | Thredded 1.1+    |
+| Rails 5.2  | Thredded 1.0.1   |
+| Rails 4.2  | Thredded 0.16.16 |
+
+
 ## Views and other assets
 
 ### Standalone layout
@@ -596,8 +606,6 @@ Rails.application.config.to_prepare do
   Thredded::ApplicationController.module_eval do
     # Require authentication to access the forums:
     before_action :thredded_require_login!
-    # NB: in rails 4.2 you will need to change this to:
-    # before_action { thredded_require_login! }
 
     # You may also want to render a login form after the
     # "Please sign in first" message:

data/app/helpers/thredded/urls_helper.rb

@@ -2,6 +2,8 @@
 
 module Thredded
   module UrlsHelper # rubocop:disable Metrics/ModuleLength
+    include Thredded::Engine.routes.url_helpers
+
     class << self
       include Thredded::Engine.routes.url_helpers
       include Thredded::UrlsHelper

data/app/view_models/thredded/topics_page_view.rb

@@ -9,6 +9,7 @@ module Thredded
              :empty?,
              :[],
              :each,
+             :each_with_index,
              :map,
              :size,
              to: :@topic_views

data/bin/run_specs_repeatedly

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+# exit on first failure
+set -e
+for i in {1..10}
+do
+  echo "#$i (rspec $1)"
+  bundle exec rspec --format d $1 --fail-fast
+done

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
@@ -82,18 +83,29 @@ 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
 
+    # `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
+    end
+
     if Thredded::Compat.rails_gte_61?
       # @param [Array<Object>] collection
       # @param [Hash] opts
@@ -121,42 +133,20 @@ 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
+    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)
-        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

@@ -3,12 +3,6 @@
 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?

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/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, ActiveRecord::SchemaMigration).migrate(nil, &filter) }
         if quiet
           silence_active_record(&migrate)
         else

data/lib/thredded/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thredded
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Joel Oliveira
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-05 00:00:00.000000000 Z
+date: 2023-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_record_union
@@ -127,20 +127,14 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.0
-    - - "!="
+    - - ">"
       - !ruby/object:Gem::Version
         version: 6.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.0
-    - - "!="
+    - - ">"
       - !ruby/object:Gem::Version
         version: 6.0.0.rc2
 - !ruby/object:Gem::Dependency
@@ -163,14 +157,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -634,7 +628,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |-
-  The best Rails 5.2+ forums engine ever. Its goal is to be as simple and feature rich as possible.
+  The best Rails 6.0+ forums engine ever. Its goal is to be as simple and feature rich as possible.
   Thredded works with SQLite, MySQL (v5.6.4+), and PostgreSQL. See the demo at https://thredded.org/.
 email:
 - joel@thredded.com
@@ -985,6 +979,7 @@ files:
 - bin/create_migration_fixture
 - bin/rails
 - bin/rubocop
+- bin/run_specs_repeatedly
 - config/i18n-tasks.yml
 - config/locales/de.yml
 - config/locales/en.yml
@@ -1034,7 +1029,6 @@ files:
 - lib/thredded/html_pipeline/spoiler_tag_filter.rb
 - lib/thredded/html_pipeline/utils.rb
 - lib/thredded/html_pipeline/wrap_iframes_filter.rb
-- lib/thredded/rails_lt_5_2_arel_case_node.rb
 - lib/thredded/users_provider.rb
 - lib/thredded/version.rb
 - lib/thredded/view_hooks/config.rb

data/lib/thredded/rails_lt_5_2_arel_case_node.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-module Arel
-  module Nodes
-    class Case < Arel::Nodes::Node
-      include Arel::OrderPredications
-      include Arel::Predications
-      include Arel::AliasPredication
-
-      attr_accessor :case, :conditions, :default
-
-      def initialize(expression = nil, default = nil)
-        @case = expression
-        @conditions = []
-        @default = default
-      end
-
-      def when(condition, expression = nil)
-        @conditions << When.new(Nodes.build_quoted(condition), expression)
-        self
-      end
-
-      def then(expression)
-        @conditions.last.right = Nodes.build_quoted(expression)
-        self
-      end
-
-      def else(expression)
-        @default = Else.new Nodes.build_quoted(expression)
-        self
-      end
-
-      def initialize_copy(other)
-        super
-        @case = @case.clone if @case
-        @conditions = @conditions.map(&:clone)
-        @default = @default.clone if @default
-      end
-
-      def hash
-        [@case, @conditions, @default].hash
-      end
-
-      def eql?(other)
-        self.class == other.class &&
-          self.case == other.case &&
-          conditions == other.conditions &&
-          default == other.default
-      end
-
-      alias == eql?
-    end
-
-    class When < Binary
-    end
-
-    class Else < Unary
-    end
-  end
-end
-
-module Arel
-  module Visitors
-    class DepthFirst < Arel::Visitors::Visitor
-      alias visit_Arel_Nodes_Else unary
-
-      def visit_Arel_Nodes_Case(o) # rubocop:disable Naming/MethodName
-        visit o.case
-        visit o.conditions
-        visit o.default
-      end
-
-      alias visit_Arel_Nodes_When binary
-    end
-  end
-end
-
-module Arel
-  module Predications
-    def when(right)
-      Nodes::Case.new(self).when quoted_node(right)
-    end
-  end
-end
-
-module Arel
-  module Visitors
-    class ToSql < Arel::Visitors::Reduce
-      def visit_Arel_Nodes_Case(o, collector) # rubocop:disable Naming/MethodName
-        collector << 'CASE '
-        if o.case
-          visit o.case, collector
-          collector << ' '
-        end
-        o.conditions.each do |condition|
-          visit condition, collector
-          collector << ' '
-        end
-        if o.default
-          visit o.default, collector
-          collector << ' '
-        end
-        collector << 'END'
-      end
-
-      def visit_Arel_Nodes_When(o, collector) # rubocop:disable Naming/MethodName
-        collector << 'WHEN '
-        visit o.left, collector
-        collector << ' THEN '
-        visit o.right, collector
-      end
-
-      def visit_Arel_Nodes_Else(o, collector) # rubocop:disable Naming/MethodName
-        collector << 'ELSE '
-        visit o.expr, collector
-      end
-    end
-  end
-end