groonga-client 0.3.3 → 0.3.4

data/lib/groonga/client/response/schema.rb

@@ -102,31 +102,31 @@ module Groonga
           end
         end
 
-        class Type < Hash
+        class Type < ::Hash
           include Hashie::Extensions::MethodAccess
         end
 
-        class Tokenizer < Hash
+        class Tokenizer < ::Hash
           include Hashie::Extensions::MethodAccess
         end
 
-        class Normalizer < Hash
+        class Normalizer < ::Hash
           include Hashie::Extensions::MethodAccess
         end
 
-        class TokenFilter < Hash
+        class TokenFilter < ::Hash
           include Hashie::Extensions::MethodAccess
         end
 
-        class KeyType < Hash
+        class KeyType < ::Hash
           include Hashie::Extensions::MethodAccess
         end
 
-        class ValueType < Hash
+        class ValueType < ::Hash
           include Hashie::Extensions::MethodAccess
         end
 
-        class Index < Hash
+        class Index < ::Hash
           include Hashie::Extensions::MethodAccess
 
           def initialize(schema, raw_index)
@@ -155,13 +155,17 @@ module Groonga
             end
           end
 
+          def full_text_searchable?
+            table.tokenizer and column.position
+          end
+
           private
           def coerce_table(table_name)
             @schema.tables[table_name]
           end
         end
 
-        class Column < Hash
+        class Column < ::Hash
           include Hashie::Extensions::MethodAccess
 
           def initialize(schema, raw_column)
@@ -181,6 +185,12 @@ module Groonga
             end
           end
 
+          def have_full_text_search_index?
+            indexes.any? do |index|
+              index.full_text_searchable?
+            end
+          end
+
           private
           def coerce_indexes(raw_indexes)
             raw_indexes.collect do |raw_index|
@@ -189,7 +199,7 @@ module Groonga
           end
         end
 
-        class Table < Hash
+        class Table < ::Hash
           include Hashie::Extensions::MethodAccess
 
           def initialize(schema)
@@ -214,6 +224,12 @@ module Groonga
             end
           end
 
+          def have_full_text_search_index?
+            indexes.any? do |index|
+              index.full_text_searchable?
+            end
+          end
+
           private
           def coerce_key_type(raw_key_type)
             if raw_key_type.nil?

data/lib/groonga/client/response/select.rb

@@ -1,5 +1,6 @@
 # Copyright (C) 2013-2016  Kouhei Sutou <kou@clear-code.com>
 # Copyright (C) 2013  Kosuke Asami
+# Copyright (C) 2016  Masafumi Yokoyama <yokoyama@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
@@ -23,9 +24,13 @@ module Groonga
       class Select < Base
         Response.register("select", self)
 
+        include Enumerable
+
         # @return [Integer] The number of records that match againt
         #   a search condition.
         attr_accessor :n_hits
+        # For Kaminari
+        alias_method :total_count, :n_hits
         attr_accessor :records
 
         # @return [::Array<Groonga::Client::Response::Select::Drilldown>,
@@ -37,19 +42,51 @@ module Groonga
         #   Otherwise, `[drilldown1, drilldown2]` is returned.
         attr_accessor :drilldowns
 
+        # @return [::Hash<String, Groonga::Client::Response::Select::Slice>]
+        #
+        # @since 0.3.4
+        attr_accessor :slices
+
         def body=(body)
           super(body)
           parse_body(body)
         end
 
+        # For Kaminari
+        def limit_value
+          (@command[:limit] || 10).to_i
+        end
+
+        # For Kaminari
+        def offset_value
+          (@command[:offset] || 0).to_i
+        end
+
+        # For Kaminari
+        def size
+          records.size
+        end
+
+        def each(&block)
+          records.each(&block)
+        end
+
         private
         def parse_body(body)
           if body.is_a?(::Array)
             @n_hits, @records = parse_match_records_v1(body.first)
-            @drilldowns = parse_drilldowns_v1(body[1..-1])
+            if @command.slices.empty?
+              raw_slices = nil
+              raw_drilldowns = body[1..-1]
+            else
+              raw_slices, *raw_drilldowns = body[1..-1]
+            end
+            @slices = parse_slices_v1(raw_slices)
+            @drilldowns = parse_drilldowns_v1(raw_drilldowns)
           else
             @n_hits, @records = parse_match_records_v3(body)
             @drilldowns = parse_drilldowns_v3(body["drilldowns"])
+            @slices = parse_slices_v3(body["slices"])
           end
           body
         end
@@ -74,7 +111,7 @@ module Groonga
           end
 
           (raw_records || []).collect do |raw_record|
-            record = {}
+            record = Record.new
             columns.each_with_index do |(name, type), i|
               record[name] = convert_value(raw_record[i], type)
             end
@@ -139,10 +176,35 @@ module Groonga
           drilldowns
         end
 
+        def parse_slices_v1(raw_slices)
+          slices = {}
+          (raw_slices || {}).each do |key, raw_slice|
+            n_hits, records = parse_match_records_v1(raw_slice)
+            slices[key] = Slice.new(key, n_hits, records)
+          end
+          slices
+        end
+
+        def parse_slices_v3(raw_slices)
+          slices = {}
+          (raw_slices || {}).each do |key, raw_slice|
+            n_hits, records = parse_match_records_v3(raw_slice)
+            slices[key] = Slice.new(key, n_hits, records)
+          end
+          slices
+        end
+
+        class Record < ::Hash
+          include Hashie::Extensions::MethodAccess
+        end
+
         class Drilldown < Struct.new(:key, :n_hits, :records)
           # @deprecated since 0.2.6. Use {#records} instead.
           alias_method :items, :records
         end
+
+        class Slice < Struct.new(:key, :n_hits, :records)
+        end
       end
     end
   end

data/lib/groonga/client/spec-helper.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2016  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 as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga/client/test/fixture"
+
+module Groonga
+  class Client
+    module SpecHelper
+      include Test::Fixture
+
+      class << self
+        def included(target)
+          target.before(:each) do
+            setup_groonga
+          end
+
+          target.after(:each) do
+            teardown_groonga
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/test-helper.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2016  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 as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga/client/test/fixture"
+
+module Groonga
+  class Client
+    module TestHelper
+      include Test::Fixture
+
+      class << self
+        def included(target)
+          target.setup do
+            setup_groonga
+          end
+
+          target.teardown do
+            teardown_groonga
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/test/fixture.rb

@@ -0,0 +1,35 @@
+# Copyright (C) 2016  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 as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga/client/test/groonga-server-runner"
+
+module Groonga
+  class Client
+    module Test
+      module Fixture
+        def setup_groonga
+          @groonga_server_runner = GroongaServerRunner.new
+          @groonga_server_runner.run
+        end
+
+        def teardown_groonga
+          return if @groonga_server_runner.nil?
+          @groonga_server_runner.stop
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/test/groonga-server-runner.rb

@@ -0,0 +1,158 @@
+# Copyright (C) 2016  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 as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "rbconfig"
+require "fileutils"
+
+module Groonga
+  class Client
+    module Test
+      class GroongaServerRunner
+        def initialize
+          @pid = nil
+          @using_running_server = false
+          @url = build_url
+          @groonga = find_groonga
+          @tmp_dir = nil
+        end
+
+        def run
+          if groonga_server_running?
+            @using_running_server = true
+          else
+            return if @groonga.nil?
+            @tmp_dir = create_tmp_dir
+            db_path = @tmp_dir + "db"
+            @pid = spawn(@groonga,
+                         "--port", @url.port.to_s,
+                         "--log-path", (@tmp_dir + "groonga.log").to_s,
+                         "--query-log-path", (@tmp_dir + "query.log").to_s,
+                         "--protocol", "http",
+                         "-s",
+                         "-n", db_path.to_s)
+            wait_groonga_ready
+          end
+        end
+
+        def stop
+          if @using_running_server
+            Groonga::Client.open(url: @url) do |client|
+              schema = client.schema
+              schema.tables.each do |name, _|
+                client.delete(table: name,
+                              filter: "true")
+              end
+            end
+          else
+            if @pid
+              Groonga::Client.open(url: @url) do |client|
+                client.shutdown
+              end
+              wait_groonga_shutdown
+            end
+            if @tmp_dir
+              FileUtils.rm_rf(@tmp_dir)
+            end
+          end
+        end
+
+        private
+        def build_url
+          default_options = Groonga::Client.default_options
+          url = default_options[:url]
+          if url.nil?
+            host = default_options[:host] ||
+              default_options[:address] ||
+              "127.0.0.1"
+            port = default_options[:port] || 10041
+            path = default_options[:path]
+            url = URI("http://#{host}:#{port}#{path}")
+          end
+          url
+        end
+
+        def groonga_server_running?
+          begin
+            TCPSocket.open(@url.host, @url.port) do
+            end
+          rescue SystemCallError
+            false
+          else
+            true
+          end
+        end
+
+        def find_groonga
+          paths = ENV["PATH"].split(File::PATH_SEPARATOR)
+          exeext = RbConfig::CONFIG["EXEEXT"]
+          paths.each do |path|
+            groonga = File.join(path, "groonga#{exeext}")
+            return groonga if File.executable?(groonga)
+          end
+          nil
+        end
+
+        def create_tmp_dir
+          tmpfs_dir = "/dev/shm"
+          if File.directory?(tmpfs_dir)
+            base_tmp_dir = Pathname(tmpfs_dir)
+          else
+            base_tmp_dir = Pathname("tmp")
+          end
+          tmp_dir = base_tmp_dir + "groonga-client.#{Process.pid}"
+          FileUtils.rm_rf(tmp_dir)
+          FileUtils.mkdir_p(tmp_dir)
+          tmp_dir
+        end
+
+        def wait_groonga_ready
+          n_retried = 0
+          while n_retried <= 20
+            n_retried += 1
+            sleep(0.05)
+            if groonga_server_running?
+              break
+            else
+              begin
+                pid = Process.waitpid(@pid, Process::WNOHANG)
+              rescue SystemCallError
+                @pid = nil
+                break
+              end
+            end
+          end
+        end
+
+        def wait_groonga_shutdown
+          # TODO: Remove me when Groonga 6.0.1 has been released.
+          # Workaround to shutdown as soon as possible.
+          groonga_server_running?
+
+          n_retried = 0
+          while n_retried <= 20
+            n_retried += 1
+            sleep(0.05)
+            pid = Process.waitpid(@pid, Process::WNOHANG)
+            return if pid
+          end
+
+          Process.kill(:KILL, @pid)
+          Process.waitpid(@pid)
+        end
+      end
+    end
+  end
+end