groonga-client 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f56e626e8d1f3ee3b00e41b67707cb96f92e7c88
-  data.tar.gz: ad74c24105a448472102e6c13a47c9fe9e2b0678
+  metadata.gz: 3dd4add841527a3ebe6c5e9a0e9cc83bb618a973
+  data.tar.gz: 3946ccfce7f6e1aa7e3105760fa0a305885ca629
 SHA512:
-  metadata.gz: 424579d18aa485f0615c7b0d2eb113f1acd35d5889a8665abe5200eadd05ac6a0273567105d79807d8957b9ad9e8409c1a4668c94a43c5e8e6e292bf317a47f6
-  data.tar.gz: fef4befdfa5f7ab2f61c39d1e23dae58b9f0e2d095ae24388d5a214e051b027a6dae5e8c07074217748de3ff258484ced5eb9750bada21a83565c588fec10aac
+  metadata.gz: 7a131ca1ab2cb04af14a5bb43e83dbac2f793e040c777354125bad17399453cdf26ef17390e931ce60b241b3cb3806131589cdd2fe836ec683ebb696ccf1ebe9
+  data.tar.gz: '080dec40f5d1b28a4b55c3d6e30e7c48261a6f0db3bffccdd7c55b755f2e59ac77bdb8dd909d4f1a53f901cf4d0f36c5eb1d0278c3d2872902a1cda7c7daa182'

data/doc/text/news.md

@@ -1,5 +1,13 @@
 # NEWS
 
+## 0.4.3 - 2017-04-21
+
+### Improvements
+
+  * `Groonga::Client::Request::Select::Filter#in_values`: Added a
+    convenience method to add a popular filter condition. You can
+    use this method by `filter.in_values("tags", "tag1", "tag2")`.
+
 ## 0.4.2 - 2016-03-09
 
 ### Improvements

data/lib/groonga/client.rb

@@ -37,7 +37,7 @@ module Groonga
         @@deafult_options
       end
 
-      # @param [Hash] options The new default options for
+      # @param options [Hash] The new default options for
       #   {Groonga::Client.new}.
       #
       # @since 0.2.0
@@ -46,7 +46,7 @@ module Groonga
       end
 
       # @!macro [new] initialize_options
-      #   @param [Hash] options The options.
+      #   @param options [Hash] The options.
       #   @option options [String, URI::Generic, URI::HTTP, URI::HTTPS]
       #     :url The URL of Groonga server.
       #   @option options [:gqtp, :http, :https] :protocol The

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

@@ -61,24 +61,47 @@ module Groonga
         #   The new request with the given condition.
         #
         # @overload filter(column_name, value)
-        #   @param [String, Symbol] column_name The target column name.
-        #   @param [Object] value The column value. It's escaped automatically.
-        #
         #   Adds a `#{column_name} == #{value}` condition.
         #
+        #   @param column_name [String, Symbol] The target column name.
+        #
+        #   @param value [Object] The column value. It's escaped
+        #     automatically.
+        #
         # @overload filter(expression, values=nil)
-        #   @param [String] expression The script syntax expression.
+        #
+        #   Adds a `#{expression % values}` condition.
+        #
+        #   @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 [nil, ::Hash] values The values to be expanded.
+        #
+        #   @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.
         #
-        #   Adds a `#{expression % values}` condition.
-        def filter(expression_or_column_name, values_or_value=nil)
+        # @overload filter
+        #
+        #   Returns a request object for filter condition. It provides
+        #   convenient methods to add a popular filter condition.
+        #
+        #   @example: Use in_values function
+        #      request.
+        #        filter.in_values("tags", "tag1", "tag2")
+        #          # -> --filter 'in_values(tags, "tag1", "tag2")'
+        #
+        #   @return [Groonga::Client::Request::Select::Filter]
+        #     The new request object for setting a filter condition.
+        #
+        #   @since 0.4.3
+        def filter(expression_or_column_name=nil, values_or_value=nil)
+          if expression_or_column_name.nil? and values_or_value.nil?
+            return Filter.new(self)
+          end
+
           if expression_or_column_name.is_a?(Symbol)
             parameter = FilterEqualParameter.new(expression_or_column_name,
                                                  values_or_value)
@@ -153,6 +176,45 @@ module Groonga
           parameters.key?(:offset) and parameters.key?(:limit)
         end
 
+        # @since 0.4.3
+        class Filter
+          def initialize(request)
+            @request = request
+          end
+
+          # Adds a `in_values` condition then return a new `select`
+          # request object.
+          #
+          # @example: Multiple conditions
+          #    request.
+          #      filter.in_values("tags", "tag1", "tag2").
+          #        # -> --filter 'in_values(tags, "tag1", "tag2")'
+          #      filter("user", "alice")
+          #        # -> --filter '(in_values(tags, "tag1", "tag2")) && (user == "alice")'
+          #
+          # @example: Ignore no values case
+          #    request.
+          #      filter.in_values("tags")
+          #        # -> --filter ''
+          #
+          # @param column_name [String, Symbol] The target column name.
+          #
+          # @param values [Object] The column values that cover target
+          #   column values.
+          #
+          # @return [Groonga::Client::Request::Select]
+          #   The new request with the given condition.
+          def in_values(column_name, *values)
+            parameter = FilterInValuesParameter.new(column_name, *values)
+            add_parameter(FilterMerger, parameter)
+          end
+
+          private
+          def add_parameter(merger, parameter)
+            @request.__send__(:add_parameter, merger, parameter)
+          end
+        end
+
         class LabeledDrilldown
           def initialize(request, label)
             @request = request
@@ -302,7 +364,7 @@ module Groonga
             filter2 = params2[:filter]
             if filter1 and filter2
               params[:filter] = "(#{filter1}) && (#{filter2})"
-            else
+            elsif filter1 or filter2
               params[:filter] = (filter1 || filter2)
             end
             params
@@ -396,6 +458,26 @@ module Groonga
         end
 
         # @private
+        class FilterInValuesParameter
+          include ScriptSyntaxValueEscapable
+
+          def initialize(column_name, *values)
+            @column_name = column_name
+            @values = values
+          end
+
+          def to_parameters
+            return {} if @values.empty?
+
+            escaped_values = @values.collect do |value|
+              escape_script_syntax_value(value)
+            end
+            {
+              filter: "in_values(#{@column_name}, #{escaped_values.join(", ")})",
+            }
+          end
+        end
+
         class FilterEqualParameter
           include ScriptSyntaxValueEscapable
 

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

@@ -38,9 +38,11 @@ module Groonga
         # Parses the response for the request of the command and returns
         # response object.
         #
-        # @param [Groonga::Command::Base] The command of the request.
-        # @param [String] The raw (not parsed) response returned by Groonga
-        #   server.
+        # @param command [Groonga::Command::Base] The command of the request.
+        #
+        # @param raw_response [String] The raw (not parsed) response
+        #   returned by Groonga server.
+        #
         # @return [Base]
         def parse(command, raw_response)
           klass = find(command.command_name)

data/lib/groonga/client/version.rb

@@ -16,6 +16,6 @@
 
 module Groonga
   class Client
-    VERSION = "0.4.2"
+    VERSION = "0.4.3"
   end
 end

data/test/request/test-select.rb

@@ -91,6 +91,35 @@ class TestRequestSelect < Test::Unit::TestCase
                             "number" => 29
                           }))
     end
+
+    sub_test_case("#in_values") do
+      def in_values(column_name, *values)
+        @request.filter.in_values(column_name, *values).to_parameters
+      end
+
+      test("numbers") do
+        assert_equal({
+                       :table => "posts",
+                       :filter => "in_values(ages, 2, 29)",
+                     },
+                     in_values("ages", 2, 29))
+      end
+
+      test("strings") do
+        assert_equal({
+                       :table => "posts",
+                       :filter => "in_values(tags, \"groonga\", \"have \\\"double\\\" quote\")",
+                     },
+                     in_values("tags", "groonga", "have \"double\" quote"))
+      end
+
+      test("no values") do
+        assert_equal({
+                       :table => "posts",
+                     },
+                     in_values("tags"))
+      end
+    end
   end
 
   sub_test_case("#drilldowns") do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groonga-client
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Haruka Yoshihara
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gqtp
@@ -270,38 +270,38 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 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-filter-expression-parameter.rb
+- test/results/test-table-list.rb
+- test/results/test-column-list.rb
+- test/request/test-generic.rb
+- test/request/test-merger.rb
+- test/request/test-select.rb
+- test/request/select/test-values-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/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/request/select/test-sort-keys-parameter.rb
+- test/request/select/test-filter-expression-parameter.rb
+- test/response/test-status.rb
+- test/response/test-error.rb
 - test/response/test-load.rb
-- test/response/test-column-list.rb
+- test/response/test-table-create.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-base.rb
+- test/response/test-table-remove.rb
 - test/response/test-select-command-version3.rb
+- test/response/test-column-list.rb
 - test/response/test-select-command-version1.rb
-- test/response/test-table-create.rb
-- test/response/test-table-remove.rb
-- test/results/test-column-list.rb
-- test/results/test-table-list.rb
+- test/response/test-schema.rb
+- test/run-test.rb
+- test/test-script-syntax.rb
+- test/protocol/test-gqtp.rb
+- test/protocol/test-http.rb
+- test/test-command.rb
+- test/test-client.rb