rroonga 0.9.5 → 1.0.0

data/NEWS.ja.rdoc

@@ -1,5 +1,18 @@
 = お知らせ
 
+== 1.0.0: 2010-08-29
+
+* groonga 1.0.0対応。
+  * Groonga::CASErrorを追加。
+  * Groonga::Table#open_cursorに:order_byオプションを追加。
+  * 前方一致検索がマッチしたレコードを順に取り出すカーソルを作る
+    Groonga::PatriciaTrie#open_prefix_cursorを追加。
+  * ローマ字・ひらがなでカタカナのキーを検索するカーソルを作る
+    Groonga::PatriciaTrie#open_rk_cursorを追加。
+  * 値の近い順にレコードを取り出すカーソルを作る
+    Groonga::PatriciaTrie#open_near_cursorを追加。
+* インデックスのソースに_keyを指定できるようになった。
+
 == 0.9.5: 2010-07-29
 
 * groonga 0.7.4対応。

data/NEWS.rdoc

@@ -1,5 +1,18 @@
 = NEWS
 
+== 1.0.0: 2010-08-29
+
+* Supported groonga 1.0.0.
+  * Added Groonga::CASError.
+  * Added :order_by option to Groonga::Table#open_cursor.
+  * Added Groonga::PatriciaTrie#open_prefix_cursor that creates a cursor
+    to retrieve each records by prefix search.
+  * Added Groonga::PatriciaTrie#open_rk_cursor that creats a cursor to
+    retrieve katakana keys from roman letters and/or hiragana.
+  * Added Groonga::PatriciaTrie#open_near_cursor that creates a cursor to
+    retrieve records order by distance from key.
+* Supported _key as index source.
+
 == 0.9.5: 2010-07-20
 
 * Supported groonga 0.7.4.

data/README.ja.rdoc

@@ -35,8 +35,8 @@ pkg-config.rbはrcairoに付属しているもので、これはRubyライセ
 
 == 依存ソフトウェア
 
-* Ruby >= 1.8 （1.9.1対応）
-* groonga >= 0.1.9
+* Ruby >= 1.8 （1.9.1, 1.9.2対応）
+* groonga >= 1.0.0
 
 == インストール
 

data/README.rdoc

@@ -36,8 +36,8 @@ license/GPL for details.
 
 == Dependencies
 
-* Ruby >= 1.8 (including 1.9.1)
-* groonga >= 0.1.9
+* Ruby >= 1.8 (including 1.9.1 and 1.9.2)
+* groonga >= 1.0.0
 
 == Install
 

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

@@ -92,6 +92,7 @@ static VALUE eGrnUpdateNotAllowed;
 static VALUE eGrnTooSmallOffset;
 static VALUE eGrnTooLargeOffset;
 static VALUE eGrnTooSmallLimit;
+static VALUE eGrnCASError;
 
 VALUE
 rb_grn_rc_to_exception (grn_rc rc)
@@ -312,6 +313,9 @@ rb_grn_rc_to_exception (grn_rc rc)
       case GRN_TOO_SMALL_LIMIT:
         exception = eGrnTooSmallLimit;
         break;
+      case GRN_CAS_ERROR:
+        exception = eGrnCASError;
+        break;
     }
 
     if (NIL_P(exception))
@@ -539,6 +543,9 @@ rb_grn_rc_to_message (grn_rc rc)
       case GRN_TOO_SMALL_LIMIT:
         message = "too small limit";
         break;
+      case GRN_CAS_ERROR:
+        message = "CAS error";
+        break;
     }
 
     if (!message)
@@ -1152,4 +1159,11 @@ rb_grn_init_exception (VALUE mGrn)
      */
     eGrnTooSmallLimit =
         rb_define_class_under(mGrn, "TooSmallLimit", rb_eGrnError);
+
+    /*
+     * Document-class: Groonga::CASError
+     *
+     * CAS（Compare and Swap）が失敗したときに発生する。
+     */
+    eGrnCASError = rb_define_class_under(mGrn, "CASError", rb_eGrnError);
 }

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

@@ -307,7 +307,19 @@ resolve_source_id (grn_ctx *context, grn_obj *column, VALUE rb_source)
 	    source = RVAL2GRNOBJECT(rb_source, &context);
 	}
 	rb_grn_context_check(context, rb_source);
-	source_id = grn_obj_id(context, source);
+	if (source->header.type == GRN_ACCESSOR) {
+	    char name[256];
+	    int length;
+	    length = grn_column_name(context, source, name, sizeof(name));
+	    name[length] = '\0';
+	    if (strcmp(name, "_key") != 0) {
+		rb_raise(rb_eArgError,
+			 "source accessor must be '_key': <%s>", name);
+	    }
+	    source_id = grn_obj_id(context, column);
+	} else {
+	    source_id = grn_obj_id(context, source);
+	}
     }
 
     return source_id;

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

@@ -766,8 +766,8 @@ rb_grn_object_inspect_content_flags_with_label (VALUE inspected,
 	rb_ary_push(inspected_flags, rb_str_new2("WITH_WEIGHT"));
     if (flags & GRN_OBJ_WITH_POSITION)
 	rb_ary_push(inspected_flags, rb_str_new2("WITH_POSITION"));
-    if (flags & GRN_OBJ_WITH_BUFFER)
-	rb_ary_push(inspected_flags, rb_str_new2("WITH_BUFFER"));
+    if (flags & GRN_OBJ_RING_BUFFER)
+	rb_ary_push(inspected_flags, rb_str_new2("RING_BUFFER"));
 
     if (flags & GRN_OBJ_WITH_SUBREC) {
 	rb_ary_push(inspected_flags, rb_str_new2("WITH_SUBREC"));

data/ext/groonga/rb-grn-patricia-trie.c

@@ -19,6 +19,8 @@
 
 #include "rb-grn.h"
 
+grn_rc grn_obj_cast(grn_ctx *ctx, grn_obj *src, grn_obj *dest, int addp);
+
 #define SELF(object) ((RbGrnTableKeySupport *)DATA_PTR(object))
 
 VALUE rb_cGrnPatriciaTrie;
@@ -488,6 +490,387 @@ rb_grn_patricia_trie_register_key_with_sis_p (VALUE self)
     return CBOOL2RVAL(table->header.flags & GRN_OBJ_KEY_WITH_SIS);
 }
 
+static grn_table_cursor *
+rb_grn_patricia_trie_open_grn_prefix_cursor (int argc, VALUE *argv, VALUE self,
+					     grn_ctx **context)
+{
+    grn_obj *table;
+    grn_table_cursor *cursor;
+    void *prefix = NULL;
+    unsigned prefix_size = 0;
+    int offset = 0, limit = -1;
+    int flags = GRN_CURSOR_PREFIX;
+    VALUE options, rb_prefix, rb_key_bytes, rb_key_bits;
+    VALUE rb_order, rb_order_by;
+    VALUE rb_greater_than, rb_less_than, rb_offset, rb_limit;
+
+    rb_grn_table_deconstruct((RbGrnTable *)SELF(self), &table, context,
+			     NULL, NULL,
+			     NULL, NULL, NULL,
+			     NULL);
+
+    rb_scan_args(argc, argv, "11", &rb_prefix, &options);
+
+    rb_grn_scan_options(options,
+			"key_bytes", &rb_key_bytes,
+                        "key_bites", &rb_key_bits,
+                        "offset", &rb_offset,
+                        "limit", &rb_limit,
+			"order", &rb_order,
+			"order_by", &rb_order_by,
+			"greater_than", &rb_greater_than,
+			"less_than", &rb_less_than,
+			NULL);
+
+    prefix = StringValuePtr(rb_prefix);
+    if (!NIL_P(rb_key_bytes) && !NIL_P(rb_key_bits)) {
+	rb_raise(rb_eArgError,
+		 "should not specify both :key_bytes and :key_bits once: %s",
+		 rb_grn_inspect(rb_ary_new4(argc, argv)));
+    } else if (!NIL_P(rb_key_bytes)) {
+	prefix_size = NUM2UINT(rb_key_bytes);
+    } else if (!NIL_P(rb_key_bits)) {
+	prefix_size = NUM2UINT(rb_key_bits);
+	flags |= GRN_CURSOR_SIZE_BY_BIT;
+    } else {
+	prefix_size = RSTRING_LEN(rb_prefix);
+    }
+    if (!NIL_P(rb_offset))
+	offset = NUM2INT(rb_offset);
+    if (!NIL_P(rb_limit))
+	limit = NUM2INT(rb_limit);
+
+    if (NIL_P(rb_order)) {
+    } else if (rb_grn_equal_option(rb_order, "asc") ||
+	       rb_grn_equal_option(rb_order, "ascending")) {
+	flags |= GRN_CURSOR_ASCENDING;
+    } else if (rb_grn_equal_option(rb_order, "desc") ||
+	       rb_grn_equal_option(rb_order, "descending")) {
+	flags |= GRN_CURSOR_DESCENDING;
+    } else {
+	rb_raise(rb_eArgError,
+		 "order should be one of "
+		 "[:asc, :ascending, :desc, :descending]: %s",
+		 rb_grn_inspect(rb_order));
+    }
+    if (NIL_P(rb_order_by)) {
+    } else if (rb_grn_equal_option(rb_order_by, "id")) {
+	flags |= GRN_CURSOR_BY_ID;
+    } else if (rb_grn_equal_option(rb_order_by, "key")) {
+	if (table->header.type != GRN_TABLE_PAT_KEY) {
+	    rb_raise(rb_eArgError,
+		     "order_by => :key is available "
+		     "only for Groonga::PatriciaTrie: %s",
+		     rb_grn_inspect(self));
+	}
+	flags |= GRN_CURSOR_BY_KEY;
+    } else {
+	rb_raise(rb_eArgError,
+		 "order_by should be one of [:id%s]: %s",
+		 table->header.type == GRN_TABLE_PAT_KEY ? ", :key" : "",
+		 rb_grn_inspect(rb_order_by));
+    }
+
+    if (RVAL2CBOOL(rb_greater_than))
+	flags |= GRN_CURSOR_GT;
+    if (RVAL2CBOOL(rb_less_than))
+	flags |= GRN_CURSOR_LT;
+
+    cursor = grn_table_cursor_open(*context, table,
+				   prefix, prefix_size,
+				   NULL, 0,
+				   offset, limit, flags);
+    rb_grn_context_check(*context, self);
+
+    return cursor;
+}
+
+
+/*
+ * call-seq:
+ *   table.open_prefix_cursor(prefix, options={}) -> Groonga::PatriciaTrieCursor
+ *   table.open_prefix_cursor(prefix, options={}) {|cursor| ... }
+ *
+ * _prefix_に前方一致検索をするカーソルを生成して返す。ブロッ
+ * クを指定すると、そのブロックに生成したカーソルが渡され、ブ
+ * ロックを抜けると自動的にカーソルが破棄される。
+ *
+ * _options_に指定可能な値は以下の通り。
+ *
+ * [+:key_bytes+]
+ *  _prefix_のサイズ（byte）
+ *
+ * [+:key_bits+]
+ *  _prefix_のサイズ（bit）
+ *
+ * [+:offset+]
+ *   該当する範囲のレコードのうち、(0ベースで)_:offset_番目
+ *   からレコードを取り出す。
+ *
+ * [+:limit+]
+ *   該当する範囲のレコードのうち、_:limit_件のみを取り出す。
+ *   省略された場合または-1が指定された場合は、全件が指定され
+ *   たものとみなす。
+ *
+ * [+:order+]
+ *   +:asc+または+:ascending+を指定すると昇順にレコードを取
+ *   り出す。
+ *   +:desc+または+:descending+を指定すると降順にレコードを
+ *   取り出す。
+ *
+ * [+:order_by+]
+ *   +:id+を指定するとID順にレコードを取り出す。（デフォルト）
+ *
+ *   +:key+指定するとキー順にレコードを取り出す。
+ *
+ * [+:greater_than+]
+ *   +true+を指定すると_prefix_で指定した値に一致した[+key+]を
+ *   範囲に含まない。
+ *
+ * [+:less_than+]
+ *   +true+を指定すると_prefix_で指定した値に一致した[+key+]を
+ *   範囲に含まない。
+ */
+static VALUE
+rb_grn_patricia_trie_open_prefix_cursor (int argc, VALUE *argv, VALUE self)
+{
+    grn_ctx *context = NULL;
+    grn_table_cursor *cursor;
+    VALUE rb_cursor;
+
+    cursor = rb_grn_patricia_trie_open_grn_prefix_cursor(argc, argv,
+							 self, &context);
+    rb_cursor = GRNTABLECURSOR2RVAL(Qnil, context, cursor);
+    rb_iv_set(rb_cursor, "@table", self); /* FIXME: cursor should mark table */
+    if (rb_block_given_p())
+	return rb_ensure(rb_yield, rb_cursor, rb_grn_object_close, rb_cursor);
+    else
+	return rb_cursor;
+}
+
+static grn_table_cursor *
+rb_grn_patricia_trie_open_grn_rk_cursor (int argc, VALUE *argv, VALUE self,
+					     grn_ctx **context)
+{
+    grn_obj *table;
+    grn_table_cursor *cursor;
+    void *prefix = NULL;
+    unsigned prefix_size = 0;
+    int offset = 0, limit = -1;
+    int flags = GRN_CURSOR_PREFIX | GRN_CURSOR_RK;
+    VALUE options, rb_prefix, rb_key_bytes, rb_key_bits;
+    VALUE rb_greater_than, rb_less_than, rb_offset, rb_limit;
+
+    rb_grn_table_deconstruct((RbGrnTable *)SELF(self), &table, context,
+			     NULL, NULL,
+			     NULL, NULL, NULL,
+			     NULL);
+
+    rb_scan_args(argc, argv, "11", &rb_prefix, &options);
+
+    rb_grn_scan_options(options,
+			"key_bytes", &rb_key_bytes,
+                        "key_bites", &rb_key_bits,
+                        "offset", &rb_offset,
+                        "limit", &rb_limit,
+			"greater_than", &rb_greater_than,
+			"less_than", &rb_less_than,
+			NULL);
+
+    prefix = StringValuePtr(rb_prefix);
+    if (!NIL_P(rb_key_bytes) && !NIL_P(rb_key_bits)) {
+	rb_raise(rb_eArgError,
+		 "should not specify both :key_bytes and :key_bits once: %s",
+		 rb_grn_inspect(rb_ary_new4(argc, argv)));
+    } else if (!NIL_P(rb_key_bytes)) {
+	prefix_size = NUM2UINT(rb_key_bytes);
+    } else if (!NIL_P(rb_key_bits)) {
+	prefix_size = NUM2UINT(rb_key_bits);
+	flags |= GRN_CURSOR_SIZE_BY_BIT;
+    } else {
+	prefix_size = RSTRING_LEN(rb_prefix);
+    }
+    if (!NIL_P(rb_offset))
+	offset = NUM2INT(rb_offset);
+    if (!NIL_P(rb_limit))
+	limit = NUM2INT(rb_limit);
+
+    if (RVAL2CBOOL(rb_greater_than))
+	flags |= GRN_CURSOR_GT;
+    if (RVAL2CBOOL(rb_less_than))
+	flags |= GRN_CURSOR_LT;
+
+    cursor = grn_table_cursor_open(*context, table,
+				   prefix, prefix_size,
+				   NULL, 0,
+				   offset, limit, flags);
+    rb_grn_context_check(*context, self);
+
+    return cursor;
+}
+
+/*
+ * call-seq:
+ *   table.open_rk_cursor(key, options={}) -> Groonga::PatriciaTrieCursor
+ *   table.open_rk_cursor(key, options={}) {|cursor| ... }
+ *
+ * _table_のキーはカタカナである必要がある。また、エンコーディ
+ * ングはUTF-8である必要がある。ローマ字やひらがなで_key_を指
+ * 定しても、_key_に対応するカタカナのキーを検索するカーソル
+ * を生成して返す。ブロックを指定すると、そのブロックに生成し
+ * たカーソルが渡され、ブロックを抜けると自動的にカーソルが破
+ * 棄される。
+ *
+ * _options_に指定可能な値は以下の通り。
+ *
+ * [+:key_bytes+]
+ *  _key_のサイズ（byte）
+ *
+ * [+:key_bits+]
+ *  _key_のサイズ（bit）（現在は未サポート）
+ *
+ * [+:offset+]
+ *   該当する範囲のレコードのうち、(0ベースで)_:offset_番目
+ *   からレコードを取り出す。
+ *
+ * [+:limit+]
+ *   該当する範囲のレコードのうち、_:limit_件のみを取り出す。
+ *   省略された場合または-1が指定された場合は、全件が指定され
+ *   たものとみなす。
+ *
+ * [+:greater_than+]
+ *   +true+を指定すると_key_で指定した値に一致した[+key+]を
+ *   範囲に含まない。
+ *
+ * [+:less_than+]
+ *   +true+を指定すると_key_で指定した値に一致した[+key+]を
+ *   範囲に含まない。
+ */
+static VALUE
+rb_grn_patricia_trie_open_rk_cursor (int argc, VALUE *argv, VALUE self)
+{
+    grn_ctx *context = NULL;
+    grn_table_cursor *cursor;
+    VALUE rb_cursor;
+
+    cursor = rb_grn_patricia_trie_open_grn_rk_cursor(argc, argv,
+								self, &context);
+    rb_cursor = GRNTABLECURSOR2RVAL(Qnil, context, cursor);
+    rb_iv_set(rb_cursor, "@table", self); /* FIXME: cursor should mark table */
+    if (rb_block_given_p())
+	return rb_ensure(rb_yield, rb_cursor, rb_grn_object_close, rb_cursor);
+    else
+	return rb_cursor;
+}
+
+
+static grn_table_cursor *
+rb_grn_patricia_trie_open_grn_near_cursor (int argc, VALUE *argv, VALUE self,
+					     grn_ctx **context, int flags)
+{
+    grn_obj *table;
+    grn_obj *key_p = NULL, casted_key;
+    grn_table_cursor *cursor;
+    unsigned min_size = 0;
+    int offset = 0, limit = -1;
+    VALUE options, rb_key, rb_min_size;
+    VALUE rb_greater_than, rb_less_than, rb_offset, rb_limit;
+
+    flags |= GRN_CURSOR_PREFIX;
+
+    rb_grn_table_deconstruct((RbGrnTable *)SELF(self), &table, context,
+			     NULL, NULL,
+			     NULL, NULL, NULL,
+			     NULL);
+
+    rb_scan_args(argc, argv, "11", &rb_key, &options);
+
+    rb_grn_scan_options(options,
+			"size", &rb_min_size,
+                        "offset", &rb_offset,
+                        "limit", &rb_limit,
+			"greater_than", &rb_greater_than,
+			"less_than", &rb_less_than,
+			NULL);
+
+    key_p = RVAL2GRNBULK_WITH_TYPE(rb_key, *context, key_p,
+				   table->header.domain, grn_ctx_at(*context, table->header.domain));
+    GRN_OBJ_INIT(&casted_key, GRN_BULK, 0, table->header.domain);
+    if (key_p->header.domain != table->header.domain) {
+	grn_obj_cast(*context, key_p, &casted_key, 0);
+	key_p = &casted_key;
+    }
+
+    if (!NIL_P(rb_min_size))
+	min_size = NUM2UINT(rb_min_size);
+    if (!NIL_P(rb_offset))
+	offset = NUM2INT(rb_offset);
+    if (!NIL_P(rb_limit))
+	limit = NUM2INT(rb_limit);
+
+    if (RVAL2CBOOL(rb_greater_than))
+	flags |= GRN_CURSOR_GT;
+    if (RVAL2CBOOL(rb_less_than))
+	flags |= GRN_CURSOR_LT;
+
+    cursor = grn_table_cursor_open(*context, table,
+				   NULL, min_size,
+				   GRN_BULK_HEAD(key_p), GRN_BULK_VSIZE(key_p),
+				   offset, limit, flags);
+    GRN_OBJ_FIN(*context, &casted_key);
+    rb_grn_context_check(*context, self);
+
+    return cursor;
+}
+
+/*
+ * call-seq:
+ *   table.open_near_cursor(key, options={}) -> Groonga::PatriciaTrieCursor
+ *   table.open_near_cursor(key, options={}) {|cursor| ... }
+ *
+ * _key_に近い順にレコードを取り出すカーソルを生成して返す。
+ * ブロックを指定すると、そのブロックに生成したカーソルが渡さ
+ * れ、ブロックを抜けると自動的にカーソルが破棄される。
+ *
+ * _options_に指定可能な値は以下の通り。
+ *
+ * [+:size+]
+ *   _size_バイト以降のデータが同じキーのレコードに限定する。
+ *
+ * [+:offset+]
+ *   該当する範囲のレコードのうち、(0ベースで)_:offset_番目
+ *   からレコードを取り出す。
+ *
+ * [+:limit+]
+ *   該当する範囲のレコードのうち、_:limit_件のみを取り出す。
+ *   省略された場合または-1が指定された場合は、全件が指定され
+ *   たものとみなす。
+ *
+ * [+:greater_than+]
+ *   +true+を指定すると_key_で指定した値に一致した[+key+]を
+ *   範囲に含まない。
+ *
+ * [+:less_than+]
+ *   +true+を指定すると_key_で指定した値に一致した[+key+]を
+ *   範囲に含まない。
+ */
+static VALUE
+rb_grn_patricia_trie_open_near_cursor (int argc, VALUE *argv, VALUE self)
+{
+    grn_ctx *context = NULL;
+    grn_table_cursor *cursor;
+    VALUE rb_cursor;
+
+    cursor = rb_grn_patricia_trie_open_grn_near_cursor(argc, argv,
+								self, &context, GRN_CURSOR_RK);
+    rb_cursor = GRNTABLECURSOR2RVAL(Qnil, context, cursor);
+    rb_iv_set(rb_cursor, "@table", self); /* FIXME: cursor should mark table */
+    if (rb_block_given_p())
+	return rb_ensure(rb_yield, rb_cursor, rb_grn_object_close, rb_cursor);
+    else
+	return rb_cursor;
+}
+
 void
 rb_grn_init_patricia_trie (VALUE mGrn)
 {
@@ -507,4 +890,14 @@ rb_grn_init_patricia_trie (VALUE mGrn)
 
     rb_define_method(rb_cGrnPatriciaTrie, "register_key_with_sis?",
 		     rb_grn_patricia_trie_register_key_with_sis_p, 0);
+
+    rb_define_method(rb_cGrnPatriciaTrie, "open_prefix_cursor",
+		     rb_grn_patricia_trie_open_prefix_cursor,
+		     -1);
+    rb_define_method(rb_cGrnPatriciaTrie, "open_rk_cursor",
+		     rb_grn_patricia_trie_open_rk_cursor,
+		     -1);
+    rb_define_method(rb_cGrnPatriciaTrie, "open_near_cursor",
+		     rb_grn_patricia_trie_open_near_cursor,
+		     -1);
 }