headmin 0.5.1 → 0.5.4

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

@@ -0,0 +1,137 @@
+module Headmin
+  module Form
+    class MediaView < ViewModel
+      include Rails.application.routes.url_helpers
+      include Headmin::Form::Hintable
+      include Headmin::Form::Labelable
+      include Headmin::Form::Placeholderable
+      include Headmin::Form::Validatable
+      include Headmin::Form::Wrappable
+
+      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)],
+          data: {
+            controller: "media",
+            name: name,
+            min: min,
+            max: max,
+            sort: sort,
+            required: required.nil? ? 0 : required
+          }
+        }).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,
+          attribute: attribute,
+          min: min,
+          max: max
+        }
+      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)
+          result = result.order(position: :asc) if sort
+          result
+        else
+          form.object.send(nested_attribute)
+        end
+      end
+
+      def attachments
+        if attached.is_a?(ActiveStorage::Attached::Many)
+          result = form.object.send(nested_attribute)
+          result = result.order(position: :asc) if sort
+          result.to_a.compact
+        else
+          [form.object.send(nested_attribute)].compact
+        end
+      end
+
+      def attached
+        form.object.send(attribute)
+      end
+
+      def build_nested_attribute
+        if attached.is_a?(ActiveStorage::Attached::Many)
+          form.object.send(nested_attribute).build
+        else
+          form.object.send("build_#{nested_attribute}")
+        end
+      end
+
+      def nested_attribute
+        if attached.is_a?(ActiveStorage::Attached::Many)
+          :"#{attribute}_attachments"
+        else
+          :"#{attribute}_attachment"
+        end
+      end
+
+      def min
+        if @required
+          @min.to_i < 1 ? 1 : @min.to_i
+        else
+          @min.to_i < 1 ? 0 : @min.to_i
+        end
+      end
+
+      def max
+        if attached.is_a?(ActiveStorage::Attached::Many)
+          @max
+        else
+          1
+        end
+      end
+
+      def required
+        @required ? 1 : nil
+      end
+
+      def blob_ids
+        attachments.map { |attachment| attachment.blob_id }
+      end
+
+      def name
+        "#{attribute}_#{object_id}"
+      end
+
+      def sort
+        @sort == true
+      end
+    end
+  end
+end

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/form/textarea_view.rb

@@ -22,7 +22,8 @@ module Headmin
 
       def wrapper_options
         default_wrapper_options.deep_merge({
-          class: ["mb-3", ("form-floating" if float)]
+          class: ["mb-3", ("form-floating" if float)],
+          data: {controller: :textarea}
         }).deep_merge(@wrapper || {})
       end
 
@@ -32,6 +33,10 @@ module Headmin
         {
           aria: {describedby: validation_id},
           class: [form_control_class, validation_class],
+          data: {
+            textarea_target: :textarea,
+            action: "input->textarea#update"
+          },
           placeholder: placeholder
         }
       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/examples/admin.html.erb

@@ -6,15 +6,15 @@
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
-  <%= stylesheet_pack_tag 'admin', media: 'all', 'data-turbo-track': 'reload' %>
-  <%= javascript_pack_tag 'admin', 'data-turbo-track': 'reload' %>
+  <%= stylesheet_pack_tag "admin", media: "all", "data-turbo-track": "reload" %>
+  <%= javascript_pack_tag "admin", "data-turbo-track": "reload" %>
 </head>
 
 <body>
 <%= render "headmin/layout/main" do %>
-  <%= render "headmin/layout/sidebar", logo: inline_svg_tag('logo.svg') do %>
+  <%= render "headmin/layout/sidebar", logo: inline_svg_tag("logo.svg") do %>
     <%= render "headmin/layout/sidebar/menu" do %>
-      <%= render "headmin/layout/sidebar/menu/item", name: t('.dashboard'), link: admin_root_path, icon: 'speedometer' %>
+      <%= render "headmin/layout/sidebar/menu/item", name: t(".dashboard"), link: admin_root_path, icon: "speedometer" %>
       <div class="d-block d-md-none">
         <%= render "headmin/layout/sidebar/menu/locale" do end %>
         <%= render "headmin/layout/sidebar/menu/account" do end %>
@@ -30,10 +30,10 @@
       <%= render "headmin/notifications" %>
       <%= yield %>
     <% end %>
-    <%= render "headmin/layout/footer", class: 'text-secondary' do %>
-      <%= bootstrap_icon('question-circle') %>
-      <a class="text-secondary" href="mailto:info@insiting.com" title="<%= t('.help') %>">
-        <%= t('.help') %>
+    <%= render "headmin/layout/footer", class: "text-secondary" do %>
+      <%= bootstrap_icon("question-circle") %>
+      <a class="text-secondary" href="mailto:info@insiting.com" title="<%= t(".help") %>">
+        <%= t(".help") %>
       </a>
     <% end %>
   <% end %>

data/app/views/examples/auth.html.erb

@@ -5,8 +5,8 @@
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
-  <%= stylesheet_pack_tag 'admin', media: 'all', 'data-turbolinks-track': 'reload' %>
-  <%= javascript_pack_tag 'admin', 'data-turbolinks-track': 'reload' %>
+  <%= stylesheet_pack_tag "admin", media: "all", "data-turbolinks-track": "reload" %>
+  <%= javascript_pack_tag "admin", "data-turbolinks-track": "reload" %>
 </head>
 <body class="bg-light w-100 vh-100">
 

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

@@ -14,11 +14,11 @@
     <% breadcrumb_count = breadcrumbs.count %>
     <% breadcrumbs.each_with_index do |breadcrumb, index| %>
       <% last = (index == breadcrumb_count - 1) %>
-      <li class="breadcrumb-item text-muted" aria-current="<%= last ? 'page' : nil %>">
+      <li class="breadcrumb-item text-muted" aria-current="<%= last ? "page" : nil %>">
         <% if last %>
           <%= breadcrumb.name %>
         <% else %>
-          <%= link_to_unless_current(breadcrumb.name, breadcrumb.path, class: 'text-muted text-decoration-none') %>
+          <%= link_to_unless_current(breadcrumb.name, breadcrumb.path, class: "text-muted text-decoration-none") %>
         <% end %>
       </li>
     <% end %>

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

@@ -10,7 +10,7 @@
   #     Your content
   #   <% end %#>
 
-  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : 'btn-group'
+  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : "btn-group"
 %>
 
 <div class="dropdown <%= class_names %>">

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

@@ -7,22 +7,27 @@
   # ==== Examples
   #   Basic version
   #   <%= render "headmin/filters" do %#>
-  #     <%= render "headmin/filters/select", name: 'color', options: ['red', 'green', 'blue']  %#>
+  #     <%= render "headmin/filters/select", name: "color", options: ["red", "green", "blue"]  %#>
   #   <% end %#>
   #
   #   With custom URL
   #   <%= 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) %>
 
   <!-- Default parameters (e.g. sorting, pagination) -->
-  <% default_params.except('page').each do |name, value| %>
+  <% default_params.except("page").each do |name, value| %>
     <%= form.hidden_field name.to_sym, value: value %>
   <% end %>
 
@@ -44,8 +49,8 @@
         <% if content_for?(:filters_menu) %>
           <div class="btn-group">
             <button type="button" class="btn h-btn-outline-light dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
-              <%= bootstrap_icon('funnel') %>
-              <%= t('.button') %>
+              <%= bootstrap_icon("funnel") %>
+              <%= t(".button") %>
             </button>
             <ul class="dropdown-menu">
               <%= content_for :filters_menu %>
@@ -53,7 +58,7 @@
                 <hr class="dropdown-divider">
               </li>
               <li>
-                <a class="dropdown-item text-danger" href="#" data-action="click->filters#removeAll"><%= t('.remove_all') %></a>
+                <a class="dropdown-item text-danger" href="#" data-action="click->filters#removeAll"><%= t(".remove_all") %></a>
               </li>
             </ul>
           </div>

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

@@ -12,7 +12,7 @@
 <div class="d-flex flex-row-reverse flex-md-row align-items-center justify-content-between justify-content-md-end my-1">
   <% content_for :collection_total_count, collection.total_count.to_s unless content_for?(:collection_total_count) %>
   <div class="ms-2 me-md-2 text-secondary flex-grow-1 flex-shrink-0">
-    <%= t('.items', count: content_for(:collection_total_count).to_i) %>
+    <%= t(".items", count: content_for(:collection_total_count).to_i) %>
   </div>
-  <%= paginate collection, views_prefix: 'headmin/pagination' %>
+  <%= paginate collection, views_prefix: "headmin/pagination" %>
 </div>

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

@@ -8,7 +8,7 @@
   #   To trigger this popup create an element with a data attribute like this
   #
   #   <button data-popup-id="popupId">open Popup</button>
-  #   <%= render "headmin/popup", id: 'popupId' do %#>
+  #   <%= render "headmin/popup", id: "popupId" do %#>
   #     popup Content
   #   <% end %#>
   #
@@ -16,14 +16,14 @@
   #   "data-popup-pass-thru" attribute.
   #
   #   <button data-popup-id="popupId" data-popup-pass-thru="#link">open Popup</button>
-  #   <%= render "headmin/popup", id: 'popupId' do %#>
+  #   <%= render "headmin/popup", id: "popupId" do %#>
   #     <a href="https://example.com" id="link">
   #   <% end %#>
   data = local_assigns.has_key?(:data) ? data : {}
 
   options = {
-    class: ['h-popup', 'closed'],
-    data: data.merge('popup-target': 'popup', 'popup-id': id)
+    class: ["h-popup", "closed"],
+    data: data.merge("popup-target": "popup", "popup-id": id)
   }
 %>
 

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

@@ -13,7 +13,7 @@
   total_count = content_for(:collection_total_count).to_i || nil
 %>
 
-<div class="h-table card my-2 shadow-sm <%= 'table-drag-sort' if sort_url %>" data-sort-url="<%= sort_url %>">
+<div class="h-table card my-2 shadow-sm <%= "table-drag-sort" if sort_url %>" data-sort-url="<%= sort_url %>">
   <div class="table-responsive">
     <table class="table table-hover m-0"
            data-controller="table"

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">
-      <%= bootstrap_icon(thumbnail.icon_name, class: 'h-thumbnail-icon') %>
-    </div>
-  <% end %>
+<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") %>
+    <% end %>
+  </div>
 </div>

data/app/views/headmin/dropdown/_button.html.erb

@@ -5,8 +5,8 @@
       id: unique identifier for the dropdown
       class: css class names as string
 %>
-<% id = local_assigns.has_key?(:id) ? id : 'dropdown-1' %>
-<% class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : 'btn' %>
+<% id = local_assigns.has_key?(:id) ? id : "dropdown-1" %>
+<% class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : "btn" %>
 
 <a class="dropdown-toggle d-flex align-items-center <%= class_names %>" type="button" id="<%= id %>" data-bs-toggle="dropdown" aria-expanded="false">
   <%= yield %>

data/app/views/headmin/dropdown/_item.html.erb

@@ -8,8 +8,8 @@
 %>
 
 <% method = local_assigns.has_key?(:method) ? method : nil %>
-<% url = local_assigns.has_key?(:url) ? url : '' %>
-<% name = local_assigns.has_key?(:name) ? name : '' %>
+<% url = local_assigns.has_key?(:url) ? url : "" %>
+<% name = local_assigns.has_key?(:name) ? name : "" %>
 
 <li>
   <a class="dropdown-item" href="<%= url %>" <%= "data-turbo-method=#{method}" if method %>>

data/app/views/headmin/dropdown/_list.html.erb

@@ -7,10 +7,10 @@
   #
   # ==== Examples
   #   Basic version
-  #   <%= render "headmin/dropdown/list", id: 'dropdown-1'  %#>
+  #   <%= render "headmin/dropdown/list", id: "dropdown-1"  %#>
 
-  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : ''
-  id = local_assigns.has_key?(:id) ? id : 'dropdown-1'
+  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : ""
+  id = local_assigns.has_key?(:id) ? id : "dropdown-1"
 %>
 
 <ul class="dropdown-menu <%= class_names %>" aria-labelledby="<%= id %>">

data/app/views/headmin/dropdown/_locale.html.erb

@@ -5,13 +5,13 @@
 %>
 
 <%= render "headmin/dropdown" do %>
-  <%= render "headmin/dropdown/button", id: 'locale-dropdown' do %>
-    <%= bootstrap_icon('globe', class: 'me-2') %>
-    <%= t('language_name', locale: ::I18n.locale) %>
+  <%= render "headmin/dropdown/button", id: "locale-dropdown" do %>
+    <%= bootstrap_icon("globe", class: "me-2") %>
+    <%= t("language_name", locale: ::I18n.locale) %>
   <% end %>
-  <%= render "headmin/dropdown/list", id: 'locale-dropdown' do %>
+  <%= render "headmin/dropdown/list", id: "locale-dropdown" do %>
     <% I18n.available_locales.each do |locale| %>
-      <%= render "headmin/dropdown/item", name: t('language_name', locale: locale), url: url_for({locale: locale.to_s}) %>
+      <%= render "headmin/dropdown/item", name: t("language_name", locale: locale), url: url_for({locale: locale.to_s}) %>
     <% end %>
   <% end %>
 <% end %>

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/filters/filter/_button.html.erb

@@ -19,11 +19,11 @@
   >
     <%= raw("#{button_view.label} #{button_view.filter&.string(display_values: button_view.display_values)}") %>
     <span class="h-filter-remove" data-action="click->filters#remove">
-      <%= bootstrap_icon('x-lg') %>
+      <%= bootstrap_icon("x-lg") %>
     </span>
   </button>
 
-  <%= render "headmin/popup", id: "#{button_view.id}", data: {'filter-target': 'popup'} do %>
+  <%= render "headmin/popup", id: "#{button_view.id}", data: {"filter-target": "popup"} do %>
     <%= yield %>
   <% end %>
 </div>

data/app/views/headmin/filters/filter/_null_select.html.erb

@@ -1,8 +1,8 @@
 <select class="form-select" data-filter-row-target="null" data-action="change->filter#updateHiddenValue" data-filter-target="value">
   <option value="1" <%= value == 1 ? "selected" : "" %>>
-    <%= t('headmin.filters.values.yes') %>
+    <%= t("headmin.filters.values.yes") %>
   </option>
   <option value="0" <%= value == 0 ? "selected" : "" %>>
-    <%= t('headmin.filters.values.no') %>
+    <%= t("headmin.filters.values.no") %>
   </option>
 </select>

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/_errors.html.erb

@@ -8,7 +8,7 @@
 <% if form.object.errors.any? %>
   <div class="alert alert-danger" role="alert">
     <h5 class="alert-heading d-flex align-items-center">
-      <%= t('errors.template.header', count: form.object.errors.size, model: form.object.model_name.human) %>
+      <%= t("errors.template.header", count: form.object.errors.size, model: form.object.model_name.human) %>
     </h5>
     <ul class="mb-0">
       <% form.object.errors.full_messages.each do |message| %>