refactors site map

velesin · velesin · commit 8eef779d3892 · 2013-11-27T21:58:36.000+01:00
diff --git a/app/assets/javascripts/discourse/controllers/header_controller.js b/app/assets/javascripts/discourse/controllers/header_controller.js
@@ -11,33 +11,17 @@ Discourse.HeaderController = Discourse.Controller.extend({
   showExtraInfo: null,
   notifications: null,
 
-  categories: function() {
-    return Discourse.Category.list();
-  }.property(),
-
   showFavoriteButton: function() {
     return Discourse.User.current() && !this.get('topic.isPrivateMessage');
   }.property('topic.isPrivateMessage'),
 
-  mobileView: function() {
-    return Discourse.Mobile.mobileView;
-  }.property(),
-
-  showMobileToggle: function() {
-    return Discourse.SiteSettings.enable_mobile_theme;
-  }.property(),
-
   actions: {
     toggleStar: function() {
       var topic = this.get('topic');
       if (topic) topic.toggleStar();
       return false;
     },
 
-    toggleMobileView: function() {
-      Discourse.Mobile.toggleMobileView();
-    },
-
     showNotifications: function(headerView) {
       var self = this;
 
diff --git a/app/assets/javascripts/discourse/controllers/site_map_category_controller.js b/app/assets/javascripts/discourse/controllers/site_map_category_controller.js
@@ -0,0 +1,5 @@
+Discourse.SiteMapCategoryController = Ember.ObjectController.extend({
+  showBadges: function() {
+    return !!Discourse.User.current();
+  }.property().volatile()
+});
diff --git a/app/assets/javascripts/discourse/controllers/site_map_controller.js b/app/assets/javascripts/discourse/controllers/site_map_controller.js
@@ -0,0 +1,33 @@
+Discourse.SiteMapController = Ember.ArrayController.extend(Discourse.HasCurrentUser, {
+  itemController: "siteMapCategory",
+
+  showAdminLinks: function() {
+    return this.get("currentUser.staff");
+  }.property("currentUser.staff"),
+
+  flaggedPostsCount: function() {
+    return this.get("currentUser.site_flagged_posts_count");
+  }.property("currentUser.site_flagged_posts_count"),
+
+  faqUrl: function() {
+    return Discourse.SiteSettings.faq_url ? Discourse.SiteSettings.faq_url : Discourse.getURL('/faq');
+  }.property(),
+
+  showMobileToggle: function() {
+    return Discourse.SiteSettings.enable_mobile_theme;
+  }.property(),
+
+  mobileViewLinkTextKey: function() {
+    return Discourse.Mobile.mobileView ? "desktop_view" : "mobile_view";
+  }.property(),
+
+  categories: function() {
+    return Discourse.Category.list();
+  }.property(),
+
+  actions: {
+    toggleMobileView: function() {
+      Discourse.Mobile.toggleMobileView();
+    }
+  }
+});
diff --git a/app/assets/javascripts/discourse/helpers/application_helpers.js b/app/assets/javascripts/discourse/helpers/application_helpers.js
@@ -317,17 +317,3 @@ Handlebars.registerHelper('date', function(property, options) {
   }
 
 });
-
-/**
-  Produces a link to the FAQ
-
-  @method faqLink
-  @for Handlebars
-**/
-Handlebars.registerHelper('faqLink', function(property, options) {
-  return new Handlebars.SafeString(
-    "<a href='" +
-    (Discourse.SiteSettings.faq_url.length > 0 ? Discourse.SiteSettings.faq_url : Discourse.getURL('/faq')) +
-    "' class='faq-link'>" + I18n.t('faq') + "</a>"
-  );
-});
diff --git a/app/assets/javascripts/discourse/templates/components/header-category-info.js.handlebars b/app/assets/javascripts/discourse/templates/components/header-category-info.js.handlebars
diff --git a/app/assets/javascripts/discourse/templates/header.js.handlebars b/app/assets/javascripts/discourse/templates/header.js.handlebars
@@ -99,49 +99,7 @@
       {{render notifications notifications}}
 
       {{#if view.renderSiteMap}}
-        <section class='d-dropdown' id='site-map-dropdown'>
-          <ul class="location-links">
-            {{#if currentUser.staff}}
-              <li><a href="/admin" class="admin-link"><i class='icon icon-wrench'></i>{{i18n admin_title}}</a></li>
-              <li>
-                <a href="/admin/flags/active" class="flagged-posts-link"><i class='icon icon-flag'></i>{{i18n flags_title}}</a>
-                {{#if currentUser.site_flagged_posts_count}}
-                  <a href='/admin/flags/active' title='{{i18n notifications.total_flagged}}' class='badge-notification flagged-posts'>{{currentUser.site_flagged_posts_count}}</a>
-                {{/if}}
-              </li>
-            {{/if}}
-            <li>
-              {{#titledLinkTo "list.latest" titleKey="filters.latest.help" class="latest-topics-link"}}{{i18n filters.latest.title}}{{/titledLinkTo}}
-            </li>
-            <li>{{faqLink}}</li>
-            {{#if showMobileToggle}}
-              <li>
-                <a href="#" class="mobile-toggle-link" {{action toggleMobileView}}>
-                  {{#if mobileView}}
-                    {{i18n desktop_view}}
-                  {{else}}
-                    {{i18n mobile_view}}
-                  {{/if}}
-                </a>
-              </li>
-            {{/if}}
-          </ul>
-
-          {{#if categories}}
-            <ul class="category-links">
-              <li class='heading' title="{{i18n filters.categories.help}}">
-                {{#link-to "list.categories"}}{{i18n filters.categories.title}}{{/link-to}}
-              </li>
-
-              {{#each categories}}
-                <li class='category'>
-                  {{header-category-info category=this currentUser=controller.currentUser}}
-                </li>
-              {{/each}}
-            </ul>
-          {{/if}}
-
-        </section>
+        {{render siteMap}}
       {{/if}}
 
     </div>
diff --git a/app/assets/javascripts/discourse/templates/site_map.js.handlebars b/app/assets/javascripts/discourse/templates/site_map.js.handlebars
@@ -0,0 +1,25 @@
+<section class="d-dropdown" id="site-map-dropdown">
+  <ul class="location-links">
+    {{#if showAdminLinks}}
+      <li>{{partial "siteMap/adminLink"}}</li>
+      <li>{{partial "siteMap/flaggedPostsLinks"}}</li>
+    {{/if}}
+    <li>{{partial "siteMap/latestTopicsLink"}}</li>
+    <li>{{partial "siteMap/faqLink"}}</li>
+    {{#if showMobileToggle}}
+      <li>{{partial "siteMap/mobileToggleLink"}}</li>
+    {{/if}}
+  </ul>
+
+  {{#if categories}}
+    <ul class="category-links">
+      <li class="heading" title="{{i18n filters.categories.help}}">
+        {{partial "siteMap/allCategoriesLink"}}
+      </li>
+
+      {{#each categories itemController=itemController}}
+        <li class="category">{{partial "siteMap/category"}}</li>
+      {{/each}}
+    </ul>
+  {{/if}}
+</section>
diff --git a/app/assets/javascripts/discourse/templates/site_map/_admin_link.js.handlebars b/app/assets/javascripts/discourse/templates/site_map/_admin_link.js.handlebars
@@ -0,0 +1 @@
+<a href="/admin" class="admin-link"><i class='icon icon-wrench'></i>{{i18n admin_title}}</a>
diff --git a/app/assets/javascripts/discourse/templates/site_map/_all_categories_link.js.handlebars b/app/assets/javascripts/discourse/templates/site_map/_all_categories_link.js.handlebars
@@ -0,0 +1 @@
+{{#link-to "list.categories"}}{{i18n filters.categories.title}}{{/link-to}}
diff --git a/app/assets/javascripts/discourse/templates/site_map/_category.js.handlebars b/app/assets/javascripts/discourse/templates/site_map/_category.js.handlebars
@@ -0,0 +1,11 @@
+{{categoryLink this allowUncategorized=true}}
+{{#if showBadges}}
+  {{#if unreadTopics}}
+    <a href={{unbound unreadUrl}} class='badge unread-posts badge-notification' title='{{i18n topic.unread_topics count="unreadTopics"}}'>{{unreadTopics}}</a>
+  {{/if}}
+  {{#if newTopics}}
+    <a href={{unbound newUrl}} class='badge new-posts badge-notification' title='{{i18n topic.new_topics count="newTopics"}}'>{{newTopics}} <i class='icon icon-asterisk'></i></a>
+  {{/if}}
+{{else}}
+  <b class="topics-count">{{unbound topic_count}}</b>
+{{/if}}
diff --git a/app/assets/javascripts/discourse/templates/site_map/_faq_link.js.handlebars b/app/assets/javascripts/discourse/templates/site_map/_faq_link.js.handlebars
@@ -0,0 +1 @@
+<a href="{{unbound faqUrl}}" class="faq-link">{{i18n faq}}</a>
diff --git a/app/assets/javascripts/discourse/templates/site_map/_flagged_posts_links.js.handlebars b/app/assets/javascripts/discourse/templates/site_map/_flagged_posts_links.js.handlebars
@@ -0,0 +1,4 @@
+<a href="/admin/flags/active" class="flagged-posts-link"><i class='icon icon-flag'></i>{{i18n flags_title}}</a>
+{{#if flaggedPostsCount}}
+  <a href='/admin/flags/active' title='{{i18n notifications.total_flagged}}' class='badge-notification flagged-posts'>{{flaggedPostsCount}}</a>
+{{/if}}
diff --git a/app/assets/javascripts/discourse/templates/site_map/_latest_topics_link.js.handlebars b/app/assets/javascripts/discourse/templates/site_map/_latest_topics_link.js.handlebars
@@ -0,0 +1 @@
+{{#titledLinkTo "list.latest" titleKey="filters.latest.help" class="latest-topics-link"}}{{i18n filters.latest.title}}{{/titledLinkTo}}
diff --git a/app/assets/javascripts/discourse/templates/site_map/_mobile_toggle_link.js.handlebars b/app/assets/javascripts/discourse/templates/site_map/_mobile_toggle_link.js.handlebars
@@ -0,0 +1 @@
+<a href="#" class="mobile-toggle-link" {{action toggleMobileView}}>{{boundI18n mobileViewLinkTextKey}}</a>
diff --git a/test/javascripts/controllers/site_map_category_controller_test.js b/test/javascripts/controllers/site_map_category_controller_test.js
@@ -0,0 +1,17 @@
+var controller;
+
+module("Discourse.SiteMapCategoryController", {
+  setup: function() {
+    controller = Discourse.SiteMapCategoryController.create();
+  }
+});
+
+test("showBadges", function() {
+  this.stub(Discourse.User, "current");
+
+  Discourse.User.current.returns(null);
+  ok(!controller.get("showBadges"), "returns false when no user is logged in");
+
+  Discourse.User.current.returns({});
+  ok(controller.get("showBadges"), "returns true when an user is logged in");
+});
diff --git a/test/javascripts/controllers/site_map_controller_test.js b/test/javascripts/controllers/site_map_controller_test.js
@@ -0,0 +1,83 @@
+var controller, oldMobileView;
+
+module("Discourse.SiteMapController", {
+  setup: function() {
+    oldMobileView = Discourse.Mobile.mobileView;
+
+    controller = Discourse.SiteMapController.create();
+  },
+
+  teardown: function() {
+    Discourse.Mobile.mobileView = oldMobileView;
+  }
+});
+
+test("itemController", function() {
+  equal(controller.get("itemController"), "siteMapCategory", "defaults to SiteMapCategoryController");
+});
+
+test("showAdminLinks", function() {
+  var currentUserStub = Ember.Object.create();
+  this.stub(Discourse.User, "current").returns(currentUserStub);
+
+  currentUserStub.set("staff", true);
+  equal(controller.get("showAdminLinks"), true, "is true when current user is a staff member");
+
+  currentUserStub.set("staff", false);
+  equal(controller.get("showAdminLinks"), false, "is false when current user is not a staff member");
+});
+
+test("flaggedPostsCount", function() {
+  var currentUserStub = Ember.Object.create();
+  this.stub(Discourse.User, "current").returns(currentUserStub);
+
+  currentUserStub.set("site_flagged_posts_count", 5);
+  equal(controller.get("flaggedPostsCount"), 5, "returns current user's flagged posts count");
+
+  currentUserStub.set("site_flagged_posts_count", 0);
+  equal(controller.get("flaggedPostsCount"), 0, "is bound (reacts to change of current user's flagged posts count)");
+});
+
+test("faqUrl returns faq url configured in site settings if it is set", function() {
+  Discourse.SiteSettings.faq_url = "faq-url";
+  equal(controller.get("faqUrl"), "faq-url");
+});
+
+test("faqUrl returns default '/faq' url when there is no corresponding site setting set", function() {
+  Discourse.SiteSettings.faq_url = null;
+  equal(controller.get("faqUrl"), "/faq");
+});
+
+test("showMoblieToggle returns true when mobile theme is enabled in site settings", function() {
+  Discourse.SiteSettings.enable_mobile_theme = true;
+  equal(controller.get("showMobileToggle"), true);
+});
+
+test("showMoblieToggle returns false when mobile theme is disabled in site settings", function() {
+  Discourse.SiteSettings.enable_mobile_theme = false;
+  equal(controller.get("showMobileToggle"), false);
+});
+
+test("mobileViewLinkTextKey returns translation key for a desktop view if the current view is mobile view", function() {
+  Discourse.Mobile.mobileView = true;
+  equal(controller.get("mobileViewLinkTextKey"), "desktop_view");
+});
+
+test("mobileViewLinkTextKey returns translation key for a mobile view if the current view is desktop view", function() {
+  Discourse.Mobile.mobileView = false;
+  equal(controller.get("mobileViewLinkTextKey"), "mobile_view");
+});
+
+test("categories", function() {
+  var categoryListStub = ["category1", "category2"];
+  this.stub(Discourse.Category, "list").returns(categoryListStub);
+
+  equal(controller.get("categories"), categoryListStub, "returns the list of categories");
+});
+
+test("toggleMobleView", function() {
+  this.stub(Discourse.Mobile, "toggleMobileView");
+
+  controller.send("toggleMobileView");
+  ok(Discourse.Mobile.toggleMobileView.calledOnce, "switches between desktop and mobile views");
+});
diff --git a/test/javascripts/templates/site_map_test.js b/test/javascripts/templates/site_map_test.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<a href="/admin" class="admin-link"><i class='icon icon-wrench'></i>{{i18n admin_title}}</a>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{{#link-to "list.categories"}}{{i18n filters.categories.title}}{{/link-to}}`