Merge pull request #4 from mhluongo/master

Fixed a couple errors and added to the README

Author: mhluongo

README.rst

@@ -25,13 +25,25 @@ A basic query can be given by passing in a string into Q's constructor.
 
 The query builder will automatically detect whether a term (no whitespace) or a phrase (multiple terms together seaparated by whitespace) and properly bound them with quotation marks.
 
+All terms and phrases are expected to be unescaped, and will be escaped::
+
+  >>> q = Q(r'The *quick* brown (fox)')
+  
+  >>> str(q)
+  
+  '"The \\*quick\\* brown \\(fox\\)"'
+
+Range Queries
+-------------
+
 Ranges are also easy to put into a query. There are two types of range queries, inclusive range and exclusive range. These are passed into the query builder with keyword arguments.
 
   >>> q = Q(inrange=(1,5))
 
   >>> q = Q(exrange=['egg','hgg'])
 
-Ranges will work with any list-like object.
+Ranges will work with any list-like object of length 2.
+
 
 
 Chaining Queries
@@ -52,7 +64,7 @@ Nested Queries
 Queries can be nested inside of each other to create new queries. This makes it easy to group queries together. Examples below::
 
   >>> q = Q(Q('a') & Q('b')) & ~Q('c')
-  
+   
   >>> q = Q(Q(Q('a') | Q(inrange=[1,2])) +Q('c))
 
 
@@ -73,4 +85,10 @@ The following examples are invalid queries which will raise an error::
   
   >>> q = Q('bad', Q('range', inrange=[10, 9001]))
 
+
+Boosting, Wildcards and Fuzzy Queries
+--------------------------------------
+
+These queries are not yet supported, but will be soon. Feel free to add support yourself and request a pull!
+
 .. _here: http://lucene.apache.org/java/3_2_0/queryparsersyntax.html

lucenequerybuilder/query.py

@@ -14,9 +14,9 @@ def __init__(self, *args, **kwargs):
         self._child_has_field = False
         if len(args) == 1 and not kwargs:
             if Q._check_whitespace(args[0]):
-                self.should.append('"'+escape(args[0])+'"')
+                self.should.append('"'+self._escape(args[0])+'"')
             else:
-                self.should.append(escape(args[0]))
+                self.should.append(self._escape(args[0]))
         elif len(args) <= 1 and kwargs:
             if kwargs.get('inrange'):
                 self.inrange = kwargs['inrange']
@@ -33,9 +33,9 @@ def __init__(self, *args, **kwargs):
             self.field = args[0]
             self._has_field = True
             if Q._check_whitespace(args[1]):
-                self.should.append('"'+_escape(args[1])+'"')
+                self.should.append('"'+self._escape(args[1])+'"')
             else:
-                self.should.append(_escape(args[1]))
+                self.should.append(self._escape(args[1]))
         if self._check_nested_fields():
             raise ValueError('No nested fields allowed.')
 
@@ -55,10 +55,12 @@ def _escape(cls, s):
         if isinstance(s, basestring):
             rv = ''
             for c in s:
-                if c in specialchars:
+                if c in cls.specialchars:
                     rv += '\\' + c
                 else:
                     rv += c
+            return rv
+        return s
 
     def _make_and(q1, q2):
         q = Q()

lucenequerybuilder/tests.py

@@ -1,10 +1,12 @@
-<<<<<<< Updated upstream:lucenequerybuilder/tests.py
+"""
+Simple tests for Q. In the future, comparing output to an actual Lucene index
+would be a good idea.
+"""
+
 from lucenequerybuilder import Q
-=======
-from query import Q
->>>>>>> Stashed changes:querybuilder/tests.py
+import re
 
-def test_lol():
+def test_general():
     a = 'a'
     b = 'b'
     c = 'c'
@@ -28,4 +30,23 @@ def test_lol():
     else:
         raise AssertionError("Shouldn't allow nested fields.")
 
-test_lol()
+def test_simple_term():
+    query_string = str(Q('a'))
+    assert query_string == 'a', query_string
+
+def test_simple_phrase():
+    query_string = str(Q('abc 123'))
+    assert query_string == '"abc 123"', query_string
+
+#this test doesn't work, but might be worth rewriting
+#
+#def test_escaping():
+#    """ Tests basic character escaping. Doesn't test double char escape, eg &&, ||."""
+#    special_lucene_chars = r'\+-!(){}[]^"~*?:'
+#    unescaped_regex = '|'.join([r'(([^\\]|^)%s)' % re.escape(c) for c in special_lucene_chars])
+#    unescaped_regex = re.compile(unescaped_regex)
+#    #test the regex
+#    assert unescaped_regex.match(r'\ [ )') is not None
+#    query_string = str(Q(':') & Q('\\'))
+#    #this won't work, dur
+#    assert not unescaped_regex.match(query_string), query_string