shimmer 0.0.18 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de8e99f1e252a60ee4c57442fe9fe67ba7af78e626b55d7c1756eedf3a83e404
-  data.tar.gz: d28eeba9b1cdf8d9c1fc46151a334dc0993cacfbafe91223f14647e988a3ba23
+  metadata.gz: 89571a33faa2d1fd1d8c9624ab42a51f019418efc9c91af68fb3bb0385b5f602
+  data.tar.gz: 814bca1dbd13b0e147df173b1b41077c0c585f4bd5b8e1b9e6933051d597f231
 SHA512:
-  metadata.gz: e750c73c60fa769a97526a0eaeb13b0f497539d9ae5c5500c581e2b0aafa7dc922c61b6edf6c4514d8946e8526d5789b5e454ce5787f4850cb598bd9450c6f05
-  data.tar.gz: 62bcf6a9014420997d088bd41e9c491b4257456ec75f5881e252db5b7aea8b107c2d531ff2b10cba44e037d8eeb387a0edfbedcc09618da898dd3267bf84cad2
+  metadata.gz: 6d1c9bfa6f442914ca03747cf391ebf52086cb2c92d334641715031539cef826f09e171d3510e20866780ed87a1829182872485f6cd143c833ddebab97e1abf8
+  data.tar.gz: 5db21bb6096a9a4a555b17c05d2ba128379f049ed87bae1e9fd9cddf824a05214c9858d8760924ea948d11645f9052b3d503167a098ece2ba97fb5ca498db754

data/.vscode/settings.json

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

data/lib/shimmer/form/builder.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class Builder < ActionView::Helpers::FormBuilder
+      class << self
+        def input_registry
+          @input_registry ||= {}
+        end
+
+        def register(klass)
+          input_registry[klass.type] = klass
+        end
+      end
+
+      def input(method, as: guess_type(method), **options)
+        as ||= guess_type(method)
+        options[:class] ||= "input__input"
+        collection = options.delete :collection
+        collection_based = !collection.nil? || as == :select
+        collection ||= guess_collection(method) if collection_based
+        name_method ||= guess_name_method(method) if collection_based
+        id_method ||= :id if collection_based
+        classes = []
+        options[:required] ||= true if options[:required].nil? && required_attributes.include?(method)
+        options[:data] ||= {}
+        options[:data][:controller] = options.delete(:controller) if options[:controller]
+        wrapper_data = {}
+        extra = []
+        input_class = self.class.input_registry[as]
+        raise "Unknown type #{as}" unless input_class
+        input = input_class.new(builder: self, method: method, options: options, id_method: id_method, collection: collection, name_method: name_method)
+        wrap method: method, content: input.render, classes: classes + ["input--#{as}"], label: options[:label], data: wrapper_data, extra: extra
+      end
+
+      private
+
+      def required_attributes
+        []
+      end
+
+      def guess_type(method)
+        self.class.input_registry.values.find { |e| e.can_handle?(method) }&.type || :string
+      end
+
+      def guess_collection(method)
+        association_for(method)&.klass&.all || enum_for(method).map { |e| OpenStruct.new(id: e, name: e) } || []
+      end
+
+      def guess_name_method(method)
+        klass = association_for(method)&.klass
+        return :name unless klass
+
+        [:display_name, :name, :title].each do |key|
+          return key if klass.instance_methods.include?(key)
+        end
+      end
+
+      def association_for(method)
+        collection_method = method.to_s.delete_suffix("_id")
+        object.class.reflect_on_association(collection_method) if object.respond_to?(collection_method)
+      end
+
+      def enum_for(method)
+        object.class.types.keys if object.class.respond_to?(method.to_s.pluralize)
+      end
+
+      def wrap(method:, content:, classes:, label:, data: nil, extra: nil)
+        if object&.errors&.[](method)&.any?
+          classes << "input--error"
+          errors = safe_join(object.errors[method].map { |e| content_tag :div, e, class: "input__error" })
+        end
+        label = label == false ? nil : self.label(method, label, class: "input__label")
+        content_tag(:div, safe_join([label, content, errors, extra].compact), class: ["input"] + classes, data: data)
+      end
+
+      def helper
+        @template
+      end
+
+      def value_for(method)
+        object.public_send(method)
+      end
+
+      delegate :content_tag, :t, :safe_join, :icon, :tag, to: :helper
+    end
+  end
+end

data/lib/shimmer/form/checkboxes_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class CheckboxesField < Field
+      self.type = :checkboxes
+
+      def render
+        builder.collection_check_boxes method, collection, id_method, name_method, {}, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/date_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class DateField < Field
+      self.type = :date
+
+      def render
+        builder.date_field method, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/email_field.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class EmailField < Field
+      self.type = :email
+
+      class << self
+        def can_handle?(method)
+          method.to_s.end_with?("email")
+        end
+      end
+
+      def render
+        builder.email_field method, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/field.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class Field
+      class_attribute :type
+
+      attr_reader :builder, :method, :collection, :id_method, :name_method, :options
+
+      class << self
+        def can_handle?(method)
+          false
+        end
+      end
+
+      def initialize(builder:, method:, collection:, id_method:, name_method:, options: {})
+        @builder = builder
+        @method = method
+        @collection = collection
+        @id_method = id_method
+        @name_method = name_method
+        @options = options
+      end
+    end
+  end
+end

data/lib/shimmer/form/number_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class NumberField < Field
+      self.type = :number
+
+      def render
+        builder.number_field method, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/password_field.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class PasswordField < Field
+      self.type = :password
+
+      class << self
+        def can_handle?(method)
+          method.to_s.end_with?("password")
+        end
+      end
+
+      def render
+        builder.password_field method, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/pdf_field.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class PdfField < Field
+      self.type = :pdf
+
+      class << self
+        def can_handle?(method)
+          method.to_s.end_with?("pdf")
+        end
+      end
+
+      def render
+        builder.file_field method, options.reverse_merge(accept: "application/pdf")
+      end
+    end
+  end
+end

data/lib/shimmer/form/radio_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class RadioField < Field
+      self.type = :radio
+
+      def render
+        builder.collection_radio_buttons method, collection, id_method, name_method, {}, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/select_field.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class SelectField < Field
+      self.type = :select
+
+      class << self
+        def can_handle?(method)
+          method.to_s.end_with?("_id")
+        end
+      end
+
+      def render
+        builder.collection_select method, collection, id_method, name_method, {}, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/text_area_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class TextAreaField < Field
+      self.type = :text
+
+      def render
+        builder.text_area method, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/text_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class TextField < Field
+      self.type = :string
+
+      def render
+        builder.text_field method, options
+      end
+    end
+  end
+end

data/lib/shimmer/form/time_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+    class TimeField < Field
+      self.type = :time
+
+      def render
+        builder.time_field method, options.reverse_merge(value: object.public_send(method))
+      end
+    end
+  end
+end

data/lib/shimmer/form.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Shimmer
+  module Form
+  end
+end
+
+require_relative "./form/builder"
+require_relative "./form/field"
+
+Dir["#{File.expand_path("./form", __dir__)}/*"].sort.each do |e|
+  require e
+  name = e.split("/").last.delete_suffix(".rb")
+  next unless name.end_with?("_field")
+  Shimmer::Form::Builder.register("Shimmer::Form::#{name.classify}".constantize)
+end

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/version.rb

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

data/lib/shimmer.rb

@@ -7,6 +7,7 @@ Dir["#{File.expand_path("../lib/shimmer/controllers", __dir__)}/*"].sort.each {
 Dir["#{File.expand_path("../lib/shimmer/jobs", __dir__)}/*"].sort.each { |e| require e }
 Dir["#{File.expand_path("../lib/shimmer/utils", __dir__)}/*"].sort.each { |e| require e }
 require_relative "shimmer/auth"
+require_relative "shimmer/form"
 
 module Shimmer
   class Error < StandardError; 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.18
+  version: 0.0.21
 platform: ruby
 authors:
 - Jens Ravens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -145,6 +145,20 @@ files:
 - lib/shimmer/auth/user.rb
 - lib/shimmer/controllers/files_controller.rb
 - lib/shimmer/controllers/sitemaps_controller.rb
+- lib/shimmer/form.rb
+- lib/shimmer/form/builder.rb
+- lib/shimmer/form/checkboxes_field.rb
+- lib/shimmer/form/date_field.rb
+- lib/shimmer/form/email_field.rb
+- lib/shimmer/form/field.rb
+- lib/shimmer/form/number_field.rb
+- lib/shimmer/form/password_field.rb
+- lib/shimmer/form/pdf_field.rb
+- lib/shimmer/form/radio_field.rb
+- lib/shimmer/form/select_field.rb
+- lib/shimmer/form/text_area_field.rb
+- lib/shimmer/form/text_field.rb
+- lib/shimmer/form/time_field.rb
 - lib/shimmer/helpers/meta_helper.rb
 - lib/shimmer/jobs/sitemap_job.rb
 - lib/shimmer/middlewares/cloudflare.rb
@@ -154,6 +168,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 +178,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