groonga-client 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 716963b0471224b408c7282c106abf6963eec5e3
-  data.tar.gz: dda03fa55b5f474b590f81bce1c3fad4761c0b72
+  metadata.gz: cfbb43c1be922a0d52d798e0a7e3a768e36eaea6
+  data.tar.gz: 3904d0176fa3c87eda914b6065b2dd81d0abf6bb
 SHA512:
-  metadata.gz: 5d7ba9d303ce1da3aa3229d82d2af43d76ac4e663d5f6b17e2ffc72be7a385da2a715f4ce6423c3d127546e33b84605eb1d1e6f7eeed0b7b9cf9335fa21ae7be
-  data.tar.gz: acd4190d4b4e3f4e2b0bb72e9a69cc76eda467fa55fcd00289796b4a4c8ad5d0918af663acc9ba302666b6d4eb9b1ebad652280516629752fa351fd177f1b3cc
+  metadata.gz: 47e683987f841ad1bb077876f73023e76f26197f2796387fbbbee717a8902d9df071e0f5d2b8c9715cca7c24ab39c5519d38ea00798b7fadb8f2b0327ba30850
+  data.tar.gz: 8f48a51fa09b821d7665ff90e109a571aac501e676f587ad11a2b80c93fac61a8c267f2a030e1b3ebabb3ea2c3901a1baa46d75dac1b2326a1161cbefb32a790

data/doc/text/news.md

@@ -1,10 +1,19 @@
 # NEWS
 
+## 0.3.8 - 2016-12-21
+
+### Improvements
+
+  * `Groonga::Client::Request::Select#filter`: Supported
+    `filter(column_name, value)` usage. It's a shortcut of
+    `filter("#{column_name} == %{value}", value: value)`.
+
 ## 0.3.7 - 2016-12-20
 
 ### Improvements
 
-  * `Groonga::Client::Test::GroongaServerRunner`: Supported customizing Groonga server URL.
+  * `Groonga::Client::Test::GroongaServerRunner`: Supported
+    customizing Groonga server URL.
 
 ## 0.3.6 - 2016-12-20
 
@@ -16,40 +25,55 @@
 
   * `Groonga::Client::Response::Schema#plugins`: Supported method access.
 
-  * `Groonga::Client::Test::GroongaServerRunner`: Supported restoring DB for existing server.
+  * `Groonga::Client::Test::GroongaServerRunner`: Supported restoring
+    DB for existing server.
 
 ## 0.3.5 - 2016-12-19
 
 ### Improvements
 
-  * `Groonga::Client::Response::Schema::Column#value_type`: Made `value_type` elements method accessable.
+  * `Groonga::Client::Response::Schema::Column#value_type`: Made
+    `value_type` elements method accessable.
 
 ## 0.3.4 - 2016-12-13
 
 ### Improvements
 
   * Added request interface from groonga-client-rails.
-  * Added `Groonga::Client::Response::Schema::Index#full_text_searchable?`.
-  * Added `Groonga::Client::Response::Schema::Column#have_full_text_search_index?`.
-  * Added `Groonga::Client::Response::Schema::Table#have_full_text_search_index?`.
+
+  * Added
+    `Groonga::Client::Response::Schema::Index#full_text_searchable?`.
+
+  * Added
+    `Groonga::Client::Response::Schema::Column#have_full_text_search_index?`.
+
+  * Added
+    `Groonga::Client::Response::Schema::Table#have_full_text_search_index?`.
+
   * Added `Groonga::Client::Response::Select#slices`.
+
   * Added test helper from groonga-client-rails.
+
   * Added `Groonga::Client::Response#size` for Kaminari.
+
   * Added enumrable interface for `Groonga::Client::Response::Select`.
 
 ## 0.3.3 - 2016-12-07
 
 ### Improvements
 
-  * `Groonga::Load#loaded_ids`: Renamed from `Groonga::Load#ids`. Because it's renamed in Groonga.
+  * `Groonga::Load#loaded_ids`: Renamed from
+    `Groonga::Load#ids`. Because it's renamed in Groonga.
 
 ## 0.3.2 - 2016-12-06
 
 ### Improvements
 
-  * `Groonga::Load#n_loaded_records`: Added. It's a convenience method to get the number of loaded records.
+  * `Groonga::Load#n_loaded_records`: Added. It's a convenience method
+    to get the number of loaded records.
 
-  * `Groonga::Load#ids`: Added. It's for `load --output_ids yes --command_version 3` that can be used with Groonga 6.1.2 or later.
+  * `Groonga::Load#ids`: Added. It's for `load --output_ids yes
+    --command_version 3` that can be used with Groonga 6.1.2 or later.
 
 ## 0.3.1 - 2016-10-11
 

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

@@ -46,9 +46,49 @@ module Groonga
                         RequestParameter.new(:query, value))
         end
 
-        def filter(expression, values=nil)
-          add_parameter(FilterMerger,
-                        FilterParameter.new(expression, values))
+        # Adds a script syntax condition. If the request already has
+        # any filter condition, they are combined by AND.
+        #
+        # @example: Multiple filters
+        #    request.
+        #      filter("user", "alice").
+        #        # -> --filter 'user == "alice"'
+        #      filter("tags @ %{tag}", tag: "Ruby")
+        #        # -> --filter '(user == "alice") && (tags @ "Ruby")'
+        #
+        # @return [Groonga::Client::Request::Select]
+        #   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.
+        #
+        # @overload filter(expression, values=nil)
+        #   @param [String] expression 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.
+        #      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)
+          if expression_or_column_name.is_a?(Symbol)
+            parameter = FilterEqualParameter.new(expression_or_column_name,
+                                                 values_or_value)
+          elsif values_or_value.nil? or values_or_value.is_a?(::Hash)
+            parameter = FilterExpressionParameter.new(expression_or_column_name,
+                                                      values_or_value)
+          else
+            parameter = FilterEqualParameter.new(expression_or_column_name,
+                                                 values_or_value)
+          end
+          add_parameter(FilterMerger, parameter)
         end
 
         def output_columns(value)
@@ -190,36 +230,7 @@ module Groonga
         end
 
         # @private
-        class FilterParameter
-          def initialize(expression, values)
-            @expression = expression
-            @values = values
-          end
-
-          def to_parameters
-            case @expression
-            when String
-              return {} if /\A\s*\z/ === @expression
-              expression = @expression
-            when NilClass
-              return {}
-            else
-              expression = @expression
-            end
-
-            if @values.is_a?(::Hash) and not @values.empty?
-              escaped_values = {}
-              @values.each do |key, value|
-                escaped_values[key] = escape_filter_value(value)
-              end
-              expression = expression % escaped_values
-            end
-
-            {
-              filter: expression,
-            }
-          end
-
+        module FilterValueEscapable
           private
           def escape_filter_value(value)
             case value
@@ -257,6 +268,56 @@ module Groonga
           end
         end
 
+        # @private
+        class FilterExpressionParameter
+          include FilterValueEscapable
+
+          def initialize(expression, values)
+            @expression = expression
+            @values = values
+          end
+
+          def to_parameters
+            case @expression
+            when String
+              return {} if /\A\s*\z/ === @expression
+              expression = @expression
+            when NilClass
+              return {}
+            else
+              expression = @expression
+            end
+
+            if @values.is_a?(::Hash) and not @values.empty?
+              escaped_values = {}
+              @values.each do |key, value|
+                escaped_values[key] = escape_filter_value(value)
+              end
+              expression = expression % escaped_values
+            end
+
+            {
+              filter: expression,
+            }
+          end
+        end
+
+        # @private
+        class FilterEqualParameter
+          include FilterValueEscapable
+
+          def initialize(column_name, value)
+            @column_name = column_name
+            @value = value
+          end
+
+          def to_parameters
+            {
+              filter: "#{@column_name} == #{escape_filter_value(@value)}",
+            }
+          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.3.7"
+    VERSION = "0.3.8"
   end
 end

data/test/request/select/test-filter-equal-parameter.rb

@@ -0,0 +1,82 @@
+# Copyright (C) 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
+# 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 TestRequestSelectFilterEqualParmater < Test::Unit::TestCase
+  def filter_parameter(column_name, value)
+    Groonga::Client::Request::Select::FilterEqualParameter.new(column_name,
+                                                               value)
+  end
+
+  def to_parameters(column_name, value)
+    filter_parameter(column_name, value).to_parameters
+  end
+
+  sub_test_case("column name") do
+    def test_string
+      assert_equal({
+                     :filter => "_key == 29",
+                   },
+                   to_parameters("_key", 29))
+    end
+
+    def test_symbol
+      assert_equal({
+                     :filter => "_key == 29",
+                   },
+                   to_parameters(:_key, 29))
+    end
+  end
+
+  sub_test_case("value") do
+    def test_string
+      filter = <<-'FILTER'.strip
+title == "[\"He\\ llo\"]"
+      FILTER
+      assert_equal({
+                     :filter => filter,
+                   },
+                   to_parameters("title", "[\"He\\ llo\"]"))
+    end
+
+    def test_symbol
+      assert_equal({
+                     :filter => "title == \"Hello\"",
+                   },
+                   to_parameters("title", :Hello))
+    end
+
+    def test_number
+      assert_equal({
+                     :filter => "age == 29",
+                   },
+                   to_parameters("age", 29))
+    end
+
+    def test_true
+      assert_equal({
+                     :filter => "published == true",
+                   },
+                   to_parameters("published", true))
+    end
+
+    def test_false
+      assert_equal({
+                     :filter => "published == false",
+                   },
+                   to_parameters("published", false))
+    end
+  end
+end

data/test/request/select/{test-filter-parameter.rb → test-filter-expression-parameter.rb}

@@ -14,9 +14,10 @@
 # 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 TestRequestSelectFilterParmater < Test::Unit::TestCase
+class TestRequestSelectFilterExpressionParmater < Test::Unit::TestCase
   def filter_parameter(expression, values=nil)
-    Groonga::Client::Request::Select::FilterParameter.new(expression, values)
+    Groonga::Client::Request::Select::FilterExpressionParameter.new(expression,
+                                                                    values)
   end
 
   def to_parameters(expression, values=nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groonga-client
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Haruka Yoshihara
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gqtp
@@ -223,7 +223,8 @@ files:
 - lib/groonga/client/version.rb
 - test/protocol/test-gqtp.rb
 - test/protocol/test-http.rb
-- test/request/select/test-filter-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-values-parameter.rb
@@ -275,9 +276,10 @@ summary: Groonga-client is a client for Groonga (http://groonga.org/) implemente
 test_files:
 - test/test-client.rb
 - test/test-script-syntax.rb
-- test/request/select/test-filter-parameter.rb
+- test/request/select/test-filter-expression-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