groonga-client 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f33db5326ba66ef34f99764539597e287337df5
-  data.tar.gz: ba050f7b65edc1889f843cef883e1784b29c1b8a
+  metadata.gz: b8a5665848bb07469199965c91102537be1de8ba
+  data.tar.gz: b199fc33a43d039152d4ba068c415259bc4da524
 SHA512:
-  metadata.gz: a7869a7e5ac081ed34339ae21665ff97802ed473eb765cb7ef388420319ee5396ab95bde8162a37e0fc434a989aa0a3daa9808d9072b239f34d7704875230afb
-  data.tar.gz: 44ffaaa3ec83082d908db61985675827684cb8e850317a9363ddebecf1fe84cc1cd52eb96ed7dd27f299fbe90ddd7aefcf0c2efe763a1a67de8c3c7a7f4bce92
+  metadata.gz: 9206ea5d72f485a6a47b02bcd4518efe6e1893cc1f462432ac9d9afd67cfb88b3faee72c574e516bad9c76485d94a6efddb9246049773230864c414144a0444c
+  data.tar.gz: 39403cfa11da317eb5e17754a7f637234f2c250b2dd62922f501dcc2c0888afa3c74bf849573e61da0d3d14acb1f5b76b7ea7b230fa389b378a2d033017a8aa4

data/doc/text/news.md

@@ -1,5 +1,17 @@
 # NEWS
 
+## 0.5.1 - 2017-08-21
+
+### Improvements
+
+  * `Groonga::Client::Request::Select#scorer`: Added a convenience
+    method to set scorer. You can use this method by
+    `scorer("2 * %{column}", column: :rate)`.
+
+  * `Groonga::Client::Request::Select#query_flags`: Added a
+    convenience method to set query flags. You can use this method by
+    `query_flags(["ALLOW_COLUMN", "QUERY_NO_SYNTAX_ERROR"])`.
+
 ## 0.5.0 - 2017-05-08
 
 ### Improvements

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

@@ -47,6 +47,54 @@ module Groonga
                         RequestParameter.new(:query, value))
         end
 
+        # Sets flags to custom how to parse query.
+        #
+        # @example One flag
+        #    request.
+        #      # Support "COLUMN_NAME:..." syntax
+        #      query_flags("ALLOW_COLUMN").
+        #        # -> --query_flags 'ALLOW_COLUMN'
+        #      query("title:@Groonga")
+        #        # -> --query_flags 'ALLOW_COLUMN'
+        #        #    --query 'title:@Groonga'
+        #
+        # @example Multiple flags
+        #    request.
+        #      # Support "COLUMN_NAME:..." syntax
+        #      # Fallback syntax error query to searchable query
+        #      query_flags(["ALLOW_COLUMN", "QUERY_NO_SYNTAX_ERROR"]).
+        #        # -> --query_flags 'ALLOW_COLUMN'
+        #      query("nonexistent:@Groonga")
+        #        # -> --query_flags 'ALLOW_COLUMN'
+        #        #    --query 'nonexistent:@Groonga'
+        #        # Normally, "nonexistent:@Groonga" is syntax error
+        #        # but it's parsed as
+        #        # "search by one keyword: 'nonexistent:@Groonga'"
+        #        # because QUERY_NO_SYNTAX_ERROR flag is used
+        #
+        # @return [Groonga::Client::Request::Select]
+        #
+        #   The new request with the given flag.
+        #
+        # @overload query_flags(flag)
+        #
+        #   Sets a `#{flag}` flag.
+        #
+        #   @param flag [String] The flag to be used.
+        #
+        #   @since 0.5.1
+        #
+        # @overload query_flags(flags)
+        #
+        #   Sets `#{flag1}|#{flag2}|...` flags.
+        #
+        #   @param flags [::Array<String>] The flags to be used.
+        #
+        #   @since 0.5.1
+        def query_flags(value)
+          flags_parameter(:query_flags, value)
+        end
+
         # Adds a script syntax condition. If the request already has
         # any filter condition, they are combined by AND.
         #
@@ -143,6 +191,70 @@ module Groonga
           end
         end
 
+        # Sets scorer.
+        #
+        # @return [Groonga::Client::Request::Select]
+        #   The new request with the given scorer.
+        #
+        # @since 0.5.1
+        #
+        # @overload scorer(column_name)
+        #
+        #   Sets `_score = #{column_name}` scorer.
+        #
+        #   @example Use column value as score
+        #      request.scorer(:rate)
+        #          # -> --scorer '_score = rate'
+        #
+        #   @param column_name [Symbol] The column name to be used as score.
+        #
+        # @overload scorer(expression, values=nil)
+        #
+        #   Adds a `_score = #{expression % values}` scorer. If
+        #   `expression` is already assignment form such as `_score =
+        #   %{column}`, `_score = ` isn't prepended automatically.
+        #
+        #   @example Compute score by expression
+        #      request.scorer("2 * rate")
+        #          # -> --scorer '_score = 2 * rate'
+        #
+        #   @example Expand values
+        #      request.scorer("2 * %{column}", column: :rate)
+        #          # -> --scorer '_score = 2 * rate'
+        #
+        #   @param expression [String] The script syntax expression.
+        #      It can includes `%{name}`s as placeholder. They are expanded
+        #      by `String#%` with the given `values` argument.
+        #
+        #   @param values [nil, ::Hash] The values to be expanded.
+        #      If the given `expression` doesn't have placeholder, you
+        #      should specify `nil`.
+        #
+        #      Values are escaped automatically. Values passed from
+        #      external should be escaped.
+        def scorer(expression_or_column_name, values=nil)
+          case expression_or_column_name
+          when Symbol
+            expression = "_score = %{column}"
+            column_name = expression_or_column_name
+            values = { column: column_name }
+          when String
+            expression = expression_or_column_name
+            case expression
+            when /\A\s*\z/
+              expression = nil
+            when /\A[_a-zA-Z\d]+\s*=/
+              # have assignment such as "_score = "
+            else
+              expression = "_score = #{expression}"
+            end
+          else
+            expression = expression_or_column_name
+          end
+          add_parameter(OverwriteMerger,
+                        ScorerExpressionParameter.new(expression, values))
+        end
+
         def output_columns(value)
           add_parameter(OverwriteMerger,
                         OutputColumnsParameter.new("", value))
@@ -729,6 +841,12 @@ module Groonga
           end
         end
 
+        class ScorerExpressionParameter < ScriptSyntaxExpressionParameter
+          def initialize(expression, values)
+            super(:scorer, expression, values)
+          end
+        end
+
         # @private
         class OutputColumnsParameter < ValuesParameter
           def initialize(prefix, output_columns)

data/lib/groonga/client/version.rb

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

data/test/request/select/test-scorer.rb

@@ -0,0 +1,112 @@
+# Copyright (C) 2017  Yasuhiro Horimoto <horimoto@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
+# 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 TestRequestSelectScorer < Test::Unit::TestCase
+  setup do
+    @request = Groonga::Client::Request::Select.new("posts")
+  end
+
+  def scorer(*args)
+    @request.scorer(*args).to_parameters
+  end
+
+  sub_test_case("expression") do
+    def test_nil
+      assert_equal({
+                     :table => "posts",
+                   },
+                   scorer(nil))
+    end
+
+    def test_string
+      assert_equal({
+                     :table => "posts",
+                     :scorer => "_score = age",
+                   },
+                   scorer("_score = age"))
+    end
+
+    def test_empty_string
+      assert_equal({
+                     :table => "posts",
+                   },
+                   scorer(""))
+    end
+
+    def test_space_only_string
+      assert_equal({
+                     :table => "posts",
+                   },
+                   scorer(" \t\r\n"))
+    end
+
+    def test_have_assignment
+      assert_equal({
+                     :table => "posts",
+                     :scorer => "persistent_score = _score",
+                   },
+                   scorer("persistent_score = %{score}", score: :_score))
+    end
+
+    def test_symbol
+      assert_equal({
+                     :table => "posts",
+                     :scorer => "_score = age",
+                   },
+                   scorer(:age))
+    end
+  end
+
+  sub_test_case("values") do
+    test("Symbol") do
+      assert_equal({
+                     :table => "posts",
+                     :scorer => "_score = age",
+                   },
+                   scorer("_score = %{column}", :column => :age))
+    end
+
+    test("Symbols") do
+      assert_equal({
+                     :table => "posts",
+                     :scorer => "_score = -geo_distance(location, \"35.68138194x139.766083888889\")",
+                   },
+                   scorer("-geo_distance(%{column}, %{point})",
+                           column: :location, point: "35.68138194x139.766083888889"))
+    end
+
+    test("Numeric") do
+      assert_equal({
+                     :table => "posts",
+                     :scorer => "_score = 29",
+                   },
+                   scorer("_score = %{value}",
+                          :value => 29))
+    end
+  end
+
+  def test_multiple
+      assert_equal({
+                     :table => "posts",
+                     :scorer => "_score = age",
+                   },
+                   @request.
+                     scorer("_score = %{value}", :value => 29).
+                     scorer(:age).
+                     to_parameters)
+  end
+end

data/test/request/test-select.rb

@@ -311,4 +311,26 @@ class TestRequestSelect < Test::Unit::TestCase
       end
     end
   end
+
+  sub_test_case("#query_flags") do
+    def query_flags(*args)
+      @request.query_flags(*args).to_parameters
+    end
+
+    test("one") do
+      assert_equal({
+                     :table => "posts",
+                     :query_flags => "ALLOW_COLUMN",
+                   },
+                   query_flags("ALLOW_COLUMN"))
+    end
+
+    test("multiple") do
+      assert_equal({
+                     :table => "posts",
+                     :query_flags => "ALLOW_COLUMN|QUERY_NO_SYNTAX_ERROR",
+                   },
+                   query_flags(["ALLOW_COLUMN", "QUERY_NO_SYNTAX_ERROR"]))
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groonga-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Haruka Yoshihara
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gqtp
@@ -226,6 +226,7 @@ files:
 - test/request/select/test-backward-compatible-sort-keys-parameter.rb
 - test/request/select/test-filter.rb
 - test/request/select/test-output-columns-parameter.rb
+- test/request/select/test-scorer.rb
 - test/request/select/test-sort-keys-parameter.rb
 - test/request/select/test-values-parameter.rb
 - test/request/test-generic.rb
@@ -269,37 +270,38 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 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/test-script-syntax.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/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-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/response/helper.rb
-- test/response/test-status.rb
-- test/response/test-column-list.rb
-- test/response/test-schema.rb
-- test/response/test-table-list.rb
-- test/response/test-load.rb
-- test/response/test-base.rb
 - test/response/test-table-remove.rb
-- test/test-script-syntax.rb
-- test/protocol/test-http.rb
-- test/protocol/test-gqtp.rb
 - test/results/test-column-list.rb
 - test/results/test-table-list.rb
-- test/test-command.rb
-- test/request/select/test-values-parameter.rb
-- test/request/select/test-filter.rb
-- test/request/select/test-output-columns-parameter.rb
-- test/request/select/test-sort-keys-parameter.rb
-- test/request/select/test-backward-compatible-sort-keys-parameter.rb
-- test/request/test-merger.rb
-- test/request/test-generic.rb
-- test/request/test-select.rb
-- test/test-client.rb