rroonga 3.0.0 → 3.0.1

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

@@ -100,7 +100,7 @@ rb_grn_scan_options (VALUE options, ...)
     VALUE *value;
     va_list args;
 
-    options = rb_check_convert_type(options, T_HASH, "Hash", "to_hash");
+    options = rb_grn_check_convert_to_hash(options);
     if (NIL_P(options)) {
 	if (NIL_P(original_options)) {
 	    options = rb_hash_new();
@@ -153,6 +153,44 @@ rb_grn_equal_option (VALUE option, const char *key)
     return GRN_FALSE;
 }
 
+grn_bool
+rb_grn_equal_string (const char *string1, const char *string2)
+{
+    if (string1 == string2) {
+        return GRN_TRUE;
+    }
+
+    if (!string1 || !string2) {
+        return GRN_FALSE;
+    }
+
+    return strcmp(string1, string2) == 0;
+}
+
+VALUE
+rb_grn_convert_to_array (VALUE object)
+{
+    return rb_convert_type(object, RUBY_T_ARRAY, "Array", "to_ary");
+}
+
+VALUE
+rb_grn_check_convert_to_string (VALUE object)
+{
+    return rb_check_string_type(object);
+}
+
+VALUE
+rb_grn_check_convert_to_array (VALUE object)
+{
+    return rb_check_array_type(object);
+}
+
+VALUE
+rb_grn_check_convert_to_hash (VALUE object)
+{
+    return rb_check_convert_type(object, RUBY_T_HASH, "Hash", "to_hash");
+}
+
 static VALUE
 rb_grn_bulk_to_ruby_object_by_range_id (grn_ctx *context, grn_obj *bulk,
 					grn_id range_id,
@@ -586,34 +624,87 @@ rb_grn_vector_to_ruby_object (grn_ctx *context, grn_obj *vector)
     return array;
 }
 
-grn_obj *
-rb_grn_vector_from_ruby_object (VALUE object, grn_ctx *context, grn_obj *vector)
+static void
+rb_grn_add_vector_element (VALUE rb_element, grn_ctx *context, grn_obj *vector,
+                           grn_obj *value_buffer)
 {
-    VALUE *values;
-    grn_obj value;
+    unsigned int weight = 0;
+    if (RVAL2CBOOL(rb_obj_is_kind_of(rb_element, rb_cHash))) {
+        VALUE rb_value;
+        VALUE rb_weight;
+        ID id_value;
+        ID id_weight;
+        CONST_ID(id_value, "value");
+        CONST_ID(id_weight, "weight");
+        rb_value = rb_hash_aref(rb_element, ID2SYM(id_value));
+        rb_weight = rb_hash_aref(rb_element, ID2SYM(id_weight));
+        RVAL2GRNOBJ(rb_value, context, &value_buffer);
+        if (!NIL_P(rb_weight)) {
+            weight = NUM2UINT(rb_weight);
+        }
+    } else {
+        RVAL2GRNOBJ(rb_element, context, &value_buffer);
+    }
+    grn_vector_add_element(context, vector,
+                           GRN_BULK_HEAD(value_buffer),
+                           GRN_BULK_VSIZE(value_buffer),
+                           weight,
+                           value_buffer->header.domain);
+}
+
+typedef struct {
+    VALUE array;
+    grn_ctx *context;
+    grn_obj *vector;
+    grn_obj value_buffer;
+} VectorFromRubyData;
+
+static VALUE
+rb_grn_vector_from_ruby_object_body (VALUE user_data)
+{
+    VectorFromRubyData *data = (VectorFromRubyData *)user_data;
+    VALUE *rb_values;
+    grn_ctx *context;
+    grn_obj *vector;
+    grn_obj *value_buffer;
     int i, n;
 
-    if (vector)
-	GRN_OBJ_INIT(vector, GRN_VECTOR, 0, GRN_ID_NIL);
-    else
-	vector = grn_obj_open(context, GRN_VECTOR, 0, 0);
+    n = RARRAY_LEN(data->array);
+    rb_values = RARRAY_PTR(data->array);
+    context = data->context;
+    vector = data->vector;
+    value_buffer = &(data->value_buffer);
+    for (i = 0; i < n; i++) {
+        rb_grn_add_vector_element(rb_values[i], context, vector, value_buffer);
+    }
+
+    return Qnil;
+}
+
+static VALUE
+rb_grn_vector_from_ruby_object_ensure (VALUE user_data)
+{
+    VectorFromRubyData *data = (VectorFromRubyData *)user_data;
+
+    GRN_OBJ_FIN(data->context, &(data->value_buffer));
+
+    return Qnil;
+}
+
+grn_obj *
+rb_grn_vector_from_ruby_object (VALUE object, grn_ctx *context, grn_obj *vector)
+{
+    VectorFromRubyData data;
 
     if (NIL_P(object))
 	return vector;
 
-    GRN_VOID_INIT(&value);
-    n = RARRAY_LEN(object);
-    values = RARRAY_PTR(object);
-    for (i = 0; i < n; i++) {
-	grn_obj *_value = &value;
-	RVAL2GRNOBJ(values[i], context, &_value);
-	grn_vector_add_element(context, vector,
-			       GRN_BULK_HEAD(&value),
-			       GRN_BULK_VSIZE(&value),
-			       0,
-			       value.header.domain);
-    }
-    GRN_OBJ_FIN(context, &value);
+    data.array = rb_grn_convert_to_array(object);
+    data.context = context;
+    data.vector = vector;
+    GRN_VOID_INIT(&(data.value_buffer));
+    rb_ensure(rb_grn_vector_from_ruby_object_body,   (VALUE)(&data),
+              rb_grn_vector_from_ruby_object_ensure, (VALUE)(&data));
 
     return vector;
 }

data/ext/groonga/rb-grn.h

@@ -76,7 +76,7 @@ RB_GRN_BEGIN_DECLS
 
 #define RB_GRN_MAJOR_VERSION 3
 #define RB_GRN_MINOR_VERSION 0
-#define RB_GRN_MICRO_VERSION 0
+#define RB_GRN_MICRO_VERSION 1
 
 #define RB_GRN_QUERY_DEFAULT_MAX_EXPRESSIONS 32
 
@@ -319,6 +319,12 @@ void           rb_grn_scan_options                  (VALUE options, ...)
                                                      RB_GRN_GNUC_NULL_TERMINATED;
 grn_bool       rb_grn_equal_option                  (VALUE option,
 						     const char *key);
+grn_bool       rb_grn_equal_string                  (const char *string1,
+                                                     const char *string2);
+VALUE          rb_grn_convert_to_array              (VALUE object);
+VALUE          rb_grn_check_convert_to_string       (VALUE object);
+VALUE          rb_grn_check_convert_to_array        (VALUE object);
+VALUE          rb_grn_check_convert_to_hash         (VALUE object);
 
 VALUE          rb_grn_object_alloc                  (VALUE klass);
 void           rb_grn_object_bind                   (VALUE self,

data/lib/groonga.rb

@@ -15,14 +15,14 @@
 # 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 'pathname'
+require "pathname"
 
 base_dir = Pathname.new(__FILE__).dirname.dirname.expand_path
 local_groonga_dir = base_dir + "vendor" + "local"
 local_groonga_bin_dir = local_groonga_dir + "bin"
 if local_groonga_bin_dir.exist?
   prepend_path = Proc.new do |environment_name, separator|
-    paths = (ENV[environment_name] || '').split(/#{separator}/)
+    paths = (ENV[environment_name] || "").split(/#{separator}/)
     dir = local_groonga_bin_dir.to_s
     dir = dir.gsub(/\//, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
     unless paths.include?(dir)
@@ -34,16 +34,16 @@ if local_groonga_bin_dir.exist?
   prepend_path.call("PATH", File::PATH_SEPARATOR)
 end
 
-require 'groonga/geo-point'
-require 'groonga/view-record'
-require 'groonga/record'
-require 'groonga/expression-builder'
-require 'groonga/posting'
+require "groonga/geo-point"
+require "groonga/view-record"
+require "groonga/record"
+require "groonga/expression-builder"
+require "groonga/posting"
 begin
   major, minor, _ = RUBY_VERSION.split(/\./)
   require "#{major}.#{minor}/groonga.so"
 rescue LoadError
-  require 'groonga.so'
+  require "groonga.so"
 end
 
 ##
@@ -90,13 +90,13 @@ module Groonga
   end
 end
 
-require 'groonga/context'
-require 'groonga/database'
-require 'groonga/patricia-trie'
-require 'groonga/index-column'
-require 'groonga/dumper'
-require 'groonga/schema'
-require 'groonga/pagination'
-require 'groonga/grntest-log'
-require 'groonga/logger'
-require 'groonga/query-logger'
+require "groonga/context"
+require "groonga/database"
+require "groonga/patricia-trie"
+require "groonga/index-column"
+require "groonga/dumper"
+require "groonga/schema"
+require "groonga/pagination"
+require "groonga/grntest-log"
+require "groonga/logger"
+require "groonga/query-logger"

data/lib/groonga/context.rb

@@ -137,11 +137,16 @@ module Groonga
 
     # Restore commands dumped by "grndump" command.
     #
-    # @example Restore dumped commands.
+    # @example Restore dumped commands as a String object.
     #   dumped_commands = File.read("dump.grn")
     #   context.restore(dumped_commands)
     #
-    # If block is given, response is yielded.
+    # @example Restore dumped commands from a File object.
+    #   File.open("dump.grn") do |file|
+    #     context.restore(file)
+    #   end
+    #
+    # If block is given, a response is yielded.
     #
     # @example Restore dumped commands and reports result.
     #   dumped_commands = File.read("dump.grn")
@@ -149,7 +154,10 @@ module Groonga
     #     puts("#{command} -> #{response}")
     #   end
     #
-    # @param [String] dumped_commands commands dumped by grndump.
+    # @param [#each_line] dumped_commands commands dumped by grndump.
+    #   It can be a String object or any objects like an IO object such
+    #   as a File object. It should have #each_line that iterates a
+    #   line.
     # @yield [command, response]
     #   Yields a sent command and its response if block is given.
     # @yieldparam command [String] A sent command.

data/lib/groonga/logger.rb

@@ -42,6 +42,32 @@ module Groonga
       end
     end
 
+    class << self
+      # @deprecated since 3.0.1. Use {Groonga::Logger.path}
+      #   instead.
+      def log_path
+        path
+      end
+
+      # @deprecated since 3.0.1. Use {Groonga::Logger.path=}
+      #   instead.
+      def log_path=(path)
+        self.path = path
+      end
+
+      # @deprecated since 3.0.1. Use {Groonga::QueryLogger.path}
+      #   instead.
+      def query_log_path
+        QueryLogger.path
+      end
+
+      # @deprecated since 3.0.1. Use {Groonga::QueryLogger.path=}
+      #   instead.
+      def query_log_path=(path)
+        QueryLogger.path = path
+      end
+    end
+
     def log(level, timestamp, title, message, location)
       guard do
         puts("#{timestamp}|#{mark(level)}|#{title} #{message} #{location}")

data/lib/groonga/record.rb

@@ -32,6 +32,9 @@ module Groonga
     #  ...,
     # ]
     # </pre>
+    #
+    # Each value is set by {#[]=}. See {#[]=} how to set weight for a
+    # value.
     def initialize(table, id, values=nil)
       @table = table
       @id = id
@@ -67,8 +70,28 @@ module Groonga
       @table.column_value(@id, column_name, :id => true)
     end
 
-    # このレコードの _column_name_ で指定されたカラムの値を設定す
-    # る。
+    # Sets column value of the record.
+    #
+    # @overload []=(column_name, value)
+    #   @param column_name [String] The column name.
+    #   @param value [Object] The column value. Weight of the value is 0.
+    #
+    #   @example Set a new value
+    #     user["age"] = 29
+    #
+    # @overload []=(column_name, value_with_weight)
+    #   @param column_name [String] The column name.
+    #   @param value_with_weight [::Hash] The column value with weight.
+    #   @option value_with_weight [Object] :value (nil) The column value.
+    #   @option value_with_weight [Integer or nil] :weight (nil)
+    #     The weight for the value. You need to use vector column and
+    #     weight supported index column for weight. See
+    #     {Groonga;:Table#set_column_value} for details.
+    #
+    #   @example Set a new value with weight "2"
+    #     user["tags"] = [{:value => "groonga", :weight => 2}]
+    #
+    # @see Groonga::Table#set_column_value
     def []=(column_name, value)
       @table.set_column_value(@id, column_name, value, :id => true)
     end

data/rroonga-build.rb

@@ -19,7 +19,7 @@ module RroongaBuild
   module RequiredGroongaVersion
     MAJOR = 3
     MINOR = 0
-    MICRO = 2
+    MICRO = 3
     VERSION = [MAJOR, MINOR, MICRO]
   end
 

data/rroonga.gemspec

@@ -88,7 +88,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rake-compiler")
   s.add_development_dependency("bundler")
   s.add_development_dependency("yard")
-  s.add_development_dependency("packnga")
+  s.add_development_dependency("packnga", [">= 0.9.7"])
   s.add_development_dependency("RedCloth")
 end
 

data/test/test-column.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2011  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2009-2013  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
@@ -347,4 +347,106 @@ class ColumnTest < Test::Unit::TestCase
     @posts.add("Hello!", :body => "World")
     @posts.add("My Hobby", :body => "Drive and Eat")
   end
+
+  class WeightTest < self
+    def setup
+      super
+      setup_schema
+    end
+
+    def setup_schema
+      Groonga::Schema.define do |schema|
+        schema.create_table("Shops", :type => :hash) do |table|
+          table.short_text("tags", :type => :vector)
+        end
+
+        schema.create_table("Tags",
+                            :type => :patricia_trie) do |table|
+          table.index("Shops.tags", :with_weight => true)
+        end
+      end
+
+      @shops = Groonga["Shops"]
+    end
+
+    def test_vector
+      @shops.add("Soul Food India",
+                 :tags => [
+                   {:value => "curry", :weight => 10},
+                   {:value => "hot",   :weight => 3},
+                 ])
+      assert_equal([["Soul Food India", 11]],
+                   select_by_tag("curry"))
+    end
+
+    def test_offline_index
+      @shops.add("Soul Food India",
+                 :tags => [
+                   {:value => "curry", :weight => 10},
+                   {:value => "hot",   :weight => 3},
+                 ])
+      Groonga::Schema.remove_column("Tags", "Shops_tags")
+      Groonga::Schema.change_table("Tags") do |table|
+        table.index("Shops.tags", :with_weight => true)
+      end
+
+      assert_equal([["Soul Food India", 11]],
+                   select_by_tag("curry"))
+    end
+
+    private
+    def select_by_tag(tag)
+      matched_records = @shops.select do |record|
+        record.tags =~ tag
+      end
+      matched_records.collect do |record|
+        [record._key, record.score]
+      end
+    end
+
+    class UpdateTest < self
+      def test_new_value
+        record = @shops.add("Soul Food India",
+                            :tags => [
+                              {:value => "curry", :weight => 10},
+                              {:value => "hot",   :weight => 3},
+                            ])
+        new_value = "india"
+        new_value_weight = 100
+        record.tags = [
+          {:value => new_value, :weight => new_value_weight},
+        ]
+        assert_equal([["Soul Food India", new_value_weight + 1]],
+                     select_by_tag(new_value))
+      end
+
+      def test_old_value
+        old_value = "curry"
+        record = @shops.add("Soul Food India",
+                            :tags => [
+                              {:value => old_value, :weight => 10},
+                              {:value => "hot",     :weight => 3},
+                            ])
+        record.tags = [
+          {:value => "india", :weight => 100},
+        ]
+        assert_equal([], select_by_tag(old_value))
+      end
+
+      def test_replaced_value
+        replaced_value = "hot"
+        record = @shops.add("Soul Food India",
+                            :tags => [
+                              {:value => "curry",        :weight => 10},
+                              {:value => replaced_value, :weight => 3},
+                            ])
+        replaced_value_weight = 100
+        record.tags = [
+          {:value => replaced_value, :weight => replaced_value_weight},
+        ]
+        assert_equal([["Soul Food India", replaced_value_weight + 1]],
+                     select_by_tag(replaced_value))
+      end
+    end
+  end
 end