headmin 0.2.8 → 0.3.1

data/app/assets/stylesheets/headmin.scss

@@ -0,0 +1,65 @@
+// Bootstrap icons
+@import url("https://cdn.jsdelivr.net/npm/bootstrap-icons@1.5.0/font/bootstrap-icons.css");
+
+// Bootstrap
+@import "headmin/vendor/bootstrap/scss/functions";
+@import "headmin/vendor/bootstrap/scss/functions";
+@import "headmin/vendor/bootstrap/scss/functions";
+@import "headmin/vendor/bootstrap/scss/variables";
+@import "headmin/vendor/bootstrap/scss/mixins";
+@import "headmin/vendor/bootstrap/scss/utilities";
+@import "headmin/overrides/bootstrap";
+@import "headmin/vendor/bootstrap/scss/root";
+@import "headmin/vendor/bootstrap/scss/reboot";
+@import "headmin/vendor/bootstrap/scss/type";
+@import "headmin/vendor/bootstrap/scss/images";
+@import "headmin/vendor/bootstrap/scss/containers";
+@import "headmin/vendor/bootstrap/scss/grid";
+@import "headmin/vendor/bootstrap/scss/tables";
+@import "headmin/vendor/bootstrap/scss/forms";
+@import "headmin/vendor/bootstrap/scss/buttons";
+@import "headmin/vendor/bootstrap/scss/transitions";
+@import "headmin/vendor/bootstrap/scss/dropdown";
+@import "headmin/vendor/bootstrap/scss/button-group";
+@import "headmin/vendor/bootstrap/scss/nav";
+@import "headmin/vendor/bootstrap/scss/navbar";
+@import "headmin/vendor/bootstrap/scss/card";
+@import "headmin/vendor/bootstrap/scss/accordion";
+@import "headmin/vendor/bootstrap/scss/breadcrumb";
+@import "headmin/vendor/bootstrap/scss/pagination";
+@import "headmin/vendor/bootstrap/scss/badge";
+@import "headmin/vendor/bootstrap/scss/alert";
+@import "headmin/vendor/bootstrap/scss/progress";
+@import "headmin/vendor/bootstrap/scss/list-group";
+@import "headmin/vendor/bootstrap/scss/close";
+@import "headmin/vendor/bootstrap/scss/toasts";
+@import "headmin/vendor/bootstrap/scss/modal";
+@import "headmin/vendor/bootstrap/scss/tooltip";
+@import "headmin/vendor/bootstrap/scss/popover";
+@import "headmin/vendor/bootstrap/scss/carousel";
+@import "headmin/vendor/bootstrap/scss/spinners";
+@import "headmin/vendor/bootstrap/scss/helpers";
+@import "headmin/vendor/bootstrap/scss/utilities/api";
+
+// Tom select
+@import "headmin/vendor/tom-select-bootstrap";
+
+// Flatpickr
+@import "headmin/vendor/flatpickr";
+
+// Redactor
+@import "headmin/vendor/redactorx";
+@import "headmin/overrides/redactorx";
+
+// Headmin
+@import "headmin/filters";
+@import "headmin/form";
+@import "headmin/general";
+@import "headmin/layout";
+@import "headmin/login";
+@import "headmin/table";
+@import "headmin/utilities";
+@import "headmin/filter";
+@import "headmin/popup";
+@import "headmin/thumbnail";
+@import "headmin/syntax";

data/app/helpers/headmin/admin_helper.rb

@@ -5,5 +5,6 @@ module Headmin
     include Headmin::FormHelper
     include Headmin::NotificationHelper
     include Headmin::RequestHelper
+    include Headmin::DocumentationHelper
   end
 end

data/app/helpers/headmin/bootstrap_helper.rb

@@ -1,9 +1,31 @@
 module Headmin
   module BootstrapHelper
     def bootstrap_icon(icon, options = {})
-      data = options.has_key?(:data) ? options[:data] : nil
-      klass = options.has_key?(:class) ? options[:class] : nil
-      content_tag(:i, class: "bi bi-#{icon} #{klass}", data: data) {}
+      tag_name = options.extract!(:tag_name).fetch(:tag_name, :i)
+      options[:class] = ['bi', "bi-#{icon}", options.dig(:class)].compact.join(' ')
+      content_tag(tag_name, options) {}
+    end
+
+    # References
+    # https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
+    def bootstrap_icon_for_mime_type(mime_type, options = {})
+      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],
+      }
+      icon_name = type_map.find{|key, mime_types| mime_types.include?(mime_type)}.first
+
+      icon = ['file', 'earmark', icon_name].compact.join('-')
+      bootstrap_icon(icon, options)
     end
   end
 end

data/app/helpers/headmin/documentation_helper.rb

@@ -0,0 +1,35 @@
+module Headmin
+  module DocumentationHelper
+    def extract_documentation(text)
+      # Get content inside documentation block
+      starts_with = '<% documentation do %>\n'
+      ends_with = '\n<% end %>'
+      between = text[/#{starts_with}(.*?)#{ends_with}/m, 1]
+
+      # Remove leading whitespaces from each line
+      between.lines.map { |line| line.sub('  ', '') }.join
+    end
+
+    def markdown_to_html(text)
+      renderer = Headmin::DocumentationRenderer.new(escape_html: true)
+      markdown = Redcarpet::Markdown.new(renderer, tables: true, fenced_code_blocks: true)
+      markdown.render(text)
+    end
+
+    def documentation(template = nil)
+      # Disable rendering inside block
+      return if block_given?
+
+      # Read contents of template
+      content = @lookup_context.find_template(template, nil, true).encode!
+
+      # Extract documentation
+      content = extract_documentation(content)
+
+      # Convert markdown into HTML
+      html = markdown_to_html(content)
+
+      raw html
+    end
+  end
+end

data/app/helpers/headmin/form_helper.rb

@@ -13,6 +13,10 @@ module Headmin
       form.object.errors.has_key?(name) ? 'is-invalid' : 'is-valid'
     end
 
+    def human_attribute_name(attribute)
+      attribute.to_s.humanize
+    end
+
     # Outputs currently present query parameters as hidden fields for a given form
     #
     # https://example.com/products?amount=1&type[]=food&type[]=beverage

data/app/helpers/headmin/request_helper.rb

@@ -3,15 +3,10 @@ module Headmin
     def current_url?(url)
       uri = URI(url)
       path = uri.path
-      query_string = uri.query
+      query_string = uri.query || ''
       matches_path = request.path.include?(path)
-      matches_query = uri.query ? request.query_string.include?(query_string) : true
-      is_root = request.fullpath == url
-      if url == admin_root_path
-        is_root
-      else
-        matches_path && matches_query
-      end
+      matches_query = request.query_string.include?(query_string)
+      matches_path && matches_query
     end
 
     def default_params

data/app/models/headmin/documentation_renderer.rb

@@ -0,0 +1,32 @@
+module Headmin
+  class DocumentationRenderer < Redcarpet::Render::HTML
+    def block_code(code, language)
+      if language == "erbx"
+        "<div class=\"card mb-3\"><div class=\"card-body\">#{render_code(code)}</div><div class=\"card-footer\"><pre><code class=\"h-syntax\">#{highlight_syntax(code, 'erb')}</code></pre></div></div>"
+      else
+        "<pre><code class=\"h-syntax\">#{highlight_syntax(code, language)}</code></pre></div>"
+      end
+    end
+
+    def table(header, body)
+      "<table class=\"table table-sm\">#{header}#{body}</table>"
+    end
+
+    private
+
+    def highlight_syntax(code, language)
+      formatter = Rouge::Formatters::HTML.new
+      lexer = Rouge::Lexer.find(language)
+      formatter.format(lexer.lex(code))
+    end
+
+    def render_code(code)
+      ApplicationController.renderer.new(
+        'action_dispatch.request.path_parameters' => {
+          controller: 'main',
+          action: 'index'
+        }
+      ).render(inline: code)
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module Headmin
+  module Form
+    class Base
+      def initialize(local_assigns)
+        @local_assigns = local_assigns
+      end
+
+      def class_names
+        class_names = [@local_assigns[:class]]
+        class_names << "form-floating" if float
+        class_names << "mb-3 text-start"
+        class_names.join(" ")
+      end
+
+      def data
+        @local_assigns[:data]
+      end
+
+      def label_options
+        {
+          attribute: attribute,
+          class: "d-block",
+          for: id,
+          form: form,
+          required: required,
+          text: label
+        }
+      end
+
+      def required
+        @local_assigns[:required]
+      end
+
+      def form
+        @local_assigns[:form]
+      end
+
+      def id
+        @local_assigns[:id]
+      end
+
+      def validation_options
+        {
+          attribute: attribute,
+          form: form
+        }
+      end
+
+      def attribute
+        @local_assigns[:attribute]
+      end
+
+      def list
+        @local_assigns[:list]
+      end
+
+      def list_id
+        list ? "#{attribute}_list" : nil
+      end
+
+      def append
+        @local_assigns[:append]
+
+      end
+
+      def prepend
+        @local_assigns[:prepend]
+      end
+
+      def float
+        @local_assigns[:float] || false
+      end
+
+      def label
+        @local_assigns[:label]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Headmin
+  module Form
+    class Text
+      def initialize(local_assigns)
+        @local_assigns = local_assigns
+      end
+
+      def placeholder
+        @local_assigns[:float] ? @local_assigns[:placeholder] || attribute : @local_assigns[:placeholder]
+      end
+
+      def attribute
+        @local_assigns[:attribute]
+      end
+
+      def form
+        @local_assigns[:form]
+      end
+
+      def options
+        option_keys = %i(aria autocomplete autofocus data disabled id maxlength minlength list pattern placeholder readonly required spellcheck size value)
+        @local_assigns.slice(*option_keys).merge(
+          aria: { describedby: form_field_validation_id(form, attribute) },
+          class: ["form-control", form_field_validation_class(form, attribute)].join(" "),
+          list: @local_assigns[:list] ? "#{attribute}_list" : nil,
+          placeholder: placeholder
+        )
+      end
+
+      def local_assigns
+        @local_assigns
+      end
+
+      def form_field_valid?(form, name)
+        return unless form.object
+
+        !form.object.errors.has_key?(name)
+      end
+
+      def form_field_validation_id(form, name)
+        return unless form.object
+
+        [form.object_name, name.to_s, "validation"].join("_").parameterize.underscore
+      end
+
+      def form_field_validation_class(form, name)
+        return unless form.object
+
+        "is-invalid" if form.object.errors.has_key?(name)
+      end
+    end
+  end
+end

data/app/services/block_service.rb

@@ -22,7 +22,7 @@ class BlockService
   end
 
   def self.view_name(view)
-    filename = File.basename(view, '.html.erb')
+    filename = File.basename(view.split('.')[0])
 
     # Removes leading _ if exists
     filename.sub(/^_/, '')

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

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="<%= I18n.locale %>">
+<html lang="<%= I18n.locale %>" data-controller="headmin">
 <head>
   <title>Admin</title>
   <meta name="viewport" content="width=device-width,initial-scale=1">

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

@@ -2,8 +2,8 @@
   # headmin/blocks
   #
   # ==== Options
-  # * <tt>blockable</tt> - Object with blocks association
-  # * <tt>path</tt> - Directory where to look for block templates
+  # * +blockable</tt> - Object with blocks association
+  # * +path</tt> - Directory where to look for block templates
   #
   # ==== Examples
   #   Basic version. This will only look for blocks in 'website/blocks'

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

@@ -2,7 +2,7 @@
   # headmin/breadcrumbs
   #
   # ==== Options
-  # * <tt>breadcrumbs</tt> - Object with blocks association
+  # * +breadcrumbs</tt> - Object with blocks association
   #
   # ==== Examples
   #   Basic version. This will use the publicly available `breadcrumbs` variable

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

@@ -1,11 +1,13 @@
+<% warn "[DEPRECATION] `headmin/card` is deprecated. Please use plain Bootstrap markup." %>
 <%
+  # DEPRECATED in 0.3
   # headmin/card
   #
   # ==== Options
-  # * <tt>title</tt> - Title for card
-  # * <tt>description</tt> - Description for card
-  # * <tt>id</tt> - HTML Id Attribute
-  # * <tt>padded</tt> - Set to true if you want to render the block content inside the card-body element
+  # * +title</tt> - Title for card
+  # * +description</tt> - Description for card
+  # * +id</tt> - HTML Id Attribute
+  # * +padded</tt> - Set to true if you want to render the block content inside the card-body element
   #
   # ==== Examples
   #   Basic version.
@@ -38,13 +40,13 @@
 
       <!-- Render inside body-->
       <% if padded %>
-        <%= yield if block_given? %>
+        <%= yield %>
       <% end %>
     </div>
   <% end %>
 
   <!-- Render outside body-->
   <% unless padded %>
-    <%= yield if block_given? %>
+    <%= yield %>
   <% end %>
 </div>

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

@@ -2,7 +2,7 @@
   # headmin/dropdown
   #
   # ==== Options
-  # * <tt>class</tt> - Custom class names to put on the dropdown
+  # * +class</tt> - Custom class names to put on the dropdown
   #
   # ==== Examples
   #   Basic version

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

@@ -2,16 +2,21 @@
   # headmin/filters
   #
   # ==== Options
-  # * <tt>url</tt> - Base url to send filter query to. Defaults to current URL
+  # * +url</tt> - Base url to send filter query to. Defaults to current URL
   #
   # ==== Examples
   #   Basic version
-  #   <%= render "headmin/filters" %#>
+  #   <%= render "headmin/filters" do %#>
+  #     <%= 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
+
+  # Perform yield in order to capture content blocks
+  yield
 %>
 
 <form action="<%= action %>" data-controller="filters" data-filters-target="form">
@@ -21,14 +26,12 @@
     <%= hidden_field_tag(name.to_sym, value) %>
   <% end %>
 
-  <%= yield if block_given? %>
-
-  <div class="d-flex flex-column flex-md-row align-content-start align-items-md-center">
+  <div class="d-flex flex-column flex-md-row align-content-start align-items-md-start">
     <div class="d-flex align-items-center">
 
       <!-- Search -->
       <div class="h-filters-search d-flex my-1 w-100">
-        <%= content_for :filters_search %>
+        <%= yield :filters_search %>
 
         <!-- Separator -->
         <% if content_for?(:filters_menu) && content_for?(:filters_search) %>
@@ -60,10 +63,19 @@
 
     <!-- Filter list -->
     <div class="h-filter-list d-flex ms-md-1 flex-wrap" data-filters-target="list">
-      <%= content_for :filters_buttons %>
+      <%= yield :filters_buttons %>
     </div>
   </div>
 
   <!-- Filter templates -->
-  <%= content_for :filters_templates %>
+  <%= yield :filters_templates %>
 </form>
+
+
+<%
+  # Clears content blocks to make this view reusable
+  content_for(:filters_search, flush: true) { concat(nil) }
+  content_for(:filters_menu, flush: true) { concat(nil) }
+  content_for(:filters_buttons, flush: true) { concat(nil) }
+  content_for(:filters_templates, flush: true) { concat(nil) }
+%>

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

@@ -2,20 +2,20 @@
   # headmin/form
   #
   # ==== Options
-  # * <tt>model<tt> - A model to infer :url and :scope
-  # * <tt>scope<tt> - The scope to prefix input field names with
-  # * <tt>url<tt> - The URL the form submits to
-  # * <tt>format<tt> - The format of the route the form submits to
-  # * <tt>namespace<tt> - A namespace for your form to ensure uniqueness of id attributes on form elements
-  # * <tt>method<tt> - The method to use when submitting the form
-  # * <tt>authenticity_token<tt> - Authenticity token to use in the form
-  # * <tt>local<tt> - By default form submits are remote and unobtrusive XHRs
-  # * <tt>skip_enforcing_utf8<tt> - If set to true, a hidden input with name utf8 is not output
-  # * <tt>builder<tt> - Override the object used to build the form
-  # * <tt>html<tt> - Other optional HTML attributes for the form tag
-  # * <tt>id<tt> - Optional HTML id attribute
-  # * <tt>class<tt> - Optional HTML class attribute
-  # * <tt>data<tt> - Optional HTML data attributes
+  # * +model+ - A model to infer :url and :scope
+  # * +scope+ - The scope to prefix input field names with
+  # * +url+ - The URL the form submits to
+  # * +format+ - The format of the route the form submits to
+  # * +namespace+ - A namespace for your form to ensure uniqueness of id attributes on form elements
+  # * +method+ - The method to use when submitting the form
+  # * +authenticity_token+ - Authenticity token to use in the form
+  # * +local+ - By default form submits are remote and unobtrusive XHRs
+  # * +skip_enforcing_utf8+ - If set to true, a hidden input with name utf8 is not output
+  # * +builder+ - Override the object used to build the form
+  # * +html+ - Other optional HTML attributes for the form tag
+  # * +id+ - Optional HTML id attribute
+  # * +class+ - Optional HTML class attribute
+  # * +data+ - Optional HTML data attributes
   #
   # === Examples
   #   Basic version

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

@@ -9,5 +9,5 @@
 %>
 
 <div class="h-heading d-flex flex-column flex-md-row align-items-start align-items-md-end justify-content-between">
-  <%= yield if block_given? %>
+  <%= yield %>
 </div>

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

@@ -8,7 +8,7 @@
 
 <div class="toast-container position-absolute top-0 end-0 p-3">
   <% flash.each do |name, message| %>
-    <div class="toast align-items-center text-white show <%= notification_color(name.to_sym)[:background] %>" role="alert" aria-live="assertive" aria-atomic="true">
+    <div class="toast align-items-center text-white show <%= notification_color(name.to_sym)[:background] %>" role="alert" aria-live="assertive" aria-atomic="true" data-controller="toast">
       <div class="d-flex">
         <div class="toast-body <%= notification_color(name.to_sym)[:text] %>">
           <%= message %>

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

@@ -2,7 +2,7 @@
   # headmin/notifications
   #
   # ==== Options
-  # * <tt>collection</tt> - Kaminari collection that accepts a method .total_count
+  # * +collection</tt> - Kaminari collection that accepts a method .total_count
   #
   # ==== Examples
   #   Basic version

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

@@ -2,7 +2,7 @@
   # headmin/popup
   #
   # ==== Options
-  # * <tt>id</tt> - Identifier for this popup
+  # * +id</tt> - Identifier for this popup
   #
   # ==== Examples
   #   To trigger this popup create an element with a data attribute like this
@@ -19,8 +19,14 @@
   #   <%= 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)
+  }
 %>
 
-<div class="h-popup closed" data-popup-target="popup" data-popup-id="<%= id %>">
-  <%= yield if block_given? %>
-</div>
+<%= content_tag(:div, options) do %>
+  <%= yield %>
+<% end %>

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

@@ -2,7 +2,7 @@
   # headmin/table
   #
   # ==== Options
-  # * <tt>sort_url</tt> - Url to post object ids to in the order of positions
+  # * +sort_url</tt> - Url to post object ids to in the order of positions
   #
   # ==== Examples
   #   <%= render 'headmin/table', sort_url: positions_admin_categories_path do %#>
@@ -20,7 +20,7 @@
            data-table-target="table"
            data-table-url-value="<%= sort_url %>"
            data-table-count-value="<%= total_count %>">
-      <%= yield if block_given? %>
+      <%= yield %>
     </table>
   </div>
 </div>

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

@@ -0,0 +1,47 @@
+<%
+  # 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 %#>
+
+  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>
+  <% else %>
+    <div class="h-thumbnail-bg">
+      <%= src ? File.extname(src) : 'nil' %>
+      <%= mime_type %>
+      <% if mime_type %>
+        <%= bootstrap_icon_for_mime_type(mime_type, class: 'h-thumbnail-icon') %>
+      <% else %>
+        <%= bootstrap_icon('question', class: 'h-thumbnail-icon') %>
+      <% end %>
+    </div>
+  <% end %>
+</div>

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

@@ -2,8 +2,8 @@
   # headmin/dropdown/devise
   #
   # ==== Options
-  # * <tt>scope</tt> - (symbol) devise scope, i.e. ':users' => current_user
-  # * <tt>class</tt> - Custom class names to put on the dropdown
+  # * +scope</tt> - (symbol) devise scope, i.e. ':users' => current_user
+  # * +class</tt> - Custom class names to put on the dropdown
   #
   # ==== Examples
   #   Basic version