rroonga 2.1.3 → 3.0.0

data/lib/groonga/context.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2010-2012  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-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
@@ -28,22 +28,81 @@ module Groonga
       Database.open(path, options, &block)
     end
 
-    # _path_ に新しくデータベースを作成する。 _path_ を省略すると
-    # 一時データベースとなる。
+    # This is convenience method. It wraps {Groonga::Database.create}
+    # for the context.
     #
-    # @example
-    #   #一時データベースを作成:
-    #   context.create_database
+    # @overload create_database
+    #   Creates a new temproary database for the context.
     #
-    #   #永続データベースを作成:
-    #   context.create_database("/tmp/db.groonga")
-    def create_database(path=nil)
+    #   @return [Groonga::Database] A new temporary database.
+    #
+    #   @example Creating a new temporary database
+    #     temporary_database = context.create_database
+    #
+    # @overload create_database(&block)
+    #   Creates a new temproary database for the context. The database
+    #   is closed after the passed block is finished.
+    #
+    #   @yield [database] Yields a newly created temporary database
+    #     for the context. The database is available only in the
+    #     block.
+    #
+    #   @yieldparam [Groonga::Database] database A newly created
+    #     temporary database for the context.
+    #
+    #   @yieldreturn [Object] The returned value from the block is the
+    #     returned value from this method.
+    #
+    #   @return Returned value from the block.
+    #
+    #   @example Creating a new temporary database with block
+    #     context.create_database do |temporary_database|
+    #       # ...
+    #     end
+    #
+    # @overload create_database(path)
+    #   Creates a new persistent database for the context to the _path_.
+    #
+    #   @param [String] path Database path for a new persistent
+    #     database.
+    #
+    #   @return [Groonga::Database] A new persistent database for the
+    #     context.
+    #
+    #   @example Creating a new persistent database to _"/tmp/db.groonga"_
+    #     database = context.create_database("/tmp/db.groonga")
+    #
+    # @overload create_database(path, &block)
+    #   Creates a new persistent database for the context to the
+    #   _path_. The database is closed after the passed block is
+    #   finished.
+    #
+    #   @param [String] path Database path for a new persistent
+    #     database.
+    #
+    #   @yield [database] Yields a newly created persistent database
+    #     for the context. The database is available only in the
+    #     block.
+    #
+    #   @yieldparam [Groonga::Database] database A newly created
+    #     persistent database for the context.
+    #
+    #   @yieldreturn [Object] The returned value from the block is the
+    #     returned value from this method.
+    #
+    #   @return Returned value from the block.
+    #
+    #   @example Creating a new persistent database to _"/tmp/db.groonga"_ database with block
+    #     context.create_database("/tmp/db.groonga") do |persistent_database|
+    #       # ...
+    #     end
+    def create_database(path=nil, &block)
       options = {:context => self}
       if path
         options[:path] = path
       end
 
-      Database.create(options)
+      Database.create(options, &block)
     end
 
     # groongaのプラグインディレクトリにあるプラグイン _name_
@@ -78,28 +137,49 @@ module Groonga
 
     # Restore commands dumped by "grndump" command.
     #
-    # @example
+    # @example Restore dumped commands.
     #   dumped_commands = File.read("dump.grn")
     #   context.restore(dumped_commands)
     #
+    # If block is given, response is yielded.
+    #
+    # @example Restore dumped commands and reports result.
+    #   dumped_commands = File.read("dump.grn")
+    #   context.restore(dumped_commands) do |command, response|
+    #     puts("#{command} -> #{response}")
+    #   end
+    #
     # @param [String] dumped_commands commands dumped by grndump.
+    # @yield [command, response]
+    #   Yields a sent command and its response if block is given.
+    # @yieldparam command [String] A sent command.
+    # @yieldparam response [String] A response for a command.
+    # @return [void]
     def restore(dumped_commands)
       buffer = ""
+      continued = false
       dumped_commands.each_line do |line|
         line = line.chomp
         case line
         when /\\\z/
+          continued = true
           buffer << $PREMATCH
         else
+          continued = false
           buffer << line
           send(buffer)
-          receive
+          _, response = receive
+          if block_given?
+            not_shared_command = continued ? buffer.dup : line
+            yield(not_shared_command, response)
+          end
           buffer.clear
         end
       end
       unless buffer.empty?
         send(buffer)
-        receive
+        _, response = receive
+        yield(buffer.dup, response) if block_given?
       end
     end
   end

data/rroonga-build.rb

@@ -17,8 +17,8 @@
 
 module RroongaBuild
   module RequiredGroongaVersion
-    MAJOR = 2
-    MINOR = 1
+    MAJOR = 3
+    MINOR = 0
     MICRO = 2
     VERSION = [MAJOR, MINOR, MICRO]
   end

data/test/groonga-test-utils.rb

@@ -15,6 +15,7 @@
 
 require 'fileutils'
 require 'pathname'
+require 'tempfile'
 require 'time'
 require 'erb'
 require 'stringio'
@@ -46,7 +47,7 @@ module GroongaTestUtils
 
   def setup_tmp_directory
     @base_tmp_dir = Pathname(File.dirname(__FILE__)) + "tmp"
-    memory_file_system = "/dev/shm"
+    memory_file_system = "/run/shm"
     if File.exist?(memory_file_system)
       FileUtils.mkdir_p(@base_tmp_dir.parent.to_s)
       FileUtils.rm_f(@base_tmp_dir.to_s)

data/test/test-array.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2012  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
@@ -16,7 +16,7 @@
 class ArrayTest < Test::Unit::TestCase
   include GroongaTestUtils
 
-  setup :setup_database
+  setup :setup_database, :before => :append
 
   def test_support_key?
     assert_not_predicate(Groonga::Array.create(:name => "Users"), :support_key?)
@@ -143,4 +143,88 @@ class ArrayTest < Test::Unit::TestCase
     user_ids = users.each.collect(&:id)
     assert_equal([1, 2, 3], user_ids)
   end
+
+  class TestPushPull < self
+    def setup
+      @queue = Groonga::Array.create(:name => "Queue")
+      @queue.define_column("content", "ShortText")
+    end
+
+    def teardown
+      @queue = nil
+    end
+
+    def test_block?
+      Tempfile.open("output") do |output|
+        Tempfile.open("blocked_pull.rb") do |pull_rb|
+          pull_rb.puts(pull_rb_source(":block? => true"))
+          pull_rb.close
+
+          pid = spawn({}, RbConfig.ruby, pull_rb.path, :out => output.path)
+          sleep(0.5)
+          @queue.push do |record|
+            record.content = "The first record"
+          end
+          Process.waitpid(pid)
+          assert_equal(<<-EXPECTED_OUTPUT, output.read)
+start
+1, The first record
+done
+EXPECTED_OUTPUT
+        end
+      end
+    end
+
+    def test_not_block?
+      Tempfile.open("output") do |output|
+        Tempfile.open("not_blocked_pull.rb") do |pull_rb|
+          pull_rb.puts(pull_rb_source(":block? => false"))
+          pull_rb.close
+
+          pid = spawn({}, RbConfig.ruby, pull_rb.path, :out => output.path)
+          Process.waitpid(pid)
+          assert_equal(<<-EXPECTED_OUTPUT, output.read)
+start
+done
+EXPECTED_OUTPUT
+
+          @queue.push do |record|
+            record.content = "The first record"
+          end
+          pid = spawn({}, RbConfig.ruby, pull_rb.path, :out => output.path)
+          Process.waitpid(pid)
+          output.rewind
+          assert_equal(<<-EXPECTED_OUTPUT, output.read)
+start
+1, The first record
+done
+EXPECTED_OUTPUT
+        end
+      end
+    end
+
+    private
+    def pull_rb_source(options)
+      base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+      <<-CODE
+base_dir = #{base_dir.dump}
+ext_dir = File.join(base_dir, "ext", "groonga")
+lib_dir = File.join(base_dir, "lib")
+
+$LOAD_PATH.unshift(ext_dir)
+$LOAD_PATH.unshift(lib_dir)
+
+require "groonga"
+
+puts("start")
+Groonga::Context.default.open_database(#{@database_path.to_s.dump}) do
+  queue = Groonga["Queue"]
+  queue.pull(#{options}) do |record|
+    puts([record.id, record.content].join(", "))
+  end
+end
+puts("done")
+CODE
+    end
+  end
 end

data/test/test-context.rb

@@ -178,12 +178,32 @@ column_create Items title COLUMN_SCALAR Text
 EOC
     end
 
+    def test_block
+      table_create = "table_create Items TABLE_HASH_KEY --key_type ShortText"
+      column_create = "column_create Items title COLUMN_SCALAR Text"
+      commands = <<-COMMANDS
+#{table_create}
+
+#{column_create}
+COMMANDS
+      responses = []
+      restore(commands) do |command, response|
+        responses << [command.dup, response]
+      end
+      assert_equal([
+                     [table_create, "true"],
+                     ["", ""],
+                     [column_create,"true"]
+                   ],
+                   responses)
+    end
+
     private
-    def restore(commands)
+    def restore(commands, &block)
       restored_db_path = @tmp_dir + "restored.db"
       Groonga::Database.create(:path => restored_db_path.to_s)
 
-      context.restore(commands)
+      context.restore(commands, &block)
     end
 
     def dump