b4um_generators 0.2.11 → 0.2.16

data/lib/generators/b4um/table/table_generator.rb

@@ -14,6 +14,14 @@ module B4um
                default: [],
                banner: "field:type field:type"
 
+      class_option :select,
+                   type: :string,
+                   desc: "Renders a field as a select value. Example: status:Active=Aktiv,Inactive=Inaktiv"
+
+      class_option :radio,
+                   type: :string,
+                   desc: "Renders a field as a radio value. Example: condition:new=Neu,used=Gebraucht"
+
       class << self
         def desc(_description = nil)
           "Generates a B4UM table partial for an existing model."
@@ -27,6 +35,22 @@ module B4um
               "Model not found: app/models/#{file_name}.rb"
       end
 
+      def validate_editor_configurations
+        configurations = {
+          select: select_configuration,
+          radio: radio_configuration
+        }
+
+        configurations.each do |option_name, configuration|
+          validate_editor_configuration(
+            option_name,
+            configuration
+          )
+        end
+
+        validate_editor_configuration_conflict(configurations)
+      end
+
       def create_table_partial
         template(
           "_table.html.erb.tt",
@@ -38,19 +62,177 @@ module B4um
         )
       end
 
+      def update_index_layout
+        return unless File.exist?(index_path)
+
+        index = File.read(index_path)
+
+        updated_index = index.sub(
+          /render\s+["'](?:bento|table|list|alternating)["']/,
+          'render "table"'
+        )
+
+        return if updated_index == index
+
+        File.write(index_path, updated_index)
+      end
+
       private
 
-      def table_attributes
-        fields.map do |field|
-          name, type = field.split(":", 2)
+      def model_class
+        class_name.constantize
+      end
+
+      def database_columns
+        model_class.columns.index_by(&:name)
+      end
+
+      def rich_text_fields
+        model_class.reflect_on_all_associations(:has_one)
+                   .filter_map do |association|
+                     association.name.to_s.delete_prefix("rich_text_") if
+                       association.name.to_s.start_with?("rich_text_")
+                   end
+      end
+
+      def single_attachment_fields
+        model_class.reflect_on_all_attachments
+                   .select { |reflection| reflection.macro == :has_one_attached }
+                   .map { |reflection| reflection.name.to_s }
+      end
+
+      def multiple_attachment_fields
+        model_class.reflect_on_all_attachments
+                   .select { |reflection| reflection.macro == :has_many_attached }
+                   .map { |reflection| reflection.name.to_s }
+      end
+
+      def available_field_names
+        (
+          database_field_names +
+          rich_text_fields +
+          single_attachment_fields +
+          multiple_attachment_fields
+        ).uniq
+      end
+
+      def database_field_names
+        database_columns.keys - %w[id created_at updated_at]
+      end
+
+      def field_type(field)
+        return :rich_text if rich_text_fields.include?(field)
+        return :attachment if single_attachment_fields.include?(field)
+        return :attachments if multiple_attachment_fields.include?(field)
+
+        database_columns.fetch(field).type
+      end
+
+      def table_field_names
+        return available_field_names if fields.empty?
+
+        fields.map { |field| field.split(":", 2).first }
+      end
+
+      def validate_editor_configuration(option_name, configuration)
+        return unless options[option_name].present?
+
+        unless configuration
+          raise Thor::Error,
+                "Invalid --#{option_name} configuration. " \
+                "Expected FIELD:VALUE[,VALUE...]"
+        end
+
+        return if table_field_names.include?(configuration[:field])
+
+        raise Thor::Error,
+              "--#{option_name} field #{configuration[:field]} " \
+              "must be one of the generated fields: #{fields.join(", ")}"
+      end
+
+      def validate_editor_configuration_conflict(configurations)
+        select = configurations[:select]
+        radio = configurations[:radio]
+
+        return unless select && radio
+        return unless select[:field] == radio[:field]
+
+        raise Thor::Error,
+              "Field #{select[:field]} cannot use both --select and --radio"
+      end
 
+      def select_configuration
+        field_configuration(:select)
+      end
+
+      def radio_configuration
+        field_configuration(:radio)
+      end
+
+      def field_configuration(option_name)
+        value = options[option_name]
+        return unless value.present?
+
+        field, values = value.split(":", 2)
+
+        return unless field.present? && values.present?
+
+        choices = field_choices(values)
+        return if choices.empty?
+
+        {
+          field: field,
+          values: choices
+        }
+      end
+
+      def field_choices(values)
+        values.split(",").filter_map do |choice|
+          value, label = choice.strip.split("=", 2)
+
+          next if value.blank?
+
+          {
+            value: value,
+            label: label.presence || value
+          }
+        end
+      end
+
+      def select_field?(field)
+        configuration = select_configuration
+
+        configuration &&
+          configuration[:field] == field &&
+          configuration[:values].any?
+      end
+
+      def radio_field?(field)
+        configuration = radio_configuration
+
+        configuration &&
+          configuration[:field] == field &&
+          configuration[:values].any?
+      end
+
+      def table_attributes
+        table_field_names.map do |field|
           TableAttribute.new(
-            name,
-            (type || "string").to_sym
+            field,
+            field_type(field)
           )
         end
       end
 
+      def index_path
+        File.join(
+          destination_root,
+          "app/views",
+          plural_table_name,
+          "index.html.erb"
+        )
+      end
+
       def model_path
         File.join(
           destination_root,

data/lib/generators/b4um/table/templates/_table.html.erb.tt

@@ -14,12 +14,298 @@
         <tr>
 <% table_attributes.each do |attribute| -%>
           <td>
+<% if select_field?(attribute.name) -%>
 <% if attribute.name == "status" -%>
+            <span class="b4um-badge">
+              <%%=
+                <%= select_configuration[:values].inspect %>.to_h {
+                  |choice| [choice[:value], choice[:label]]
+                }.fetch(
+                  <%= file_name %>.<%= attribute.name %>,
+                  <%= file_name %>.<%= attribute.name %>
+                )
+              %>
+            </span>
+<% else -%>
+            <%%=
+              <%= select_configuration[:values].inspect %>.to_h {
+                |choice| [choice[:value], choice[:label]]
+              }.fetch(
+                <%= file_name %>.<%= attribute.name %>,
+                <%= file_name %>.<%= attribute.name %>
+              )
+            %>
+<% end -%>
+<% elsif radio_field?(attribute.name) -%>
+            <%%=
+              <%= radio_configuration[:values].inspect %>.to_h {
+                |choice| [choice[:value], choice[:label]]
+              }.fetch(
+                <%= file_name %>.<%= attribute.name %>,
+                <%= file_name %>.<%= attribute.name %>
+              )
+            %>
+<% elsif attribute.type == :rich_text -%>
+            <div
+              class="b4um-table__rich-text trix-content"
+              data-controller="image-lightbox rich-text"
+              data-action="keydown->image-lightbox#keydown"
+            >
+              <%%= <%= file_name %>.<%= attribute.name %> %>
+
+              <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 preview"
+                hidden
+              >
+                <div
+                  class="image-lightbox__counter"
+                  data-image-lightbox-target="counter"
+                ></div>
+
+                <button
+                  type="button"
+                  class="image-lightbox__close"
+                  aria-label="Close image"
+                  data-action="click->image-lightbox#close"
+                >
+                  &times;
+                </button>
+
+                <button
+                  type="button"
+                  class="image-lightbox__navigation image-lightbox__navigation--previous"
+                  aria-label="Previous image"
+                  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-action="click->image-lightbox#next"
+                >
+                  &#8250;
+                </button>
+
+                <div
+                  class="image-lightbox__thumbnails"
+                  data-image-lightbox-target="thumbnails"
+                ></div>
+
+                <div
+                  class="image-lightbox__caption"
+                  data-image-lightbox-target="caption"
+                ></div>
+              </div>
+            </div>
+<% elsif attribute.type == :attachment -%>
+            <%% if <%= file_name %>.<%= attribute.name %>.attached? %>
+              <div
+                class="b4um-table__media"
+                data-controller="image-lightbox"
+                data-action="keydown->image-lightbox#keydown"
+              >
+                <button
+                  type="button"
+                  class="b4um-table__image-button"
+                  data-image-lightbox-target="item"
+                  data-image-lightbox-url="<%%= url_for(<%= file_name %>.<%= attribute.name %>) %>"
+                  data-image-lightbox-alt="<%%= <%= file_name %>.<%= attribute.name %>.filename.to_s %>"
+                  data-action="click->image-lightbox#open"
+                >
+                  <%%= image_tag <%= file_name %>.<%= attribute.name %>,
+                        class: "b4um-table__image",
+                        alt: <%= file_name %>.<%= attribute.name %>.filename.to_s %>
+                </button>
+
+                <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 preview"
+                  hidden
+                >
+                  <div
+                    class="image-lightbox__counter"
+                    data-image-lightbox-target="counter"
+                  ></div>
+
+                  <button
+                    type="button"
+                    class="image-lightbox__close"
+                    aria-label="Close image"
+                    data-action="click->image-lightbox#close"
+                  >
+                    &times;
+                  </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>
+
+                  <div
+                    class="image-lightbox__thumbnails"
+                    data-image-lightbox-target="thumbnails"
+                  ></div>
+
+                  <div
+                    class="image-lightbox__caption"
+                    data-image-lightbox-target="caption"
+                  ></div>
+                </div>
+              </div>
+            <%% else %>
+              <span class="b4um-table__media-empty">No image</span>
+            <%% end %>
+<% elsif attribute.type == :attachments -%>
+            <%% if <%= file_name %>.<%= attribute.name %>.attached? %>
+              <div
+                class="b4um-table__media"
+                data-controller="image-lightbox"
+                data-action="keydown->image-lightbox#keydown"
+              >
+                <%% <%= file_name %>.<%= attribute.name %>.each do |image| %>
+                  <button
+                    type="button"
+                    class="b4um-table__image-button"
+                    data-image-lightbox-target="item"
+                    data-image-lightbox-url="<%%= url_for(image) %>"
+                    data-image-lightbox-alt="<%%= image.filename.to_s %>"
+                    data-action="click->image-lightbox#open"
+                  >
+                    <%%= image_tag image,
+                          class: "b4um-table__image",
+                          alt: image.filename.to_s %>
+                  </button>
+                <%% end %>
+
+                <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 image"
+                    data-action="click->image-lightbox#close"
+                  >
+                    &times;
+                  </button>
+
+                  <button
+                    type="button"
+                    class="image-lightbox__navigation image-lightbox__navigation--previous"
+                    aria-label="Previous image"
+                    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-action="click->image-lightbox#next"
+                  >
+                    &#8250;
+                  </button>
+
+                  <div
+                    class="image-lightbox__thumbnails"
+                    data-image-lightbox-target="thumbnails"
+                  ></div>
+
+                  <div
+                    class="image-lightbox__caption"
+                    data-image-lightbox-target="caption"
+                  ></div>
+                </div>
+              </div>
+            <%% else %>
+              <span class="b4um-table__media-empty">No images</span>
+            <%% end %>
+<% elsif attribute.name == "status" -%>
             <span class="b4um-badge">
               <%%= <%= file_name %>.<%= attribute.name %> %>
             </span>
 <% elsif attribute.type == :text -%>
             <%%= truncate(<%= file_name %>.<%= attribute.name %>, length: 100) %>
+<% elsif attribute.type == :decimal -%>
+            <%%= number_with_precision(
+                  <%= file_name %>.<%= attribute.name %>,
+                  precision: 2,
+                  delimiter: ".",
+                  separator: ","
+                ) %>
 <% else -%>
             <%%= <%= file_name %>.<%= attribute.name %> %>
 <% end -%>

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

@@ -133,16 +133,75 @@ module B4um
       end
 
       def update_form
-        gsub_file(
+        form = File.read(form_path)
+
+        return if form.include?("form.rich_text_area :#{attribute}")
+
+        if form.include?("form.text_area :#{attribute}")
+          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">'
+          )
+
+          return
+        end
+
+        insert_into_file(
           form_path,
-          "form.text_area :#{attribute}",
-          "form.rich_text_area :#{attribute}"
+          <<~ERB,
+            <div class="form-field form-field--rich-text">
+              <%= form.rich_text_area :#{attribute} %>
+              <%= form.label :#{attribute}, class: "form-label" %>
+            </div>
+
+          ERB
+          before: '  <div class="form-actions">'
         )
+      end
+
+      def update_controller_params
+        return unless File.exist?(controller_path)
+
+        controller = File.read(controller_path)
+
+        params_method = controller[
+          /def #{Regexp.escape(name.underscore)}_params.*?^\s*end/m,
+          0
+        ]
+
+        unless params_method
+          raise Thor::Error,
+                "Could not find #{name.underscore}_params in #{controller_path}"
+        end
+
+        parameter = ":#{attribute}"
+
+        return if params_method.include?(parameter)
+
+        updated_method =
+          if params_method.match?(/\w+:\s*\[\]/)
+            params_method.sub(
+              /(?=\w+:\s*\[\])/,
+              "#{parameter}, "
+            )
+          else
+            params_method.sub(
+              /\s*\]\s*\)\s*$/,
+              ", #{parameter} ])"
+            )
+          end
 
         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">'
+          controller_path,
+          params_method,
+          updated_method
         )
       end
 
@@ -151,6 +210,8 @@ module B4um
 
         resource_name = name.underscore
 
+        add_rich_text_resource_field(resource_name)
+
         preview_length =
           'local_assigns\.fetch\(:preview_length,\s*160\)'
 
@@ -374,6 +435,36 @@ module B4um
 
       private
 
+      def add_rich_text_resource_field(resource_name)
+        partial = File.read(resource_partial_path)
+
+        return if partial.include?("#{resource_name}.#{attribute}")
+
+        field = <<~ERB
+          <div class="resource-field">
+            <strong class="resource-label">#{attribute.humanize}:</strong>
+            <span class="resource-value">
+              <% if local_assigns[:compact] %>
+                <%= b4um_rich_text_preview(
+                      #{resource_name}.#{attribute},
+                      length: local_assigns.fetch(:preview_length, 160)
+                    ) %>
+              <% else %>
+                <%= #{resource_name}.#{attribute} %>
+              <% end %>
+            </span>
+          </div>
+        ERB
+
+        closing_div = partial.rindex("</div>")
+
+        return unless closing_div
+
+        partial.insert(closing_div, field)
+
+        File.write(resource_partial_path, partial)
+      end
+
       def action_text_installed?
         Dir.glob(
           File.join(
@@ -401,6 +492,13 @@ module B4um
         )
       end
 
+      def controller_path
+        File.join(
+          destination_root,
+          "app/controllers/#{name.underscore.pluralize}_controller.rb"
+        )
+      end
+
       def resource_partial_path
         File.join(
           destination_root,