Update readme and other tweaks (#33)

Among other things, I wiped my virtual environment, reinstalled everything from scratch, and was surprised that the tree-sitter implementation had changed. So, I've also updated some test data to get the tests to pass again.


* tweaks to the readme

* tweak to touchpad zooming: do things in the order you'd expect

* upgrade code_tokenize, needs to update tests to match

* the test shouldn't hang when it fails

* update images in integration tests for new version of tree-sitter

* all tests pass again

* add java support

Author: penguinland

README.md

@@ -26,7 +26,7 @@ mouse is on, and the bottom snippit is for the column. In large images, as you
 zoom out, multiple tokens will be combined into single pixels in the image, and
 multiple tokens will be highlighted in these snippets.
 
-## Prerequisites
+## Installation
 You'll need [Tcl/Tk bindings](https://docs.python.org/3/library/tkinter.html)
 for Python. This might require installing something outside of your virtual
 environment: you'll know it's set up right if you can run `python3 -m tkinter`
@@ -35,7 +35,8 @@ and get a little interactive window to pop up.
 - On Mac: `brew install python-tk`
 - On Ubuntu: `sudo apt-get install python3-pil.imagetk`
 
-After that, just `pip3 install -r requirements.txt`, and you should be good!
+After that, just clone the repo, run `pip3 install -r requirements.txt`, and
+you should be good!
 
 If you get errors about not doing this in a virtual environment, try
 `python3 -m venv venv`, then `source venv/bin/activate`, and _then_
@@ -46,7 +47,7 @@ either file an issue telling us to update the documentation with what you did,
 or update it yourself and send us a pull request!).
 
 ## Options
-The short version: run `visual_diff.py --help` for info.
+The short version: run `./visual_diff.py --help` for info.
 
 The program can recognize a handful of languages from the file extension (e.g.,
 `.py` or `.go`). If you want to use a language that is not automatically

generate_report_test.py

@@ -12,11 +12,11 @@ def test_file_against_self(self):
                 pointsprite_info, pointsprite_info, 100))
         expected = [
             "Found duplicated code between examples/pointsprite.py and examples/pointsprite.py:",
-            "    706 tokens on lines 28-121 and lines 121-295",
-            "    126 tokens on lines 90-105 and lines 104-121",
-            "    126 tokens on lines 90-105 and lines 280-295",
-            "    126 tokens on lines 104-121 and lines 266-281",
-            "    126 tokens on lines 266-281 and lines 280-295",
+            "    672 tokens on lines 28-119 and lines 121-295",
+            "    116 tokens on lines 92-104 and lines 105-119",
+            "    116 tokens on lines 92-104 and lines 281-295",
+            "    116 tokens on lines 105-119 and lines 268-280",
+            "    116 tokens on lines 268-280 and lines 281-295",
             ]
         self.assertEqual(expected, actual)
 
@@ -27,11 +27,12 @@ def test_file_pair(self):
                 [nmea_info, rtk_info], 100))
         expected = [
             "Found duplicated code between examples/gpsnmea.go and examples/gpsrtk.go:",
-            "    413 tokens on lines 69-131 and lines 85-152",
+            "    451 tokens on lines 69-131 and lines 85-152",
             "Found duplicated code between examples/gpsrtk.go and examples/gpsrtk.go:",
-            "    120 tokens on lines 278-316 and lines 312-352",
-            "    116 tokens on lines 352-363 and lines 487-498",
-            "    142 tokens on lines 395-423 and lines 446-472",
+            "    100 tokens on lines 96-124 and lines 106-127",
+            "    128 tokens on lines 278-316 and lines 312-352",
+            "    118 tokens on lines 352-363 and lines 487-498",
+            "    157 tokens on lines 389-423 and lines 444-472",
             "    362 tokens on lines 559-618 and lines 567-626",
             "    305 tokens on lines 559-610 and lines 575-626",
             "    251 tokens on lines 559-602 and lines 583-626",

integration_test.py

@@ -25,8 +25,10 @@ def generate_image(filename_a, filename_b):
 
     def assertImagesMatch(self, expected_filename, actual_image):
         expected_image = PIL.Image.open(f"test_images/{expected_filename}")
-        self.assertEqual(list(actual_image.getdata()),
-                         list(expected_image.getdata()))
+        # This used to be a `self.assertEqual`, but when it fails, formatting
+        # the error message takes forever.
+        self.assertTrue(list(actual_image.getdata()) ==
+                        list(expected_image.getdata()))
 
     @parameterized.expand((("cpp_example.hpp",),
                           ("index.js",),

requirements.txt

@@ -1,29 +1,20 @@
-certifi==2024.8.30
-charset-normalizer==3.4.0
-code_ast==0.1.0
-code_tokenize==0.2.0
-contourpy==1.3.0
-cycler==0.12.1
+certifi==2024.12.14
+charset-normalizer==3.4.1
+code_ast==0.1.1
+code_tokenize==0.2.1
 darkdetect==0.8.0
-fonttools==4.54.1
-gitdb==4.0.11
-GitPython==3.1.43
+gitdb==4.0.12
+GitPython==3.1.44
 idna==3.10
-kiwisolver==1.4.7
-matplotlib==3.9.2
 mypy==1.14.1
 mypy-extensions==1.0.0
-numpy==2.1.2
-packaging==24.1
+numpy==2.2.2
 parameterized==0.9.0
-pillow==11.0.0
-pyparsing==3.2.0
-python-dateutil==2.9.0.post0
+pillow==11.1.0
 requests==2.32.3
-ruff==0.8.4
-setuptools==75.2.0
-six==1.16.0
-smmap==5.0.1
+ruff==0.9.3
+setuptools==75.8.0
+smmap==5.0.2
 tree-sitter==0.21.3
 typing_extensions==4.12.2
-urllib3==2.2.3
+urllib3==2.3.0

test_images/gps.png

@@ -46,6 +46,7 @@ def guess_language(filename: str) -> str:
         "hpp":    "cpp",
         "go":     "go",
         "hs":     "haskell",
+        "java":   "java",
         "js":     "javascript",
         "py":     "python",
         "rs":     "rust",

test_images/lsbattle_entity_wireframe.png

@@ -107,8 +107,8 @@ def _zoom_touchpad(self, event: tk.Event) -> None:
         self._zoom_touchpad_amount += delta_x + delta_y
         if abs(self._zoom_touchpad_amount) > 20:
             sign = 1 if self._zoom_touchpad_amount > 0 else -1
-            self._zoom_touchpad_amount = 0
             self._zoom(-sign, event)
+            self._zoom_touchpad_amount = 0
 
     def _zoom(self, amount: int, event: tk.Event) -> None:
         if not self._pyramid.zoom(amount):