bluefeather 0.10

data/Rakefile.rb

@@ -0,0 +1,168 @@
+# encoding: us-ascii
+#-----------------------------------------------------------
+# BlueFeather rakefile
+#
+# Requirement:
+#   Ruby (1.8.1 later)
+#   Rake - <http://rake.rubyforge.org/> or `gem install rake` with RubyGems
+#   Exerb - <http://exerb.sourceforge.jp/>
+#   Info-Zip - If you use Windows, you can get it from GnuWin32
+#                                  <http://gnuwin32.sourceforge.net/>
+#   Rspec - `gem install rspec` with RubyGems
+#-----------------------------------------------------------
+
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'rake/clean'
+
+$KCODE = 'u'
+$LOAD_PATH.unshift './lib'
+require 'bluefeather'
+
+ZIP_NAME = "pkg/bluefeather-#{BlueFeather::VERSION}.zip"
+
+CLOBBER.include 'sample/*.html'
+CLOBBER.include 'doc/**/*.html'
+
+# setup.rb
+CLEAN.include('InstalledFiles', '.config', 'bin/bluefeather.bat')
+
+PACKAGED = FileList.new
+PACKAGED.include('readme*.txt')
+PACKAGED.include('setup.rb')
+PACKAGED.include('Rakefile.rb')
+PACKAGED.include('bin/**/*')
+PACKAGED.include('lib/bluefeather.rb')
+PACKAGED.include('lib/bluefeather/*.rb')
+PACKAGED.include('license/**/*')
+PACKAGED.include('spec/**/*')
+PACKAGED.include('original-tests/**/*')
+PACKAGED.include('doc/**/*.*')
+PACKAGED.exclude('doc/**/format-extension-spec.*')
+
+
+
+task :default => :package
+
+desc 'Package to zip.'
+task :package => [:doc, ZIP_NAME]
+
+desc 'Clobber and package.'
+task :repackage => [:clobber, :package]
+
+file ZIP_NAME => PACKAGED do |task|
+	mkpath 'pkg'
+	src_list = task.prerequisites.map{|x| %Q|"#{x}"|}.join(' ')
+	sh "zip -q #{task.name} #{src_list}"
+	puts "#{task.name} maked. (#{File.size(task.name) / 1024} KB)"
+end
+
+
+
+
+DOCS = []
+Dir.glob('doc/**/*.bfdoc').each do |src|
+	dest = src.sub(/\.bfdoc$/, '.html')
+	DOCS << dest
+
+	file dest => src do
+		html = BlueFeather.parse_document_file(src)
+		open(dest, 'w'){|f| f.write(html)}
+		puts "#{src} => #{dest}"
+	end
+end
+
+desc 'Convert documents, bfdoc -> html'
+task :doc => DOCS
+
+task :sample => 'sample/sample.html'
+
+file 'sample/sample.html' => 'sample/sample.bfdoc' do |task|
+	html = BlueFeather.parse_document_file(task.prerequisites.first)
+	open(task.name, 'w'){|f| f.write(html)}
+	puts "#{task.prerequisites.first} => #{task.name}"
+end
+
+
+
+
+GEM_PACKAGED = PACKAGED.dup
+GEM_PACKAGED.exclude('setup.rb')
+
+spec = Gem::Specification.new do |s|
+	s.platform = Gem::Platform::RUBY
+	s.summary = "Extend Markdown Converter"
+	s.author = 'Dice'
+	s.email = 'tetradice@gmail.com'
+	s.homepage = 'http://ruby.morphball.net/bluefeather/'
+	s.name = 'bluefeather'
+	s.rubyforge_project = 'bluefeather'
+	s.has_rdoc = false
+	s.required_ruby_version = '>= 1.8.1'
+	s.version = BlueFeather::VERSION
+	s.files = GEM_PACKAGED
+	s.executables = ['bluefeather']
+	s.description = <<EOF
+ BlueFeather is software for converting text written by extended Markdown to
+html. It is pair of command-line tool and pure Ruby library.
+EOF
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end
+
+
+
+
+
+
+desc 'Run tests of original BlueCloth.'
+Rake::TestTask.new('original-test') do |tasklib|
+	tasklib.test_files = FileList['original-tests/*.tests.rb']
+end
+
+
+# Proc for initializing each spec-tasks by common parameters
+setting = proc do |st|
+	st.libs << ['./lib']
+	st.ruby_opts = %w(-Ku)
+end
+
+
+desc "Verify all spec files."
+Spec::Rake::SpecTask.new do |st|
+	setting.call(st)
+	st.spec_files = FileList['spec/*.rb']
+end
+
+desc "Verify all spec files with specdocs."
+Spec::Rake::SpecTask.new(:specd) do |st|
+	setting.call(st)
+	st.spec_opts << '-fs'
+	st.spec_files = FileList['spec/*.rb']
+end
+
+
+
+namespace :spec do
+	Dir.glob('spec/*.rb') do |path|
+		desc "Verify '#{path}'"
+		Spec::Rake::SpecTask.new(File.basename(path, '.rb')) do |st|
+			setting.call(st)
+			st.spec_files = FileList[path]
+		end
+	end
+end
+
+namespace :specd do
+	Dir.glob('spec/*.rb') do |path|
+		desc "Verify '#{path}' with specdocs."
+		Spec::Rake::SpecTask.new(File.basename(path, '.rb')) do |st|
+			setting.call(st)
+			st.spec_opts << '-fs'
+			st.spec_files = FileList[path]
+		end
+	end
+end
+

data/bin/bluefeather

@@ -0,0 +1,4 @@
+#!ruby
+
+require 'bluefeather/cui'
+BlueFeather::CUI.run(ARGV) or exit(1)

data/doc/author-and-license.bfdoc

@@ -0,0 +1,16 @@
+Title: 連絡先・ライセンス - BlueFeather マニュアル
+CSS: black.css
+
+<div class="back"><a href="index.html">BlueFeather マニュアル</a></div>
+
+
+連絡先・ライセンス
+====
+
+BlueFeather は、改変元である BlueCloth のライセンス（利用条件）に基づき、General Public License（GPL）バージョン 2 の元で配布されるフリーソフトウェアです。
+詳しくは、`bluefeather.rb` のファイル頭にある著作権表示、および同梱の `license/` ディレクトリ内にある GPL 公衆利用許諾契約書を参照してください。
+
+* [Wikipedia - GNU General Public License](http://ja.wikipedia.org/wiki/GNU_General_Public_License)
+
+
+BlueFeather への要望、ご意見、バグ報告などがありましたら、[BlueFeather 配布サイト](http://ruby.morphball.net/bluefeather/)よりメッセージを送信していただくか、もしくは Dice（<tetradice@gmail.com>）までメールでご連絡していただけるよう、よろしくお願いします。

data/doc/base.css

@@ -0,0 +1,135 @@
+body {
+  font-size : medium;
+  line-height : 1.4em;
+  margin    : 3em 10%;
+}
+
+
+div.back{
+	text-align: right;
+}
+
+/* �\ */
+
+table{
+  font-size   : 1.0em;
+  margin-left : 1.0em;
+}
+
+th {
+  border-style : outset;
+}
+
+
+
+/* ���o���E�i�� */
+
+h1,h2,h3,h4,h5,h6 {
+  line-height : 1.0em;
+}
+
+h1 {
+  font-size : xx-large;
+}
+
+h2 {
+  font-size : x-large;
+  margin-top : 4em;
+}
+
+h3 {
+	font-size : large;
+	margin-top: 3em;
+}
+
+/* ���\�b�h�ꗗ�p */
+h2 + h2, h3 + h3{
+	margin-top: 0.2em;
+}
+
+p {
+  margin-left : 2em;
+}
+
+
+
+/* ���X�g */
+li {
+  margin-bottom		: 0.6em;
+}
+
+
+dl {
+	margin-left : 2.0em;
+}
+
+dt {
+  font-weight  : bold;
+}
+
+dd {
+  margin-left : 2.0em;
+  margin-bottom : 0.5em;
+}
+
+ul, ol, dl{
+	margin: 2.0em;
+}
+
+ul ul{
+	margin: 0.5em;
+}
+
+li p{
+	margin-left: 0.1em;
+}
+
+
+/* ���p���ׂ����� */
+
+blockquote, pre{
+	margin-left: 3em;
+	margin-bottom: 3em;
+}
+
+blockquote p{
+	margin-left: 0.5em;
+}
+
+
+pre {
+	padding: 1em;
+}
+
+address {
+  text-align : right;
+	font-style: normal;
+}
+
+em {
+  font-weight		: bold;
+  font-style		: normal;
+}
+
+
+pre code{
+	margin: 0;
+}
+
+
+hr {
+}
+
+
+
+
+div.layer {
+  padding-left : 1.5em;
+}
+
+div.link {
+  font-size : 1.2em;
+  font-weight : bold;
+  margin-top : 2.0em;
+  margin-left : 0.5em;
+}

data/doc/basic-usage.bfdoc

@@ -0,0 +1,265 @@
+Title: インストール・基本的な使い方 - BlueFeather マニュアル
+CSS: black.css
+
+<div class="back"><a href="index.html">BlueFeather マニュアル</a></div>
+
+
+
+インストール・基本的な使い方
+====
+
+この文書では、BlueFeather そのものの使い方について記述しています。
+BlueFeather が解釈する Markdown 記法への独自拡張については、[Markdown 記法の拡張](format-extension.html)を参照してください。
+
+{toc}
+
+
+インストール
+----
+同梱の setup.rb を実行することにより、ファイルが適切な位置にコピーされ、インストールが完了します。
+
+	% ruby setup.rb
+
+もしくは、RubyGems がインストールされていれば、インターネットに接続されたPCから次のように打ち込むことでインストールすることも可能です。
+
+	% gem install bluefeather
+
+
+コマンドラインから使う
+----
+
+### 基本
+
+インストールが正常に終了していれば、`bluefeather` コマンドを使って、Markdown記法で書かれたファイルを変換することができます。
+インターフェースは以下の通りです。
+
+	bluefeather [options] file1 [file2] [file3] ...
+
+たとえば、次のように入力することで、拡張子が `.bftext` のファイル全てをhtmlファイルに変換することができます。
+
+	% bluefeather *.bftext
+	example1.bftext => example1.html (4240 byte)
+	example2.bftext => example2.html (5613 byte)
+	example3.bftext => example3.html (10499 byte)
+	% 
+
+オプションの種類については、この文書内の[コマンドラインオプション](#commandline-options)の項を参照してください。
+
+### 拡張子による出力htmlの違い
+
+`bluefeather` コマンドでは、変換対象のファイルの拡張子によって、どのようなhtmlファイルを出力するかが異なります。
+
+`.md`, `.bfdoc`
+:DTD宣言やhead要素などを含んだ、完全なHTML文書を生成する
+
+それ以外
+:HTML片を生成する（DTD宣言やhead要素は含まない）
+
+
+たとえば、次のような一文だけが書かれたテキストファイルがあるとします。
+
+	test paragraph.
+
+このテキストファイルが `test1.bftext` という名前であれば、変換結果（`test1.html`）はこのようになります。
+
+	<p>test paragraph.</p>
+
+しかし、もしこのファイルが `test1.bfdoc` という名前であれば、上記の例と異なり_完全なHTML文書を生成します。_
+
+	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+	<html>
+	<head>
+	<title>no title (Generated by BlueFeather)</title>
+	</head>
+	<body>
+	
+	<p>test paragraph.</p>
+	
+	</body>
+	</html>
+
+
+なお、このとき変換する文書にレベル1の見出しが含まれていれば、_その見出しが自動的にhtml文書のtitleとして使われます。_
+
+test2.bfdoc
+
+:
+
+		Test Document
+		=============
+		
+		test paragraph.
+
+test2.html（出力結果）
+
+:
+
+		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+		<html>
+		<head>
+		<title>Test Document</title>
+		</head>
+		<body>
+		
+		<h1 id="bfheader-a5decd745d43af4aa8cf62eef5be43ac">Test Document</h1>
+		
+		<p>test paragraph.</p>
+		
+		</body>
+		</html>
+
+
+### 文書メタデータ
+
+拡張子が `.bfdoc` や `.md` のファイルには、文書メタデータを付け加えることが出来ます。
+
+test3.bfdoc
+
+:
+
+		Title: Test Document
+		CSS: style.css
+		
+		Test paragraph.
+
+test3.html
+
+:
+
+		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+		<html>
+		<head>
+		<title>Test Document</title>
+		<link rel="stylesheet" type="text/css" href="style.css" />
+		</head>
+		<body>
+		
+		<p>Test paragraph.</p>
+		
+		</body>
+		</html>
+
+
+
+メタデータについての詳細は、[メタデータリファレンス](metadata-reference.html)を参照してください。
+
+### 標準入力からの読み込み（stdin-mode）
+
+ファイル名を `-` とだけ指定すると特殊な動作モードになり、標準入力からテキストを読み込み、変換結果のhtmlを標準出力へ書き込みます。
+パイプラインを用いるときなどに便利です。
+
+	% bluefeather -
+
+
+### コマンドラインオプション {#commandline-options}
+
+`-e NAME`, `--encoding NAME`
+:
+変換するテキストファイルのエンコーディングを、指定したエンコーディングとして解釈します。
+（`shift-jis` / `euc-jp` / `utf-8` / `none` のうちいずれか、もしくは最初の数文字。標準では `utf-8`）
+
+`-f TYPE`, `--format TYPE`
+:
+出力するhtmlの種別を特定します。
+`text`, `bftext` ならhtml片を、 `document`, `bfdoc` なら完全なhtml文書を出力します。
+（標準ではファイルの拡張子から自動判別）
+
+`-h`, `--help`
+: `bluefeather` コマンドの解説を表示します。
+
+`-o DIR`, `--output DIR`
+: 指定したディレクトリに全てのファイルを生成します。（標準ではパース対象のファイルと同じ位置に生成）
+
+`-q`, `--quiet`
+: 動作時に作業の状況や結果を表示しません。
+
+`--suffix .SUF`
+: 出力するファイルの拡張子を指定します。（標準は.html）
+
+`-v`, `--verbose`
+: 冗長フラグ。作業内容を詳細に表示します。
+
+`--version`
+: BlueFeather のバージョンを表示します。
+
+Rubyスクリプト内で使う
+----
+
+### 基本
+
+もっとも基本的なメソッドは、`BlueFeather.parse` です。
+このメソッドにより、BlueFeatherを用いて文字列をパースし、htmlに変換することができます。
+
+	require 'bluefeather'
+	
+	str = "もっとも基本的な例です。"
+	puts BlueFeather.parse(str)      #=> "<p>もっとも基本的な例です。</p>"
+
+また、`BlueFeather.parse_file` を使えば、ファイルの中にある文字列を読み込んでパースすることができます。
+
+	BlueFeather.parse_file('test1.txt')
+	BlueFeather.parse_file('test2.markdown')
+	BlueFeather.parse_file('test3.bftext')
+
+
+### HTML文書の生成 ###
+
+`parse` や `parse_file` メソッドの代わりに、`parse_document` や `parse_document_file` メソッドを用いることによって、HTML片ではなく_完全なHTML文書を生成する_ことが可能です。
+
+test.bfdoc
+
+:		The sentence is expected as HTML.
+
+test.rb
+
+:
+
+		require 'bluefeather'
+		
+		puts '-- parse_file --'
+		puts BlueFeather.parse_file('test.bfdoc')
+		
+		puts '-- parse_document_file --'
+		puts BlueFeather.parse_document_file('test.bfdoc')
+
+実行結果
+
+:
+
+		-- parse_file --
+		<p>The sentence is expected as HTML.</p>
+		
+		-- parse_document_file --
+		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+		<html>
+		<head>
+		<title>no title (Generated by BlueFeather)</title>
+		</head>
+		<body>
+		
+		<p>The sentence is expected as HTML.</p>
+		
+		</body>
+		</html>
+		
+### 文書のメタデータ取得 ###
+
+文書をパースして直接 html を生成するのではなく、`BlueFeather::Document` オブジェクトを生成することにより、その文書のメタデータを取得することができます。
+
+	doc = BlueFeather::Document.parse(<<EOS)
+	Title: test document
+	CSS: style.css
+	
+	test paragraph.
+	EOS
+	
+	p doc['title']     # => "test document"
+	p doc['css']       # => "style.css"
+	p doc[:css]        # => "style.css"
+	p doc['undefined'] # => nil
+	
+	p doc.body         # => "test paragraph."
+
+この `BlueFeather::Document` オブジェクトから実際に html を生成するには、 `to_html` メソッドを呼んでください。
+
+	doc.to_html