Bugfix/circular drawer units (#101)

* - add wheel * - bump-year to 2022 * - use given units for circular_ring_max_distance * - use given units for circular_ring_max_distance * - make use of units for max_length * - update-readme * - remove min_length, convert after assert --------- Co-authored-by: Lowtower <lowtower@lowtower.de>
flopp · Feb 19, 2023 · e8da1e3 · e8da1e3
1 parent 445202f
commit e8da1e3
Show file tree

Hide file tree

Showing 28 changed files with 43 additions and 41 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2021 Florian Pigorsch & Contributors
+Copyright (c) 2016-2022 Florian Pigorsch & Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Makefile b/Makefile
@@ -3,7 +3,7 @@ COPYRIGHT_FILES = README.md LICENSE gpxtrackposter/*.py tests/*.py scripts/*.py
 .PHONY: setup
 setup:
 	python3 -m venv .env
-	.env/bin/pip install --upgrade pip
+	.env/bin/pip install --upgrade pip wheel
 	.env/bin/pip install --upgrade -r requirements.txt
 	.env/bin/pip install --upgrade -r requirements-dev.txt
 	.env/bin/pip install .

diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ usage: create_poster [-h] [--gpx-dir DIR] [--output FILE]
                      [--heatmap-center LAT,LNG] [--heatmap-radius RADIUS_KM]
                      [--heatmap-line-transparency-width TRANSP_1,WIDTH_1, TRANSP_2,WIDTH_2, TRANSP_3,WIDTH_3]
                      [--circular-rings] [--circular-ring-color COLOR]
-                     [--circular-ring-max-distance DISTANCE KM]
+                     [--circular-ring-max-distance DISTANCE]
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -104,8 +104,9 @@ Circular Type Options:
   --circular-rings      Draw distance rings.
   --circular-ring-color COLOR
                         Color of distance rings.
-  --circular-ring-max-distance DISTANCE KM
-                        Maximum distance for scaling the track length.
+  --circular-ring-max-distance DISTANCE
+                        Maximum distance for scaling the track lengths (in
+                        given units).
 ```
 
 Example:
@@ -249,6 +250,6 @@ E.g. use [Poedit](https://poedit.net/) or [Localise Online Editor](https://local
 `msgfmt gpxposter.po -o gpxposter.mo`
 
 ## License
-[MIT](https://github.com/flopp/GpxTrackPoster/blob/master/LICENSE) &copy; 2016-2021 Florian Pigorsch
+[MIT](https://github.com/flopp/GpxTrackPoster/blob/master/LICENSE) &copy; 2016-2022 Florian Pigorsch
 
 [strava-activity-type]: https://developers.strava.com/docs/reference/#api-models-ActivityType
diff --git a/gpxtrackposter/calendar_drawer.py b/gpxtrackposter/calendar_drawer.py
@@ -1,5 +1,5 @@
 """Draw a calendar poster."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/circular_drawer.py b/gpxtrackposter/circular_drawer.py
@@ -1,5 +1,5 @@
 """Draw a circular Poster."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.
@@ -44,6 +44,7 @@ def __init__(self, the_poster: Poster) -> None:
         self._rings = False
         self._ring_color = "darkgrey"
         self._max_distance = None
+        self._unit = Units().km
 
     def create_args(self, args_parser: argparse.ArgumentParser) -> None:
         """Add arguments to the parser"""
@@ -65,17 +66,17 @@ def create_args(self, args_parser: argparse.ArgumentParser) -> None:
         group.add_argument(
             "--circular-ring-max-distance",
             dest="circular_ring_max_distance",
-            metavar="DISTANCE KM",
+            metavar="DISTANCE",
             type=float,
-            help="Maximum distance for scaling the track length.",
+            help="Maximum distance for scaling the track lengths (in given units).",
         )
 
     def fetch_args(self, args: argparse.Namespace) -> None:
         """Get arguments from the parser"""
         self._rings = args.circular_rings
         self._ring_color = args.circular_ring_color
         if args.circular_ring_max_distance:
-            self._max_distance = abs(args.circular_ring_max_distance) * Units().km
+            self._max_distance = abs(args.circular_ring_max_distance)
 
     def draw(self, dr: svgwrite.Drawing, g: svgwrite.container.Group, size: XY, offset: XY) -> None:
         """Draw the circular Poster using distances broken down by time"""
@@ -84,6 +85,11 @@ def draw(self, dr: svgwrite.Drawing, g: svgwrite.container.Group, size: XY, offs
         if self.poster.length_range_by_date is None:
             return
 
+        if self.poster.units == "imperial":
+            self._unit = Units().mile
+        if self._max_distance:
+            self._max_distance = self._max_distance * self._unit
+
         years = self.poster.years.count()
         _, counts = utils.compute_grid(years, size)
         if counts is None:
@@ -194,11 +200,7 @@ def _draw_year(self, dr: svgwrite.Drawing, g: svgwrite.container.Group, size: XY
 
     def _determine_ring_distance(self, max_length: pint.Quantity) -> typing.Optional[pint.Quantity]:
         ring_distance = None
-        if self.poster.units == "metric":
-            unit = Units().km
-        else:
-            unit = Units().mile
-        for distance in [1.0 * unit, 5.0 * unit, 10.0 * unit, 50.0 * unit]:
+        for distance in [1.0 * self._unit, 5.0 * self._unit, 10.0 * self._unit, 50.0 * self._unit]:
             if max_length < distance:
                 continue
             ring_distance = distance
@@ -212,12 +214,11 @@ def _draw_rings(
         length_range = self.poster.length_range_by_date
         if not length_range.is_valid():
             return
-        min_length = length_range.lower()
         max_length = length_range.upper()
         if self._max_distance:
             max_length = self._max_distance
-        assert min_length is not None
         assert max_length is not None
+        max_length = max_length.to(self._unit)
         ring_distance = self._determine_ring_distance(max_length)
         if ring_distance is None:
             return

diff --git a/gpxtrackposter/cli.py b/gpxtrackposter/cli.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/exceptions.py b/gpxtrackposter/exceptions.py
@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/github_drawer.py b/gpxtrackposter/github_drawer.py
@@ -1,4 +1,4 @@
-# Copyright 2020-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2020-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/grid_drawer.py b/gpxtrackposter/grid_drawer.py
@@ -1,5 +1,5 @@
 """Draw a grid poster."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/heatmap_drawer.py b/gpxtrackposter/heatmap_drawer.py
@@ -1,5 +1,5 @@
 """Draw a heatmap poster."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/localization.py b/gpxtrackposter/localization.py
@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/poster.py b/gpxtrackposter/poster.py
@@ -1,5 +1,5 @@
 """Create a poster from track data."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/quantity_range.py b/gpxtrackposter/quantity_range.py
@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/timezone_adjuster.py b/gpxtrackposter/timezone_adjuster.py
@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/track.py b/gpxtrackposter/track.py
@@ -1,5 +1,5 @@
 """Create and maintain info about a given activity track (corresponding to one GPX file)."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/track_loader.py b/gpxtrackposter/track_loader.py
@@ -1,7 +1,7 @@
 """Handle parsing of GPX files and writing/loading of cached data"""
 
 
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/tracks_drawer.py b/gpxtrackposter/tracks_drawer.py
@@ -1,5 +1,5 @@
 """Contains the base class TracksDrawer, which other Drawers inherit from."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/units.py b/gpxtrackposter/units.py
@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/utils.py b/gpxtrackposter/utils.py
@@ -1,5 +1,5 @@
 """Assorted utility methods for use in creating posters."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/value_range.py b/gpxtrackposter/value_range.py
@@ -1,5 +1,5 @@
 """Represent a range of numerical values"""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/xy.py b/gpxtrackposter/xy.py
@@ -1,5 +1,5 @@
 """Represent x,y coords with properly overloaded operations."""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/gpxtrackposter/year_range.py b/gpxtrackposter/year_range.py
@@ -1,5 +1,5 @@
 """Represent a range of years, with ability to update based on a track"""
-# Copyright 2016-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2016-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/scripts/bump_year.py b/scripts/bump_year.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright 2018-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2018-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/scripts/check_copyright.py b/scripts/check_copyright.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright 2018-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2018-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/scripts/update_readme.py b/scripts/update_readme.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright 2018-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2018-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/tests/test_timezone_adjuster.py b/tests/test_timezone_adjuster.py
@@ -1,4 +1,4 @@
-# Copyright 2020-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2020-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/tests/test_track_loader.py b/tests/test_track_loader.py
@@ -1,4 +1,4 @@
-# Copyright 2020-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2020-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.

diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -1,4 +1,4 @@
-# Copyright 2018-2021 Florian Pigorsch & Contributors. All rights reserved.
+# Copyright 2018-2022 Florian Pigorsch & Contributors. All rights reserved.
 #
 # Use of this source code is governed by a MIT-style
 # license that can be found in the LICENSE file.