rroonga 1.2.0 → 1.2.1

data/lib/groonga/expression-builder.rb

@@ -27,7 +27,7 @@ module Groonga
 
     VALID_COLUMN_NAME_RE = /\A[a-zA-Z\d_]+\z/
 
-    def initialize(*args)
+    def initialize
       @table = nil
       @name = nil
       @query = nil
@@ -445,7 +445,7 @@ module Groonga
       end
       if object.range != @table
         raise ArgumentError,
-              "differenct index column: <#{name}>: #{object.inspect}"
+              "different index column: <#{name}>: #{object.inspect}"
       end
       column_expression_builder(object, name)
     end

data/lib/groonga/pagination.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# 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
@@ -17,7 +17,13 @@
 
 module Groonga
   class TooSmallPage < Error
-    attr_reader :page, :available_pages
+    # Table#paginate で小さすぎるページ番号を指定した場合に
+    # 発生する。
+
+    # 指定したページ番号。
+    attr_reader :page
+    # 有効なページ。Range。
+    attr_reader :available_pages
     def initialize(page, available_pages)
       @page = page
       @available_pages = available_pages
@@ -27,7 +33,13 @@ module Groonga
   end
 
   class TooLargePage < Error
-    attr_reader :page, :available_pages
+    # Table#paginate で大きすぎるページ番号を指定した場合に
+    # 発生する。
+
+    # 指定したページ番号。
+    attr_reader :page
+    # 有効なページ。Range。
+    attr_reader :available_pages
     def initialize(page, available_pages)
       @page = page
       @available_pages = available_pages
@@ -37,7 +49,13 @@ module Groonga
   end
 
   class TooSmallPageSize < Error
-    attr_reader :page_size, :available_page_sizes
+    # Table#paginate で小さすぎるページサイズを指定した場合
+    # に発生する。
+
+    # 指定したページサイズ。
+    attr_reader :page_size
+    # 有効なページサイズ。Range。
+    attr_reader :available_page_sizes
     def initialize(page_size, available_page_sizes)
       @page_size = page_size
       @available_page_sizes = available_page_sizes
@@ -47,6 +65,44 @@ module Groonga
   end
 
   class Table
+
+    # ページネーション用便利メソッド。ページネーションをした
+    # い場合は #sort よりも #paginate の方が便利。
+    #
+    # 説明文（descriptionカラム）を「Ruby」で全文検索し、検
+    # 索結果をスコアの高い順にソートして、10項目ずつ表示する
+    # 場合は以下のようになる。
+    #
+    #   query = "Ruby"
+    #   entries = Groonga["entries"]
+    #   selected_entries = entries.select do |record|
+    #     entry.description =~ query
+    #   end
+    #   paged_entries = selected_entries.paginate(["_score", :desc],
+    #                                             :page => 1,
+    #                                             :size => 10)
+    #
+    # #sort と違い、返されるTableオブジェクトにはPagination
+    # モジュールがextendされており、以下のようにページネーショ
+    # ン情報を取得できる。
+    #
+    #   puts "#{paged_entries.n_records}件ヒット"
+    #   puts "#{paged_entries.start_offset}-#{paged_entries.end_offset}件を表示"
+    #   paged_entries.each do |entry|
+    #     puts entry.description
+    #   end
+    #
+    # _sort_keys_ には ソートに用いる情報を指定する。
+    # 指定の仕方は #sort と同様なので、詳細は #sort を参照。
+    #
+    # _options_に指定可能な値は以下の通り。
+    #
+    # [+:size+]
+    #   1ページあたりに表示する最大項目数。デフォルトは10。
+    #
+    # [+:page+]
+    #   ページ番号。ページ番号は0ベースではなく1ベースである
+    #   ことに注意。デフォルトは1ページ目。
     def paginate(sort_keys, options={})
       _size = size
       page_size = options[:size] || 10
@@ -74,60 +130,96 @@ module Groonga
 
   # ページネーション機能を追加するモジュール。
   #
-  # ページ番号など、0ベースではなく1ベースです。
+  # ページ番号やレコードが何番目かは0ベースではなく1ベースで
+  # あることに注意すること。
   module Pagination
-    attr_reader :current_page, :page_size, :n_pages, :n_records
-
+    # 現在のページ番号。
+    attr_reader :current_page
+    # 1ページあたりのレコード数。
+    attr_reader :page_size
+    # 全ページ数。
+    attr_reader :n_pages
+    # 全レコード数。
+    attr_reader :n_records
+
+    # 2ページ以上ある場合は+true+を返す。
     def have_pages?
       @n_pages > 1
     end
 
+    # 最初のページ番号。常に1を返す。
     def first_page
       1
     end
 
+    # 現在のページが最初のページなら+true+を返す。
     def first_page?
       @current_page == first_page
     end
 
+    # 最後のページ番号。
     def last_page
       @n_pages
     end
 
+    # 現在のページが最後のページなら+true+を返す。
     def last_page?
       @current_page == last_page
     end
 
+    # 次のページがあるなら+true+を返す。
     def have_next_page?
       @current_page < @n_pages
     end
 
+    # 次のページ番号を返す。次のページがない場合は+nil+を返
+    # す。
     def next_page
       have_next_page? ? @current_page + 1 : nil
     end
 
+    # 前のページがあるなら+true+を返す。
     def have_previous_page?
       @current_page > 1
     end
 
+    # 前のページ番号を返す。前のページがない場合は+nil+を返
+    # す。
     def previous_page
       have_previous_page? ? @current_page - 1 : nil
     end
 
+    # 1ページあたりのレコード数を返す。
     def n_records_in_page
       size
     end
 
+    # 現在のページに含まれているレコードのうち、先頭のレコー
+    # ドが何番目のレコードかを返す。0ベースではなく1ベースで
+    # あることに注意。つまり、最初のレコードは0番目のレコー
+    # ドではなく、1番目のレコードになる。
+    #
+    # レコードが1つもない場合は+nil+を返す。
     def start_offset
       return nil if @n_records.zero?
       1 + (@current_page - 1) * @page_size
     end
 
+    # 現在のページに含まれているレコードのうち、最後のレコー
+    # ドが何番目のレコードかを返す。0ベースではなく1ベースで
+    # あることに注意。つまり、最初のレコードは0番目のレコー
+    # ドではなく、1番目のレコードになる。
+    #
+    # レコードが1つもない場合は+nil+を返す。
     def end_offset
       return nil if @n_records.zero?
       [start_offset + @page_size - 1, @n_records].min
     end
 
+    # 最初のページから最後のページまでを含んだRangeを返す。
+    #
+    # 例えば、10ページある場合は以下を返す。
+    #   1..10
     def pages
       first_page..last_page
     end

data/lib/groonga/posting.rb

@@ -0,0 +1,87 @@
+# -*- 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 'English'
+
+module Groonga
+  # This class keeps posting information.
+  #
+  # @since 1.2.1
+  class Posting
+    # The record ID.
+    attr_accessor :record_id
+
+    # The section ID.
+    attr_accessor :section_id
+
+    # The term ID.
+    attr_accessor :term_id
+
+    # The position.
+    attr_accessor :position
+
+    # The term frequency.
+    attr_accessor :term_frequency
+
+    # The weight.
+    attr_accessor :weight
+
+    # The number of rest posting information for the term ID.
+    attr_accessor :n_rest_postings
+
+    # Creates a new Posting.
+    #
+    # @return The new Posting.
+    def initialize(parameters=nil)
+      update(parameters || {})
+    end
+
+    # Updates all values.
+    #
+    # @param [Hash] parameters The name and value
+    #   pairs. Omitted names are initialized as the default value.
+    # @option parameters [Integer] :record_id The record_id.
+    # @option parameters [Integer] :section_id The section_id.
+    # @option parameters [Integer] :term_id The term_id.
+    # @option parameters [Integer] :position The position.
+    # @option parameters [Integer] :term_frequency The term_frequency.
+    # @option parameters [Integer] :weight The weight.
+    # @option parameters [Integer] :n_rest_postings The n_rest_postings.
+    def update(parameters)
+      @record_id = parameters[:record_id] || nil
+      @section_id = parameters[:section_id] || nil
+      @term_id = parameters[:term_id] || nil
+      @position = parameters[:position] || 0
+      @term_frequency = parameters[:term_frequency] || 0
+      @weight = parameters[:weight] || 0
+      @n_rest_postings = parameters[:n_rest_postings] || 0
+    end
+
+    # Returns Hash created from attributes.
+    def to_hash
+      {
+        :record_id => @record_id,
+        :section_id => @section_id,
+        :term_id => @term_id,
+        :position => @position,
+        :term_frequency => @term_frequency,
+        :weight => @weight,
+        :n_rest_postings => @n_rest_postings
+      }
+    end
+  end
+end

data/lib/groonga/record.rb

@@ -215,6 +215,15 @@ module Groonga
       self["_score"]
     end
 
+    # call-seq:
+    #   record.support_score? -> true/false
+    #
+    # Groonga::Record#scoreが利用できる場合はtrueを
+    # 返す。
+    def support_score?
+      @table.have_column?("_score") # TODO delegate to Table
+    end
+
     # call-seq:
     #   record.n_sub_records -> 件数
     #
@@ -285,17 +294,8 @@ module Groonga
     # 型のカラムでない全カラムを対象とし、カラムの名前をキーとし
     # たこのレコードのカラムの値のハッシュを返す。
     def attributes
-      attributes = {"id" => id}
-      attributes["key"] = key if support_key?
-      table_name = @table.name
-      columns.each do |column|
-        next if column.is_a?(Groonga::IndexColumn)
-        value = column[@id]
-        # TODO: support recursive reference.
-        value = value.attributes if value.is_a?(Groonga::Record)
-        attributes[column.local_name] = value
-      end
-      attributes
+      accessor = AttributeHashBuilder.new(self)
+      accessor.build
     end
 
     # call-seq:
@@ -408,5 +408,112 @@ module Groonga
         super
       end
     end
+
+    class AttributeHashBuilder # :nodoc:
+      attr_reader :attributes
+
+      def initialize(root_record)
+        @root_record = root_record
+        @built_records = []
+      end
+
+      def build
+        build_attributes(@root_record)
+      end
+
+      private
+      def build_attributes(record)
+        building(record) do
+          attributes = create_attributes(record)
+          add_key(attributes, record)
+          add_score(attributes, record)
+          add_n_sub_records(attributes, record)
+          add_columns(attributes, record)
+
+          attributes
+        end
+      end
+
+      def build_recursive_attributes(record)
+        attributes = create_attributes(record)
+        add_table(attributes, record)
+        add_key(attributes, record)
+
+        attributes
+      end
+
+      def build_value(value)
+        if value.is_a?(Record)
+          if recursive?(value)
+            build_recursive_attributes(value)
+          else
+            build_attributes(value)
+          end
+        else
+          value
+        end
+      end
+
+      def build_vector(vector)
+        vector.collect do |element|
+          build_value(element)
+        end
+      end
+
+      def create_attributes(record)
+        {"_id" => record.id}
+      end
+
+      def add_table(attributes, record)
+        attributes["_table"] = record.table.name
+      end
+
+      def add_columns(attributes, record)
+        record.columns.each do |column|
+          next if column.is_a?(IndexColumn)
+
+          value = column[record.id]
+          attributes[column.local_name] = build_column(column, value)
+        end
+      end
+
+      def build_column(column, value)
+        if column.vector?
+          build_vector(value)
+        else
+          build_value(value)
+        end
+      end
+
+      def add_key(attributes, record)
+        if record.support_key?
+          attributes["_key"] = build_value(record.key)
+        end
+      end
+
+      def add_score(attributes, record)
+        if record.support_score?
+          attributes["_score"] = record.score
+        end
+      end
+
+      def add_n_sub_records(attributes, record)
+        if record.support_sub_records?
+          attributes["_nsubrecs"] = record.n_sub_records
+        end
+      end
+
+      def building(record)
+        @built_records.push(record)
+        returned_object = yield
+        @built_records.pop
+
+        returned_object
+      end
+
+      def recursive?(record)
+        @built_records.include?(record)
+      end
+    end
   end
 end

data/lib/groonga/schema.rb

@@ -57,6 +57,15 @@ module Groonga
       end
     end
 
+    # カラムが存在しないときに発生する。
+    class ColumnNotExists < Error
+      attr_reader :name
+      def initialize(name)
+        @name = name
+        super("column doesn't exist: <#{@name}>")
+      end
+    end
+
     # すでに存在するテーブルと違うオプションでテーブルを作ろ
     # うとしたときに発生する。
     class TableCreationWithDifferentOptions < Error
@@ -467,6 +476,8 @@ module Groonga
         "time" => "Time",
         "date" => "Time",
         "boolean" => "Bool",
+        "delimit" => "TokenDelimit",
+        "token_delimit" => "TokenDelimit",
         "unigram" => "TokenUnigram",
         "token_unigram" => "TokenUnigram",
         "bigram" => "TokenBigram",
@@ -1463,7 +1474,13 @@ module Groonga
         else
           name = @name
         end
-        table.column(name).remove
+        column = table.column(name)
+
+        if column.nil?
+          raise ColumnNotExists.new(name)
+        end
+
+        column.remove
       end
     end