shimmer 0.0.19 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adda5b02ed66f485505f07b24ba314621c5b0dd1cae9ce3093681651f0a1a509
-  data.tar.gz: 89c1baa878afdf2bb38c2cc62eeafd298f15916f11466e5ec1e31eb5b42f9be6
+  metadata.gz: 36f3761e1bd5856a9fd2078201abda25b544eff5e807566ce85847ba291c47d9
+  data.tar.gz: c946f2ec830a472aee08d835dbb697711d46c107152723ee8f9bb43a36bc4173
 SHA512:
-  metadata.gz: f2add223e56adabf705dcb3061950ea47613d50caf4b7c240b3c7aa1907dbb0ef52b179b409183d2d205f21789d3cc15719e0ade1ba17387085eb47f9e2945d1
-  data.tar.gz: e496ccb035f571cd070c2af88968d0ab6d9d45bcf23016655a9a7213beccf9c83907f001f2f26c4188ce5ce1bc4affbd5c29d2b16d43d60a7949df0e9446f908
+  metadata.gz: d8bb839595c9e32ab185276bdaac0c8a6f43b4ce1fb1ce0d82d47a1c18c5ae082e29caa68c34d14856db2ebb2001fe4774f5b687599b794706d199767bd46de1
+  data.tar.gz: 885c2bdb0326b02c3eebd7d4606d79906b52264ef8b6043dc6f4061dffd6c8b5a786af22f9d25378d7aa21988a34d6412409adcd7acb6acce7f478e342323eba

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shimmer
-  VERSION = "0.0.19"
+  VERSION = "0.0.22"
 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

@@ -1,12 +1,24 @@
 import { getCookie, setCookie } from "./util";
 
+const consentCategories = ["essential", "targeting", "statistic"] as const;
+export type ConsentCategory = typeof consentCategories[number];
+
 export class Consent {
-  get permitted(): string[] {
-    return (getCookie("consent") ?? "").split(",");
+  #consentListeners: Record<ConsentCategory, Array<() => void>> = {
+    essential: [],
+    targeting: [],
+    statistic: [],
+  };
+
+  get permitted(): ConsentCategory[] {
+    return (getCookie("consent") ?? "").split(",") as ConsentCategory[];
   }
 
-  set permitted(settings: string[]) {
+  set permitted(settings: ConsentCategory[]) {
     setCookie("consent", settings.join(","));
+    settings.forEach((category) => {
+      this.#consentListeners[category].forEach((e) => e());
+    });
   }
 
   get given(): boolean {
@@ -14,7 +26,7 @@ export class Consent {
   }
 
   permitAll(): void {
-    this.permitted = ["essential", "targeting", "statistic"];
+    this.permitted = consentCategories.slice();
   }
 
   denyAll(): void {
@@ -25,4 +37,30 @@ export class Consent {
     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("js", new Date());
+    window.gtag("config", id);
+    const script = document.createElement("script");
+    script.async = true;
+    script.setAttribute(
+      "src",
+      `https://www.googletagmanager.com/gtag/js?id=${id}`
+    );
+    document.head.prepend(script);
+  }
 }

data/src/controllers/analytics.ts

@@ -0,0 +1,43 @@
+import { Controller } from "@hotwired/stimulus";
+
+interface DataEvent {
+  event: string;
+}
+
+declare global {
+  interface Window {
+    dataLayer?: DataEvent[];
+    gtag(...arg): void;
+  }
+}
+
+const dataLayer = (window.dataLayer = window.dataLayer ?? []);
+function gtag(): void {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  // eslint-disable-next-line prefer-rest-params
+  dataLayer.push(arguments);
+}
+window.gtag = gtag;
+
+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

@@ -1,4 +1,5 @@
 import { Controller } from "@hotwired/stimulus";
+import { ConsentCategory } from "../consent";
 
 export default class extends Controller {
   static targets = ["check"];
@@ -7,7 +8,7 @@ export default class extends Controller {
   connect(): void {
     this.checkTargets.forEach((input) => {
       input.checked =
-        window.ui?.consent.permitted.includes(input.name) ||
+        window.ui?.consent.permitted.includes(input.name as ConsentCategory) ||
         input.name === "essential";
     });
   }
@@ -29,7 +30,7 @@ export default class extends Controller {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     window.ui!.consent.permitted = this.checkTargets
       .filter((e) => e.checked)
-      .map((e) => e.name);
+      .map((e) => e.name) as ConsentCategory[];
     this.closeAll();
   }
 

data/src/index.ts

@@ -4,6 +4,7 @@ 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";
@@ -19,6 +20,12 @@ declare global {
   }
 }
 
+window.ui = {
+  modal: new ModalPresenter(),
+  popover: new PopoverPresenter(),
+  consent: new Consent(),
+};
+
 function createRemoteDestination(): void {
   if (document.getElementById("shimmer")) {
     return;
@@ -37,9 +44,7 @@ export async function start({
   createRemoteDestination();
   application.register("remote-navigation", RemoteNavigationController);
   application.register("consent", ConsentController);
-  window.ui = {
-    modal: new ModalPresenter(),
-    popover: new PopoverPresenter(),
-    consent: new Consent(),
-  };
+  application.register("analytics", AnalyticsController);
 }
+
+export const ui = window.ui;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shimmer
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.22
 platform: ruby
 authors:
 - Jens Ravens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-08-11 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
@@ -165,6 +179,7 @@ files:
 - package.json
 - rollup.config.js
 - src/consent.ts
+- src/controllers/analytics.ts
 - src/controllers/consent.ts
 - src/controllers/remote-navigation.ts
 - src/index.ts