shimmer 0.0.16 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d82a8e015623e83b0381e182752ede22419e26c40b9a730536f6020793818b75
-  data.tar.gz: 00766a05189358517092bcbc6ef958d26acbfae14efb98b45f81c3b848cfaffa
+  metadata.gz: adda5b02ed66f485505f07b24ba314621c5b0dd1cae9ce3093681651f0a1a509
+  data.tar.gz: 89c1baa878afdf2bb38c2cc62eeafd298f15916f11466e5ec1e31eb5b42f9be6
 SHA512:
-  metadata.gz: d9e72dcab3004ea3c720a1b7041ee0714e4beded68cfa8caa9f5a1213fbe3ece9cf82030437be32c1532c85c67e489b159fa39f13392664c9c5f3520f8ba67f6
-  data.tar.gz: e8e15ddcc1aedbad180f0b62dd11af6791d8ef35aa5139e7f0e7ffdead8551052f8ccbed36c143ae39868e44ca381ed27737e036d93dca8b9e5b8cffd125fae5
+  metadata.gz: f2add223e56adabf705dcb3061950ea47613d50caf4b7c240b3c7aa1907dbb0ef52b179b409183d2d205f21789d3cc15719e0ade1ba17387085eb47f9e2945d1
+  data.tar.gz: e496ccb035f571cd070c2af88968d0ab6d9d45bcf23016655a9a7213beccf9c83907f001f2f26c4188ce5ce1bc4affbd5c29d2b16d43d60a7949df0e9446f908

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

@@ -2,6 +2,16 @@
 
 module Shimmer
   module FileHelper
+    extend ActiveSupport::Concern
+
+    included do
+      ActiveSupport.on_load(:action_view) do
+        include Shimmer::FileAdditions
+      end
+    end
+  end
+
+  module FileAdditions
     def image_tag(source, **options)
       return nil if source.blank?
 
@@ -9,19 +19,27 @@ module Shimmer
         attachment = source
         width = options[:width]
         height = options[:height]
-        source = image_file_url(source, width: width, height: height)
+        source = image_file_path(source, width: width, height: height)
         options[:loading] = :lazy
-        options[:srcset] = "#{source} 1x, #{image_file_url(attachment, width: width.to_i * 2, height: height ? height.to_i * 2 : nil)} 2x" if options[:width].present?
+        options[:srcset] = "#{source} 1x, #{image_file_path(attachment, width: width.to_i * 2, height: height ? height.to_i * 2 : nil)} 2x" if options[:width].present?
       end
       super source, options
     end
 
+    def image_file_path(source, width: nil, height: nil)
+      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
+    end
+
+    def image_file_proxy(source, width: nil, height: nil)
       return if source.blank?
       return source if source.is_a?(String)
 
       blob = source.try(:blob) || source
-      Shimmer::FileProxy.new(blob_id: blob.id, width: width, height: height).url
+      Shimmer::FileProxy.new(blob_id: blob.id, width: width, height: height)
     end
   end
 end

data/lib/shimmer/version.rb

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

data/src/consent.ts

@@ -0,0 +1,28 @@
+import { getCookie, setCookie } from "./util";
+
+export class Consent {
+  get permitted(): string[] {
+    return (getCookie("consent") ?? "").split(",");
+  }
+
+  set permitted(settings: string[]) {
+    setCookie("consent", settings.join(","));
+  }
+
+  get given(): boolean {
+    return getCookie("consent") !== undefined;
+  }
+
+  permitAll(): void {
+    this.permitted = ["essential", "targeting", "statistic"];
+  }
+
+  denyAll(): void {
+    this.permitted = ["essential"];
+  }
+
+  showSettings(): void {
+    const element = document.getElementById("personalization-settings");
+    if (element) element.hidden = false;
+  }
+}

data/src/controllers/consent.ts

@@ -0,0 +1,51 @@
+import { Controller } from "@hotwired/stimulus";
+
+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) ||
+        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);
+    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,9 @@
 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 "./touch";
 
 export { registerServiceWorker } from "./serviceworker";
@@ -12,6 +14,7 @@ declare global {
     ui?: {
       modal: ModalPresenter;
       popover: PopoverPresenter;
+      consent: Consent;
     };
   }
 }
@@ -33,8 +36,10 @@ export async function start({
   window.addEventListener("turbo:load", createRemoteDestination);
   createRemoteDestination();
   application.register("remote-navigation", RemoteNavigationController);
+  application.register("consent", ConsentController);
   window.ui = {
     modal: new ModalPresenter(),
     popover: new PopoverPresenter(),
+    consent: new Consent(),
   };
 }

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.16
+  version: 0.0.19
 platform: ruby
 authors:
 - Jens Ravens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-12 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,8 @@ files:
 - lib/shimmer/version.rb
 - package.json
 - rollup.config.js
+- src/consent.ts
+- src/controllers/consent.ts
 - src/controllers/remote-navigation.ts
 - src/index.ts
 - src/locale.ts