rroonga 9.0.2 → 10.0.6

data/ext/groonga/rb-grn-table-key-support.c

@@ -1,6 +1,6 @@
 /* -*- coding: utf-8; mode: C; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 /*
-  Copyright (C) 2009-2014  Kouhei Sutou <kou@clear-code.com>
+  Copyright (C) 2009-2020  Sutou Kouhei <kou@clear-code.com>
   Copyright (C) 2014-2016  Masafumi Yokoyama <yokoyama@clear-code.com>
 
   This library is free software; you can redistribute it and/or
@@ -481,8 +481,10 @@ typedef struct _SetValueData
 } SetValueData;
 
 static VALUE
-set_value (VALUE args, SetValueData *data)
+set_value (RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg))
 {
+    VALUE args = yielded_arg;
+    SetValueData *data = (SetValueData *)callback_arg;
     VALUE rb_name, rb_value, rb_column;
     RbGrnObject *rb_grn_object;
 
@@ -911,7 +913,9 @@ rb_grn_table_key_support_get_normalizer (VALUE self)
  *   # Specifies normalizer object.
  *   table.normalizer = Groonga::Context["NormalizerNFKC51"]
  *   # Uses auto normalizer that is a normalizer for backward compatibility.
- *   table.normalizer = "TNormalizerAuto"
+ *   table.normalizer = "NormalizerAuto"
+ *   # Uses a normalizer with options.
+ *   table.normalizer = "NormalizerNFKC121('unify_kana', true)"
  *
  * @overload normalizer=(name)
  *    @param [String] name Set a nomalizer named @name@.
@@ -927,7 +931,6 @@ rb_grn_table_key_support_set_normalizer (VALUE self, VALUE rb_normalizer)
 {
     grn_ctx *context;
     grn_obj *table;
-    grn_obj *normalizer;
     grn_rc rc;
 
     rb_grn_table_key_support_deconstruct(SELF(self), &table, &context,
@@ -935,9 +938,25 @@ rb_grn_table_key_support_set_normalizer (VALUE self, VALUE rb_normalizer)
                                          NULL, NULL, NULL,
                                          NULL);
 
-    normalizer = RVAL2GRNOBJECT(rb_normalizer, &context);
-    rc = grn_obj_set_info(context, table, GRN_INFO_NORMALIZER, normalizer);
-    rb_grn_context_check(context, self);
+    if (RB_TYPE_P(rb_normalizer, RUBY_T_STRING)) {
+        grn_obj normalizer;
+        VALUE exception;
+        GRN_TEXT_INIT(&normalizer, GRN_OBJ_DO_SHALLOW_COPY);
+        GRN_TEXT_SET(context,
+                     &normalizer,
+                     RSTRING_PTR(rb_normalizer),
+                     RSTRING_LEN(rb_normalizer));
+        rc = grn_obj_set_info(context, table, GRN_INFO_NORMALIZER, &normalizer);
+        exception = rb_grn_context_to_exception(context, self);
+        GRN_OBJ_FIN(context, &normalizer);
+        if (!NIL_P(exception)) {
+            rb_exc_raise(exception);
+        }
+    } else {
+        grn_obj *normalizer = RVAL2GRNOBJECT(rb_normalizer, &context);
+        rc = grn_obj_set_info(context, table, GRN_INFO_NORMALIZER, normalizer);
+        rb_grn_context_check(context, self);
+    }
     rb_grn_rc_check(rc, self);
 
     return Qnil;

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

@@ -2,6 +2,7 @@
 /*
   Copyright (C) 2009-2017  Kouhei Sutou <kou@clear-code.com>
   Copyright (C) 2014-2016  Masafumi Yokoyama <yokoyama@clear-code.com>
+  Copyright (C) 2019  Horimoto Yasuhiro <horimoto@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
@@ -29,9 +30,9 @@ static ID id_array_set;
 /*
  * Document-class: Groonga::Table < Groonga::Object
  *
- * Rroongaが提供するテーブルのベースとなるクラス。このクラス
- * から {Groonga::Array} , {Groonga::Hash} , {Groonga::PatriciaTrie}
- * が継承されている。
+ * This class is base class which represents Rroonga's table.
+ * {Groonga::Array} , {Groonga::Hash} , {Groonga::PatriciaTrie}
+ * are extended from this class.
  */
 
 grn_obj *
@@ -183,7 +184,8 @@ rb_grn_table_inspect_content (VALUE self, VALUE inspected)
 }
 
 /*
- * テーブルの中身を人に見やすい文字列で返す。
+ * This function return contents of a table as a string.
+ * It's easy to understand for human.
  *
  * @overload inspect
  *   @return [String]
@@ -203,31 +205,33 @@ rb_grn_table_inspect (VALUE self)
 }
 
 /*
- * テーブルに名前が _name_ で型が _value_type_ のカラムを定義
- * し、新しく定義されたカラムを返す。
+ * Defines a column that name is `name` and type is `value_type`. It
+ * returns the newly defined column.
  *
  * @overload define_column(name, value_type, options={})
  *   @param options [::Hash] The name and value
  *     pairs. Omitted names are initialized as the default value.
- *   @option options :path
- *     カラムを保存するパス。
- *   @option options :persistent (永続カラム)
- *     +true+ を指定すると永続カラムとなる。省略した場合は永
- *     続カラムとなる。 +:path+ を省略した場合は自動的にパスが
- *     付加される。
+ *   @option options :path [String, nil] (nil)
+ *     The path to store the content of the column.
+ *     If this is omitted, path is generated automatically.
+ *   @option options :persistent [Boolean] (true)
+ *     Whether the column is a persistent column or not.
+ *     If this is `true` and `:path` is omitted, path is generated
+ *     automatically.
  *   @option options :type (:scalar)
- *     カラムの値の格納方法について指定する。省略した場合は、
- *     +:scalar+ になる。
+ *     This option specifies how to store a value of a column.
+ *     If this option is omitted, +:scalar+ is used.
  *
- *     - +:scalar+ := スカラ値(単独の値)を格納する。
- *     - +:vector+ := 値の配列を格納する。
+ *     - +:scalar+ := Store scalar value.
+ *     - +:vector+ := Store array value.
  *   @option options [Boolean] :with_weight (false)
  *     It specifies whether making the column weight vector column or not.
  *     Weight vector column can store weight for each element.
  *
  *     You can't use this option for scalar column.
  *   @option options :compress
- *     値の圧縮方法を指定する。省略した場合は、圧縮しない。
+ *     This option specifies how to compress values.
+ *     If we omit this option, values are not compressed.
  *
  *     * `:zlib`: Compressed by zlib.
  *     * `:lz4`: Compressed by LZ4.
@@ -345,32 +349,37 @@ rb_grn_table_define_column (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * テーブルに名前が _name_ で型が _value_type_ のインデックスカ
- * ラムを定義し、新しく定義されたカラムを返す。
+ * Defines an index column that name is `name` and type is
+ * `value_type`. It returns the newly defined index column.
  *
  * @overload define_index_column(name, value_type, options={})
  *   @param options [::Hash] The name and value
  *     pairs. Omitted names are initialized as the default value.
- *   @option options :path
- *     カラムを保存するパス。
- *   @option options :persistent (永続カラム)
- *     +true+ を指定すると永続カラムとなる。省略した場合は永
- *     続カラムとなる。 +:path+ を省略した場合は自動的にパスが
- *     付加される。
- *   @option options :with_section
- *     転置索引にsection(段落情報)を合わせて格納する。
- *   @option options :with_weight
- *     転置索引にweight情報を合わせて格納する。
- *   @option options :with_position
- *     転置索引に出現位置情報を合わせて格納する。
- *   @option options :size (nil)
- *     The size of index column. It must be `nil`, `:small` or
- *     `:medium`. `nil` means full size. `:small` means small
- *     size. `:medium` means medium size.
- *   @option options :source
- *    インデックス対象となるカラムを指定する。 +:sources+ との併用はできない。
- *   @option options :sources
- *    インデックス対象となる複数のカラムを指定する。 +:source+ との併用はできない。
+ *   @option options :path [String, nil] (nil)
+ *     The path to store the content of the index column.
+ *     If this is omitted, path is generated automatically.
+ *   @option options :persistent [Boolean] (true)
+ *     Whether the index column is a persistent indent column or not.
+ *     If this is `true` and `:path` is omitted, path is generated
+ *     automatically.
+ *   @option options :with_section [Boolean] (false)
+ *     Whether section information is stored to the index column or not.
+ *   @option options :with_weight [Boolean] (false)
+ *     Whether weight information is stored to the index column or not.
+ *   @option options :with_position [Boolean] (false)
+ *     Whether position information is stored to the index column or not.
+ *   @option options :size [Symbol, nil] (nil)
+ *     The size of index column. It must be `nil`, `:small`,
+ *     `:medium` or `:large`. `nil` means the default size.
+ *     `:small` means small size. `:medium` means medium size. Medium size
+ *     is smaller than the default size. `:large` means large size.
+ *     Large size is larger than the default size.
+ *   @option options :source [Groonga::Column, nil] (nil)
+ *     Specifies the source column of the index column.
+ *     This option can't be used with `:sources`.
+ *   @option options :sources [::Array<Groonga::Column>, nil] (nil)
+ *     Specifies the source columns of the index column.
+ *     This option can't be used with `:source`.
  *
  * @return [Groonga::IndexColumn]
  */
@@ -461,9 +470,11 @@ rb_grn_table_define_index_column (int argc, VALUE *argv, VALUE self)
         flags |= GRN_OBJ_INDEX_SMALL;
     } else if (rb_grn_equal_option(rb_size, "medium")) {
         flags |= GRN_OBJ_INDEX_MEDIUM;
+    } else if (rb_grn_equal_option(rb_size, "large")) {
+        flags |= GRN_OBJ_INDEX_LARGE;
     } else {
         rb_raise(rb_eArgError,
-                 ":size must be nil, :small or :medium: <%" PRIsVALUE ">",
+                 ":size must be nil, :small, :medium or :large: <%" PRIsVALUE ">",
                  rb_size);
     }
 
@@ -514,8 +525,8 @@ ruby_object_to_column_name (VALUE rb_name,
 }
 
 /*
- * テーブルの _name_ に対応するカラムを返す。カラムが存在しな
- * い場合は +nil+ を返す。
+ * It returns the column has the specified name.
+ * If the specified column does not exist, it returns `nil`.
  *
  * @overload column(name)
  *   @return [Groonga::Column, nil]
@@ -595,11 +606,15 @@ rb_grn_table_get_column_surely (VALUE self, VALUE rb_name)
 }
 
 /*
- * テーブルの全てのカラムを返す。 _name_ が指定された場合はカ
- * ラム名の先頭が _name_ で始まるカラムを返す。
+ * @overload columns(prefix=nil)
+ *   It returns the specified columns in the table.
  *
- * @overload columns(name=nil)
- *   @return [Groonga::Columnの配列]
+ *   @param prefix [String, nil]
+ *     If this is `nil`, it returns the all columns in table.
+ *
+ *     Otherwise it returns columns which have name starts with `prefix`.
+ *
+ *   @return [::Array<Groonga::Column>]
  */
 static VALUE
 rb_grn_table_get_columns (int argc, VALUE *argv, VALUE self)
@@ -611,9 +626,9 @@ rb_grn_table_get_columns (int argc, VALUE *argv, VALUE self)
     grn_rc rc;
     int n;
     grn_table_cursor *cursor;
-    VALUE rb_name, rb_columns;
-    char *name = NULL;
-    unsigned name_size = 0;
+    VALUE rb_prefix, rb_columns;
+    char *prefix = NULL;
+    unsigned prefix_size = 0;
     VALUE exception;
 
     rb_grn_table_deconstruct(SELF(self), &table, &context,
@@ -621,18 +636,18 @@ rb_grn_table_get_columns (int argc, VALUE *argv, VALUE self)
                              NULL, NULL, NULL,
                              NULL);
 
-    rb_scan_args(argc, argv, "01", &rb_name);
+    rb_scan_args(argc, argv, "01", &rb_prefix);
 
-    if (!NIL_P(rb_name)) {
-        name = StringValuePtr(rb_name);
-        name_size = RSTRING_LEN(rb_name);
+    if (!NIL_P(rb_prefix)) {
+        prefix = StringValuePtr(rb_prefix);
+        prefix_size = RSTRING_LEN(rb_prefix);
     }
 
     key_type = grn_ctx_at(context, GRN_DB_SHORT_TEXT);
     columns = grn_table_create(context, NULL, 0, NULL, GRN_TABLE_HASH_KEY,
                                key_type, 0);
     rb_grn_context_check(context, self);
-    n = grn_table_columns(context, table, name, name_size, columns);
+    n = grn_table_columns(context, table, prefix, prefix_size, columns);
     rb_grn_context_check(context, self);
 
     rb_columns = rb_ary_new2(n);
@@ -690,9 +705,10 @@ rb_grn_table_get_columns (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * テーブルが _name_ カラムを持っている場合は +true+ を返す。
+ * Checks whether the table has a specified column or not.
  *
  * @overload have_column?(name)
+ *   @return [Boolean] `true` if the table has a `name` column, `false` otherwise.
  */
 static VALUE
 rb_grn_table_have_column (VALUE self, VALUE rb_name)
@@ -873,11 +889,10 @@ rb_grn_table_open_cursor (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * テーブルに登録されている全てのレコードが入っている配列を
- * 返す。
- *
  * @overload records
- *   @return [Groonga::Recordの配列]
+ *   It returns all records in the table.
+ *
+ *   @return [::Array<Groonga::Record>]
  */
 static VALUE
 rb_grn_table_get_records (int argc, VALUE *argv, VALUE self)
@@ -898,9 +913,9 @@ rb_grn_table_get_records (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * テーブルに登録されているレコード数を返す。
- *
  * @overload size
+ *   It returns the number of records in the table.
+ *
  *   @return [Integer]
  */
 static VALUE
@@ -919,9 +934,10 @@ rb_grn_table_get_size (VALUE self)
 }
 
 /*
- * テーブルにレコードが登録されていなければ +true+ を返す。
- *
  * @overload empty?
+ *
+ *   @return [Boolean] `true` if the table has no records,
+ *     `false` otherwise.
  */
 static VALUE
 rb_grn_table_empty_p (VALUE self)
@@ -939,9 +955,11 @@ rb_grn_table_empty_p (VALUE self)
 }
 
 /*
- * テーブルの全レコードを一括して削除する。
+ * Deletes all records in the table at once.
  *
  * @overload truncate
+ *
+ *   @return [void]
  */
 static VALUE
 rb_grn_table_truncate (VALUE self)
@@ -1112,7 +1130,7 @@ rb_grn_table_delete_by_expression (VALUE self)
  *
  *   @param id [Integer] The ID of delete target record.
  *
- *   @return void
+ *   @return [void]
  *
  * @overload delete
  *   Delete records that are matched with the given condition
@@ -1130,7 +1148,7 @@ rb_grn_table_delete_by_expression (VALUE self)
  *   @yieldreturn [Groonga::ExpressionBuilder]
  *     TODO: See #select.
  *
- *   @return void
+ *   @return [void]
  */
 static VALUE
 rb_grn_table_delete (int argc, VALUE *argv, VALUE self)
@@ -1613,9 +1631,10 @@ rb_grn_table_each_sub_record (VALUE self, VALUE rb_id)
 }
 
 /*
- * _table_ の _id_ に対応する {Groonga::Record} を返す。
+ * It returns the {Groonga::Record} for the `id` in the `table`.
  *
- * 0.9.0から値ではなく {Groonga::Record} を返すようになった。
+ * The return value has been changed to {Groonga::Record} from `id`
+ * itself since 0.9.0.
  *
  * @overload [](id)
  *   @return [Groonga::Record]
@@ -1653,16 +1672,16 @@ rb_grn_table_get_value (VALUE self, VALUE rb_id)
 }
 
 /*
- * _table_ の _id_ に対応する値を返す。
+ * It returns the value for the `id` in the `table`.
  *
- * @:id => true@ が指定できるのは利便性のため。
- * {Groonga::Array} でも {Groonga::Hash} や {Groonga::PatriciaTrie} と
- * 同じ引数で動くようになる。
+ * You can specify `id: true` for the convenience. `id: true` works
+ * with {Groonga::Array} like for {Groonga::Hash},
+ * {Groonga::PatriciaTrie} and so on.
  *
  * @overload value(id)
- *   @return [値]
- * @overload value(id, :id => true)
- *   @return [値]
+ *   @return [value]
+ * @overload value(id, id: true)
+ *   @return [value]
  */
 static VALUE
 rb_grn_table_get_value_convenience (int argc, VALUE *argv, VALUE self)
@@ -2482,8 +2501,8 @@ rb_grn_table_support_key_p (VALUE self)
 /*
  * @overload support_value?
  *
- *   @return @true@ if the table is created with value type, @false@
- *   otherwise.
+ *   @return [Boolean] `true` if the table is created with value type,
+ *     `false` otherwise.
  */
 static VALUE
 rb_grn_table_support_value_p (VALUE self)
@@ -2498,11 +2517,11 @@ rb_grn_table_support_value_p (VALUE self)
 }
 
 /*
- * グループ化したとき、テーブルにグループに含まれるレコード
- * 数を格納できる場合は +true+ 、格納できない場合は +false+ を返
- * す。
- *
  * @overload support_sub_records?
+ *
+ *   @return [Boolean] `true` if the table can store the number of
+ *     records for each group when the table is grouped, `false`
+ *     otherwise.
  */
 static VALUE
 rb_grn_table_support_sub_records_p (VALUE self)
@@ -2517,6 +2536,19 @@ rb_grn_table_support_sub_records_p (VALUE self)
     return CBOOL2RVAL(grn_table_is_grouped(context, table));
 }
 
+/*
+ * @overload support_score?
+ *
+ *   @return [Boolean] `true` if the table has `_score` column,
+ *     `false` otherwise.
+ */
+static VALUE
+rb_grn_table_support_score_p (VALUE self)
+{
+    return CBOOL2RVAL(rb_grn_table_have_column(self,
+                                               rb_str_new_literal("_score")));
+}
+
 /*
  * {Groonga::Table#group} returns a table that contains grouped
  * records. If grouped table has a space to store the number of
@@ -2554,13 +2586,11 @@ rb_grn_table_have_n_sub_records_space_p (VALUE self)
 }
 
 /*
- * _table_ に _id_ で指定したIDのレコードが存在する場合は +true+ 、
- * 存在しない場合は +false+ を返す。
- *
- * 注意: 実行には相応のコストがかかるのであまり頻繁に呼ばな
- * いようにして下さい。
- *
  * @overload exist?(id)
+ *   @return [Boolean] `true` if the table has a record specified ID
+ *      by `id`, `false` otherwise.
+ *
+ *   @note This method is heavy. You should not call this as much as possible.
  */
 static VALUE
 rb_grn_table_exist_p (VALUE self, VALUE id)
@@ -2890,6 +2920,8 @@ rb_grn_init_table (VALUE mGrn)
                      rb_grn_table_support_value_p, 0);
     rb_define_method(rb_cGrnTable, "support_sub_records?",
                      rb_grn_table_support_sub_records_p, 0);
+    rb_define_method(rb_cGrnTable, "support_score?",
+                     rb_grn_table_support_score_p, 0);
     rb_define_method(rb_cGrnTable, "have_n_sub_records_space?",
                      rb_grn_table_have_n_sub_records_space_p, 0);