elastic_searchable 1.2.1 → 1.2.2

data/lib/elastic_searchable/version.rb

@@ -1,4 +1,4 @@
 module ElasticSearchable
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end
 

data/lib/elastic_searchable.rb

@@ -42,6 +42,10 @@ module ElasticSearchable
       response
     end
 
+    def escape_query(string)
+      string.to_s.gsub(/([\(\)\[\]\{\}\?\\\"!\^\+\-\*:~])/,'\\\\\1')
+    end
+
     private
     # all elasticsearch rest calls return a json response when an error occurs.  ex:
     # {error: 'an error occurred' }

data/test/test_elastic_searchable.rb

@@ -468,6 +468,92 @@ class TestElasticSearchable < Test::Unit::TestCase
         assert_equal 2, @results.num_pages
       end
     end
+
+    context "escape_query" do
+      should "escape exclamation marks" do
+        queryString = '!'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\!', result
+      end
+
+      should "escape ^" do
+        queryString = '^'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\^', result
+      end
+
+      should "escape +" do
+        queryString = '+'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\+', result
+      end
+
+      should "escape -" do
+        queryString = '-'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\-', result
+      end
+
+      should "escape (" do
+        queryString = '('
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\(', result
+      end
+
+      should "escape )" do
+        queryString = ')'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\)', result
+      end
+
+      should "escape {" do
+        queryString = '}'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\}', result
+      end
+
+      should "escape [" do
+        queryString = '['
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\[', result
+      end
+
+      should "escape ]" do
+        queryString = ']'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\]', result
+      end
+
+      should 'escape "' do
+        queryString = '"'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\"', result
+      end
+
+      should "escape ~" do
+        queryString = '~'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\~', result
+      end
+
+      should "escape *" do
+        queryString = '*'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\*', result
+      end
+
+      should "escape :" do
+        queryString = ':'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\:', result
+      end
+
+      should "escape ?" do
+        queryString = '?'
+        result = ElasticSearchable.escape_query(queryString)
+        assert_equal '\?', result
+      end
+    end
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: elastic_searchable
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 1
   - 2
-  - 1
-  version: 1.2.1
+  - 2
+  version: 1.2.2
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-21 00:00:00 Z
+date: 2011-11-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord