Make 'begin' and 'end' markers case-insensitive. Make 'snip' commands not need a colon.

Author: desplesda

Pipfile.lock

@@ -6,9 +6,9 @@
 import logging
 from fuzzywuzzy import process
 
-SNIP_PREFIX="// snip:"
-SNIP_FILE_PREFIX="// snip-file:"
-TAG_PREFIX="// tag:"
+SNIP_PREFIX="// snip"
+SNIP_FILE_PREFIX="// snip-file"
+TAG_PREFIX="// tag"
 
 # The virtual "ref" that represents the current state of the files on disk,
 # and may not necessarily be stored in the index or in a commit. Uses a
@@ -57,7 +57,7 @@ def find(base_path, extensions):
     @property 
     def cleaned_contents(self):
         """Returns a version of 'text' that has no expanded snippets."""
-        snip_with_code = re.compile("(//.*snip(\-file)*:.*\n)(\[.*\]\n)*----\n(.*\n)*?----\n")
+        snip_with_code = re.compile("(//.*snip(\-file)*:?.*\n)(\[.*\]\n)*----\n(.*\n)*?----\n", flags=re.IGNORECASE)
         cleaned = re.sub(snip_with_code, r'\1', self.contents)
         return cleaned
 
@@ -80,19 +80,25 @@ def snippets(self):
         # encountered in the document
         current_ref = WORKSPACE_REF
 
+        tag_regex = re.compile(r"$\/\/\s*tag:?\s*(.*)^", flags=re.IGNORECASE)
+        snip_regex = re.compile(r"$\/\/\s*tag:?\s*(.*)^", flags=re.IGNORECASE)
+
         for line in source_lines:
             output_lines.append(line)
 
             # change which tag we're looking at if we hit an instruction to
             # do so
-            if line.startswith(TAG_PREFIX):
-                current_ref = line[len(TAG_PREFIX)+1:].strip()
+            tag = tag_regex.match(line)
+
+            if tag:
+                current_ref = tag.groups(1).strip()
 
             # is this a snippet?
-            if line.startswith(SNIP_PREFIX):
+            snippet = snip_regex.match(line)
+            if snippet:
 
                 # figure out what tags we're supposed to be using here
-                query_text = line[len(SNIP_PREFIX)+1:]
+                query_text = snippet.groups(1)
 
                 # build the tag query from this
                 query = TagQuery(query_text, ref=current_ref)

source_document.py

@@ -167,8 +167,8 @@ def parse_lines(self, data):
         # begin_re = re.compile(r"\s*(\/\/|#)\s*BEGIN\s+([^\s]+)")
         # end_re = re.compile(r"\s*(\/\/|#)\s*END\s+([^\s]+)")
 
-        begin_re = re.compile(r"\s*(\/\/|\#)\s*BEGIN\s+([^\s]+)")
-        end_re = re.compile(r"\s*(\/\/|\#)\s*END\s+([^\s]+)")
+        begin_re = re.compile(r"\s*(\/\/|\#)\s*BEGIN\s+([^\s]+)", flags=re.IGNORECASE)
+        end_re = re.compile(r"\s*(\/\/|\#)\s*END\s+([^\s]+)", flags=re.IGNORECASE)
 
 
         current_tags = []
@@ -255,11 +255,11 @@ def __init__(self, query_string, ref="HEAD"):
         for token in tokens:
 
             # Change mode if we have to
-            if token == "except":
+            if token.lower() == "except":
                 mode = EXCLUDE_TAGS
-            elif token == "highlighting":
+            elif token.lower() == "highlighting":
                 mode = HIGHLIGHT_TAGS
-            elif token == "isolating":
+            elif token.lower() == "isolating":
                 mode = ISOLATE_TAGS
 
             # Otherwise, add it to the list of tokens

tagged_document.py

@@ -27,11 +27,20 @@ This is version 2 of source A.
 Finally, let's go back to the working copy.
 
 // tag: working-copy
-// snip: sourceA
+// snip sourceA
 [source,swift]
 ----
 This is version 4 of source A. This version of the file is not committed to the test repo.
 This line is tagged with both 'sourceA' and 'sourceA-1'.
 ----
 
 This is the final line of the example.
+
+Let's check that python quotes work.
+
+// snip python-quotes
+[source,swift]
+----
+This snippet uses python quotes, and is in lowercase.
+----
+

tests/sample-expanded.txt

@@ -14,6 +14,11 @@ Let's change to see the second tag.
 Finally, let's go back to the working copy.
 
 // tag: working-copy
-// snip: sourceA
+// snip sourceA
 
 This is the final line of the example.
+
+Let's check that python quotes work.
+
+// snip python-quotes
+

tests/sample.txt

@@ -1,3 +1,8 @@
 // BEGIN sourceB
 This file is not committed to the test repo.
-// END sourceB
+// END sourceB
+
+# begin python-quotes
+This snippet uses python quotes, and is in lowercase.
+# end python-quotes
+

tests/sourceB.txt

@@ -6,7 +6,7 @@
 class SourceDocumentTests(unittest.TestCase):
     """Unit tests for the Document class"""
     def test_cleaning(self):
-        """Tests removing snippets"""
+        # Tests removing snippets
 
         input_path = "tests/sample-expanded.txt"
         reference_path = "tests/sample.txt"
@@ -26,7 +26,7 @@ def test_finding_documents(self):
 
 
     def test_processing(self):
-        """Tests rendering a snippet using tagged documents."""
+        # Tests rendering a snippet using tagged documents.
         repo = create_test_repo()
 
         tagged_documents = TaggedDocument.find(repo, ["txt"])