refactor: Extract gruvbox colors

Dishti-Oberai · Dishti-Oberai · commit 206b949e80f7 · 2022-02-04T14:49:11.000+05:30
diff --git a/tests/config/test_themes.py b/tests/config/test_themes.py
@@ -22,51 +22,11 @@
 expected_complete_themes = {
     "zt_dark",
     "gruvbox_dark",
-    "gruvbox_light",
     "zt_light",
     "zt_blue",
 }
 aliases_16_color = [
     "default",
-    "dark0 hard",
-    "dark0",
-    "dark0 soft",
-    "dark1",
-    "dark2",
-    "dark3",
-    "dark4",
-    "dark4 256",
-    "gray 245",
-    "gray 244",
-    "light0 hard",
-    "light0",
-    "light0 soft",
-    "light1",
-    "light2",
-    "light3",
-    "light4",
-    "light4 256",
-    "bright red",
-    "bright green",
-    "bright yellow",
-    "bright blue",
-    "bright purple",
-    "bright aqua",
-    "bright orange",
-    "neutral red",
-    "neutral green",
-    "neutral yellow",
-    "neutral blue",
-    "neutral purple",
-    "neutral aqua",
-    "neutral orange",
-    "faded red",
-    "faded green",
-    "faded yellow",
-    "faded blue",
-    "faded purple",
-    "faded aqua",
-    "faded orange",
     "black",
     "dark red",
     "dark green",
diff --git a/zulipterminal/config/themes.py b/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_dark, gruvbox_light, zt_blue, zt_dark, zt_light
+from zulipterminal.themes import gruvbox_dark, zt_blue, zt_dark, zt_light
 
 
 StyleSpec = Union[
@@ -19,75 +19,74 @@
 # monochrome (1-bit) mode - independently of the specified theme
 REQUIRED_STYLES = {
     # style name      : monochrome style
-    None: '',
-    'selected': 'standout',
-    'msg_selected': 'standout',
-    'header': 'bold',
-    'general_narrow': 'standout',
-    'general_bar': '',
-    'name': '',
-    'unread': 'strikethrough',
-    'user_active': 'bold',
-    'user_idle': '',
-    'user_offline': '',
-    'user_inactive': '',
-    'title': 'bold',
-    'column_title': 'bold',
-    'time': '',
-    'bar': 'standout',
-    'msg_emoji': 'bold',
-    'reaction': 'bold',
-    'reaction_mine': 'standout',
-    'msg_heading': 'bold',
-    'msg_math': 'standout',
-    'msg_mention': 'bold',
-    'msg_link': '',
-    'msg_link_index': 'bold',
-    'msg_quote': 'underline',
-    'msg_code': 'bold',
-    'msg_bold': 'bold',
-    'msg_time': 'bold',
-    'footer': 'standout',
-    'footer_contrast': 'standout',
-    'starred': 'bold',
-    'unread_count': 'bold',
-    'starred_count': '',
-    'table_head': 'bold',
-    'filter_results': 'bold',
-    'edit_topic': 'standout',
-    'edit_tag': 'standout',
-    'edit_author': 'bold',
-    'edit_time': 'bold',
-    'current_user': '',
-    'muted': 'bold',
-    'popup_border': 'bold',
-    'popup_category': 'bold',
-    'popup_contrast': 'standout',
-    'popup_important': 'bold',
-    'widget_disabled': 'strikethrough',
-    'area:help': 'standout',
-    'area:msg': 'standout',
-    'area:stream': 'standout',
-    'area:error': 'standout',
-    'area:user': 'standout',
-    'search_error': 'standout',
-    'task:success': 'standout',
-    'task:error': 'standout',
-    'task:warning': 'standout',
+    None              : '',
+    'selected'        : 'standout',
+    'msg_selected'    : 'standout',
+    'header'          : 'bold',
+    'general_narrow'  : 'standout',
+    'general_bar'     : '',
+    'name'            : '',
+    'unread'          : 'strikethrough',
+    'user_active'     : 'bold',
+    'user_idle'       : '',
+    'user_offline'    : '',
+    'user_inactive'   : '',
+    'title'           : 'bold',
+    'column_title'    : 'bold',
+    'time'            : '',
+    'bar'             : 'standout',
+    'msg_emoji'       : 'bold',
+    'reaction'        : 'bold',
+    'reaction_mine'   : 'standout',
+    'msg_heading'     : 'bold',
+    'msg_math'        : 'standout',
+    'msg_mention'     : 'bold',
+    'msg_link'        : '',
+    'msg_link_index'  : 'bold',
+    'msg_quote'       : 'underline',
+    'msg_code'        : 'bold',
+    'msg_bold'        : 'bold',
+    'msg_time'        : 'bold',
+    'footer'          : 'standout',
+    'footer_contrast' : 'standout',
+    'starred'         : 'bold',
+    'unread_count'    : 'bold',
+    'starred_count'   : '',
+    'table_head'      : 'bold',
+    'filter_results'  : 'bold',
+    'edit_topic'      : 'standout',
+    'edit_tag'        : 'standout',
+    'edit_author'     : 'bold',
+    'edit_time'       : 'bold',
+    'current_user'    : '',
+    'muted'           : 'bold',
+    'popup_border'    : 'bold',
+    'popup_category'  : 'bold',
+    'popup_contrast'  : 'standout',
+    'popup_important' : 'bold',
+    'widget_disabled' : 'strikethrough',
+    'area:help'       : 'standout',
+    'area:msg'        : 'standout',
+    'area:stream'     : 'standout',
+    'area:error'      : 'standout',
+    'area:user'       : 'standout',
+    'search_error'    : 'standout',
+    'task:success'    : 'standout',
+    'task:error'      : 'standout',
+    'task:warning'    : 'standout',
 }
 
 REQUIRED_META = {
     'pygments': {
-        'styles': None,
-        'background': None,
-        'overrides': None,
+        'styles'     : None,
+        'background' : None,
+        'overrides'  : None,
     }
 }
 # fmt: on
 
 THEMES: Dict[str, Any] = {
     "gruvbox_dark": gruvbox_dark,
-    "gruvbox_light": gruvbox_light,
     "zt_dark": zt_dark,
     "zt_light": zt_light,
     "zt_blue": zt_blue,
@@ -96,7 +95,6 @@
 THEME_ALIASES = {
     "default": "zt_dark",
     "gruvbox_dark": "gruvbox_dark",
-    "gruvbox_light": "gruvbox_light",
     "light": "zt_light",
     "blue": "zt_blue",
 }
diff --git a/zulipterminal/themes/THEME_CONTRIBUTING.md b/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_dark import Color
+from zulipterminal.themes.colors_gruvbox import DefaultBoldColor
 ```
 
 ---
diff --git a/zulipterminal/themes/colors_gruvbox.py b/zulipterminal/themes/colors_gruvbox.py
@@ -3,26 +3,14 @@
 -----
 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 typing import Any
 
-from pygments.style import Style
-from pygments.token import (
-    Comment,
-    Error,
-    Escape,
-    Generic,
-    Keyword,
-    Literal,
-    Name,
-    Number,
-    Operator,
-    Punctuation,
-    String,
-    Text,
-    Whitespace,
-)
+from zulipterminal.config.color import color_properties
 
 
 # fmt: off
@@ -34,107 +22,20 @@
 class GruvBoxColor(Enum):
     # color          =  16code          256code   24code
     DEFAULT          = 'default         default   default'
-    DARK0_HARD       = 'dark0_hard      h234      #1d2021'
-    DARK0            = 'dark0           h235      #282828'
-    DARK0_SOFT       = 'dark0_soft      h236      #32302f'
-    DARK1            = 'dark1           h237      #3c3836'
-    DARK2            = 'dark2           h239      #504945'
-    DARK3            = 'dark3           h241      #665c54'
-    DARK4            = 'dark4           h243      #7c6f64'
-    DARK4_256        = 'dark4_256       h243      #7c6f64'
-    GRAY_245         = 'gray_245        h245      #928374'
-    GRAY_244         = 'gray_244        h244      #928374'
-    LIGHT0_HARD      = 'light0_hard     h230      #f9f5d7'
-    LIGHT0           = 'light0          h229      #fbf1c7'
-    LIGHT0_SOFT      = 'light0_soft     h228      #f2e5bc'
-    LIGHT1           = 'light1          h223      #ebdbb2'
-    LIGHT2           = 'light2          h250      #d5c4a1'
-    LIGHT3           = 'light3          h248      #bdae93'
-    LIGHT4           = 'light4          h246      #a89984'
-    LIGHT4_256       = 'light4_256      h246      #a89984'
-    BRIGHT_RED       = 'bright_red      h167      #fb4934'
-    BRIGHT_GREEN     = 'bright_green    h142      #b8bb26'
-    BRIGHT_YELLOW    = 'bright_yellow   h214      #fabd2f'
-    BRIGHT_BLUE      = 'bright_blue     h109      #83a598'
-    BRIGHT_PURPLE    = 'bright_purple   h175      #d3869b'
-    BRIGHT_AQUA      = 'bright_aqua     h108      #8ec07c'
-    BRIGHT_ORANGE    = 'bright_orange   h208      #fe8019'
-    NEUTRAL_RED      = 'neutral_red     h124      #cc241d'
-    NEUTRAL_GREEN    = 'neutral_green   h106      #98971a'
-    NEUTRAL_YELLOW   = 'neutral_yellow  h172      #d79921'
-    NEUTRAL_BLUE     = 'neutral_blue    h66       #458588'
-    NEUTRAL_PURPLE   = 'neutral_purple  h132      #b16286'
-    NEUTRAL_AQUA     = 'neutral_aqua    h72       #689d6a'
-    NEUTRAL_ORANGE   = 'neutral_orange  h166      #d65d0e'
-    FADED_RED        = 'faded_red       h88       #9d0006'
-    FADED_GREEN      = 'faded_green     h100      #79740e'
-    FADED_YELLOW     = 'faded_yellow    h136      #b57614'
-    FADED_BLUE       = 'faded_blue      h24       #076678'
-    FADED_PURPLE     = 'faded_purple    h96       #8f3f71'
-    FADED_AQUA       = 'faded_aqua      h66       #427b58'
-    FADED_ORANGE     = 'faded_orange    h130      #af3a03'
+    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
 
 
-def color_properties(colors: Any, *prop: str) -> Any:
-    """
-    Adds properties(Bold, Italics, etc...) to Enum Colors in theme files.
-    Useage: color_properties(Color, 'BOLD', 'ITALICS', 'STRIKETHROUGH')
-
-        NOTE: color_properties(Color, BOLD, ITALICS) would result in only
-        Color.WHITE and Color.WHITE__BOLD_ITALICS
-        but not Color.WHITE__BOLD or Color.WHITE__ITALICS.
-        One would also have to do color_properties(Color, BOLD)
-        and color_properties(Color, ITALICS) for the others to work
-        >>> This function can be later extended to achieve all combinations
-        with one call to the function.
-    """
-    prop_n = "_".join([p.upper() for p in prop])
-    prop_v = " , ".join([p.lower() for p in prop])
-    updated_colors: Any = Enum(  # type: ignore # Ref: python/mypy#529, #535 and #5317
-        "Color",
-        {
-            **{c.name: c.value for c in colors},
-            **{c.name + f"__{prop_n}": c.value + f" , {prop_v}" for c in colors},
-        },
-    )
-    return updated_colors
-
-
 DefaultBoldColor = color_properties(GruvBoxColor, "BOLD")
-
-
-# fmt: off
-class Term16Style(Style):
-    """
-    This style is a 16 color syntax style made for use in all ZT themes.
-    "var" bypasses pygments style format checking.
-    "_" is used in place of space and changed later below.
-    """
-    background_color = "dark4"
-
-    styles = {
-        Text:                          "var:gray_245",
-        Escape:                        "var:faded_aqua",
-        Error:                         "var:faded_red",
-        Whitespace:                    "var:gray_245",
-        Keyword:                       "var:bright_blue,_bold",
-        Name:                          "var:neutral_orange",
-        Name.Class:                    "var:neutral_yellow",
-        Name.Function:                 "var:bright_green",
-        Literal:                       "var:bright_green",
-        String:                        "var:faded_green",
-        String.Escape:                 "var:gray_245",
-        String.Doc:                    "var:gray_245",
-        Number:                        "var:bright_red",
-        Operator:                      "var:faded_aqua",
-        Punctuation:                   "var:gray_245,_bold",
-        Comment:                       "var:gray_245",
-        Generic:                       "var:gray_245",
-    }
-# fmt:on
-
-
-term16 = Term16Style()
-for style, code in term16.styles.items():
-    term16.styles[style] = code[4:].replace("_", " ")
diff --git a/zulipterminal/themes/gruvbox_dark.py b/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,6 +11,7 @@
 
 For further details on themefiles look at the theme contribution guide
 """
+
 from pygments.styles.solarized import SolarizedDarkStyle
 
 from zulipterminal.themes.colors_gruvbox import DefaultBoldColor as Color
