' +
' ' +
'
');
var shadow = $('#comments_lightbox_shadow', lightbox);
var contents = $('#comments_lightbox_contents > .shell', lightbox);
function close() {
if (lightbox) {
lightbox.remove();
lightbox = undefined;
if (closeCallback) {
closeCallback();
}
}
}
shadow.click(close);
lightbox.bind('lightbox:close', close);
lightbox.appendTo(document.body);
creationCallback(contents);
}, Mizuho);
Mizuho.getCommentThreadInfo = $.proxy(function(balloon) {
var info = {};
if ($(balloon).closest('#toc').length > 0) {
info.id = 'toctitle';
info.topic = 'toctitle';
info.title = $('#header h1').text() + " - " + $('#toctitle').text();
} else {
var header = $(balloon).next('h2, h3, h4');
if (header.length > 0) {
info.id = header.attr('id');
info.topic = header.data('comment-topic');
info.title = $('#header h1').text() + " - " + header.text();
} else {
info = undefined;
}
}
return info;
}, Mizuho);
Mizuho.callJuviaApi = function(action, options) {
function makeQueryString(options) {
var key, params = [];
for (key in options) {
params.push(
encodeURIComponent(key) +
'=' +
encodeURIComponent(options[key]));
}
return params.join('&');
}
// Makes sure that each call generates a unique URL, otherwise
// the browser may not actually perform the request.
if (!('_juviaRequestCounter' in window)) {
window._juviaRequestCounter = 0;
}
var url =
JUVIA_URL + '/api/' + action +
'?_c=' + window._juviaRequestCounter +
'&' + makeQueryString(options);
window._juviaRequestCounter++;
var s = document.createElement('script');
s.async = true;
s.type = 'text/javascript';
s.className = 'juvia';
s.src = url;
(document.getElementsByTagName('head')[0] ||
document.getElementsByTagName('body')[0]).appendChild(s);
}
Mizuho.showCommentsPopup = $.proxy(function(balloon) {
var info = this.getCommentThreadInfo(balloon);
if (!info) {
return;
}
var self = this;
this.showLightbox(function(element) {
// We install a 'Close' button in the Juvia comment form after it has loaded.
function installCloseButton() {
if ($('#comments .juvia-form-actions').size() > 0) {
// The Juvia form is now loaded. Install the button.
var div = $('');
var button = $('').appendTo(div);
div.insertBefore('#comments .juvia-form-actions .juvia-error');
button.click(function() {
$(element).trigger('lightbox:close');
});
} else {
// Continue polling.
setTimeout(installCloseButton, 50);
}
}
setTimeout(installCloseButton, 50);
// Now load the Juvia comments form.
element.html('' +
'
Loading comments...
');
self.changingHash = true;
location.hash = '#!/' + info.id;
self.callJuviaApi('show_topic.js', {
container : '#comments',
site_key : JUVIA_SITE_KEY,
topic_key : info.topic,
topic_url : location.href,
topic_title : info.topic,
include_base: !window.Juvia,
include_css : !window.Juvia
});
}, function() {
self.reloadCommentCount();
});
}, Mizuho);
Mizuho.reloadCommentCount = $.proxy(function() {
this.callJuviaApi('list_topics.jsonp', {
site_key: JUVIA_SITE_KEY,
jsonp : 'Mizuho.topicListReceived'
});
}, Mizuho);
Mizuho.topicListReceived = $.proxy(function(result) {
var self = this;
var i, topic, map = {};
for (i = 0; i < result.topics.length; i++) {
topic = result.topics[i];
map[topic.key] = topic;
}
this.commentBalloons.each(function() {
var info = self.getCommentThreadInfo(this);
if (info) {
topic = map[info.topic];
if (topic) {
var balloon = $(this);
$('.count', balloon).text(topic.comment_count);
balloon.removeClass('empty');
balloon.addClass('nonempty');
balloon.attr('title', null);
}
}
});
}, Mizuho);
$(document).ready(Mizuho.initializeCommenting);
mizuho-0.9.20/templates/mizuho.js 0000644 0000041 0000041 00000011411 12261241511 017005 0 ustar www-data www-data // IE...
if (!Date.now) {
Date.now = function() {
return new Date().getTime();
}
}
var Mizuho = {
/** Cached DOM elements so that we don't have to re-find them over and over. */
$document: undefined,
$window: undefined,
$mainSections: undefined,
$sectionHeaders: undefined,
/** Constants */
MAX_TOC_LEVEL: 3,
sectionHeadersSelector: undefined,
scrollMemory: {},
changingHash: false,
activeHash: undefined,
/** Whether in single-page or multi-page mode. Either 'single' or 'multi'. */
mode: 'single',
/** Whether smooth scrolling is enabled. It is always enabled except right
* after page load: when the page is scrolled to the section as pointed to
* by location.hash.
*/
smoothScrolling: true,
initialize: function() {
this.sectionHeadersSelector = '';
for (var i = 0; i < this.MAX_TOC_LEVEL; i++) {
if (i != 0) {
this.sectionHeadersSelector += ', ';
}
this.sectionHeadersSelector += 'h' + (i + 2);
}
this.$document = $(document);
this.$window = $(window);
this.$mainSections = $('.sect1');
this.$sectionHeaders = $(this.sectionHeadersSelector, '#content');
this.$sectionHeaders.sort(function(a, b) {
var off_a = $(a).offset();
var off_b = $(b).offset();
return off_a.top - off_b.top;
});
if (this.isMobileDevice()) {
$(document.body).addClass('mobile');
}
},
/********* Generic utility functions *********/
isMobileDevice: function() {
return navigator.userAgent.match(
/(IEMobile|Windows CE|NetFront|PlayStation|PLAYSTATION|like Mac OS X|MIDP|UP\.Browser|Symbian|Nintendo|Android)/
);
},
virtualAnimate: function(options) {
var options = $.extend({
duration: 1000
}, options || {});
var animation_start = Date.now();
var animation_end = Date.now() + options.duration;
var interval = animation_end - animation_start;
this._virtualAnimate_step(animation_start, animation_end, interval, options);
},
_virtualAnimate_step: function(animation_start, animation_end, interval, options) {
var self = this;
var now = new Date();
var progress = (now - animation_start) / interval;
if (progress > 1) {
progress = 1;
}
progress = (1 + Math.sin(-Math.PI / 2 + progress * Math.PI)) / 2;
options.step(progress);
if (now < animation_end) {
setTimeout(function() {
self._virtualAnimate_step(animation_start,
animation_end, interval, options);
}, 15);
} else {
options.step(1);
if (options.finish) {
options.finish();
}
}
},
smoothlyScrollTo: function(top) {
if (!this.smoothScrolling) {
return this.setScrollTop(top);
}
var self = this;
var $document = this.$document;
var current = $document.scrollTop();
this.virtualAnimate({
duration: 300,
step: function(x) {
$document.scrollTop(Math.floor(
top + (1 - x) * (current - top)
));
},
finish: function() {
self.setScrollTop(top);
}
});
},
smoothlyScrollToToc: function() {
this.smoothlyScrollTo($('#toc').position().top);
},
scrollToHeader: function(header) {
this.smoothlyScrollTo($(header).offset().top - 50);
},
setScrollTop: function(top, element) {
// Browsers don't always scroll properly so work around
// this with a few timers.
var self = this;
element = element || this.$document;
element = $(element);
element.scrollTop(top);
setTimeout(function() {
element.scrollTop(top);
}, 1);
setTimeout(function() {
element.scrollTop(top);
self.$document.trigger('mizuho:updateTopBar');
}, 20);
},
/********* Mizuho-specific functions *********/
/** Returns the currently displayed section's header DOM element. */
currentSubsection: function() {
var $sectionHeaders = this.$sectionHeaders;
var scrollTop = this.$document.scrollTop();
var windowHeight = this.$window.height();
var offset;
var low = 0;
var high = this.$sectionHeaders.length - 1;
var mid = 0;
while (low <= high) {
mid = Math.floor((low + high) / 2);
offset = $($sectionHeaders[mid]).offset();
if (offset.top >= scrollTop) {
high = mid - 1;
} else {
low = mid + 1;
}
}
var $found = $($sectionHeaders[low]);
if ($found.offset().top > scrollTop + windowHeight) {
if (low > 0) {
return $sectionHeaders[low - 1];
} else {
return undefined;
}
} else {
return $sectionHeaders[low];
}
},
/** Looks up a section's header DOM element corresponding to a hash name. */
lookupHeader: function(hash) {
var id = hash.replace(/^#!\//, '#');
if (id == '') {
return undefined;
} else {
var header = $(id);
if (header.length == 0) {
return undefined;
} else {
return header;
}
}
}
};
for (var key in Mizuho) {
if (typeof(Mizuho[key]) == 'function') {
Mizuho[key] = $.proxy(Mizuho[key], Mizuho);
}
}
$(document).ready(Mizuho.initialize);
//$(document).ready(Mizuho.installHashbangLinks);
mizuho-0.9.20/templates/mizuho.css 0000644 0000041 0000041 00000003067 12261241511 017171 0 ustar www-data www-data body {
margin: 1em auto 1em auto;
padding: 0 1em 0 1em;
max-width: 800px;
}
a.image {
border: none;
}
.comments {
display: block;
background: url('balloon.png') top left no-repeat;
float: left;
margin-left: -55px;
width: 36px;
height: 48px;
line-height: 0;
color: black;
text-decoration: none !important;
border: none !important;
}
#toc .comments {
margin-top: 0.25em;
}
.sect1 .comments {
margin-top: 0.5em;
}
.sect2 .comments {
margin-top: 1.15em;
}
.sect3 .comments {
margin-top: -1em;
}
.comments.empty {
opacity: 0.2;
}
.comments.empty:hover,
.comments.nonempty {
opacity: 1;
}
.comments .count {
display: block;
font-size: 80%;
padding-top: 12px;
text-align: center;
text-shadow: 1px 1px 2px white;
}
#comments_lightbox_shadow {
position: fixed;
top: 0;
left: 0;
right: 0;
bottom: 0;
background: black;
opacity: 0.7;
z-index: 10;
}
#comments_lightbox_contents {
position: fixed;
top: 10%;
left: 20%;
right: 20%;
bottom: 10%;
background: white;
overflow: auto;
z-index: 11;
}
#comments_lightbox_contents > .shell {
margin: 2em;
}
pre {
overflow: auto;
}
@media print {
body {
font-size: 18pt;
}
#header h1 {
page-break-after: always;
font-size: 500%;
vertical-align: middle;
}
#header {
page-break-after: always;
}
#toctitle {
font-size: 200%;
margin-bottom: 1em;
}
div.toclevel1 {
font-size: 100%;
}
div.toclevel2 {
font-size: 90%;
}
div.toclevel3 {
font-size: 80%;
}
#content .comments {
display: none;
}
@page :left {
@bottom-left {
content: counter(page);
}
}
}
mizuho-0.9.20/templates/jquery.hashchange-1.0.0.js 0000644 0000041 0000041 00000006055 12261241511 021543 0 ustar www-data www-data /**
* jQuery hashchange 1.0.0
*
* (based on jquery.history)
*
* Copyright (c) 2008 Chris Leishman (chrisleishman.com)
* Dual licensed under the MIT (MIT-LICENSE.txt)
* and GPL (GPL-LICENSE.txt) licenses.
*/
(function($) {
$.fn.extend({
hashchange: function(callback) { this.bind('hashchange', callback) },
openOnClick: function(href) {
if (href === undefined || href.length == 0)
href = '#';
return this.click(function(ev) {
if (href && href.charAt(0) == '#') {
// execute load in separate call stack
window.setTimeout(function() { $.locationHash(href) }, 0);
} else {
window.location(href);
}
ev.stopPropagation();
return false;
});
}
});
// IE 8 introduces the hashchange event natively - so nothing more to do
if ($.browser.msie && document.documentMode && document.documentMode >= 8) {
$.extend({
locationHash: function(hash) {
if (!hash) hash = '#';
else if (hash.charAt(0) != '#') hash = '#' + hash;
location.hash = hash;
}
});
return;
}
var curHash;
// hidden iframe for IE (earlier than 8)
var iframe;
$.extend({
locationHash: function(hash) {
if (curHash === undefined) return;
if (!hash) hash = '#';
else if (hash.charAt(0) != '#') hash = '#' + hash;
location.hash = hash;
if (curHash == hash) return;
curHash = hash;
if ($.browser.msie) updateIEFrame(hash);
$.event.trigger('hashchange');
}
});
$(document).ready(function() {
curHash = location.hash;
if ($.browser.msie) {
// stop the callback firing twice during init if no hash present
if (curHash == '') curHash = '#';
// add hidden iframe for IE
iframe = $('').hide().get(0);
$('body').prepend(iframe);
updateIEFrame(location.hash);
setInterval(checkHashIE, 100);
} else {
setInterval(checkHash, 100);
}
});
$(window).unload(function() { iframe = null });
function checkHash() {
var hash = location.hash;
if (hash != curHash) {
curHash = hash;
$.event.trigger('hashchange');
}
}
if ($.browser.msie) {
// Attach a live handler for any anchor links
$('a[href^=#]').live('click', function() {
var hash = $(this).attr('href');
// Don't intercept the click if there is an existing anchor on the page
// that matches this hash
if ($(hash).length == 0 && $('a[name='+hash.slice(1)+']').length == 0) {
$.locationHash(hash);
return false;
}
});
}
function checkHashIE() {
// On IE, check for location.hash of iframe
var idoc = iframe.contentDocument || iframe.contentWindow.document;
var hash = idoc.location.hash;
if (hash == '') hash = '#';
if (hash != curHash) {
if (location.hash != hash) location.hash = hash;
curHash = hash;
$.event.trigger('hashchange');
}
}
function updateIEFrame(hash) {
if (hash == '#') hash = '';
var idoc = iframe.contentWindow.document;
idoc.open();
idoc.close();
if (idoc.location.hash != hash) idoc.location.hash = hash;
}
})(jQuery); mizuho-0.9.20/lib/ 0000755 0000041 0000041 00000000000 12261241511 013706 5 ustar www-data www-data mizuho-0.9.20/lib/mizuho/ 0000755 0000041 0000041 00000000000 12261241511 015221 5 ustar www-data www-data mizuho-0.9.20/lib/mizuho/id_map.rb 0000644 0000041 0000041 00000021544 12261241511 017005 0 ustar www-data www-data # encoding: utf-8
# Copyright (c) 2011-2013 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 'mizuho/fuzzystringmatch'
require 'mizuho/utils'
module Mizuho
class IdMap
class AlreadyAssociatedError < StandardError
end
include Utils
URANDOM = File.open("/dev/urandom", "rb")
MATCHER = JaroWinklerPure.new
BANNER =
"###### Autogenerated by Mizuho, DO NOT EDIT ######\n" <<
"# This file maps section names to IDs so that the commenting system knows which\n" <<
"# comments belong to which section. Section names may be changed at will but\n" <<
"# IDs always stay the same, allowing one to retain old comments even if you\n" <<
"# rename a section.\n" <<
"#\n" <<
"# This file is autogenerated but is not a cache; you MUST NOT DELETE this\n" <<
"# file and you must check it into your version control system. If you lose\n" <<
"# this file you may lose the ability to identity old comments.\n" <<
"#\n" <<
"# Entries marked with \"fuzzy\" indicate that the section title has changed\n" <<
"# and that Mizuho has found an ID which appears to be associated with that\n" <<
"# section. You should check whether it is correct, and if not, fix it.\n\n"
attr_reader :entries, :associations
def initialize
@entries = {}
@associations = {}
#@namespace = slug(File.basename(filename, File.extname(filename)))
end
def load(filename_or_io)
@entries.clear
open_io(filename_or_io, :read) do |io|
fuzzy = false
while true
begin
line = io.readline.strip
if line.empty?
fuzzy = false
elsif line == "# fuzzy"
fuzzy = true
elsif line !~ /\A#/
title, id = line.split("\t=>\t", 2)
add(title, id, fuzzy, false)
fuzzy = false
end
rescue EOFError
break
end
end
end
return self
end
def save(filename_or_io)
normal, orphaned = group_and_sort_entries
output = ""
output << BANNER
normal.each do |entry|
output << "# fuzzy\n" if entry.fuzzy?
output << "#{entry.title} => #{entry.id}\n"
output << "\n"
end
if !orphaned.empty?
output << "\n"
output << "### These sections appear to have been removed. Please check.\n"
output << "\n"
orphaned.each do |entry|
output << "# fuzzy\n" if entry.fuzzy?
output << "#{entry.title} => #{entry.id}\n"
output << "\n"
end
end
open_io(filename_or_io, :write) do |f|
f.write(output)
end
end
def generate_associations(titles)
@associations = {}
# Associate exact matches.
titles = titles.reject do |title|
if (entry = @entries[title]) && !entry.associated?
entry.associated = true
@associations[title] = entry.id
true
else
false
end
end
# For the remaining titles, associate with moved or similar-looking entry.
titles.reject! do |title|
if entry = find_moved(title)
@entries.delete(entry.title)
@entries[title] = entry
entry.title = title
entry.associated = true
entry.fuzzy = false
@associations[title] = entry.id
true
else
false
end
end
# For the remaining titles, associate with similar-looking entry.
titles.reject! do |title|
if entry = find_similar(title)
@entries.delete(entry.title)
@entries[title] = entry
entry.title = title
entry.associated = true
entry.fuzzy = true
@associations[title] = entry.id
true
else
false
end
end
# For the remaining titles, create new entries.
titles.each do |title|
id = create_unique_id(title)
add(title, id, false, true)
@associations[title] = id
end
end
def xassociate(title)
if entry = @entries[title]
if entry.associated?
raise AlreadyAssociatedError, "Cannot associate an already associated title (#{title.inspect})"
else
entry.associated = true
id = entry.id
end
elsif (moved_entry = find_moved(title)) || (similar_entry = find_similar(title))
if moved_entry
puts "moved entry: #{title.inspect} -> #{moved_entry.title.inspect}"
elsif similar_entry
puts "similar entry: #{title.inspect} -> #{similar_entry.title.inspect}"
end
entry = (moved_entry || similar_entry)
@entries.delete(entry.title)
@entries[title] = entry
entry.title = title
entry.associated = true
entry.fuzzy = true if similar_entry
id = entry.id
else
id = create_unique_id(title)
add(title, id, false, true)
end
return id
end
def add(title, id, *options)
return @entries[title] = Entry.new(title, id || create_unique_id(title), *options)
end
def stats
fuzzy = 0
orphaned = 0
@entries.each_value do |entry|
fuzzy += 1 if entry.fuzzy?
orphaned += 1 if !entry.associated?
end
return { :fuzzy => fuzzy, :orphaned => orphaned }
end
private
# fuzzy
# Whether #associate has fuzzily associated a title with this entry.
#
# associated
# Whether #associate has associated a title with this entry.
# Immediately after loading a map file, all entries are marked
# as 'not associated'.
class Entry < Struct.new(:title, :id, :fuzzy, :associated)
alias fuzzy? fuzzy
alias associated? associated
def <=>(other)
if (a = Utils.extract_chapter(title)) &&
(b = Utils.extract_chapter(other.title))
# Sort by chapter whenever possible.
a[0] = Utils.chapter_to_int_array(a[0])
b[0] = Utils.chapter_to_int_array(b[0])
return a <=> b
else
return title <=> other.title
end
end
end
def find_moved(title)
orig_chapter, orig_pure_title = extract_chapter(title)
return nil if !orig_chapter
# Find all possible matches.
orig_chapter_digits = chapter_to_int_array(orig_chapter)
matches = []
@entries.each_value do |entry|
next if entry.associated?
chapter, pure_title = extract_chapter(entry.title)
if chapter && orig_pure_title == pure_title
matches << {
:chapter_digits => chapter_to_int_array(chapter),
:pure_title => pure_title,
:entry => entry
}
end
end
# Iterate until we find the best match. We match the chapter
# digits from left to right.
digit_match_index = 0
while matches.size > 1
orig_digit = orig_chapter_digits[digit_match_index] || 1
# Find closest digit in all matches.
tmp = matches.min do |a, b|
x = a[:chapter_digits][digit_match_index] - orig_digit
y = b[:chapter_digits][digit_match_index] - orig_digit
x.abs <=> y.abs
end
closest_digit = tmp[:chapter_digits][digit_match_index]
# Filter out all matches with this digit.
matches = matches.find_all do |m|
m[:chapter_digits][digit_match_index] == closest_digit
end
# If a next iteration is necessary, we check the next digit.
digit_match_index += 1
end
if matches.empty?
return nil
else
return matches[0][:entry]
end
end
def find_similar(title)
lower_title = title.downcase
best_score = nil
best_match = nil
@entries.each_value do |entry|
next if entry.associated?
score = MATCHER.getDistance(entry.title.downcase, lower_title)
if best_score.nil? || score > best_score
best_score = score
best_match = entry
end
end
if best_score && best_score > 0.8
return best_match
else
return nil
end
end
def slug(text)
text = text.downcase
text.gsub!(/^(\d+\.)+ /, '')
text.gsub!(/[^a-z0-9\-\_]/i, '-')
text.gsub!('_', '-')
text.gsub!(/--+/, '-')
return text
end
def create_unique_id(title)
suffix = URANDOM.read(4).unpack('H*')[0].to_i(16).to_s(36)
return "#{slug(title)}-#{suffix}"
end
def open_io(filename_or_io, mode, &block)
if mode == :read
if filename_or_io.respond_to?(:readline)
yield(filename_or_io)
else
File.open(filename_or_io, 'r', &block)
end
else
if filename_or_io.respond_to?(:write)
yield(filename_or_io)
else
File.open(filename_or_io, 'w', &block)
end
end
end
def group_and_sort_entries
normal = []
orphaned = []
@entries.each_value do |entry|
if entry.associated?
normal << entry
else
orphaned << entry
end
end
normal.sort!
orphaned.sort!
return [normal, orphaned]
end
end
end mizuho-0.9.20/lib/mizuho/utils.rb 0000644 0000041 0000041 00000004021 12261241511 016703 0 ustar www-data www-data # encoding: utf-8
# Copyright (c) 2013 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.
module Mizuho
module Utils
extend self
def self.included(klass)
# When included into another class, make sure that Utils
# methods are made private.
public_instance_methods(false).each do |method_name|
klass.send(:private, method_name)
end
end
# Given a title with a chapter number, e.g. "6.1 Installation using tarball",
# splits the two up.
def extract_chapter(title)
title =~ /^((\d+\.)*) (.+)$/
chapter = $1
pure_title = $3
if !chapter.nil? && !chapter.empty? && pure_title && !pure_title.empty?
return [chapter, pure_title]
else
return nil
end
end
def chapter_to_int_array(chapter)
return chapter.split('.').map { |x| x.to_i }
end
def title_to_docid(title)
chapter, pure_title = extract_chapter(title)
p title
numbers = chapter_to_int_array(chapter)
result = 0
bit_offset = 0
numbers.each do |num|
result = result | (num << bit_offset)
bit_offset += 5
end
return result
end
end
end
mizuho-0.9.20/lib/mizuho/fuzzystringmatch.rb 0000644 0000041 0000041 00000004566 12261241511 021214 0 ustar www-data www-data # encoding: utf-8
# Extracted from https://github.com/kiyoka/fuzzy-string-match
#
# Fuzzy String Match
#
# Copyright 2010 Kiyoka Nishiyama
#
# 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.
#
module Mizuho
class JaroWinklerPure
THRESHOLD = 0.7
def getDistance( s1, s2 )
a1 = s1.split( // )
a2 = s2.split( // )
if s1.size > s2.size
(max,min) = a1,a2
else
(max,min) = a2,a1
end
range = [ (max.size / 2 - 1), 0 ].max
indexes = Array.new( min.size, -1 )
flags = Array.new( max.size, false )
matches = 0;
(0 ... min.size).each { |mi|
c1 = min[mi]
xi = [mi - range, 0].max
xn = [mi + range + 1, max.size].min
(xi ... xn).each { |i|
if (not flags[i]) && ( c1 == max[i] )
indexes[mi] = i
flags[i] = true
matches += 1
break
end
}
}
ms1 = Array.new( matches, nil )
ms2 = Array.new( matches, nil )
si = 0
(0 ... min.size).each { |i|
if (indexes[i] != -1)
ms1[si] = min[i]
si += 1
end
}
si = 0
(0 ... max.size).each { |i|
if flags[i]
ms2[si] = max[i]
si += 1
end
}
transpositions = 0
(0 ... ms1.size).each { |mi|
if ms1[mi] != ms2[mi]
transpositions += 1
end
}
prefix = 0
(0 ... min.size).each { |mi|
if s1[mi] == s2[mi]
prefix += 1
else
break
end
}
if 0 == matches
0.0
else
m = matches.to_f
t = (transpositions/ 2)
j = ((m / s1.size) + (m / s2.size) + ((m - t) / m)) / 3.0;
return j < THRESHOLD ? j : j + [0.1, 1.0 / max.size].min * prefix * (1 - j)
end
end
end
end mizuho-0.9.20/lib/mizuho/packaging.rb 0000644 0000041 0000041 00000002611 12261241511 017472 0 ustar www-data www-data # Copyright (c) 2013 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.
MIZUHO_FILES = [
"README.markdown", "LICENSE.txt", "Rakefile", "mizuho.gemspec",
"bin/*",
"lib/**/*",
"debian.template/**/*",
"rpm/**/*",
"test/*",
"templates/*",
"asciidoc/**/*",
"source-highlight/**/*"
]
MIZUHO_DEBIAN_EXCLUDE_FILES = [
"Rakefile",
"debian.template/**/*",
"rpm/**/*",
"source-highlight/**/*",
]
mizuho-0.9.20/lib/mizuho/generator.rb 0000644 0000041 0000041 00000024546 12261241511 017547 0 ustar www-data www-data # encoding: utf-8
# Copyright (c) 2008-2013 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 'nokogiri'
require 'mizuho'
require 'mizuho/source_highlight'
require 'mizuho/id_map'
require 'mizuho/utils'
module Mizuho
class GenerationError < StandardError
end
class Generator
def initialize(input, options = {})
@options = options
@input_file = input
@output_file = options[:output] || default_output_filename(input)
@id_map_file = options[:id_map] || default_id_map_filename(input)
@icons_dir = options[:icons_dir]
@conf_file = options[:conf_file]
@attributes = options[:attributes] || []
@enable_topbar = options[:topbar]
@no_run = options[:no_run]
@commenting_system = options[:commenting_system]
@index = options[:index]
@index_filename = options[:index_filename] || default_index_filename(input)
if @commenting_system == 'juvia'
require_options(options, :juvia_url, :juvia_site_key)
end
end
def start
if @commenting_system
@id_map = IdMap.new
if File.exist?(@id_map_file)
@id_map.load(@id_map_file)
else
warn "No ID map file, generating one (#{@id_map_file})..."
end
end
if !@no_run
self.class.run_asciidoc(@input_file, @output_file, @icons_dir,
@conf_file, @attributes)
end
transform(@output_file)
if @commenting_system
@id_map.save(@id_map_file)
stats = @id_map.stats
if stats[:fuzzy] > 0
warn "Warning: #{stats[:fuzzy]} fuzzy ID(s)"
end
if stats[:orphaned] > 0
warn "Warning: #{stats[:orphaned]} unused ID(s)"
end
end
end
def self.run_asciidoc(input, output, icons_dir = nil, conf_file = nil, attributes = [])
args = [
ASCIIDOC,
"-b", "html5",
"-a", "theme=flask",
"-a", "icons",
"-n"
].flatten
if icons_dir
args << "-a"
args << "iconsdir=#{icons_dir}"
end
attributes.each do |attribute|
args << "-a"
args << attribute
end
if conf_file
# With the splat operator we support a string and an array of strings.
[*conf_file].each do |cf|
args << "-f"
args << cf
end
end
args += ["-o", output, input]
if !system(*args)
raise GenerationError, "Asciidoc failed."
end
end
private
def default_output_filename(input)
return File.dirname(input) +
"/" +
File.basename(input, File.extname(input)) +
".html"
end
def default_id_map_filename(input)
return File.dirname(input) +
"/" +
File.basename(input, File.extname(input)) +
".idmap.txt"
end
def default_index_filename(input)
return File.dirname(input) +
"/" +
File.basename(input, File.extname(input)) +
".index.sqlite3"
end
def warn(message)
STDERR.puts(message)
end
def transform(filename)
File.open(filename, 'r+') do |f|
doc = Nokogiri.HTML(f)
head = (doc / "head")[0]
body = (doc / "body")[0]
title = (doc / "title")[0].text
header_div = (doc / "#header")[0]
headers = (doc / "#content" / "h1, h2, h3, h4")
head.add_child(make_node(stylesheet_tag, doc))
# Remove footer with generation timestamp.
(doc / "#footer-text").remove
# Add commenting balloons.
if @commenting_system
titles = []
headers.each do |header|
if header['class'] !~ /float/
titles << header.text
end
end
@id_map.generate_associations(titles)
headers.each do |header|
if header['class'] !~ /float/
titles << header.text
header['data-comment-topic'] = @id_map.associations[header.text]
header.add_previous_sibling(make_node(create_comment_balloon, doc))
end
end
end
# Add top bar.
if @enable_topbar
body.children.first.add_previous_sibling(make_node(topbar(title), doc))
end
# Add Mizuho Javascript.
body.add_child(javascript_tag(doc))
# Move preamble from content area to header area.
if preamble = (doc / "#preamble")[0]
preamble.remove
header_div.add_child(make_node(preamble, doc))
end
# Create a TOC after the preamble.
toc_div = add_child_and_get(header_div, %Q{})
if @commenting_system
# Add a commenting balloon to the TOC title.
toc_div.add_child(make_node(create_comment_balloon, doc))
end
toc_div.add_child(make_node(%Q{Table of Contents
}, doc))
headers.each do |header|
if header['class'] !~ /float/
level = header.name.scan(/\d+/).first
div = add_child_and_get(toc_div, "")
link = add_child_and_get(div, "")
link['href'] = '#' + header['id']
link.content = header.text
end
end
if @enable_topbar
# Add invisible spans before each header so that anchor jumps
# don't hide the header behind the top bar.
# http://nicolasgallagher.com/jump-links-and-viewport-positioning/
headers.each do |header|
span = add_previous_sibling_and_get(header, '')
span['id'] = header['data-anchor'] = header['id']
header.remove_attribute('id')
end
end
if @index
# Add docid attributes to headers.
headers.each do |header|
next if header['class'] =~ /float/
docid = Utils.title_to_docid(header.text)
header['data-docid'] = docid.to_s
header['class'] = "#{header['class']} docid-#{docid}".strip
end
create_search_index(headers, @index_filename)
end
f.rewind
f.truncate(0)
f.puts(doc.to_html)
end
end
def stylesheet_tag
content = %Q{\n}
return content
end
def topbar(title)
content = render_template("topbar.html")
content.gsub!(/\{TITLE\}/, title)
return content
end
def javascript_tag(doc)
node = Nokogiri::XML::Node.new('script', doc)
content = ""
content << File.read("#{TEMPLATES_DIR}/jquery-1.7.1.min.js") << "\n"
content << File.read("#{TEMPLATES_DIR}/jquery.hashchange-1.0.0.js") << "\n"
content << File.read("#{TEMPLATES_DIR}/mizuho.js") << "\n"
if @enable_topbar
content << File.read("#{TEMPLATES_DIR}/topbar.js") << "\n"
end
if @commenting_system == 'juvia'
content << %Q{
var JUVIA_URL = '#{@options[:juvia_url]}';
var JUVIA_SITE_KEY = '#{@options[:juvia_site_key]}';
}
content << File.read("#{TEMPLATES_DIR}/juvia.js") << "\n"
end
node.content = content
return node
end
def create_comment_balloon
return %Q{}
end
def render_template(name)
content = File.read("#{TEMPLATES_DIR}/#{name}")
content.gsub!(/\{INLINE_IMAGE:(.*?)\.png\}/) do
data = File.open("#{TEMPLATES_DIR}/#{$1}.png", "rb") do |f|
f.read
end
data = [data].pack('m')
data.gsub!("\n", "")
"data:image/png;base64,#{data}"
end
return content
end
def require_options(options, *required_keys)
fail = false
required_keys.each do |key|
if !options.has_key?(key)
fail = true
argument_name = '--' + key.to_s.gsub('_', '-')
STDERR.puts "You must also specify #{argument_name}!"
end
end
exit 1 if fail
end
# For Nokogiri 1.4.0 compatibility
def make_node(html, doc)
result = Nokogiri::XML::Node.new('div', doc)
result.inner_html = html
return result.children[0]
end
# For Nokogiri 1.4.0 compatibility
def add_child_and_get(node, html)
result = node.add_child(make_node(html, node.document))
result = result[0] if result.is_a?(Array)
return result
end
# For Nokogiri 1.4.0 compatibility
def add_previous_sibling_and_get(node, html)
result = node.add_previous_sibling(make_node(html, node.document))
result = result[0] if result.is_a?(Array)
return result
end
def gather_content(header)
result = []
elem = header
while true
elem = elem.next_sibling
if !elem || elem.name =~ /^h/i
break
else
text = elem.text.strip
if !text.empty?
text.gsub!(/\r?\n/, " ")
result << text
end
end
end
return result.join(" ")
end
def create_search_index(headers, filename)
require 'sqlite3'
db = SQLite3::Database.new("#{filename}.tmp")
db.transaction do
db.execute(%q{
CREATE VIRTUAL TABLE book USING fts4(
title TEXT NOT NULL,
content TEXT NOT NULL,
content="",
tokenize=porter
)
})
db.execute(%q{
CREATE TABLE version(
version INTEGER NOT NULL
)
})
db.execute("INSERT INTO version VALUES(1)")
db.prepare("INSERT INTO book(docid, title, content) VALUES(?, ?, ?)") do |stmt|
headers.each do |header|
next if header['class'] =~ /float/
title = header.text.strip
docid = Utils.title_to_docid(title)
content = gather_content(header)
stmt.execute(docid, title, content)
end
end
end
db.execute("INSERT INTO book(book) VALUES('optimize')")
db.execute("VACUUM")
db.close
File.rename("#{filename}.tmp", filename)
rescue Exception => e
File.unlink("#{filename}.tmp") rescue nil
raise e
end
end
end
mizuho-0.9.20/lib/mizuho/source_highlight.rb 0000644 0000041 0000041 00000002304 12261241511 021074 0 ustar www-data www-data # Copyright (c) 2008-2013 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 'mizuho'
if !Mizuho::NATIVELY_PACKAGED
ENV['PATH'] += ":" + File.join(Mizuho::SOURCE_ROOT, "source-highlight")
end
mizuho-0.9.20/lib/mizuho.rb 0000644 0000041 0000041 00000003355 12261241511 015554 0 ustar www-data www-data # Copyright (c) 2008-2013 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.
module Mizuho
VERSION_STRING = "0.9.20"
NATIVELY_PACKAGED = false
if NATIVELY_PACKAGED
TEMPLATES_DIR = "/usr/share/mizuho/templates"
if File.exist?("/usr/share/mizuho/asciidoc")
ASCIIDOC = ["/usr/bin/python", "/usr/share/mizuho/asciidoc/asciidoc.py"]
else
ASCIIDOC = "/usr/bin/asciidoc"
end
else
SOURCE_ROOT = File.expand_path(File.dirname(__FILE__) + "/..")
LIBDIR = "#{SOURCE_ROOT}/lib"
TEMPLATES_DIR = "#{SOURCE_ROOT}/templates"
ASCIIDOC = ["python", "#{SOURCE_ROOT}/asciidoc/asciidoc.py"]
if $LOAD_PATH.first != LIBDIR
$LOAD_PATH.unshift(LIBDIR)
$LOAD_PATH.uniq!
end
end
end if !defined?(Mizuho::VERSION_STRING)
mizuho-0.9.20/README.markdown 0000644 0000041 0000041 00000010704 12261241511 015643 0 ustar www-data www-data # Mizuho documentation formatting tool
Mizuho is a documentation formatting tool, best suited for small to
medium-sized documentation. One writes documentation in plain text
files, which Mizuho then converts to nicely formatted HTML.
Mizuho wraps [Asciidoc](http://www.methods.co.nz/asciidoc/), the text
formatting tool used by e.g. Git and Phusion Passenger for its manuals.
Mizuho adds the following functionality on top of Asciidoc:
* A top bar that gives quick access to the table of contents.
* Commenting via [Juvia](https://github.com/FooBarWidget/juvia).
Mizuho bundles Asciidoc so you don't have to install it yourself. Mizuho
should Just Work(tm) out-of-the-box. Asciidoc uses GNU source-highlight
for highlighting source code. GNU source-highlight depends on Boost and
so is notorious for being difficult to install on systems without a
decent package manager (e.g. OS X). Mizuho comes prebundled with an OS
X binary for GNU source-highlight so that you don't have to worry about
that.
## Requirements
* Nokogiri (`gem install nokogiri`)
* Python (because Asciidoc is written in Python)
* [GNU Source-highlight](http://www.gnu.org/software/src-highlite/), if you
want syntax highlighting support. If you're on OS X then it's not necessary
to install this yourself; we've bundled a precompiled source-highlight
binary for OS X for your convenience.
## Installation with RubyGems
Run:
gem install mizuho
This gem is signed using PGP with the [Phusion Software Signing key](http://www.phusion.nl/about/gpg). That key in turn is signed by [the rubygems-openpgp Certificate Authority](http://www.rubygems-openpgp-ca.org/).
You can verify the authenticity of the gem by following [The Complete Guide to Verifying Gems with rubygems-openpgp](http://www.rubygems-openpgp-ca.org/blog/the-complete-guide-to-verifying-gems-with-rubygems-openpgp.html).
## Installation on Ubuntu
Use our [PPA](https://launchpad.net/~phusion.nl/+archive/misc):
sudo add-apt-repository ppa:phusion.nl/misc
sudo apt-get update
sudo apt-get install mizuho
## Installation on Debian
Our Ubuntu Lucid packages are compatible with Debian 6.
sudo sh -c 'echo deb http://ppa.launchpad.net/phusion.nl/misc/ubuntu lucid main > /etc/apt/sources.list.d/phusion-misc.list'
sudo sh -c 'echo deb-src http://ppa.launchpad.net/phusion.nl/misc/ubuntu lucid main >> /etc/apt/sources.list.d/phusion-misc.list'
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 2AC745A50A212A8C
sudo apt-get update
sudo apt-get install mizuho
## Installation on RHEL, CentOS and Amazon Linux
1. Enable EPEL: [RHEL](https://fedoraproject.org/wiki/EPEL), [CentOS](http://www.centosblog.com/enable-epel-repo-on-centos-5-and-centos-6/), [Amazon Linux](http://aws.amazon.com/amazon-linux-ami/faqs/#epel).
2. Enable our YUM repository:
# RHEL 6, CentOS 6
curl -L https://oss-binaries.phusionpassenger.com/yumgems/phusion-misc/el.repo | \
sudo tee /etc/yum.repos.d/phusion-misc.repo
# Amazon Linux
curl -L https://oss-binaries.phusionpassenger.com/yumgems/phusion-misc/amazon.repo | \
sudo tee /etc/yum.repos.d/phusion-misc.repo
3. Install our package:
sudo yum install rubygem-mizuho
## Usage
First, read [the Asciidoc manual](http://www.methods.co.nz/asciidoc/userguide.html)
to learn the input file format:
Next, write an input file and save it in a .txt file.
Finally, convert the .txt file to a single HTML file with Mizuho, with the
default template:
mizuho input.txt
This will generate 'input.html'.
### Commenting via Juvia
To enable commenting via Juvia, pass `-c juvia` and the `--juvia-url` and
`--juvia-site-key` arguments with appropriate values. Mizuho will generate a
so-called *ID map file* if there isn't already one. This file maps section
titles to Juvia topic IDs. This way you can preserve a section's comments
even when you rename that section's title. Note that the section's number is
considered part of the title, so renaming can happen implicitly.
When a section title has been renamed, Mizuho will look for a Juvia topic ID
for which the previous title is similar to the new title, and assign that ID
to the section. The entry in the ID map file is then marked 'fuzzy' in order to
warn you about this. You have to remove the `# fuzzy` comment in the ID map
file, or Mizuho will keep complaining about this in subsequent runs.
## Credits
This tool is named after Kazami Mizuho from the 2003 anime 'Onegai Teacher'.
mizuho-0.9.20/metadata.yml 0000644 0000041 0000041 00000032366 12261241511 015455 0 ustar www-data www-data --- !ruby/object:Gem::Specification
name: mizuho
version: !ruby/object:Gem::Version
version: 0.9.20
prerelease:
platform: ruby
authors:
- Hongli Lai
autorequire:
bindir: bin
cert_chain: []
date: 2013-12-13 00:00:00.000000000 Z
dependencies:
- !ruby/object:Gem::Dependency
name: nokogiri
requirement: !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: 1.4.0
type: :runtime
prerelease: false
version_requirements: !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: 1.4.0
- !ruby/object:Gem::Dependency
name: sqlite3
requirement: !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: '0'
type: :runtime
prerelease: false
version_requirements: !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: '0'
description: A documentation formatting tool. Mizuho converts Asciidoc input files
into nicely outputted HTML, possibly one file per chapter. Multiple templates are
supported, so you can write your own.
email: software-signing@phusion.nl
executables:
- mizuho
- mizuho-asciidoc
extensions: []
extra_rdoc_files: []
files:
- README.markdown
- LICENSE.txt
- Rakefile
- mizuho.gemspec
- bin/mizuho
- bin/mizuho-asciidoc
- lib/mizuho/fuzzystringmatch.rb
- lib/mizuho/generator.rb
- lib/mizuho/id_map.rb
- lib/mizuho/packaging.rb
- lib/mizuho/source_highlight.rb
- lib/mizuho/utils.rb
- lib/mizuho.rb
- debian.template/changelog
- debian.template/compat
- debian.template/control.template
- debian.template/copyright
- debian.template/mizuho.install.template
- debian.template/ruby-interpreter
- debian.template/rules.template
- debian.template/source/format
- rpm/get_distro_id.py
- rpm/rubygem-mizuho.spec.template
- test/generator_spec.rb
- test/id_map_spec.rb
- test/parser_spec.rb
- test/spec_helper.rb
- templates/arrow-up.png
- templates/balloon.png
- templates/balloon.svg
- templates/jquery-1.6.1.min.js
- templates/jquery-1.7.1.min.js
- templates/jquery.hashchange-1.0.0.js
- templates/juvia.js
- templates/mizuho.css
- templates/mizuho.js
- templates/toc.html
- templates/topbar.css
- templates/topbar.html
- templates/topbar.js
- asciidoc/a2x.py
- asciidoc/asciidoc.conf
- asciidoc/asciidoc.py
- asciidoc/asciidocapi.py
- asciidoc/BUGS
- asciidoc/BUGS.txt
- asciidoc/CHANGELOG
- asciidoc/CHANGELOG.txt
- asciidoc/common.aap
- asciidoc/configure
- asciidoc/configure.ac
- asciidoc/COPYING
- asciidoc/COPYRIGHT
- asciidoc/dblatex/asciidoc-dblatex.sty
- asciidoc/dblatex/asciidoc-dblatex.xsl
- asciidoc/dblatex/dblatex-readme.txt
- asciidoc/doc/a2x.1
- asciidoc/doc/a2x.1.txt
- asciidoc/doc/article-docinfo.xml
- asciidoc/doc/article.pdf
- asciidoc/doc/article.txt
- asciidoc/doc/asciidoc.1
- asciidoc/doc/asciidoc.1.txt
- asciidoc/doc/asciidoc.conf
- asciidoc/doc/asciidoc.dict
- asciidoc/doc/asciidoc.txt
- asciidoc/doc/asciidocapi.txt
- asciidoc/doc/asciimathml.txt
- asciidoc/doc/book-multi.txt
- asciidoc/doc/book.epub
- asciidoc/doc/book.txt
- asciidoc/doc/customers.csv
- asciidoc/doc/epub-notes.txt
- asciidoc/doc/faq.txt
- asciidoc/doc/latex-backend.txt
- asciidoc/doc/latex-bugs.txt
- asciidoc/doc/latex-filter.pdf
- asciidoc/doc/latex-filter.txt
- asciidoc/doc/latexmath.txt
- asciidoc/doc/latexmathml.txt
- asciidoc/doc/main.aap
- asciidoc/doc/music-filter.pdf
- asciidoc/doc/music-filter.txt
- asciidoc/doc/publishing-ebooks-with-asciidoc.txt
- asciidoc/doc/slidy-example.txt
- asciidoc/doc/slidy.txt
- asciidoc/doc/source-highlight-filter.pdf
- asciidoc/doc/source-highlight-filter.txt
- asciidoc/doc/testasciidoc.txt
- asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt
- asciidoc/docbook-xsl/chunked.xsl
- asciidoc/docbook-xsl/common.xsl
- asciidoc/docbook-xsl/epub.xsl
- asciidoc/docbook-xsl/fo.xsl
- asciidoc/docbook-xsl/htmlhelp.xsl
- asciidoc/docbook-xsl/manpage.xsl
- asciidoc/docbook-xsl/text.xsl
- asciidoc/docbook-xsl/xhtml.xsl
- asciidoc/docbook45.conf
- asciidoc/examples/website/a2x.1.txt
- asciidoc/examples/website/asciidoc-docbook-xsl.txt
- asciidoc/examples/website/asciidoc-graphviz-sample.txt
- asciidoc/examples/website/asciidoc.css
- asciidoc/examples/website/asciidoc.js
- asciidoc/examples/website/asciidocapi.txt
- asciidoc/examples/website/ASCIIMathML.js
- asciidoc/examples/website/asciimathml.txt
- asciidoc/examples/website/build-website.sh
- asciidoc/examples/website/CHANGELOG.txt
- asciidoc/examples/website/customers.csv
- asciidoc/examples/website/epub-notes.txt
- asciidoc/examples/website/faq.txt
- asciidoc/examples/website/index.txt
- asciidoc/examples/website/INSTALL.txt
- asciidoc/examples/website/latex-backend.txt
- asciidoc/examples/website/latex-bugs.txt
- asciidoc/examples/website/latex-filter.txt
- asciidoc/examples/website/LaTeXMathML.js
- asciidoc/examples/website/latexmathml.txt
- asciidoc/examples/website/layout1.conf
- asciidoc/examples/website/layout1.css
- asciidoc/examples/website/layout2.conf
- asciidoc/examples/website/layout2.css
- asciidoc/examples/website/main.aap
- asciidoc/examples/website/manpage.txt
- asciidoc/examples/website/music-filter.txt
- asciidoc/examples/website/newlists.txt
- asciidoc/examples/website/newtables.txt
- asciidoc/examples/website/plugins.txt
- asciidoc/examples/website/publishing-ebooks-with-asciidoc.txt
- asciidoc/examples/website/README-website.txt
- asciidoc/examples/website/README.txt
- asciidoc/examples/website/slidy-example.txt
- asciidoc/examples/website/slidy.txt
- asciidoc/examples/website/source-highlight-filter.txt
- asciidoc/examples/website/support.txt
- asciidoc/examples/website/testasciidoc.txt
- asciidoc/examples/website/userguide.txt
- asciidoc/examples/website/version83.txt
- asciidoc/examples/website/xhtml11-quirks.css
- asciidoc/filters/code/code-filter-readme.txt
- asciidoc/filters/code/code-filter-test.txt
- asciidoc/filters/code/code-filter.conf
- asciidoc/filters/code/code-filter.py
- asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt
- asciidoc/filters/graphviz/graphviz-filter.conf
- asciidoc/filters/graphviz/graphviz2png.py
- asciidoc/filters/latex/latex-filter.conf
- asciidoc/filters/latex/latex2png.py
- asciidoc/filters/music/music-filter-test.txt
- asciidoc/filters/music/music-filter.conf
- asciidoc/filters/music/music2png.py
- asciidoc/filters/source/source-highlight-filter-test.txt
- asciidoc/filters/source/source-highlight-filter.conf
- asciidoc/help.conf
- asciidoc/html4.conf
- asciidoc/html5.conf
- asciidoc/images/highlighter.png
- asciidoc/images/icons/callouts/1.png
- asciidoc/images/icons/callouts/10.png
- asciidoc/images/icons/callouts/11.png
- asciidoc/images/icons/callouts/12.png
- asciidoc/images/icons/callouts/13.png
- asciidoc/images/icons/callouts/14.png
- asciidoc/images/icons/callouts/15.png
- asciidoc/images/icons/callouts/2.png
- asciidoc/images/icons/callouts/3.png
- asciidoc/images/icons/callouts/4.png
- asciidoc/images/icons/callouts/5.png
- asciidoc/images/icons/callouts/6.png
- asciidoc/images/icons/callouts/7.png
- asciidoc/images/icons/callouts/8.png
- asciidoc/images/icons/callouts/9.png
- asciidoc/images/icons/caution.png
- asciidoc/images/icons/example.png
- asciidoc/images/icons/home.png
- asciidoc/images/icons/important.png
- asciidoc/images/icons/next.png
- asciidoc/images/icons/note.png
- asciidoc/images/icons/prev.png
- asciidoc/images/icons/README
- asciidoc/images/icons/tip.png
- asciidoc/images/icons/up.png
- asciidoc/images/icons/warning.png
- asciidoc/images/smallnew.png
- asciidoc/images/tiger.png
- asciidoc/INSTALL
- asciidoc/install-sh
- asciidoc/INSTALL.txt
- asciidoc/javascripts/asciidoc.js
- asciidoc/javascripts/ASCIIMathML.js
- asciidoc/javascripts/LaTeXMathML.js
- asciidoc/javascripts/slidy.js
- asciidoc/javascripts/toc.js
- asciidoc/lang-de.conf
- asciidoc/lang-en.conf
- asciidoc/lang-es.conf
- asciidoc/lang-fr.conf
- asciidoc/lang-hu.conf
- asciidoc/lang-it.conf
- asciidoc/lang-nl.conf
- asciidoc/lang-pt-BR.conf
- asciidoc/lang-ru.conf
- asciidoc/lang-uk.conf
- asciidoc/latex.conf
- asciidoc/main.aap
- asciidoc/Makefile.in
- asciidoc/MANIFEST
- asciidoc/README
- asciidoc/README.txt
- asciidoc/slidy.conf
- asciidoc/stylesheets/asciidoc.css
- asciidoc/stylesheets/docbook-xsl.css
- asciidoc/stylesheets/pygments.css
- asciidoc/stylesheets/slidy.css
- asciidoc/stylesheets/toc2.css
- asciidoc/stylesheets/xhtml11-quirks.css
- asciidoc/tests/asciidocapi.py
- asciidoc/tests/data/deprecated-quotes.txt
- asciidoc/tests/data/filters-test.txt
- asciidoc/tests/data/lang-de-man-test.txt
- asciidoc/tests/data/lang-de-test.txt
- asciidoc/tests/data/lang-en-man-test.txt
- asciidoc/tests/data/lang-en-test.txt
- asciidoc/tests/data/lang-es-man-test.txt
- asciidoc/tests/data/lang-es-test.txt
- asciidoc/tests/data/lang-fr-man-test.txt
- asciidoc/tests/data/lang-fr-test.txt
- asciidoc/tests/data/lang-hu-man-test.txt
- asciidoc/tests/data/lang-hu-test.txt
- asciidoc/tests/data/lang-it-man-test.txt
- asciidoc/tests/data/lang-it-test.txt
- asciidoc/tests/data/lang-nl-man-test.txt
- asciidoc/tests/data/lang-nl-test.txt
- asciidoc/tests/data/lang-pt-BR-man-test.txt
- asciidoc/tests/data/lang-pt-BR-test.txt
- asciidoc/tests/data/lang-ru-man-test.txt
- asciidoc/tests/data/lang-ru-test.txt
- asciidoc/tests/data/lang-uk-man-test.txt
- asciidoc/tests/data/lang-uk-test.txt
- asciidoc/tests/data/oldtables.txt
- asciidoc/tests/data/rcs-id-marker-test.txt
- asciidoc/tests/data/testcases.conf
- asciidoc/tests/data/testcases.txt
- asciidoc/tests/data/utf8-bom-test.txt
- asciidoc/tests/data/utf8-examples.txt
- asciidoc/tests/testasciidoc.conf
- asciidoc/tests/testasciidoc.py
- asciidoc/text.conf
- asciidoc/themes/flask/flask.css
- asciidoc/themes/volnitsky/volnitsky.css
- asciidoc/vim/ftdetect/asciidoc_filetype.vim
- asciidoc/vim/syntax/asciidoc.vim
- asciidoc/wordpress.conf
- asciidoc/xhtml11-quirks.conf
- asciidoc/xhtml11.conf
- source-highlight/ada.lang
- source-highlight/bib.lang
- source-highlight/bison.lang
- source-highlight/c.lang
- source-highlight/c_comment.lang
- source-highlight/c_string.lang
- source-highlight/caml.lang
- source-highlight/changelog.lang
- source-highlight/clike_vardeclaration.lang
- source-highlight/cpp.lang
- source-highlight/csharp.lang
- source-highlight/css.lang
- source-highlight/css_common.outlang
- source-highlight/darwin/source-highlight
- source-highlight/default.css
- source-highlight/default.lang
- source-highlight/default.style
- source-highlight/desktop.lang
- source-highlight/diff.lang
- source-highlight/docbook.outlang
- source-highlight/esc.outlang
- source-highlight/esc.style
- source-highlight/extreme_comment.lang
- source-highlight/extreme_comment2.lang
- source-highlight/extreme_comment3.lang
- source-highlight/fixed-fortran.lang
- source-highlight/flex.lang
- source-highlight/fortran.lang
- source-highlight/function.lang
- source-highlight/glsl.lang
- source-highlight/haxe.lang
- source-highlight/html.lang
- source-highlight/html.outlang
- source-highlight/html_common.outlang
- source-highlight/html_notfixed.outlang
- source-highlight/html_ref.outlang
- source-highlight/htmlcss.outlang
- source-highlight/htmltable.outlang
- source-highlight/htmltablelinenum.outlang
- source-highlight/java.lang
- source-highlight/javadoc.outlang
- source-highlight/javascript.lang
- source-highlight/key_string.lang
- source-highlight/lang.map
- source-highlight/langdef.lang
- source-highlight/latex.lang
- source-highlight/latex.outlang
- source-highlight/latexcolor.outlang
- source-highlight/ldap.lang
- source-highlight/log.lang
- source-highlight/logtalk.lang
- source-highlight/lsm.lang
- source-highlight/lua.lang
- source-highlight/m4.lang
- source-highlight/makefile.lang
- source-highlight/nohilite.lang
- source-highlight/number.lang
- source-highlight/outlang.lang
- source-highlight/outlang.map
- source-highlight/pascal.lang
- source-highlight/perl.lang
- source-highlight/php.lang
- source-highlight/postscript.lang
- source-highlight/prolog.lang
- source-highlight/properties.lang
- source-highlight/python.lang
- source-highlight/ruby.lang
- source-highlight/scala.lang
- source-highlight/script_comment.lang
- source-highlight/sh.lang
- source-highlight/slang.lang
- source-highlight/sml.lang
- source-highlight/source-highlight
- source-highlight/spec.lang
- source-highlight/sql.lang
- source-highlight/style.defaults
- source-highlight/style.lang
- source-highlight/style2.style
- source-highlight/style3.style
- source-highlight/symbols.lang
- source-highlight/tcl.lang
- source-highlight/texinfo.outlang
- source-highlight/texinfo.style
- source-highlight/url.lang
- source-highlight/xhtml.outlang
- source-highlight/xhtml_common.outlang
- source-highlight/xhtml_notfixed.outlang
- source-highlight/xhtmlcss.outlang
- source-highlight/xhtmltable.outlang
- source-highlight/xml.lang
- source-highlight/xorg.lang
homepage: https://github.com/FooBarWidget/mizuho
licenses:
- MIT
post_install_message:
rdoc_options: []
require_paths:
- lib
required_ruby_version: !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: '0'
required_rubygems_version: !ruby/object:Gem::Requirement
none: false
requirements:
- - ! '>='
- !ruby/object:Gem::Version
version: '0'
requirements: []
rubyforge_project:
rubygems_version: 1.8.23
signing_key:
specification_version: 3
summary: Mizuho documentation formatting tool
test_files: []
mizuho-0.9.20/test/ 0000755 0000041 0000041 00000000000 12261241511 014117 5 ustar www-data www-data mizuho-0.9.20/test/id_map_spec.rb 0000644 0000041 0000041 00000020567 12261241511 016721 0 ustar www-data www-data # 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'
module Mizuho
describe IdMap do
before :each do
@id_map = IdMap.new
end
describe "#generate_associations" do
describe "if no similar titles exist in the map" do
before :each do
@id_map.generate_associations(["Installation",
"Installation on Linux", "Configuration"])
@id1 = @id_map.associations["Installation"]
@id2 = @id_map.associations["Installation on Linux"]
@id3 = @id_map.associations["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.entries["Installation"].should be_associated
@id_map.entries["Installation on Linux"].should be_associated
@id_map.entries["Configuration"].should be_associated
end
it "doesn't mark the corresponding entry as fuzzy" do
@id_map.entries["Installation"].should_not be_fuzzy
@id_map.entries["Installation on Linux"].should_not be_fuzzy
@id_map.entries["Configuration"].should_not be_fuzzy
end
end
describe "if the same title exists in the map, but with a different section number" do
before :each do
@entry1 = @id_map.add("1.2. Installation using a tarball", nil, false, false)
@entry2 = @id_map.add("5.6. Installation using a tarball", nil, false, false)
@entry3 = @id_map.add("6.0. Installation using a tarball", nil, false, false)
@id_map.generate_associations(["5.4. Installation using a tarball",
"2.1. Installation using a tarball"])
@id1 = @id_map.associations["5.4. Installation using a tarball"]
@id2 = @id_map.associations["2.1. Installation using a tarball"]
end
it "associates with the title whose section number is closest to the new section number" do
@id1.should == @entry2.id
@id2.should == @entry1.id
end
it "changes the original entries' titles" do
@entry1.title.should == "2.1. Installation using a tarball"
@entry2.title.should == "5.4. Installation using a tarball"
@entry3.title.should == "6.0. Installation using a tarball"
end
it "marks the corresponding entry as associated" do
@entry1.should be_associated
@entry2.should be_associated
@entry3.should_not be_associated
end
it "doesn't mark the corresponding entry as fuzzy" do
@entry1.should_not be_fuzzy
@entry2.should_not be_fuzzy
@entry3.should_not be_fuzzy
end
specify "bug fix" do
@id_map = IdMap.new
@entry1 = @id_map.add("2.9.3. Environment variables and sudo", nil, false, false)
@entry2 = @id_map.add("2.9.8. Environment variables and sudo", nil, false, false)
@id_map.generate_associations(["14.5. Environment variables and sudo"])
@id1 = @id_map.associations["14.5. Environment variables and sudo"]
@id1.should == @entry1.id
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
@id_map.generate_associations(["Installation using tarball"])
@id3 = @id_map.associations["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
@id_map.generate_associations(["Installation using tarball"])
@id3 = @id_map.associations["Installation using tarball"]
@id3.should == @entry2.id
end
it "marks the corresponding entry as associated" do
@id_map.generate_associations(["Installation using tarball"])
@id_map.entries["Installation using tarball"].should be_associated
end
it "marks the corresponding entry as fuzzy" do
@id_map.generate_associations(["Installation using tarball"])
@id_map.entries["Installation using tarball"].should be_fuzzy
end
end
describe "if a one title has a similar match, but a later title has an exact match" do
it "associates the later title with the exact match, then associates the first title with the similar match" do
@id_map.add("Hello Dear World", "id-1", false, false)
@id_map.add("Hallaa Dear World", "id-2", false, false)
@id_map.generate_associations(["Helloo Dear World", "Hello Dear World"])
@id_map.associations["Helloo Dear World"].should == "id-2"
@id_map.associations["Hello Dear World"].should == "id-1"
end
end
specify "title matching is case-insensitive" do
entry1 = @id_map.add("INSTALLATION USING A TARBALL", nil, false, false)
@id_map.generate_associations(["installation using tarball"])
id = @id_map.associations["installation using tarball"]
id.should == entry1.id
end
end
describe "entries" do
specify "are sortable by chapter" do
array = []
array << IdMap::Entry.new('1. Extra chapter')
array << IdMap::Entry.new('10. Under the hood')
array << IdMap::Entry.new('2.1. Generic installation instructions')
array.sort!
array[0].title.should == '1. Extra chapter'
array[1].title.should == '2.1. Generic installation instructions'
array[2].title.should == '10. Under the hood'
end
end
describe "loading" do
before :each do
@io = StringIO.new
@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
end
it "marks all entries as 'not associated'" do
@id_map.load(@io)
@id_map.entries.each_value { |entry| entry.should_not be_associated }
end
it "works" do
@id_map.load(@io)
@id_map.entries.should have(3).items
entry = @id_map.entries["Installation"]
entry.title.should == "Installation"
entry.id.should == "installation-1"
entry.should_not be_fuzzy
entry = @id_map.entries["Configuration"]
entry.title.should == "Configuration"
entry.id.should == "configuration-2"
entry.should_not be_fuzzy
entry = @id_map.entries["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 ==
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
end # module Mizuho
mizuho-0.9.20/test/parser_spec.rb 0000644 0000041 0000041 00000015310 12261241511 016752 0 ustar www-data www-data require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
require 'mizuho/parser'
shared_examples_for "an Asciidoc document with 3 chapters" do
it "extracts the chapter contents" do
@chapter_one.contents.should =~ /Chapter 1 contents/
@chapter_two.contents.should =~ /Chapter 2 contents/
end
specify "the extracted chapter contents include (sub)section contents as well" do
@chapter_two.contents.should =~ /Subsection/
@chapter_two.contents.should =~ /This is a subsection/
end
it "doesn't HTML-escape auto-generated HTML formatting tags in the title" do
@html_chapter.title.should =~ %r(Look)
end
it "HTML-escapes non-autogenerated HTML tags in the title" do
@html_chapter.title.should =~ %r(<i>hurray</i>)
end
it "HTML-escapes non-HTML special characters in the title" do
@html_chapter.title.should =~ %r(<3)
end
end
describe Mizuho::Parser do
it "extracts the title" do
parser = generate_and_parse(%Q{
= Hello world
A sample document.
})
parser.title.should == "Hello world"
end
specify "the extracted title is not HTML escaped" do
parser = generate_and_parse(%Q{
= *Look at this!* 2 < 1!
A sample document.
})
parser.title.should == "Look at this! 2 < 1!"
end
describe "construction of table of contents" do
before :each do
@parser = generate_and_parse(%Q{
= Hello world
A sample document.
== Scientists Erase Specific Memories In Mice
It sounds like science fiction, but scientists say it might
one day be possible to erase undesirable memories from the
brain, selectively and safely.
=== How it works
After exposing mice to emotionally powerful stimuli, such
as a mild shock to their paws, the scientists then observed
how well or poorly the animals subsequently recalled the
particular trauma as their brain's expression of CaMKII was
manipulated up and down. When the brain was made to
overproduce CaMKII at the exact moment the mouse was prodded
to retrieve the traumatic memory, the memory wasn't just
blocked, it appeared to be fully erased.
== Researchers Developing Cancer-Fighting Beer
Ever picked up a cold, frosty beer on a hot summer's day
and thought that it simply couldn't get any better? Well,
think again. A team of researchers at Rice University in
Houston is working on helping Joe Six Pack fight aging and
cancer with every swill of beer.
=== Comment by samzenpus
Thank you science! Now we just need cigarettes that cure baldness.
== *Look*, non-HTML special characters <3, hurray
})
@toc = @parser.table_of_contents
end
it "contains all headers" do
@toc.should have(3).items
@toc[0].title.should =~ /Scientists Erase Specific Memories In Mice/
@toc[0].children.should have(1).item
@toc[0].children[0].title.should =~ /How it works/
@toc[1].title.should =~ /Researchers Developing Cancer-Fighting Beer/
@toc[1].children.should have(1).item
@toc[1].children[0].title.should =~ /Comment by samzenpus/
@toc[2].title.should =~ /Look/
@toc[2].children.should be_empty
end
it "records the corresponding header levels" do
@toc[0].level.should == 2
@toc[0].children[0].level.should == 3
@toc[1].level.should == 2
@toc[1].children[0].level.should == 3
@toc[2].level.should == 2
end
it "doesn't HTML-escape auto-generated HTML formatting tags in the title" do
@toc[2].title.should =~ %r(Look)
end
it "HTML-escapes non-autogenerated HTML tags in the title" do
@toc[2].title.should =~ %r(<i>hurray</i>)
end
it "HTML-escapes non-HTML special characters in the title" do
@toc[2].title.should =~ %r(<3)
end
it "prepends heading titles with a corresponding section number" do
@toc[0].title.should =~ /^1\. /
@toc[0].children[0].title.should =~ /^1\.1\. /
@toc[1].title.should =~ /^2\. /
@toc[1].children[0].title.should =~ /^2\.1\. /
@toc[2].title.should =~ /^3\. /
end
end
describe "chapter extraction" do
def test_input(with_preamble)
return %Q{
= Hello world
#{"A preamble." if with_preamble}
== Chapter 1
Chapter 1 contents.
== Chapter 2
Chapter 2 contents.
=== Subsection
This is a subsection.
== *Look*, non-HTML special characters <3, hurray
}
end
describe "when there is a premable" do
before :each do
@parser = generate_and_parse(test_input(true))
@chapters = @parser.chapters
@chapter_one = @chapters[1]
@chapter_two = @chapters[2]
@html_chapter = @chapters[3]
end
it "consists of a preamble followed by level 2 headings" do
@chapters.should have(4).items
end
specify "the preamble chapter has no title" do
@chapters.first.title.should be_nil
end
it_should_behave_like "an Asciidoc document with 3 chapters"
end
describe "when there is no preamble" do
def default_test_input
return test_input(false)
end
before :each do
@parser = generate_and_parse(test_input(false))
@chapters = @parser.chapters
@chapter_one = @chapters[0]
@chapter_two = @chapters[1]
@html_chapter = @chapters[2]
end
it "consists of only level 2 headings" do
@chapters.should have(3).items
end
it_should_behave_like "an Asciidoc document with 3 chapters"
end
end
describe "content extraction" do
describe "when there is a preamble" do
before :each do
@parser = generate_and_parse(%Q{
= Ruby Enterprise Edition Features Guide
Today
Hello world
== Overview
Ruby Enterprise Edition (REE) is a
server-oriented distribution of the
official Ruby interpreter, and includes
various additional enhancements.
})
end
it "extracts the contents" do
@parser.contents.should include("various additional enhancements.")
end
it "strips away the irrelevant HTML that come before the actual content" do
@parser.contents.should_not include("