shimmer 0.0.17 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef9968ad0ba48627fb9adb95ae2702575de2f9fa1b1e56ba3f30c9872d9cde38
-  data.tar.gz: c8bef4d12c776820c96e810a1e3ae1cb7c6717f029d5ac532b7fc05e595005d2
+  metadata.gz: d8819816445402b9ba5fc3a8ffcd9e273f85b34018cd29d0e0c99b5a338e6c37
+  data.tar.gz: 91786fdab270afb2c5cd89c3874284dd1701263eacbd309043ba35b87ae49ad5
 SHA512:
-  metadata.gz: 2c2dfb753bd6ac9afc4a4ba726c99a53a1dce6e1843c6b5bcdc320671ffcb2da0a8575ff357fd1294b3c25beed7a2026e144dffc0873a1a6ded6b78318ac737a
-  data.tar.gz: 9c00815fe851db16bd4ebf925d2ba2beb8b84c729351982f430721d6c7a395d21fd162add118a82a80df13ed8b97c67f76ac8177dadac29573c9e9604d8f9687
+  metadata.gz: 0f0abe61b9c8a001df68bfd019cee02d5de58c2c582ab58ed0f6899dcad78409f9136e62cd5892be9dc5167708f19b04df66afbdaccf0f925e5b986f1e9de97b
+  data.tar.gz: 2f8031509918cd09d64dd87158b9b119fc90f3e594c2fbdc068898bdffe29b5687cb7f6161af7d7d98061fe17ad72747388c8a01e2c381f082801d02ace39193

data/.vscode/settings.json

@@ -5,4 +5,5 @@
     "editor.formatOnSave": false,
     "editor.defaultFormatter": "castwide.solargraph"
   },
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

data/lib/shimmer/utils/consent_settings.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Shimmer
+  class ConsentSettings
+    SETTINGS = [:essential, :targeting, :statistic].freeze
+    DEFAULT = [:essential].freeze
+
+    SETTINGS.each do |setting|
+      attr_accessor setting
+      alias_method "#{setting}?", setting
+    end
+
+    def initialize(cookies)
+      @cookies = cookies
+      allowed = @cookies[:consent].to_s.split(",").map(&:strip)
+      SETTINGS.each do |setting|
+        instance_variable_set "@#{setting}", DEFAULT.include?(setting) || allowed.include?(setting.to_s)
+      end
+    end
+
+    def save
+      value = SETTINGS.map { |e| e.to_s if instance_variable_get("@#{e}") }.compact.join(",")
+      @cookies.permanent[:consent] = {value: value, expires: 2.years.from_now}
+    end
+
+    def given?
+      @cookies[:consent].present?
+    end
+  end
+
+  module Consent
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :consent_settings
+      def consent_settings
+        @consent_settings ||= ConsentSettings.new(cookies)
+      end
+    end
+  end
+end

data/lib/shimmer/utils/file_helper.rb

@@ -27,11 +27,11 @@ module Shimmer
     end
 
     def image_file_path(source, width: nil, height: nil)
-      image_file_proxy(source, width: width, height: height).path
+      image_file_proxy(source, width: width, height: height)&.path
     end
 
     def image_file_url(source, width: nil, height: nil)
-      image_file_proxy(source, width: width, height: height).url
+      image_file_proxy(source, width: width, height: height)&.url
     end
 
     def image_file_proxy(source, width: nil, height: nil)

data/lib/shimmer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shimmer
-  VERSION = "0.0.17"
+  VERSION = "0.0.20"
 end

data/src/consent.ts

@@ -0,0 +1,64 @@
+import { getCookie, setCookie } from "./util";
+
+const consentCategories = ["essential", "targeting", "statistic"] as const;
+export type ConsentCategory = typeof consentCategories[number];
+
+export class Consent {
+  #consentListeners: Record<ConsentCategory, Array<() => void>> = {
+    essential: [],
+    targeting: [],
+    statistic: [],
+  };
+
+  get permitted(): ConsentCategory[] {
+    return (getCookie("consent") ?? "").split(",") as ConsentCategory[];
+  }
+
+  set permitted(settings: ConsentCategory[]) {
+    setCookie("consent", settings.join(","));
+    settings.forEach((category) => {
+      this.#consentListeners[category].forEach((e) => e());
+    });
+  }
+
+  get given(): boolean {
+    return getCookie("consent") !== undefined;
+  }
+
+  permitAll(): void {
+    this.permitted = consentCategories.slice();
+  }
+
+  denyAll(): void {
+    this.permitted = ["essential"];
+  }
+
+  showSettings(): void {
+    const element = document.getElementById("personalization-settings");
+    if (element) element.hidden = false;
+  }
+
+  consentFor(category: ConsentCategory): Promise<void> {
+    return new Promise((res) => {
+      if (this.permitted.includes(category)) {
+        res();
+      } else {
+        this.#consentListeners[category].push(res);
+      }
+    });
+  }
+
+  async enableGoogleAnalytics(
+    id: string,
+    role: ConsentCategory = "statistic"
+  ): Promise<void> {
+    await this.consentFor(role);
+    window.gtag("config", id);
+    const script = document.createElement("script");
+    script.setAttribute(
+      "src",
+      `https://www.googletagmanager.com/gtag/js?id=${id}`
+    );
+    document.head.appendChild(script);
+  }
+}

data/src/controllers/analytics.ts

@@ -0,0 +1,42 @@
+import { Controller } from "@hotwired/stimulus";
+
+interface DataEvent {
+  event: string;
+}
+
+declare global {
+  interface Window {
+    dataLayer?: DataEvent[];
+    gtag(...arg): void;
+  }
+}
+
+const dataLayer = (window.dataLayer = window.dataLayer ?? []);
+
+window.gtag = (...arg) => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  dataLayer.push(arg as any);
+};
+window.gtag("js", new Date());
+
+export default class extends Controller {
+  connect(): void {
+    this.recordPage();
+  }
+
+  recordAction(event: MouseEvent): void {
+    const data = JSON.parse(
+      (event.target as HTMLElement).dataset.analytics ?? "{}"
+    );
+    dataLayer.push(data);
+  }
+
+  recordPage(): void {
+    const event = {
+      event: "Pageview",
+      path: location.pathname + location.search,
+      host: location.host,
+    };
+    dataLayer.push(event);
+  }
+}

data/src/controllers/consent.ts

@@ -0,0 +1,52 @@
+import { Controller } from "@hotwired/stimulus";
+import { ConsentCategory } from "../consent";
+
+export default class extends Controller {
+  static targets = ["check"];
+  declare checkTargets: HTMLInputElement[];
+
+  connect(): void {
+    this.checkTargets.forEach((input) => {
+      input.checked =
+        window.ui?.consent.permitted.includes(input.name as ConsentCategory) ||
+        input.name === "essential";
+    });
+  }
+
+  permitAll(event: Event): void {
+    event.preventDefault();
+    window.ui?.consent.permitAll();
+    this.closeAll();
+  }
+
+  denyAll(event: Event): void {
+    event.preventDefault();
+    window.ui?.consent.denyAll();
+    this.closeAll();
+  }
+
+  save(event: Event): void {
+    event.preventDefault();
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    window.ui!.consent.permitted = this.checkTargets
+      .filter((e) => e.checked)
+      .map((e) => e.name) as ConsentCategory[];
+    this.closeAll();
+  }
+
+  manage(event: Event): void {
+    event.preventDefault();
+    const div = document.body.querySelector(
+      "#personalization-settings"
+    ) as HTMLDivElement;
+    if (!div) return;
+    (this.element as HTMLElement).hidden = true;
+    div.hidden = false;
+  }
+
+  closeAll(): void {
+    document
+      .querySelectorAll("[data-controller='consent']")
+      .forEach((e: HTMLElement) => (e.hidden = true));
+  }
+}

data/src/index.ts

@@ -1,7 +1,10 @@
 import type { Application } from "@hotwired/stimulus";
 import { ModalPresenter } from "./modal";
 import { PopoverPresenter } from "./popover";
+import { Consent } from "./consent";
 import RemoteNavigationController from "./controllers/remote-navigation";
+import ConsentController from "./controllers/consent";
+import AnalyticsController from "./controllers/analytics";
 import "./touch";
 
 export { registerServiceWorker } from "./serviceworker";
@@ -12,10 +15,17 @@ declare global {
     ui?: {
       modal: ModalPresenter;
       popover: PopoverPresenter;
+      consent: Consent;
     };
   }
 }
 
+window.ui = {
+  modal: new ModalPresenter(),
+  popover: new PopoverPresenter(),
+  consent: new Consent(),
+};
+
 function createRemoteDestination(): void {
   if (document.getElementById("shimmer")) {
     return;
@@ -33,8 +43,8 @@ export async function start({
   window.addEventListener("turbo:load", createRemoteDestination);
   createRemoteDestination();
   application.register("remote-navigation", RemoteNavigationController);
-  window.ui = {
-    modal: new ModalPresenter(),
-    popover: new PopoverPresenter(),
-  };
+  application.register("consent", ConsentController);
+  application.register("analytics", AnalyticsController);
 }
+
+export const ui = window.ui;

data/src/util.ts

@@ -44,3 +44,22 @@ export function wait(seconds: number): Promise<void> {
     setTimeout(res, seconds * 1000);
   });
 }
+
+export function getCookie(key: string): string | null {
+  if (!document.cookie) return null;
+  return (
+    document.cookie
+      .split(";")
+      .map((v) => v.split("="))
+      .reduce((acc, v) => {
+        acc[decodeURIComponent(v[0].trim())] = decodeURIComponent(v[1].trim());
+        return acc;
+      }, {})[key] ?? null
+  );
+}
+
+export function setCookie(key: string, value: string): void {
+  const date = new Date();
+  date.setTime(date.getTime() + 365 * 24 * 60 * 60 * 1000);
+  document.cookie = `${key}=${value}; expires=${date.toUTCString()}`;
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shimmer
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.20
 platform: ruby
 authors:
 - Jens Ravens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -154,6 +154,7 @@ files:
 - lib/shimmer/tasks/lint.rake
 - lib/shimmer/tasks/s3.rake
 - lib/shimmer/utils/config.rb
+- lib/shimmer/utils/consent_settings.rb
 - lib/shimmer/utils/file_helper.rb
 - lib/shimmer/utils/file_proxy.rb
 - lib/shimmer/utils/localizable.rb
@@ -163,6 +164,9 @@ files:
 - lib/shimmer/version.rb
 - package.json
 - rollup.config.js
+- src/consent.ts
+- src/controllers/analytics.ts
+- src/controllers/consent.ts
 - src/controllers/remote-navigation.ts
 - src/index.ts
 - src/locale.ts