Tenarai::XML

Ruby のブロックを使って XML を作るクラス

概要

あたりまえのことなんですが、html ってこんな風に書くじゃないですか、

 <html>
   <head><title>タイトル</text></head>
   <body>
     <h1>ヘッダー</h1>
     <p id="summary">
       コンテンツいろいろ
      </p>
   </body>
 </html>

気をつけて書けばいいんでしょうが、タグが多くなってくると、(これは例なので少ないけど、)

 <html>
   <head><title>タイトル</text></head>
   <body>
     <h1>ヘッダー</h1>
     <p id="summary">
       コンテンツいろいろ
      <div>
     </p>
       コンテンツそれから...
     </div>
   <body>
 </html>

こんな風に div と p の入れ子がおかしなことになったり、閉じタグを間違って書いちゃったりします。この例だと body の閉じタグも間違ってます。

チェックすればいいんだけど、めんどうなんで、出来れば生の XML や HTML は触りたくない。

そこで、Ruby でこういう風に書ければ便利かなと思って作りました。タイプ量は増えちゃいますが...

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.tag('html') do |html|
   html.tag('head').tag('title').text('タイトル')
   html.tag('body') do |bd|
     bd.tag('h1').text('ヘッダー')
     bd.tag('p') do |p|
       p['id'] = 'summary'
       p.text('コンテンツいろいろ')
     end
     bd.tag('div').text('コンテンそれから...')
   end
 end
 
 puts xml.to_s

これを実行すると、以下のようにデフォルトでは 2 文字でインデントします。また、テキストの両側に不要なスペースや改行文字を付けません。

 <html>
   <head>
     <title>タイトル</title>
   </head>
   <body>
     <h1>ヘッダー</h1>
     <p id="summary">コンテンツいろいろ</p>
     <div>コンテンそれから...</div>
   </body>
 </html>

Tenarai::XML.new と to_s の引数にインデント文字数を指定できるので、例えば最初の方の new するところをこうするか、

 xml = Tenarai::XML.new(:indent => 0)

あるいは、最後の行を、

 puts x.to_s(0)

とすると、

 <html><head><title>タイトル</title></head><body><h1>ヘッダー</h1><p id="summary">コンテンツいろいろ</p><div>コンテンそれから...</div></body></html>

インデントしないで、こんな風に一行にします。

このモジュールを書いた後、どっかで同じようなものを見たような気がするんですが、書いてしまったものはしょうがない。もったいないので、使うことにします。

クラスメソッド

new(param={:indent=>2})

new(param={:indent=>2}) { |xml| ... }

それぞれ、オブジェクトを作成します。引数のハッシュオブジェクトにデフォルトのインデント文字数を指定することが出来ます。また、ブロックを指定した場合は、ブロックの引数に作成したオブジェクトが代入されます。

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 xml.tag('a').tag('b')
 puts xml.to_s
 
 puts Tenarai::XML.new { |xml|
   xml.tag('a').tag('b')
 }.to_s

メソッド

xml(version, encoding)

xml 宣言を作成します。

サンプルコード

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.xml('1.0', 'utf-8')
 
 puts xml.to_s

実行結果

<?xml version="1.0" encoding="utf-8"?>

doctype(root, fpi, uri)

DOCTYPE 宣言を作成します。

サンプルコード

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.doctype('html', '-//W3C//DTD XHTML 1.0 Strict//EN', 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd')
 
 puts xml.to_s

実行結果

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

tag(tag, attr={})

tag(tag, attr={}) { |obj| ... }

それぞれタグオブジェクト (Tenarai::XML::Tag) を作成します。引数としてタグのアトリビュートを指定した Hash オブジェクトを渡すことができます。ブロックを指定した場合は、ブロックの引数に作成したタグオブジェクトが代入されます。

タグオブジェクトの [], []= メソッドでアトリビュートを操作できます。

Tenarai::XML::Tag クラスは Tenarai::XML クラスを継承しているので、Tenarai::XML クラスのメソッドを使ってタグを入れ子にしたり、テキストノードを作成したりすることができます。

サンプルコード

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.tag('html') do |html|
   html.tag('head').tag('title').text('タイトル')
   html.tag('body') do |bd|
     bd.tag('h1', 'id' => 'title').text('ヘッダー')
     bd.tag('p') do |p|
       p['class'] = 'summary'
       p.text('コンテンツ概要')
     end
   end
 end
 
 puts xml.to_s

実行結果

 <html>
   <head>
     <title>タイトル</title>
   </head>
   <body>
     <h1 id="title">ヘッダー</h1>
     <p class="summary">コンテンツ概要</p>
   </body>
 </html>

text(text)

テキストを作成します。< や > などは to_s したときにエスケープされます。

空白文字を   に変換することはしません。というのも、  の場合はブラウザが自動改行してくれないので、ものすごく長い一行になってしまうことになるので。

サンプルコード

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.tag('p').text('<span>テキスト</span>文字 で す')
 
 puts xml.to_s

実行結果

 <p>&lt;span&gt;テキスト&lt;/span&gt;文字 で す</p>

escaped_text(text)

テキストを作成します。< や > などは to_s してもそのまま出力されます。

サンプルコード

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.tag('p').escaped_text('<span>テキスト</span>文字 で す')
 
 puts xml.to_s

実行結果

 <p><span>テキスト</span>文字 で す</p>

code(code='')

escaped_text と同じでテキストを作成しますが、to_s したときに code の最初と最後に改行文字を付けます。escaped_text だとJavaScript を埋め込んだときに JavaScript コードの最初と最後が script タグにくっついてしまい、見栄えが良くないので用意したメソッドです。ただそれだけ。

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.tag('script', 'type' => 'text/javascript').code <<END
 alert('hello');
 END
 
 puts xml.to_s

実行結果

 <script type="text/javascript">
 
 alert('hello');
 
 </script>

comment(comment)

で囲われたコメントを作成します。

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.comment('コメント文字列')
 
 puts xml.to_s

実行結果

 <!--
 コメント文字列
 -->

cdata(cdata)

CDATA セクションを作成します。

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new
 
 xml.comment('<タグはそのまま出力されます>')
 
 puts xml.to_s

実行結果

 <![CDATA[<タグはそのまま出力されます>]]>

to_s(indent=nil)

オブジェクトを XML に整形した文字列を返します。引数にインデントの文字数を指定することができます。

 require 'tenarai/xml'
 
 xml = Tenarai::XML.new(:indent => 2)
 
 xml.tag('div').tag('p').text('コンテンツ')
 
 puts xml.to_s
 puts xml.to_s(0)

実行結果

 <div>
   <p>コンテンツ</p>
 </div>
 <div><p>コンテンツ</p></div>

to_xml

to_s のエイリアスです

AdSense is disabled. Please check setting.

Tenarai

最近の更新

2008-11-25

2008-05-12

2008-04-16

Wikiガイド

サイドバー

Tenarai::XML

概要

クラスメソッド

new(param={:indent=>2})

new(param={:indent=>2}) { |xml| ... }

メソッド

xml(version, encoding)

doctype(root, fpi, uri)

tag(tag, attr={})

tag(tag, attr={}) { |obj| ... }

text(text)

escaped_text(text)

code(code='')

comment(comment)

cdata(cdata)

to_s(indent=nil)

to_xml