mizuho 0.9.11 → 0.9.12

data/bin/mizuho

@@ -4,7 +4,8 @@ require 'optparse'
 require 'rubygems'
 require 'mizuho/generator'
 
-$KCODE = 'UTF-8'
+$KCODE = 'UTF-8' if RUBY_VERSION < '1.9'
+
 options = { :topbar => true, :attributes => [] }
 parser = OptionParser.new do |opts|
 	nl = "\n" + ' ' * 37

data/lib/mizuho/id_map.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2012 Hongli Lai
+# 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
@@ -80,24 +80,26 @@ class IdMap
 
 	def save(filename_or_io)
 		normal, orphaned = group_and_sort_entries
-		open_io(filename_or_io, :write) do |f|
-			f.write(BANNER)
-			normal.each do |entry|
-				f.puts "# fuzzy" if entry.fuzzy?
-				f.puts "#{entry.title}	=>	#{entry.id}"
-				f.puts
-			end
-			if !orphaned.empty?
-				f.puts
-				f.puts "### These sections appear to have been removed. Please check."
-				f.puts
-				orphaned.each do |entry|
-					f.puts "# fuzzy" if entry.fuzzy?
-					f.puts "#{entry.title}	=>	#{entry.id}"
-					f.puts
-				end
+		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 associate(title)
@@ -108,12 +110,13 @@ class IdMap
 				entry.associated = true
 				id = entry.id
 			end
-		elsif entry = find_similar(title)
+		elsif (moved_entry = find_moved(title)) || (similar_entry = find_similar(title))
+			entry = (moved_entry || similar_entry)
 			@entries.delete(entry.title)
 			@entries[title] = entry
 			entry.title = title
 			entry.associated = true
-			entry.fuzzy = true
+			entry.fuzzy = true if similar_entry
 			id = entry.id
 		else
 			id = create_unique_id(title)
@@ -149,7 +152,64 @@ private
 		alias associated? associated
 		
 		def <=>(other)
-			return title <=> other.title
+			if (a = IdMap.extract_chapter(title)) &&
+			   (b = IdMap.extract_chapter(other.title))
+				# Sort by chapter whenever possible.
+				a[0] = IdMap.chapter_to_int_array(a[0])
+				b[0] = IdMap.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]
+
+			# 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
 	
@@ -171,7 +231,32 @@ private
 			return nil
 		end
 	end
-	
+
+	# Given a title with a chapter number, e.g. "6.1 Installation using tarball",
+	# splits the two up.
+	def self.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 extract_chapter(title)
+		return IdMap.extract_chapter(title)
+	end
+
+	def self.chapter_to_int_array(chapter)
+		return chapter.split('.').map { |x| x.to_i }
+	end
+
+	def chapter_to_int_array(chapter)
+		return IdMap.chapter_to_int_array(chapter)
+	end
+
 	def slug(text)
 		text = text.downcase
 		text.gsub!(/^(\d+\.)+ /, '')

data/lib/mizuho.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2012 Hongli Lai
+# 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
@@ -24,7 +24,7 @@ module Mizuho
 	TEMPLATES_DIR = "#{SOURCE_ROOT}/templates"
 	ASCIIDOC      = "#{SOURCE_ROOT}/asciidoc/asciidoc.py"
 	
-	VERSION_STRING = "0.9.11"
+	VERSION_STRING = "0.9.12"
 	
 	if $LOAD_PATH.first != LIBDIR
 		$LOAD_PATH.unshift(LIBDIR)

data/test/id_map_spec.rb

@@ -22,9 +22,11 @@ require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
 require 'stringio'
 require 'mizuho/id_map'
 
-describe Mizuho::IdMap do
+module Mizuho
+
+describe IdMap do
 	before :each do
-		@id_map = Mizuho::IdMap.new
+		@id_map = IdMap.new
 	end
 
 	describe "#associate" do
@@ -54,6 +56,39 @@ describe Mizuho::IdMap do
 				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)
+					@id1 = @id_map.associate "5.4. Installation using a tarball"
+					@id2 = @id_map.associate "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
+			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)
@@ -118,17 +153,27 @@ describe Mizuho::IdMap do
 		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)
+				lambda { @id_map.associate "Installation" }.should raise_error(IdMap::AlreadyAssociatedError)
 			end
 		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
-		end
-
-		it "works" do
 			@io.puts "# This is a comment."
 			@io.puts ""
 			@io.puts "Installation	=>	installation-1"
@@ -136,10 +181,17 @@ describe Mizuho::IdMap do
 			@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
-			@id_map.entries.each_value { |entry| entry.should_not be_associated }
 			
 			entry = @id_map["Installation"]
 			entry.title.should == "Installation"
@@ -172,7 +224,7 @@ describe Mizuho::IdMap do
 		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 +
+				IdMap::BANNER +
 				"0. Introduction	=>	intro\n\n" +
 				"1. Installation	=>	installation-1\n\n" +
 				"2. Configuration	=>	configuration-2\n\n" +
@@ -186,3 +238,5 @@ describe Mizuho::IdMap do
 		end
 	end
 end
+
+end # module Mizuho

metadata

@@ -1,46 +1,42 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mizuho
-version: !ruby/object:Gem::Version 
-  hash: 45
+version: !ruby/object:Gem::Version
+  version: 0.9.12
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 11
-  version: 0.9.11
 platform: ruby
-authors: 
+authors:
 - Hongli Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-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.
+  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: hongli@phusion.nl
-executables: 
+executables:
 - mizuho
 - mizuho-asciidoc
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.markdown
 - LICENSE.txt
 - Rakefile
@@ -376,37 +372,26 @@ files:
 - source-highlight/xorg.lang
 homepage: https://github.com/FooBarWidget/mizuho
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Mizuho documentation formatting tool
 test_files: []
-
-has_rdoc: