Update to coloraide 5.1 and allow setting gamut map parameters in config (#278)

* Update to coloraide 5.1 and allow setting gamut map parameters in config

* Upgrade ColorAide to 6.0.0 and require Python 3.13 for upcoming ST

Author: facelessuser

.github/workflows/deploy.yml

@@ -4,6 +4,7 @@ on:
   push:
     tags:
     - 'st3-*'
+    - 'st4-*'
 
 jobs:
 

.python-version

@@ -1 +1 @@
-3.8
+3.13

CHANGES.md

@@ -1,5 +1,11 @@
 # ColorHelper
 
+## 6.5.0
+
+-   **NEW**: Upgrade ColorAide to 6.0.0.
+-   **NEW**: Allow setting gamut map parameters in settings file.
+-   **NEW**: Require Python 3.13 for Sublim Text 4201+.
+
 ## 6.4.5
 
 -   **FIX**: Fix SCSS support.

ch_mixin.py

@@ -23,7 +23,10 @@ def setup_gamut_style(self):
         ch_settings = sublime.load_settings('color_helper.sublime-settings')
         self.show_out_of_gamut_preview = ch_settings.get('show_out_of_gamut_preview', True)
         self.gamut_space = ch_settings.get('gamut_space', 'srgb')
-        self.gamut_map = ch_settings.get('gamut_map', 'lch-chroma')
+        gmap = ch_settings.get('gamut_map', {'method': 'minde-chroma', 'pspace': 'lch-d65'})
+        if isinstance(gmap, str):
+            gmap = {'method': gmap}
+        self.gamut_map = gmap
         if self.gamut_space not in GAMUT_SPACES:
             self.gamut_space = 'srgb'
 
@@ -35,7 +38,7 @@ def setup_image_border(self):
         if border_color is not None:
             try:
                 border_color = self.base(border_color)
-                border_color.fit(self.gamut_space, method=self.gamut_map)
+                border_color.fit(self.gamut_space, **self.gamut_map)
             except Exception:
                 border_color = None
 
@@ -188,15 +191,15 @@ def get_preview(self, color):
         if not color.in_gamut(check_space):
             message = 'preview out of gamut'
             if self.show_out_of_gamut_preview:
-                pcolor = color.convert(self.gamut_space, fit=self.gamut_map)
+                pcolor = color.convert(self.gamut_space).fit(**self.gamut_map)
                 preview1 = pcolor.clone().set('alpha', 1)
                 preview2 = pcolor
             else:
                 preview1 = self.out_of_gamut
                 preview2 = self.out_of_gamut
                 preview_border = self.out_of_gamut_border
         else:
-            pcolor = color.convert(self.gamut_space, fit=self.gamut_map)
+            pcolor = color.convert(self.gamut_space).fit(**self.gamut_map)
             preview1 = pcolor.clone().set('alpha', 1)
             preview2 = pcolor
 

ch_panel.py

@@ -245,7 +245,7 @@ def color_picker(self, color):
 
         if self.os_color_picker:
             self.view.hide_popup()
-            new_color = native_picker(self.base(color).convert("srgb", fit=self.gamut_map))
+            new_color = native_picker(self.base(color).convert("srgb").fit(**self.gamut_map))
             if new_color is not None:
                 sublime.set_timeout(
                     lambda c=new_color.to_string(**util.COLOR_FULL_PREC): self.view.run_command(

ch_picker.py

@@ -69,7 +69,7 @@ def setup(self, color, mode, controls, on_done, on_cancel):
         self.setup_controls(controls)
         color.convert(self.mode, in_place=True)
         if not color.in_gamut():
-            color.fit(method=self.gamut_map)
+            color.fit(**self.gamut_map)
         else:
             color.clip()
         # Ensure hue is between 0 - 360.

ch_preview.py

@@ -271,7 +271,10 @@ def setup_gamut_options(self):
 
         self.show_out_of_gamut_preview = ch_settings.get('show_out_of_gamut_preview', True)
         self.gamut_space = ch_settings.get('gamut_space', 'srgb')
-        self.gamut_map = ch_settings.get('gamut_map', 'lch-chroma')
+        gmap = ch_settings.get('gamut_map', {'method': 'minde-chroma', 'pspace': 'lch-d65'})
+        if isinstance(gmap, str):
+            gmap = {'method': gmap}
+        self.gamut_map = gmap
         if self.gamut_space not in util.GAMUT_SPACES:
             self.gamut_space = 'srgb'
         self.out_of_gamut = self.base("transparent").convert(self.gamut_space)
@@ -437,7 +440,7 @@ def do_search(self, force=False):
                         mdpopups.scope2style(self.view, self.view.scope_name(pt))['background']
                     ).convert("hsl")
                     hsl['lightness'] = hsl['lightness'] + (0.3 if hsl.luminance() < 0.5 else -0.3)
-                    preview_border = hsl.convert(self.gamut_space, fit=self.gamut_map).set('alpha', 1)
+                    preview_border = hsl.convert(self.gamut_space).fit(**self.gamut_map).set('alpha', 1)
 
                     color = self.base(obj.color)
                     title = ''
@@ -448,15 +451,15 @@ def do_search(self, force=False):
                     if not color.in_gamut(check_space):
                         title = ' title="Preview out of gamut"'
                         if self.show_out_of_gamut_preview:
-                            pcolor = color.convert(self.gamut_space, fit=self.gamut_map)
+                            pcolor = color.convert(self.gamut_space).fit(**self.gamut_map)
                             preview1 = pcolor.clone().set('alpha', 1)
                             preview2 = pcolor
                         else:
                             preview1 = self.out_of_gamut
                             preview2 = self.out_of_gamut
                             preview_border = self.out_of_gamut_border
                     else:
-                        pcolor = color.convert(self.gamut_space, fit=self.gamut_map)
+                        pcolor = color.convert(self.gamut_space).fit(**self.gamut_map)
                         preview1 = pcolor.clone().set('alpha', 1)
                         preview2 = pcolor
 

ch_tool_blend.py

@@ -185,10 +185,10 @@ def preview(self, text):
                 else:
                     check_space = self.gamut_space
                 if not pcolor.in_gamut(check_space):
-                    pcolor.fit(self.gamut_space, method=self.gamut_map)
+                    pcolor.fit(self.gamut_space, **self.gamut_map)
                     message = '<br><em style="font-size: 0.9em;">* preview out of gamut</em>'
                     color_string = "<strong>Gamut Mapped</strong>: {}<br>".format(pcolor.to_string())
-                pcolor.convert(self.gamut_space, fit=self.gamut_map, in_place=True)
+                pcolor.convert(self.gamut_space, in_place=True).fit(**self.gamut_map)
                 color_string += "<strong>Color</strong>: {}".format(color.to_string(**util.DEFAULT))
                 preview = pcolor.clone().set('alpha', 1)
                 preview_alpha = pcolor

ch_tool_colormod.py

@@ -106,7 +106,7 @@ def preview(self, text):
                     check_space = self.gamut_space
                 if not pcolor.in_gamut(check_space):
                     message = '<br><em style="font-size: 0.9em;">* preview out of gamut</em>'
-                pcolor.convert(self.gamut_space, fit=self.gamut_map, in_place=True)
+                pcolor.convert(self.gamut_space, in_place=True).fit(**self.gamut_map)
                 preview = pcolor.clone().set('alpha', 1)
                 preview_alpha = pcolor
                 preview_border = self.default_border

ch_tool_contrast.py

@@ -114,11 +114,11 @@ def evaluate(base, string, gamut_map):
 
         # Package up the color, or the two reference colors along with the mixed.
         if first:
-            colors.append(first.fit('srgb', method=gamut_map))
+            colors.append(first.fit('srgb', **gamut_map))
         if second:
             if second[-1] < 1.0:
                 second[-1] = 1.0
-            colors.append(second.fit('srgb', method=gamut_map))
+            colors.append(second.fit('srgb', **gamut_map))
             if ratio:
                 if first[-1] < 1.0:
                     first = first.compose(second, space="srgb", out_space=first.space())