headmin 0.3.4 → 0.4.0

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

@@ -0,0 +1,44 @@
+module Headmin
+  module Form
+    class PasswordView < 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[append attribute float form input_group label prepend 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/redactorx_view.rb

@@ -0,0 +1,59 @@
+module Headmin
+  module Form
+    class RedactorxView < ViewModel
+      def options
+        default_options.merge(to_h)
+      end
+
+      private
+
+      def default_options
+        {
+          data: {
+            controller: "redactorx",
+            "redactor-options": redactor_options
+          }
+        }
+      end
+
+      def control
+        @control || (hybrid ? true : nil)
+      end
+
+      def context
+        @context || (hybrid ? true : nil)
+      end
+
+      def toolbar
+        @toolbar || (hybrid ? false : nil)
+      end
+
+      def addbar
+        @addbar || %w[paragraph image embed table quote pre line]
+      end
+
+      def plugins
+        @plugins || %w[shortcut]
+      end
+
+      attr_reader :topbar
+
+      def redactor_options
+        default_redactor_options.merge(redactor || {})
+      end
+
+      def default_redactor_options
+        {
+          control: control,
+          context: context,
+          toolbar: toolbar,
+          buttons: {
+            addbar: addbar,
+            plugins: plugins,
+            topbar: topbar
+          }
+        }.delete_if { |k, v| v.nil? }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Headmin
+  module Form
+    class SearchView < 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/select_view.rb

@@ -0,0 +1,62 @@
+module Headmin
+  module Form
+    class SelectView < 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)
+        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
+
+      def select_options
+        keys = %i[include_blank selected]
+        options = to_h.slice(*keys)
+        default_options.merge(options)
+      end
+
+      private
+
+      def default_options
+        {
+          selected: form.object&.send(attribute)
+        }
+      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
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Headmin
+  module Form
+    class SwitchView < ViewModel
+      def options
+        default_options.merge(to_h)
+      end
+
+      private
+
+      def default_options
+        {
+          wrapper: default_wrapper_options
+        }
+      end
+
+      def default_wrapper_options
+        {
+          class: %w[form-check form-switch mb-3]
+        }
+      end
+    end
+  end
+end

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.rb → thumbnail_view.rb}

@@ -1,5 +1,5 @@
 module Headmin
-  class Thumbnail
+  class ThumbnailView
     def initialize(local_assigns)
       @local_assigns = local_assigns
     end
@@ -22,6 +22,10 @@ module Headmin
       @local_assigns[:src]
     end
 
+    def icon
+      @local_assigns[:icon]
+    end
+
     def mime_type
       if src
         stripped_path = URI.parse(src).path
@@ -36,6 +40,7 @@ module Headmin
 
     # 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],

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,40 +1,4 @@
-<!--
-<% documentation do %>
-  # Thumbnail
-  Render thumbnails for files. Whenever possible (e.g. images) previews are generated. Icons are used instead for other file types.
-
-  ```erbx
-  <%= render 'headmin/thumbnail', src: image_path("image.jpg") %>
-  ```
-
-  ## Parameters
-  | Name         | Required | Type             | Description |
-  | ------------ | -------- | ---------------- | ----------- |
-  | src          | yes      | String           | Source of the file. Can be a local or external URL |
-  | width        | no       | Integer          | Width of the thumbnail in px |
-  | height       | no       | Integer          | Height of the thumbnail in px |
-
-  ## Examples
-
-  ### Sizing
-  ```erbx
-  <%= render 'headmin/thumbnail', src: image_path("image.jpg"), width: 300, height: 100 %>
-  ```
-
-  ### Types
-  ```erbx
-  <%= render 'headmin/thumbnail', src: asset_path("document.pdf"), width: 100, height: 100 %>
-  <%= render 'headmin/thumbnail', src: asset_path("document.docx"), width: 100, height: 100 %>
-  <%= render 'headmin/thumbnail', src: asset_path("spreadsheet.xls"), width: 100, height: 100 %>
-  <%= render 'headmin/thumbnail', src: asset_path("video.mp4"), width: 100, height: 100 %>
-  ```
-
-  ## References
-  - [Bootstrap](https://getbootstrap.com/docs/5.1/content/images/#image-thumbnails)
-<% end %>
--->
-
-<% thumbnail = Headmin::Thumbnail.new(local_assigns) %>
+<% thumbnail = Headmin::ThumbnailView.new(local_assigns) %>
 
 <div class="<%= thumbnail.class_names %>" style="width: <%= thumbnail.width %>px; height: <%= thumbnail.height %>px;">
   <% if thumbnail.image? %>

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 %>