headmin 0.2.8 → 0.3.4

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/controllers/concerns/headmin/authentication.rb

@@ -6,4 +6,4 @@ module Headmin
       before_action :authenticate_admin!
     end
   end
-end
+end

data/app/controllers/concerns/headmin/searchable.rb

@@ -9,7 +9,7 @@ module Headmin
     end
 
     def search_params
-      @search_params ||= params[:search] && params[:search].to_s
+      @search_params ||= params[:search]&.to_s
     end
   end
 end

data/app/controllers/concerns/headmin/sortable.rb

@@ -12,8 +12,8 @@ module Headmin
 
     def sort_by_params(collection)
       sort_params.each do |key, value|
-        next unless %w(asc desc).include?(value)
-        attribute = key.gsub('sort_', '')
+        next unless %w[asc desc].include?(value)
+        attribute = key.gsub("sort_", "")
 
         # Sort on model columns first, then check for translation columns
         if collection.attribute_names.include?(attribute.to_s)
@@ -26,19 +26,19 @@ module Headmin
 
         order_scope = "order_by_#{attribute}".to_sym
         sort_scope = "sort_by_#{attribute}".to_sym
-        if collection.respond_to?(order_scope)
-          collection = collection.send(order_scope, value)
+        collection = if collection.respond_to?(order_scope)
+          collection.send(order_scope, value)
         elsif collection.respond_to?(sort_scope)
-          collection = collection.send(sort_scope, value)
+          collection.send(sort_scope, value)
         else
-          collection = collection.order(column.send(value))
+          collection.order(column.send(value))
         end
       end
       collection
     end
 
     def sort_params
-      params.permit!.select { |p| p.to_s.include?('sort_') }
+      params.permit!.select { |p| p.to_s.include?("sort_") }
     end
   end
 end

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
+end

data/app/helpers/headmin/bootstrap_helper.rb

@@ -1,9 +1,9 @@
 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
   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

@@ -13,4 +13,4 @@ module Headmin
       end
     end
   end
-end
+end

data/app/helpers/headmin/form_helper.rb

@@ -5,12 +5,16 @@ module Headmin
     end
 
     def form_field_validation_id(form, name)
-      [form.object_name, name.to_s, 'validation'].join('_').parameterize.underscore
+      [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'
+      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
@@ -33,4 +37,4 @@ module Headmin
       test.join.html_safe
     end
   end
-end
+end

data/app/helpers/headmin/notification_helper.rb

@@ -2,30 +2,30 @@ module Headmin
   module NotificationHelper
     def notification_color(name)
       color = {
-          notice: {
-              background: 'bg-success',
-              text: 'text-white'
-          },
-          error: {
-              text: 'text-dark',
-              background: 'bg-danger'
-          },
-          alert: {
-              text: 'text-dark',
-              background: 'bg-warning'
-          },
-          timedout: {
-              text: 'text-dark',
-              background: 'bg-warning'
-          },
-          fallback: {
-              text: 'text-light',
-              background: 'bg-info',
-          }
+        notice: {
+          background: "bg-success",
+          text: "text-white"
+        },
+        error: {
+          text: "text-dark",
+          background: "bg-danger"
+        },
+        alert: {
+          text: "text-dark",
+          background: "bg-warning"
+        },
+        timedout: {
+          text: "text-dark",
+          background: "bg-warning"
+        },
+        fallback: {
+          text: "text-light",
+          background: "bg-info"
+        }
       }
 
       name = name.to_sym
       color.key?(name) ? color[name] : color[:fallback]
     end
   end
-end
+end

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
@@ -33,7 +28,7 @@ module Headmin
     end
 
     def is_sort_param_key?(key)
-      key.to_s.include?('sort_')
+      key.to_s.include?("sort_")
     end
   end
-end
+end

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

@@ -3,9 +3,8 @@ module Headmin
     extend ActiveSupport::Concern
 
     included do
-
       # Associations
       belongs_to :blockable, polymorphic: true, optional: true, touch: true
     end
   end
-end
+end

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

@@ -7,4 +7,4 @@ module Headmin
       accepts_nested_attributes_for :blocks, allow_destroy: true
     end
   end
-end
+end

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

@@ -14,4 +14,4 @@ module Headmin
       has_one_attached :file
     end
   end
-end
+end

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

@@ -24,27 +24,27 @@ module Headmin
           when Hash
             fields.build(
               name: key,
-              field_type: 'group',
+              field_type: "group",
               fields: parse_fields_hash(value)
             )
           when Array
             fields.build(
               name: key,
-              field_type: 'list',
+              field_type: "list",
               fields: value.map do |item|
-                fields.new(name: 'item', field_type: 'group', fields: parse_fields_hash(item))
+                fields.new(name: "item", field_type: "group", fields: parse_fields_hash(item))
               end
             )
           when String
             fields.build(
               name: key,
-              field_type: 'text',
+              field_type: "text",
               value: value
             )
           else
             fields.build(
               name: key,
-              field_type: 'file',
+              field_type: "file",
               file: value
             )
           end
@@ -52,7 +52,7 @@ module Headmin
       end
 
       def parse_hash_tree(hash_tree)
-        Hash[hash_tree.map do |field, children|
+        hash_tree.map do |field, children|
           case field.field_type.to_sym
           when :group
             children = children.any? ? children : field.hash_tree
@@ -67,8 +67,8 @@ module Headmin
           else
             [field.name, field.value]
           end
-        end]
+        end.to_h
       end
     end
   end
-end
+end

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,78 @@
+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,51 @@
+module Headmin
+  module Form
+    class Text
+      def initialize(local_assigns, request)
+        @local_assigns = local_assigns
+        @request = request
+      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
+
+      attr_reader :local_assigns
+
+      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 nil if @request.get?
+        form.object.errors.has_key?(name) ? "is-invalid" : "is-valid"
+      end
+    end
+  end
+end

data/app/models/headmin/thumbnail.rb

@@ -0,0 +1,61 @@
+module Headmin
+  class Thumbnail
+    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 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
+      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