theme_switcher.py

"""
Allow easy manipulations of the rainmeter themes.

The rainmeter themes are hidden to the default system
so other systems can not use these color schemes.
"""

import re

import sublime
import sublime_plugin

from . import logger


class EditThemeCommand(sublime_plugin.ApplicationCommand):
    """Bind to the sublime text API via the ApplicationCommand."""

    def run(self, theme):  # pylint: disable=R0201; sublime text API, no need for class reference
        """
        Search all *.tmTheme files in the Rainmeter space and tries to match it to the theme param.

        If no matching theme was found an error is reported to the log
        and tell the user that his intended operation failed.

        Parameters
        ----------
        self: EditThemeCommand
            the current instance given to the method.

        theme: String
            Given String through the menu. Should match one of the tmTheme in the Rainmeter space
        """
        all_themes = sublime.find_resources("*.hidden-tmTheme")

        # only list rainmeter themes
        # could be installed via "add repository" then the file is named after the repository
        rm_exp = re.compile(r"Packages/Rainmeter/", re.IGNORECASE)

        theme_exp = re.compile(re.escape(theme))
        filtered_themes = [theme for theme in all_themes if rm_exp.search(theme) and theme_exp.search(theme)]

        if len(filtered_themes) != 1:
            str_all_themes = '\n'.join(str(t) for t in all_themes)
            str_filtered_themes = '\n'.join(str(t) for t in filtered_themes)
            message = """searched for '{theme}' in

                         {stringified_all_themes}

                         but resulted into more or less than 1 result with

                         {stringified_filtered_themes}"""
            formatted_message = message.format(
                theme=theme,
                stringified_all_themes=str_all_themes,
                stringified_filtered_themes=str_filtered_themes
            )
            logger.error(formatted_message)
            sublime.error_message(formatted_message)

        # we found only one
        theme = filtered_themes[0]
        settings = sublime.load_settings("Rainmeter.sublime-settings")
        settings.set("color_scheme", theme)
        sublime.save_settings("Rainmeter.sublime-settings")

    def is_checked(self, theme):  # pylint: disable=R0201; sublime text API, no need for class reference
        """
        Return True if a checkbox should be shown next to the menu item.

        The .sublime-menu file must have the checkbox attribute set to true for this to be used.
        """
        settings = sublime.load_settings("Rainmeter.sublime-settings")
        color_scheme = settings.get("color_scheme", None)
        theme_exp = re.compile(re.escape(theme))

        return theme_exp.search(color_scheme) is not None