groonga-client 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8a5665848bb07469199965c91102537be1de8ba
-  data.tar.gz: b199fc33a43d039152d4ba068c415259bc4da524
+  metadata.gz: 98c07600cda5089240101c97f1055cee06406515
+  data.tar.gz: c26124ec4e3364a316949bb21bb9fbc00cac6661
 SHA512:
-  metadata.gz: 9206ea5d72f485a6a47b02bcd4518efe6e1893cc1f462432ac9d9afd67cfb88b3faee72c574e516bad9c76485d94a6efddb9246049773230864c414144a0444c
-  data.tar.gz: 39403cfa11da317eb5e17754a7f637234f2c250b2dd62922f501dcc2c0888afa3c74bf849573e61da0d3d14acb1f5b76b7ea7b230fa389b378a2d033017a8aa4
+  metadata.gz: d3aeb65b3107c978fdfef99efe64aadc4a5fd7c5ed4a4835c6377d2d1910acb795994e923ac2cd7bed0737d89740999e8a2c50f511ac762b2797593ad0be4e04
+  data.tar.gz: dedc41cf9ce0f590bb557574d310d55a02cff6c033eec799ff30253093e18182c1141a9801eed0d8aee46df5c583b936511560d9905aabe673aaf2abaf3f78ef

data/doc/text/news.md

@@ -1,5 +1,11 @@
 # NEWS
 
+## 0.5.2 - 2017-09-27
+
+### Improvements
+
+  * `Groonga::Client::Request::Select`: Added XML output support.
+
 ## 0.5.1 - 2017-08-21
 
 ### Improvements

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

@@ -93,18 +93,10 @@ module Groonga
 
           private
           def parse_xml(response)
-            # FIXME: Use more fast XML parser
-            # Extract as a class
             document = REXML::Document.new(response)
-            root_element = document.root
-            if root_element.name == "RESULT"
-              result_element = root_element
-              header = parse_xml_header(result_element)
-              body = parse_xml_body(result_element.elements[1])
-            else
-              header = nil
-              body = parse_xml_body(root_element)
-            end
+            result_element = document.root
+            header = parse_xml_header(result_element)
+            body = parse_xml_body(result_element.elements[1])
             [header, body]
           end
 

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

@@ -24,6 +24,84 @@ module Groonga
       class Select < Base
         Response.register("select", self)
 
+        class << self
+          private
+          def parse_xml(response)
+            document = REXML::Document.new(response)
+            return super if document.root.name == "RESULT"
+
+            result_page = document.elements["SEGMENTS/SEGMENT/RESULTPAGE"]
+            result_set = result_page.elements["RESULTSET"]
+            n_hits, columns, records = parse_xml_result_set(result_set)
+
+            navigation_entry = result_page.elements["NAVIGATIONENTRY"]
+            drilldowns = parse_xml_navigation_entry(navigation_entry)
+
+            header = nil
+            body = [
+              [
+                [n_hits],
+                columns,
+                *records,
+              ],
+              *drilldowns,
+            ]
+            [header, body]
+          end
+
+          def parse_xml_result_set(result_set)
+            n_hits = Integer(result_set.attributes["NHITS"])
+
+            columns = []
+            records = []
+            result_set.each_element("HIT") do |hit|
+              if columns.empty?
+                hit.each_element("FIELD") do |field|
+                  name = field.attributes["NAME"]
+                  columns << [name, "ShortText"]
+                end
+              end
+              record = []
+              hit.each_element("FIELD") do |field|
+                record << field.text
+              end
+              records << record
+            end
+
+            [n_hits, columns, records]
+          end
+
+          def parse_xml_navigation_entry(navigation_entry)
+            return [] if navigation_entry.nil?
+
+            drilldowns = []
+            navigation_entry.each_element("NAVIGATIONELEMENTS") do |elements|
+              n_hits = Integer(elements.attributes["COUNT"])
+              columns = []
+              drilldown = []
+              elements.each_element("NAVIGATIONELEMENT") do |element|
+                if columns.empty?
+                  element.attributes.each do |name, value|
+                    columns << [name, "ShortText"]
+                  end
+                end
+
+                drilldown << element.attributes.collect do |_, value|
+                  value
+                end
+              end
+
+              drilldowns << [
+                [n_hits],
+                columns,
+                *drilldown,
+              ]
+            end
+
+            drilldowns
+          end
+        end
+
         include Enumerable
 
         # @return [Integer] The number of records that match againt

data/lib/groonga/client/version.rb

@@ -16,6 +16,6 @@
 
 module Groonga
   class Client
-    VERSION = "0.5.1"
+    VERSION = "0.5.2"
   end
 end

data/test/response/helper.rb

@@ -16,9 +16,18 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 module TestResponseHelper
-  def parse_raw_response(command_name, raw_response)
+  def parse_raw_response_raw(command_name, pair_arguments, raw_response)
     command_class = Groonga::Command.find(command_name)
-    command = command_class.new(command_name, {})
+    command = command_class.new(command_name, pair_arguments)
     Groonga::Client::Response.parse(command, raw_response)
   end
+
+  def parse_raw_response(command_name, raw_response)
+    parse_raw_response_raw(command_name, {}, raw_response)
+  end
+
+  def parse_raw_xml_response(command_name, raw_response)
+    parse_raw_response_raw(command_name, {"output_type" => "xml"},
+                           raw_response)
+  end
 end

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

@@ -0,0 +1,105 @@
+# 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 "response/helper"
+
+class TestResponseSelectXML < Test::Unit::TestCase
+  include TestResponseHelper
+
+  def drilldown(key, n_hits, records)
+    Groonga::Client::Response::Select::Drilldown.new(key, n_hits, records)
+  end
+
+  def test_basic
+    raw_response = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<SEGMENTS>
+<SEGMENT>
+<RESULTPAGE>
+<RESULTSET OFFSET="0" LIMIT="1" NHITS="100">
+<HIT NO="1">
+<FIELD NAME="_id">1</FIELD>
+</HIT>
+</RESULTSET>
+</RESULTPAGE>
+</SEGMENT>
+</SEGMENTS>
+    XML
+
+    response = parse_raw_xml_response("select", raw_response)
+    assert_equal({
+                   :return_code => 0,
+                   :start_time => Time.at(0),
+                   :elapsed_time => 0.0,
+                   :records => [{"_id" => "1"}],
+                 },
+                 {
+                   :return_code => response.return_code,
+                   :start_time => response.start_time,
+                   :elapsed_time => response.elapsed_time,
+                   :records => response.records,
+                 })
+  end
+
+  def test_drilldown
+    raw_response = <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<SEGMENTS>
+<SEGMENT>
+<RESULTPAGE>
+<RESULTSET OFFSET="0" LIMIT="0" NHITS="100">
+</RESULTSET>
+<NAVIGATIONENTRY>
+<NAVIGATIONELEMENTS COUNT="7">
+<NAVIGATIONELEMENT _key="2.2.0" _nsubrecs="18044" />
+<NAVIGATIONELEMENT _key="2.3.0" _nsubrecs="18115" />
+<NAVIGATIONELEMENT _key="2.4.0" _nsubrecs="14594" />
+</NAVIGATIONELEMENTS>
+</NAVIGATIONENTRY>
+</RESULTPAGE>
+</SEGMENT>
+</SEGMENTS>
+    XML
+
+    response = parse_raw_response_raw("select",
+                                      {
+                                        "drilldown" => "version",
+                                        "output_type" => "xml",
+                                      },
+                                      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groonga-client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Haruka Yoshihara
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gqtp
@@ -240,6 +240,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-xml.rb
 - test/response/test-status.rb
 - test/response/test-table-create.rb
 - test/response/test-table-list.rb
@@ -298,6 +299,7 @@ test_files:
 - test/response/test-error.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-select-command-version1.rb