groonga-client 0.5.8 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4513c924b1dc4c7ca3b26afc382163620d09d26c
-  data.tar.gz: dd01a037ba7ff770cf04b6d3118d9847061e0fe4
+SHA256:
+  metadata.gz: 16493f7abb6c08faa1f10060a64bedca44071acc4772ed06ac400a91a4b96282
+  data.tar.gz: 0c94271fb51d35d2758e423a7d52cacc46488ae1c6afbc9ab947b3093dedcfee
 SHA512:
-  metadata.gz: a71e2bd65572c69a35956b928c533754ae6411e5788bc5a412e939eeb7435d765b341ac4f623a8ca30778c8ed7ccf356489007628fafdddb8e94c3716ad2119f
-  data.tar.gz: 698187d4515e5d45bd1b4572f046ca7e30c915f99b35b676a6027c7c107549b5a52c69b5629612ced8a9d2597f29ea0402536d2574529ff82e025f972f78bebd
+  metadata.gz: 8df38010cd75c8e29bd0461243ed0ce07a6cb7efe84450e2eae1e5a8612cd3237be4f00c37bda7a10bbd7016bf5be88507961016337664c988a27ee5c66487b5
+  data.tar.gz: 3a23a2605d9711c4e46582b5a06021a434763d7021a4bd1263be077e605ec1bdcfdfb7fd8d858e2166bd0213ec2feb24961317699a486d33c817182214c3106b

data/doc/text/news.md

@@ -1,5 +1,11 @@
 # NEWS
 
+## 0.5.9 - 2018-07-13
+
+### Improvements
+
+  * Added support for TSV output.
+
 ## 0.5.8 - 2017-11-09
 
 ### Improvements

data/lib/groonga/client.rb

@@ -1,5 +1,5 @@
 # Copyright (C) 2013  Haruka Yoshihara <yoshihara@clear-code.com>
-# Copyright (C) 2013-2016  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2013-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
@@ -23,6 +23,7 @@ require "groonga/client/command"
 require "groonga/client/empty-request"
 require "groonga/client/protocol/gqtp"
 require "groonga/client/protocol/http"
+require "groonga/client/protocol/file"
 require "groonga/client/request"
 
 module Groonga
@@ -100,9 +101,11 @@ module Groonga
         @connection = Groonga::Client::Protocol::GQTP.new(url, options)
       when "http", "https"
         @connection = Groonga::Client::Protocol::HTTP.new(url, options)
+      when "file"
+        @connection = Groonga::Client::Protocol::File.new(url, options)
       else
         message = "unsupported scheme: <#{url.scheme}>: "
-        message << "supported: [gqtp, http, https]"
+        message << "supported: [gqtp, http, https, file]"
         raise ArgumentError, message
       end
     end
@@ -219,7 +222,7 @@ module Groonga
       scheme = (options.delete(:protocol) || "gqtp").to_s
       host = options.delete(:host) || options.delete(:address) || "127.0.0.1"
       port = options.delete(:port) || default_port(scheme)
-      path = options.delete(:path)
+      path = options.delete(:path) || default_path(scheme)
       user = options.delete(:user)
       password = options.delete(:password)
       if user and password
@@ -260,6 +263,15 @@ module Groonga
       end
     end
 
+    def default_path(scheme)
+      case scheme
+      when "http", "https"
+        "/d/"
+      else
+        nil
+      end
+    end
+
     def groonga_command_name?(name)
       /\A[a-zA-Z][a-zA-Z\d_]+\z/ === name.to_s
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2015-2018  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
@@ -14,7 +14,9 @@
 # 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 "fileutils"
 require "json"
+require "pathname"
 require "securerandom"
 
 require "groonga/command/parser"
@@ -45,8 +47,19 @@ module Groonga
             runner = Runner.new(client, @runner_options)
 
             if command_file_paths.empty?
-              $stdin.each_line do |line|
-                runner << line
+              if $stdin.tty? and $stdout.tty?
+                begin
+                  require "readline"
+                rescue LoadError
+                  repl = BareREPL.new(runner)
+                else
+                  repl = ReadlineREPL.new(runner)
+                end
+                repl.run
+              else
+                $stdin.each_line do |line|
+                  runner << line
+                end
               end
             else
               command_file_paths.each do |command_file_path|
@@ -114,6 +127,17 @@ module Groonga
             @parser.finish
           end
 
+          def repl
+            begin
+              require "readline"
+            rescue LoadError
+              repl = BareREPL.new(self)
+            else
+              repl = ReadlineREPL.new(self)
+              repl_readline
+            end
+          end
+
           private
           def create_command_parser
             parser = Groonga::Command::Parser.new
@@ -176,6 +200,98 @@ module Groonga
             end
           end
         end
+
+        class BareREPL
+          def initialize(runner)
+            @runner = runner
+          end
+
+          def run
+            loop do
+              print("> ")
+              $stdout.flush
+              line = gets
+              break if line.nil?
+              @runner << line
+            end
+          end
+        end
+
+        class ReadlineREPL
+          def initialize(runner)
+            @runner = runner
+            @history_path = guess_history_path
+            read_history
+          end
+
+          def run
+            loop do
+              line = Readline.readline("> ", true)
+              break if line.nil?
+              add_history(line)
+              @runner << line
+              @runner << "\n"
+            end
+          end
+
+          private
+          def guess_history_path
+            case RUBY_PLATFORM
+            when /mswin/, /mingw/
+              base_dir = ENV["LOCALAPPDATA"] || "~/AppData"
+            when /darwin/
+              base_dir = "~/Library/Preferences"
+            else
+              base_dir = ENV["XDG_CONFIG_HOME"] || "~/.config"
+            end
+            Pathname(base_dir).expand_path + "groonga-client" + "history.txt"
+          end
+
+          def read_history
+            if @history_path.exist?
+              @history_path.open do |history_file|
+                history_file.each_line do |line|
+                  Readline::HISTORY << line.chomp
+                end
+              end
+              @history_timestamp = @history_path.mtime
+            else
+              @history_timestamp = Time.now
+            end
+          end
+
+          def add_history(entry)
+            updated = history_is_updated?
+
+            if new_history_entry?(entry)
+              FileUtils.mkdir_p(@history_path.dirname)
+              @history_path.open("a") do |history_file|
+                history_file << entry
+                history_file << "\n"
+              end
+            else
+              Readline::HISTORY.pop
+            end
+
+            if updated
+              Readline::HISTORY.clear
+              read_history
+            end
+          end
+
+          def history_is_updated?
+            @history_path.exist? and
+              @history_path.mtime > @history_timestamp
+          end
+
+          def new_history_entry?(entry)
+            return false if /\A\s*\z/ =~ entry
+            if Readline::HISTORY.size > 1 and Readline::HISTORY[-2] == entry
+              return false
+            end
+            true
+          end
+        end
       end
     end
   end

data/lib/groonga/client/protocol/file.rb

@@ -0,0 +1,76 @@
+# 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/client/version"
+require "groonga/client/protocol/error"
+
+module Groonga
+  class Client
+    module Protocol
+      class File
+        def initialize(url, options)
+          @url = url
+          @options = options
+        end
+
+        def send(command, &block)
+          open_pipes do |input, output, error|
+            options = {
+              :in => input[0],
+              :out => output[1],
+              :err => error[1],
+            }
+            pid = spawn("groonga", @url.path, options)
+            input[0].close
+            output[1].close
+            error[1].close
+
+            input[1].puts(command.to_command_format)
+            input[1].close
+            response = output[0].read
+            Process.waitpid(pid)
+            yield(response)
+            EmptyRequest.new
+          end
+        end
+
+        def connected?
+          false
+        end
+
+        def close(&block)
+          if block_given?
+            yield
+            EmptyRequest.new
+          else
+            false
+          end
+        end
+
+        private
+        def open_pipes
+          IO.pipe do |input|
+            IO.pipe do |output|
+              IO.pipe do |error|
+                yield(input, output, error)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/protocol/http/path-resolvable.rb

@@ -21,7 +21,12 @@ module Groonga
         module PathResolvable
           private
           def resolve_path(uri, path)
-            uri.path.chomp("/") + path
+            path_prefix = uri.path.chomp("/")
+            if path_prefix.empty?
+              path
+            else
+              path.sub(/\A\/d/) {path_prefix}
+            end
           end
         end
       end

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

@@ -17,6 +17,7 @@
 # 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 "csv"
 require "rexml/document"
 require "json"
 
@@ -78,6 +79,9 @@ module Groonga
             when :xml
               header, body = parse_xml(raw_response)
               return_code = header[0] if header
+            when :tsv
+              header, body = parse_tsv(raw_response)
+              return_code = header["return_code"] if header
             else
               header = nil
               body = raw_response
@@ -129,6 +133,46 @@ module Groonga
               end
             end
           end
+
+          def parse_tsv(response)
+            tsv = CSV.new(response, col_sep: "\t")
+            raw_header = tsv.shift
+            return nil, nil if raw_header.nil?
+
+            header = parse_tsv_header(raw_header)
+            return header, nil unless header["return_code"].zero?
+
+            body = parse_tsv_body(tsv)
+            [header, body]
+          end
+
+          def parse_tsv_header(raw_header)
+            header = {
+              "return_code" => Integer(raw_header[0], 10),
+              "start_time" => Float(raw_header[1]),
+              "elapsed_time" => Float(raw_header[2]),
+            }
+            if raw_header.size >= 4
+              header["error"] = {
+                "message" => raw_header[3],
+              }
+              if raw_header.size >= 5
+                header["error"]["function"] = raw_header[4]
+                header["error"]["file"] = raw_header[5]
+                header["error"]["line"] = Integer(raw_header[6])
+              end
+            end
+            header
+          end
+
+          def parse_tsv_body(tsv)
+            body = []
+            tsv.each do |row|
+              break if row.size == 1 and row[0] == "END"
+              body << row
+            end
+            body
+          end
         end
 
         # @return [Groonga::Command] The command for the request.

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

@@ -20,10 +20,50 @@ module Groonga
   class Client
     module Response
       class Error < Base
-        # @return [String] The error message of the error response.
+        # @return [String, nil] The error message of the error response.
+        #
         # @since 0.1.0
         def message
-          (header || [0, 0, 0.0, ""])[3]
+          error_message
+        end
+
+        # @return [String, nil] The function name where the error is occurred.
+        #
+        # @since 0.5.9
+        def function
+          if header.nil?
+            nil
+          elsif header_v1?
+            header[4]
+          else
+            (header["error"] || {})["function"]
+          end
+        end
+
+        # @return [String, nil] The file name where the error is occurred.
+        #
+        # @since 0.5.9
+        def file
+          if header.nil?
+            nil
+          elsif header_v1?
+            header[5]
+          else
+            (header["error"] || {})["file"]
+          end
+        end
+
+        # @return [String, nil] The line where the error is occurred.
+        #
+        # @since 0.5.9
+        def line
+          if header.nil?
+            nil
+          elsif header_v1?
+            header[5]
+          else
+            (header["error"] || {})["line"]
+          end
         end
       end
     end

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

@@ -100,6 +100,78 @@ module Groonga
 
             drilldowns
           end
+
+          def parse_tsv_body(tsv)
+            record_sets = []
+
+            n_hits = parse_tsv_n_hits(tsv.shift)
+            columns = parse_tsv_columns(tsv.shift)
+            records = []
+            loop do
+              row = tsv.shift
+              break if row.size == 1 and row[0] == "END"
+              if (row.size % 4).zero? and row[0] == "[" and row[-1] == "]"
+                next_n_hits_row = records.pop
+                record_sets << [
+                  [n_hits],
+                  columns,
+                  *records,
+                ]
+                n_hits = parse_tsv_n_hits(next_n_hits_row)
+                columns = parse_tsv_columns(row)
+                records = []
+                next
+              end
+              records << parse_tsv_record(row)
+            end
+
+            record_sets << [
+              [n_hits],
+              columns,
+              *records,
+            ]
+            record_sets
+          end
+
+          def parse_tsv_n_hits(row)
+            Integer(row[0], 10)
+          end
+
+          def parse_tsv_columns(row)
+            columns = []
+            column = nil
+            row.each do |value|
+              case value
+              when "["
+                column = []
+              when "]"
+                columns << column
+              else
+                column << value
+              end
+            end
+            columns
+          end
+
+          def parse_tsv_record(row)
+            record = []
+            column_value = nil
+            row.each do |value|
+              case value
+              when "["
+                column_value = []
+              when "]"
+                record << column_value
+              else
+                if column_value
+                  column_value << value
+                else
+                  record << value
+                end
+              end
+            end
+            record
+          end
         end
 
         include Enumerable

data/lib/groonga/client/version.rb

@@ -16,6 +16,6 @@
 
 module Groonga
   class Client
-    VERSION = "0.5.8"
+    VERSION = "0.5.9"
   end
 end

data/test/response/helper.rb

@@ -30,4 +30,9 @@ module TestResponseHelper
     parse_raw_response_raw(command_name, {"output_type" => "xml"},
                            raw_response)
   end
+
+  def parse_raw_tsv_response(command_name, raw_response)
+    parse_raw_response_raw(command_name, {"output_type" => "tsv"},
+                           raw_response)
+  end
 end

data/test/response/test-error.rb

@@ -55,7 +55,7 @@ class TestResponseError < Test::Unit::TestCase
 
     def test_no_header
       response = Groonga::Client::Response::Error.new(nil, nil, nil)
-      assert_equal("", response.message)
+      assert_nil(response.message)
     end
   end
 end

data/test/response/test-select-tsv.rb

@@ -0,0 +1,127 @@
+# Copyright (C) 2018  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 "response/helper"
+
+class TestResponseSelectTSV < Test::Unit::TestCase
+  include TestResponseHelper
+
+  def drilldown(key, n_hits, records)
+    Groonga::Client::Response::Select::Drilldown.new(key, n_hits, records)
+  end
+
+  def test_error
+    raw_response = <<-TSV
+-22	0	0.0	"message"	"function"	"file"	29
+
+END
+    TSV
+
+    response = parse_raw_tsv_response("select", raw_response)
+    assert_equal({
+                   :return_code => -22,
+                   :start_time => Time.at(0),
+                   :elapsed_time => 0.0,
+                   :error => {
+                     :message => "message",
+                     :function => "function",
+                     :file => "file",
+                     :line => 29,
+                   },
+                 },
+                 {
+                   :return_code => response.return_code,
+                   :start_time => response.start_time,
+                   :elapsed_time => response.elapsed_time,
+                   :error => {
+                     :message => response.message,
+                     :function => response.function,
+                     :file => response.file,
+                     :line => response.line,
+                   },
+                 })
+  end
+
+  def test_basic
+    raw_response = <<-TSV
+ 0	0	0.0
+100
+[	"_id"	"UInt32"	]
+1
+2
+END
+    TSV
+
+    response = parse_raw_tsv_response("select", raw_response)
+    assert_equal({
+                   :return_code => 0,
+                   :start_time => Time.at(0),
+                   :elapsed_time => 0.0,
+                   :records => [
+                     {"_id" => "1"},
+                     {"_id" => "2"},
+                   ],
+                 },
+                 {
+                   :return_code => response.return_code,
+                   :start_time => response.start_time,
+                   :elapsed_time => response.elapsed_time,
+                   :records => response.records,
+                 })
+  end
+
+  def test_drilldown
+    raw_response = <<-TSV
+ 0	0	0.0
+100
+[	"_id"	"UInt32"	]
+7
+[	"_key"	"ShortText"	]	[	"_nsubrecs"	"UInt32"	]
+"2.2.0"	"18044"
+"2.3.0"	"18115"
+"2.4.0"	"14594"
+END
+    TSV
+
+    response = parse_raw_response_raw("select",
+                                      {
+                                        "drilldown" => "version",
+                                        "output_type" => "tsv",
+                                      },
+                                      raw_response)
+    drilldown_records = [
+      {"_key" => "2.2.0", "_nsubrecs" => "18044"},
+      {"_key" => "2.3.0", "_nsubrecs" => "18115"},
+      {"_key" => "2.4.0", "_nsubrecs" => "14594"},
+    ]
+    assert_equal({
+                   :return_code => 0,
+                   :start_time => Time.at(0),
+                   :elapsed_time => 0.0,
+                   :records => [],
+                   :drilldowns => [
+                     drilldown("version", 7, drilldown_records),
+                   ],
+                 },
+                 {
+                   :return_code => response.return_code,
+                   :start_time => response.start_time,
+                   :elapsed_time => response.elapsed_time,
+                   :records => response.records,
+                   :drilldowns => response.drilldowns,
+                 })
+  end
+end

data/test/test-client.rb

@@ -491,7 +491,7 @@ EOH
 
       def test_with_trailing_slash
         stub_response("[]")
-        options = component_based_open_options.merge(:path => "/sub_path/")
+        options = component_based_open_options.merge(:path => "/sub_path/d/")
         Groonga::Client.open(options) do |client|
           client.status
         end
@@ -500,7 +500,7 @@ EOH
 
       def test_without_trailing_slash
         stub_response("[]")
-        options = component_based_open_options.merge(:path => "/sub_path")
+        options = component_based_open_options.merge(:path => "/sub_path/d")
         Groonga::Client.open(options) do |client|
           client.status
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groonga-client
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.5.9
 platform: ruby
 authors:
 - Haruka Yoshihara
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2018-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gqtp
@@ -161,9 +161,9 @@ email:
 - kou@clear-code.com
 - tfortress58@gmail.com
 executables:
-- groonga-client
 - groonga-client-index-check
 - groonga-client-index-recreate
+- groonga-client
 extensions: []
 extra_rdoc_files: []
 files:
@@ -188,6 +188,7 @@ files:
 - lib/groonga/client/empty-request.rb
 - lib/groonga/client/error.rb
 - lib/groonga/client/protocol/error.rb
+- lib/groonga/client/protocol/file.rb
 - lib/groonga/client/protocol/gqtp.rb
 - lib/groonga/client/protocol/http.rb
 - lib/groonga/client/protocol/http/coolio.rb
@@ -251,6 +252,7 @@ files:
 - test/response/test-schema.rb
 - test/response/test-select-command-version1.rb
 - test/response/test-select-command-version3.rb
+- test/response/test-select-tsv.rb
 - test/response/test-select-xml.rb
 - test/response/test-status.rb
 - test/response/test-table-create.rb
@@ -281,41 +283,42 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Groonga-client is a client for Groonga (http://groonga.org/) implemented
   with pure Ruby. You can use it without Groonga.
 test_files:
+- test/test-client.rb
+- test/command-line/test-index-check.rb
+- test/command-line/helper.rb
+- test/command-line/test-index-recreate.rb
 - test/test-script-syntax.rb
-- test/protocol/test-http.rb
+- test/request/select/test-backward-compatible-sort-keys-parameter.rb
+- test/request/select/test-filter.rb
+- test/request/select/test-sort-keys-parameter.rb
+- test/request/select/test-output-columns-parameter.rb
+- test/request/select/test-values-parameter.rb
+- test/request/select/test-scorer.rb
+- test/request/test-merger.rb
+- test/request/test-generic.rb
+- test/request/test-select.rb
+- test/test-command.rb
 - test/protocol/test-gqtp.rb
-- test/response/test-schema.rb
+- test/protocol/test-http.rb
+- test/run-test.rb
+- test/response/test-base.rb
+- test/response/test-select-tsv.rb
+- test/response/test-load.rb
+- test/response/test-column-list.rb
+- test/response/helper.rb
 - test/response/test-error.rb
-- test/response/test-table-remove.rb
+- test/response/test-table-list.rb
+- test/response/test-status.rb
 - test/response/test-select-xml.rb
+- test/response/test-schema.rb
 - test/response/test-select-command-version3.rb
-- test/response/test-table-list.rb
-- test/response/test-column-list.rb
-- test/response/test-load.rb
-- test/response/helper.rb
-- test/response/test-base.rb
 - test/response/test-select-command-version1.rb
-- test/response/test-status.rb
 - test/response/test-table-create.rb
+- test/response/test-table-remove.rb
 - test/results/test-table-list.rb
-- test/test-command.rb
-- test/run-test.rb
-- test/request/test-generic.rb
-- test/request/select/test-values-parameter.rb
-- test/request/select/test-output-columns-parameter.rb
-- test/request/select/test-scorer.rb
-- test/request/select/test-backward-compatible-sort-keys-parameter.rb
-- test/request/select/test-filter.rb
-- test/request/select/test-sort-keys-parameter.rb
-- test/request/test-select.rb
-- test/request/test-merger.rb
-- test/test-client.rb
-- test/command-line/test-index-recreate.rb
-- test/command-line/helper.rb
-- test/command-line/test-index-check.rb