insights4you-jekyll-theme 0.1.1 → 0.2.2

data/assets/js/theme.js

@@ -1,31 +1,194 @@
-/**
- * demo-theme is specifically loaded right after the body and not deferred
- * to ensure we switch to the chosen dark/light theme as fast as possible.
- * This will prevent any flashes of the light theme (default) before switching.
- */
+// Ensure jsyaml is available
+/* eslint-disable no-undef */ // Disable undefined variable check for 'jsyaml'
+if (typeof jsyaml === "undefined") {
+  throw new Error("js-yaml library is not loaded. Please include it in your project.");
+}
+/* eslint-enable no-undef */
 
 const THEME_STORAGE_KEY = "tablerTheme";
-const defaultTheme = "light";
-let selectedTheme;
+const DEFAULT_THEME = "light";
 
-// https://stackoverflow.com/a/901144
-// Create a Proxy for URLSearchParams to simplify access to query parameters.
-// This allows us to use `params.key` instead of `params.get('key')`.
+// Proxy to access URL parameters securely
 const params = new Proxy(new URLSearchParams(window.location.search), {
-	get: (searchParams, prop) => searchParams.get(prop)
+  get: (searchParams, prop) => searchParams.get(prop),
 });
 
-if (params.theme) {
-  localStorage.setItem(THEME_STORAGE_KEY, params.theme);
-  selectedTheme = params.theme;
-} else {
-  const storedTheme = localStorage.getItem(THEME_STORAGE_KEY);
-  selectedTheme = storedTheme || defaultTheme;
+// Validate theme values
+function isValidTheme(theme) {
+  return ["light", "dark"].includes(theme);
+}
+
+// Apply the selected theme to the document
+function applyTheme(theme) {
+  document.body.setAttribute("data-bs-theme", theme);
+
+  // Accessibility: Notify screen readers of theme change
+  const themeAnnouncement = document.getElementById("theme-announcement");
+  if (themeAnnouncement) {
+    themeAnnouncement.textContent = `Theme changed to ${theme}`;
+  }
+}
+
+// Save the selected theme to localStorage
+function saveTheme(theme) {
+  localStorage.setItem(THEME_STORAGE_KEY, theme);
+}
+
+// Load the current theme based on priority: URL > localStorage > system preference > default
+function loadTheme() {
+  let selectedTheme;
+
+  // Prioritize theme from URL (sanitize input to prevent XSS)
+  if (params.theme && isValidTheme(params.theme)) {
+    selectedTheme = params.theme;
+    saveTheme(selectedTheme);
+  } else {
+    // Use localStorage or system preference
+    const storedTheme = localStorage.getItem(THEME_STORAGE_KEY);
+    selectedTheme = isValidTheme(storedTheme)
+      ? storedTheme
+      : window.matchMedia("(prefers-color-scheme: dark)").matches
+      ? "dark"
+      : DEFAULT_THEME;
+  }
+
+  // Apply the selected theme
+  applyTheme(selectedTheme);
+}
+
+// Toggle between light and dark themes
+/* eslint-disable no-unused-vars */ // Disable unused function check for 'toggleTheme'
+function toggleTheme(theme) {
+  saveTheme(theme);
+  applyTheme(theme);
+}
+/* eslint-enable no-unused-vars */
+
+// Load dynamic notifications
+async function loadNotifications() {
+  const notificationsList = document.getElementById("notifications-list");
+  const badge = document.getElementById("notification-badge");
+
+  if (!notificationsList || !badge) return;
+
+  try {
+    // Fetch local and remote notifications
+    const [localNotifications, remoteNotifications] = await Promise.all([
+      getLocalNotifications(),
+      fetchRemoteNotifications(),
+    ]);
+
+    // Combine, sort, and render notifications
+    const allNotifications = combineAndSortNotifications(localNotifications, remoteNotifications);
+    renderNotifications(allNotifications, notificationsList, badge);
+  } catch (error) {
+    console.error("Error loading notifications:", error);
+  }
+}
+
+// Fetch local notifications from site data
+function getLocalNotifications() {
+  try {
+    return Array.isArray(window.siteData?.notifications) ? window.siteData.notifications : [];
+  } catch (error) {
+    console.error("Error loading local notifications:", error);
+    return [];
+  }
+}
+
+// Fetch remote notifications from GitHub repository
+async function fetchRemoteNotifications() {
+  try {
+    const response = await fetch(
+      "https://raw.githubusercontent.com/marciopaiva/insights4you-jekyll-theme/main/_data/notifications.yml"
+    );
+    if (!response.ok) throw new Error("Failed to fetch remote notifications");
+    const yamlText = await response.text();
+    /* eslint-disable no-undef */ // Disable undefined variable check for 'jsyaml'
+    const parsedData = jsyaml.load(yamlText); // Parse YAML data
+    /* eslint-enable no-undef */
+    return Array.isArray(parsedData) ? parsedData : [];
+  } catch (error) {
+    console.error("Error fetching remote notifications:", error);
+    return [];
+  }
+}
+
+// Combine and sort notifications by date
+function combineAndSortNotifications(local, remote) {
+  return [...remote, ...local]
+    .filter((notification) => notification.date) // Ensure each notification has a valid date
+    .sort((a, b) => new Date(b.date) - new Date(a.date))
+    .slice(0, 5); // Display only the latest 5 notifications
+}
+
+// Render notifications in the DOM securely
+function renderNotifications(notifications, listElement, badgeElement) {
+  badgeElement.textContent = notifications.length;
+
+  // Clear existing notifications
+  listElement.innerHTML = "";
+
+  // Append notifications using DOM manipulation for security
+  notifications.forEach((notification) => {
+    const item = createNotificationItem(notification);
+    listElement.appendChild(item);
+  });
+}
+
+// Create a single notification item securely
+function createNotificationItem(notification) {
+  const container = document.createElement("div");
+  container.className = "list-group-item";
+
+  const row = document.createElement("div");
+  row.className = "row align-items-center";
+
+  const colAuto = document.createElement("div");
+  colAuto.className = "col-auto";
+  const statusDot = document.createElement("span");
+  statusDot.className = `status-dot bg-${notification.color || "blue"} d-block`;
+  colAuto.appendChild(statusDot);
+
+  const colText = document.createElement("div");
+  colText.className = "col text-truncate";
+  const title = document.createElement("a");
+  title.href = notification.link;
+  title.className = "text-body d-block";
+  title.textContent = notification.title || "Untitled Notification";
+  const description = document.createElement("div");
+  description.className = "text-secondary";
+  description.textContent = notification.description || "No description available";
+  const date = document.createElement("small");
+  date.className = "text-muted";
+  date.textContent = new Date(notification.date).toLocaleDateString();
+  colText.append(title, description, date);
+
+  const colActions = document.createElement("div");
+  colActions.className = "col-auto";
+  const actionLink = document.createElement("a");
+  actionLink.href = notification.link;
+  actionLink.className = "list-group-item-actions";
+  actionLink.target = "_blank";
+  const svgIcon = document.createElementNS("http://www.w3.org/2000/svg", "svg");
+  svgIcon.setAttribute("class", "icon text-muted icon-2");
+  svgIcon.setAttribute("viewBox", "0 0 24 24");
+  svgIcon.setAttribute("stroke", "currentColor");
+  svgIcon.setAttribute("fill", "none");
+  const path = document.createElementNS("http://www.w3.org/2000/svg", "path");
+  path.setAttribute("d", "M12 17.75l-6.172 3.245l1.179 -6.873l-5 -4.867l6.9 -1l3.086 -6.253l3.086 6.253l6.9 1l-5 4.867l1.179 6.873z");
+  svgIcon.appendChild(path);
+  actionLink.appendChild(svgIcon);
+  colActions.appendChild(actionLink);
+
+  row.append(colAuto, colText, colActions);
+  container.appendChild(row);
+
+  return container;
 }
 
-// Apply the selected theme to the document body
-if (selectedTheme === "dark") {
-  document.body.setAttribute("data-bs-theme", "dark");
-} else if (selectedTheme === "light") {
-  document.body.setAttribute("data-bs-theme", "light");
-}
+// Initialize theme and notifications when the page loads
+document.addEventListener("DOMContentLoaded", () => {
+  loadTheme();
+  loadNotifications();
+});

metadata

@@ -1,35 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: insights4you-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Marcio Paiva Barbosa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.9'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 4.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
-    - - "<"
+        version: 4.4.1
+- !ruby/object:Gem::Dependency
+  name: jekyll-feed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: jekyll-seo-tag
   requirement: !ruby/object:Gem::Requirement
@@ -58,10 +66,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
-description: A professional and responsive Jekyll theme designed for documentation
-  sites, admin panels, and project showcases. It includes customizable layouts, modern
-  design elements, and support for responsive design to ensure compatibility across
-  devices.
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: "A sleek and modern Jekyll theme inspired by the Tabler Admin Dashboard.
+  \nThis theme offers a clean, professional, and responsive interface, making it ideal
+  for developers, \ncontent creators, and businesses. Whether you're building documentation
+  sites, admin panels, or \nproject showcases, this theme provides a minimal-effort
+  solution with customizable layouts and \nmodern design elements.\n"
 email:
 - mpaivabarbosa@gmail.com
 executables: []
@@ -70,11 +121,35 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- _data/i4y-errors.json
+- _data/i4y-icons.json
+- _data/i4y-illustrations.json
+- _data/i4y-social-media.yml
+- _data/notifications.yml
+- _includes/card/profile.html
 - _includes/footer.html
-- _includes/header.html
-- _includes/sidebar.html
-- _layouts/base.html
+- _includes/head.html
+- _includes/header-logo.html
+- _includes/header-navbar.html
+- _includes/header-svg.html
+- _includes/ui/button.html
+- _includes/ui/empty.html
+- _includes/ui/icon.html
+- _includes/ui/illustration.html
+- _layouts/default.html
+- _layouts/error.html
+- _layouts/home.html
+- _layouts/post.html
 - assets/css/theme.min.css
+- assets/images/android-chrome-192x192.png
+- assets/images/android-chrome-512x512.png
+- assets/images/apple-touch-icon.png
+- assets/images/favicon-16x16.png
+- assets/images/favicon-32x32.png
+- assets/images/favicon.ico
+- assets/images/i4y-logo.jpg
+- assets/images/preview-dark.png
+- assets/images/site.webmanifest
 - assets/js/theme.js
 homepage: https://github.com/marciopaiva/insights4you-jekyll-theme
 licenses:
@@ -84,7 +159,11 @@ metadata:
   documentation_uri: https://github.com/marciopaiva/insights4you-jekyll-theme/#readme
   source_code_uri: https://github.com/marciopaiva/insights4you-jekyll-theme
   wiki_uri: https://github.com/marciopaiva/insights4you-jekyll-theme/wiki
+  changelog_uri: https://github.com/marciopaiva/insights4you-jekyll-theme/blob/main/CHANGELOG.md
   plugin_type: theme
+  funding_uri: https://github.com/sponsors/marciopaiva
+  usage_uri: https://github.com/marciopaiva/insights4you-jekyll-theme/wiki/Usage
+  examples_uri: https://github.com/marciopaiva/insights4you-jekyll-theme/tree/main/example-site
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -93,14 +172,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A sleek and modern Jekyll theme inspired by the Tabler Admin Dashboard.