Add tests, setup CI and CQ

Author: sanketsaurav

.circleci/config.yml

@@ -0,0 +1,29 @@
+version: 2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/python:3.7
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+          - cache-{{ checksum "Pipfile.lock" }}
+          - cache-
+      - run:
+          name: install dependencies
+          command: pipenv sync --dev
+
+      - save_cache:
+          paths:
+            - ~/.local
+            - ~/.cache
+          key: cache-{{ checksum "Pipfile.lock" }}
+
+      - run:
+          name: run tests
+          command: make test

.coveragerc

@@ -0,0 +1,17 @@
+version = 1
+
+exclude_patterns = [
+  'tests/data/*',
+]
+
+test_patterns = [
+  'tests/*'
+]
+
+[[analyzers]]
+name = "python"
+enabled = true
+
+  [analyzers.meta]
+  max_line_length = 90
+  skip_doc_coverage = ["module", "magic", "init"]

.deepsource.toml

@@ -1,4 +1,4 @@
 test:
-	pipenv run pytest --cov
+	pipenv run pytest
 
 .DEFAULT_GOAL := test

Makefile

@@ -5,7 +5,7 @@ verify_ssl = true
 
 [dev-packages]
 pytest = "*"
-pytest-cov = "*"
+lxml = "*"
 
 [packages]
 pygments = "*"

Pipfile

@@ -25,20 +25,23 @@ def __init__(self, *args, **kwargs):
             # if begin_line is set, set `linenostart` to match it
             self.linenostart = self.begin_line
 
+            # since we've changed the beginning of this file, we'll need to
+            # offset the hl_lines, if available, appropriately.
+            hl_line_offset = self.begin_line - 1
+            self.hl_lines = [i - hl_line_offset for i in self.hl_lines or []]
+        else:
+            self.begin_line = None
+
         end_line = kwargs.get('end_line')
         self.end_line = int(end_line) if end_line else None
 
         # validate sanity of begin_line and end_line
-        if self.end_line < self.begin_line:
+        if ((self.begin_line and self.end_line) and
+                (self.end_line < self.begin_line)):
             raise ValueError(
                 "Value for `end_line` must be less than or equal to `begin_line`"
             )
 
-        # since we've changed the beginning of this file, we'll need to
-        # offset the hl_lines, if available, appropriately.
-        hl_line_offset = self.begin_line - 1
-        self.hl_lines = [i - hl_line_offset for i in self.hl_lines or []]
-
     def _format_lines(self, tokensource, *_, **__):
         """
         Override the default method to support extraction of the expected

Pipfile.lock

@@ -1,6 +1,87 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+from subprocess import run
+from lxml import html, etree
 
 
-def test_foo():
-    assert True
+SAMPLE_FILE = 'tests/data/sample.py'
+
+
+def test_html_slice_without_range(tmp_path):
+    """
+    Verify that using the HtmlSliceFormatter without passing
+    begin_line and end_line works identical to HtmlFormatter.
+    """
+
+    # run with HtmlFormatter
+    output_html = tmp_path / 'html'
+    run([
+        'pygmentize', '-f', 'html',
+        '-O', 'linenos=table,hl_lines="28 29 30"',
+        '-o', output_html, SAMPLE_FILE
+    ])
+    with open(output_html, 'r') as file_desc:
+        output_html_content = file_desc.read()
+
+    # run with HtmlSliceFormatter
+    output_html_slice = tmp_path / 'html_slice'
+    run([
+        'pygmentize', '-f', 'formatters/html_slice.py:HtmlSliceFormatter', '-x',
+        '-O', 'linenos=table,hl_lines="28 29 30"',
+        '-o', output_html_slice, SAMPLE_FILE
+    ])
+    with open(output_html_slice, 'r') as file_desc:
+        output_html_slice_content = file_desc.read()
+
+    assert output_html_content == output_html_slice_content
+
+
+def test_html_slice_with_range(tmp_path):
+    """
+    Verify that using the HtmlSliceFormatter when passing
+    begin_line and end_line works as expected.
+    """
+    # run with HtmlFormatter
+    output_html = tmp_path / 'html'
+    run([
+        'pygmentize', '-f', 'html',
+        '-O', 'linenos=table,hl_lines="28 29 30"',
+        '-o', output_html, SAMPLE_FILE
+    ])
+    with open(output_html, 'r') as file_desc:
+        output_html_content = file_desc.read()
+    tree = html.fromstring(output_html_content)
+
+    # run with HtmlSliceFormatter
+    output_html_slice = tmp_path / 'html_slice'
+    run([
+        'pygmentize', '-f', 'formatters/html_slice.py:HtmlSliceFormatter', '-x',
+        '-O', 'linenos=table,hl_lines="28 29 30",begin_line=24,end_line=32',
+        '-o', output_html_slice, SAMPLE_FILE
+    ])
+    with open(output_html_slice, 'r') as file_desc:
+        output_html_slice_content = file_desc.read()
+    slice_tree = html.fromstring(output_html_slice_content)
+
+    # in the output for slice, check that line numbers are sane
+    line_nos = slice_tree.xpath(
+        "//div[contains(@class, 'linenodiv')]"
+    )[0][0].text.split('\n')
+    assert int(line_nos[0]) == 24
+    assert int(line_nos[-1]) == 32
+
+    # the markup for the highlighted code must be a subset of the original
+    # highlighted code
+    original_code = ''.join(
+        [etree.tostring(child).decode() for
+         child in tree.xpath(
+             "//div[contains(@class, 'highlight')]")[0][0].iterdescendants()
+         ])
+
+    sliced_code = ''.join(
+        [etree.tostring(child).decode() for
+         child in tree.xpath(
+             "//div[contains(@class, 'highlight')]")[0][0].iterdescendants()
+         ])
+
+    assert sliced_code in original_code