headmin 0.2.5 → 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

@@ -1,65 +1,10 @@
 module Headmin
   module AdminHelper
+    include Headmin::BootstrapHelper
     include Headmin::FilterHelper
+    include Headmin::FormHelper
     include Headmin::NotificationHelper
-
-    def current_model
-      controller_name.classify.constantize
-    end
-
-    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) {}
-    end
-
-    def current_url?(url)
-      uri = URI(url)
-      path = uri.path
-      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
-    end
-
-    def form_field_valid?(form, name)
-      !form.object.errors.has_key?(name)
-    end
-
-    def form_field_validation_id(form, name)
-      [form.object_name, name.to_s, 'validation'].join('_').parameterize.underscore
-    end
-
-    def form_field_validation_class(form, name)
-      return nil if request.get?
-      form.object.errors.has_key?(name) ? 'is-invalid' : 'is-valid'
-    end
-
-    def default_params
-      params.select { |key, value| is_default_param?(key) }
-    end
-
-    def add_default_param_key(key)
-      keys = default_param_keys || []
-      keys.push(key)
-      @default_param_keys = keys
-    end
-
-    def default_param_keys
-      @default_param_keys ||= [:page, :start, :length, :per_page]
-    end
-
-    def is_default_param?(key)
-      default_param_keys.include?(key.to_sym) || is_sort_param_key?(key)
-    end
-
-    def is_sort_param_key?(key)
-      key.to_s.include?('sort_')
-    end
+    include Headmin::RequestHelper
+    include Headmin::DocumentationHelper
   end
 end

data/app/helpers/headmin/bootstrap_helper.rb

@@ -0,0 +1,31 @@
+module Headmin
+  module BootstrapHelper
+    def bootstrap_icon(icon, options = {})
+      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/filter_helper.rb

@@ -1,11 +1,15 @@
 module Headmin
   module FilterHelper
     def filter_param_exists?(name)
-      return false unless params.has_key?(name)
+      filter_param(name).present?
+    end
+
+    def filter_param(name)
+      return nil unless params.has_key?(name)
       if params[name].is_a?(Array)
-        params[name].reject { |c| c.empty? }.present?
+        params[name].reject { |c| c.empty? }
       else
-        params[name].present?
+        params[name]
       end
     end
   end

data/app/helpers/headmin/form_helper.rb

@@ -0,0 +1,40 @@
+module Headmin
+  module FormHelper
+    def form_field_valid?(form, name)
+      !form.object.errors.has_key?(name)
+    end
+
+    def form_field_validation_id(form, name)
+      [form.object_name, name.to_s, 'validation'].join('_').parameterize.underscore
+    end
+
+    def form_field_validation_class(form, name)
+      return nil if request.get?
+      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
+    #
+    # <%= form.hidden_input :amount, value: 1 %>
+    # <%= form.hidden_input :'type[]', value: 'food' %>
+    # <%= form.hidden_input :'type[]', value: 'beverage' %>
+    def query_parameter_fields(form)
+      test = request.query_parameters.map do |name, value|
+        if value.is_a?(Array)
+          value.map do |value_element|
+            form.hidden_field "#{name}[]", value: value_element
+          end.join
+        else
+          form.hidden_field name, value: value
+        end
+      end
+      test.join.html_safe
+    end
+  end
+end

data/app/helpers/headmin/request_helper.rb

@@ -0,0 +1,34 @@
+module Headmin
+  module RequestHelper
+    def current_url?(url)
+      uri = URI(url)
+      path = uri.path
+      query_string = uri.query || ''
+      matches_path = request.path.include?(path)
+      matches_query = request.query_string.include?(query_string)
+      matches_path && matches_query
+    end
+
+    def default_params
+      params.select { |key, value| is_default_param?(key) }
+    end
+
+    def add_default_param_key(key)
+      keys = default_param_keys || []
+      keys.push(key)
+      @default_param_keys = keys
+    end
+
+    def default_param_keys
+      @default_param_keys ||= [:page, :start, :length, :per_page]
+    end
+
+    def is_default_param?(key)
+      default_param_keys.include?(key.to_sym) || is_sort_param_key?(key)
+    end
+
+    def is_sort_param_key?(key)
+      key.to_s.include?('sort_')
+    end
+  end
+end

data/app/models/concerns/headmin/fieldable.rb

@@ -7,7 +7,9 @@ module Headmin
       accepts_nested_attributes_for :fields, allow_destroy: true
 
       def fields_hash
-        parse_hash_tree(fields.hash_tree)
+        fields.order(position: :asc).map do |field|
+          parse_hash_tree(field.hash_tree)
+        end.reduce({}, :merge)
       end
 
       def fields_hash=(hash)

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

@@ -1,10 +1,7 @@
 class BlockService
   def self.block_names(path:)
     form_views(path: path).map do |view|
-      filename = File.basename(view, '.html.erb')
-
-      # Removes leading _ if exists
-      filename.sub!(/^_/, '')
+      view_name(view)
     end
   end
 
@@ -24,6 +21,13 @@ class BlockService
     views(form_view_paths(path))
   end
 
+  def self.view_name(view)
+    filename = File.basename(view.split('.')[0])
+
+    # Removes leading _ if exists
+    filename.sub(/^_/, '')
+  end
+
   private
 
   # Looks for a block view by its name.

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

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html>
+<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,10 +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>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.
@@ -17,12 +20,13 @@
   #      Your content
   #   <% end %#>
 
+  id = local_assigns.has_key?(:id) ? id : nil
   title = local_assigns.has_key?(:title) ? title : nil
   description = local_assigns.has_key?(:description) ? description : nil
   padded = local_assigns.has_key?(:padded) ? padded : true
 %>
 
-<div class="card mb-3 shadow-sm">
+<div class="card mb-3 shadow-sm" id="<%= id %>">
 
   <% if padded || title || description %>
     <div class="card-body">
@@ -36,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.url
+  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,24 +26,22 @@
     <%= 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) %>
+        <% if content_for?(:filters_menu) && content_for?(:filters_search) %>
           <div class="vr mx-2"></div>
         <% end %>
       </div>
 
       <!-- Menu -->
       <div class="h-filters-menu d-flex align-items-center w-auto my-1">
-        <% if content_for :filters_menu %>
+        <% 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') %>
@@ -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) }
+%>