groonga-client 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 433e771ffc7190f3e47bf37a34ac59eb0103f166
-  data.tar.gz: f18ec9abac0699bdb97665bcba17cd4dfe7b72e7
+  metadata.gz: b10f2746556ebf27bbe22c67f37fe6758aab8400
+  data.tar.gz: 5f96d9789517af65942d155c12053d88283b2d3e
 SHA512:
-  metadata.gz: aca4054d08b78df878530ff0b5b4f81ac3d465c1f1052daa78730a8dc442e919e1ade9177c8c525874ddd1468e7d0f7fe0f5378e2f3c0faaa0959173c2dcbef9
-  data.tar.gz: 4301d2ebb01994a37ab1e2bfeef54dc456a26d166b58c07b7322b684d3ea5152b5c5c2230f6d0994c343bef5c26481c9833c69f4582c95e9e04faf10f6ae575a
+  metadata.gz: 6dddafd8f52e38d9d9a6a53cf24a5ab475de32a106d955743c289a64c87d1907cfc13777a4a1c1cfc3be711ec9d6d4287d832e10861f308b1710c240b8b05117
+  data.tar.gz: 69fb56a8c4322708287bf815f883d1c04748476bba5b54048ae35070314d45b96374ada729ade886c4562047001a8f9752367cab04a1fb19c35ccc8221a52d8f

data/doc/text/news.md

@@ -1,5 +1,19 @@
 # NEWS
 
+## 0.4.0 - 2016-01-12
+
+### Improvements
+
+  * `Groonga::Client::Request::Select#columns`: Supported
+    `columns[label]`.
+
+### Fixes
+
+  * Removed Active Support method use.
+
+  * `Groonga::Client::Request::Select#filter`: Fixed filter value
+    escape error.
+
 ## 0.3.9 - 2016-12-22
 
 ### Improvements

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2016-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
@@ -98,7 +98,7 @@ module Groonga
 
         def sort_keys(value)
           add_parameter(OverwriteMerger,
-                        SortKeysParameter.new("", value))
+                        BackwardCompatibleSortKeysParameter.new("", value))
         end
         alias_method :sortby, :sort_keys
         alias_method :sort, :sort_keys
@@ -126,6 +126,10 @@ module Groonga
           LabeledDrilldown.new(self, label)
         end
 
+        def columns(label)
+          DynamicColumn.new(self, label)
+        end
+
         def each(&block)
           response.records.each(&block)
         end
@@ -158,7 +162,7 @@ module Groonga
 
           def sort_keys(value)
             add_parameter(OverwriteMerger,
-                          SortKeysParameter.new(prefix, value))
+                          BackwardCompatibleSortKeysParameter.new(prefix, value))
           end
           alias_method :sortby, :sort_keys
           alias_method :sort, :sort_keys
@@ -195,6 +199,71 @@ module Groonga
           end
         end
 
+        class DynamicColumn
+          def initialize(request, label)
+            @request = request
+            @label = label
+          end
+
+          def stage(value)
+            add_parameter(OverwriteMerger,
+                          RequestParameter.new(:"#{prefix}stage", value))
+          end
+
+          def type(value)
+            add_parameter(OverwriteMerger,
+                          RequestParameter.new(:"#{prefix}type", value))
+          end
+
+          def flags(value)
+            add_parameter(OverwriteMerger,
+                          FlagsParameter.new([:"#{prefix}flags"], value))
+          end
+
+          def value(expression, values=nil)
+            add_parameter(OverwriteMerger,
+                          ScriptSyntaxExpressionParameter.new(:"#{prefix}value",
+                                                              expression,
+                                                              values))
+          end
+
+          def window
+            DynamicColumnWindow.new(@request, @label)
+          end
+
+          private
+          def prefix
+            "columns[#{@label}]."
+          end
+
+          def add_parameter(merger, parameter)
+            @request.__send__(:add_parameter, merger, parameter)
+          end
+        end
+
+        class DynamicColumnWindow
+          def initialize(request, label)
+            @request = request
+            @label = label
+          end
+
+          def sort_keys(value)
+            add_parameter(OverwriteMerger,
+                          SortKeysParameter.new(prefix, value))
+          end
+          alias_method :sortby, :sort_keys
+          alias_method :sort, :sort_keys
+
+          private
+          def prefix
+            "columns[#{@label}].window."
+          end
+
+          def add_parameter(merger, parameter)
+            @request.__send__(:add_parameter, merger, parameter)
+          end
+        end
+
         # @private
         class QueryMerger < ParameterMerger
           def to_parameters
@@ -203,7 +272,7 @@ module Groonga
             params = params1.merge(params2)
             query1 = params1[:query]
             query2 = params2[:query]
-            if query1.present? and query2.present?
+            if query1 and query2
               params[:query] = "(#{query1}) (#{query2})"
             else
               params[:query] = (query1 || query2)
@@ -220,7 +289,7 @@ module Groonga
             params = params1.merge(params2)
             filter1 = params1[:filter]
             filter2 = params2[:filter]
-            if filter1.present? and filter2.present?
+            if filter1 and filter2
               params[:filter] = "(#{filter1}) && (#{filter2})"
             else
               params[:filter] = (filter1 || filter2)
@@ -230,14 +299,14 @@ module Groonga
         end
 
         # @private
-        module FilterValueEscapable
+        module ScriptSyntaxValueEscapable
           private
-          def escape_filter_value(value)
+          def escape_script_syntax_value(value)
             case value
             when Numeric
-              value
+              value.to_s
             when TrueClass, FalseClass
-              value
+              value.to_s
             when NilClass
               "null"
             when String
@@ -248,7 +317,7 @@ module Groonga
               escaped_value = "["
               value.each_with_index do |element, i|
                 escaped_value << ", " if i > 0
-                escaped_value << escape_filter_value(element)
+                escaped_value << escape_script_syntax_value(element)
               end
               escaped_value << "]"
               escaped_value
@@ -256,9 +325,9 @@ module Groonga
               escaped_value = "{"
               value.each_with_index do |(k, v), i|
                 escaped_value << ", " if i > 0
-                escaped_value << escape_filter_value(k.to_s)
+                escaped_value << escape_script_syntax_value(k.to_s)
                 escaped_value << ": "
-                escaped_value << escape_filter_value(v)
+                escaped_value << escape_script_syntax_value(v)
               end
               escaped_value << "}"
               escaped_value
@@ -269,10 +338,11 @@ module Groonga
         end
 
         # @private
-        class FilterExpressionParameter
-          include FilterValueEscapable
+        class ScriptSyntaxExpressionParameter
+          include ScriptSyntaxValueEscapable
 
-          def initialize(expression, values)
+          def initialize(name, expression, values)
+            @name = name
             @expression = expression
             @values = values
           end
@@ -288,23 +358,35 @@ module Groonga
               expression = @expression
             end
 
-            if @values.is_a?(::Hash) and not @values.empty?
+            case @values
+            when ::Hash
               escaped_values = {}
               @values.each do |key, value|
-                escaped_values[key] = escape_filter_value(value)
+                escaped_values[key] = escape_script_syntax_value(value)
+              end
+              expression = expression % escaped_values
+            when ::Array
+              escaped_values = @values.collect do |value|
+                escape_script_syntax_value(value)
               end
               expression = expression % escaped_values
             end
 
             {
-              filter: expression,
+              @name => expression,
             }
           end
         end
 
+        class FilterExpressionParameter < ScriptSyntaxExpressionParameter
+          def initialize(expression, values)
+            super(:filter, expression, values)
+          end
+        end
+
         # @private
         class FilterEqualParameter
-          include FilterValueEscapable
+          include ScriptSyntaxValueEscapable
 
           def initialize(column_name, value)
             @column_name = column_name
@@ -313,7 +395,7 @@ module Groonga
 
           def to_parameters
             {
-              filter: "#{@column_name} == #{escape_filter_value(@value)}",
+              filter: "#{@column_name} == #{escape_script_syntax_value(@value)}",
             }
           end
         end
@@ -339,6 +421,16 @@ module Groonga
 
         # @private
         class SortKeysParameter < ValuesParameter
+          def initialize(prefix, output_columns)
+            names = [
+              :"#{prefix}sort_keys",
+            ]
+            super(names, output_columns)
+          end
+        end
+
+        # @private
+        class BackwardCompatibleSortKeysParameter < ValuesParameter
           def initialize(prefix, output_columns)
             names = [
               :"#{prefix}sort_keys",

data/lib/groonga/client/version.rb

@@ -16,6 +16,6 @@
 
 module Groonga
   class Client
-    VERSION = "0.3.9"
+    VERSION = "0.4.0"
   end
 end

data/test/request/select/{test-sort-keys-columns-parameter.rb → test-backward-compatible-sort-keys-parameter.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+# 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
@@ -14,9 +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
 
-class TestRequestSelectSortKeysParmater < Test::Unit::TestCase
+class TestRequestSelectBackwardCompatibleSortKeysParmater < Test::Unit::TestCase
   def sort_keys_parameter(prefix, sort_keys)
-    Groonga::Client::Request::Select::SortKeysParameter.new(prefix, sort_keys)
+    Groonga::Client::Request::Select::BackwardCompatibleSortKeysParameter.new(prefix, sort_keys)
   end
 
   def to_parameters(sort_keys)

data/test/request/select/test-sort-keys-parameter.rb

@@ -0,0 +1,70 @@
+# Copyright (C) 2016-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
+
+class TestRequestSelectSortKeysParmater < Test::Unit::TestCase
+  def sort_keys_parameter(prefix, sort_keys)
+    Groonga::Client::Request::Select::SortKeysParameter.new(prefix, sort_keys)
+  end
+
+  def to_parameters(sort_keys)
+    sort_keys_parameter("", sort_keys).to_parameters
+  end
+
+  def test_nil
+    assert_equal({},
+                 to_parameters(nil))
+  end
+
+  def test_string
+    assert_equal({
+                   :sort_keys => "-_score, _id",
+                 },
+                 to_parameters("-_score, _id"))
+  end
+
+  def test_empty_string
+    assert_equal({},
+                 to_parameters(""))
+  end
+
+  def test_symbol
+    assert_equal({
+                   :sort_keys => "_score",
+                 },
+                 to_parameters(:_score))
+  end
+
+  def test_array
+    assert_equal({
+                   :sort_keys => "-_score, _id",
+                 },
+                 to_parameters(["-_score", :_id]))
+  end
+
+  def test_empty_array
+    assert_equal({},
+                 to_parameters([]))
+  end
+
+  def test_prefix
+    parameter = sort_keys_parameter("slices[tag].", "-_score, _id")
+
+    assert_equal({
+                   :"slices[tag].sort_keys" => "-_score, _id",
+                 },
+                 parameter.to_parameters)
+  end
+end

data/test/request/test-select.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2016-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
@@ -19,6 +19,80 @@ class TestRequestSelect < Test::Unit::TestCase
     @request = Groonga::Client::Request::Select.new("posts")
   end
 
+  sub_test_case("#filter") do
+    def filter(*args)
+      @request.filter(*args).to_parameters
+    end
+
+    test("Numeric") do
+      assert_equal({
+                     :table => "posts",
+                     :filter => "rate == 5",
+                   },
+                   filter("rate == %{rate}", :rate => 5))
+    end
+
+    test("true") do
+      assert_equal({
+                     :table => "posts",
+                     :filter => "published == true",
+                   },
+                   filter("published == %{published}", :published => true))
+    end
+
+    test("false") do
+      assert_equal({
+                     :table => "posts",
+                     :filter => "published == false",
+                   },
+                   filter("published == %{published}", :published => false))
+    end
+
+    test("nil") do
+      assert_equal({
+                     :table => "posts",
+                     :filter => "function(null)",
+                   },
+                   filter("function(%{arg})", :arg => nil))
+    end
+
+    test("String") do
+      assert_equal({
+                     :table => "posts",
+                     :filter => "title == \"Hello\"",
+                   },
+                   filter("title == %{title}", :title => "Hello"))
+    end
+
+    test("Symbol") do
+      assert_equal({
+                     :table => "posts",
+                     :filter => "title == \"Hello\"",
+                   },
+                   filter("title == %{title}", :title => :Hello))
+    end
+
+    test("Array") do
+      assert_equal({
+                     :table => "posts",
+                     :filter => "function([\"a\", 29])",
+                   },
+                   filter("function(%{arg})", :arg => ["a", 29]))
+    end
+
+    test("Hash") do
+      assert_equal({
+                     :table => "posts",
+                     :filter => "function({\"string\": \"value\", \"number\": 29})",
+                   },
+                   filter("function(%{options})",
+                          :options => {
+                            "string" => "value",
+                            "number" => 29
+                          }))
+    end
+  end
+
   sub_test_case("#drilldowns") do
     def drilldown
       @request.drilldowns("label")
@@ -128,4 +202,52 @@ class TestRequestSelect < Test::Unit::TestCase
       end
     end
   end
+
+  sub_test_case("#columns") do
+    def column
+      @request.columns("label")
+    end
+
+    test "#stage" do
+      assert_equal({
+                     :table => "posts",
+                     :"columns[label].stage" => "output",
+                   },
+                   column.stage("output").to_parameters)
+    end
+
+    test "#type" do
+      assert_equal({
+                     :table => "posts",
+                     :"columns[label].type" => "Text",
+                   },
+                   column.type("Text").to_parameters)
+    end
+
+    test "#flags" do
+      assert_equal({
+                     :table => "posts",
+                     :"columns[label].flags" => "COLUMN_SCALAR|COMPRESS_LZ4",
+                   },
+                   column.flags(["COLUMN_SCALAR", "COMPRESS_LZ4"]).to_parameters)
+    end
+
+    test "#value" do
+      assert_equal({
+                     :table => "posts",
+                     :"columns[label].value" => "highlight_html(\"xxx\")",
+                   },
+                   column.value("highlight_html(%{text})", text: "xxx").to_parameters)
+    end
+
+    sub_test_case("#window") do
+      test "#sort_keys" do
+        assert_equal({
+                       :table => "posts",
+                       :"columns[label].window.sort_keys" => "_id",
+                     },
+                     column.window.sort_keys("_id").to_parameters)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groonga-client
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Haruka Yoshihara
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gqtp
@@ -223,10 +223,11 @@ files:
 - lib/groonga/client/version.rb
 - test/protocol/test-gqtp.rb
 - test/protocol/test-http.rb
+- test/request/select/test-backward-compatible-sort-keys-parameter.rb
 - test/request/select/test-filter-equal-parameter.rb
 - test/request/select/test-filter-expression-parameter.rb
 - test/request/select/test-output-columns-parameter.rb
-- test/request/select/test-sort-keys-columns-parameter.rb
+- test/request/select/test-sort-keys-parameter.rb
 - test/request/select/test-values-parameter.rb
 - test/request/test-base.rb
 - test/request/test-select.rb
@@ -277,10 +278,11 @@ test_files:
 - test/test-client.rb
 - test/test-script-syntax.rb
 - test/request/select/test-filter-expression-parameter.rb
+- test/request/select/test-backward-compatible-sort-keys-parameter.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-filter-equal-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