refactor: Extract gruvbox colors

Author: Dishti-Oberai

zulipterminal/config/themes.py

@@ -3,7 +3,7 @@
 from pygments.token import STANDARD_TYPES
 
 from zulipterminal.config.color import term16
-from zulipterminal.themes import gruvbox, zt_blue, zt_dark, zt_light
+from zulipterminal.themes import gruvbox_dark, zt_blue, zt_dark, zt_light
 
 
 StyleSpec = Union[
@@ -86,15 +86,15 @@
 # fmt: on
 
 THEMES: Dict[str, Any] = {
-    "gruvbox_dark": gruvbox,
+    "gruvbox_dark": gruvbox_dark,
     "zt_dark": zt_dark,
     "zt_light": zt_light,
     "zt_blue": zt_blue,
 }
 
 THEME_ALIASES = {
     "default": "zt_dark",
-    "gruvbox": "gruvbox_dark",
+    "gruvbox_dark": "gruvbox_dark",
     "light": "zt_light",
     "blue": "zt_blue",
 }

zulipterminal/themes/THEME_CONTRIBUTING.md

@@ -23,10 +23,10 @@ If BOLD is something that is not needed, just use:
 from zulipterminal.config.color import DefaultColor as Color
 ```
 
-Likewise, to use a color scheme from any other theme like Gruvbox, use:
+Likewise, to use a color scheme from any other theme like Gruvbox (for which the colors are defined in colors_gruvbox.py), use:
 
 ```python
-from zulipterminal.themes.gruvbox import Color
+from zulipterminal.themes.colors_gruvbox import DefaultBoldColor
 ```
 
 ---

zulipterminal/themes/colors_gruvbox.py

@@ -0,0 +1,41 @@
+"""
+COLOR
+-----
+Contains color definitions or functions common across gruvbox themes.
+For further details on themefiles look at the theme contribution guide.
+-------
+This theme uses the official gruvbox color scheme.
+For color reference see:
+    https://github.com/morhetz/gruvbox/blob/master/colors/gruvbox.vim
+"""
+from enum import Enum
+
+from zulipterminal.config.color import color_properties
+
+
+# fmt: off
+# NOTE: The 24bit color codes use 256 color which can be
+# enhanced to be truly 24bit.
+# NOTE: The 256code format can be moved to h0-255 to
+# make use of the complete range instead of only 216 colors.
+
+class GruvBoxColor(Enum):
+    # color          =  16code          256code   24code
+    DEFAULT          = 'default         default   default'
+    DARK0_HARD       = 'black           h234      #1d2021'
+    GRAY_244         = 'dark_gray       h244      #928374'
+    LIGHT2           = 'white           h250      #d5c4a1'
+    LIGHT4           = 'light_gray      h248      #bdae93'
+    BRIGHT_BLUE      = 'light_blue      h109      #83a598'
+    BRIGHT_GREEN     = 'light_green     h142      #b8bb26'
+    BRIGHT_RED       = 'light_red       h167      #fb4934'
+    NEUTRAL_PURPLE   = 'light_magenta   h132      #b16286'
+    NEUTRAL_BLUE     = 'dark_cyan       h66       #458588'
+    NEUTRAL_YELLOW   = 'yellow          h172      #d79921'
+    FADED_BLUE       = 'dark_blue       h24       #076678'
+    FADED_YELLOW     = 'brown           h136      #b57614'
+    FADED_RED        = 'dark_red        h88       #9d0006'
+# fmt: on
+
+
+DefaultBoldColor = color_properties(GruvBoxColor, "BOLD")

zulipterminal/themes/gruvbox.py renamed to zulipterminal/themes/gruvbox_dark.py

@@ -1,5 +1,5 @@
 """
-GRUVBOX
+GRUVBOX DARK
 -------
 This theme uses the official gruvbox color scheme.
 For color reference see:
@@ -11,34 +11,13 @@
 
 For further details on themefiles look at the theme contribution guide
 """
-from enum import Enum
 
 from pygments.styles.solarized import SolarizedDarkStyle
 
-from zulipterminal.config.color import color_properties
+from zulipterminal.themes.colors_gruvbox import DefaultBoldColor as Color
 
 
 # fmt: off
-class GruvBoxColor(Enum):
-    # color          =  16code          256code   24code
-    DEFAULT          = 'default         default   default'
-    DARK0_HARD       = 'black           h234      #1d2021'
-    GRAY_244         = 'dark_gray       h244      #928374'
-    LIGHT2           = 'white           h250      #d5c4a1'
-    LIGHT4           = 'light_gray      h248      #bdae93'
-    BRIGHT_BLUE      = 'light_blue      h109      #83a598'
-    BRIGHT_GREEN     = 'light_green     h142      #b8bb26'
-    BRIGHT_RED       = 'light_red       h167      #fb4934'
-    NEUTRAL_PURPLE   = 'light_magenta   h132      #b16286'
-    NEUTRAL_BLUE     = 'dark_cyan       h66       #458588'
-    NEUTRAL_YELLOW   = 'yellow          h172      #d79921'
-    FADED_BLUE       = 'dark_blue       h24       #076678'
-    FADED_YELLOW     = 'brown           h136      #b57614'
-    FADED_RED        = 'dark_red        h88       #9d0006'
-
-
-Color = color_properties(GruvBoxColor, 'BOLD')
-
 
 STYLES = {
     # style_name       :  foreground                   background