escape all lucene special characters, remove special case for !, upda…

…te unit tests
socialcast · Nov 11, 2011 · e84409c · e84409c
1 parent 552d93d
commit e84409c
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 25 deletions.
diff --git a/lib/elastic_searchable.rb b/lib/elastic_searchable.rb
@@ -43,13 +43,7 @@ def request(method, url, options = {})
     end
 
     def escape_query(string)
-      q = string.to_s.gsub(/([\(\)\[\]\{\}\?\\\"\\^])/,'\\\\\1')
+      string.to_s.gsub(/([\(\)\[\]\{\}\?\\\"!\^\+\-\*:~])/,'\\\\\1')
-      # escape any exclamation marks followed by whitespace or the end of the string
-      # lucene will interpret exclamation marks as a negation operator
-      # This should allow users to continue to use ! for negation while avoiding most errors
-      q.gsub!(/!(!|\s|\z|\\\))/, '\\!\1')
-      q.gsub!('!!','!\\!')
-      q
     end
 
     private

diff --git a/test/test_elastic_searchable.rb b/test/test_elastic_searchable.rb
@@ -476,40 +476,82 @@ def self.max_per_page
         assert_equal '\!', result
       end
 
-      should "escape two exclamation marks" do
+      should "escape ^" do
-        queryString = '!!'
+        queryString = '^'
         result = ElasticSearchable.escape_query(queryString)
-        assert_equal '\!\!', result
+        assert_equal '\^', result
       end
 
-      should "escape five exclamation marks" do
+      should "escape +" do
-        queryString = '!!!!!'
+        queryString = '+'
         result = ElasticSearchable.escape_query(queryString)
-        assert_equal '\!\!\!\!\!', result
+        assert_equal '\+', result
       end
 
-      should "leave exlamation at the beginning of a word intact" do
+      should "escape -" do
-        queryString = '!monkey'
+        queryString = '-'
         result = ElasticSearchable.escape_query(queryString)
-        assert_equal '!monkey', result
+        assert_equal '\-', result
       end
 
-      should "escape exclamation mark before whitespace" do
+      should "escape (" do
-        queryString = '! '
+        queryString = '('
         result = ElasticSearchable.escape_query(queryString)
-        assert_equal '\! ', result
+        assert_equal '\(', result
       end
 
-      should "escape exclamation mark before closing parens" do
+      should "escape )" do
-        queryString = '!)'
+        queryString = ')'
         result = ElasticSearchable.escape_query(queryString)
-        assert_equal '\!\)', result
+        assert_equal '\)', result
       end
 
-      should "escape ^" do
+      should "escape {" do
-        queryString = '^'
+        queryString = '}'
         result = ElasticSearchable.escape_query(queryString)
-        assert_equal '\^', result
+        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