groonga 0.0.1

data/AUTHORS

@@ -0,0 +1 @@
+Kouhei Sutou <kou@clear-code.com>

data/NEWS.ja.rdoc

@@ -0,0 +1,5 @@
+= お知らせ
+
+== 0.0.1: 2009-04-30
+
+* 最初のリリース！

data/NEWS.rdoc

@@ -0,0 +1,5 @@
+= NEWS
+
+== 0.0.1: 2009-04-30
+
+* Initial release!

data/README.ja.rdoc

@@ -0,0 +1,53 @@
+= はじめに
+
+== 名前
+
+Ruby/groonga
+
+== 説明
+
+全文検索機能とカラムストア機能を提供するgroongaのRubyバイン
+ディングです。
+
+groongaのいわゆるDB-API層をRubyから使うための拡張ライブラリで
+す。groongaのAPIをそのままRubyレベルに提供するのではなく、
+Rubyらしく読み書きしやすいAPIとして提供します。高速・高機能な
+groongaをRubyらしい書き方で利用できます。
+
+groongaに関する情報は以下を参照して下さい。
+
+* groonga: http://groonga.org/
+
+== 作者
+
+Kouhei Sutou <kou@clear-code.com>
+
+== ライセンス
+
+LGPL 2.1です。詳しくはlicense/LGPLを見てください。
+
+pkg-config.rbはrcairoに付属しているもので、これはRubyライセ
+ンスです。詳しくはlicense/RUBYとlicense/GPLを見てください。
+
+== 依存ソフトウェア
+
+* Ruby >= 1.8 （1.9.1対応）
+* groonga >= 0.0.4
+
+== インストール
+
+  % sudo gem install groonga
+
+== ドキュメント
+
+http://groonga.rubyforge.org/groonga/
+
+== メーリングリスト
+
+質問、要望、バグ報告などはgroongaのMLにお願いします。
+
+http://lists.sourceforge.jp/mailman/listinfo/groonga-dev
+
+== 感謝
+
+* ...

data/README.rdoc

@@ -0,0 +1,54 @@
+= README
+
+== Name
+
+Ruby/groonga
+
+== Description
+
+Ruby bindings for groonga that provides full text search and
+column store features.
+
+Ruby/groonga is a extension library to use groonga's DB-API
+layer. Ruby/groonga provides Rubyish readable and writable
+API. You can use groonga's first and highly functional
+features from Ruby.
+
+See the following URL about groonga.
+
+* groonga: http://groonga.org/
+
+== Author
+
+Kouhei Sutou <kou@clear-code.com>
+
+== License
+
+LGPL 2.1. See license/LGPL for details.
+
+pkg-config.rb is a library that is bundled with rcairo. It's
+distributed under Ruby license. See license/RUBY and
+license/GPL for details.
+
+== Dependencies
+
+* Ruby >= 1.8 (including 1.9.1)
+* groonga >= 0.0.4
+
+== Install
+
+  % sudo gem install groonga
+
+== Documents
+
+Japanese only. Sorry.
+
+http://groonga.rubyforge.org/groonga/
+
+== Mailing list
+
+http://rubyforge.org/mailman/listinfo/groonga-users-en
+
+== Thanks
+
+* ...

data/Rakefile

@@ -0,0 +1,209 @@
+# -*- coding: utf-8; mode: ruby -*-
+#
+# Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 2.1 as published by the Free Software Foundation.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require 'English'
+
+require 'find'
+require 'fileutils'
+require 'pathname'
+require 'erb'
+require 'rubygems'
+gem 'rdoc'
+require 'hoe'
+
+ENV["NODOT"] = "yes"
+
+Hoe::SUPPORTED_TEST_FRAMEWORKS[:testunit2] = "test/run-test.rb"
+
+base_dir = File.join(File.dirname(__FILE__))
+truncate_base_dir = Proc.new do |x|
+  x.gsub(/^#{Regexp.escape(base_dir + File::SEPARATOR)}/, '')
+end
+
+groonga_ext_dir = File.join(base_dir, 'ext')
+groonga_lib_dir = File.join(base_dir, 'lib')
+$LOAD_PATH.unshift(groonga_ext_dir)
+$LOAD_PATH.unshift(groonga_lib_dir)
+ENV["RUBYLIB"] = "#{groonga_lib_dir}:#{groonga_ext_dir}:#{ENV['RUBYLIB']}"
+
+def guess_version
+  require 'groonga'
+  Groonga.bindings_version
+end
+
+groonga_win32_dir = "groonga"
+FileUtils.rm_rf(groonga_win32_dir)
+
+manifest = File.join(base_dir, "Manifest.txt")
+manifest_contents = []
+base_dir_included_components = %w(AUTHORS Rakefile
+                                  README.rdoc README.ja.rdoc
+                                  NEWS.rdoc NEWS.ja.rdoc
+                                  TUTORIAL.ja.rdoc
+                                  extconf.rb pkg-config.rb)
+excluded_components = %w(.cvsignore .gdb_history CVS depend Makefile pkg
+                         .svn .git doc vendor .test-result)
+excluded_suffixes = %w(.png .ps .pdf .o .so .a .txt .~)
+Find.find(base_dir) do |target|
+  target = truncate_base_dir[target]
+  components = target.split(File::SEPARATOR)
+  if components.size == 1 and !File.directory?(target)
+    next unless base_dir_included_components.include?(components[0])
+  end
+  Find.prune if (excluded_components - components) != excluded_components
+  next if excluded_suffixes.include?(File.extname(target))
+  manifest_contents << target if File.file?(target)
+end
+
+File.open(manifest, "w") do |f|
+  f.puts manifest_contents.sort.join("\n")
+end
+
+# For Hoe's no user friendly default behavior. :<
+File.open("README.txt", "w") {|file| file << "= Dummy README\n== XXX\n"}
+FileUtils.cp("NEWS.rdoc", "History.txt")
+at_exit do
+  FileUtils.rm_f("README.txt")
+  FileUtils.rm_f("History.txt")
+  FileUtils.rm_f(manifest)
+end
+
+def cleanup_white_space(entry)
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+ENV["VERSION"] ||= guess_version
+version = ENV["VERSION"]
+project = Hoe.new('groonga', version) do |project|
+  project.rubyforge_name = 'groonga'
+  authors = File.join(base_dir, "AUTHORS")
+  project.author = File.readlines(authors).collect do |line|
+    if /\s*<[^<>]*>$/ =~ line
+      $PREMATCH
+    else
+      nil
+    end
+  end.compact
+  project.email = ['groonga-users-en@rubyforge.org',
+                   'groonga-dev@lists.sourceforge.jp']
+  project.url = 'http://groonga.rubyforge.org/'
+  project.testlib = :testunit2
+  project.test_globs = ["test/run-test.rb"]
+  project.spec_extras = {
+    :extensions => ['extconf.rb'],
+    :require_paths => ["lib", "ext"],
+    :extra_rdoc_files => Dir.glob("*.rdoc"),
+  }
+  project.readme_file = "README.ja.rdoc"
+
+  news_of_current_release = File.read("NEWS.rdoc").split(/^==\s.*$/)[1]
+  project.changes = cleanup_white_space(news_of_current_release)
+
+  entries = File.read("README.rdoc").split(/^==\s(.*)$/)
+  description = cleanup_white_space(entries[entries.index("Description") + 1])
+  project.summary, project.description, = description.split(/\n\n+/, 3)
+
+  project.need_tar = false
+  project.remote_rdoc_dir = "groonga"
+end
+
+project.spec.dependencies.delete_if {|dependency| dependency.name == "hoe"}
+
+if /mswin32/ =~ project.spec.platform.to_s
+  project.spec.extensions = []
+  project.spec.files += ["ext/groonga.so", "ext/libruby-groonga.a"]
+
+  FileUtils.cp_r(File.expand_path("~/.wine/drive_c/groonga-dev"),
+                 groonga_win32_dir)
+  groonga_files = []
+  Find.find(groonga_win32_dir) do |f|
+    groonga_files << f
+  end
+  project.spec.files += groonga_files
+end
+
+ObjectSpace.each_object(Rake::RDocTask) do |rdoc_task|
+  t_option_index = rdoc_task.options.index("-t")
+  rdoc_task.options[t_option_index, 2] = nil
+  rdoc_task.title = "Ruby/groonga - #{version}"
+
+  rdoc_task.rdoc_files = ["ext/rb-groonga.c"] + Dir.glob("ext/rb-grn-*.c")
+  rdoc_task.rdoc_files += Dir.glob("lib/*.rb")
+  rdoc_task.rdoc_files += Dir.glob("*.rdoc")
+end
+
+task :publish_docs => [:prepare_docs_for_publishing]
+
+
+include ERB::Util
+
+def apply_template(file, head, header, footer)
+  content = File.read(file)
+  content = content.sub(/lang="en"/, 'lang="ja"')
+
+  title = nil
+  content = content.sub(/<title>(.+?)<\/title>/) do
+    title = $1
+    head.result(binding)
+  end
+
+  content = content.sub(/<body(?:.*?)>/) do |body_start|
+    "#{body_start}\n#{header.result(binding)}\n"
+  end
+
+  content = content.sub(/<\/body/) do |body_end|
+    "\n#{footer.result(binding)}\n#{body_end}"
+  end
+
+  File.open(file, "w") do |file|
+    file.print(content)
+  end
+end
+
+def erb_template(name)
+  file = File.join("html", "#{name}.html.erb")
+  template = File.read(file)
+  erb = ERB.new(template, nil, "-")
+  erb.filename = file
+  erb
+end
+
+task :prepare_docs_for_publishing do
+  head = erb_template("head")
+  header = erb_template("header")
+  footer = erb_template("footer")
+  Find.find("doc") do |file|
+    if /\.html\z/ =~ file and /_(?:c|rb)\.html\z/ !~ file
+      apply_template(file, head, header, footer)
+    end
+  end
+end
+
+task :publish_html do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+
+  rsync_args = "-av --exclude '*.erb' --exclude '*.svg' --exclude .svn"
+  remote_dir = "/var/www/gforge-projects/#{project.rubyforge_name}/"
+  sh "rsync #{rsync_args} html/ #{host}:#{remote_dir}"
+end
+
+# fix Hoe's incorrect guess.
+project.spec.executables.clear
+# project.lib_files = project.spec.files.grep(%r|^src/lib/|)
+
+task(:release).prerequisites.reject! {|name| name == "clean"}

data/TUTORIAL.ja.rdoc

@@ -0,0 +1,160 @@
+= チュートリアル
+
+このページでは簡単なアプリケーションの作成を通して
+Ruby/groongaの新しいSennaの操作方法を紹介します。
+
+== インストール
+
+Ruby/groongaはRubyGemsでインストールできます。
+
+  % sudo gem install groonga
+
+== データベースの作成
+
+簡単なブックマークアプリケーション用のデータベースを作ってみ
+ます。以下のようにgroongaライブラリを読み込んでirbを起動しま
+す。
+
+  % irb --simple-prompt -rubygems -rgroonga
+  >>
+
+まず、エンコーディングを設定します。ここではUTF-8を利用します。
+
+  >> $KCODE = "UTF-8"
+  => "UTF-8"
+  >> Groonga::Context.default_options = {:encoding => :utf8}
+  => {:encoding=>:utf8}
+
+それでは、ファイルを指定してデータベースを作成します。
+
+  >> Groonga::Database.create(:path => "/tmp/bookmark.db")
+  => #<Groonga::Database id: <nil>, name: (anonymous), path: </tmp/bookmark.db>, domain: <nil>, range: <nil>>
+
+ここで作成したデータベースは、これ以降、暗黙のうちに利用され
+ます。最初にデータベースを作成したら特に意識する必要はありま
+せん。
+
+== テーブルの定義
+
+groongaには以下の3種類のテーブルがあります。
+
+[Groonga::Hash]
+  ハッシュテーブル。主キーでレコードを管理します。キーと完全
+  一致するレコードを非常に高速に検索することができます。
+[Groonga::PatriciaTrie]
+  パトリシアトライ。ハッシュテーブルに比べて完全一致検索の速
+  度がやや遅いですが、前方一致検索・共通接頭辞探索などの検索
+  が行えます。またカーソルを用いてキーの昇降順にレコードを取
+  り出すことができます。
+[Groonga::Array]
+  配列。主キーの存在しないテーブルです。レコードはIDによって
+  識別します。
+
+ここではハッシュテーブルを利用して、+<items>+という名前のテー
+ブルを作成します。
+
+  >> items = Groonga::Hash.create(:name => "<items>", :persistent => true)
+  => #<Groonga::Hash id: <18>, name: <<items>>, path: </tmp/bookmark.db.0000012>, domain: <nil>, range: <nil>, encoding: <:utf8>, size: <0>>
+
+
+これで+<items>+という名前のテーブルが作成できました。
+
+テーブルはRubyのHashのように扱えます。
+
+例えば、以下のように+size+でテーブルに登録されているレコード
+の件数を取得できます。
+
+  >> items.size
+  0
+
+== レコードを追加する
+
+items>テーブルにレコードを追加します。
+
+  >> items.add("http://ja.wikipedia.org/wiki/Ruby")
+  => #<Groonga::Record:0x7f0ece6aeaf8 @table=#<Groonga::Hash id: <18>, name: <<items>>, path: </tmp/bookmark.db.0000012>, domain: <nil>, range: <nil>, encoding: <:utf8>, size: <1>>, @id=1>
+  >> items.add("http://www.ruby-lang.org/")
+  => #<Groonga::Record:0x7f0ece6a9fa8 @table=#<Groonga::Hash id: <18>, name: <<items>>, path: </tmp/bookmark.db.0000012>, domain: <nil>, range: <nil>, encoding: <:utf8>, size: <2>>, @id=2>
+
+件数を確認すると確かに2件増えています。
+
+  >> items.size
+  => 2
+
+主キーを指定してレコードを取り出す時には以下のようにします。
+
+  >> items["http://ja.wikipedia.org/wiki/Ruby"]
+  => #<Groonga::Record:0x7f0ece699ab8 @table=#<Groonga::Hash id: <18>, name: <<items>>, path: </tmp/bookmark.db.0000012>, domain: <nil>, range: <nil>, encoding: <:utf8>, size: <2>>, @id=1>
+
+== 全文検索を行う
+
+各itemのタイトル文字列を登録して、全文検索できるようにしてみ
+ましょう。
+
+まず+<items>+テーブルに+title+という名前のカラムを追加します。
+
+  >> title_colum = items.define_column("title", "<text>")
+  => #<Groonga::VarSizeColumn id: <19>, name: <<items>.title>, path: (temporary), domain: <#<Groonga::Hash id: <18>, name: <<items>>, path: </tmp/bookmark.db.0000012>, domain: <nil>, range: <nil>, encoding: <:utf8>, size: <2>>>, range: <#<Groonga::Type id: <7>, name: <<text>>, path: (temporary), domain: <nil>, range: <65536>>>>
+
+2番目の引数は、追加するカラムのデータ型を示しています。
++<int>+、+<text>+、+<longtext>+等の型が基本型として用意されて
+います。
+
+全文検索するためには、文字列を分解して得られる各単語を格納す
+るためのテーブルを別途しなければなりません。ここでは<terms>と
+いう名前でテーブルを定義します。
+
+  >> terms = Groonga::Hash.create(:name => "<terms>",
+                                  :key_type => "<shorttext>",
+                                  :persistent => true)
+  => #<Groonga::Hash id: <21>, name: <<terms>>, path: </tmp/bookmark.db.0000015>, domain: <#<Groonga::Type id: <6>, name: <<shorttext>>, path: (temporary), domain: <nil>, range: <4096>>>, range: <nil>, encoding: <:utf8>, size: <0>>
+
++<items>+テーブルの+title+カラムに対するインデックスを定義し
+ます。
+
+  >> title_index_column = terms.define_column("item_title", items,
+                                              :type => "index",
+                                              :with_position => true)
+  => #<Groonga::IndexColumn id: <22>, name: <<terms>.item_title>, path: (temporary), domain: <#<Groonga::Hash id: <21>, name: <<terms>>, path: </tmp/bookmark.db.0000015>, domain: <#<Groonga::Type id: <6>, name: <<shorttext>>, path: (temporary), domain: <nil>, range: <4096>>>, range: <nil>, encoding: <:utf8>, size: <0>>>, range: <#<Groonga::Hash id: <18>, name: <<items>>, path: </tmp/bookmark.db.0000012>, domain: <nil>, range: <nil>, encoding: <:utf8>, size: <2>>>>
+
+インデックス用カラムに、検索対象の+<items>+テーブルの+title+
+カラムを設定します。
+
+  >> title_index_column.source = title_column
+  => #<Groonga::VarSizeColumn id: <19>, name: <<items>.title>, path: (temporary), domain: <#<Groonga::Hash id: <18>, name: <<items>>, path: </tmp/bookmark.db.0000012>, domain: <nil>, range: <nil>, encoding: <:utf8>, size: <2>>>, range: <#<Groonga::Type id: <7>, name: <<text>>, path: (temporary), domain: <nil>, range: <65536>>>>
+
+少し違和感を感じるかも知れませんが、+<items>+テーブルのカラムに
+対するインデックスは、 +<terms>+テーブルのカラムとして定義しま
+す。
+
++<items>+にレコードが登録されると、その中に含まれる単語に該当
+するレコードが+<terms>+に自動的に追加されるようになります。
+
++<terms>+は、文書に含まれる語彙に相当する、やや特殊なテーブル
+だと言えます。しかし、他のテーブルと同様に語彙テーブルには自
+由にカラムを追加し、単語毎の様々な属性を管理することができま
+す。これはある種の検索処理を行う際には非常に便利に機能します。
+
+これでテーブルの定義は完了です。
+
+先ほど登録した各レコードの+title+カラムに値をセットします。
+
+  >> items["http://ja.wikipedia.org/wiki/Ruby"]["title"] = "Ruby"
+  => "Ruby"
+  >> items["http://www.ruby-lang.org/"]["title"] = "オブジェクトスクリプト言語Ruby"
+  "オブジェクトスクリプト言語Ruby"
+
+以下のようにして検索することができます。
+
+  >> title_index_column.saerch("Ruby").collect {|record| record.key.key}
+  ["http://ja.wikipedia.org/wiki/Ruby", "http://www.ruby-lang.org/"]
+
+検索結果はGroonga::Hashで返されます。ハッシュのキーに見つかっ
+た+<items>+のレコードが入っています。上の例ではrecord.keyで
++<items>+のレコードを取得して、さらにそのキーを指定して
+（record.key.key）で+<items>+のキーを返しています。
+
+
+== マルチユーザ向けのブックマークアプリケーション
+
+つづく。。。