groonga-command 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaa9e5d607968c538c0fc7900edd0e0fd8c10c4d
-  data.tar.gz: 2ca7cd45a8c6709e18dead9c1f36b7f8f6fb6793
+  metadata.gz: b5d52462003c9ca479ef592591f48e0b9d001fe1
+  data.tar.gz: bad56b2b66c55244d5385ca60f73b2ca94d81c57
 SHA512:
-  metadata.gz: 2a0eb7b2a7539445cbd61947e76c77e4d4d3169f83143573bcf3cf2b162b57283245c1afac76d1990616b422c57b00cd966fc371896f9ed7a0c9931209828d3f
-  data.tar.gz: d0807f8d4b8e9812ece1e03b9a319cdb84e2809e39845559dcde9c61a36b9b7ba492e73c2f5095a8d46453c931744ddcec3620a7ca0b8fc2174bfaa4596216f2
+  metadata.gz: d6fc11658893bb743cef7a9bd77ff4b1e38061c2d08ebd4932e0f555a095b71b6963379ab70d7981ce5cc19467edef208ad86a7bb64d7063246c2776f7c3bcd9
+  data.tar.gz: fe21795f21cb493d9a7f6f38fc09759a93cf2f20678804d821e99fdccb65461d7d29fe418dd753068604a7bdb590dfaa628774f6e92dcd1439228b3ebbb15937

data/doc/text/news.md

@@ -1,5 +1,28 @@
 # News
 
+## 1.2.8: 2016-10-11
+
+### Improvements
+
+  * {Groonga::Command::Select}: Supported labeled drilldowns.
+
+  * {Groonga::Command::Select}: Supported `adjuster` parameter.
+
+  * {Groonga::Command::Select}: Supported `drilldown_calc_types` parameter.
+
+  * {Groonga::Command::Select}: Supported `drilldown_calc_target` parameter.
+
+  * {Groonga::Command::Select}: Supported `sort_keys` parameter.
+
+  * {Groonga::Command::Select}: Supported `drilldown_sort_keys` parameter.
+
+  * {Groonga::Command::Select#sort_keys}: Added.
+
+  * {Groonga::Command::Select#sortby}: Deprecated. Use
+    {Groonga::Command::Select#sort_keys} instead.
+
+  * {Groonga::Command::Select#drilldown_sort_keys}: Added.
+
 ## 1.2.7: 2016-08-15
 
 ### Improvements

data/lib/groonga/command/base.rb

@@ -184,8 +184,12 @@ module Groonga
       end
 
       def integer_value(name)
-        value = self[name]
+        parse_integer_value(self[name])
+      end
+
+      def parse_integer_value(value)
         return value if value.nil?
+        return nil if value.empty?
 
         begin
           Integer(value)
@@ -195,7 +199,12 @@ module Groonga
       end
 
       def array_value(name)
-        (self[name] || "").strip.split(/\s*,\s*/)
+        parse_array_value(self[name] || "")
+      end
+
+      def parse_array_value(value)
+        return nil if value.nil?
+        value.strip.split(/\s*,\s*/)
       end
     end
   end

data/lib/groonga/command/select.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2012-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2012-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
@@ -47,16 +45,32 @@ module Groonga
             :query_expansion,
             :query_flags,
             :query_expander,
+            :adjuster,
+            :drilldown_calc_types,
+            :drilldown_calc_target,
+            :sort_keys,
+            :drilldown_sort_keys,
           ]
         end
       end
 
       Command.register(command_name, self)
 
+      # @return [String] The sort keys as String. Each key is
+      #   separated by "," or spaces.
+      #
+      # @deprecated since 1.2.8. Use {#sort_keys} instead.
       def sortby
         self[:sortby]
       end
 
+      # @return [::Array<String>] The sort keys.
+      #
+      # @since 1.2.8
+      def sort_keys
+        parse_array_value(self[:sort_keys] || self[:sortby] || "")
+      end
+
       def scorer
         self[:scorer]
       end
@@ -77,6 +91,21 @@ module Groonga
         @drilldowns ||= array_value(:drilldown)
       end
 
+      # @return [::Array<String>] The sort keys for drilldowns.
+      #
+      # @since 1.2.8
+      def drilldown_sort_keys
+        value = self[:drilldown_sort_keys] || self[:drilldown_sortby] || ""
+        parse_array_value(value)
+      end
+
+      # @return [::Hash<String, Drilldown>] The labeled drilldowns.
+      #
+      # @since 1.2.8
+      def labeled_drilldowns
+        @labeled_drilldowns ||= parse_labeled_drilldowns
+      end
+
       def output_columns
         self[:output_columns]
       end
@@ -90,6 +119,52 @@ module Groonga
           condition
         end
       end
+
+      def parse_labeled_drilldowns
+        raw_labeled_drilldowns = {}
+        @arguments.each do |name, value|
+          case name.to_s
+          when /\Adrilldowns?\[(.+?)\]\.(.+?)\z/
+            label = $1
+            parameter_name = $2
+            raw_labeled_drilldowns[label] ||= {}
+            raw_labeled_drilldowns[label][parameter_name] = value
+          end
+        end
+        build_labeled_drilldowns(raw_labeled_drilldowns)
+      end
+
+      def build_labeled_drilldowns(raw_labeled_drilldowns)
+        labeled_drilldowns = {}
+        raw_labeled_drilldowns.each do |label, raw_drilldown|
+          keys = parse_array_value(raw_drilldown["keys"])
+          sort_keys = raw_drilldown["sort_keys"] || raw_drilldown["sortby"]
+          sort_keys = parse_array_value(sort_keys)
+          output_columns = parse_array_value(raw_drilldown["output_columns"])
+          offset = parse_integer_value(raw_drilldown["offset"])
+          limit = parse_integer_value(raw_drilldown["limit"])
+          calc_types = parse_array_value(raw_drilldown["calc_types"])
+          calc_target = raw_drilldown["calc_target"]
+          drilldown = Drilldown.new(keys,
+                                    sort_keys,
+                                    output_columns,
+                                    offset,
+                                    limit,
+                                    calc_types,
+                                    calc_target)
+          labeled_drilldowns[label] = drilldown
+        end
+        labeled_drilldowns
+      end
+
+      class Drilldown < Struct.new(:keys,
+                                   :sort_keys,
+                                   :output_columns,
+                                   :offset,
+                                   :limit,
+                                   :calc_types,
+                                   :calc_target)
+      end
     end
   end
 end

data/lib/groonga/command/version.rb

@@ -16,6 +16,6 @@
 
 module Groonga
   module Command
-    VERSION = "1.2.7"
+    VERSION = "1.2.8"
   end
 end

data/test/command/test-select.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2011-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2011-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
@@ -43,6 +41,11 @@ class SelectCommandTest < Test::Unit::TestCase
       query_expansion            = "deprecated"
       query_flags                = "ALLOW_LEADING_NOT"
       query_expander             = "Terms.synonym"
+      adjuster                   = "tag * 10"
+      drilldown_calc_types       = "MIN, MAX"
+      drilldown_calc_target      = "age"
+      sort_keys                  = "-_score"
+      drilldown_sort_keys        = "-_nsubrecs"
 
       ordered_arguments = [
         table,
@@ -64,6 +67,11 @@ class SelectCommandTest < Test::Unit::TestCase
         query_expansion,
         query_flags,
         query_expander,
+        adjuster,
+        drilldown_calc_types,
+        drilldown_calc_target,
+        sort_keys,
+        drilldown_sort_keys,
       ]
       command = select_command({}, ordered_arguments)
 
@@ -87,6 +95,11 @@ class SelectCommandTest < Test::Unit::TestCase
                      :query_expansion            => query_expansion,
                      :query_flags                => query_flags,
                      :query_expander             => query_expander,
+                     :adjuster                   => adjuster,
+                     :drilldown_calc_types       => drilldown_calc_types,
+                     :drilldown_calc_target      => drilldown_calc_target,
+                     :sort_keys                  => sort_keys,
+                     :drilldown_sort_keys        => drilldown_sort_keys,
                    },
                    command.arguments)
     end
@@ -126,4 +139,81 @@ class SelectCommandTest < Test::Unit::TestCase
                    command.conditions)
     end
   end
+
+  class SortKeysTest < self
+    def test_reader
+      command = select_command(:sort_keys => "-_score,_key")
+      assert_equal(["-_score", "_key"],
+                   command.sort_keys)
+    end
+
+    def test_sortby
+      command = select_command(:sortby => "-_score,_key")
+      assert_equal(["-_score", "_key"],
+                   command.sort_keys)
+    end
+  end
+
+  class DrilldownSortKeysTest < self
+    def test_reader
+      command = select_command(:drilldown_sort_keys => "-_nsubrecs,_key")
+      assert_equal(["-_nsubrecs", "_key"],
+                   command.drilldown_sort_keys)
+    end
+
+    def test_sortby
+      command = select_command(:drilldown_sortby => "-_nsubrecs,_key")
+      assert_equal(["-_nsubrecs", "_key"],
+                   command.drilldown_sort_keys)
+    end
+  end
+
+  class LabeledDrilldownsTest < self
+    def test_multiple
+      parameters = {
+        "drilldowns[tag].keys" => "tag",
+        "drilldowns[tag].sort_keys" => "-_nsubrecs,_key",
+        "drilldowns[tag].output_columns" => "_key,_nsubrecs,_min,_max",
+        "drilldowns[tag].offset" => "1",
+        "drilldowns[tag].limit" => "10",
+        "drilldowns[tag].calc_types" => "MIN,MAX",
+        "drilldowns[tag].calc_target" => "_nsubrecs",
+
+        "drilldowns[author_tag].keys" => "author,tag",
+        "drilldowns[author_tag].sort_keys" => "_value.author",
+        "drilldowns[author_tag].output_columns" => "_value.author,_nsubrecs",
+      }
+      command = select_command(parameters)
+      drilldowns = {
+        "author_tag" => drilldown(:keys => ["author", "tag"],
+                                  :sort_keys => ["_value.author"],
+                                  :output_columns => [
+                                    "_value.author",
+                                    "_nsubrecs",
+                                  ]),
+        "tag" => drilldown(:keys => ["tag"],
+                           :sort_keys => ["-_nsubrecs", "_key"],
+                           :output_columns => [
+                             "_key",
+                             "_nsubrecs",
+                             "_min",
+                             "_max",
+                           ],
+                           :offset => 1,
+                           :limit => 10,
+                           :calc_types => ["MIN", "MAX"],
+                           :calc_target => "_nsubrecs"),
+      }
+      assert_equal(drilldowns,
+                   command.labeled_drilldowns)
+    end
+
+    def drilldown(parameters)
+      drilldown = Groonga::Command::Select::Drilldown.new
+      parameters.each do |key, value|
+        drilldown[key] = value
+      end
+      drilldown
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groonga-command
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Kouhei Sutou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -266,55 +266,54 @@ specification_version: 4
 summary: Groonga-command is a library that represents [Groonga](http://groonga.org/)'s
   command. You can write a program that handle Groonga's command by using groonga-command.
 test_files:
-- test/command/test-schema.rb
-- test/command/test-column-remove.rb
-- test/command/test-range-filter.rb
-- test/command/test-object-inspect.rb
-- test/command/test-column-copy.rb
-- test/command/test-io-flush.rb
-- test/command/test-log-put.rb
-- test/command/test-plugin-unregister.rb
-- test/command/test-table-remove.rb
-- test/command/test-column-rename.rb
-- test/command/test-column-create.rb
-- test/command/test-select.rb
-- test/command/test-shutdown.rb
+- test/groonga-command-test-utils.rb
+- test/command/test-config-delete.rb
 - test/command/test-object-remove.rb
-- test/command/test-logical-select.rb
 - test/command/test-table-tokenize.rb
-- test/command/test-logical-shard-list.rb
-- test/command/test-object-exist.rb
-- test/command/test-suggest.rb
-- test/command/test-request-cancel.rb
-- test/command/test-query-expand.rb
-- test/command/test-log-level.rb
-- test/command/test-table-list.rb
-- test/command/test-column-list.rb
-- test/command/test-load.rb
-- test/command/test-dump.rb
-- test/command/test-truncate.rb
-- test/command/test-delete.rb
-- test/command/test-ruby-load.rb
-- test/command/test-plugin-register.rb
+- test/command/test-reindex.rb
+- test/command/test-plugin-unregister.rb
+- test/command/test-io-flush.rb
 - test/command/test-base.rb
-- test/command/test-table-rename.rb
-- test/command/test-config-get.rb
 - test/command/test-logical-count.rb
+- test/command/test-table-rename.rb
+- test/command/test-column-rename.rb
+- test/command/test-dump.rb
 - test/command/test-normalize.rb
-- test/command/test-table-copy.rb
-- test/command/test-get.rb
+- test/command/test-config-get.rb
+- test/command/test-register.rb
+- test/command/test-shutdown.rb
+- test/command/test-delete.rb
+- test/command/test-column-copy.rb
+- test/command/test-tokenize.rb
+- test/command/test-log-put.rb
+- test/command/test-load.rb
+- test/command/test-column-list.rb
+- test/command/test-plugin-register.rb
+- test/command/test-request-cancel.rb
+- test/command/test-column-create.rb
+- test/command/test-config-set.rb
 - test/command/test-logical-range-filter.rb
-- test/command/test-config-delete.rb
-- test/command/test-logical-table-remove.rb
+- test/command/test-object-inspect.rb
 - test/command/format/test-command.rb
-- test/command/test-reindex.rb
+- test/command/test-logical-select.rb
+- test/command/test-get.rb
 - test/command/test-thread-limit.rb
-- test/command/test-config-set.rb
-- test/command/test-tokenize.rb
-- test/command/test-ruby-eval.rb
+- test/command/test-table-list.rb
+- test/command/test-object-exist.rb
+- test/command/test-log-level.rb
+- test/command/test-range-filter.rb
 - test/command/test-status.rb
-- test/command/test-register.rb
+- test/command/test-logical-shard-list.rb
+- test/command/test-schema.rb
+- test/command/test-suggest.rb
+- test/command/test-select.rb
+- test/command/test-column-remove.rb
+- test/command/test-ruby-eval.rb
 - test/command/test-table-create.rb
+- test/command/test-table-remove.rb
+- test/command/test-ruby-load.rb
+- test/command/test-table-copy.rb
+- test/command/test-query-expand.rb
+- test/command/test-truncate.rb
+- test/command/test-logical-table-remove.rb
 - test/run-test.rb
-- test/groonga-command-test-utils.rb
-has_rdoc: