rroonga 2.0.5 → 2.0.6

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

@@ -25,7 +25,7 @@ VALUE rb_cGrnVariable;
 /*
  * Document-class: Groonga::Variable < Groonga::Object
  *
- * Groonga::Expressionで使われる変数。
+ * {Groonga::Expression} で使われる変数。
  */
 
 grn_obj *
@@ -59,10 +59,10 @@ rb_grn_variable_deconstruct (RbGrnVariable *rb_grn_variable,
 }
 
 /*
- * call-seq:
- *   variable.value -> Groonga::Object
- *
  * 変数の値を返す。
+ *
+ * @overload value
+ *   @return [Groonga::Object]
  */
 static VALUE
 rb_grn_variable_get_value (VALUE self)
@@ -78,10 +78,9 @@ rb_grn_variable_get_value (VALUE self)
 }
 
 /*
- * call-seq:
- *   variable.value=(value)
- *
  * 変数の値を _value_ に設定する。
+ *
+ * @overload value=(value)
  */
 static VALUE
 rb_grn_variable_set_value (VALUE self, VALUE value)

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

@@ -43,7 +43,7 @@ rb_grn_view_accessor_to_ruby_object (grn_ctx *context, grn_obj *table,
  * Document-class: Groonga::ViewAccessor < Groonga::Object
  *
  * キー、値、スコアなど種々の値へのアクセスをカプセル化した
- * オブジェクト。Groonga::Table#columnで取得できる。
+ * オブジェクト。 {Groonga::Table#column} で取得できる。
  */
 void
 rb_grn_init_view_accessor (VALUE mGrn)

data/ext/groonga/rb-grn-view-cursor.c

@@ -23,8 +23,8 @@ VALUE rb_cGrnViewCursor;
 /*
  * Document-class: Groonga::ViewCursor < Groonga::TableCursor
  *
- * Groonga::Viewからレコードを順番に取り出すためのオブジェク
- * ト。利用できるメソッドはGroonga::TableCursorを参照。
+ * {Groonga::View} からレコードを順番に取り出すためのオブジェク
+ * ト。利用できるメソッドは {Groonga::TableCursor} を参照。
  */
 
 void

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

@@ -40,7 +40,7 @@ VALUE rb_cGrnView;
  * に生成したテーブルが渡され、ブロックを抜けると自動的にテー
  * ブルが破棄される。
  *
- * ビューにテーブルを追加するときはGroonga::View#add_tableを
+ * ビューにテーブルを追加するときは {#add_table} を
  * 使う。
  *
  * @example 無名一時ビューを生成する。
@@ -60,46 +60,30 @@ VALUE rb_cGrnView;
  *
  * @overload create(options={})
  *   @return [Groonga::View]
- *   @param options [::Hash] The name and value
- *     pairs. Omitted names are initialized as the default value
- *   @option options :context (Groonga::Context.default)
- *     ビューが利用するGroonga::Context。
- *   @option options :name
- *     ビューの名前。名前をつけると、Groonga::Context#[]に名
- *     前を指定してビューを取得することができる。省略すると
- *     無名ビューになり、ビューIDでのみ取得できる。
- *   @option options :path
- *     ビューを保存するパス。パスを指定すると永続ビューとな
- *     り、プロセス終了後もレコードは保持される。次回起動時に
- *     Groonga::View.openで保存されたビューを利用することが
- *     できる。省略すると一時ビューになり、プロセスが終了する
- *     とビューは破棄される。
- *   @option options :persistent
- *     +true+ を指定すると永続ビューとなる。 +path+ を省略した
- *     場合は自動的にパスが付加される。 +:context+ で指定した
- *     Groonga::Contextに結びついているデータベースが一時デー
- *     タベースの場合は例外が発生する。
+ *   @!macro [new] view.create.options
+ *     @param options [::Hash] The name and value
+ *       pairs. Omitted names are initialized as the default value
+ *     @option options :context (Groonga::Context.default)
+ *       ビューが利用する {Groonga::Context} 。
+ *     @option options :name
+ *       ビューの名前。名前をつけると、 {Groonga::Context#[]} に名
+ *       前を指定してビューを取得することができる。省略すると
+ *       無名ビューになり、ビューIDでのみ取得できる。
+ *     @option options :path
+ *       ビューを保存するパス。パスを指定すると永続ビューとな
+ *       り、プロセス終了後もレコードは保持される。次回起動時に
+ *       {Groonga::View.open} で保存されたビューを利用することが
+ *       できる。省略すると一時ビューになり、プロセスが終了する
+ *       とビューは破棄される。
+ *     @option options :persistent
+ *       +true+ を指定すると永続ビューとなる。 +path+ を省略した
+ *       場合は自動的にパスが付加される。 +:context+ で指定した
+ *       {Groonga::Context} に結びついているデータベースが一時デー
+ *       タベースの場合は例外が発生する。
+ *   @!macro view.create.options
  * @overload create(options={})
  *   @yield [table]
- *   @param options [::Hash] The name and value
- *     pairs. Omitted names are initialized as the default value
- *   @option options :context (Groonga::Context.default)
- *     ビューが利用するGroonga::Context。
- *   @option options :name
- *     ビューの名前。名前をつけると、Groonga::Context#[]に名
- *     前を指定してビューを取得することができる。省略すると
- *     無名ビューになり、ビューIDでのみ取得できる。
- *   @option options :path
- *     ビューを保存するパス。パスを指定すると永続ビューとな
- *     り、プロセス終了後もレコードは保持される。次回起動時に
- *     Groonga::View.openで保存されたビューを利用することが
- *     できる。省略すると一時ビューになり、プロセスが終了する
- *     とビューは破棄される。
- *   @option options :persistent
- *     +true+ を指定すると永続ビューとなる。 +path+ を省略した
- *     場合は自動的にパスが付加される。 +:context+ で指定した
- *     Groonga::Contextに結びついているデータベースが一時デー
- *     タベースの場合は例外が発生する。
+ *   @!macro view.create.options
  */
 static VALUE
 rb_grn_view_s_create (int argc, VALUE *argv, VALUE klass)
@@ -149,10 +133,9 @@ rb_grn_view_s_create (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   view.add_table(table)
- *
  * _table_ をビューからアクセスできるようにする。
+ *
+ * @overload add_table(table)
  */
 static VALUE
 rb_grn_view_add_table (VALUE self, VALUE rb_table)
@@ -176,11 +159,11 @@ rb_grn_view_add_table (VALUE self, VALUE rb_table)
 }
 
 /*
- * call-seq:
- *   view.each {|record| ...}
- *
  * ビューに登録されているテーブルのレコードを順番にブロック
  * に渡す。
+ *
+ * @overload each
+ *   @yield [record]
  */
 static VALUE
 rb_grn_view_each (VALUE self)

data/ext/groonga/rb-grn.h

@@ -76,7 +76,7 @@ RB_GRN_BEGIN_DECLS
 
 #define RB_GRN_MAJOR_VERSION 2
 #define RB_GRN_MINOR_VERSION 0
-#define RB_GRN_MICRO_VERSION 5
+#define RB_GRN_MICRO_VERSION 6
 
 #define RB_GRN_QUERY_DEFAULT_MAX_EXPRESSIONS 32
 

data/ext/groonga/rb-groonga.c

@@ -70,8 +70,8 @@ rb_grn_init_runtime_version (VALUE mGrn)
 
     rb_obj_freeze(runtime_version);
     /*
-     * 利用しているgroongaのバージョン。<tt>[メジャーバージョ
-     * ン, マイナーバージョン, マイクロバージョン, タグ]</tt>の
+     * 利用しているgroongaのバージョン。 @[メジャーバージョ
+     * ン, マイナーバージョン, マイクロバージョン, タグ]@ の
      * 配列。
      */
     rb_define_const(mGrn, "VERSION", runtime_version);
@@ -90,8 +90,8 @@ rb_grn_init_version (VALUE mGrn)
 				INT2NUM(GRN_MICRO_VERSION));
     rb_obj_freeze(build_version);
     /*
-     * ビルドしたgroongaのバージョン。<tt>[メジャーバージョン,
-     * マイナーバージョン, マイクロバージョン]</tt>の配列。
+     * ビルドしたgroongaのバージョン。 @[メジャーバージョン,
+     * マイナーバージョン, マイクロバージョン]@ の配列。
      */
     rb_define_const(mGrn, "BUILD_VERSION", build_version);
 
@@ -101,8 +101,8 @@ rb_grn_init_version (VALUE mGrn)
 				   INT2NUM(RB_GRN_MICRO_VERSION));
     rb_obj_freeze(bindings_version);
     /*
-     * rroongaのバージョン。<tt>[メジャーバージョン, マ
-     * イナーバージョン, マイクロバージョン]</tt>の配列。
+     * rroongaのバージョン。 @[メジャーバージョン, マ
+     * イナーバージョン, マイクロバージョン]@ の配列。
      */
     rb_define_const(mGrn, "BINDINGS_VERSION", bindings_version);
 }

data/lib/groonga/database.rb

@@ -17,7 +17,7 @@
 
 module Groonga
   class Database
-    # @return [Array<Groonga::Table] tables defined in the database
+    # @return [Array<Groonga::Table>] tables defined in the database.
     def tables
       find_all do |object|
         object.is_a?(Groonga::Table)

data/lib/groonga/dumper.rb

@@ -48,9 +48,20 @@ module Groonga
       options[:dump_schema] = true if options[:dump_schema].nil?
       options[:dump_tables] = true if options[:dump_tables].nil?
 
+      if options[:dump_schema]
+        schema_dumper = SchemaDumper.new(options.merge(:syntax => :command))
+      end
       dump_plugins(options) if options[:dump_plugins]
-      dump_schema(options) if options[:dump_schema]
+      if options[:dump_schema]
+        schema_dumper.dump_tables
+        options[:output].write("\n")
+        schema_dumper.dump_reference_columns
+      end
       dump_tables(options) if options[:dump_tables]
+      if options[:dump_schema]
+        options[:output].write("\n")
+        schema_dumper.dump_index_columns
+      end
 
       if have_output
         nil
@@ -74,10 +85,6 @@ module Groonga
       options[:output].write("\n") unless plugin_paths.empty?
     end
 
-    def dump_schema(options)
-      SchemaDumper.new(options.merge(:syntax => :command)).dump
-    end
-
     def dump_tables(options)
       first_table = true
       options[:database].each(each_options(:order_by => :key)) do |object|
@@ -125,6 +132,40 @@ module Groonga
     end
 
     def dump
+      run do |syntax|
+        syntax.dump
+      end
+    end
+
+    def dump_tables
+      run do |syntax|
+        syntax.dump_tables
+      end
+    end
+
+    def dump_reference_columns
+      run do |syntax|
+        syntax.dump_reference_columns
+      end
+    end
+
+    def dump_index_columns
+      run do |syntax|
+        syntax.dump_index_columns
+      end
+    end
+
+    private
+    def create_syntax(database, output)
+      case @options[:syntax]
+      when :command
+        CommandSyntax.new(database, output)
+      else
+        RubySyntax.new(database, output)
+      end
+    end
+
+    def run
       database = @options[:database]
       if database.nil?
         context = @options[:context] || Groonga::Context.default
@@ -135,7 +176,7 @@ module Groonga
       output = @options[:output]
       have_output = !output.nil?
       output ||= Dumper.default_output
-      result = syntax(database, output).dump
+      result = yield(create_syntax(database, output))
       if have_output
         result
       else
@@ -143,24 +184,12 @@ module Groonga
       end
     end
 
-    private
-    def syntax(database, output)
-      case @options[:syntax]
-      when :command
-        CommandSyntax.new(database, output)
-      else
-        RubySyntax.new(database, output)
-      end
-    end
-
     # @private
     class BaseSyntax
       def initialize(database, output)
         @database = database
         @output = output
         @table_defined = false
-        @index_columns = []
-        @reference_columns = []
       end
 
       def dump
@@ -176,14 +205,13 @@ module Groonga
       end
 
       def dump_tables
-        each_options = {:order_by => :key, :ignore_missing_object => true}
-        @database.each(each_options) do |object|
-          create_table(object) if object.is_a?(Groonga::Table)
+        each_table do |table|
+          create_table(table)
         end
       end
 
       def dump_reference_columns
-        group_columns(@reference_columns).each do |table, columns|
+        group_columns(reference_columns).each do |table, columns|
           change_table(table) do
             columns.each do |column|
               define_reference_column(table, column)
@@ -193,7 +221,7 @@ module Groonga
       end
 
       def dump_index_columns
-        group_columns(@index_columns).each do |table, columns|
+        group_columns(index_columns).each do |table, columns|
           change_table(table) do
             columns.each do |column|
               define_index_column(table, column)
@@ -215,6 +243,40 @@ module Groonga
         write("")
       end
 
+      def each_table
+        each_options = {:order_by => :key, :ignore_missing_object => true}
+        @database.each(each_options) do |object|
+          yield(object) if object.is_a?(Groonga::Table)
+        end
+      end
+
+      def each_column(table, &block)
+        sorted_columns = table.columns.sort_by {|column| column.local_name}
+        sorted_columns.each(&block)
+      end
+
+      def collect_columns
+        columns = []
+        each_table do |table|
+          each_column(table) do |column|
+            columns << column if yield(column)
+          end
+        end
+        columns
+      end
+
+      def reference_columns
+        @reference_columns ||= collect_columns do |column|
+          reference_column?(column)
+        end
+      end
+
+      def index_columns
+        @index_columns ||= collect_columns do |column|
+          index_column?(column)
+        end
+      end
+
       def group_columns(columns)
         grouped_columns = columns.group_by do |column|
           column.table
@@ -239,19 +301,33 @@ module Groonga
         write("\n")
       end
 
+      def column_type(column)
+        if column.is_a?(Groonga::IndexColumn)
+          :index
+        elsif column.range.is_a?(Groonga::Table)
+          :reference
+        else
+          :normal
+        end
+      end
+
+      def index_column?(column)
+        column_type(column) == :index
+      end
+
+      def reference_column?(column)
+        column_type(column) == :reference
+      end
+
+      def normal_column?(column)
+        column_type(column) == :normal
+      end
+
       def create_table(table)
         table_separator if @table_defined
         create_table_header(table)
-        table.columns.sort_by {|column| column.local_name}.each do |column|
-          if column.is_a?(Groonga::IndexColumn)
-            @index_columns << column
-          else
-            if column.range.is_a?(Groonga::Table)
-              @reference_columns << column
-            else
-              define_column(table, column)
-            end
-          end
+        each_column(table) do |column|
+          define_column(table, column) if normal_column?(column)
         end
         create_table_footer(table)
         @table_defined = true

data/lib/groonga/expression-builder.rb

@@ -24,6 +24,7 @@ module Groonga
     attr_accessor :allow_pragma
     attr_accessor :allow_column
     attr_accessor :allow_update
+    attr_accessor :allow_leading_not
     attr_accessor :default_column
 
     VALID_COLUMN_NAME_RE = /\A[a-zA-Z\d_]+\z/
@@ -36,6 +37,7 @@ module Groonga
       @allow_pragma = nil
       @allow_column = nil
       @allow_update = nil
+      @allow_leading_not = nil
       @default_column = nil
     end
 
@@ -60,6 +62,7 @@ module Groonga
         :allow_pragma => @allow_pragma,
         :allow_column => @allow_column,
         :allow_update => @allow_update,
+        :allow_leading_not => @allow_leading_not,
         :default_column => @default_column,
       }
     end
@@ -230,6 +233,16 @@ module Groonga
         SimilarSearchExpressionBuilder.new(self, normalize(other))
       end
 
+      def term_extract(other)
+        if @column_name == "_key"
+          TermExtractExpressionBuilder.new(self, normalize(other))
+        else
+          message = "term extraction supports _key column only: " +
+            "<#{@column_name}>"
+          raise ArgumentError, message
+        end
+      end
+
       private
       def normalize(other)
         if @range.is_a?(Groonga::Table)
@@ -417,6 +430,13 @@ module Groonga
         super(Groonga::Operation::SIMILAR, column_value_builder, value)
       end
     end
+
+    # @private
+    class TermExtractExpressionBuilder < BinaryExpressionBuilder
+      def initialize(column_value_builder, value)
+        super(Groonga::Operation::TERM_EXTRACT, column_value_builder, value)
+      end
+    end
   end
 
   # @private
@@ -586,6 +606,10 @@ module Groonga
       column_expression_builder.similar_search(text)
     end
 
+    def term_extract(text)
+      column_expression_builder.term_extract(text)
+    end
+
     private
     def column_expression_builder
       ColumnValueExpressionBuilder.new(@default_column,