From 9ef1688a76d3ccc0e42bd6da945adcd84caf07c1 Mon Sep 17 00:00:00 2001
From: Neil Lalonde <neillalonde@gmail.com>
Date: Tue, 1 Nov 2016 12:18:31 -0400
Subject: [PATCH] FEATURE: per-category default topic list sort order

---
 .../components/edit-category-settings.js.es6  | 18 +++++++++++++++++
 .../discourse/models/category.js.es6          |  4 +++-
 .../components/edit-category-settings.hbs     | 10 ++++++++++
 app/controllers/categories_controller.rb      |  2 ++
 app/models/category.rb                        |  2 ++
 app/serializers/basic_category_serializer.rb  |  4 +++-
 config/locales/client.en.yml                  | 13 ++++++++++++
 ...031183811_add_sort_fields_to_categories.rb |  6 ++++++
 lib/topic_query.rb                            |  9 +++++++++
 spec/components/topic_query_spec.rb           | 20 +++++++++++++++++++
 10 files changed, 86 insertions(+), 2 deletions(-)
 create mode 100644 db/migrate/20161031183811_add_sort_fields_to_categories.rb

diff --git a/app/assets/javascripts/discourse/components/edit-category-settings.js.es6 b/app/assets/javascripts/discourse/components/edit-category-settings.js.es6
index 049157609e3..41a4d2b20f5 100644
--- a/app/assets/javascripts/discourse/components/edit-category-settings.js.es6
+++ b/app/assets/javascripts/discourse/components/edit-category-settings.js.es6
@@ -1,7 +1,25 @@
 import { setting } from 'discourse/lib/computed';
 import { buildCategoryPanel } from 'discourse/components/edit-category-panel';
+import computed from "ember-addons/ember-computed-decorators";
 
 export default buildCategoryPanel('settings', {
   emailInEnabled: setting('email_in'),
   showPositionInput: setting('fixed_category_positions'),
+
+  isDefaultSortOrder: Em.computed.empty('category.sort_order'),
+
+  @computed
+  availableSorts() {
+    return ['likes', 'op_likes', 'views', 'posts', 'activity', 'posters', 'category', 'created']
+      .map(s => ({ name: I18n.t('category.sort_options.' + s), value: s }))
+      .sort((a,b) => { return a.name > b.name; });
+  },
+
+  @computed
+  sortAscendingOptions() {
+    return [
+      {name: I18n.t('category.sort_ascending'),  value: 'true'},
+      {name: I18n.t('category.sort_descending'), value: 'false'}
+    ];
+  }
 });
diff --git a/app/assets/javascripts/discourse/models/category.js.es6 b/app/assets/javascripts/discourse/models/category.js.es6
index 724a2664699..b77a4abdf33 100644
--- a/app/assets/javascripts/discourse/models/category.js.es6
+++ b/app/assets/javascripts/discourse/models/category.js.es6
@@ -98,7 +98,9 @@ const Category = RestModel.extend({
         topic_template: this.get('topic_template'),
         suppress_from_homepage: this.get('suppress_from_homepage'),
         allowed_tags: this.get('allowed_tags'),
-        allowed_tag_groups: this.get('allowed_tag_groups')
+        allowed_tag_groups: this.get('allowed_tag_groups'),
+        sort_order: this.get('sort_order'),
+        sort_ascending: this.get('sort_ascending')
       },
       type: id ? 'PUT' : 'POST'
     });
diff --git a/app/assets/javascripts/discourse/templates/components/edit-category-settings.hbs b/app/assets/javascripts/discourse/templates/components/edit-category-settings.hbs
index 1a9c68c6b25..72883cba5ad 100644
--- a/app/assets/javascripts/discourse/templates/components/edit-category-settings.hbs
+++ b/app/assets/javascripts/discourse/templates/components/edit-category-settings.hbs
@@ -19,6 +19,16 @@
   </label>
 </section>
 
+<section class="field">
+  <label>
+    {{i18n "category.sort_order"}}
+    {{combo-box valueAttribute="value" content=availableSorts value=category.sort_order none="category.sort_options.default"}}
+    {{#unless isDefaultSortOrder}}
+      {{combo-box valueAttribute="value" content=sortAscendingOptions value=category.sort_ascending none="category.sort_options.default"}}
+    {{/unless}}
+  </label>
+</section>
+
 {{#if emailInEnabled}}
     <section class='field'>
       <label>
diff --git a/app/controllers/categories_controller.rb b/app/controllers/categories_controller.rb
index 8b59196ef0b..9890a40c4b4 100644
--- a/app/controllers/categories_controller.rb
+++ b/app/controllers/categories_controller.rb
@@ -238,6 +238,8 @@ class CategoriesController < ApplicationController
                         :slug,
                         :allow_badges,
                         :topic_template,
+                        :sort_order,
+                        :sort_ascending,
                         :custom_fields => [params[:custom_fields].try(:keys)],
                         :permissions => [*p.try(:keys)],
                         :allowed_tags => [],
diff --git a/app/models/category.rb b/app/models/category.rb
index 2d077cd6fb9..3a8cc580e2a 100644
--- a/app/models/category.rb
+++ b/app/models/category.rb
@@ -536,6 +536,8 @@ end
 #  topic_template                :text
 #  suppress_from_homepage        :boolean          default(FALSE)
 #  contains_messages             :boolean
+#  sort_order                    :string
+#  sort_ascending                :boolean
 #
 # Indexes
 #
diff --git a/app/serializers/basic_category_serializer.rb b/app/serializers/basic_category_serializer.rb
index cd5c6c71699..96d6ec6b836 100644
--- a/app/serializers/basic_category_serializer.rb
+++ b/app/serializers/basic_category_serializer.rb
@@ -19,7 +19,9 @@ class BasicCategorySerializer < ApplicationSerializer
              :notification_level,
              :can_edit,
              :topic_template,
-             :has_children
+             :has_children,
+             :sort_order,
+             :sort_ascending
 
   def include_parent_category_id?
     parent_category_id
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index df618cac2b1..d6a10c0d733 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -1883,6 +1883,7 @@ en:
       email_in_disabled: "Posting new topics via email is disabled in the Site Settings. To enable posting new topics via email, "
       email_in_disabled_click: 'enable the "email in" setting.'
       suppress_from_homepage: "Suppress this category from the homepage."
+      sort_order: "Default Sort:"
       allow_badges_label: "Allow badges to be awarded in this category"
       edit_permissions: "Edit Permissions"
       add_permission: "Add Permission"
@@ -1908,6 +1909,18 @@ en:
         muted:
           title: "Muted"
           description: "You will never be notified of anything about new topics in these categories, and they will not appear in latest."
+      sort_options:
+        default: "default"
+        likes: "Likes"
+        op_likes: "Original Post Likes"
+        views: "Views"
+        posts: "Posts"
+        activity: "Activity"
+        posters: "Posters"
+        category: "Category"
+        created: "Created"
+      sort_ascending: 'Ascending'
+      sort_descending: 'Descending'
 
     flagging:
       title: 'Thanks for helping to keep our community civil!'
diff --git a/db/migrate/20161031183811_add_sort_fields_to_categories.rb b/db/migrate/20161031183811_add_sort_fields_to_categories.rb
new file mode 100644
index 00000000000..991b5484bec
--- /dev/null
+++ b/db/migrate/20161031183811_add_sort_fields_to_categories.rb
@@ -0,0 +1,6 @@
+class AddSortFieldsToCategories < ActiveRecord::Migration
+  def change
+    add_column :categories, :sort_order, :string
+    add_column :categories, :sort_ascending, :boolean
+  end
+end
diff --git a/lib/topic_query.rb b/lib/topic_query.rb
index baf93ce58f2..f13cbbd8bcb 100644
--- a/lib/topic_query.rb
+++ b/lib/topic_query.rb
@@ -450,6 +450,15 @@ class TopicQuery
           result = result.where('categories.id = :category_id OR (categories.parent_category_id = :category_id AND categories.topic_id <> topics.id)', category_id: category_id)
         end
         result = result.references(:categories)
+
+        if !@options[:order]
+          # category default sort order
+          sort_order, sort_ascending = Category.where(id: category_id).pluck(:sort_order, :sort_ascending).first
+          if sort_order
+            options[:order] = sort_order
+            options[:ascending] = !!sort_ascending ? 'true' : 'false'
+          end
+        end
       end
 
       # ALL TAGS: something like this?
diff --git a/spec/components/topic_query_spec.rb b/spec/components/topic_query_spec.rb
index 6506377d494..6fe6552615e 100644
--- a/spec/components/topic_query_spec.rb
+++ b/spec/components/topic_query_spec.rb
@@ -379,6 +379,26 @@ describe TopicQuery do
         ).to eq([topic_in_cat2.id, topic_category.id, topic_in_cat1.id])
       end
     end
+
+    describe "category default sort order" do
+      it "can use category's default sort order" do
+        category.update_attributes!(sort_order: 'created', sort_ascending: true)
+        topic_ids = TopicQuery.new(user, category: category.id).list_latest.topics.map(&:id)
+        expect(topic_ids - [topic_category.id]).to eq([topic_in_cat1.id, topic_in_cat2.id])
+      end
+
+      it "ignores invalid order value" do
+        category.update_attributes!(sort_order: 'funny')
+        topic_ids = TopicQuery.new(user, category: category.id).list_latest.topics.map(&:id)
+        expect(topic_ids - [topic_category.id]).to eq([topic_in_cat2.id, topic_in_cat1.id])
+      end
+
+      it "can be overridden" do
+        category.update_attributes!(sort_order: 'created', sort_ascending: true)
+        topic_ids = TopicQuery.new(user, category: category.id, order: 'activity').list_latest.topics.map(&:id)
+        expect(topic_ids - [topic_category.id]).to eq([topic_in_cat2.id, topic_in_cat1.id])
+      end
+    end
   end
 
   context 'unread / read topics' do