From: Alexandre Terrasa <alexandre@moz-code.org>
Date: Fri, 7 Feb 2014 07:04:09 +0000 (-0500)
Subject: nitdoc: refactor Nitdoc.UI JS module into ui plugin
X-Git-Tag: v0.6.4~2^2~25
X-Git-Url: http://nitlanguage.org

nitdoc: refactor Nitdoc.UI JS module into ui plugin

Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
---

diff --git a/share/nitdoc/js/nitdoc.js b/share/nitdoc/js/nitdoc.js
index df3559d..4d12538 100644
--- a/share/nitdoc/js/nitdoc.js
+++ b/share/nitdoc/js/nitdoc.js
@@ -12,5 +12,6 @@ require.config({
 
 // nitdoc main module
 define([
+	"plugins/ui",
 ], function() {});
 
diff --git a/share/nitdoc/js/plugins/ui.js b/share/nitdoc/js/plugins/ui.js
new file mode 100644
index 0000000..fe479e2
--- /dev/null
+++ b/share/nitdoc/js/plugins/ui.js
@@ -0,0 +1,208 @@
+/* This file is part of NIT ( http://www.nitlanguage.org ).
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   Documentation generator for the nit language.
+   Generate API documentation in HTML format from nit source code.
+*/
+
+/*
+ * Nitdoc UI module
+ *
+ * Enhance nitdoc usability with JS features
+ */
+define([
+	"jquery",
+	"ZeroClipboard",
+	"plugins/utils"
+], function($, ZeroClipboard, utils) {
+
+	var UI = {
+
+		// Allow user to fold sidebar nav elements on click
+		enableFolding: function(containerSelector) {
+			var container = $(containerSelector);
+			var foldLink = $(document.createElement("a"))
+			.addClass("nitdoc-ui-fold")
+			.html("-");
+
+			container.find("nav h3")
+			.prepend(foldLink)
+			.css("cursor", "pointer")
+			.toggle(
+				function() {
+					$(this).find("a.nitdoc-ui-fold").html("+");
+					$(this).nextAll().toggle();
+				},
+				function() {
+					$(this).find("a.nitdoc-ui-fold").html("-");
+					$(this).nextAll().toggle();
+				}
+			);
+		},
+
+		// Allow user to copy signatures to clipboard with ZeroClipboard flahs plugin
+		// See: https://github.com/zeroclipboard/ZeroClipboard
+		enableCopyToClipboard: function(copySelector) {
+			$(copySelector).each(function() {
+				var btn = $(document.createElement("button"))
+				.addClass("nitdoc-ui-copy")
+				.attr("data-clipboard-text", $(this).attr("data-untyped-signature"))
+				.append(
+					$(document.createElement("img"))
+					.attr("src", './resources/icons/copy.png')
+				);
+				$(this).append(btn);
+			});
+
+			var clip = new ZeroClipboard($("button.nitdoc-ui-copy"), {
+				moviePath: "./ZeroClipboard.swf"
+			});
+		},
+
+		// Allow user to filter sidebar box entries by name
+		enableSidebarTextFilters: function(filterSelector) {
+			var div = $(document.createElement("div"))
+			.addClass("nitdoc-ui-filter")
+			.append(
+				$(document.createElement("input"))
+				.addClass("nitdoc-ui-filter-field")
+				.addClass("nitdoc-ui-filter-field-notused")
+				.attr("type", "text")
+				.attr("value",	"filter...")
+				.keyup(function() {
+					var box = $(this).parents("nav.filterable");
+					var value = $(this).val();
+					box.find("ul li:not(:icontains('" + value + "'))").hide();
+					box.find("ul li:icontains('" + value + "')").show();
+				})
+				.focusout(function() {
+					if($(this).val() == "") {
+						$(this).addClass("nitdoc-ui-filter-field-notused");
+						$(this).val("filter...");
+					}
+				})
+				.focusin(function() {
+					if($(this).val() == "filter...") {
+						$(this).removeClass("nitdoc-ui-filter-field-notused");
+						$(this).val("");
+					}
+				})
+			);
+			$(filterSelector).after(div);
+			this.preloadSidebarTextFilters();
+		},
+
+		// Prealod filters using search query
+		preloadSidebarTextFilters: function() {
+			var anchor = utils.extractAnchor(document.location.hash);
+			if(!anchor || anchor.indexOf("q=") == -1) return;
+
+			var query = anchor.substring(2);
+			if(!query) return;
+
+			$(".nitdoc-ui-filter input:text")
+			.val(query)
+			.removeClass("nitdoc-ui-notused")
+			.trigger("keyup");
+		},
+
+		// Allow user to filter side bar box entries by Introduced/Refined/inHerited type
+		enableSidebarTypeFilters: function(filterSelector) {
+			var box = $(filterSelector);
+			var types = {};
+
+			box.find("li").each(function() {
+				var span = $(this).find("span:first");
+				if(!types[span.html()]) types[span.html()] = {
+					title: span.attr("title"),
+					class: $(this).attr("class")
+				}
+			});
+
+			for(var type in types) {
+				var a = $(document.createElement("a"))
+				.addClass("nitdoc-ui-filter-link")
+				.html(type)
+				.attr("title", "Hide " + types[type].title)
+				.attr("data-filter-class", types[type].class)
+				.toggle(
+					function() {
+						var hclass = $(this).attr("data-filter-class");
+						$(this).parents(filterSelector).find("li." + hclass).hide();
+						$(this).addClass("nitdoc-ui-filter-hidden")
+					},
+					function() {
+						var hclass = $(this).attr("data-filter-class");
+						$(this).parents(filterSelector).find("li." + hclass).show();
+						$(this).removeClass("nitdoc-ui-filter-hidden")
+					}
+				)
+				$(filterSelector).find(".nitdoc-ui-filter").append(a);
+			}
+		},
+
+		// Allow user to filter sidebar box entries by name
+		enableSearchPageField: function(filterSelector) {
+			var div = $(document.createElement("div"))
+			.addClass("nitdoc-ui-searchpage-filter")
+			.append(
+				$(document.createElement("input"))
+				.addClass("nitdoc-ui-searchpage-field")
+				.addClass("nitdoc-ui-filter-field-notused")
+				.attr("type", "text")
+				.attr("value",	"filter...")
+				.keyup(function() {
+					var box = $(this).parents(".content.fullpage").find("article.filterable");
+					var value = $(this).val();
+					box.find("ul li:not(:icontains('" + value + "'))").hide();
+					box.find("ul li:icontains('" + value + "')").show();
+				})
+				.focusout(function() {
+					if($(this).val() == "") {
+						$(this).addClass("nitdoc-ui-filter-field-notused");
+						$(this).val("filter...");
+					}
+				})
+				.focusin(function() {
+					if($(this).val() == "filter...") {
+						$(this).removeClass("nitdoc-ui-filter-field-notused");
+						$(this).val("");
+					}
+				})
+			);
+			$(filterSelector).after(div);
+			this.preloadSearchPageField();
+		},
+
+		// Prealod filter using search query
+		preloadSearchPageField: function() {
+			var anchor = utils.extractAnchor(document.location.hash);
+			if(!anchor || anchor.indexOf("q=") == -1) return;
+
+			var query = anchor.substring(2);
+			if(!query) return;
+
+			$(".nitdoc-ui-searchpage-field")
+			.val(query)
+			.removeClass("nitdoc-ui-notused")
+			.trigger("keyup");
+		}
+	};
+
+	UI.enableFolding(".sidebar");
+	UI.enableCopyToClipboard(".signature");
+	UI.enableSidebarTextFilters("nav.filterable h3");
+	UI.enableSidebarTypeFilters("nav.filterable");
+	UI.enableSearchPageField(".content.fullpage h1:contains('Search')");
+});
diff --git a/share/nitdoc/scripts/Nitdoc.UI.js b/share/nitdoc/scripts/Nitdoc.UI.js
deleted file mode 100644
index 5b8d004..0000000
--- a/share/nitdoc/scripts/Nitdoc.UI.js
+++ /dev/null
@@ -1,249 +0,0 @@
-/* This file is part of NIT ( http://www.nitlanguage.org ).
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
-   Documentation generator for the nit language.
-   Generate API documentation in HTML format from nit source code.
-*/
-
-var Nitdoc = Nitdoc || {};
-
-/*
- * Nitdoc UI module
- *
- * Enhance nitdoc usability with JS features
- */
-
-Nitdoc.UI = function() {
-
-	// Allow user to fold sidebar nav elements on click
-	var enableFolding = function(containerSelector) {
-		var container = $(containerSelector);
-		var foldLink = $(document.createElement("a"))
-		.addClass("nitdoc-ui-fold")
-		.html("-");
-
-		container.find("nav h3")
-		.prepend(foldLink)
-		.css("cursor", "pointer")
-		.toggle(
-			function() {
-				$(this).find("a.nitdoc-ui-fold").html("+");
-				$(this).nextAll().toggle();
-			},
-			function() {
-				$(this).find("a.nitdoc-ui-fold").html("-");
-				$(this).nextAll().toggle();
-			}
-		);
-	}
-
-	// Allow user to copy signatures to clipboard with ZeroClipboard flahs plugin
-	// See: https://github.com/zeroclipboard/ZeroClipboard
-	var enableCopyToClipboard = function(copySelector) {
-		$(copySelector).each(function() {
-			var btn = $(document.createElement("button"))
-			.addClass("nitdoc-ui-copy")
-			.attr("data-clipboard-text", $(this).attr("data-untyped-signature"))
-			.append(
-				$(document.createElement("img"))
-				.attr("src", './resources/icons/copy.png')
-			);
-			$(this).append(btn);
-		});
-
-		var clip = new ZeroClipboard($("button.nitdoc-ui-copy"), {
-			moviePath: "./ZeroClipboard.swf"
-		});
-	}
-
-	// Allow user to filter sidebar box entries by name
-	var enableSidebarTextFilters = function(filterSelector) {
-		var div = $(document.createElement("div"))
-		.addClass("nitdoc-ui-filter")
-		.append(
-			$(document.createElement("input"))
-			.addClass("nitdoc-ui-filter-field")
-			.addClass("nitdoc-ui-filter-field-notused")
-			.attr("type", "text")
-			.attr("value",	"filter...")
-			.keyup(function() {
-				var box = $(this).parents("nav.filterable");
-				var value = $(this).val();
-				box.find("ul li:not(:icontains('" + value + "'))").hide();
-				box.find("ul li:icontains('" + value + "')").show();
-			})
-			.focusout(function() {
-				if($(this).val() == "") {
-					$(this).addClass("nitdoc-ui-filter-field-notused");
-					$(this).val("filter...");
-				}
-			})
-			.focusin(function() {
-				if($(this).val() == "filter...") {
-					$(this).removeClass("nitdoc-ui-filter-field-notused");
-					$(this).val("");
-				}
-			})
-		);
-		$(filterSelector).after(div);
-		preloadSidebarTextFilters();
-	}
-
-	// Prealod filters using search query
-	var preloadSidebarTextFilters = function() {
-		var anchor = Nitdoc.Utils.extractAnchor(document.location.hash);
-		if(!anchor || anchor.indexOf("q=") == -1) return;
-
-		var query = anchor.substring(2);
-		if(!query) return;
-
-		$(".nitdoc-ui-filter input:text")
-		.val(query)
-		.removeClass("nitdoc-ui-notused")
-		.trigger("keyup");
-	}
-
-	// Allow user to filter side bar box entries by Introduced/Refined/inHerited type
-	var enableSidebarTypeFilters = function(filterSelector) {
-		var box = $(filterSelector);
-		var types = {};
-
-		box.find("li").each(function() {
-			var span = $(this).find("span:first");
-			if(!types[span.html()]) types[span.html()] = {
-				title: span.attr("title"),
-				class: $(this).attr("class")
-			}
-		});
-
-		for(var type in types) {
-			var a = $(document.createElement("a"))
-			.addClass("nitdoc-ui-filter-link")
-			.html(type)
-			.attr("title", "Hide " + types[type].title)
-			.attr("data-filter-class", types[type].class)
-			.toggle(
-				function() {
-					var hclass = $(this).attr("data-filter-class");
-					$(this).parents(filterSelector).find("li." + hclass).hide();
-					$(this).addClass("nitdoc-ui-filter-hidden")
-				},
-				function() {
-					var hclass = $(this).attr("data-filter-class");
-					$(this).parents(filterSelector).find("li." + hclass).show();
-					$(this).removeClass("nitdoc-ui-filter-hidden")
-				}
-			)
-			$(filterSelector).find(".nitdoc-ui-filter").append(a);
-		}
-	}
-
-	// Allow user to filter sidebar box entries by name
-	var enableSearchPageField = function(filterSelector) {
-		var div = $(document.createElement("div"))
-		.addClass("nitdoc-ui-searchpage-filter")
-		.append(
-			$(document.createElement("input"))
-			.addClass("nitdoc-ui-searchpage-field")
-			.addClass("nitdoc-ui-filter-field-notused")
-			.attr("type", "text")
-			.attr("value",	"filter...")
-			.keyup(function() {
-				var box = $(this).parents(".content.fullpage").find("article.filterable");
-				var value = $(this).val();
-				box.find("ul li:not(:icontains('" + value + "'))").hide();
-				box.find("ul li:icontains('" + value + "')").show();
-			})
-			.focusout(function() {
-				if($(this).val() == "") {
-					$(this).addClass("nitdoc-ui-filter-field-notused");
-					$(this).val("filter...");
-				}
-			})
-			.focusin(function() {
-				if($(this).val() == "filter...") {
-					$(this).removeClass("nitdoc-ui-filter-field-notused");
-					$(this).val("");
-				}
-			})
-		);
-		$(filterSelector).after(div);
-		preloadSearchPageField();
-	}
-
-	// Prealod filter using search query
-	var preloadSearchPageField = function() {
-		var anchor = Nitdoc.Utils.extractAnchor(document.location.hash);
-		if(!anchor || anchor.indexOf("q=") == -1) return;
-
-		var query = anchor.substring(2);
-		if(!query) return;
-
-		$(".nitdoc-ui-searchpage-field")
-		.val(query)
-		.removeClass("nitdoc-ui-notused")
-		.trigger("keyup");
-	}
-
-	// Public interface
-	var ui = {
-		enableFolding: enableFolding,
-		enableCopyToClipboard: enableCopyToClipboard,
-		enableSidebarTextFilters: enableSidebarTextFilters,
-		enableSidebarTypeFilters: enableSidebarTypeFilters,
-		enableSearchPageField: enableSearchPageField
-	};
-
-	return ui;
-}();
-
-// Init UI on page load
-$(document).ready(function() {
-	Nitdoc.UI.enableFolding(".sidebar");
-	Nitdoc.UI.enableCopyToClipboard(".signature");
-	Nitdoc.UI.enableSidebarTextFilters("nav.filterable h3");
-	Nitdoc.UI.enableSidebarTypeFilters("nav.filterable");
-	Nitdoc.UI.enableSearchPageField(".content.fullpage h1:contains('Search')");
-});
-
-/*
- * Utils module
- *
- * Utility functions
- */
-
-Nitdoc.Utils = function() {
-
-	// Extract anchor part (after #) from URL string
-	var extractAnchor = function(url) {
-	    var index = url.indexOf("#");
-	    if (index >= 0) {
-			return url.substring(index + 1);
-		}
-		return null;
-	}
-
-	// Public interface
-	var utils = {
-		extractAnchor: extractAnchor
-	};
-
-	return utils;
-}();
-
-// JQuery Case Insensitive :icontains selector
-$.expr[':'].icontains = function(obj, index, meta, stack){
-	return (obj.textContent.replace(/\[[0-9]+\]/g, "") || obj.innerText.replace(/\[[0-9]+\]/g, "") || jQuery(obj).text().replace(/\[[0-9]+\]/g, "") || '').toLowerCase().indexOf(meta[3].toLowerCase()) >= 0;
-};
-