rroonga 1.1.0 → 1.2.0

data/NEWS.ja.rdoc

@@ -1,5 +1,23 @@
 = お知らせ
 
+== 1.2.0: 2011-04-01
+
+=== 改良
+
+* groonga 1.2.0対応。
+* Groonga::Accessor#local_nameを追加。
+* Groonga::IndexColumn#with_section?を追加。
+* Groonga::IndexColumn#with_weight?を追加。
+* Groonga::IndexColumn#with_position?を追加。
+* Groonga::Schema.dumpがgroongaコマンド形式でのダンプに対応。
+* grndumpを追加。
+* Groonga::Database#eachで繰り返す順序を指定可能にした。
+* Groonga::Context#match_escalation_thresholdを追加。
+* Groonga::Context#match_escalation_threshold=を追加。
+* エラーメッセージの改良。
+* Groonga::Schemaの型指定で"ShortText"など正式型名だけではなく、
+  :short_textなどよりRubyらしい名前を使えるようにした。
+
 == 1.1.0: 2011-02-09
 
 === 改良

data/NEWS.rdoc

@@ -1,5 +1,23 @@
 = NEWS
 
+== 1.2.0: 2011-04-01
+
+=== Improvements
+
+* Supported groonga 1.2.0.
+* Added Groonga::Accessor#local_name.
+* Added Groonga::IndexColumn#with_section?.
+* Added Groonga::IndexColumn#with_weight?.
+* Added Groonga::IndexColumn#with_position?.
+* Groonga::Schema.dump supported groonga command format dump.
+* Added grndump command.
+* Groonga::Database#each supports order customize.
+* Added Groonga::Context#match_escalation_threshold.
+* Added Groonga::Context#match_escalation_threshold=.
+* Improved error message.
+* Supported Rubyish name like :short_text instead of the
+  official type name like "ShortText" in Groonga::Schema.
+
 == 1.1.0: 2011-02-09
 
 === Improvements

data/bin/grndump

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  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 'ostruct'
+require 'optparse'
+require 'pathname'
+
+require 'groonga'
+
+options = OpenStruct.new
+options.tables = []
+options.dump_schema = true
+options.dump_tables = true
+option_parser = OptionParser.new do |parser|
+  parser.banner += " DB_PATH"
+
+  parser.on("--no-dump-schema",
+            "don't dump schema.") do |boolean|
+    options.dump_schema = boolean
+  end
+
+  parser.on("--no-dump-tables",
+            "don't dump tables.") do |boolean|
+    options.dump_tables = boolean
+  end
+
+  parser.on("-t=TABLE", "--table=TABLE",
+            "dump only TABLE.",
+            "use this option multiple to dump multiple tables.",
+            "use /.../ as TABLE to match table name with regexp.") do |table|
+    case table
+    when /\A\/(.*)\/(i)?\z/
+      options.tables << Regexp.new($1, $2 == "i")
+    when
+      options.tables << table
+    end
+  end
+end
+args = option_parser.parse!(ARGV)
+
+if args.size != 1
+  puts(option_parser)
+  exit(false)
+end
+db_path = args[0]
+
+database = Groonga::Database.open(db_path)
+dumper_options = {
+  :database => database,
+  :output => STDOUT,
+  :dump_schema => options.dump_schema,
+  :dump_tables => options.dump_tables,
+  :tables => options.tables,
+}
+database_dumper = Groonga::DatabaseDumper.new(dumper_options)
+database_dumper.dump

data/ext/groonga/rb-grn-accessor.c

@@ -18,7 +18,7 @@
 
 #include "rb-grn.h"
 
-#define SELF(object) (RVAL2GRNACCESSOR(object))
+#define SELF(object) ((RbGrnAccessor *)DATA_PTR(object))
 
 VALUE rb_cGrnAccessor;
 
@@ -39,6 +39,66 @@ rb_grn_accessor_to_ruby_object (grn_ctx *context, grn_obj *table,
     return GRNOBJECT2RVAL(rb_cGrnAccessor, context, table, owner);
 }
 
+void
+rb_grn_accessor_bind (RbGrnAccessor *rb_accessor,
+		      grn_ctx *context, grn_obj *accessor)
+{
+    RbGrnObject *rb_grn_object;
+    RbGrnNamedObject *rb_grn_named_object;
+    char name[GRN_TABLE_MAX_KEY_SIZE];
+    int name_size;
+
+    rb_grn_object = RB_GRN_OBJECT(rb_accessor);
+    rb_grn_named_object = RB_GRN_NAMED_OBJECT(rb_accessor);
+    rb_grn_named_object_bind(rb_grn_named_object, context, accessor);
+
+    name_size = grn_column_name(context, accessor, name, sizeof(name));
+    if (name_size > 0) {
+	rb_grn_named_object_set_name(rb_grn_named_object, name, name_size);
+    }
+
+    rb_accessor->value = grn_obj_open(context, GRN_BULK, 0,
+				      rb_grn_object->range_id);
+}
+
+
+void
+rb_grn_accessor_finalizer (grn_ctx *context, grn_obj *grn_object,
+			   RbGrnAccessor *rb_accessor)
+{
+    rb_grn_named_object_finalizer(context, grn_object,
+				  RB_GRN_NAMED_OBJECT(rb_accessor));
+    if (context && rb_accessor->value)
+	grn_obj_unlink(context, rb_accessor->value);
+    rb_accessor->value = NULL;
+}
+
+/*
+ * call-seq:
+ *   accessor.local_name
+ *
+ * アクセサ名を返す。
+ *
+ *   items = Groonga::Array.create(:name => "Items")
+ *   id = items.column("_id")
+ *   id.name # => nil
+ *   id.local_name # => "_id"
+ */
+static VALUE
+rb_grn_accessor_get_local_name (VALUE self)
+{
+    RbGrnAccessor *rb_grn_accessor;
+    RbGrnNamedObject *rb_grn_named_object;
+
+    rb_grn_accessor = SELF(self);
+    rb_grn_named_object = RB_GRN_NAMED_OBJECT(rb_grn_accessor);
+    if (rb_grn_named_object->name_size == 0)
+	return Qnil;
+
+    return rb_str_new(rb_grn_named_object->name,
+		      rb_grn_named_object->name_size);
+}
+
 /*
  * Document-class: Groonga::Accessor < Groonga::Object
  *
@@ -49,4 +109,7 @@ void
 rb_grn_init_accessor (VALUE mGrn)
 {
     rb_cGrnAccessor = rb_define_class_under(mGrn, "Accessor", rb_cGrnObject);
+
+    rb_define_method(rb_cGrnAccessor, "local_name",
+		     rb_grn_accessor_get_local_name, 0);
 }

data/ext/groonga/rb-grn-context.c

@@ -1,6 +1,6 @@
 /* -*- c-file-style: "ruby" -*- */
 /*
-  Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+  Copyright (C) 2010-2011  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
@@ -422,6 +422,41 @@ rb_grn_context_set_encoding (VALUE self, VALUE rb_encoding)
     return rb_encoding;
 }
 
+/*
+ * call-seq:
+ *   context.match_escalation_threshold -> Integer
+ *
+ * このコンテキストを使って検索したときに検索の挙動をエスカレー
+ * ションする閾値を返します。エスカレーションの詳細はgroonga
+ * の検索の仕様に関するドキュメントを参照してください。
+ * http://groonga.org/docs/spec/search.html#spec-search
+ */
+static VALUE
+rb_grn_context_get_match_escalation_threshold (VALUE self)
+{
+    return LL2NUM(grn_ctx_get_match_escalation_threshold(SELF(self)));
+}
+
+/*
+ * call-seq:
+ *   context.match_escalation_threshold=(match_escalation_threshold)
+ *
+ * このコンテキストを使って検索したときに検索の挙動をエスカレー
+ * ションする閾値を設定します。エスカレーションの詳細はgroonga
+ * の検索の仕様に関するドキュメントを参照してください。
+ * http://groonga.org/docs/spec/search.html#spec-search
+ */
+static VALUE
+rb_grn_context_set_match_escalation_threshold (VALUE self, VALUE threshold)
+{
+    grn_ctx *context;
+
+    context = SELF(self);
+    grn_ctx_set_match_escalation_threshold(context, NUM2LL(threshold));
+
+    return threshold;
+}
+
 /*
  * call-seq:
  *   context.support_zlib?
@@ -732,6 +767,10 @@ rb_grn_init_context (VALUE mGrn)
 
     rb_define_method(cGrnContext, "encoding", rb_grn_context_get_encoding, 0);
     rb_define_method(cGrnContext, "encoding=", rb_grn_context_set_encoding, 1);
+    rb_define_method(cGrnContext, "match_escalation_threshold",
+		     rb_grn_context_get_match_escalation_threshold, 0);
+    rb_define_method(cGrnContext, "match_escalation_threshold=",
+		     rb_grn_context_set_match_escalation_threshold, 1);
 
     rb_define_method(cGrnContext, "support_zlib?",
 		     rb_grn_context_support_zlib_p, 0);

data/ext/groonga/rb-grn-database.c

@@ -1,6 +1,6 @@
 /* -*- c-file-style: "ruby" -*- */
 /*
-  Copyright (C) 2009-2010  Kouhei Sutou <kou@clear-code.com>
+  Copyright (C) 2009-2011  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
@@ -287,27 +287,69 @@ rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
 /*
  * call-seq:
  *   database.each {|object| ...}
+ *   database.each(options=nil) {|object| ...}
  *
  * データベース内のオブジェクトを順番にブロックに渡す。
  *
+ * _options_にはハッシュでオプションを指定する。指定できるオ
+ * プションは以下の通り。
+ *
+ * [+:order+]
+ *   +:asc+または+:ascending+を指定すると昇順にレコードを取
+ *   り出す。（デフォルト）
+ *
+ *   +:desc+または+:descending+を指定すると降順にレコードを
+ *   取り出す。
+ *
+ * [+:order_by+]
+ *   +:id+を指定するとID順にレコードを取り出す。
+ *
+ *   +:key+指定するとキー順にレコードを取り出す。（デフォル
+ *   ト）
+ *
  * すべてのオブジェクトの名前を表示する:
  *   database.each do |object|
  *     p object.name
  *   end
+ *
+ * すべてのオブジェクトの名前をID順で表示する:
+ *   database.each(:order_by => :id) do |object|
+ *     p object.name
+ *   end
+ *
+ * すべてのオブジェクトの名前をキー名の降順で表示する:
+ *   database.each(:order_by => :key, :order => :desc) do |object|
+ *     p object.name
+ *   end
  */
 static VALUE
-rb_grn_database_each (VALUE self)
+rb_grn_database_each (int argc, VALUE *argv, VALUE self)
 {
     grn_ctx *context = NULL;
     grn_obj *database;
     grn_table_cursor *cursor;
-    VALUE rb_cursor;
+    VALUE rb_cursor, rb_options, rb_order, rb_order_by;
+    int flags = 0;
     grn_id id;
 
     rb_grn_database_deconstruct(SELF(self), &database, &context,
 				NULL, NULL, NULL, NULL);
+
+    rb_scan_args(argc, argv, "01", &rb_options);
+
+    rb_grn_scan_options(rb_options,
+			"order", &rb_order,
+			"order_by", &rb_order_by,
+			NULL);
+
+    flags |= rb_grn_table_cursor_order_to_flag(rb_order);
+    flags |= rb_grn_table_cursor_order_by_to_flag(GRN_TABLE_PAT_KEY,
+						  self,
+						  rb_order_by);
+
     cursor = grn_table_cursor_open(context, database, NULL, 0, NULL, 0,
-				   0, -1, GRN_CURSOR_ASCENDING);
+				   0, -1,
+				   flags);
     rb_cursor = GRNTABLECURSOR2RVAL(Qnil, context, cursor);
     rb_iv_set(self, "cursor", rb_cursor);
     while ((id = grn_table_cursor_next(context, cursor)) != GRN_ID_NIL) {
@@ -480,7 +522,7 @@ rb_grn_init_database (VALUE mGrn)
 		     rb_grn_database_initialize, -1);
 
     rb_define_method(rb_cGrnDatabase, "each",
-		     rb_grn_database_each, 0);
+		     rb_grn_database_each, -1);
 
     rb_define_method(rb_cGrnDatabase, "close",
 		     rb_grn_database_close, 0);

data/ext/groonga/rb-grn-index-column.c

@@ -400,26 +400,26 @@ rb_grn_index_column_set_source (VALUE self, VALUE rb_source)
  *
  * 利用可能なオプションは以下の通り。
  *
- * [_:result_]
+ * [+:result+]
  *   結果を格納するGroonga::Hash。指定しない場合は新しく
  *   Groonga::Hashを生成し、それに結果を格納して返す。
- * [_:operator_]
+ * [+:operator+]
  *   以下のどれかの値を指定する。+nil+, <tt>"or"</tt>, <tt>"||"</tt>,
  *   <tt>"and"</tt>, <tt>"+"</tt>, <tt>"&&"</tt>, <tt>"but"</tt>,
  *   <tt>"not"</tt>, <tt>"-"</tt>, <tt>"adjust"</tt>, <tt>">"</tt>。
  *   それぞれ以下のようになる。（FIXME: 「以下」）
- * [_:exact_]
+ * [+:exact+]
  *   +true+を指定すると完全一致で検索する
- * [_:longest_common_prefix_]
+ * [+:longest_common_prefix+]
  *   +true+を指定すると_query_と同じ接頭辞をもつエントリのう
  *   ち、もっとも長いエントリを検索する
- * [_:suffix_]
+ * [+:suffix+]
  *   +true+を指定すると_query_が後方一致するエントリを検索す
  *   る
- * [_:prefix_]
+ * [+:prefix+]
  *   +true+を指定すると_query_が前方一致するレコードを検索す
  *   る
- * [_:near_]
+ * [+:near+]
  *   +true+を指定すると_query_に指定した複数の語が近傍に含ま
  *   れるレコードを検索する
  * [...]
@@ -483,6 +483,69 @@ rb_grn_index_column_search (int argc, VALUE *argv, VALUE self)
     return rb_result;
 }
 
+/*
+ * Document-method: with_section?
+ *
+ * call-seq:
+ *   column.with_section? -> true/false
+ *
+ * _column_が段落情報も格納する場合は+true+を返します。
+ */
+static VALUE
+rb_grn_index_column_with_section_p (VALUE self)
+{
+    grn_obj *column;
+
+    rb_grn_index_column_deconstruct(SELF(self), &column, NULL,
+				    NULL, NULL,
+				    NULL, NULL, NULL, NULL,
+				    NULL, NULL);
+
+    return CBOOL2RVAL(column->header.flags & GRN_OBJ_WITH_SECTION);
+}
+
+/*
+ * Document-method: with_weight?
+ *
+ * call-seq:
+ *   column.with_weight? -> true/false
+ *
+ * _column_がウェイト情報も格納する場合は+true+を返します。
+ */
+static VALUE
+rb_grn_index_column_with_weight_p (VALUE self)
+{
+    grn_obj *column;
+
+    rb_grn_index_column_deconstruct(SELF(self), &column, NULL,
+				    NULL, NULL,
+				    NULL, NULL, NULL, NULL,
+				    NULL, NULL);
+
+    return CBOOL2RVAL(column->header.flags & GRN_OBJ_WITH_WEIGHT);
+}
+
+/*
+ * Document-method: with_position?
+ *
+ * call-seq:
+ *   column.with_position? -> true/false
+ *
+ * _column_が位置情報も格納する場合は+true+を返します。
+ */
+static VALUE
+rb_grn_index_column_with_position_p (VALUE self)
+{
+    grn_obj *column;
+
+    rb_grn_index_column_deconstruct(SELF(self), &column, NULL,
+				    NULL, NULL,
+				    NULL, NULL, NULL, NULL,
+				    NULL, NULL);
+
+    return CBOOL2RVAL(column->header.flags & GRN_OBJ_WITH_POSITION);
+}
+
 void
 rb_grn_init_index_column (VALUE mGrn)
 {
@@ -501,4 +564,11 @@ rb_grn_init_index_column (VALUE mGrn)
 
     rb_define_method(rb_cGrnIndexColumn, "search",
 		     rb_grn_index_column_search, -1);
+
+    rb_define_method(rb_cGrnIndexColumn, "with_section?",
+		     rb_grn_index_column_with_section_p, 0);
+    rb_define_method(rb_cGrnIndexColumn, "with_weight?",
+		     rb_grn_index_column_with_weight_p, 0);
+    rb_define_method(rb_cGrnIndexColumn, "with_position?",
+		     rb_grn_index_column_with_position_p, 0);
 }