headmin 0.3.2 → 0.4.0

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

@@ -0,0 +1,48 @@
+module Headmin
+  module Form
+    class TextView < ViewModel
+      include Headmin::Form::Autocompletable
+      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 label prepend validate wrapper]
+        options = to_h.slice(*keys)
+        options = default_input_options.merge(options)
+        options.merge(autocomplete_input_options)
+      end
+
+      def input_group_options
+        default_input_group_options
+          .merge(autocomplete_input_group_options)
+          .merge(label_input_group_options)
+          .merge(@input_group || {})
+      end
+
+      def wrapper_options
+        default_wrapper_options.merge({
+          class: ["mb-3", ("form-floating" if float)]
+        }).merge(@wrapper || {})
+      end
+
+      private
+
+      def default_input_options
+        {
+          aria: {describedby: validation_id},
+          class: [form_control_class, validation_class],
+          placeholder: placeholder
+        }
+      end
+
+      def form_control_class
+        plaintext ? "form-control-plaintext" : "form-control"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Headmin
+  module Form
+    class TextareaView < ViewModel
+      include Headmin::Form::Hintable
+      include Headmin::Form::InputGroupable
+      include Headmin::Form::Labelable
+      include Headmin::Form::Placeholderable
+      include Headmin::Form::Validatable
+      include Headmin::Form::Wrappable
+
+      def input_options
+        keys = attributes - %i[attribute float form input_group label validate wrapper]
+        options = to_h.slice(*keys)
+        default_input_options.merge(options)
+      end
+
+      def input_group_options
+        default_input_group_options
+          .merge(label_input_group_options)
+          .merge(@input_group || {})
+      end
+
+      def wrapper_options
+        default_wrapper_options.merge({
+          class: ["mb-3", ("form-floating" if float)]
+        }).merge(@wrapper || {})
+      end
+
+      private
+
+      def default_input_options
+        {
+          aria: {describedby: validation_id},
+          class: [form_control_class, validation_class],
+          placeholder: placeholder
+        }
+      end
+
+      def form_control_class
+        plaintext ? "form-control-plaintext" : "form-control"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Headmin
+  module Form
+    class UrlView < ViewModel
+      include Headmin::Form::Autocompletable
+      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 label prepend validate wrapper]
+        options = to_h.slice(*keys)
+        options = default_input_options.merge(options)
+        options.merge(autocomplete_input_options)
+      end
+
+      def input_group_options
+        default_input_group_options
+          .merge(autocomplete_input_group_options)
+          .merge(label_input_group_options)
+          .merge(@input_group || {})
+      end
+
+      def wrapper_options
+        default_wrapper_options.merge({
+          class: ["mb-3", ("form-floating" if float)]
+        }).merge(@wrapper || {})
+      end
+
+      private
+
+      def default_input_options
+        {
+          aria: {describedby: validation_id},
+          class: [form_control_class, validation_class],
+          placeholder: placeholder
+        }
+      end
+
+      def form_control_class
+        plaintext ? "form-control-plaintext" : "form-control"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Headmin
+  module Form
+    class WrapperView < ViewModel
+      def options
+        keys = attributes - %i[bypass]
+        options = to_h.slice(*keys)
+        default_options.merge(options)
+      end
+
+      private
+
+      def default_options
+        {
+          class: ["mb-3"]
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Headmin
+  module Form
+    class WysiwygView < ViewModel
+      def options
+        default_options.merge(to_h)
+      end
+
+      private
+
+      def default_options
+        {
+          hybrid: toolbar == false
+        }
+      end
+    end
+  end
+end

data/app/models/headmin/thumbnail_view.rb

@@ -0,0 +1,66 @@
+module Headmin
+  class ThumbnailView
+    def initialize(local_assigns)
+      @local_assigns = local_assigns
+    end
+
+    def class_names
+      class_names = [@local_assigns[:class]]
+      class_names << "img-thumbnail h-thumbnail"
+      class_names.join(" ")
+    end
+
+    def width
+      @local_assigns[:width] || 150
+    end
+
+    def height
+      @local_assigns[:height] || 150
+    end
+
+    def src
+      @local_assigns[:src]
+    end
+
+    def icon
+      @local_assigns[:icon]
+    end
+
+    def mime_type
+      if src
+        stripped_path = URI.parse(src).path
+        extension = File.extname(stripped_path)
+        Rack::Mime.mime_type(extension)
+      end
+    end
+
+    def image?
+      mime_type&.match?(/^image/)
+    end
+
+    # https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
+    def icon_name
+      return icon if icon
+      type_map = {
+        image: %w[image/bmp image/gif image/vnd.microsoft.icon image/jpeg image/png image/svg+xml image/tiff image/webp],
+        play: %w[video/mp4 video/mpeg video/ogg video/mp2t video/webm video/3gpp video/3gpp2],
+        music: %w[audio/aac audio/midi audio/x-midi audio/mpeg audio/ogg audio/opus audio/wav audio/webm audio/3gpp audio/3gpp2],
+        word: %w[application/msword application/vnd.openxmlformats-officedocument.wordprocessingml.document],
+        ppt: %w[application/vnd.ms-powerpoint application/vnd.openxmlformats-officedocument.presentationml.presentation],
+        excel: %w[application/vnd.ms-excel application/vnd.openxmlformats-officedocument.spreadsheetml.sheet],
+        slides: %w[application/vnd.oasis.opendocument.presentation],
+        spreadsheet: %w[application/vnd.oasis.opendocument.spreadsheet],
+        richtext: %w[application/vnd.oasis.opendocument.text],
+        zip: %w[application/zip application/x-7z-compressed application/x-bzip application/x-bzip2 application/gzip application/vnd.rar],
+        pdf: %w[application/pdf]
+      }
+
+      type = type_map.find { |key, mime_types| mime_types.include?(mime_type) }
+      if type
+        ["file", "earmark", type.first].compact.join("-")
+      else
+        "question"
+      end
+    end
+  end
+end

data/app/models/view_model.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class ViewModel
+  # = View Model
+  #
+  # A View Model is a class that allows you to set an arbitrary hash of attributes and access all values by calling
+  # attribute methods.
+  #
+  # ==== Examples
+  #
+  #   model = ViewModel.new(a: 1, b: {b1: 1, b2: 2}, c: 3)
+  #
+  #   model.a   # => 1
+  #   model.b   # => {b1: 1, b2: 2}
+  #   model.c   # => 3
+  #
+  # Reserved methods or attributes are left untouched. If you want to access an attribute that collides with a reserved
+  # method, you can do it via the +to_hash+ method.
+  #
+  #   model = ViewModel.new(class: "test")
+  #
+  #   model.class             # => ViewModel
+  #   model.to_hash[:class]   # => "test"
+
+  def initialize(hash = {})
+    hash.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end
+  end
+
+  def attributes
+    instance_variables.map { |instance_variable| instance_variable.to_s.delete("@").to_sym }
+  end
+
+  def to_hash
+    attributes.map { |attribute| {attribute => value_for(attribute)} }.inject(:merge)
+  end
+
+  alias_method :to_h, :to_hash
+
+  private
+
+  def value_for(attribute)
+    reserved_methods.include?(attribute) ? instance_variable_get("@#{attribute}") : send(attribute)
+  end
+
+  def method_missing(m, *args, &block)
+    instance_variable_get("@#{m}")
+  end
+
+  def respond_to_missing?
+    true
+  end
+
+  def reserved_methods
+    Class.methods + Class.private_methods
+  end
+end

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

@@ -1,24 +1,28 @@
 <%
   # headmin/blocks
   #
-  # ==== Options
+  # ==== Required parameters
   # * +blockable</tt> - Object with blocks association
-  # * +path</tt> - Directory where to look for block templates
+  #
+  # ==== Optional parameters
+  # * +paths</tt> - Directories where to look for block templates
   #
   # ==== Examples
-  #   Basic version. This will only look for blocks in 'website/blocks'
+  #   Basic version. (looks in views/website/blocks, views/blocks or views directory )
   #   <%= render "headmin/blocks", blockable: @page %#>
   #
-  #   Define the path to look for block templates like this:
-  #   <%= render "headmin/blocks", blockable: @page, path: 'website/pages/blocks' %#>
+  #   Define one ore more path where the templates could be located:
+  #   <%= render "headmin/blocks", blockable: @page, paths: %w(website/pages/blocks) %#>
 
-  blockable = local_assigns.has_key?(:blockable) ? blockable : nil
-  path = local_assigns.has_key?(:path) ? path : nil
+  blocks = Headmin::BlocksView.new(local_assigns)
+  @lookup_context.prefixes = @lookup_context.prefixes + blocks.prefixes
 %>
 
 <% if blockable && blockable.respond_to?(:blocks) %>
   <% blockable.blocks.order(:position).each do |block| %>
-    <% view_path = BlockService.frontend_view(block.name, path: path).gsub('/_', '/').split('.').first %>
-    <%= render view_path, block: block %>
+
+    <!-- <%= block.name %> -->
+    <%= render block.name, block: block %>
+
   <% end %>
 <% end %>

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

@@ -1,10 +1,16 @@
 <%
   # headmin/heading
   #
+  # Accepts a block
+  #
+  # ==== References
+  # https://headmin.dev/docs/heading
+  # https://headmin.dev/preview/heading
+  #
   # ==== Examples
   #   Basic version
   #   <%= render "headmin/heading" do %#>
-  #     Your content
+  #     Title
   #   <% end %#>
 %>
 

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

@@ -1,45 +1,11 @@
-<%
-  # name: headmin/thumbnail
-  #
-  # ==== Required parameters
-  # * +src+ - Sourch path for the file
-  #
-  # ==== Optional parameters
-  # * +width+ - Width of the thumbnail
-  # * +height+ - Height of the thumbnail
-  #
-  # ==== References
-  # https://getbootstrap.com/docs/5.1/content/images/#image-thumbnails
-  #
-  # ==== Examples
-  #   Basic version
-  #   <%= render 'headmin/thumbnail', src: file %#>
-  #
-  #   Custom width and height
-  #   <%= render 'headmin/thumbnail', src: file, width: 300, height: 100 %#>
+<% thumbnail = Headmin::ThumbnailView.new(local_assigns) %>
 
-  width = local_assigns[:width] || 150
-  height = local_assigns[:height] || 150
-  class_names = ['img-thumbnail h-thumbnail', local_assigns[:class]].join(' ')
-
-  mime_type = nil
-  if src
-    stripped_path = URI.parse(src).path
-    extension = File.extname(stripped_path)
-    mime_type = Rack::Mime.mime_type(extension)
-  end
-%>
-
-<div class="<%= class_names %>" style="width: <%= width %>px; height: <%= height %>px;">
-  <% if mime_type&.match?(/^image/) %>
-        <div class="h-thumbnail-bg" style="background-image: url('<%= src %>');"></div>
+<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">
-      <% if mime_type %>
-        <%= bootstrap_icon_for_mime_type(mime_type, class: 'h-thumbnail-icon') %>
-      <% else %>
-        <%= bootstrap_icon('question', class: 'h-thumbnail-icon') %>
-      <% end %>
+      <%= bootstrap_icon(thumbnail.icon_name, class: 'h-thumbnail-icon') %>
     </div>
   <% end %>
 </div>

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

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

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

@@ -0,0 +1,11 @@
+<div class="h-autocomplete d-none" data-autocomplete-target="dropdown">
+<% if collection.any? %>
+  <%= render "headmin/forms/autocomplete/list" do %>
+    <% collection.each do |value, name| %>
+      <%= render "headmin/forms/autocomplete/item", value: value do %>
+        <%= name %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>
+</div>

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

@@ -1,39 +1,38 @@
 <%
   # headmin/forms/blocks
   #
-  # ==== Options
+  # ==== Required parameters
   # * +form</tt> - Form object
-  # * +path</tt> - Directory where to look for block templates
-  # * +allow</tt> - Names of block templates that can be added
+  # * +names</tt> - Names of block templates that can be added
+  #
+  # ==== Optional parameters
+  # * +paths</tt> - Directories where to look for block templates
   #
   # ==== Examples
-  #   Basic version. This will only look for blocks in 'admin/blocks'
-  #   <%= render "headmin/forms/blocks", form: form %#>
+  #   Basic version. (looks in views/admin/blocks, views/blocks or views directory )
+  #   <%= render "headmin/forms/blocks", form: form, names: %w(text image button) %#>
   #
-  #   Define the path to look for block templates like this:
-  #   <%= render "headmin/forms/blocks", form: form, path: 'admin/pages/blocks' %#>
+  #   Define one ore more path where the templates could be located:
+  #   <%= render "headmin/forms/blocks", form: form, names: %w(text image button), paths: %w(admin/pages/blocks) %#>
   #
   #   Limit the types of blocks
-  #   <%= render "headmin/forms/blocks", form: form, allow: ['text', 'text-image'] %#>
-
-  path = local_assigns.has_key?(:path) ? path : nil
-  allowed_block_names = local_assigns.has_key?(:allow) ? allow.map(&:to_s) : BlockService.block_names(path: path)
+  #   <%= render "headmin/forms/blocks", form: form, names: %w(text text_image list) %#>
 
-  templates = allowed_block_names.map { |name| BlockService.form_view(name, path: path) }
+  blocks = Headmin::Form::BlocksView.new(local_assigns)
+  @lookup_context.prefixes = @lookup_context.prefixes + blocks.prefixes
 %>
 
-<%= render 'headmin/forms/repeater', form: form, attribute: :blocks, templates: templates, label: false do |block_form, template| %>
-  <% name = template ? BlockService.view_name(template) : block_form.object.name %>
+<%= render 'headmin/forms/repeater', blocks.repeater_options do |block_form, template| %>
+  <% name = template || block_form.object.name %>
 
   <!-- Name input of the block -->
   <%= block_form.hidden_field :name, value: name %>
 
   <!-- Render block form fields -->
-  <% view_path = BlockService.form_view(name, path: path).gsub('/_', '/').split('.')[0] %>
-  <%= render view_path, form: block_form %>
+  <%= render name, form: block_form %>
 
   <!-- Label -->
   <span class="position-absolute top-0 end-0 badge bg-light text-dark">
-    <%= name.titleize %>
+    <%= t("blocks.#{name}", default: name).humanize %>
   </span>
 <% end %>

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

@@ -1,39 +1,34 @@
 <%
   # headmin/forms/checkbox
   #
-  # ==== Options
-  # * +form+ - Form object
+  # ==== Required parameters
   # * +attribute+ - Name of the attribute of the form model
-  # * +label+ - Text to show as label. Label will be hidden if value is false
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +checked_value+ - Value for checked state
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +unchecked_value+ - Value for unchecked state
+  # * +wrapper+ - Hash with all options for the surrounding html tag
+  #
+  # ==== References
+  # https://headmin.dev/docs/forms/checkbox
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/check_box
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/image', form: form, attribute: :image %#>
-
-  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : false
-  data = local_assigns.has_key?(:data) ? data : nil
-  disabled = local_assigns.has_key?(:disabled) ? disabled : false
-  label = local_assigns.has_key?(:label) ? label : nil
-  readonly = local_assigns.has_key?(:readonly) ? readonly : false
-  required = local_assigns.has_key?(:required) ? required : false
-
-  options = {
-    'aria-describedby': form_field_validation_id(form, attribute),
-    class: "form-checkbox-input #{form_field_validation_class(form, attribute)} #{class_names}",
-    data: data,
-    disabled: disabled,
-    placeholder: attribute,
-    readonly: readonly,
-    required: required,
-  }
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/checkbox", form: form, attribute: :active %#>
+  #   <% end %#>
 
-  show_label = label != false
+  checkbox = Headmin::Form::CheckboxView.new(local_assigns)
 %>
 
-<div class="<%= ('mb-3 text-start' if show_label) %>">
-  <%= form.check_box(attribute, options) %>
-  <% if show_label %>
-    <%= render 'headmin/forms/label', form: form, attribute: attribute, name: label, required: required %>
-  <% end %>
-  <%= render 'headmin/forms/validation', form: form, attribute: attribute %>
-</div>
+<%= render "headmin/forms/wrapper", checkbox.wrapper_options do %>
+  <%= form.check_box(checkbox.attribute, checkbox.input_options, checkbox.checked_value, checkbox.unchecked_value) %>
+  <%= render "headmin/forms/label", checkbox.label_options if checkbox.label? %>
+  <%= render "headmin/forms/validation", checkbox.validation_options if checkbox.validate? %>
+  <%= render "headmin/forms/hint", checkbox.hint_options if checkbox.hint? %>
+<% end %>

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

@@ -0,0 +1,3 @@
+<datalist id="<%= id %>">
+  <%= options_for_select(collection) %>
+</datalist>

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

@@ -2,40 +2,40 @@
   # headmin/forms/date
   #
   # ==== Required parameters
-  # * +form+ - Form object
   # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
   #
   # ==== Optional parameters
-  # * +aria+ - Provide a hash to define all aria attributes
-  # * +autocomplete+ - Value to be autofilled by the browser
-  # * +autofocus+ - Set to true to focus on this field when the page renders
-  # * +data+ - Optional HTML data attributes
-  # * +disabled+ - Set to true if the input should be shown as disabled
-  # * +id+ - Input identifier
-  # * +list+ - Add array of options to show in a data list
-  # * +readonly+ - Set to true if the value of the field can only be read and not be modified
-  # * +required+ - Set to true to mark as required
-  # * +step+ - The acceptable value granularity
-  # * +value+ - Overrides the value of the form
-  #
-  # ==== Extra parameters
-  # Listed in 'headmin/forms/base'
+  # * +append+ - Display as input group with text on the right-hand side
+  # * +float+ - Use floating labels. Defaults to false
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +list+ - Options are passed through options_for_select
+  # * +plaintext+ - Render input as plain text.
+  # * +prepend+ - Display as input group with text on the left-hand side
+  # * +wrapper+ - Hash with all options for the surrounding html tag
   #
   # ==== References
+  # https://headmin.dev/docs/forms/date
   # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date
   # https://apidock.com/rails/ActionView/Helpers/FormHelper/date_field
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/date', form: form, attribute: :date %#>
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/date", form: form, attribute: :date_of_birth %#>
+  #   <% end %#>
 
-  option_keys = %i(aria autocomplete autofocus data disabled id list readonly required step value)
-  options = local_assigns.slice(*option_keys).merge(
-    aria: { describedby: form_field_validation_id(form, attribute) },
-    class: ['form-control', form_field_validation_class(form, attribute)].join(' '),
-  )
+  date = Headmin::Form::DateView.new(local_assigns)
 %>
 
-<%= render 'headmin/forms/base', local_assigns do |form| %>
-  <%= form.date_field(attribute, options) %>
-<% end %>
+<%= render "headmin/forms/wrapper", date.wrapper_options do %>
+  <%= render "headmin/forms/label", date.label_options if date.prepend_label? %>
+  <%= render "headmin/forms/input_group", date.input_group_options do %>
+    <%= form.date_field(date.attribute, date.input_options) %>
+    <%= render "headmin/forms/datalist", date.datalist_options if date.datalist? %>
+  <% end %>
+  <%= render "headmin/forms/validation", date.validation_options if date.validate? %>
+  <%= render "headmin/forms/hint", date.hint_options if date.hint? %>
+  <%= render "headmin/forms/label", date.label_options if date.append_label? %>
+<% end %>