1. ホーム
  2. スクリプト・コラム
  3. ルビートピックス

RubyのプログラムでXML形式のデータをパースするためにREXMLを呼び出す例

2022-01-31 14:50:17

REXMLは、Sean Russellによって書かれたライブラリです。Ruby用のXMLライブラリはこれだけではありませんが、人気のあるもので、純粋にRubyで書かれています(NQXMLもRubyで書かれていますが、XMLParserはCで書かれたJadeライブラリをラッピングしています)。REXMLの概要について、Russellは次のようにコメントしている。
私はこの問題を抱えています:私は混乱したAPIを好みません。Java実装のためのいくつかのXMLパーサAPIがあります。それらのほとんどはDOMまたはSAXに従っており、多くのJava APIが出現し続けるのと根本的に非常によく似ています。つまり、自分自身のAPIを使ったことがない理論家が設計したように見えるのです。一般に、既存のXML APIは迷惑な存在です。非常にシンプルで、ファーストクラスで、パワフルであるように設計されたマークアップ言語を、不愉快で、過剰で、大きなAPIでカプセル化しているのです。最も基本的なXMLツリーの操作でさえ、私はいつもAPIドキュメントを参照しなければなりません。
XML APIは、それを使うほとんどの人にとって過剰な作業を強いるものであることは確かです。


次のbook.xmlを見てください。

引用

<library shelf="Recent Acquisitions"> 
 <section name="Ruby"> 
  <book isbn="0672328844"> 
  <title>The Ruby Way</title> 
  <author>Hal Fulton</author> 
  <description> 
   The book you are now reading. 
   Ain't recursion grand? 
  </description> 
  </book> 
 </section> 
 <section name="Space"> 
  <book isbn="0684835509"> 
   <title>The Case for Mars</title> 
   <author>Robert Zubrin</author> 
   <description>Pushing toward a second home for the human 
    race. 
   </description> 
  </book> 
  <book isbn="074325631X"> 
   <title>First Man: The Life of Neil A. Armstrong</title> 
   <author>James R. Hansen</author> 
   <description>Definitive biography of the first man on 
    the moon. 
   </description> 
  </book> 
 </section> 
</library>


1 ツリーパース(別名:DOMライク)

rexml/document ライブラリを必要とし、REXML をインクルードする必要があります。

require 'rexml/document' 
include REXML 
 
input = File.new("books.xml") 
doc = Document.new(input) 
 
root = doc.root 
puts root.attributes["shelf"] # Recent Acquisitions 
 
doc.elements.each("library/section") { |e| puts e.attributes["name"] } 
# Output: 
# Ruby 
# Space 
 
doc.elements.each("*/section/book") { |e| puts e.attributes["isbn"] } 
# Output: 
# 0672328844 
# 0321445619 
# 0684835509 
# 074325631X 
 
sec2 = root.elements[2] 
author = sec2.elements[1].elements["author"].text # Robert Zubrin 



なお、xmlの属性と値はハッシュで表現されているので、attributes[]を使って必要な値を取り出し、要素の値はパスのような文字列か整数値で取得することが可能です。ここで、整数は0ベースではなく1ベースである。

2 ストリーム解析(別名:SAXライク解析)

ここでちょっとしたコツは、パース時にコールバックされるリスナークラスを定義することです。

require 'rexml/document' 
require 'rexml/streamlistener' 
include REXML 
 
class MyListener 
 include REXML::StreamListener 
 def tag_start(*args) 
 puts "tag_start: #{args.map {|x| x.inspect}.join(', ')}" 
 end 
 
 def text(data) 
 return if data =~ /^\w*$/ # whitespace only 
 abbrev = data[0..40] + (data.length > 40 ? "... " : "") 
 puts " text : #{abbrev.inspect}" 
 end 
end 
 
list = MyListener.new 
source = File.new "books.xml" 
Document.parse_stream(source, list) 




このモジュールはいくつかの空のコールバックメソッドを提供していますので、独自の機能を持たせるためにオーバーライドすることができます。パーサーがタグに入るとき、tag_start メソッドを呼び出します。textメソッドも同様ですが、データが読み込まれたときにコールバックされ、その出力は以下のようになります。

tag_start: "library", {"shelf"=>"Recent Acquisitions"} 
tag_start: "section", {"name"=>"Ruby"} 
tag_start: "book", {"isbn"=>"0672328844"} 
tag_start: "title", {} 
text : "The Ruby Way" 




3 XPath

REXMLは、XPathクラスを通じてXpathをサポートしています。また、DOM ライクと SAX ライクの両方をサポートしています。先ほどの xml ファイルと同様に、Xpath を使って次のようなことができます。

book1 = XPath.first(doc, "//book") # Info for first book found 
p book1 
 
# Print out all titles 
XPath.each(doc, "//title") { |e| puts e.text } 
 
# Get an array of all of the "author" elements in the document. 
names = XPath.match(doc, "//author").map {|x| x.text } 
p names 



出力は以下のようなものです。

<book isbn='0672328844'> ... </> 
The Ruby Way 
The Case for Mars 
First Man: The Life of Neil A. Armstrong 
["Hal Fulton", "Robert Zubrin", "James R. Hansen"]