RubyからRDFを使うライブラリをいくつか紹介してきましたが,最近急ピッチで開発されているRDF.rbが本命になりそうです.まだSPARQLは使えず,基本的なことしかできませんが,やっとどれを使ったらいいのかよくわからないという状況が変わりそうです.

ちゃんとした紹介を日本語で書こうと思っていたら,作者達が良くできたチュートリアルを書いてくれたので,それを翻訳することにしました.とりあえずここに置いておくことにします.

RubyによるRDFデータの解析と永続化 (Parsing and Serializing RDF Data with Ruby)

original text 2010/04/21 by Arto

このチュートリアルでは、Ruby用のライブラリRDF.rbを使ったRDFデータの解析と永続化の方法を学びます。RDFを基礎としたLinked Dataの永続化形式には色々ありますが、RDF.rbでは多くの形式が使えます。

このチュートリアルに沿ってコード例を試すには、RubyとRubygemsだけが必要です。最近のRuby 1.8.xや1.9.x、またはJRuby1.4.0以上なら動きます。

サポートしているRDF形式

現在RDF.rbで解析や永続化できるRDF形式は以下の通りです。


形式        | 実装                  | RubyGems gem
------------|-----------------------|-------------
N-Triples   | RDF::NTriples         | rdf
Turtle      | RDF::Raptor::Turtle   | rdf-raptor
RDF/XML     | RDF::Raptor::RDFXML   | rdf-raptor
RDF/JSON    | RDF::JSON             | rdf-json
TriX        | RDF::TriX             | rdf-trix

RDF.rb自体は比較的軽量なgemで、N-Triples形式のみビルトインでサポートしています。その他の形式についてはRDF::Raptor, RDF::JSON, RDF::TriXのようなプラグインとして、個別のgemにパッケージ化されています。このアプローチによって、コアライブラリを他から切り離して、RDF.rb自体がいかなるXMLやJSONパーサへの依存しないようにしています。

これら全ての形式サポートを一度に簡単にインストールできます。

$ sudo gem install rdf rdf-raptor rdf-json rdf-trix
Successfully installed rdf-0.1.9
Successfully installed rdf-raptor-0.2.1
Successfully installed rdf-json-0.1.0
Successfully installed rdf-trix-0.0.3
4 gems installed

注: RDF::Raptor gemはRaptor RDF Parser ライブラリとそのコマンドラインツールがシステムにインストールされている必要があります。MacやLinux, BSDディストリビューションのための簡単なRaptorのインストール方法は以下の通りです。

$ sudo port install raptor             # Mac OS X with MacPorts
$ sudo fink install raptor-bin         # Mac OS X with Fink
$ sudo aptitude install raptor-utils   # Ubuntu / Debian
$ sudo yum install raptor              # Fedora / CentOS / RHEL
$ sudo zypper install raptor           # openSUSE
$ sudo emerge raptor                   # Gentoo Linux
$ sudo pkg_add -r raptor               # FreeBSD
$ sudo pkg_add raptor                  # OpenBSD / NetBSD

Raptorのインストールや使用方法についての更なる情報は、我々の以前のチュートリアル RDF for Intrepid Unix Hackers: Trasmuting N-Triplesを見てください。

RDFデータの読み込み

もしあなたが急いでいて、すぐにRDFデータの正しい読み込み方を知りたいのなら、あなたが知る必要があることは本当に以下だけです。

require 'rdf'
require 'rdf/ntriples'

graph = RDF::Graph.load("http://datagraph.org/jhacker/foaf.nt")

この例では、まずはじめにRDF.rbとN-Triples形式のサポートを読み込んでいます。その後、RDF::Graphクラスの便利なメソッドを使って、RDFデータを一度に直接ウェブURLから取得して解析します。(loadメソッドはファイル名かURLを受け付けます。)

全てのRDF.rbパーサプラグインは、処理可能なMIMEタイプとファイル拡張子を宣言します。それが、上の例でRDF.rbが、与えられたURLにあるfoaf.ntファイルを読むためのN-Triplesパーサのインスタンスの作り方を知っている理由です。

同じ方法で、RDF.rbは他のいかなるRDFファイル形式を自動検知します。そのためには、以下のどれかを使って形式のサポートを読み込めば良いです。


require 'rdf/ntriples' # Support for N-Triples (.nt)
require 'rdf/raptor'   # Support for RDF/XML (.rdf) and Turtle (.ttl)
require 'rdf/json'     # Support for RDF/JSON (.json)
require 'rdf/trix'     # Support for TriX (.xml)

注: もし複数の名前付きグラフを含むRDFファイル(TriXのように名前付きグラフをサポートする永続化形式)を読む必要があるなら、おそらくRDF::Graphの代わりにRDF::Repositoryを使いたいでしょう。


repository = RDF::Repository.load("http://datagraph.org/jhacker/foaf.nt")

この2つの違いは、RDF::Repositoryインスタンス内のRDF文が、オプションとしてcontextを含められることです(すなわち4つ組(quad)になれます)。RDF::GraphインスタンスのRDF文は常に同じcontextとなります(すなわちこれらは3つ組(triple)です)。言い換えると、レポジトリは一つ以上のグラフを含み、以下のようにアクセスできます。

repository.each_graph do |graph|
  puts graph.inspect
end

RDF形式の内部処理

RDF.rbの解析や永続化APIは以下の3つの基底クラスを基にしています。

  • RDF::Formatは特定のRDF永続化形式を記述するために使われます。
  • RDF::ReaderRDFパーサ実装用の基底クラスです。
  • RDF::WriterRDF永続化実装用の基底クラスです。

もしあなたが解析や永続化をしたいファイル形式について何か知っているなら、形式指定用のクラスを以下の何れかの方法で取得できます。

require 'rdf/raptor'

RDF::Format.for(:rdfxml)       #=> RDF::Raptor::RDFXML::Format
RDF::Format.for("input.rdf")
RDF::Format.for(:file_name      => "input.rdf")
RDF::Format.for(:file_extension => "rdf")
RDF::Format.for(:content_type   => "application/rdf+xml")

一度そのような形式指定用のクラスを持てば、そこから解析/永続化実装を取得可能です。

format = RDF::Format.for("input.nt")   #=> RDF::NTriples::Format
reader = format.reader                 #=> RDF::NTriples::Reader
writer = format.writer                 #=> RDF::NTriples::Writer

また、RDF::ReaderとRDF::Writerにも、直接対応するファクトリメソッドがあります。

reader = RDF::Reader.for("input.nt")   #=> RDF::NTriples::Reader
writer = RDF::Writer.for("output.nt")  #=> RDF::NTriples::Writer

以上が、URLやファイル名をRDF::Graph.loadに渡したときに、RDF.rbが正しい解析実装を得るために内部で依存するものです。もちろん、永続化形式を自動検出して、解析や永続化用の適切な実装クラスに委譲する必要がある、他のいかなるメソッドも同様です。

RDFデータの解析

もし、より明示的にRDFデータの解析、例えばデータセットをメモリに読み込めないので文毎に処理したい、ということをする必要があるのなら、RDF::Readerを直接使う必要があります。

ファイルからRDF文を解析

RDFパーサ実装は一般的にRDF::Enumerableインタフェースのストリーミング互換なサブセットをサポートします。これは#each_statementメソッドを基にしています。以下はRDFファイルを文毎に列挙しながら読み込む方法です。

require 'rdf/raptor'

RDF::Reader.open("foaf.rdf") do |reader|
  reader.each_statement do |statement|
    puts statement.inspect
  end
end

RDF::Reader.openをRubyブロックと一緒に使うことで、入力ファイルが処理後に自動的に閉じられることが保障されます。

URLからRDF文を解析

前の通り、ファイル名を使えていた場所全てでhttp://https://のURLを使えます。

require 'rdf/json'

RDF::Reader.open("http://datagraph.org/jhacker/foaf.json") do |reader|
  reader.each_statement do |statement|
    puts statement.inspect
  end
end
文字列からRDF文を解析

時々、すでにメモリバッファ上のどこかに永続化されたRDFコンテンツを持っているときがあります。例えばデータベースから取得した場合です。そのような場合、前に示したパーサ実装を取得して、その後RDF::Reader.newを直接使います。

require 'rdf/ntriples'

input = open('http://datagraph.org/jhacker/foaf.nt').read

RDF::Reader.for(:ntriples).new(input) do |reader|
  reader.each_statement do |statement|
    puts statement.inspect
  end
end

RDF::Readerコンストラクタはダックタイピングを使用しているので、#readlineメソッドに応答するいかなる入力(例えばIOStringIOオブジェクト)を受け付けます。もし入力の引数が何も与えられないときは、入力データはデフォルトで標準入力から読み込まれます。

RDFデータの永続化

RDFデータの永続化は解析とほとんど同様です。名前付きの出力ファイルに永続化されるとき、与えられたファイル拡張子によって正しい永続化実装がファイル拡張子によって自動検出されます。

出力ファイルにRDF文を永続化する

RDF永続化実装は一般的にRDF::Mutableインタフェースのサブセットであり、追加だけ可能です。主に#insertメソッドとそのエイリアス#<<が対応します。以下がRDFファイルに文毎に出力する方法です。

require 'rdf/ntriples'
require 'rdf/raptor'

data = RDF::Graph.load("http://datagraph.org/jhacker/foaf.nt")

RDF::Writer.open("output.rdf") do |writer|
  data.each_statement do |statement|
    writer << statement
  end
end

またですが、RDF::Writer.openをRubyブロックと一緒に使うことで、処理後に出力ファイルが自動的にフラッシュされ閉じられることが保障されています。

RDF文を文字列結果に永続化

ある共通のユースケースは、文字列バッファにRDFグラフを永続化することです。例えばRailsアプリケーションからRDFデータを供給するときです。RDF::Writerには便利なbufferクラスメソッドがあり、StringIOに出力を溜め込んで最後に文字列として返してくれます。

require 'rdf/ntriples'

output = RDF::Writer.for(:ntriples).buffer do |writer|
  subject = RDF::Node.new
  writer << [subject, RDF.type, RDF::FOAF.Person]
  writer << [subject, RDF::FOAF.name, "J. Random Hacker"]
  writer << [subject, RDF::FOAF.mbox, RDF::URI("mailto:jhacker@example.org")]
  writer << [subject, RDF::FOAF.nick, "jhacker"]
end
永続化出力をカスタマイズ

もし特定の永続化実装が名前空間接頭辞宣言や基底URIのようなオプションをサポートしているなら、これらのオプションをRDF::Writer.openRDF::Writer.newにキーワード引数として与えることで指定できます。

RDF::Writer.open("output.ttl", :base_uri => "http://rdf.rubyforge.org/")
RDF::Writer.for(:rdfxml).new($stdout, :base_uri => "http://rdf.rubyforge.org/")

サポートチャンネル

皆さん、今はこれで終わりです。このチュートリル以上のAPIについての情報は、RDF.rb API文書を参照してください。何か質問があれば、#swigpublic-rdf-ruby@w3.orgメーリングリストで遠慮なく聞いて下さい。

Greggが早急に動くようにしてくれました.すでに入れている人はgem update で0.5.0にできます.とりあえずRuby1.8.6-1.9.1なら動くようになったようです.1.8と1.9では文字の扱いが大分違うので色々な問題がありそうですね.また,TurtleなどのTestSuiteもN3 Parserが通るようになってみたいです.

次はRubyRDFです.特徴は以下の通りです.

  • Store: Memory, Sesami
  • Query: 独自の構文

特定のフォーマットの入出力には対応しておらず,メモリ上(またはSesami)でグラフを作り,それに対して独自のクエリを投げられるだけのようです.また,残念ながら開発が止まっており,かつRuby1.8.xでしか動きません.Ruby1.9.1では駄目でした.メリットが何もないので少し試しただけで止めました.

使い方

gemから入れます.


$ gem install rubyrdf

とりあえず試すには以下のコード(ほぼサンプルのまま)を入れれば良いです.


#!/usr/bin/ruby

require 'rubygems'
require 'rubyrdf'

RDF::Namespace.register(:dc, "http://purl.org/dc/elements/1.1/")
g = RDF::Graph::Memory.new
g.add(RDF::UriNode.new("http://paul.stadig.name/"), DC::author,  
         g.new_blank_node("test"))

q = RDF::Query.new
q.select(:x, :y).where(:x, DC::author, :y)
result = g.execute(q)
result.bindings.each do |b|
  puts "x = #{b[:x]}"
  puts "y = #{b[:y]}"
end

自分用メモとして,言語毎にRDFを扱えるライブラリのまとめをしていきたいと思っています.とりあえずまずはRubyから.RubyはRDFライブラリの対応具合がばらばらで,これといったものがありませんでした.一番人気がある方法がJRuby経由でJenaを使うことです.私はCライブラリであるRedlandのRubyバインディングをたまに使っていました.しかしここ最近,Pure Rubyなライブラリが出てきているので,調査しています.

まず今回はRdfContextです.Reddyがベースとなっています.主な機能は以下の通り.

  • Parser: RDF/XML, RDFa, N3
  • Store: List(Array), Memory, SQLite3
  • Serialization: RDF/XML, N-Triples

まだRDFの入出力しか対応しておらず,SPARQLなどの機能はTodoとなっています.また,非ASCII文字は全部unicode escapeされます.Ruby1.9.1で動かなかったので,とりあえず動くようにするPatchを送ったのですが,作者のGreggが今色々と対応中で,近い内にversion0.5を出したいとのことなので,しばらく待とうと思います.

使い方

インストールはgemでできます.Ruby 1.8.7なら動くはずです.Ruby1.9以上で使う場合は上記のPatchをインストール後に当てればとりあえず使えます.


$ gem install rdf_context

RDFファイルを読み込んでN-Triplesで出力するコードは以下のようになります.p.parseの2つ目の引数で基点となるURIを与える必要があります.与えなかった場合は適当なbnodeになるようです.


#!/usr/bin/ruby
require 'rubygems'
require 'rdf_context'
require 'open-uri'

include RdfContext
p = Parser.new
str = open("http://fumi.me/foaf.rdf").read
g = p.parse(str, "http://fumi.me/foaf.rdf", :type => :rdfxml)

#puts g.to_rdfxml
puts g.to_ntriples

また,GraphにTripleを追加いきたいときは,ストレージ先を指定したGraphを先に作れば良いです.引数storeについては,今のところListは動くのですが,まだSQLite3で動かせていません.引数identifierは,NamedGraph用のようです.下記のコードで,二つのRDF/XMLの内容をまとめた一つのRDF/XMLを出力することができます.


include RdfContext

## 動かない
#g = Graph.new(:store => SQLite3Store.new(:path => "store.db"),
            :identifier => URIRef.new("http://fumi.me")) 

g = Graph.new(:store => :list_store,
            :identifier => URIRef.new("http://fumi.me"))
g.parse(open("http://fumi.me/foaf.rdf").read, 
            "http://fumi.me/foaf.rdf", :type => :rdfxml)
g.parse(open("http://semantictweet.com/fumi1").read,
            "http://semantictweet.com/fumi1", :type => :rdfxml)
puts g.to_rdfxml

全体的にまだまだこれからという印象です.

プログラミング言語Ruby

この本がPerlのラクダ本扱いになるのかはわからないですが,Rubyでプログラムを書いている人は一度目を通す価値ありだと思います.Rubyは使い始めてから結構年数が経ちますが,細部で知らないことが結構ありました.例えばcloneとdupの違い.対象がfreezeの場合,cloneはそのままコピーしますが,dupはfreezeを外します.また,cloneはオブジェクトの特異メソッドもコピーします.splat演算子というのも使ったことがないです.

Procとlambdaの扱いの違いも知りませんでした.returnやbreakなどの制御構文で違う動作をします.また,lambda はメソッド扱いなので引数の数が厳密にチェックされるそうです.Ruby1.9 にはlambdaかProcかを判別できるようにlambda?メソッドが追加されています.

Ruby1.9についてはまったく知らなかったので,かなり参考になりました.仕様としては,エンコーディングのサポートと,文字の単位がエンコーディング依存になるのが一番大きい変更のようです..lengthはバイト数ではなく文字数になります.逆にバイト単位用の仕様やメソッドも色々追加されています.その他,便利なメソッドが増えているようなので,一度標準ライブラリを確認し直した方が良さそうです.

アマゾンのサーバでエラーが起こっているかもしれません。
一度ページを再読み込みしてみてください。

Evernote APIのライブラリとサンプルはAPIのページからダウンロード可能です.サンプルはJava,Perl,PHP,Python,Rubyが用意されています.Rubyのサンプルはsample/ruby/EDAMTest.rbです.まず,EDAMTest.rbの13-16行目を,取得したAPI key,secret,開発サーバのユーザ名,パスワードで置き換えます.


consumerKey = "your-api-key-here!"
consumerSecret = "your-api-secret-here!"
username = "your-username"
password = "your-password"

次に,EDAMTest.rbの先頭にEvernote APIのライブラリのパスを追加します.


$:.unshift("../../lib/ruby/")

ライブラリにはバグがあるので以下のパッチを当てます.thriftのほうを直すべきだと思いますが,とりあえず動かすために.


--- lib/ruby/thrift/struct.rb.orig      2009-02-07 17:07:30.000000000 +0900
+++ lib/ruby/thrift/struct.rb   2009-02-08 09:40:56.000000000 +0900
@@ -97,11 +97,11 @@
         end
         iprot.read_struct_end
       end
-      validate
+#      validate
     end

     def write(oprot)
-      validate
+#      validate
       if oprot.respond_to?(:encode_binary)
         # TODO(kevinclark): Clean this so I don't have to access the transport.
         oprot.trans.write oprot.encode_binary(self)

--- lib/ruby/thrift/transport/httpclient.rb.orig        2009-02-08 09:46:12.000000000 +0900
+++ lib/ruby/thrift/transport/httpclient.rb     2009-02-08 09:46:53.000000000 +0900
@@ -19,6 +19,7 @@
     def flush
       http = Net::HTTP.new @url.host, @url.port
       http.use_ssl = @url.scheme == "https"
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       headers = { 'Content-Type' => 'application/x-thrift' }
       resp, data = http.post(@url.path, @outbuf, headers)
       @inbuf = StringIO.new data

後は,残りの必要なライブラリをインストールします.Ubuntu8.10だと以下のように入力します.


$ sudo aptitude install libreadline-ruby libhttp-access2-ruby

ここまで設定すれば,ruby EDAMTest.rbと入力することでサンプルプログラムが起動すると思います.
入力した文章を新しいノートとして取り込むという単純なプログラムです.