bluefeather 0.22 → 0.30

data/doc/author-and-license.html

@@ -18,7 +18,7 @@
 <li><a href="http://ja.wikipedia.org/wiki/GNU_General_Public_License">Wikipedia - GNU General Public License</a></li>
 </ul>
 
-<p>BlueFeather への要望、ご意見、バグ報告などがありましたら、<a href="http://ruby.morphball.net/bluefeather/">BlueFeather 配布サイト</a>よりメッセージを送信していただくか、もしくは Dice（<a href="&#109;&#x61;&#105;&#x6C;&#116;&#111;:&#x74;&#x65;&#116;&#x72;&#x61;&#100;i&#x63;&#101;&#064;&#x67;&#x6D;a&#105;l&#x2E;&#x63;&#x6F;&#109;">&#x74;&#x65;&#116;&#x72;&#x61;&#100;i&#x63;&#101;&#064;&#x67;&#x6D;a&#105;l&#x2E;&#x63;&#x6F;&#109;</a>）までメールでご連絡していただけるよう、よろしくお願いします。</p>
+<p>BlueFeather への要望、ご意見、バグ報告などがありましたら、<a href="http://ruby.morphball.net/bluefeather/">BlueFeather 配布サイト</a>よりメッセージを送信していただくか、もしくは Dice（<a href="&#109;&#097;&#105;&#108;&#116;&#x6F;:&#x74;&#x65;&#116;&#x72;&#097;&#100;&#x69;&#099;&#101;&#x40;&#103;&#x6D;&#x61;&#x69;&#x6C;&#x2E;&#099;&#x6F;m">&#x74;&#x65;&#116;&#x72;&#097;&#100;&#x69;&#099;&#101;&#x40;&#103;&#x6D;&#x61;&#x69;&#x6C;&#x2E;&#099;&#x6F;m</a>）までメールでご連絡していただけるよう、よろしくお願いします。</p>
 
 </body>
 </html>

data/doc/en/author-and-license.html

@@ -24,7 +24,7 @@
 <p>If you want to send requests, comments, or bug reports to BlueFeather, please
 feel free to post messages from
 <a href="http://ruby.morphball.net/bluefeather/index_en.html">http://ruby.morphball.net/bluefeather/index_en.html</a> or to send mail to Dice.
-(<a href="m&#097;&#x69;&#108;&#116;&#111;:&#x74;&#101;&#116;r&#097;&#100;&#105;&#099;&#101;&#064;g&#109;&#097;&#105;&#108;&#046;&#x63;&#111;&#x6D;">&#x74;&#101;&#116;r&#097;&#100;&#105;&#099;&#101;&#064;g&#109;&#097;&#105;&#108;&#046;&#x63;&#111;&#x6D;</a>)</p>
+(<a href="&#109;&#097;i&#x6C;&#116;&#x6F;:t&#x65;&#116;&#x72;&#097;&#100;&#x69;&#x63;&#x65;&#064;&#103;&#109;&#097;&#x69;l&#x2E;&#099;&#x6F;&#109;">t&#x65;&#116;&#x72;&#097;&#100;&#x69;&#x63;&#x65;&#064;&#103;&#109;&#097;&#x69;l&#x2E;&#099;&#x6F;&#109;</a>)</p>
 
 </body>
 </html>

data/doc/en/index.bfdoc

@@ -10,7 +10,7 @@ BlueFeather Manual
 
 -> [Japanese version (original)](../index.html)
 
-(2009-06-15: this document based on version 0.22)
+(2009-08-01: this document based on version 0.30)
 
  BlueFeather is software for converting text written by extended Markdown like 
 [PHP Markdown Extra][] to html. It is pair of command-line tool and pure Ruby

data/doc/en/index.html

@@ -12,7 +12,7 @@
 
 <p>-> <a href="../index.html">Japanese version (original)</a></p>
 
-<p>(2009-06-15: this document based on version 0.22)</p>
+<p>(2009-08-01: this document based on version 0.30)</p>
 
 <p>BlueFeather is software for converting text written by extended Markdown like 
 <a href="http://michelf.com/projects/php-markdown/extra/">PHP Markdown Extra</a> to html. It is pair of command-line tool and pure Ruby

data/doc/index.bfdoc

@@ -9,7 +9,7 @@ BlueFeather マニュアル
 → [English version](en/index.html)
 
 
-（2009-06-15 バージョン 0.22 準拠）
+（2009-08-01 バージョン 0.30 準拠）
 
 BlueFeather は、拡張 Markdown 記法で書かれたテキストを html に変換するソフトウェアです。
 コマンドラインツールと、Ruby スクリプト内で変換を行うためのライブラリがセットになっています。

data/doc/index.html

@@ -13,7 +13,7 @@
 
 <p>→ <a href="en/index.html">English version</a></p>
 
-<p>（2009-06-15 バージョン 0.22 準拠）</p>
+<p>（2009-08-01 バージョン 0.30 準拠）</p>
 
 <p>BlueFeather は、拡張 Markdown 記法で書かれたテキストを html に変換するソフトウェアです。
 コマンドラインツールと、Ruby スクリプト内で変換を行うためのライブラリがセットになっています。</p>

data/doc/metadata-reference.bfdoc

@@ -64,7 +64,7 @@ html の head 要素内に出力される Content-Type の値、および変換
 	Atom-Feed: example.xml
 
 
-ニュースフィードの URL。生成される html 文書の head 要素内に、以下のようなリンクが付け加えられ、RSS リーダーなどから登録できるようになる（オートディスカバリー）。
+ニュースフィードの URL。生成される html 文書の head 要素内に、以下のようなリンクが付け加えられ、RSS リーダーなどでそのページを簡単に登録できるようになる（オートディスカバリー）。
 
 	<link rel="alternate" type="application/atom+xml" href="example.xml" />
 
@@ -84,3 +84,44 @@ html の head 要素内に出力される Content-Type の値、および変換
 	Description: にんじん,レシピ,料理
 
 その文書を表すキーワード。`<meta name="keywords" content="～">` の内容になる。
+
+
+### Numbering: {#numbering}
+
+	Numbering: yes
+
+*BlueFeather 0.30以降*でのみ有効。
+
+yes, true, on, 1のいずれかを指定すると、レベル2以降の見出し（h2～h6）に、自動で番号が振られるようになる。
+
+使用例：
+
+	Numbering: yes
+	
+	# 見出し1
+	## 見出し2a
+	## 見出し2b
+	### 見出し3a
+	### 見出し3b
+	## 見出し2c
+	
+~
+
+	<h1>見出し1</h1>
+	  <h2>1. 見出し2a</h2>
+	  <h2>2. 見出し2b</h2>
+	    <h3>2.1. 見出し3a</h3>
+	    <h3>2.2. 見出し3b</h3>
+	  <h2>3. 見出し2c</h2>
+
+### Numbering-Start-Level: {#numbering-start-level}
+
+	Numbering: yes
+	Numbering-Start-Level: 3
+
+*BlueFeather 0.30以降*でのみ有効。
+
+見出しへの番号付けを行うとき、どのレベルの見出しから番号付けの対象とするのかを指定する。
+[Numbering:](#numbering)ヘッダーと同時に使われているときのみ有効。
+
+省略した場合、レベル2以降の見出し（h2～h6）が番号付けの対象になる。

data/doc/metadata-reference.html

@@ -38,6 +38,8 @@ Atom-Feed: info/atom.xml
 <li><a href="#rss-feed" rel="toc">RSS-Feed:</a></li>
 <li><a href="#description" rel="toc">Description:</a></li>
 <li><a href="#keywords" rel="toc">Keywords:</a></li>
+<li><a href="#numbering" rel="toc">Numbering:</a></li>
+<li><a href="#numbering-start-level" rel="toc">Numbering-Start-Level:</a></li>
 </ul></li>
 </ul>
 
@@ -82,7 +84,7 @@ html の head 要素内に出力される Content-Type の値、および変換
 <pre><code>Atom-Feed: example.xml
 </code></pre>
 
-<p>ニュースフィードの URL。生成される html 文書の head 要素内に、以下のようなリンクが付け加えられ、RSS リーダーなどから登録できるようになる（オートディスカバリー）。</p>
+<p>ニュースフィードの URL。生成される html 文書の head 要素内に、以下のようなリンクが付け加えられ、RSS リーダーなどでそのページを簡単に登録できるようになる（オートディスカバリー）。</p>
 
 <pre><code>&lt;link rel="alternate" type="application/atom+xml" href="example.xml" /&gt;
 </code></pre>
@@ -104,5 +106,49 @@ html の head 要素内に出力される Content-Type の値、および変換
 
 <p>その文書を表すキーワード。<code>&lt;meta name="keywords" content="～"&gt;</code> の内容になる。</p>
 
+<h3 id="numbering">Numbering:</h3>
+
+<pre><code>Numbering: yes
+</code></pre>
+
+<p><em>BlueFeather 0.30以降</em>でのみ有効。</p>
+
+<p>yes, true, on, 1のいずれかを指定すると、レベル2以降の見出し（h2～h6）に、自動で番号が振られるようになる。</p>
+
+<p>使用例：</p>
+
+<pre><code>Numbering: yes
+
+# 見出し1
+## 見出し2a
+## 見出し2b
+### 見出し3a
+### 見出し3b
+## 見出し2c
+</code></pre>
+
+
+
+<pre><code>&lt;h1&gt;見出し1&lt;/h1&gt;
+  &lt;h2&gt;1. 見出し2a&lt;/h2&gt;
+  &lt;h2&gt;2. 見出し2b&lt;/h2&gt;
+    &lt;h3&gt;2.1. 見出し3a&lt;/h3&gt;
+    &lt;h3&gt;2.2. 見出し3b&lt;/h3&gt;
+  &lt;h2&gt;3. 見出し2c&lt;/h2&gt;
+</code></pre>
+
+<h3 id="numbering-start-level">Numbering-Start-Level:</h3>
+
+<pre><code>Numbering: yes
+Numbering-Start-Level: 3
+</code></pre>
+
+<p><em>BlueFeather 0.30以降</em>でのみ有効。</p>
+
+<p>見出しへの番号付けを行うとき、どのレベルの見出しから番号付けの対象とするのかを指定する。
+<a href="#numbering">Numbering:</a>ヘッダーと同時に使われているときのみ有効。</p>
+
+<p>省略した場合、レベル2以降の見出し（h2～h6）が番号付けの対象になる。</p>
+
 </body>
 </html>

data/lib/bluefeather.rb

@@ -42,9 +42,9 @@ require 'uri'
 
 
 module BlueFeather
-	VERSION = '0.22'
-	VERSION_NUMBER = 0.22
-	RELEASE_DATE = '2009-05-16'
+	VERSION = '0.30'
+	VERSION_NUMBER = 0.30
+	RELEASE_DATE = '2009-08-01'
 	VERSION_LABEL = "#{VERSION} (#{RELEASE_DATE})"
 	
 	UTF8_BOM = "\xef\xbb\xbf"
@@ -188,7 +188,7 @@ module BlueFeather
 	end
 	
 	class Document
-		HEADER_PATTERN = /^(.+?)\s*\:\s*(.+)(?:\n|\Z)/
+		HEADER_PATTERN = /^(.+?)\s*\:\s*(.+?)\s*(?:\n|\Z)/
 		BLANK_LINE_PATTERN = /^\n/
 		HEADER_SEQUEL_PATTERN = /^\s+(.+)$/
 		
@@ -304,6 +304,26 @@ module BlueFeather
 			@headers['css']
 		end
 		
+		def numbering
+			case @headers['numbering']
+			when 'yes', '1', 'true', 'on'
+				true
+			else
+				false
+			end
+		end
+		
+		alias numbering? numbering
+		
+		def numbering_start_level
+			level = (@headers['numbering-start-level'] || 2).to_i
+			if level >= 1 and level <= 6 then
+				return level
+			else
+				return 2
+			end
+		end
+		
 		def encoding_type
 			(@headers['encoding'] ? @headers['encoding'].downcase : 'utf-8')
 		end
@@ -332,6 +352,8 @@ module BlueFeather
 			# BlueFeather Extension
 			attr_accessor :footnotes, :found_footnote_ids, :warnings
 			attr_accessor :headers, :block_transform_depth
+			attr_accessor :numbering, :numbering_start_level # option switch
+			alias numbering? numbering
 			
 			def initialize
 				@urls, @titles, @html_blocks = {}, {}, {}
@@ -339,6 +361,8 @@ module BlueFeather
 				@footnotes, @found_footnote_ids, @warnings = {}, [], []
 				@headers = []
 				@block_transform_depth = 0
+				@numbering = false
+				@numbering_start_level = 2
 			end
 			
 		end
@@ -524,6 +548,10 @@ module BlueFeather
 		
 		def document_to_html(doc)
 			rs = RenderState.new
+			if doc.numbering? then
+				rs.numbering = true
+			end
+			rs.numbering_start_level = doc.numbering_start_level
 			
 			body_html = nil
 			
@@ -964,7 +992,12 @@ module BlueFeather
 						rs.warnings << "illegal TOC parameter - #{param} (valid example: 'h2..h4')"
 					end
 				end
-			
+				
+				if rs.headers.first and rs.headers.first.level >= (start_level + 1) then
+					rs.warnings << "illegal structure of headers - h#{start_level} should be set before h#{rs.headers.first.level}"
+				end
+				
+				
 				ul_text = "\n\n"
 				rs.headers.each do |header|
 					if header.level >= start_level and header.level <= end_level then
@@ -976,7 +1009,8 @@ module BlueFeather
 				end
 				ul_text << "\n"
 				
-				ul_text
+				ul_text # output
+			
 			}
 		end
 		
@@ -1474,6 +1508,9 @@ module BlueFeather
 			#	  Header 2
 			#	  --------
 			#
+			
+			section_numbers = [nil, nil, nil, nil, nil]
+			
 			str.
 				gsub( HeaderRegexp ) {|m|
 					if $1 then
@@ -1496,6 +1533,31 @@ module BlueFeather
 						end
 					end
 					
+					if rs.numbering? then
+						if level >= rs.numbering_start_level and level <= 6 then
+							depth = level - rs.numbering_start_level
+							
+							section_numbers.each_index do |i|
+								if i == depth and section_numbers[depth] then
+									# increment a deepest number if current header's level equals last header's
+									section_numbers[i] += 1
+								elsif i <= depth then
+									# set default number if nil
+									section_numbers[i] ||= 1
+								else
+									# clear discardeds
+									section_numbers[i] = nil
+								end
+							end
+							
+							no = ''
+							(0..depth).each do |i|
+								no << "#{section_numbers[i]}."
+							end
+	
+							title = "#{no} #{title}"
+						end
+					end
 					
 					title_html = apply_span_transforms( title, rs )
 					id ||= "bfheader-#{Digest::MD5.hexdigest(title)}"

data/spec/numbering.rb

@@ -0,0 +1,58 @@
+require 'pathname'
+require(Pathname.new(__FILE__).parent + 'lib/common.rb')
+
+
+describe 'Numbering:' do
+	before(:each) do
+		@src = <<MARKDOWN
+Numbering: #{@numbering}
+Numbering-Start-Level: #{@start_level}
+
+# h1
+## h2a
+## h2b
+### h3a
+### h3b
+## h2c
+MARKDOWN
+
+		@html = BlueFeather.parse_document(@src)
+		@doc = Hpricot(@html)
+	end
+	
+	
+	describe "yes:" do
+		before(:all) do
+			@numbering, @start_level = 'yes  ', ''
+		end
+
+		specify "numbering" do
+			@doc.at('h1').inner_text.should == 'h1'
+			
+			elems = @doc.search('h2')
+			elems.map{|x| x.inner_text}.should == ['1. h2a', '2. h2b', '3. h2c']
+			
+			elems = @doc.search('h3')
+			elems.map{|x| x.inner_text}.should == ['2.1. h3a', '2.2. h3b']
+		end
+
+	end
+	
+	describe "yes (start=3):" do
+		before(:all) do
+			@numbering, @start_level = 'yes  ', '3 '
+		end
+
+		specify "numbering" do
+			@doc.at('h1').inner_text.should == 'h1'
+			
+			elems = @doc.search('h2')
+			elems.map{|x| x.inner_text}.should == ['h2a', 'h2b', 'h2c']
+			
+			elems = @doc.search('h3')
+			elems.map{|x| x.inner_text}.should == ['1. h3a', '2. h3b']
+		end
+
+	end
+
+end

data/spec/toc.rb

@@ -3,8 +3,19 @@ require(Pathname.new(__FILE__).parent + 'lib/common.rb')
 
 
 describe 'TOC:' do
-	before(:all) do
-		@header_part = <<MARKDOWN
+	before(:each) do
+		@bf = BlueFeather::Parser.new
+		if @doc_src then
+			@html = @bf.parse_document(@doc_src)
+		else
+			@html, @rs = @bf.parse_text_with_render_state(@src)
+		end
+		@doc = Hpricot(@html)
+	end
+
+	describe 'Standard:' do
+		before(:all) do
+			@header_part = <<MARKDOWN
 # h1 #
 ## h2a ##
 ## h2b ##
@@ -13,84 +24,122 @@ describe 'TOC:' do
 ### h3c ###
 ## h2c ##
 MARKDOWN
-	end
+		end
 
-	before(:each) do
-		@bf = BlueFeather::Parser.new
-		@html = @bf.parse_text(@src)
-		@doc = Hpricot(@html)
-	end
 	
 	
-	share_as :ContentOverview do
-		specify 'overview' do
-			@doc.should have_element('ul')
-			@doc.should have_elements(1, 'h1')
-			@doc.should have_elements(3, 'h2')
-			@doc.should have_elements(3, 'h3')
+		share_as :ContentOverview do
+			specify 'overview' do
+				@doc.should have_element('ul')
+				@doc.should have_elements(1, 'h1')
+				@doc.should have_elements(3, 'h2')
+				@doc.should have_elements(3, 'h3')
+			end
 		end
-	end
-
-
-	describe 'basic:' do
-		include ContentOverview
-		before(:all) do
-			@src = "{toc}\n\n" +  @header_part
+	
+	
+		describe 'basic:' do
+			include ContentOverview
+			before(:all) do
+				@src = "{toc}\n\n" +  @header_part
+			end
+			
+			
+			specify 'list structure' do
+				toc = @doc.at('ul')
+				toc['class'] = 'toc'
+				
+				@doc.should have_elements(3, 'ul.toc > li')
+				@doc.should have_elements(1, 'ul.toc > li > ul')
+				@doc.should have_elements(3, 'ul.toc > li > ul > li')
+			end
+			
+			specify 'list content' do
+				toc = @doc.at('ul')
+				toc['class'] = 'toc'
+				
+				items1 = @doc.search('ul.toc > li')
+				items1[0].inner_text.should == 'h2a'
+				items1[2].inner_text.should == 'h2c'
+	
+				items2 = @doc.search('ul.toc > li > ul > li')
+				items2[0].inner_text.should == 'h3a'
+				items2[1].inner_text.should == 'h3b'
+				items2[2].inner_text.should == 'h3c'
+			end
+	
 		end
 		
 		
-		specify 'list structure' do
-			toc = @doc.at('ul')
-			toc['class'] = 'toc'
+		describe 'range:' do
+			include ContentOverview
+			before(:all) do
+				@src = "{toc:h1..h2}\n\n" +  @header_part
+			end
 			
-			@doc.should have_elements(3, 'ul.toc > li')
-			@doc.should have_elements(1, 'ul.toc > li > ul')
-			@doc.should have_elements(3, 'ul.toc > li > ul > li')
+			specify 'list structure' do
+				toc = @doc.at('ul')
+				toc['class'] = 'toc'
+				
+				@doc.should have_elements(1, 'ul.toc > li')
+				@doc.should have_elements(1, 'ul.toc > li > ul')
+				@doc.should have_elements(3, 'ul.toc > li > ul > li')
+			end
+			
+			specify 'list content' do
+				toc = @doc.at('ul')
+				toc['class'] = 'toc'
+				
+				items2 = @doc.search('ul.toc > li > ul > li')
+				items2[0].inner_text.should == 'h2a'
+				items2[1].inner_text.should == 'h2b'
+				items2[2].inner_text.should == 'h2c'
+			end
+	
 		end
 		
-		specify 'list content' do
-			toc = @doc.at('ul')
-			toc['class'] = 'toc'
+		
+		describe 'numbering:' do
+			before(:all) do
+				@doc_src = "Numbering: yes\n\n{toc}\n" + @header_part
+			end
 			
-			items1 = @doc.search('ul.toc > li')
-			items1[0].inner_text.should == 'h2a'
-			items1[2].inner_text.should == 'h2c'
+			specify 'list content' do
+				toc = @doc.at('ul')
+				toc['class'] = 'toc'
+				
+				items1 = @doc.search('ul.toc > li')
+				items1[0].inner_text.should == '1. h2a'
+				items1[2].inner_text.should == '3. h2c'
+				
+				items2 = @doc.search('ul.toc > li > ul > li')
+				items2[0].inner_text.should == '2.1. h3a'
+				items2[1].inner_text.should == '2.2. h3b'
+				items2[2].inner_text.should == '2.3. h3c'
 
-			items2 = @doc.search('ul.toc > li > ul > li')
-			items2[0].inner_text.should == 'h3a'
-			items2[1].inner_text.should == 'h3b'
-			items2[2].inner_text.should == 'h3c'
+			end
 		end
 
-	end
-
-	describe 'range:' do
-		include ContentOverview
-		before(:all) do
-			@src = "{toc:h1..h2}\n\n" +  @header_part
-		end
 		
-		specify 'list structure' do
-			toc = @doc.at('ul')
-			toc['class'] = 'toc'
-			
-			@doc.should have_elements(1, 'ul.toc > li')
-			@doc.should have_elements(1, 'ul.toc > li > ul')
-			@doc.should have_elements(3, 'ul.toc > li > ul > li')
-		end
-		
-		specify 'list content' do
-			toc = @doc.at('ul')
-			toc['class'] = 'toc'
+
+	end
+	
+	describe 'Illegal:' do
+		describe 'Standard:' do
+			before(:all) do
+				@src = <<MARKDOWN
+{toc}
+	
+### h3
+MARKDOWN
+			end
 			
-			items2 = @doc.search('ul.toc > li > ul > li')
-			items2[0].inner_text.should == 'h2a'
-			items2[1].inner_text.should == 'h2b'
-			items2[2].inner_text.should == 'h2c'
+			specify '1 warning' do
+				@rs.warnings.size.should == 1
+			end
 		end
-
 	end
-
+	
 	
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bluefeather
 version: !ruby/object:Gem::Version 
-  version: "0.22"
+  version: "0.30"
 platform: ruby
 authors: 
 - Dice
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-15 00:00:00 +09:00
+date: 2009-08-01 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -40,6 +40,7 @@ files:
 - spec/footnote.rb
 - spec/header-id.rb
 - spec/lib/common.rb
+- spec/numbering.rb
 - spec/table.rb
 - spec/text/encoding_sample_default.bfdoc
 - spec/text/encoding_sample_euc-jp.bfdoc