headmin 0.5.3 → 0.5.4

data/app/models/headmin/form/association_view.rb

@@ -0,0 +1,102 @@
+module Headmin
+  module Form
+    class AssociationView < ViewModel
+      include Headmin::Form::Hintable
+      include Headmin::Form::InputGroupable
+      include Headmin::Form::Labelable
+      include Headmin::Form::Listable
+      include Headmin::Form::Placeholderable
+      include Headmin::Form::Validatable
+      include Headmin::Form::Wrappable
+
+      def input_options
+        keys = attributes - %i[append attribute collection float form input_group include_blank label prepend validate selected tags wrapper]
+        options = to_h.slice(*keys)
+        def_input_options = default_input_options
+        def_input_options = def_input_options.deep_merge(options)
+        def_input_options = def_input_options.merge({multiple: true}) if collection?
+        def_input_options
+      end
+
+      def input_group_options
+        default_input_group_options
+          .deep_merge(label_input_group_options)
+          .deep_merge(@input_group || {})
+      end
+
+      def wrapper_options
+        default_wrapper_options.deep_merge({
+          class: ["mb-3", ("form-floating" if float)]
+        }).deep_merge(@wrapper || {})
+      end
+
+      def select_options
+        keys = %i[include_blank selected]
+        options = to_h.slice(*keys)
+        default_options.deep_merge(options)
+      end
+
+      def attribute_with_id
+        attribute_with_id = collection? ? "#{association_foreign_key}s" : foreign_key
+
+        if attribute_with_id.nil?
+          raise(AssociationDoesNotExistError, "Association attribute that was passed does not exist.")
+        else
+          attribute_with_id
+        end
+      end
+
+      def collection
+        association_class.all.map { |item| [item.to_s, item.id] }
+      end
+
+      private
+
+      def association_foreign_key
+        reflection.association_foreign_key
+      end
+
+      def foreign_key
+        reflection.foreign_key
+      end
+
+      def reflection
+        form.object.class.reflect_on_association(attribute)
+      end
+
+      def association_class
+        reflection.klass
+      end
+
+      def collection?
+        reflection.collection?
+      end
+
+      def default_options
+        {
+          selected: form.object&.send(attribute_with_id)
+        }
+      end
+
+      def default_input_options
+        {
+          aria: {describedby: validation_id},
+          class: [form_control_class, validation_class],
+          data: {
+            tags: tags,
+            controller: "select"
+          },
+          multiple: tags,
+          placeholder: placeholder
+        }
+      end
+
+      def form_control_class
+        plaintext ? "form-control-plaintext" : "form-select"
+      end
+
+      class AssociationDoesNotExistError < StandardError
+      end
+    end
+  end
+end

data/app/models/headmin/form/blocks_view.rb

@@ -21,7 +21,10 @@ module Headmin
         {
           attribute: "blocks",
           label: false,
-          templates: names
+          templates: names,
+          row: {
+            class: "repeater-row list-group-item pt-3"
+          }
         }
       end
     end

data/app/models/headmin/form/file_view.rb

@@ -55,14 +55,6 @@ module Headmin
         attached.is_a?(ActiveStorage::Attached::Many) ? :"#{attribute}_attachments" : :"#{attribute}_attachment"
       end
 
-      def thumbnail_width
-        100
-      end
-
-      def thumbnail_height
-        100
-      end
-
       def dropzone_options
         if dropzone
           {

data/app/models/headmin/form/flatpickr_view.rb

@@ -18,8 +18,9 @@ module Headmin
       def default_data
         {
           controller: "flatpickr",
+
           flatpickr: {
-            defaultDate: form.object&.send(attribute)&.strftime("%d/%m/%Y")
+            defaultDate: attribute.nil? ? Date.today : form.object&.send(attribute)&.strftime("%d/%m/%Y")
           }
         }
       end

data/app/models/headmin/form/media_item_view.rb

@@ -0,0 +1,39 @@
+module Headmin
+  module Form
+    class MediaItemView < ViewModel
+      include Rails.application.routes.url_helpers
+
+      def thumbnail_options
+        options = {
+          file: attachment
+        }
+
+        # Don't pass width or height if it was not defined
+        options = options.merge(width: width) if is_defined?(:width)
+        options = options.merge(height: height) if is_defined?(:height)
+
+        options
+      end
+
+      def attachment
+        form.object
+      end
+
+      def position_value
+        attachment.new_record? ? nil : attachment.position
+      end
+
+      def id
+        attachment.blob ? attachment.blob.id : "$1"
+      end
+
+      def filename
+        attachment.blob&.filename&.to_s
+      end
+
+      def size
+        number_to_human_size(attachment.blob&.byte_size || 0)
+      end
+    end
+  end
+end

data/app/models/headmin/form/media_view.rb

@@ -19,7 +19,7 @@ module Headmin
           class: ["mb-3", ("form-floating" if float)],
           data: {
             controller: "media",
-            name: "#{attribute}_#{object_id}",
+            name: name,
             min: min,
             max: max,
             sort: sort,
@@ -28,6 +28,18 @@ module Headmin
         }).deep_merge(@wrapper || {})
       end
 
+      def item_options
+        options = {
+          sort: sort
+        }
+
+        # Don't pass width or height if it was not defined
+        options = options.merge(width: width) if is_defined?(:width)
+        options = options.merge(height: height) if is_defined?(:height)
+
+        options
+      end
+
       def custom_validation_options
         {
           form: form,
@@ -37,6 +49,18 @@ module Headmin
         }
       end
 
+      def thumbnail_options
+        options = {
+          icon: "plus"
+        }
+
+        # Don't pass width or height if it was not defined
+        options = options.merge(width: width) unless is_defined?(:width)
+        options = options.merge(height: height) unless is_defined?(:height)
+
+        options
+      end
+
       def association_object
         if attached.is_a?(ActiveStorage::Attached::Many)
           result = form.object.send(nested_attribute)
@@ -101,8 +125,8 @@ module Headmin
         attachments.map { |attachment| attachment.blob_id }
       end
 
-      def media_modal_url
-        headmin_media_url(name: "#{attribute}_#{object_id}", ids: blob_ids, min: min, max: max)
+      def name
+        "#{attribute}_#{object_id}"
       end
 
       def sort

data/app/models/headmin/form/select_view.rb

@@ -36,8 +36,9 @@ module Headmin
       private
 
       def default_options
+        selected = attribute.nil? ? nil : form.object&.send(attribute)
         {
-          selected: form.object&.send(attribute)
+          selected: selected
         }
       end
 

data/app/models/headmin/thumbnail_view.rb

@@ -1,41 +1,62 @@
 module Headmin
-  class ThumbnailView
-    def initialize(local_assigns)
-      @local_assigns = local_assigns
-    end
-
+  class ThumbnailView < ViewModel
     def class_names
-      class_names = [@local_assigns[:class]]
+      class_names = [@class]
       class_names << "img-thumbnail h-thumbnail"
       class_names.join(" ")
     end
 
     def width
-      @local_assigns[:width] || 150
+      if is_defined?(:width)
+        @width
+      else
+        @width || 100
+      end
     end
 
     def height
-      @local_assigns[:height] || 150
+      if is_defined?(:height)
+        @height
+      else
+        @height || 100
+      end
     end
 
-    def src
-      @local_assigns[:src]
+    def blob
+      file.is_a?(ActiveStorage::Blob) ? file : file&.blob
     end
 
-    def icon
-      @local_assigns[:icon]
+    def mime_type
+      blob&.content_type
     end
 
-    def mime_type
-      if src
-        stripped_path = URI.parse(src).path
-        extension = File.extname(stripped_path)
-        Rack::Mime.mime_type(extension)
+    def variant_options
+      if width.nil? || height.nil?
+        default_variant_options.merge({
+          resize_to_fit: [width, height]
+        })
+      else
+        default_variant_options.merge({
+          resize_to_fill: [width, height, crop: :attention]
+        })
       end
     end
 
-    def image?
-      mime_type&.match?(/^image/)
+    def default_variant_options
+      {
+        saver: {
+          quality: 80
+        }
+      }
+    end
+
+    # Is it possible to create a ActiveStorage::Variant?
+    def variable?
+      blob&.variable?
+    end
+
+    def icon?
+      is_defined?(:icon)
     end
 
     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

data/app/models/view_model.rb

@@ -40,6 +40,10 @@ class ViewModel
 
   private
 
+  def is_defined?(attribute)
+    attributes.include?(attribute.to_sym)
+  end
+
   def value_for(attribute)
     reserved_methods.include?(attribute) ? instance_variable_get("@#{attribute}") : send(attribute)
   end

data/app/views/headmin/_filters.html.erb

@@ -14,10 +14,15 @@
   #   <%= render "headmin/filters", url: admin_polls_path %#>
 
   action = local_assigns.has_key?(:url) ? url : request.path
-%>
 
-<%= form_with url: action, method: :get, data: {controller: "filters", filters_target: "form"} do |form| %>
+  begin
+    model = controller_name.singularize.capitalize.constantize
+  rescue
+    raise "Cannot find class!"
+  end
+%>
 
+<%= form_with model: model.new, url: action, method: :get, data: {controller: "filters", filters_target: "form"} do |form| %>
   <%# Perform yield in order to capture content blocks, pass form so we can use headmin form inputs %>
   <%= yield(form) %>
 

data/app/views/headmin/_thumbnail.html.erb

@@ -1,11 +1,35 @@
-<% thumbnail = Headmin::ThumbnailView.new(local_assigns) %>
+<%
+  # headmin/thumbnail
+  #
+  # ==== Required parameters
+  # * +file+ - Name of the attribute of the form model
+  #
+  # ==== Optional parameters
+  # * +width+ - Width of the thumbnail. Set to nil to fill according to the original aspect ratio
+  # * +height+ - Height of the thumbnail. Set to nil to fill according to the original aspect ratio
+  # * +icon+ - Force icon to be shown instead of a thumbnail
+  #
+  # ==== References
+  # https://headmin.dev/docs/thumbnail
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/thumbnail", file: file %#>
+  #
+  #   Custom size (200px x 100px)
+  #   <%= render "headmin/thumbnail", file: file, width: 200, height: 100 %#>
+  #
+  #   Custom (bootstrap) icon
+  #   <%= render "headmin/thumbnail", file: file, icon: "file-earmark-excel" %#>
+  thumbnail = Headmin::ThumbnailView.new(local_assigns)
+%>
 
-<div class="<%= thumbnail.class_names %>" style="width: <%= thumbnail.width %>px; height: <%= thumbnail.height %>px;">
-  <% if thumbnail.image? %>
-    <div class="h-thumbnail-bg" style="background-image: url('<%= thumbnail.src %>');"></div>
-  <% else %>
-    <div class="h-thumbnail-bg">
+<div class="<%= thumbnail.class_names %>">
+  <div class="h-thumbnail-bg" style="min-width: <%= thumbnail.width || 100 %>px; min-height: <%= thumbnail.height || 100 %>px;">
+    <% if thumbnail.variable? && !thumbnail.icon? %>
+      <%= image_tag(thumbnail.file.variant(thumbnail.variant_options)) %>
+    <% else %>
       <%= bootstrap_icon(thumbnail.icon_name, class: "h-thumbnail-icon") %>
-    </div>
-  <% end %>
+    <% end %>
+  </div>
 </div>

data/app/views/headmin/filters/_association.html.erb

@@ -0,0 +1,24 @@
+<%
+  # headmin/filters/association
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the attribute to be filtered
+  # * +collection+ - Values to create option tags for
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +label+ - Display label
+  # * +name+ - Name of the filter parameter
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/filters", url: admin_orders_path do |form| %#>
+  #     <%= render "headmin/filters/association", form: form, attribute: :product %#>
+  #   <% end  %#>
+
+  association = Headmin::Filter::AssociationView.new(local_assigns.merge(params: params))
+%>
+
+<%= render "headmin/filters/base", association.base_options do |value| %>
+  <%= render "headmin/forms/select", association.input_options.merge(selected: value) %>
+<% end %>

data/app/views/headmin/filters/_options.html.erb

@@ -1,5 +1,5 @@
 <%
-  # headmin/filters/boolean
+  # headmin/filters/options
   #
   # ==== Required parameters
   # * +attribute+ - Name of the attribute to be filtered

data/app/views/headmin/forms/_association.html.erb

@@ -0,0 +1,30 @@
+<%
+  # headmin/forms/association
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the association
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +collection+ - Values to create option tags for
+  #
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/association", form: form, attribute: :product %#>
+  #   <% end %#>
+
+  association = Headmin::Form::AssociationView.new(local_assigns)
+
+%>
+
+<%= render "headmin/forms/wrapper", association.wrapper_options do %>
+  <%= render "headmin/forms/label", association.label_options if association.prepend_label? %>
+  <%= render "headmin/forms/input_group", association.input_group_options do %>
+    <%= form.select(association.attribute_with_id, association.collection, association.select_options, association.input_options) %>
+  <% end %>
+  <%= render "headmin/forms/validation", association.validation_options if association.validate? %>
+  <%= render "headmin/forms/hint", association.hint_options if association.hint? %>
+  <%= render "headmin/forms/label", association.label_options if association.append_label? %>
+<% end %>

data/app/views/headmin/forms/_file.html.erb

@@ -45,12 +45,11 @@
               next unless attachment
               filename = attachment.blob.filename.to_s
               size = number_to_human_size(attachment.blob.byte_size)
-              src = attachment.image? ? url_for(attachment.variant(resize_to_fill: [file.thumbnail_width, file.thumbnail_height])) : url_for(attachment)
             %>
             <div class="h-form-file-thumbnail" title="<%= "#{filename} (#{size})" %>" data-file-preview-target="thumbnail">
               <%= ff.hidden_field(:id, disabled: !file.destroy) %>
               <%= ff.hidden_field(:_destroy, data: {"file-preview-target": "thumbnailDestroy"}, disabled: !file.destroy) %>
-              <%= render "headmin/thumbnail", src: src, width: file.thumbnail_width, height: file.thumbnail_height %>
+              <%= render "headmin/thumbnail", file: attachment %>
 
               <% if file.destroy %>
                 <div class="h-form-file-thumbnail-remove" data-action="click->file-preview#remove" data-file-preview-name-param="<%= filename %>">
@@ -62,12 +61,12 @@
 
           <!-- Placeholder -->
           <% if file.dropzone %>
-            <div class="h-dropzone-placeholder <%= "d-none" if file.attachments.any? %>" data-file-preview-target="placeholder" style="height: <%= file.thumbnail_height %>px;">
+            <div class="h-dropzone-placeholder <%= "d-none" if file.attachments.any? %>" data-file-preview-target="placeholder" style="height: 100px;">
               <%= t("headmin.forms.file.placeholder", count: file.number_of_files) %>
             </div>
           <% else %>
             <div class="h-form-file-thumbnail <%= "d-none" if file.attachments.any? %>" title="<%= t("headmin.forms.file.not_found") %>" data-file-preview-target="placeholder">
-              <%= render "headmin/thumbnail", width: file.thumbnail_width, height: file.thumbnail_height, icon: "plus" %>
+              <%= render "headmin/thumbnail", icon: "plus" %>
             </div>
           <% end %>
         </div>
@@ -76,7 +75,7 @@
       <!-- Template -->
       <template data-file-preview-target="template">
         <div class="h-form-file-thumbnail" title="" data-file-preview-target="thumbnail">
-          <%= render "headmin/thumbnail", src: nil, width: file.thumbnail_width, height: file.thumbnail_height %>
+          <%= render "headmin/thumbnail" %>
 
           <% if file.destroy %>
             <div class="h-form-file-thumbnail-remove" data-action="click->file-preview#remove">

data/app/views/headmin/forms/_media.html.erb

@@ -1,5 +1,5 @@
 <%
-  # headmin/forms/file
+  # headmin/forms/media
   #
   # ==== Required parameters
   # * +attribute+ - Name of the attribute of the form model
@@ -13,6 +13,8 @@
   # * +max+ - Limit the selection to a maximum amount of items.
   # * +sort+ - Allow sorting by dragging items. `active_storage_attachments` must have a position column.
   # * +wrapper+ - Hash with all options for the surrounding html tag
+  # * +width+ - Width of the thumbnail
+  # * +height+ - Height of the thumbnail
   #
   # ==== References
   # https://headmin.dev/docs/forms/media
@@ -33,13 +35,13 @@
 
     <!-- Render previews for attachments -->
     <%= form.fields_for(media.nested_attribute, media.association_object) do |ff| %>
-      <%= render "headmin/forms/media/item", form: ff, url: media.media_modal_url, sort: media.sort %>
+      <%= render "headmin/forms/media/item", media.item_options.merge(form: ff, url: headmin_media_url(name: media.name, ids: media.blob_ids, min: media.min, max: media.max)) %>
     <% end %>
 
     <!-- Placeholder -->
     <div class="<%= "d-none" if media.attachments.any? %>" data-media-target="placeholder">
-      <a href="<%= media.media_modal_url %>" data-turbo-frame="remote_modal" data-media-target="modalButton">
-        <%= render "headmin/thumbnail", src: nil, width: 100, height: 100, icon: "plus" %>
+      <a href="<%= headmin_media_url(name: media.name, ids: media.blob_ids, min: media.min, max: media.max) %>" data-turbo-frame="remote_modal" data-media-target="modalButton">
+        <%= render "headmin/thumbnail", media.thumbnail_options %>
       </a>
     </div>
   </div>
@@ -48,7 +50,7 @@
   <% association_object = ActiveStorage::Attachment.new %>
   <template data-media-target="template" data-template-id-regex="<%= association_object.object_id %>">
     <%= form.fields_for(media.nested_attribute, ActiveStorage::Attachment.new, child_index: association_object.object_id) do |ff| %>
-      <%= render "headmin/forms/media/item", form: ff, url: media.media_modal_url, sort: media.sort %>
+      <%= render "headmin/forms/media/item", media.item_options.merge(form: ff, url: headmin_media_url(name: media.name, ids: media.blob_ids, min: media.min, max: media.max)) %>
     <% end %>
   </template>
 

data/app/views/headmin/forms/_repeater.html.erb

@@ -2,12 +2,13 @@
   # headmin/forms/repeater
   #
   # ==== Options
-  # * +form</tt> -  Form object
-  # * +attribute</tt> - Name of the attribute of the form model
-  # * +header</tt> - Name of the template to use as header
+  # * +form+ -  Form object
+  # * +attribute+ - Name of the attribute of the form model
+  # * +header+ - Name of the template to use as header
   # * +label+ - Text to show as label. Label will be hidden if value is false
-  # * +templates</tt> - List of all views that can be used as a template for a new block
-  # * +flush</tt> - Set to true if you want the list items to sit flush with its parent.
+  # * +templates+ - List of all views that can be used as a template for a new block
+  # * +flush+ - Set to true if you want the list items to sit flush with its parent.
+  # * +row+ - Pass hash with options to pass to the row template.
   #
   # ==== Examples
   #   # Basic version
@@ -36,6 +37,7 @@
   header = local_assigns.has_key?(:header) ? header : nil
   templates = local_assigns.has_key?(:templates) ? templates : []
   flush = local_assigns.has_key?(:flush) ? flush : true
+  row_options = local_assigns.has_key?(:row) ? row : {}
 
   template_names = templates.map { |template| File.basename(template, ".html.erb") }
   template_names = template_names.any? ? template_names : ["new"]
@@ -55,7 +57,7 @@
   <%= render "headmin/forms/label", form: form, attribute: attribute, text: label, required: required %>
 <% end %>
 
-<ul class="repeater list-group <%= "list-group-flush" if flush %>" data-controller="repeater" data-repeater-target="list" data-repeater-id-value="<%= repeater_id %>">
+<ul class="repeater list-group <%= "list-group-flush" if flush %> mb-3" data-controller="repeater" data-repeater-target="list" data-repeater-id-value="<%= repeater_id %>">
 
   <!-- Header -->
   <% if header %>
@@ -66,7 +68,7 @@
 
   <!-- Rows -->
   <%= form.fields_for attribute, associations do |ff| %>
-    <%= render "headmin/forms/repeater/row", pass_thru: pass_thru, form: ff, repeater_id: repeater_id do %>
+    <%= render "headmin/forms/repeater/row", row_options.merge(pass_thru: pass_thru, form: ff, repeater_id: repeater_id) do %>
       <%= yield(ff) %>
     <% end %>
   <% end %>
@@ -114,7 +116,7 @@
     <% template_names.each do |name| %>
       <template data-repeater-target="template" data-template-name="<%= name %>" data-template-id-regex="<%= association_object.object_id %>">
         <%= form.fields_for attribute, association_object, child_index: association_object.object_id do |ff| %>
-          <%= render "headmin/forms/repeater/row", form: ff, pass_thru: pass_thru, repeater_id: repeater_id do %>
+          <%= render "headmin/forms/repeater/row", row_options.merge(form: ff, pass_thru: pass_thru, repeater_id: repeater_id) do %>
             <% yield(ff, name) %>
           <% end %>
         <% end %>

data/app/views/headmin/forms/_wrapper.html.erb

@@ -1,5 +1,4 @@
 <% wrapper = Headmin::Form::WrapperView.new(local_assigns) %>
-
 <% if wrapper.bypass %>
   <%= yield %>
 <% else %>

data/app/views/headmin/forms/fields/_list.html.erb

@@ -19,8 +19,10 @@
 %>
 
 <%= render "headmin/forms/fields/base", form: form, name: name, field_type: :list do |list, field_label| %>
-  <%= render "headmin/forms/repeater", form: list, attribute: :fields, label: show_label ? label || field_label : false, flush: false do |field| %>
-    <%= field.hidden_field :field_type, value: :group %>
-    <%= yield field %>
-  <% end %>
+  <div class="mb-3">
+    <%= render "headmin/forms/repeater", form: list, attribute: :fields, label: show_label ? label || field_label : false, flush: false do |field| %>
+      <%= field.hidden_field :field_type, value: :group %>
+      <%= yield field %>
+    <% end %>
+  </div>
 <% end %>