groonga-client 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81898dfb1545f8ea8096d3e5632351d6fa0c9d6
-  data.tar.gz: 74aacd0492c441e64f3553f66e5cb11d6f5f4d9e
+  metadata.gz: a6c355134e4059b95ea7d3746803c7f4341d9247
+  data.tar.gz: 9c3ebae53243d5fa4cb0ab8395763db7e2e4bcfe
 SHA512:
-  metadata.gz: f241f17e797564649c9e48932f707e9f00437b963d3aa652d7c274ee93cd9ffd7401e70ee4fb88ad37b95a1b436c4004c5bdb52ca243050f63b717be5cb9f87f
-  data.tar.gz: f2a88c1e238bffcde125363cb1a175a1cc9b433e8ef6b0898f42376edbd6f38d8fa48a4d8ca95734a67a5a4e7c3c128ec2a40314c01a32c40e13b25fb24ca183
+  metadata.gz: a91f6bd599929636c25aa63654c4a026b9d951b68c1f1ae25c6355fdfb2cef205ed76afe13af041e8eb895e7039a898cf8ea278b806b23c004447e9e1980bd2a
+  data.tar.gz: 55997467909ceb21090d53379b9d70968c3b2bd79f9a590a9f93d41cb1cf873335718af0b84a2ca719b8bdbfcb653f9fdc59260d68c8f029034b66bd001a32f6

data/bin/groonga-client

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+#
+# Copyright (C) 2015-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/cli"
+
+cli = Groonga::Client::CLI.new
+exit(cli.run(ARGV))

data/doc/text/news.md

@@ -1,5 +1,17 @@
 # NEWS
 
+## 0.3.6 - 2016-12-20
+
+### Improvements
+
+  * Added `Groonga::Client::Test::GroongaServerRunner#using_running_server?`.
+
+  * Merged groonga-client-cli. Now `groonga-client` command is available.
+
+  * `Groonga::Client::Response::Schema#plugins`: Supported method access.
+
+  * `Groonga::Client::Test::GroongaServerRunner`: Supported restoring DB for existing server.
+
 ## 0.3.5 - 2016-12-19
 
 ### Improvements

data/groonga-client.gemspec

@@ -43,9 +43,13 @@ Gem::Specification.new do |spec|
   spec.files += Dir.glob("lib/**/*.rb")
   spec.files += Dir.glob("doc/text/*")
   spec.test_files += Dir.glob("test/**/*")
+  Dir.chdir("bin") do
+    spec.executables = Dir.glob("*")
+  end
 
   spec.add_runtime_dependency("gqtp", ">= 1.0.4")
   spec.add_runtime_dependency("groonga-command", ">= 1.2.8")
+  spec.add_runtime_dependency("groonga-command-parser", ">= 1.0.7")
   spec.add_runtime_dependency("hashie")
 
   spec.add_development_dependency("bundler")
@@ -54,5 +58,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency("test-unit-rr")
   spec.add_development_dependency("packnga")
   spec.add_development_dependency("redcarpet")
-  spec.add_development_dependency("groonga-command-parser")
 end

data/lib/groonga/client/cli.rb

@@ -0,0 +1,233 @@
+# Copyright (C) 2015-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 "ostruct"
+require "optparse"
+require "json"
+require "securerandom"
+
+require "groonga/client"
+
+require "groonga/command/parser"
+
+module Groonga
+  class Client
+    class CLI
+      def initialize
+        @protocol = :http
+        @host     = "localhost"
+        @port     = nil
+
+        @read_timeout = Client::Default::READ_TIMEOUT
+
+        @chunk = false
+
+        @runner_options = {
+          :split_load_chunk_size => 10000,
+          :generate_request_id   => false,
+        }
+      end
+
+      def run(argv)
+        command_file_paths = parse_command_line(argv)
+
+        @client = Client.new(:protocol => @protocol,
+                             :host     => @host,
+                             :port     => @port,
+                             :read_timeout => @read_timeout,
+                             :chunk    => @chunk,
+                             :backend  => :synchronous)
+        runner = Runner.new(@client, @runner_options)
+
+        if command_file_paths.empty?
+          $stdin.each_line do |line|
+            runner << line
+          end
+        else
+          command_file_paths.each do |command_file_path|
+            File.open(command_file_path) do |command_file|
+              last_line = nil
+              command_file.each_line do |line|
+                last_line = line
+                runner << line
+              end
+              if last_line and !last_line.end_with?("\n")
+                runner << "\n"
+              end
+            end
+          end
+        end
+        runner.finish
+
+        true
+      end
+
+      private
+      def parse_command_line(argv)
+        parser = OptionParser.new
+        parser.version = VERSION
+        parser.banner += " GROONGA_COMMAND_FILE1 GROONGA_COMMAND_FILE2 ..."
+
+        parser.separator("")
+
+        parser.separator("Connection:")
+
+        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.on("--split-load-chunk-size=SIZE", Integer,
+                  "Split a large load to small loads.",
+                  "Each small load has at most SIZE records.",
+                  "Set 0 to SIZE to disable this feature.",
+                  "(#{@runner_options[:split_load_chunk_size]})") do |size|
+          @runner_options[:split_load_chunk_size] = size
+        end
+
+        parser.on("--[no-]generate-request-id",
+                  "Add auto generated request ID to all commands.",
+                  "(#{@runner_options[:generate_request_id]})") do |boolean|
+          @runner_options[:generate_request_id] = boolean
+        end
+
+        parser.on("--[no-]chunk",
+                  "Use \"Transfer-Encoding: chunked\" for load command.",
+                  "HTTP only.",
+                  "(#{@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
+        def initialize(client, options={})
+          @client = client
+          @split_load_chunk_size = options[:split_load_chunk_size] || 10000
+          @generate_request_id   = options[:generate_request_id]
+          @load_values = []
+          @parser = create_command_parser
+        end
+
+        def <<(line)
+          @parser << line
+        end
+
+        def finish
+          @parser.finish
+        end
+
+        private
+        def create_command_parser
+          parser = Groonga::Command::Parser.new
+
+          parser.on_command do |command|
+            run_command(command)
+          end
+
+          parser.on_load_columns do |command, columns|
+            command[:columns] ||= columns.join(",")
+          end
+
+          parser.on_load_value do |command, value|
+            unless command[:values]
+              @load_values << value
+              if @load_values.size == @split_load_chunk_size
+                consume_load_values(command)
+              end
+            end
+            command.original_source.clear
+          end
+
+          parser.on_load_complete do |command|
+            if command[:values]
+              run_command(client, command)
+            else
+              consume_load_values(command)
+            end
+          end
+
+          parser
+        end
+
+        def consume_load_values(load_command)
+          return if @load_values.empty?
+
+          values_json = "["
+          @load_values.each_with_index do |value, i|
+            values_json << "," unless i.zero?
+            values_json << "\n"
+            values_json << JSON.generate(value)
+          end
+          values_json << "\n]\n"
+          load_command[:values] = values_json
+          run_command(load_command)
+          @load_values.clear
+          load_command[:values] = nil
+        end
+
+        def run_command(command)
+          command[:request_id] ||= SecureRandom.uuid if @generate_request_id
+          response = @client.execute(command)
+          case command.output_type
+          when :json
+            puts(JSON.pretty_generate([response.header, response.body]))
+          when :xml
+            puts(response.raw)
+          else
+            puts(response.body)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -25,6 +25,16 @@ module Groonga
       class Schema < Base
         Response.register("schema", self)
 
+        # @return [Hash<String, Plugin>] Key is plugin name and
+        #   value is the definition of the plugin.
+        #
+        # @since 0.3.6
+        def plugins
+          @plugins ||= HashValueConverter.convert(@body["plugins"]) do |raw_plugin|
+            Plugin[raw_plugin]
+          end
+        end
+
         # @return [Hash<String, Type>] Key is type name and
         #   value is the definition of the type.
         #
@@ -102,6 +112,11 @@ module Groonga
           end
         end
 
+        class Plugin < ::Hash
+          include Hashie::Extensions::MergeInitializer
+          include Hashie::Extensions::MethodAccess
+        end
+
         class Type < ::Hash
           include Hashie::Extensions::MergeInitializer
           include Hashie::Extensions::MethodAccess

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

@@ -17,6 +17,8 @@
 require "rbconfig"
 require "fileutils"
 
+require "groonga/command/parser"
+
 module Groonga
   class Client
     module Test
@@ -32,6 +34,9 @@ module Groonga
         def run
           if groonga_server_running?
             @using_running_server = true
+            @dump = Groonga::Client.open(url: @url) do |client|
+              client.dump.body
+            end
           else
             return if @groonga.nil?
             @tmp_dir = create_tmp_dir
@@ -50,11 +55,8 @@ module Groonga
         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
+              remove_all(client)
+              restore(client)
             end
           else
             if @pid
@@ -69,6 +71,10 @@ module Groonga
           end
         end
 
+        def using_running_server?
+          @using_running_server
+        end
+
         private
         def build_url
           default_options = Groonga::Client.default_options
@@ -152,6 +158,57 @@ module Groonga
           Process.kill(:KILL, @pid)
           Process.waitpid(@pid)
         end
+
+        def remove_all(client)
+          schema = client.schema
+          schema.tables.each_value do |table|
+            table.columns.each_value do |column|
+              client.column_remove(:table => table.name,
+                                   :name => column.name)
+            end
+          end
+          schema.tables.each_value do |table|
+            client.table_remove(:name => table.name)
+          end
+          schema.plugins.each_value do |plugin|
+            client.plugin_unregister(:name => plugin.name)
+          end
+        end
+
+        def restore(client)
+          return if @dump.empty?
+
+          parser = Groonga::Command::Parser.new
+
+          parser.on_command do |command|
+            client.execute(command)
+          end
+
+          parser.on_load_columns do |command, columns|
+            command[:columns] ||= columns.join(",")
+          end
+
+          load_values = []
+          parser.on_load_value do |command, value|
+            unless command[:values]
+              load_values << value
+            end
+            command.original_source.clear
+          end
+
+          parser.on_load_complete do |command|
+            unless command[:values]
+              command[:values] = JSON.generate(load_values)
+              load_values.clear
+            end
+            client.execute(command)
+          end
+
+          @dump.each_line do |line|
+            parser << line
+          end
+          parser.finish
+        end
       end
     end
   end

data/lib/groonga/client/version.rb

@@ -16,6 +16,6 @@
 
 module Groonga
   class Client
-    VERSION = "0.3.5"
+    VERSION = "0.3.6"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groonga-client
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Haruka Yoshihara
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gqtp
@@ -41,27 +41,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.8
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: groonga-command-parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -69,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit-rr
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,7 +111,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: packnga
+  name: test-unit-rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,7 +125,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: packnga
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -139,7 +139,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: groonga-command-parser
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -160,7 +160,8 @@ email:
 - yshr04hrk@gmail.com
 - kou@clear-code.com
 - tfortress58@gmail.com
-executables: []
+executables:
+- groonga-client
 extensions: []
 extra_rdoc_files: []
 files:
@@ -168,10 +169,12 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/groonga-client
 - doc/text/lgpl-2.1.txt
 - doc/text/news.md
 - groonga-client.gemspec
 - lib/groonga/client.rb
+- lib/groonga/client/cli.rb
 - lib/groonga/client/command.rb
 - lib/groonga/client/default.rb
 - lib/groonga/client/empty-request.rb
@@ -270,29 +273,29 @@ 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/test-script-syntax.rb
-- test/protocol/test-http.rb
+- test/request/select/test-filter-parameter.rb
+- test/request/select/test-output-columns-parameter.rb
+- test/request/select/test-values-parameter.rb
+- test/request/select/test-sort-keys-columns-parameter.rb
+- test/request/test-base.rb
+- test/request/test-select.rb
+- test/test-command.rb
 - test/protocol/test-gqtp.rb
-- test/response/test-schema.rb
-- test/response/test-error.rb
-- test/response/test-table-remove.rb
-- test/response/test-select-command-version3.rb
-- test/response/test-table-list.rb
-- test/response/test-column-list.rb
+- test/protocol/test-http.rb
+- test/run-test.rb
+- test/response/test-base.rb
 - test/response/test-load.rb
+- test/response/test-column-list.rb
 - test/response/helper.rb
-- test/response/test-base.rb
-- test/response/test-select-command-version1.rb
+- test/response/test-error.rb
+- test/response/test-table-list.rb
 - test/response/test-status.rb
+- test/response/test-schema.rb
+- test/response/test-select-command-version3.rb
+- test/response/test-select-command-version1.rb
 - test/response/test-table-create.rb
-- test/results/test-table-list.rb
+- test/response/test-table-remove.rb
 - test/results/test-column-list.rb
-- test/test-command.rb
-- test/run-test.rb
-- test/request/select/test-values-parameter.rb
-- test/request/select/test-sort-keys-columns-parameter.rb
-- test/request/select/test-output-columns-parameter.rb
-- test/request/select/test-filter-parameter.rb
-- test/request/test-select.rb
-- test/request/test-base.rb
-- test/test-client.rb
+- test/results/test-table-list.rb