al_cookie 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a08992fa6f34ce007c29aa92fc0e51285375da5607b1ab6b5c631c447ffd9662
+  data.tar.gz: d618c0fa1ff93ba06f1a5ef76baa0e4b13c82f1d8b21a99ffee5dd0295ba7494
+SHA512:
+  metadata.gz: 2a2fe65b699a2da510cbf413ab11b8d44faad01b8e843d61900499d6d428a5365826c053f453eff3daaf5dded46a2210e1d502d28f78c548eefcf0e8f0307074
+  data.tar.gz: 5fd2dfea12cedd3c5a6ef665dd3dbc59477b009a6d9b0368915e9d9e98c5310365bccccd5878bd0dc8ba5a24897f6d2a22e0fee21e6b6ed7721e704c0231323c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+- Initial extraction of cookie consent runtime from `al_folio_core` into `al_cookie`.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) al-folio maintainers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# al-cookie
+
+Bootstrap branch for PR base.

data/lib/al_cookie/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AlCookie
+  VERSION = "1.0.0"
+end

data/lib/al_cookie 2.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "liquid"
+require_relative "al_cookie/version"
+
+module AlCookie
+  PLUGIN_ROOT = File.expand_path("..", __dir__)
+  TEMPLATES_ROOT = File.join(PLUGIN_ROOT, "lib", "templates")
+  ASSETS_ROOT = File.join(PLUGIN_ROOT, "lib", "assets")
+
+  class PluginStaticFile < Jekyll::StaticFile; end
+
+  module_function
+
+  def enabled?(site)
+    site.config["enable_cookie_consent"] == true
+  end
+
+  def render_setup_script(context)
+    template_path = File.join(TEMPLATES_ROOT, "cookie_consent_setup.js.liquid")
+    template = Liquid::Template.parse(File.read(template_path))
+    payload = context.registers[:site].site_payload
+    payload["page"] = context.registers[:page] || {}
+    template.render(payload, registers: context.registers)
+  end
+
+  class AssetsGenerator < Jekyll::Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      return unless AlCookie.enabled?(site)
+
+      Dir.glob(File.join(ASSETS_ROOT, "**", "*")).sort.each do |source_path|
+        next if File.directory?(source_path)
+
+        relative_dir = File.dirname(source_path).sub("#{PLUGIN_ROOT}/", "")
+        site.static_files << PluginStaticFile.new(site, PLUGIN_ROOT, relative_dir, File.basename(source_path))
+      end
+    end
+  end
+
+  class CookieStylesTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      return "" unless site && AlCookie.enabled?(site)
+
+      libs = site.config["third_party_libraries"] || {}
+      <<~HTML
+        <link
+          defer
+          rel="stylesheet"
+          href="#{libs.dig("vanilla-cookieconsent", "url", "css")}"
+          integrity="#{libs.dig("vanilla-cookieconsent", "integrity", "css")}"
+          crossorigin="anonymous"
+        >
+      HTML
+    end
+  end
+
+  class CookieScriptsTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      return "" unless site && AlCookie.enabled?(site)
+
+      libs = site.config["third_party_libraries"] || {}
+      baseurl = site.config["baseurl"] || ""
+      setup_script = AlCookie.render_setup_script(context)
+
+      <<~HTML
+        <script
+          defer
+          src="#{libs.dig("vanilla-cookieconsent", "url", "js")}"
+          integrity="#{libs.dig("vanilla-cookieconsent", "integrity", "js")}"
+          crossorigin="anonymous"
+        ></script>
+        <script defer src="#{baseurl}/assets/al_cookie/js/cookie-theme-sync.js"></script>
+        <script>
+        #{setup_script}
+        </script>
+      HTML
+    end
+  end
+end
+
+Liquid::Template.register_tag("al_cookie_styles", AlCookie::CookieStylesTag)
+Liquid::Template.register_tag("al_cookie_scripts", AlCookie::CookieScriptsTag)

data/lib/al_cookie.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "liquid"
+require_relative "al_cookie/version"
+
+module AlCookie
+  PLUGIN_ROOT = File.expand_path("..", __dir__)
+  TEMPLATES_ROOT = File.join(PLUGIN_ROOT, "lib", "templates")
+  ASSETS_ROOT = File.join(PLUGIN_ROOT, "lib", "assets")
+
+  class PluginStaticFile < Jekyll::StaticFile; end
+
+  module_function
+
+  def enabled?(site)
+    site.config["enable_cookie_consent"] == true
+  end
+
+  def render_setup_script(context)
+    template_path = File.join(TEMPLATES_ROOT, "cookie_consent_setup.js.liquid")
+    template = Liquid::Template.parse(File.read(template_path))
+    payload = context.registers[:site].site_payload
+    payload["page"] = context.registers[:page] || {}
+    template.render(payload, registers: context.registers)
+  end
+
+  class AssetsGenerator < Jekyll::Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      return unless AlCookie.enabled?(site)
+
+      Dir.glob(File.join(ASSETS_ROOT, "**", "*")).sort.each do |source_path|
+        next if File.directory?(source_path)
+
+        relative_dir = File.dirname(source_path).sub("#{PLUGIN_ROOT}/", "")
+        site.static_files << PluginStaticFile.new(site, PLUGIN_ROOT, relative_dir, File.basename(source_path))
+      end
+    end
+  end
+
+  class CookieStylesTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      return "" unless site && AlCookie.enabled?(site)
+
+      libs = site.config["third_party_libraries"] || {}
+      <<~HTML
+        <link
+          defer
+          rel="stylesheet"
+          href="#{libs.dig("vanilla-cookieconsent", "url", "css")}"
+          integrity="#{libs.dig("vanilla-cookieconsent", "integrity", "css")}"
+          crossorigin="anonymous"
+        >
+      HTML
+    end
+  end
+
+  class CookieScriptsTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      return "" unless site && AlCookie.enabled?(site)
+
+      libs = site.config["third_party_libraries"] || {}
+      baseurl = site.config["baseurl"] || ""
+      setup_script = AlCookie.render_setup_script(context)
+
+      <<~HTML
+        <script
+          defer
+          src="#{libs.dig("vanilla-cookieconsent", "url", "js")}"
+          integrity="#{libs.dig("vanilla-cookieconsent", "integrity", "js")}"
+          crossorigin="anonymous"
+        ></script>
+        <script defer src="#{baseurl}/assets/al_cookie/js/cookie-theme-sync.js"></script>
+        <script>
+        #{setup_script}
+        </script>
+      HTML
+    end
+  end
+end
+
+Liquid::Template.register_tag("al_cookie_styles", AlCookie::CookieStylesTag)
+Liquid::Template.register_tag("al_cookie_scripts", AlCookie::CookieScriptsTag)

data/lib/assets/al_cookie/js/cookie-theme-sync.js

@@ -0,0 +1,35 @@
+(function () {
+  function applyCookieThemeClass() {
+    var root = document.documentElement;
+    var theme = root.getAttribute("data-theme");
+
+    if (theme === "dark") {
+      root.classList.add("cc--darkmode");
+    } else {
+      root.classList.remove("cc--darkmode");
+    }
+  }
+
+  function setupObserver() {
+    if (typeof MutationObserver !== "function") {
+      return;
+    }
+
+    var root = document.documentElement;
+    var observer = new MutationObserver(function (mutations) {
+      for (var i = 0; i < mutations.length; i += 1) {
+        if (mutations[i].attributeName === "data-theme") {
+          applyCookieThemeClass();
+          break;
+        }
+      }
+    });
+
+    observer.observe(root, { attributes: true, attributeFilter: ["data-theme"] });
+  }
+
+  document.addEventListener("DOMContentLoaded", function () {
+    applyCookieThemeClass();
+    setupObserver();
+  });
+})();

data/lib/templates/cookie_consent_setup.js.liquid

@@ -0,0 +1,115 @@
+window.dataLayer = window.dataLayer || [];
+
+if (typeof window.gtag !== "function") {
+  window.gtag = function () {
+    window.dataLayer.push(arguments);
+  };
+}
+
+var gtag = window.gtag;
+gtag("consent", "default", {
+  ad_storage: "denied",
+  analytics_storage: "denied",
+  functionality_storage: "denied",
+  personalization_storage: "denied",
+});
+
+var cookieConsentRetryCount = 0;
+var COOKIE_CONSENT_MAX_RETRIES = 50;
+
+function initializeCookieConsent() {
+  if (!window.CookieConsent) {
+    if (cookieConsentRetryCount++ < COOKIE_CONSENT_MAX_RETRIES) {
+      setTimeout(initializeCookieConsent, 100);
+    } else {
+      console.error("CookieConsent library failed to load");
+    }
+    return;
+  }
+
+  window.CookieConsent.run({
+    categories: {
+      necessary: {
+        enabled: true,
+        readOnly: true,
+      },
+      analytics: {},
+    },
+    language: {
+      default: "en",
+      translations: {
+        en: {
+          consentModal: {
+            title: "We use cookies",
+            description:
+              'This website uses cookies to improve your experience and analyze site traffic. By clicking "Accept all", you consent to our use of cookies.',
+            acceptAllBtn: "Accept all",
+            acceptNecessaryBtn: "Reject all",
+            showPreferencesBtn: "Manage Individual preferences",
+          },
+          preferencesModal: {
+            title: "Manage cookie preferences",
+            acceptAllBtn: "Accept all",
+            acceptNecessaryBtn: "Reject all",
+            savePreferencesBtn: "Accept current selection",
+            closeIconLabel: "Close modal",
+            sections: [
+              {
+                title: "Cookie usage",
+                description:
+                  "We use cookies to ensure the basic functionalities of the website and to enhance your online experience. You can choose for each category to opt-in/out whenever you want.",
+              },
+              {
+                title: "Strictly Necessary cookies",
+                description:
+                  "These cookies are essential for the proper functioning of the website. Without these cookies, the website would not work properly.",
+                linkedCategory: "necessary",
+              },
+              {
+                title: "Analytics cookies",
+                description:
+                  "These cookies allow us to measure traffic and analyze your behavior to improve our service.",
+                linkedCategory: "analytics",
+              },
+              {
+                title: "More information",
+                description:
+                  'For any queries in relation to our policy on cookies and your choices, please <a class="cc-link" href="{{ site.url }}{{ site.baseurl }}/#contact">contact us</a>.',
+              },
+            ],
+          },
+        },
+      },
+    },
+    onFirstConsent: function (consentData) {
+      updateConsentMode(consentData);
+    },
+    onChange: function (consentData) {
+      updateConsentMode(consentData);
+    },
+  });
+
+  function updateConsentMode(consentData) {
+    var categories = consentData.categories || consentData;
+
+    if (!categories || typeof categories !== "object") {
+      console.warn("Invalid consent data structure:", consentData);
+      return;
+    }
+
+    gtag("consent", "update", {
+      analytics_storage: categories.analytics ? "granted" : "denied",
+      ad_storage: "denied",
+      functionality_storage: "denied",
+      personalization_storage: "denied",
+    });
+
+    if (categories.analytics) {
+      console.debug("Analytics consent granted; tracking enabled for configured providers.");
+    } else {
+      console.debug("Analytics consent denied; tracking remains blocked.");
+    }
+  }
+}
+
+initializeCookieConsent();

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: al_cookie
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- al-folio maintainers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-02-16 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Provides cookie consent runtime assets and Liquid tags for al-folio sites.
+email:
+- maintainers@al-folio.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/al_cookie 2.rb
+- lib/al_cookie.rb
+- lib/al_cookie/version.rb
+- lib/assets/al_cookie/js/cookie-theme-sync.js
+- lib/templates/cookie_consent_setup.js.liquid
+homepage: https://github.com/al-org-dev/al-cookie
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/al-org-dev/al-cookie
+  source_code_uri: https://github.com/al-org-dev/al-cookie
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Cookie consent plugin for al-folio v1.x
+test_files: []