b4um_generators 0.1.0

data/lib/generators/b4um/trix/trix_generator.rb

@@ -0,0 +1,383 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module B4um
+  module Generators
+    class TrixGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      argument :name,
+               type: :string,
+               required: true,
+               banner: "MODEL"
+
+      argument :attribute,
+               type: :string,
+               required: true,
+               banner: "ATTRIBUTE"
+
+      desc "Adds Action Text with Trix to an existing B4UM resource."
+
+      def validate_model
+        return if File.exist?(model_path)
+
+        raise Thor::Error, "Model #{class_name} does not exist."
+      end
+
+      def validate_form
+        return if File.exist?(form_path)
+
+        raise Thor::Error, "Form for #{class_name} does not exist."
+      end
+
+      def install_action_text
+        return if action_text_installed?
+
+        rails_command "action_text:install"
+      end
+
+      def install_b4um_trix_javascript
+        copy_file(
+          "b4um_trix.js",
+          "app/javascript/b4um/trix.js"
+        )
+      end
+
+      def install_b4um_rich_text_helper
+        copy_file(
+          "b4um_rich_text_helper.rb",
+          "app/helpers/b4um_rich_text_helper.rb"
+        )
+      end
+
+      def install_b4um_rich_text_preview_styles
+        resources_stylesheet_path = File.join(
+          destination_root,
+          "app/assets/stylesheets/b4um/resources.css"
+        )
+
+        return unless File.exist?(resources_stylesheet_path)
+
+        stylesheet = File.read(resources_stylesheet_path)
+
+        return if stylesheet.include?(".b4um-rich-text-preview__heading")
+
+        styles = <<~CSS
+
+          .b4um-rich-text-preview {
+            display: block;
+          }
+
+          .b4um-rich-text-preview__heading {
+            display: block;
+            margin-bottom: 0.25rem;
+
+            font-weight: 700;
+            line-height: 1.25;
+          }
+
+          .b4um-rich-text-preview__text {
+            display: block;
+          }
+        CSS
+
+        append_to_file(
+          "app/assets/stylesheets/b4um/resources.css",
+          styles
+        )
+      end
+
+      def import_b4um_trix_javascript
+        application_javascript_path = File.join(
+          destination_root,
+          "app/javascript/application.js"
+        )
+
+        return unless File.exist?(application_javascript_path)
+
+        application_javascript = File.read(application_javascript_path)
+
+        return if application_javascript.include?("import 'b4um/trix'")
+
+        append_to_file(
+          "app/javascript/application.js",
+          "\nimport 'b4um/trix'\n"
+        )
+      end
+
+      def pin_b4um_trix_javascript
+        importmap_path = File.join(
+          destination_root,
+          "config/importmap.rb"
+        )
+
+        return unless File.exist?(importmap_path)
+
+        importmap = File.read(importmap_path)
+
+        return if importmap.include?('pin "b4um/trix"')
+
+        append_to_file(
+          "config/importmap.rb",
+          "\npin \"b4um/trix\", to: \"b4um/trix.js\"\n"
+        )
+      end
+
+      def add_rich_text_association
+        inject_into_class(
+          model_path,
+          class_name,
+          "  has_rich_text :#{attribute}\n"
+        )
+      end
+
+      def update_form
+        gsub_file(
+          form_path,
+          "form.text_area :#{attribute}",
+          "form.rich_text_area :#{attribute}"
+        )
+
+        gsub_file(
+          form_path,
+          /<div class="form-field form-field--textarea">(?=\s*<%= form\.rich_text_area :#{Regexp.escape(attribute)})/,
+          '<div class="form-field form-field--rich-text">'
+        )
+      end
+
+      def update_resource_partial
+        return unless File.exist?(resource_partial_path)
+
+        resource_name = name.underscore
+
+        gsub_file(
+          resource_partial_path,
+          "truncate(#{resource_name}.#{attribute}, length: 160)",
+          "b4um_rich_text_preview(#{resource_name}.#{attribute}, length: 160)"
+        )
+
+        gsub_file(
+          resource_partial_path,
+          "truncate(#{resource_name}.#{attribute}.to_plain_text, length: 160)",
+          "b4um_rich_text_preview(#{resource_name}.#{attribute}, length: 160)"
+        )
+
+        partial = File.read(resource_partial_path)
+
+        rich_text_expression =
+          "<%= #{resource_name}.#{attribute} %>"
+
+        rich_text_already_wrapped =
+          partial.match?(
+            /<div class="rich-text-lightbox"[^>]*>\s*.*?#{Regexp.escape(rich_text_expression)}/m
+          )
+
+        return if rich_text_already_wrapped
+
+        gsub_file(
+          resource_partial_path,
+          rich_text_expression,
+          <<~ERB.chomp
+            <div class="rich-text-lightbox"
+                 data-controller="image-lightbox"
+                 data-action="keydown->image-lightbox#keydown">
+              <%= #{resource_name}.#{attribute} %>
+
+              <div class="image-lightbox"
+                   data-image-lightbox-target="overlay"
+                   data-action="click->image-lightbox#closeOnBackground"
+                   tabindex="-1"
+                   role="dialog"
+                   aria-modal="true"
+                   aria-label="Image gallery"
+                   hidden>
+
+                <div class="image-lightbox__counter"
+                     data-image-lightbox-target="counter"></div>
+
+                <button type="button"
+                        class="image-lightbox__close"
+                        aria-label="Close gallery"
+                        data-action="click->image-lightbox#close">
+                  &times;
+                </button>
+
+                <button type="button"
+                        class="image-lightbox__navigation image-lightbox__navigation--previous"
+                        aria-label="Previous image"
+                        data-image-lightbox-target="previousButton"
+                        data-action="click->image-lightbox#previous">
+                  &#8249;
+                </button>
+
+                <div class="image-lightbox__stage"
+                     data-image-lightbox-target="stage"
+                     data-action="pointerdown->image-lightbox#pointerDown pointermove->image-lightbox#pointerMove pointerup->image-lightbox#pointerUp pointercancel->image-lightbox#pointerCancel">
+                  <img class="image-lightbox__image"
+                       data-image-lightbox-target="image"
+                       alt="">
+                </div>
+
+                <button type="button"
+                        class="image-lightbox__navigation image-lightbox__navigation--next"
+                        aria-label="Next image"
+                        data-image-lightbox-target="nextButton"
+                        data-action="click->image-lightbox#next">
+                  &#8250;
+                </button>
+
+                <div class="image-lightbox__caption"
+                     data-image-lightbox-target="caption"></div>
+              </div>
+            </div>
+          ERB
+        )
+      end
+
+      def update_action_text_blob_partial
+        return unless File.exist?(action_text_blob_partial_path)
+
+        partial = File.read(action_text_blob_partial_path)
+
+        unless partial.include?("blob.video?")
+          gsub_file(
+            action_text_blob_partial_path,
+            /<% if blob\.representable\? %>\s*(<%= image_tag .+? %>)\s*<% end %>/m,
+            <<~ERB.chomp
+              <% if blob.video? %>
+                <%= video_tag rails_blob_path(blob, disposition: "inline"),
+                      controls: true,
+                      playsinline: true,
+                      preload: "metadata",
+                      class: "b4um-rich-text-video" %>
+              <% elsif blob.representable? %>
+                \\1
+              <% end %>
+            ERB
+          )
+        end
+
+        partial = File.read(action_text_blob_partial_path)
+
+        return if partial.include?('image_lightbox_target: "item"')
+
+        gsub_file(
+          action_text_blob_partial_path,
+          /<%= image_tag (.+?) %>/,
+          <<~ERB.chomp
+            <%= image_tag \\1,
+                  data: {
+                    image_lightbox_target: "item",
+                    image_lightbox_url: rails_blob_path(blob, only_path: true),
+                    image_lightbox_alt: blob.filename.to_s,
+                    action: "click->image-lightbox#open"
+                  } %>
+          ERB
+        )
+      end
+
+      def create_action_text_initializer
+        initializer_path = File.join(
+          destination_root,
+          "config/initializers/action_text.rb"
+        )
+
+        configuration = <<~RUBY
+          Rails.application.config.after_initialize do
+            ActionText::ContentHelper.allowed_tags =
+              ActionText::ContentHelper.sanitizer.class.allowed_tags +
+              [
+                ActionText::Attachment.tag_name,
+                "figure",
+                "figcaption"
+              ] +
+              %w[
+                align-left
+                align-center
+                align-right
+                section
+                article
+                video
+              ]
+
+            ActionText::ContentHelper.allowed_attributes =
+              ActionText::ContentHelper.sanitizer.class.allowed_attributes +
+              ActionText::Attachment::ATTRIBUTES +
+              %w[
+                style
+                id
+                src
+                controls
+                playsinline
+                preload
+                data-image-lightbox-target
+                data-image-lightbox-url
+                data-image-lightbox-alt
+                data-action
+              ]
+          end
+        RUBY
+
+        if File.exist?(initializer_path)
+          append_to_file(
+            initializer_path,
+            "\n#{configuration}"
+          )
+        else
+          create_file(
+            initializer_path,
+            <<~RUBY
+              # frozen_string_literal: true
+
+              #{configuration}
+            RUBY
+          )
+        end
+      end
+
+      private
+
+      def action_text_installed?
+        Dir.glob(
+          File.join(
+            destination_root,
+            "db/migrate/*_create_action_text_tables.action_text.rb"
+          )
+        ).any?
+      end
+
+      def class_name
+        name.camelize
+      end
+
+      def model_path
+        File.join(
+          destination_root,
+          "app/models/#{name.underscore}.rb"
+        )
+      end
+
+      def form_path
+        File.join(
+          destination_root,
+          "app/views/#{name.underscore.pluralize}/_form.html.erb"
+        )
+      end
+
+      def resource_partial_path
+        File.join(
+          destination_root,
+          "app/views/#{name.underscore.pluralize}/_#{name.underscore}.html.erb"
+        )
+      end
+
+      def action_text_blob_partial_path
+        File.join(
+          destination_root,
+          "app/views/active_storage/blobs/_blob.html.erb"
+        )
+      end
+    end
+  end
+end

data/sig/b4um_generators.rbs

@@ -0,0 +1,4 @@
+module B4umGenerators
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: b4um_generators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Baum
+bindir: exe
+cert_chain: []
+date: 2026-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Reusable Rails generators, templates and application defaults for b4um
+  projects.
+email:
+- info@b4um.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.de.md
+- README.md
+- Rakefile
+- b4um_generators.gemspec
+- bin/console
+- bin/setup
+- lib/b4um_generators.rb
+- lib/b4um_generators/version.rb
+- lib/generators/b4um/bento/bento_generator.rb
+- lib/generators/b4um/bento/templates/_alternating.html.erb.tt
+- lib/generators/b4um/bento/templates/_bento.html.erb.tt
+- lib/generators/b4um/bento/templates/_grid.html.erb.tt
+- lib/generators/b4um/bento/templates/_list.html.erb.tt
+- lib/generators/b4um/comments/comments_generator.rb
+- lib/generators/b4um/comments/templates/_comments.html.erb.tt
+- lib/generators/b4um/comments/templates/comment.rb.tt
+- lib/generators/b4um/comments/templates/comments_controller.rb.tt
+- lib/generators/b4um/comments/templates/create_comments.rb.tt
+- lib/generators/b4um/controller/controller_generator.rb
+- lib/generators/b4um/help/help_generator.rb
+- lib/generators/b4um/infinite_scroll/infinite_scroll_generator.rb
+- lib/generators/b4um/infinite_scroll/templates/infinite_scroll_controller.js
+- lib/generators/b4um/install/install_generator.rb
+- lib/generators/b4um/install/templates/_cookie_consent.html.erb
+- lib/generators/b4um/install/templates/_footer.html.erb
+- lib/generators/b4um/install/templates/_hero.html.erb
+- lib/generators/b4um/install/templates/_navigation.html.erb
+- lib/generators/b4um/install/templates/_sitemap.html.erb
+- lib/generators/b4um/install/templates/_theme_switcher.html.erb
+- lib/generators/b4um/install/templates/b4um.css
+- lib/generators/b4um/install/templates/b4um.yml
+- lib/generators/b4um/install/templates/b4um/badges.css
+- lib/generators/b4um/install/templates/b4um/base.css
+- lib/generators/b4um/install/templates/b4um/callouts.css
+- lib/generators/b4um/install/templates/b4um/cards.css
+- lib/generators/b4um/install/templates/b4um/comments.css
+- lib/generators/b4um/install/templates/b4um/cookie-consent.css
+- lib/generators/b4um/install/templates/b4um/empty-state.css
+- lib/generators/b4um/install/templates/b4um/flash.css
+- lib/generators/b4um/install/templates/b4um/footer.css
+- lib/generators/b4um/install/templates/b4um/forms.css
+- lib/generators/b4um/install/templates/b4um/hero.css
+- lib/generators/b4um/install/templates/b4um/layout.css
+- lib/generators/b4um/install/templates/b4um/lightbox.css
+- lib/generators/b4um/install/templates/b4um/navigation.css
+- lib/generators/b4um/install/templates/b4um/pagination.css
+- lib/generators/b4um/install/templates/b4um/resources.css
+- lib/generators/b4um/install/templates/b4um/search.css
+- lib/generators/b4um/install/templates/b4um/tables.css
+- lib/generators/b4um/install/templates/b4um/theme-switcher.css
+- lib/generators/b4um/install/templates/b4um/theme.css
+- lib/generators/b4um/install/templates/b4um_helper.rb
+- lib/generators/b4um/install/templates/cookie_consent_controller.js
+- lib/generators/b4um/install/templates/dismissible_controller.js
+- lib/generators/b4um/install/templates/image_lightbox_controller.js
+- lib/generators/b4um/install/templates/image_preview_controller.js
+- lib/generators/b4um/install/templates/navigation_controller.js
+- lib/generators/b4um/install/templates/navigation_helper.rb
+- lib/generators/b4um/install/templates/sitemap_controller.js
+- lib/generators/b4um/install/templates/theme_controller.js
+- lib/generators/b4um/pagination/pagination_generator.rb
+- lib/generators/b4um/pagination/templates/_pagination.html.erb.tt
+- lib/generators/b4um/pagination/templates/pagination.rb
+- lib/generators/b4um/scaffold/scaffold_generator.rb
+- lib/generators/b4um/scaffold/templates/_bento.html.erb.tt
+- lib/generators/b4um/scaffold/templates/_form.html.erb.tt
+- lib/generators/b4um/scaffold/templates/_resource.html.erb.tt
+- lib/generators/b4um/scaffold/templates/_table.html.erb.tt
+- lib/generators/b4um/scaffold/templates/edit.html.erb.tt
+- lib/generators/b4um/scaffold/templates/index.html.erb.tt
+- lib/generators/b4um/scaffold/templates/new.html.erb.tt
+- lib/generators/b4um/scaffold/templates/show.html.erb.tt
+- lib/generators/b4um/search/search_generator.rb
+- lib/generators/b4um/search/templates/search.rb
+- lib/generators/b4um/search/templates/search_form.html.erb.tt
+- lib/generators/b4um/table/table_generator.rb
+- lib/generators/b4um/table/templates/_table.html.erb.tt
+- lib/generators/b4um/trix/templates/b4um_rich_text_helper.rb
+- lib/generators/b4um/trix/templates/b4um_trix.js
+- lib/generators/b4um/trix/trix_generator.rb
+- sig/b4um_generators.rbs
+homepage: https://www.b4um.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.b4um.com
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Rails generators for b4um applications
+test_files: []