groonga-client 0.5.4 → 0.5.5

data/lib/groonga/client/command-line/groonga-client.rb

@@ -14,26 +14,19 @@
 # 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 "optparse"
 require "json"
 require "securerandom"
 
-require "groonga/client"
-
 require "groonga/command/parser"
 
+require "groonga/client"
+require "groonga/client/command-line/parser"
+
 module Groonga
   class Client
     module CommandLine
       class GroongaClient
         def initialize
-          @url      = nil
-          @protocol = :http
-          @host     = "localhost"
-          @port     = nil
-
-          @read_timeout = Client::Default::READ_TIMEOUT
-
           @chunk = false
 
           @runner_options = {
@@ -42,16 +35,13 @@ module Groonga
           }
         end
 
-        def run(argv)
-          command_file_paths = parse_command_line(argv)
+        def run(arguments)
+          parser = Parser.new
+          command_file_paths = parser.parse(arguments) do |option_parser|
+            parse_command_line(option_parser)
+          end
 
-          Client.open(:url      => @url,
-                      :protocol => @protocol,
-                      :host     => @host,
-                      :port     => @port,
-                      :read_timeout => @read_timeout,
-                      :chunk    => @chunk,
-                      :backend  => :synchronous) do |client|
+          parser.open_client(:chunk => @chunk) do |client|
             runner = Runner.new(client, @runner_options)
 
             if command_file_paths.empty?
@@ -79,48 +69,11 @@ module Groonga
         end
 
         private
-        def parse_command_line(argv)
-          parser = OptionParser.new
-          parser.version = VERSION
+        def parse_command_line(parser)
           parser.banner += " GROONGA_COMMAND_FILE1 GROONGA_COMMAND_FILE2 ..."
 
           parser.separator("")
-
-          parser.separator("Connection:")
-
-          parser.on("--url=URL",
-                    "URL to connect to Groonga server.",
-                    "If this option is specified,",
-                    "--protocol, --host and --port are ignored.") do |url|
-            @url = url
-          end
-
-          available_protocols = [:http, :gqtp]
-          parser.on("--protocol=PROTOCOL", [:http, :gqtp],
-                    "Protocol to connect to Groonga server.",
-                    "[#{available_protocols.join(", ")}]",
-                    "(#{@protocol})") do |protocol|
-            @protocol = protocol
-          end
-
-          parser.on("--host=HOST",
-                    "Groonga server to be connected.",
-                    "(#{@host})") do |host|
-            @host = host
-          end
-
-          parser.on("--port=PORT", Integer,
-                    "Port number of Groonga server to be connected.",
-                    "(auto)") do |port|
-            @port = port
-          end
-
-          parser.on("--read-timeout=TIMEOUT", Integer,
-                    "Timeout on reading response from Groonga server.",
-                    "You can disable timeout by specifying -1.",
-                    "(#{@read_timeout})") do |timeout|
-            @read_timeout = timeout
-          end
+          parser.separator("Request:")
 
           parser.on("--split-load-chunk-size=SIZE", Integer,
                     "Split a large load to small loads.",
@@ -142,21 +95,6 @@ module Groonga
                     "(#{@chunk})") do |boolean|
             @chunk = boolean
           end
-
-          command_file_paths = parser.parse(argv)
-
-          @port ||= default_port(@protocol)
-
-          command_file_paths
-        end
-
-        def default_port(protocol)
-          case protocol
-          when :http
-            10041
-          when :gqtp
-            10043
-          end
         end
 
         class Runner

data/lib/groonga/client/command-line/parser.rb

@@ -0,0 +1,111 @@
+# Copyright (C) 2015-2017  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 "optparse"
+
+require "groonga/client"
+
+module Groonga
+  class Client
+    module CommandLine
+      class Parser
+        def initialize(options={})
+          @url      = nil
+          @protocol = :http
+          @host     = "localhost"
+          @port     = nil
+
+          @read_timeout = options[:read_timeout] || Client::Default::READ_TIMEOUT
+        end
+
+        def parse(arguments)
+          parser = OptionParser.new
+          parser.version = VERSION
+
+          parser.separator("")
+
+          parser.separator("Connection:")
+
+          parser.on("--url=URL",
+                    "URL to connect to Groonga server.",
+                    "If this option is specified,",
+                    "--protocol, --host and --port are ignored.") do |url|
+            @url = url
+          end
+
+          available_protocols = [:http, :gqtp]
+          parser.on("--protocol=PROTOCOL", [:http, :gqtp],
+                    "Protocol to connect to Groonga server.",
+                    "[#{available_protocols.join(", ")}]",
+                    "(#{@protocol})") do |protocol|
+            @protocol = protocol
+          end
+
+          parser.on("--host=HOST",
+                    "Groonga server to be connected.",
+                    "(#{@host})") do |host|
+            @host = host
+          end
+
+          parser.on("--port=PORT", Integer,
+                    "Port number of Groonga server to be connected.",
+                    "(auto)") do |port|
+            @port = port
+          end
+
+          parser.on("--read-timeout=TIMEOUT", Integer,
+                    "Timeout on reading response from Groonga server.",
+                    "You can disable timeout by specifying -1.",
+                    "(#{@read_timeout})") do |timeout|
+            @read_timeout = timeout
+          end
+
+          yield(parser)
+
+          rest = parser.parse(arguments)
+
+          @port ||= default_port(@protocol)
+
+          rest
+        end
+
+        def open_client(options={})
+          default_options = {
+            :url      => @url,
+            :protocol => @protocol,
+            :host     => @host,
+            :port     => @port,
+            :read_timeout => @read_timeout,
+            :backend  => :synchronous,
+          }
+          Client.open(default_options.merge(options)) do |client|
+            yield(client)
+          end
+        end
+
+        private
+        def default_port(protocol)
+          case protocol
+          when :http
+            10041
+          when :gqtp
+            10043
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/command-line/runner.rb

@@ -0,0 +1,122 @@
+# Copyright (C) 2017  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
+
+module Groonga
+  class Client
+    module CommandLine
+      class Runner
+        def initialize(client)
+          @client = client
+        end
+
+        def run(&block)
+          catch do |tag|
+            @abort_tag = tag
+            run_internal(&block)
+          end
+        end
+
+        private
+        def abort_run(message)
+          $stderr.puts(message)
+          throw(@abort_tag, false)
+        end
+
+        def execute_command(name, arguments={})
+          response = @client.execute(name, arguments)
+          unless response.success?
+            abort_run("Failed to run #{name}: #{response.inspect}")
+          end
+          response
+        end
+
+        def config_get(key)
+          execute_command(:config_get, :key => key).body
+        end
+
+        def config_set(key, value)
+          execute_command(:config_set, :key => key, :value => value).body
+        end
+
+        def object_exist?(name)
+          execute_command(:object_exist, :name => name).body
+        end
+
+        def table_list
+          execute_command(:table_list)
+        end
+
+        def column_list(table)
+          execute_command(:column_list, :table => table)
+        end
+
+        def column_create(table_name, name, flags, type, source)
+          execute_command(:column_create,
+                          :table => table_name,
+                          :name => name,
+                          :flags => flags,
+                          :type => type,
+                          :source => source).body
+        end
+
+        def column_create_similar(table_name, column_name, base_column_name)
+          if object_exist?(:schema)
+            info = execute_command(:schema)["#{table_name}.#{base_column_name}"]
+            arguments = info.command.arguments.merge("name" => column_name)
+            execute_command(:column_create, arguments).body
+          else
+            base_column = column_list(table_name).find do |column|
+              column.name == base_column_name
+            end
+            range = base_column.range
+            source_columns = base_column.sources.collect do |source|
+              if source.include?(".")
+                source.split(".", 2)[1]
+              else
+                "_key"
+              end
+            end
+            flags = base_column.flags.dup
+            flags.delete("PERSISTENT")
+            column_create(table_name,
+                          column_name,
+                          flags.join("|"),
+                          range,
+                          source_columns.join(","))
+          end
+        end
+
+        def column_remove(table, column)
+          execute_command(:column_remove,
+                          :table => table,
+                          :name => column).body
+        end
+
+        def column_rename(table, name, new_name)
+          execute_command(:column_rename,
+                          :table => table,
+                          :name => name,
+                          :new_name => new_name).body
+        end
+
+        def select(table, arguments={})
+          execute_command(:select,
+                          arguments.merge(:table => table))
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/protocol/http/synchronous.rb

@@ -27,6 +27,27 @@ module Groonga
     module Protocol
       class HTTP
         class Synchronous
+          # TODO: Workaround to disable retry in net/http.
+          class HTTPClient < Net::HTTP
+            class ReadTimeout < StandardError
+            end
+
+            module ReadTimeoutConvertable
+              def rbuf_fill
+                begin
+                  super
+                rescue Net::ReadTimeout => error
+                  raise ReadTimeout, error.message, error.backtrace
+                end
+              end
+            end
+
+            private
+            def on_connect
+              @socket.extend(ReadTimeoutConvertable)
+            end
+          end
+
           include PathResolvable
 
           def initialize(url, options={})
@@ -36,7 +57,7 @@ module Groonga
 
           def send(command)
             begin
-              Net::HTTP.start(@url.host, @url.port, start_options) do |http|
+              HTTPClient.start(@url.host, @url.port, start_options) do |http|
                 http.read_timeout = read_timeout
                 response = send_request(http, command)
                 case response

data/lib/groonga/client/response/column-list.rb

@@ -64,6 +64,14 @@ module Groonga
                                   :domain,
                                   :range,
                                   :source)
+          # @return [String]
+          #   The column name with table name such as `TABLE.COLUMN`.
+          #
+          # @since 0.5.4
+          def full_name
+            "#{domain}.#{name}"
+          end
+
           # @return [::Array<String>]
           #   The flag names of the column.
           #
@@ -95,6 +103,8 @@ module Groonga
           def index?
             flags.include?("COLUMN_INDEX")
           end
+
+          alias_method :sources, :source
         end
       end
     end

data/lib/groonga/client/version.rb

@@ -16,6 +16,6 @@
 
 module Groonga
   class Client
-    VERSION = "0.5.4"
+    VERSION = "0.5.5"
   end
 end

data/test/command-line/helper.rb

@@ -0,0 +1,87 @@
+# Copyright (C) 2017  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/command/parser"
+
+require "groonga/client"
+require "groonga/client/test-helper"
+
+module CommandLineTestHelper
+  def groonga_url
+    @groonga_server_runner.url.to_s
+  end
+
+  def open_client
+    Groonga::Client.open(:url => groonga_url) do |client|
+      yield(client)
+    end
+  end
+
+  def restore(commands)
+    open_client do |client|
+      values = nil
+      Groonga::Command::Parser.parse(commands) do |event, *args|
+        case event
+        when :on_command
+          command, = args
+          response = client.execute(command)
+          unless response.success?
+            raise Groonga::Client::Request::ErrorResponse.new(response)
+          end
+        when :on_load_start
+          command, = args
+          values = []
+        when :on_load_columns
+          command, columns = args
+          command[:columns] ||= columns.join(",")
+        when :on_load_value
+          command, value = args
+          values << value
+        when :on_load_complete
+          command, = args
+          command[:values] ||= JSON.generate(values)
+          response = client.execute(command)
+          unless response.success?
+            raise Groonga::Client::Request::ErrorResponse.new(response)
+          end
+        else
+          p [:unhandled_event, event, *args]
+        end
+      end
+    end
+  end
+
+  def dump
+    open_client do |client|
+      client.dump.body
+    end
+  end
+
+  def capture_outputs
+    begin
+      stdout, $stdout = $stdout, StringIO.new
+      stderr, $stderr = $stderr, StringIO.new
+      result = yield
+      [
+        result,
+        $stdout.string,
+        $stderr.string,
+      ]
+    ensure
+      $stdout, $stderr = stdout, stderr
+    end
+  end
+end