Make theme name case insensitive

nbedos · nbedos · commit 69404952f6a4 · 2018-06-30T23:20:28.000+02:00
diff --git a/termtosvg/__main__.py b/termtosvg/__main__.py
@@ -14,21 +14,15 @@
 logger = logging.getLogger('termtosvg')
 LOG_FILENAME = os.path.join(tempfile.gettempdir(), 'termtosvg.log')
 
-
-configuration = config.init_read_conf()
-available_themes = [section for section in configuration if section != 'GLOBAL']
-
 USAGE = """termtosvg [output_file] [--theme THEME] [--help] [--verbose]
-
 Record a terminal session and render an SVG animation on the fly
 """
-
 EPILOG = "See also 'termtosvg record --help' and 'termtosvg render --help'"
 RECORD_USAGE = """termtosvg record [output_file] [--verbose] [--help]"""
 RENDER_USAGE = """termtosvg render input_file [output_file] [--theme THEME] [--verbose] [--help]"""
 
 
-def parse(args):
+def parse(args, themes):
     # type: (List) -> Tuple[Union[None, str], argparse.Namespace]
     # Usage: termtosvg [--theme THEME] [--verbose] [output_file]
     verbose_parser = argparse.ArgumentParser(add_help=False)
@@ -38,16 +32,14 @@ def parse(args):
         action='store_true',
         help='increase log messages verbosity'
     )
-
     theme_parser = argparse.ArgumentParser(add_help=False)
     theme_parser.add_argument(
         '--theme',
         help='color theme used to render the terminal session ({})'.format(
-            ', '.join(available_themes)),
-        choices=available_themes,
+            ', '.join(themes)),
+        choices=themes,
         metavar='THEME'
     )
-
     parser = argparse.ArgumentParser(
         prog='termtosvg',
         parents=[theme_parser, verbose_parser],
@@ -107,7 +99,11 @@ def main(args=None, input_fileno=None, output_fileno=None):
     if output_fileno is None:
         output_fileno = sys.stdout.fileno()
 
-    command, args = parse(args[1:])
+    configuration = config.init_read_conf()
+    available_themes = config.CaseInsensitiveDict(**configuration)
+    del available_themes['global']
+
+    command, args = parse(args[1:], available_themes)
 
     logger.setLevel(logging.INFO)
 
diff --git a/termtosvg/config.py b/termtosvg/config.py
@@ -7,45 +7,80 @@
 
 import termtosvg.asciicast as asciicast
 
+
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
-_PKG_CONFIGURATION_PATH = os.path.join('data', 'termtosvg.ini')
-DEFAULT_CONFIG = pkg_resources.resource_string(__name__, _PKG_CONFIGURATION_PATH).decode('utf-8')
+PKG_CONF_PATH = os.path.join('data', 'termtosvg.ini')
+DEFAULT_CONFIG = pkg_resources.resource_string(__name__, PKG_CONF_PATH).decode('utf-8')
+
+
+class CaseInsensitiveDict(dict):
+    @classmethod
+    def _lower_key(cls, key):
+        return key.lower() if isinstance(key, str) else key
+
+    def __init__(self, *args, **kwargs):
+        super(CaseInsensitiveDict, self).__init__(*args, **kwargs)
+        for key in list(self.keys()):
+            value = super(CaseInsensitiveDict, self).pop(key)
+            self.__setitem__(key, value)
+
+    def __getitem__(self, key):
+        lower_case_key = self.__class__._lower_key(key)
+        return super(CaseInsensitiveDict, self).__getitem__(lower_case_key)
+
+    def __setitem__(self, key, value):
+        lower_case_key = self.__class__._lower_key(key)
+        super(CaseInsensitiveDict, self).__setitem__(lower_case_key, value)
+
+    def __delitem__(self, key):
+        lower_case_key = self.__class__._lower_key(key)
+        return super(CaseInsensitiveDict, self).__delitem__(lower_case_key)
 
+    def __contains__(self, key):
+        lower_case_key = self.__class__._lower_key(key)
+        return super(CaseInsensitiveDict, self).__contains__(lower_case_key)
 
-if 'XDG_CONFIG_HOME' in os.environ:
-    USER_CONFIG_DIR = os.environ['XDG_CONFIG_HOME']
-elif 'HOME' in os.environ:
-    USER_CONFIG_DIR = os.path.join(os.environ['HOME'], '.config')
-else:
-    logger.info('Environment variable XDG_CONFIG_HOME and HOME are not set: user configuration '
-                'cannot be used')
-    USER_CONFIG_DIR = None
+    def pop(self, key, *args, **kwargs):
+        lower_case_key = self.__class__._lower_key(key)
+        return super(CaseInsensitiveDict, self).pop(lower_case_key, *args, **kwargs)
+
+    def get(self, key, *args, **kwargs):
+        lower_case_key = self.__class__._lower_key(key)
+        return super(CaseInsensitiveDict, self).get(lower_case_key, *args, **kwargs)
+
+    def setdefault(self, key, *args, **kwargs):
+        lower_case_key = self.__class__._lower_key(key)
+        return super(CaseInsensitiveDict, self).setdefault(lower_case_key, *args, **kwargs)
+
+    def update(self, E=None, **F):
+        super(CaseInsensitiveDict, self).update(self.__class__(E))
+        super(CaseInsensitiveDict, self).update(self.__class__(**F))
 
 
 def conf_to_dict(configuration):
-    # type: (str) -> Dict[str, Union[Dict[str, str], asciicast.AsciiCastTheme]]
+    # type: (str) -> CaseInsensitiveDict[str, Union[Dict[str, str], asciicast.AsciiCastTheme]]
     """Read a configuration string in INI format and return a dictionary
 
     Raise a subclass of configparser.Error if parsing the configuration string fails
     Raise ValueError if the color theme is invalid
     """
-    user_config = configparser.ConfigParser(comment_prefixes=(';',))
-    user_config.read_string(configuration)
-    config_dict = {
-        'GLOBAL': {
-            'font': user_config.get('GLOBAL', 'font'),
-            'theme': user_config.get('GLOBAL', 'theme'),
+    parser = configparser.ConfigParser(dict_type=CaseInsensitiveDict,
+                                       comment_prefixes=(';',))
+    parser.read_string(configuration)
+    config_dict = CaseInsensitiveDict({
+        'global': {
+            'font': parser.get('global', 'font'),
+            'theme': parser.get('global', 'theme'),
         }
-    }
+    })
 
-    themes = user_config.sections()
-    themes.remove('GLOBAL')
+    themes = [theme.lower() for theme in parser.sections() if theme.lower() != 'global']
     for theme_name in themes:
-        fg = user_config.get(theme_name, 'foreground', fallback='')
-        bg = user_config.get(theme_name, 'background', fallback='')
-        palette = ':'.join(user_config.get(theme_name, 'color{}'.format(i), fallback='')
+        fg = parser.get(theme_name, 'foreground', fallback='')
+        bg = parser.get(theme_name, 'background', fallback='')
+        palette = ':'.join(parser.get(theme_name, 'color{}'.format(i), fallback='')
                            for i in range(16))
 
         # This line raises ValueError if the color theme is invalid
@@ -69,32 +104,38 @@ def get_configuration(user_config, default_config):
 
     # Override default values with user configuration
     for section in user_config_dict:
-        if section == 'GLOBAL':
+        if section.lower() == 'global':
             for _property in 'theme', 'font':
-                if _property in user_config_dict['GLOBAL']:
-                    config_dict['GLOBAL'][_property] = user_config_dict['GLOBAL'][_property]
+                config_dict['GLOBAL'][_property] = user_config_dict['global'][_property]
         else:
             config_dict[section] = user_config_dict[section]
 
     return config_dict
 
 
-def init_read_conf(user_config_dir=USER_CONFIG_DIR, default_config=DEFAULT_CONFIG):
+def init_read_conf():
+    if 'XDG_CONFIG_HOME' in os.environ:
+        user_config_dir = os.environ['XDG_CONFIG_HOME']
+    elif 'HOME' in os.environ:
+        user_config_dir = os.path.join(os.environ['HOME'], '.config')
+    else:
+        logger.info('Environment variable XDG_CONFIG_HOME and HOME are not set: user '
+                    'configuration cannot be used')
+        user_config_dir = None
+
+    if user_config_dir is None:
+        return get_configuration(DEFAULT_CONFIG, DEFAULT_CONFIG)
+
     config_dir = os.path.join(user_config_dir, 'termtosvg')
     config_path = os.path.join(config_dir, 'termtosvg.ini')
     try:
         with open(config_path, 'r') as config_file:
             user_config = config_file.read()
     except FileNotFoundError:
         user_config = DEFAULT_CONFIG
-        try:
-            with open(config_path, 'w') as config_file:
-                config_file.write(DEFAULT_CONFIG)
-            logger.info('Created default configuration file: {}'.format(config_path))
-        except FileNotFoundError:
-            os.makedirs(config_dir)
-            with open(config_path, 'w') as config_file:
-                config_file.write(DEFAULT_CONFIG)
-            logger.info('Created default configuration file: {}'.format(config_path))
-
-    return get_configuration(user_config, default_config)
+        os.makedirs(config_dir, exist_ok=True)
+        with open(config_path, 'w') as config_file:
+            config_file.write(DEFAULT_CONFIG)
+        logger.info('Created default configuration file: {}'.format(config_path))
+
+    return get_configuration(user_config, DEFAULT_CONFIG)
diff --git a/termtosvg/data/termtosvg.ini b/termtosvg/data/termtosvg.ini
@@ -1,11 +1,14 @@
 ; TERMTOSVG CONFIGURATION FILE
 ;
 ; Configuration file structure:
-;    - The 'GLOBAL' section defines the font and theme used by termtosvg
+;    - The 'global' section defines the font and theme used by termtosvg
 ;    - All other sections define color schemes
 ;
+; Section and property names are case insensitive
+;
+
 
-[GLOBAL]
+[global]
 ; properties of this section:
 ;    - FONT: CSS font family used in the SVG animation (Deja Vu Sans Mono,
 ;    Lucida Console, Monaco...)
@@ -17,7 +20,7 @@
 ;    this file, or one of the default themes of termtosvg (circus,
 ;    classic-dark, classic-light, dracula, isotope, marrakesh, material,
 ;    monokai, solarized-dark, solarized-light, zenburn)
-;
+
 font = Deja Vu Sans Mono
 theme = solarized-dark 
 
@@ -41,8 +44,7 @@ theme = solarized-dark
 ; https://github.com/chriskempson/base16-xresources
 
 [circus]
-; Authors: Stephan Boyer (https://github.com/stepchowfun)
-; and Esther Wang
+; Authors: Stephan Boyer (https://github.com/stepchowfun) and Esther Wang
 foreground = #a7a7a7
 background = #191919
 color0 = #191919
diff --git a/tests/test___main__.py b/tests/test___main__.py
@@ -46,7 +46,7 @@ def test_parse(self):
 
         for args in test_cases:
             with self.subTest(case=args):
-                __main__.parse(args)
+                __main__.parse(args, ['solarized-light', 'solarized-dark'])
 
     @staticmethod
     def run_main(shell_commands, args):
@@ -96,6 +96,6 @@ def test_main(self):
             args = ['termtosvg', '--verbose']
             TestMain.run_main(SHELL_COMMANDS, args)
 
-        with self.subTest(case='record and render on the fly (circus theme)'):
-            args = ['termtosvg', svg_filename, '--theme', 'circus', '--verbose']
+        with self.subTest(case='record and render on the fly (uppercase circus theme +)'):
+            args = ['termtosvg', svg_filename, '--theme', 'CIRCUS', '--verbose']
             TestMain.run_main(SHELL_COMMANDS, args)
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -1,4 +1,6 @@
+import tempfile
 import unittest
+from unittest.mock import patch
 
 import termtosvg.config as config
 
@@ -18,7 +20,7 @@
 color6=#666666
 color7=#777777
 """
-
+UPPERCASE_CONFIG = MINIMAL_CONFIG.upper()
 NO_GLOBAL_SECTION_CONFIG = MINIMAL_CONFIG.replace('[GLOBAL]', ';[GLOBAL]')
 NO_FONT_CONFIG = MINIMAL_CONFIG.replace('font', ';font')
 NO_THEME_CONFIG = MINIMAL_CONFIG.replace('theme', ';theme')
@@ -30,6 +32,17 @@
 
 class TestConf(unittest.TestCase):
     def test_conf_to_dict(self):
+        test_cases = [
+            ('Minimal config', MINIMAL_CONFIG),
+            ('Uppercase config', UPPERCASE_CONFIG),
+        ]
+        for case, configuration in test_cases:
+            with self.subTest(case=case):
+                config_dict = config.conf_to_dict(configuration)
+                self.assertEqual(config_dict['GlOBal']['font'].lower(), 'deja vu sans mono')
+                self.assertEqual(config_dict['Dark'].fg.lower(), '#ffffff')
+                self.assertEqual(config_dict['dark'].bg.lower(), '#000000')
+
         with self.subTest(case='minimal config'):
             config_dict = config.conf_to_dict(MINIMAL_CONFIG)
             self.assertEqual(config_dict['GLOBAL']['font'], 'Deja Vu Sans Mono')
@@ -62,3 +75,38 @@ def test_get_configuration(self):
             self.assertEqual(config_dict['dark'].bg.lower(), '#ffffff')
             palette = config_dict['dark'].palette.split(':')
             self.assertEqual(palette[0].lower(), '#ffffff')
+
+    def test_init_read_conf(self):
+        with self.subTest(case='XDG_CONFIG_HOME'):
+            mock_environ = {
+                'XDG_CONFIG_HOME': tempfile.mkdtemp(prefix='termtosvg_config_')
+            }
+            with patch('os.environ', mock_environ):
+                # First call should create config dirs and return it
+                self.assertEqual(config.conf_to_dict(config.DEFAULT_CONFIG),
+                                 config.init_read_conf())
+                # Second call only reads the config file which was created by the first call
+                self.assertEqual(config.conf_to_dict(config.DEFAULT_CONFIG),
+                                 config.init_read_conf())
+
+        with self.subTest(case='XDG_CONFIG_HOME'):
+            mock_environ = {
+                'XDG_CONFIG_HOME': tempfile.mkdtemp(prefix='termtosvg_config_')
+            }
+            with patch('os.environ', mock_environ):
+                self.assertEqual(config.conf_to_dict(config.DEFAULT_CONFIG),
+                                 config.init_read_conf())
+
+        with self.subTest(case='HOME'):
+            mock_environ = {
+                'HOME': tempfile.mkdtemp(prefix='termtosvg_config_')
+            }
+            with patch('os.environ', mock_environ):
+                self.assertEqual(config.conf_to_dict(config.DEFAULT_CONFIG),
+                                 config.init_read_conf())
+
+        with self.subTest(case='No environment variable'):
+            mock_environ = {}
+            with patch('os.environ', mock_environ):
+                self.assertEqual(config.conf_to_dict(config.DEFAULT_CONFIG),
+                                 config.init_read_conf())
