- {{i18n "docs.tags"}}
+
+ {{i18n "docs.tags"}}
+
- |
-
- {{~raw "topic-status" topic=topic}}
- {{~raw "docs-topic-link" topic=topic urlPath=urlPath}}
-
-
- {{category-link topic.category}}
- {{discourse-tags topic mode="list"}}
-
- |
-
- {{format-date topic.bumped_at format="tiny" noTitle="true"}}
- |
-
+{{~raw-plugin-outlet name="topic-list-before-columns"}}
+
+
+ {{~raw-plugin-outlet name="topic-list-before-link"}}
+
+ {{~raw "topic-status" topic=topic}}
+ {{~raw "docs-topic-link" topic=topic urlPath=urlPath}}
+
+
+ {{category-link topic.category}}
+ {{discourse-tags topic mode="list"}}
+
+ {{!-- {{#if showExcerpt}} --}}
+ {{~raw "list/topic-excerpt" topic=topic}}
+ {{!-- {{/if}} --}}
+ |
+
+ {{format-date topic.bumped_at format="tiny" noTitle="true"}}
+ |
\ No newline at end of file
diff --git a/lib/docs/query.rb b/lib/docs/query.rb
index e86b982..32b644c 100644
--- a/lib/docs/query.rb
+++ b/lib/docs/query.rb
@@ -2,8 +2,8 @@
module Docs
class Query
- def initialize(user = nil, filters = {})
- @user = user
+ def initialize(guardian, filters = {})
+ @guardian = guardian
@filters = filters
@limit = 30
end
@@ -19,7 +19,7 @@ module Docs
def list
# query for topics matching selected categories & tags
opts = { no_definitions: true, limit: false }
- tq = TopicQuery.new(@user, opts)
+ tq = TopicQuery.new(@guardian.user, opts)
results = tq.list_docs_topics
results =
results.left_outer_joins(SiteSetting.show_tags_by_group ? { tags: :tag_groups } : :tags)
@@ -155,7 +155,7 @@ module Docs
# assemble the object
topic_query = tq.create_list(:docs, { unordered: true }, results)
- topic_list = TopicListSerializer.new(topic_query, scope: Guardian.new(@user)).as_json
+ topic_list = TopicListSerializer.new(topic_query, scope: @guardian).as_json
if end_of_list.nil?
topic_list["load_more_url"] = load_more_url
@@ -169,6 +169,9 @@ module Docs
:categories => categories,
:topics => topic_list,
:topic_count => results_length,
+ :meta => {
+ show_topic_excerpts: show_topic_excerpts,
+ },
}
end
@@ -200,7 +203,7 @@ module Docs
tags_object << { id: tag[0], count: tag[1], active: active || false }
end
- allowed_tags = DiscourseTagging.filter_allowed_tags(Guardian.new(@user)).map(&:name)
+ allowed_tags = DiscourseTagging.filter_allowed_tags(@guardian).map(&:name)
tags_object = tags_object.select { |tag| allowed_tags.include?(tag[:id]) }
@@ -235,5 +238,10 @@ module Docs
"/#{GlobalSetting.docs_path}.json?#{filters.join("&")}"
end
+
+ def show_topic_excerpts
+ SiteSetting.always_include_topic_excerpts ||
+ ThemeModifierHelper.new(request: @guardian.request).serialize_topic_excerpts
+ end
end
end
diff --git a/spec/system/docs_index_spec.rb b/spec/system/docs_index_spec.rb
new file mode 100644
index 0000000..ccab8c8
--- /dev/null
+++ b/spec/system/docs_index_spec.rb
@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+describe "Discourse Docs | Index", type: :system do
+ fab!(:current_user) { Fabricate(:user) }
+ fab!(:category) { Fabricate(:category) }
+ fab!(:topic_1) { Fabricate(:topic, category: category) }
+ fab!(:topic_2) { Fabricate(:topic, category: category) }
+ fab!(:post_1) { Fabricate(:post, topic: topic_1) }
+ fab!(:post_2) { Fabricate(:post, topic: topic_2) }
+
+ before do
+ SiteSetting.docs_enabled = true
+ SiteSetting.docs_categories = category.id.to_s
+ sign_in(current_user)
+ end
+
+ it "does not error when showing the index" do
+ visit("/docs")
+ expect(page).to have_css(".docs-topic-link", text: topic_1.title)
+ expect(page).to have_css(".docs-topic-link", text: topic_2.title)
+ end
+
+ describe "topic excerpts" do
+ before do
+ topic_1.update_excerpt(post_1.excerpt_for_topic)
+ topic_2.update_excerpt(post_2.excerpt_for_topic)
+ end
+
+ it "does not show the topic excerpts by default" do
+ visit("/docs")
+ expect(page).to have_no_css(".topic-excerpt")
+ end
+
+ context "when docs_show_topic_excerpts is true" do
+ before { SiteSetting.always_include_topic_excerpts = true }
+
+ it "shows the excerpts" do
+ visit("/docs")
+ expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt)
+ expect(page).to have_css(".topic-excerpt", text: topic_2.excerpt)
+ end
+ end
+
+ context "when the theme modifier serialize_topic_excerpts is true" do
+ before do
+ ThemeModifierSet.find_by(theme_id: Theme.first.id).update!(serialize_topic_excerpts: true)
+ Theme.clear_cache!
+ end
+
+ it "shows the excerpts" do
+ visit("/docs")
+ expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt)
+ expect(page).to have_css(".topic-excerpt", text: topic_2.excerpt)
+ end
+ end
+ end
+end