rroonga 2.0.4-x86-mingw32 → 2.0.7-x86-mingw32

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

@@ -135,13 +135,10 @@ rb_grn_database_finalizer (grn_ctx *context,
 }
 
 /*
- * Document-method: close
- *
- * call-seq:
- *   database.close
- *
  * _database_ が使用しているリソースを開放する。これ以降 _database_ を
  * 使うことはできない。
+ *
+ * @overload close
  */
 static VALUE
 rb_grn_database_close (VALUE self)
@@ -164,30 +161,26 @@ reset_floating_objects (VALUE rb_context)
 }
 
 /*
- * call-seq:
- *   Groonga::Database.create(options=nil) -> Groonga::Database
- *
  * 新しくデータベースを作成する。
- *
- * _options_ にはハッシュでオプションを指定する。指定できるオ
- * プションは以下の通り。
- * @param option [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :path The path
- *
- *   データベースを保存するパス。省略すると一時データベース
- *   となる。
- * @option options :context (Groonga::Context.default) The context
- *
- *   データベースを結びつけるコンテキスト。省略すると
- *   Groonga::Context.defaultを利用する。
+ * _options_ にはハッシュでオプションを指定する。
  *
  * @example
- *   一時データベースを作成:
+ *   # 一時データベースを作成:
  *   Groonga::Database.create
  *
- *   永続データベースを作成:
+ *   # 永続データベースを作成:
  *   Groonga::Database.create(:path => "/tmp/db.groonga")
+ *
+ * @overload create(options=nil)
+ *   @return [Groonga::Database] 作成されたデータベースを返す。
+ *   @param option [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :path
+ *     データベースを保存するパス。省略すると一時データベース
+ *     となる。
+ *   @option options :context (Groonga::Context.default)
+ *     データベースを結びつけるコンテキスト。省略すると
+ *     {Groonga::Context.default} を利用する。
  */
 static VALUE
 rb_grn_database_s_create (int argc, VALUE *argv, VALUE klass)
@@ -236,22 +229,25 @@ rb_grn_database_s_create (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   Groonga::Database.new(path, options=nil) -> Groonga::Database
- *   Groonga::Database.new(path, options=nil) {|database| ...}
- *
  * 既存のデータベースを開く。ブロックを指定した場合はブロッ
  * クに開いたデータベースを渡し、ブロックを抜けるときに閉じ
  * る。
  *
- * _options_ にはハッシュでオプションを指定する。指定できるオ
- * プションは以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :context (Groonga::Context.default) The context
- *
- *   データベースを結びつけるコンテキスト。省略すると
- *   Groonga::Context.defaultを利用する。
+ * @overload new(path, options=nil)
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default)
+ *     データベースを結びつけるコンテキスト。省略すると
+ *     {Groonga::Context.default} を利用する。
+ *   @return [Groonga::Database]
+ * @overload new(path, options=nil)
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default)
+ *     データベースを結びつけるコンテキスト。省略すると
+ *     {Groonga::Context.default} を利用する。
+ *   @yield [database]
+ *   @yieldparam [Groonga::Database] database 開いたデータベース
  */
 static VALUE
 rb_grn_database_initialize (int argc, VALUE *argv, VALUE self)
@@ -286,21 +282,23 @@ rb_grn_database_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   Groonga::Database.open(path, options=nil) -> Groonga::Database
- *   Groonga::Database.open(path, options=nil) {|database| ...}
- *
  * 既存のデータベースを開く。ブロックを指定した場合はブロッ
  * クに開いたデータベースを渡し、ブロックを抜けるときに閉じ
- * る。
- *
- * _options_ にはハッシュでオプションを指定する。指定できるオ
- * プションは以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :context (Groonga::Context.default) The context
- *
- *   データベースを結びつけるコンテキスト。
+ * る。 _options_ にはハッシュでオプションを指定する。
+ *
+ * @overload open(path, options=nil)
+ *   @return [Groonga::Database]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default) The context
+ *     データベースを結びつけるコンテキスト。
+ * @overload open(path, options=nil)
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default) The context
+ *     データベースを結びつけるコンテキスト。
+ *   @yield [database]
+ *   @yieldparam [Groonga::Database] database 開いたデータベース
  */
 static VALUE
 rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
@@ -316,10 +314,6 @@ rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   database.each {|object| ...}
- *   database.each(options=nil) {|object| ...}
- *
  * データベース内のオブジェクトを順番にブロックに渡す。
  *
  * @example すべてのオブジェクトの名前を表示する:
@@ -337,20 +331,28 @@ rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
  *     p object.name
  *   end
  *
- * @param options [::Hash]
- * @option options :order The order
- *   +:asc+ または +:ascending+ を指定すると昇順にレコードを取
- *   り出す。（デフォルト）
- *
- *   +:desc+ または +:descending+ を指定すると降順にレコードを
- *   取り出す。
- *
- * @option options :order_by (:key) The ordef by
- *   +:id+ を指定するとID順にレコードを取り出す。
- *
- *   +:key+ 指定するとキー順にレコードを取り出す。（デフォル
- *   ト）
- *
+ * @overload each(options=nil)
+ *   @macro [new] database.each.options
+ *     @param options [::Hash]
+ *     @yield [object]
+ *     @option options :order
+ *       +:asc+ または +:ascending+ を指定すると昇順にレコードを取
+ *       り出す。（デフォルト）
+ *       +:desc+ または +:descending+ を指定すると降順にレコードを
+ *       取り出す。
+ *     @option options :order_by (:key)
+ *       +:id+ を指定するとID順にレコードを取り出す。
+ *       +:key+ 指定するとキー順にレコードを取り出す。（デフォル
+ *       ト）
+ *   @macro database.each.options
+ *
+ * @overload each(options=nil)
+ *   @macro database.each.options
+ *   @option options :ignore_missing_object (false)
+ *     Specify +true+ to ignore missing object. Otherwise, an exception is
+ *     raised for missing object.
+ *
+ *   @since 2.0.5
  */
 static VALUE
 rb_grn_database_each (int argc, VALUE *argv, VALUE self)
@@ -359,8 +361,12 @@ rb_grn_database_each (int argc, VALUE *argv, VALUE self)
     grn_obj *database;
     grn_table_cursor *cursor;
     VALUE rb_cursor, rb_options, rb_order, rb_order_by;
+    VALUE rb_ignore_missing_object;
     int flags = 0;
     grn_id id;
+    VALUE exception;
+
+    RETURN_ENUMERATOR(self, argc, argv);
 
     rb_grn_database_deconstruct(SELF(self), &database, &context,
 				NULL, NULL, NULL, NULL);
@@ -370,6 +376,7 @@ rb_grn_database_each (int argc, VALUE *argv, VALUE self)
     rb_grn_scan_options(rb_options,
 			"order", &rb_order,
 			"order_by", &rb_order_by,
+			"ignore_missing_object", &rb_ignore_missing_object,
 			NULL);
 
     flags |= rb_grn_table_cursor_order_to_flag(rb_order);
@@ -386,8 +393,21 @@ rb_grn_database_each (int argc, VALUE *argv, VALUE self)
 	grn_obj *object;
 
 	object = grn_ctx_at(context, id);
-	if (object)
+	if (!object && RTEST(rb_ignore_missing_object)) {
+	    context->rc = GRN_SUCCESS;
+	    continue;
+	}
+
+	exception = rb_grn_context_to_exception(context, self);
+	if (!NIL_P(exception)) {
+	    rb_grn_object_close(rb_cursor);
+	    rb_iv_set(self, "cursor", Qnil);
+	    rb_exc_raise(exception);
+	}
+
+	if (object) {
 	    rb_yield(GRNOBJECT2RVAL(Qnil, context, object, GRN_FALSE));
+	}
     }
     rb_grn_object_close(rb_cursor);
     rb_iv_set(self, "cursor", Qnil);
@@ -396,12 +416,9 @@ rb_grn_database_each (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * Document-method: unlock
- *
- * call-seq:
- *   database.unlock
- *
  * _database_ のロックを解除する。
+ *
+ * @overload unlock
  */
 static VALUE
 rb_grn_database_unlock (VALUE self)
@@ -421,25 +438,22 @@ rb_grn_database_unlock (VALUE self)
 }
 
 /*
- * Document-method: lock
- *
- * call-seq:
- *   database.lock(options={})
- *   database.lock(options={}) {...}
- *
  * _database_ をロックする。ロックに失敗した場合は
- * Groonga::ResourceDeadlockAvoided例外が発生する。
- *
- * ブロックを指定した場合はブロックを抜けたときにunlockする。
- *
- * 利用可能なオプションは以下の通り。
- * @param [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value
- * @option options :timeout The timeout
- *
- *   ロックを獲得できなかった場合は _:timeout_ 秒間ロックの獲
- *   得を試みる。 _:timeout_ 秒以内にロックを獲得できなかった
- *   場合は例外が発生する。
+ * {Groonga::ResourceDeadlockAvoided} 例外が発生する。
+ *
+ * @overload lock(options={})
+ *   @param [::Hash] options 利用可能なオプションは以下の通り。
+ *   @option options :timeout
+ *     ロックを獲得できなかった場合は _:timeout_ 秒間ロックの獲
+ *     得を試みる。 _:timeout_ 秒以内にロックを獲得できなかった
+ *     場合は例外が発生する。
+ * @overload lock(options={})
+ *   @yield ブロックを指定した場合はブロックを抜けたときにunlockする。
+ *   @param [::Hash] options 利用可能なオプションは以下の通り。
+ *   @option options :timeout
+ *     ロックを獲得できなかった場合は _:timeout_秒間ロックの獲
+ *     得を試みる。 _:timeout_秒以内にロックを獲得できなかった
+ *     場合は例外が発生する。
  */
 static VALUE
 rb_grn_database_lock (int argc, VALUE *argv, VALUE self)
@@ -474,12 +488,9 @@ rb_grn_database_lock (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * Document-method: clear_lock
- *
- * call-seq:
- *   database.clear_lock
- *
  * _database_ のロックを強制的に解除する。
+ *
+ * @overload clear_lock
  */
 static VALUE
 rb_grn_database_clear_lock (VALUE self)
@@ -496,12 +507,9 @@ rb_grn_database_clear_lock (VALUE self)
 }
 
 /*
- * Document-method: locked?
- *
- * call-seq:
- *   database.locked?
- *
  * _database_ がロックされていれば +true+ を返す。
+ *
+ * @overload locked?
  */
 static VALUE
 rb_grn_database_is_locked (VALUE self)
@@ -516,12 +524,9 @@ rb_grn_database_is_locked (VALUE self)
 }
 
 /*
- * Document-method: touch
- *
- * call-seq:
- *   database.touch
- *
  * _database_ の最終更新時刻を現在時刻にする。
+ *
+ * @overload touch
  */
 static VALUE
 rb_grn_database_touch (VALUE self)
@@ -537,18 +542,15 @@ rb_grn_database_touch (VALUE self)
 }
 
 /*
- * Document-method: defrag
- *
- * call-seq:
- *   database.defrag(options={}) -> n_segments
- *
  * Defrags all variable size columns in the database.
  *
  * @return [Integer] the number of defraged segments
- * @option options [Integer] :threshold (0) the threshold to
- *   determine whether a segment is defraged. Available
- *   values are -4..22. -4 means all segments are defraged.
- *   22 means no segment is defraged.
+ * @overload defrag(options={})
+ *   @param [::Hash] options option for defrag
+ *   @option options [Integer] :threshold (0) the threshold to
+ *     determine whether a segment is defraged. Available
+ *     values are -4..22. -4 means all segments are defraged.
+ *     22 means no segment is defraged.
  * @since 1.2.6
  */
 static VALUE

data/ext/groonga/rb-grn-double-array-trie-cursor.c

@@ -21,11 +21,11 @@
 VALUE rb_cGrnDoubleArrayTrieCursor;
 
 /*
- * Document-class: Groonga::DoubleArrayCursor < Groonga::TableCursor
+ * Document-class: Groonga::DoubleArrayTrieCursor < Groonga::TableCursor
  *
- * Groonga::DoubleArrayに登録されているレコードを順番に取り
+ * {Groonga::DoubleArrayTrie} に登録されているレコードを順番に取り
  * 出すためのオブジェクト。利用できるメソッドは
- * Groonga::TableCursorとGroonga::TableCursor::KeySupportを
+ * {Groonga::TableCursor} と {Groonga::TableCursor::KeySupport} を
  * 参照。
  */