b4um_generators 0.1.0

data/lib/generators/b4um/install/install_generator.rb

@@ -0,0 +1,492 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "yaml"
+
+module B4um
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Installs the B4UM base setup."
+
+      def install_bcrypt
+        unless yes?("Install bcrypt for password support? (y/n)")
+          say "  bcrypt skipped."
+          return
+        end
+
+        gemfile_path = File.join(destination_root, "Gemfile")
+        gemfile = File.read(gemfile_path)
+
+        if gemfile.match?(/^\s*gem ["']bcrypt["']/)
+          say "  bcrypt is already present in the Gemfile."
+          return
+        end
+
+        if gemfile.match?(/^\s*#\s*gem ["']bcrypt["']/)
+          gsub_file(
+            "Gemfile",
+            /^(\s*)#\s*(gem ["']bcrypt["'].*)$/,
+            '\1\2'
+          )
+
+          @gems_added = true
+
+          say "  bcrypt activated in the Gemfile."
+          return
+        end
+
+        gem "bcrypt"
+        @gems_added = true
+
+        say "  bcrypt added to the Gemfile."
+      end
+
+      def install_active_storage
+        unless yes?("Install Active Storage for image attachments? (y/n)")
+          say "  Active Storage skipped."
+          return
+        end
+
+        migration_files = Dir.glob(
+          File.join(
+            destination_root,
+            "db/migrate/*_create_active_storage_tables.active_storage.rb"
+          )
+        )
+
+        if migration_files.any?
+          say "  Active Storage is already installed."
+          return
+        end
+
+        rails_command "active_storage:install"
+
+        say "  Active Storage installed."
+        say "  Running database migrations..."
+
+        rails_command "db:migrate"
+
+        say "  Active Storage database tables created."
+      end
+
+      def create_stylesheet
+        copy_file "b4um.css", "app/assets/stylesheets/b4um.css"
+
+        directory(
+          "b4um",
+          "app/assets/stylesheets/b4um"
+        )
+      end
+
+      def install_hero
+        unless yes?("Add a hero section? (y/n)")
+          say "  Hero section skipped."
+          return
+        end
+
+        copy_file(
+          "_hero.html.erb",
+          "app/views/shared/_hero.html.erb"
+        )
+
+        @hero_installed = true
+
+        say "  Hero section installed."
+      end
+
+      def install_footer
+        unless yes?("Add a footer? (y/n)")
+          @footer_installed = false
+
+          say "  Footer skipped."
+          return
+        end
+
+        footer_path = "app/views/shared/_footer.html.erb"
+        full_footer_path = File.join(destination_root, footer_path)
+
+        if File.exist?(full_footer_path)
+          @footer_installed = true
+
+          say "  Footer already exists; keeping existing footer."
+          return
+        end
+
+        copy_file(
+          "_footer.html.erb",
+          footer_path
+        )
+
+        @footer_installed = true
+
+        say "  Footer installed."
+      end
+
+      def install_sitemap
+        unless @footer_installed
+          say "  Sitemap skipped because footer is not installed."
+          return
+        end
+
+        unless yes?("Add a sitemap to the footer? (y/n)")
+          say "  Sitemap skipped."
+          return
+        end
+
+        @sitemap_column_count = ask_sitemap_column_count
+
+        default_titles = %w[
+          Kontakt
+          Inhalte
+          Service
+          Mehr
+          Weitere
+        ]
+
+        @sitemap_titles = Array.new(@sitemap_column_count) do |index|
+          default_title = default_titles[index]
+
+          ask(
+            "Sitemap column #{index + 1} title [#{default_title}]:"
+          ).presence || default_title
+        end
+
+        copy_file(
+          "_sitemap.html.erb",
+          "app/views/shared/_sitemap.html.erb"
+        )
+
+        copy_file(
+          "sitemap_controller.js",
+          "app/javascript/controllers/sitemap_controller.js"
+        )
+
+        @sitemap_installed = true
+
+        say "  Sitemap installed."
+      end
+
+      def install_cookie_consent
+        unless yes?("Add cookie consent? (y/n)")
+          say "  Cookie consent skipped."
+          return
+        end
+
+        copy_file(
+          "_cookie_consent.html.erb",
+          "app/views/shared/_cookie_consent.html.erb"
+        )
+
+        copy_file(
+          "cookie_consent_controller.js",
+          "app/javascript/controllers/cookie_consent_controller.js"
+        )
+
+        @cookie_consent_installed = true
+
+        say "  Cookie consent installed."
+      end
+
+      def copy_navigation
+        copy_file "_navigation.html.erb",
+                  "app/views/shared/_navigation.html.erb"
+      end
+
+      def copy_navigation_controller
+        copy_file "navigation_controller.js",
+                  "app/javascript/controllers/navigation_controller.js"
+      end
+
+      def copy_theme_controller
+        copy_file "theme_controller.js",
+                  "app/javascript/controllers/theme_controller.js"
+      end
+
+      def copy_theme_switcher
+        copy_file(
+          "_theme_switcher.html.erb",
+          "app/views/shared/_theme_switcher.html.erb"
+        )
+      end
+
+      def copy_b4um_config
+        copy_file "b4um.yml",
+                  "config/b4um.yml"
+
+        return unless @sitemap_installed
+        return unless @sitemap_titles
+
+        config_path = "config/b4um.yml"
+        full_config_path = File.join(destination_root, config_path)
+
+        config = YAML.safe_load_file(full_config_path) || {}
+
+        config["sitemap"] = @sitemap_titles.each_with_index.map do |title, index|
+          {
+            "key" => "column_#{index + 1}",
+            "title" => title
+          }
+        end
+
+        File.write(
+          full_config_path,
+          config.to_yaml
+        )
+      end
+
+      def copy_image_preview_controller
+        copy_file "image_preview_controller.js",
+                  "app/javascript/controllers/image_preview_controller.js"
+      end
+
+      def copy_image_lightbox_controller
+        copy_file "image_lightbox_controller.js",
+                  "app/javascript/controllers/image_lightbox_controller.js"
+      end
+
+      def copy_dismissible_controller
+        copy_file "dismissible_controller.js",
+                  "app/javascript/controllers/dismissible_controller.js"
+      end
+
+      def copy_navigation_helper
+        copy_file "navigation_helper.rb",
+                  "app/helpers/navigation_helper.rb"
+      end
+
+      def copy_b4um_helper
+        copy_file "b4um_helper.rb",
+                  "app/helpers/b4um_helper.rb"
+      end
+
+      def update_application_layout
+        layout_path = "app/views/layouts/application.html.erb"
+        full_layout_path = File.join(destination_root, layout_path)
+
+        ensure_page_top_anchor(layout_path, full_layout_path)
+        ensure_navigation(layout_path, full_layout_path)
+        ensure_main_container(layout_path, full_layout_path)
+        ensure_hero(layout_path, full_layout_path)
+        ensure_theme_switcher(layout_path, full_layout_path)
+        ensure_footer(layout_path, full_layout_path)
+        ensure_sitemap_footer_render
+        ensure_cookie_consent(layout_path, full_layout_path)
+        ensure_cookie_consent_footer_link
+      end
+
+      def install_selected_gems
+        return unless @gems_added
+
+        say "Installing selected gems..."
+
+        run "bundle install"
+
+        say "Selected gems installed."
+      end
+
+      private
+
+      def ask_sitemap_column_count
+        loop do
+          answer = ask(
+            "Number of sitemap columns [4]:"
+          ).to_s.strip
+
+          return 4 if answer.empty?
+
+          column_count = Integer(answer, exception: false)
+
+          return column_count if column_count&.between?(2, 5)
+
+          say "  Please choose between 2 and 5 sitemap columns."
+        end
+      end
+
+      def ensure_navigation(layout_path, full_layout_path)
+        layout = File.read(full_layout_path)
+
+        return if layout.include?('render "shared/navigation"')
+
+        gsub_file(
+          layout_path,
+          '<div id="b4um-page-top"></div>',
+          <<~ERB.chomp
+            <div id="b4um-page-top"></div>
+            <%= render "shared/navigation" %>
+          ERB
+        )
+      end
+
+      def ensure_main_container(layout_path, full_layout_path)
+        layout = File.read(full_layout_path)
+
+        return if layout.include?('class="container"')
+
+        gsub_file(
+          layout_path,
+          '<%= render "shared/navigation" %>',
+          <<~ERB.chomp
+            <%= render "shared/navigation" %>
+
+            <main class="container">
+              <% flash.each do |type, message| %>
+                <div class="flash <%= "flash--" + type.to_s %>"
+                    data-controller="dismissible">
+                  <%= message %>
+
+                  <button type="button"
+                          class="flash__close"
+                          data-action="dismissible#dismiss"
+                          aria-label="Close">
+                    &times;
+                  </button>
+                </div>
+              <% end %>
+          ERB
+        )
+
+        gsub_file(
+          layout_path,
+          "</body>",
+          "  </main>\n</body>"
+        )
+      end
+
+      def ensure_hero(layout_path, full_layout_path)
+        return unless @hero_installed
+
+        layout = File.read(full_layout_path)
+
+        return if layout.include?('render "shared/hero"')
+
+        gsub_file(
+          layout_path,
+          '<main class="container">',
+          <<~ERB.chomp
+            <main class="container">
+                  <%= render "shared/hero" if request.path == root_path %>
+          ERB
+        )
+      end
+
+      def ensure_theme_switcher(layout_path, full_layout_path)
+        layout = File.read(full_layout_path)
+
+        return if layout.include?('render "shared/theme_switcher"')
+
+        gsub_file(
+          layout_path,
+          "</body>",
+          <<~ERB.chomp
+            <%= render "shared/theme_switcher" %>
+            </body>
+          ERB
+        )
+      end
+
+      def ensure_footer(layout_path, full_layout_path)
+        return unless @footer_installed
+
+        layout = File.read(full_layout_path)
+
+        return if layout.include?('render "shared/footer"')
+
+        gsub_file(
+          layout_path,
+          "</body>",
+          <<~ERB.chomp
+            <%= render "shared/footer" %>
+            </body>
+          ERB
+        )
+      end
+
+      def ensure_cookie_consent(layout_path, full_layout_path)
+        return unless @cookie_consent_installed
+
+        layout = File.read(full_layout_path)
+
+        return if layout.include?('render "shared/cookie_consent"')
+
+        gsub_file(
+          layout_path,
+          "</body>",
+          <<~ERB.chomp
+            <%= render "shared/cookie_consent" %>
+            </body>
+          ERB
+        )
+      end
+
+      def ensure_sitemap_footer_render
+        return unless @sitemap_installed
+
+        footer_path = "app/views/shared/_footer.html.erb"
+        full_footer_path = File.join(destination_root, footer_path)
+
+        return unless File.exist?(full_footer_path)
+
+        footer = File.read(full_footer_path)
+
+        return if footer.include?('render "shared/sitemap"')
+
+        gsub_file(
+          footer_path,
+          '<div class="b4um-footer__inner">',
+          <<~ERB.chomp
+            <%= render "shared/sitemap" %>
+
+            <div class="b4um-footer__inner">
+          ERB
+        )
+      end
+
+      def ensure_cookie_consent_footer_link
+        return unless @cookie_consent_installed
+
+        footer_path = "app/views/shared/_footer.html.erb"
+        full_footer_path = File.join(destination_root, footer_path)
+
+        return unless File.exist?(full_footer_path)
+
+        footer = File.read(full_footer_path)
+
+        return if footer.include?("data-b4um-cookie-consent-open")
+        return unless footer.include?("<%# B4UM_FOOTER_LINKS %>")
+
+        gsub_file(
+          footer_path,
+          "<%# B4UM_FOOTER_LINKS %>",
+          <<~ERB.chomp
+            <button
+              type="button"
+              class="b4um-footer__link b4um-footer__link--button"
+              data-b4um-cookie-consent-open
+            >
+              Cookie-Einstellungen
+            </button>
+
+            <%# B4UM_FOOTER_LINKS %>
+          ERB
+        )
+      end
+
+      def ensure_page_top_anchor(layout_path, full_layout_path)
+        layout = File.read(full_layout_path)
+
+        return if layout.include?('id="b4um-page-top"')
+
+        gsub_file(
+          layout_path,
+          "<body>",
+          <<~ERB.chomp
+            <body>
+              <div id="b4um-page-top"></div>
+          ERB
+        )
+      end
+    end
+  end
+end

data/lib/generators/b4um/install/templates/_cookie_consent.html.erb

@@ -0,0 +1,27 @@
+<div
+  class="b4um-cookie-consent"
+  data-controller="cookie-consent"
+  data-cookie-consent-target="banner"
+  hidden
+>
+  <div class="b4um-cookie-consent__content">
+    <p class="b4um-cookie-consent__text">
+      Diese Website verwendet optionale Cookies. Du kannst selbst entscheiden,
+      ob du diese zulassen möchtest.
+    </p>
+
+    <div class="b4um-cookie-consent__actions">
+      <button
+        type="button"
+        class="button button--secondary"
+        data-action="cookie-consent#reject"
+      >
+        Ablehnen
+      </button>
+
+      <button type="button" class="button" data-action="cookie-consent#accept">
+        Akzeptieren
+      </button>
+    </div>
+  </div>
+</div>

data/lib/generators/b4um/install/templates/_footer.html.erb

@@ -0,0 +1,17 @@
+<footer class="b4um-footer">
+  <a class="b4um-footer__back-to-top" href="#b4um-page-top">
+    Zurück zum Seitenanfang
+  </a>
+
+  <div class="b4um-footer__inner">
+    <p class="b4um-footer__copyright">
+      &copy;
+      <%= Time.current.year %>
+      Deine Anwendung
+    </p>
+
+    <nav class="b4um-footer__links" aria-label="Rechtliche Hinweise">
+      <%# B4UM_FOOTER_LINKS %>
+    </nav>
+  </div>
+</footer>

data/lib/generators/b4um/install/templates/_hero.html.erb

@@ -0,0 +1,33 @@
+<section class="b4um-hero b4um-hero--text-only">
+  <div class="b4um-hero__content">
+    <p class="b4um-hero__eyebrow">
+      Willkommen
+    </p>
+
+    <h1 class="b4um-hero__title">
+      Deine Anwendung
+    </h1>
+
+    <p class="b4um-hero__text">
+      Hier kannst du deine Anwendung mit einer kurzen Beschreibung vorstellen.
+    </p>
+
+    <%# Optionaler Hero-Link:
+        Füge hier einen Link mit der Klasse "button button--primary" ein.
+        Beispiel:
+        link_to "Mehr erfahren", about_path, class: "button button--primary"
+    %>
+  </div>
+
+  <%# Optionales Hero-Bild:
+      Entferne "b4um-hero--text-only" oben und aktiviere den Bereich unten.
+  %>
+
+  <!--
+  <div class="b4um-hero__media">
+    Hero-Bild hier einfügen.
+    Beispiel:
+    image_tag "hero.jpg", class: "b4um-hero__image", alt: ""
+  </div>
+  -->
+</section>

data/lib/generators/b4um/install/templates/_navigation.html.erb

@@ -0,0 +1,31 @@
+<nav
+  class="navigation"
+  aria-label="Main navigation"
+  data-controller="navigation"
+>
+  <div class="navigation__inner">
+    <%= link_to "b4um", "/", class: "navigation__brand" %>
+
+    <button
+      class="navigation__toggle"
+      type="button"
+      aria-label="Open navigation"
+      aria-expanded="false"
+      aria-controls="navigation-menu"
+      data-navigation-target="toggle"
+      data-action="click->navigation#toggle"
+    >
+      <span class="navigation__toggle-line"></span>
+      <span class="navigation__toggle-line"></span>
+      <span class="navigation__toggle-line"></span>
+    </button>
+
+    <div
+      class="navigation__menu"
+      id="navigation-menu"
+      data-navigation-target="menu"
+    >
+      <%# B4UM_NAVIGATION_LINKS %>
+    </div>
+  </div>
+</nav>

data/lib/generators/b4um/install/templates/_sitemap.html.erb

@@ -0,0 +1,48 @@
+<div
+  class="b4um-footer__sitemap"
+  data-controller="sitemap"
+  data-action="resize@window->sitemap#reset"
+>
+  <nav class="b4um-sitemap" aria-label="Sitemap">
+    <% b4um_sitemap_columns.each do |column| %>
+      <% column_key = column["key"].to_s %>
+
+      <div class="b4um-sitemap__item">
+        <button
+          type="button"
+          class="b4um-sitemap__title"
+          aria-expanded="false"
+          aria-controls="b4um-sitemap-<%= column_key.tr("_", "-") %>"
+          data-sitemap-target="title"
+          data-action="sitemap#toggle"
+        >
+          <%= column["title"] %>
+        </button>
+
+        <div class="b4um-sitemap__content">
+          <ul
+            id="b4um-sitemap-<%= column_key.tr("_", "-") %>"
+            class="b4um-sitemap__list"
+            data-sitemap-target="list"
+          >
+            <% Array(column["links"]).each do |link| %>
+              <% path = b4um_sitemap_path(link["route"]) %>
+
+              <% if path %>
+                <li>
+                  <%= link_to link["title"],
+                  path,
+                  class: [
+                    "b4um-sitemap__link",
+                    ("is-active" if current_page?(path)),
+                  ].compact.join(" "),
+                  aria: (current_page?(path) ? { current: "page" } : {}) %>
+                </li>
+              <% end %>
+            <% end %>
+          </ul>
+        </div>
+      </div>
+    <% end %>
+  </nav>
+</div>

data/lib/generators/b4um/install/templates/_theme_switcher.html.erb

@@ -0,0 +1,57 @@
+<div class="b4um-theme-switcher" data-controller="theme">
+  <div class="b4um-theme-switcher__menu" data-theme-target="menu" hidden>
+    <div class="b4um-theme-switcher__title">
+      Darstellung
+    </div>
+
+    <button
+      type="button"
+      class="b4um-theme-switcher__option"
+      data-theme-target="option"
+      data-theme-value="system"
+      data-action="theme#select"
+      role="menuitemradio"
+      aria-checked="false"
+    >
+      <span class="b4um-theme-switcher__indicator" aria-hidden="true"></span>
+      System
+    </button>
+
+    <button
+      type="button"
+      class="b4um-theme-switcher__option"
+      data-theme-target="option"
+      data-theme-value="light"
+      data-action="theme#select"
+      role="menuitemradio"
+      aria-checked="false"
+    >
+      <span class="b4um-theme-switcher__indicator" aria-hidden="true"></span>
+      Hell
+    </button>
+
+    <button
+      type="button"
+      class="b4um-theme-switcher__option"
+      data-theme-target="option"
+      data-theme-value="dark"
+      data-action="theme#select"
+      role="menuitemradio"
+      aria-checked="false"
+    >
+      <span class="b4um-theme-switcher__indicator" aria-hidden="true"></span>
+      Dunkel
+    </button>
+  </div>
+
+  <button
+    type="button"
+    class="b4um-theme-switcher__toggle"
+    data-theme-target="toggle"
+    data-action="theme#toggle"
+    aria-expanded="false"
+    aria-label="Darstellung ändern"
+  >
+    <span data-theme-target="icon" aria-hidden="true">◐</span>
+  </button>
+</div>