mizuho 0.9.8 → 0.9.9

data/templates/topbar.css

@@ -0,0 +1,116 @@
+#topbar {
+	position: fixed;
+	left: 0;
+	top: 0;
+	right: 0;
+	height: 2.5em;
+	padding-left: 10%;
+	padding-right: 10%;
+	z-index: 1;
+	background: #880000;
+	overflow: hidden;
+	white-space: nowrap;
+	box-shadow: 0px 3px 6px #555555;
+	-moz-box-shadow: 0px 3px 6px #555555;
+	-webkit-box-shadow: 0px 3px 6px #555555;
+	-o-box-shadow: 0px 3px 6px #555555;
+}
+
+#topbar .title {
+	display: inline-block;
+	margin: 0.6em 1em 0 0;
+	vertical-align: top;
+}
+
+#topbar .title img {
+	display: none;
+	margin-right: 6px;
+	vertical-align: middle;
+}
+
+#topbar .title a {
+	color: #fffafa;
+	border: 0;
+}
+
+#topbar .title:hover img,
+.mobile #topbar .title img {
+	display: inline-block;
+	margin-left: -17px;
+}
+
+#topbar .title:hover a,
+.mobile #topbar .title a {
+	color: #ffffdd;
+}
+
+#floattoc {
+	position: fixed;
+	z-index: 1;
+	top: 2em;
+	bottom: 20%;
+	width: 50%;
+	background: #f0f0f0;
+	color: black;
+	box-shadow: 0px 6px 6px #555555;
+	-moz-box-shadow: 0px 6px 6px #555555;
+	-webkit-box-shadow: 0px 6px 6px #555555;
+	-o-box-shadow: 0px 6px 6px #555555;
+	overflow: auto;
+	padding: 1em;
+	border-radius: 6px;
+	-webkit-border-radius: 8px;
+	-webkit-border-top-left-radius: 0;
+	-webkit-border-top-right-radius: 0;
+	-moz-border-radius: 8px;
+	-moz-border-radius-topleft: 0;
+	-moz-border-top-right-radius: 0;
+	-o-border-radius: 8px;
+	-o-border-radius-topleft: 0;
+	-o-border-top-right-radius: 0;
+	border-radius: 8px;
+	border-top-left-radius: 0;
+	border-top-right-radius: 0;
+}
+
+#floattoc a.current {
+	font-weight: bold;
+	color: black;
+}
+
+#current_section {
+	display: inline-block;
+	margin: 0.5em 0 0 0;
+	padding: 0.2em 0.5em 0.2em 0.5em;
+	background: #550000;
+	font-size: 90%;
+	vertical-align: top;
+	color: white;
+	border: none;
+	-webkit-border-radius: 8px;
+	-moz-border-radius: 8px;
+	-o-border-radius: 8px;
+	border-radius: 8px;
+}
+
+#current_section:hover {
+	text-decoration: none;
+	border: none;
+}
+
+#current_section.pressed {
+	background: #f0f0f0;
+	color: black;
+	-webkit-border-top-left-radius: 8px;
+	-webkit-border-top-right-radius: 8px;
+	-webkit-border-bottom-left-radius: 0;
+	-webkit-border-bottom-right-radius: 0;
+	-moz-border-radius-topleft: 8px;
+	-moz-border-radius-topright: 8px;
+	-moz-border-bottom-left-radius: 0;
+	-moz-border-bottom-right-radius: 0;
+	border-top-left-radius: 8px;
+	border-top-right-radius: 8px;
+	border-bottom-left-radius: 0;
+	border-bottom-right-radius: 0;
+}

data/templates/topbar.html

@@ -0,0 +1,7 @@
+<div id="topbar" style="display: none">
+	<div class="title">
+		<img src="{INLINE_IMAGE:arrow-up.png}" width="11" height="10" alt="">
+		<a href="javascript:void(Mizuho.smoothlyScrollToToc())">{TITLE}</a>
+	</div>
+	<a href="javascript:void(0)" id="current_section"></a>
+</div>

data/templates/topbar.js

@@ -0,0 +1,175 @@
+Mizuho.initializeTopBar = $.proxy(function() {
+	var $window = this.$window;
+	var $document = this.$document;
+	var self = this;
+	var $topbar = $('#topbar');
+	var $title = $('#header h1');
+	var $currentSection = $('#current_section');
+	var isMobileDevice = this.isMobileDevice();
+	var timerId;
+	
+	var $floattoc = $('<div id="floattoc"></div>').html($('#toc').html());
+	$floattoc.find('#toctitle').remove();
+	$floattoc.find('.comments').remove();
+	$floattoc.css('visibility', 'hidden');
+	$floattoc.insertAfter($topbar);
+	var $floattoclinks = $floattoc.find('a');
+	$floattoclinks.each(function() {
+		// Firefox changes '#!' to '#%21' so change that back.
+		var $this = $(this);
+		var href = $this.attr('href');
+		if (href.match(/^#%21/)) {
+			$this.attr('href', href.replace(/^#%21/, '#!'));
+		}
+	});
+	$floattoclinks.click(function(event) {
+		self.internalLinkClicked(this, event);
+	});
+	
+	function showFloatingToc() {
+		var scrollUpdateTimerId;
+		
+		function reposition() {
+			if (isMobileDevice) {
+				$floattoc.css({
+					top: $currentSection.offset().top +
+						$currentSection.innerHeight() +
+						'px',
+					height: $window.height() * 0.7 + 'px'
+				});
+			}
+		}
+		
+		function highlightCurrentTocEntry() {
+			var currentSubsection = self.currentSubsection();
+			$floattoclinks.removeClass('current');
+			if (currentSubsection) {
+				var currentSubsectionTitle = $(currentSubsection).text();
+				var $link;
+				
+				$floattoclinks.each(function() {
+					if ($(this).text() == currentSubsectionTitle) {
+						$link = $(this);
+						return false;
+					}
+				});
+				if ($link) {
+					$link.addClass('current');
+					self.setScrollTop(
+						$floattoc.scrollTop() +
+							$link.position().top -
+							$floattoc.height() * 0.45,
+						$floattoc);
+					return false;
+				}
+			}
+		}
+		
+		function hideFloatingToc() {
+			$currentSection.removeClass('pressed');
+			$floattoc.css('visibility', 'hidden');
+			$floattoclinks.unbind('click', hideFloatingToc);
+			$document.unbind('mousedown', onMouseDown);
+			$document.unbind('touchdown', onMouseDown);
+			$document.unbind('mizuho:hideTopBar', hideFloatingToc);
+			$window.unbind('scroll', onScroll);
+			if (scrollUpdateTimerId !== undefined) {
+				clearTimeout(scrollUpdateTimerId);
+				scrollUpdateTimerId = undefined;
+			}
+		}
+		
+		function onMouseDown(event) {
+			if (event.target != $floattoc[0]
+			 && $(event.target).closest('#floattoc').length == 0) {
+				hideFloatingToc();
+			}
+		}
+		
+		function onScroll(event) {
+			if (scrollUpdateTimerId === undefined) {
+				scrollUpdateTimerId = setTimeout(function() {
+					scrollUpdateTimerId = undefined;
+					reposition();
+					highlightCurrentTocEntry();
+				}, 100);
+			}
+		}
+		
+		// Layout and display floating TOC.
+		highlightCurrentTocEntry();
+		var origScrollTop = $document.scrollTop();
+		var windowWidth = $window.width();
+		var maxRight = windowWidth - Math.floor(windowWidth * 0.1);
+		
+		if ($currentSection.offset().left + $floattoc.outerWidth() > maxRight) {
+			$floattoc.css('left', maxRight - $floattoc.outerWidth());
+		} else {
+			$floattoc.css('left', $currentSection.offset().left + 'px');
+		}
+		reposition();
+		$floattoc.css('visibility', 'visible');
+		$currentSection.addClass('pressed');
+		
+		$floattoclinks.bind('click', hideFloatingToc);
+		$document.bind('mousedown', onMouseDown)
+		$document.bind('touchdown', onMouseDown);
+		$document.bind('mizuho:hideTopBar', hideFloatingToc);
+		$window.bind('scroll', onScroll);
+	}
+	
+	function update() {
+		if ($title.offset().top + $title.height() < $document.scrollTop()) {
+			if (!$topbar.is(':visible')) {
+				$topbar.slideDown(250);
+				$document.trigger('mizuho:showTopBar');
+			}
+		} else {
+			if ($topbar.is(':visible')) {
+				$topbar.slideUp();
+				$document.trigger('mizuho:hideTopBar');
+			}
+		}
+		
+		if (isMobileDevice) {
+			$topbar.css({
+				top: $document.scrollTop() + 'px',
+				width: $window.width() -
+					parseInt($topbar.css('padding-left')) -
+					parseInt($topbar.css('padding-right')) +
+					'px'
+			});
+		}
+		
+		var header = self.currentSubsection();
+		var name;
+		if (header) {
+			name = $(header).text();
+		} else {
+			name = 'Preamble';
+		}
+		$currentSection.text(name);
+	}
+	
+	function scheduleUpdate() {
+		if (timerId !== undefined) {
+			return;
+		}
+		timerId = setTimeout(function() {
+			timerId = undefined;
+			update();
+		}, 100);
+	}
+	
+	if (isMobileDevice) {
+		// Mobile devices don't support position fixed.
+		$topbar.css('position', 'absolute');
+		$floattoc.css('position', 'absolute');
+	}
+	
+	$currentSection.click(showFloatingToc);
+	$window.scroll(scheduleUpdate);
+	$document.bind('mizuho:updateTopBar', update);
+}, Mizuho);
+
+$(document).ready(Mizuho.initializeTopBar);

data/test/id_map_spec.rb

@@ -0,0 +1,188 @@
+# Copyright (c) 2012 Hongli Lai
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+require 'stringio'
+require 'mizuho/id_map'
+
+describe Mizuho::IdMap do
+	before :each do
+		@id_map = Mizuho::IdMap.new
+	end
+
+	describe "#associate" do
+		describe "if the given title is not in the map" do
+			describe "if no similar titles exist in the map" do
+				before :each do
+					@id1 = @id_map.associate "Installation"
+					@id2 = @id_map.associate "Installation on Linux"
+					@id3 = @id_map.associate "Configuration"
+				end
+
+				it "returns a new unique ID" do
+					@id1.should_not == @id2
+					@id1.should_not == @id3
+				end
+
+				it "marks the entry as associated" do
+					@id_map["Installation"].should be_associated
+					@id_map["Installation on Linux"].should be_associated
+					@id_map["Configuration"].should be_associated
+				end
+
+				it "doesn't mark the corresponding entry as fuzzy" do
+					@id_map["Installation"].should_not be_fuzzy
+					@id_map["Installation on Linux"].should_not be_fuzzy
+					@id_map["Configuration"].should_not be_fuzzy
+				end
+			end
+
+			describe "if one or more similar titles exist in the map" do
+				before :each do
+					@entry1 = @id_map.add("Installation using a tarball", nil, false, false)
+					@entry2 = @id_map.add("Installation using a Linux tarball", nil, false, false)
+				end
+
+				it "associates with the most similar title and returns its ID" do
+					@id3 = @id_map.associate "Installation using tarball"
+					@id3.should == @entry1.id
+					@entry1.title.should == "Installation using tarball"
+				end
+
+				it "only associates with a title that hasn't been associated before" do
+					@entry1.associated = true
+					@id3 = @id_map.associate "Installation using tarball"
+					@id3.should == @entry2.id
+				end
+
+				it "marks the corresponding entry as associated" do
+					@id_map.associate "Installation using tarball"
+					@id_map["Installation using tarball"].should be_associated
+				end
+
+				it "marks the corresponding entry as fuzzy" do
+					@id_map.associate "Installation using tarball"
+					@id_map["Installation using tarball"].should be_fuzzy
+				end
+			end
+
+			specify "title matching is case-insensitive" do
+				entry1 = @id_map.add("INSTALLATION USING A TARBALL", nil, false, false)
+				id = @id_map.associate "installation using tarball"
+				id.should == entry1.id
+			end
+		end
+
+		describe "if the given title is in the map and it hasn't been associated before" do
+			before :each do
+				@entry = @id_map.add("Installation", nil, false, false)
+			end
+
+			it "returns that title's previous ID" do
+				id = @id_map.associate "Installation"
+				id.should == @entry.id
+			end
+
+			it "marks the entry as associated" do
+				@id_map.associate "Installation"
+				@entry.should be_associated
+			end
+
+			it "preserves the entry's fuzziness" do
+				@id_map.associate "Installation"
+				@entry.should_not be_fuzzy
+
+				@entry2 = @id_map.add("Installation 2", nil, true, false)
+				@id_map.associate "Installation 2"
+				@entry2.should be_fuzzy
+			end
+		end
+
+		describe "if the given title is in the map and it has been associated before" do
+			it "raises an error" do
+				@entry = @id_map.add("Installation", nil, false, true)
+				lambda { @id_map.associate "Installation" }.should raise_error(Mizuho::IdMap::AlreadyAssociatedError)
+			end
+		end
+	end
+
+	describe "loading" do
+		before :each do
+			@io = StringIO.new
+		end
+
+		it "works" do
+			@io.puts "# This is a comment."
+			@io.puts ""
+			@io.puts "Installation	=>	installation-1"
+			@io.puts "Configuration	=>	configuration-2"
+			@io.puts "# fuzzy"
+			@io.puts "Troubleshooting	=>	troubleshooting-1"
+			@io.rewind
+			@id_map.load(@io)
+
+			@id_map.entries.should have(3).items
+			@id_map.entries.each_value { |entry| entry.should_not be_associated }
+			
+			entry = @id_map["Installation"]
+			entry.title.should == "Installation"
+			entry.id.should == "installation-1"
+			entry.should_not be_fuzzy
+
+			entry = @id_map["Configuration"]
+			entry.title.should == "Configuration"
+			entry.id.should == "configuration-2"
+			entry.should_not be_fuzzy
+
+			entry = @id_map["Troubleshooting"]
+			entry.title.should == "Troubleshooting"
+			entry.id.should == "troubleshooting-1"
+			entry.should be_fuzzy
+		end
+	end
+
+	describe "saving" do
+		before :each do
+			@io = StringIO.new
+			@id_map.add "1. Installation", "installation-1", false, true
+			@id_map.add "2. Configuration", "configuration-2", false, true
+			@id_map.add "3. Troubleshooting", "troubleshooting-1", true, true
+			@id_map.add "4. Administration", "administration-1", true, false
+			@id_map.add "5. Uninstallation", "uninstallation-1", false, false
+			@id_map.add "0. Introduction", "intro", false, true
+		end
+
+		it "saves all entries in alphabetical order, marks fuzzy entries as such and puts unassociated (orphaned) entries at the bottom" do
+			@id_map.save(@io)
+			@io.string.should ==
+				Mizuho::IdMap::BANNER +
+				"0. Introduction	=>	intro\n\n" +
+				"1. Installation	=>	installation-1\n\n" +
+				"2. Configuration	=>	configuration-2\n\n" +
+				"# fuzzy\n" +
+				"3. Troubleshooting	=>	troubleshooting-1\n\n" +
+				"\n" +
+				"### These sections appear to have been removed. Please check.\n\n" +
+				"# fuzzy\n" +
+				"4. Administration	=>	administration-1\n\n" +
+				"5. Uninstallation	=>	uninstallation-1\n\n"
+		end
+	end
+end