Merge pull request #1046 from theymightbetim/popup-cal

Popup calendar module

Author: tobi-wan-kenobi

bumblebee_status/modules/contrib/calendar.py

@@ -0,0 +1,122 @@
+# pylint: disable=C0111,R0903
+
+"""Extended version of datetime module which displays a small popup calendar and can open google calendar in the browser
+Parameters:
+    * calendar.format: strftime()-compatible formatting string
+    * calendar.locale: locale to use rather than the system default
+    * calendar.bg: background colors. default black.
+    * calendar.fg: foreground colors. default white.
+    * calendar.browserpath: path to broweser. default /usr/bin/firefox
+
+"""
+
+from __future__ import absolute_import
+from bumblebee_status.modules.core.datetime import Module
+import os
+
+import core.module
+import core.widget
+import core.input
+import datetime
+import locale
+
+def get_default_browser_linux():
+    try:
+        command = "xdg-settings get default-web-browser"
+        process = os.popen(command)
+        browser_id = process.read().strip()
+
+        if browser_id:
+            # Convert .desktop ID to a more user-friendly name (basic handling)
+            if ".desktop" in browser_id:
+                browser_name = browser_id.replace(".desktop", "")
+                return browser_name
+
+            # If it doesn't look like a .desktop id, return as is
+            return browser_id
+        else:
+            return None
+    except:
+        return None
+    
+class Module(Module):
+    def __init__(self, config, theme, dtlibrary=None):
+        super().__init__(config, theme)
+
+        core.input.register(
+            self, button=core.input.LEFT_MOUSE, cmd=self.display_calendar
+        )
+        
+    def display_calendar(self, widget):
+        default_browser = get_default_browser_linux()
+        import tkinter as tk
+        from tkcalendar import Calendar
+
+        root = tk.Tk()
+        window_width = 300
+        window_height = 205
+
+        bg = self.parameter("bg", "black")
+        fg = self.parameter("fg", "white")
+        root.configure(bg=bg)
+
+        # Get screen width
+        screen_width = root.winfo_screenwidth()
+        x = screen_width - window_width
+        y = 20
+
+        # Set the geometry of the window
+        root.geometry(f"{window_width}x{window_height}+{x}+{y}")
+
+        month = datetime.datetime.now().month
+        year = datetime.datetime.now().year
+        root.title(f"{month} {year}")
+
+        def close_window():
+            root.destroy()
+
+        close_button = tk.Button(
+            root, text="X", bg="black", fg="white", command=close_window
+        )
+        close_button.place(x=290, y=0, width=10, height=10)
+
+        # Calendar widget
+
+        cal = Calendar(
+            root,
+            background=bg,
+            foreground=fg,
+            disabledbackground=bg,
+            bordercolor=bg,
+            headersbackground=bg,
+            headersforeground=fg,
+            normalbackground=bg,
+            normalforeground=fg,
+            weekendbackground=bg,
+            weekendforeground=fg,
+            othermonthforeground="grey",
+            othermonthbackground=bg,
+            othermonthwebackground=bg,
+            othermonthweforground="grey",
+            showweeknumbers=False,
+        )
+        cal.place(x=0, y=10, width=300, height=200)
+
+        def key_listener(event):
+            if event.keysym == "Escape":
+                close_window()
+            if event.keysym == "Return":
+                import subprocess
+
+                selected_date = cal.selection_get()
+                browser_path = self.parameter("browserpath", "/usr/bin/firefox")
+                url = f"https://calendar.google.com/calendar/u/0/r/day/{selected_date.strftime('%Y/%m/%d')}"
+                subprocess.Popen([browser_path, url], stdout=subprocess.DEVNULL)
+                close_window()
+                return self.full_text
+
+        root.bind("<KeyRelease>", key_listener)
+        root.mainloop()
+
+
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4

docs/modules.rst

@@ -627,6 +627,22 @@ contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks
 
 .. image:: ../screenshots/caffeine.png
 
+calendar
+~~~~~~~~
+Extended version of datetime module which displays a small popup calendar and can open google calendar in the browser
+
+Parameters:
+    * popupcal.format: strftime()-compatible formatting string
+    * popupcal.locale: locale to use rather than the system default
+    * popupcal.bg: background colors. default black.
+    * popupcal.fg: foreground colors. default white.
+    * popupcal.browserpath: path to broweser. default /usr/bin/firefox
+
+Requires:
+    tkcalendar
+
+.. image:: ../screenshots/calendar.png
+    
 cmus
 ~~~~
 

requirements/modules/calendar.txt

@@ -0,0 +1 @@
+tkcalendar

screenshots/calendar.png

@@ -0,0 +1,92 @@
+import pytest
+from bumblebee_status.modules.contrib.calendar import Module, get_default_browser_linux
+from unittest.mock import MagicMock, patch
+from unittest import mock, TestCase
+from freezegun import freeze_time
+
+import core.config
+import core.input
+import core.widget
+import modules.core.datetime
+
+pytest.importorskip("datetime")
+
+def test_load_module():
+    __import__("modules.contrib.calendar")
+
+# Mocking os.popen
+@pytest.fixture
+def mock_popen(mocker):
+    return mocker.patch('os.popen')
+
+
+def test_get_default_browser_linux_valid_browser(mock_popen):
+    # Simulate a valid browser ID with ".desktop"
+    mock_popen.return_value.read.return_value = 'firefox.desktop\n'
+    
+    # Call the function
+    result = get_default_browser_linux()
+    
+    # Assert the result after stripping '.desktop'
+    assert result == 'firefox'
+
+
+def test_get_default_browser_linux_no_browser(mock_popen):
+    # Simulate the case where no browser is set (empty string)
+    mock_popen.return_value.read.return_value = ''
+    
+    # Call the function
+    result = get_default_browser_linux()
+    
+    # Assert the result is None
+    assert result is None
+
+
+def test_get_default_browser_linux_invalid_browser(mock_popen):
+    # Simulate a browser ID without ".desktop" (invalid case)
+    mock_popen.return_value.read.return_value = 'firefox\n'
+    
+    # Call the function
+    result = get_default_browser_linux()
+    
+    # Assert the result is the browser ID as it is
+    assert result == 'firefox'
+
+
+def test_get_default_browser_linux_exception(mock_popen):
+    # Simulate an exception during the command execution
+    mock_popen.side_effect = Exception("Command failed")
+    
+    # Call the function
+    result = get_default_browser_linux()
+    
+    # Assert the result is None due to exception
+    assert result is None
+
+@pytest.fixture
+def module():
+    config = {}
+    theme = {}
+    mock_dtlibrary = MagicMock()
+    return Module(config, theme, dtlibrary=mock_dtlibrary)
+    
+# Test for display_calendar method (opening browser)
+@patch('subprocess.Popen')
+@patch('tkinter.Tk')
+@patch('tkcalendar.Calendar')
+@patch('modules.contrib.calendar.get_default_browser_linux', return_value='/usr/bin/firefox')
+def test_display_calendar(mock_get_browser, mock_Calendar, mock_Tk, mock_popen, module):
+    # Mock tkinter methods
+    mock_root = MagicMock()
+    mock_Tk.return_value = mock_root
+    mock_cal = MagicMock()
+    mock_Calendar.return_value = mock_cal
+    # Mock parameter calls
+    module.parameter = MagicMock(browserpath='/usr/bin/firefox')
+    # Run display_calendar
+    module.display_calendar(None)
+    # Assertions for tkinter window and calendar creation
+    mock_Tk.assert_called_once()
+    mock_Calendar.assert_called_once()
+    # Check if subprocess.Popen is called with correct parameters
+    mock_popen.assert_called_once()