headmin 0.3.2 → 0.4.0

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,6 +5,5 @@ module Headmin
     include Headmin::FormHelper
     include Headmin::NotificationHelper
     include Headmin::RequestHelper
-    include Headmin::DocumentationHelper
   end
-end
+end

data/app/helpers/headmin/bootstrap_helper.rb

@@ -2,30 +2,8 @@ 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(' ')
+      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
+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

@@ -1,20 +1,14 @@
 module Headmin
   module FormHelper
-    def form_field_valid?(form, name)
-      !form.object.errors.has_key?(name)
-    end
-
+    # TODO: cleanup after input field refactoring
     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
 
+    # TODO: cleanup after input field refactoring
     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
+      form.object.errors.has_key?(name) ? "is-invalid" : "is-valid"
     end
 
     # Outputs currently present query parameters as hidden fields for a given form
@@ -37,4 +31,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,7 +3,7 @@ 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 = request.query_string.include?(query_string)
       matches_path && matches_query
@@ -28,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

@@ -3,8 +3,8 @@ module Headmin
     extend ActiveSupport::Concern
 
     included do
-      has_many :blocks, as: :blockable
+      has_many :blocks, as: :blockable, dependent: :destroy
       accepts_nested_attributes_for :blocks, allow_destroy: true
     end
   end
-end
+end

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

@@ -12,6 +12,7 @@ module Headmin
       has_many :fields, foreign_key: "parent_id"
       accepts_nested_attributes_for :fields, allow_destroy: true
       has_one_attached :file
+      accepts_nested_attributes_for :file_attachment
     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/concerns/headmin/form/autocompletable.rb

@@ -0,0 +1,38 @@
+module Headmin
+  module Form
+    module Autocompletable
+      extend ActiveSupport::Concern
+
+      included do
+        def autocomplete?
+          collection.is_a?(String) || collection.is_a?(Array)
+        end
+
+        def autocomplete_options
+          {
+            collection: collection.is_a?(Array) ? collection : []
+          }
+        end
+
+        def autocomplete_input_options
+          {
+            data: {
+              autocomplete_target: autocomplete? ? "input" : nil
+            }
+          }
+        end
+
+        def autocomplete_input_group_options
+          options = {
+            data: {
+              controller: autocomplete? ? "autocomplete" : nil,
+              autocomplete_url_value: collection.is_a?(String) ? collection : nil
+            }
+          }
+          options = options.merge(bypass: false) if autocomplete?
+          options
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/headmin/form/hintable.rb

@@ -0,0 +1,19 @@
+module Headmin
+  module Form
+    module Hintable
+      extend ActiveSupport::Concern
+
+      included do
+        def hint?
+          hint.present?
+        end
+
+        def hint_options
+          {
+            content: hint
+          }
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/headmin/form/input_groupable.rb

@@ -0,0 +1,23 @@
+module Headmin
+  module Form
+    module InputGroupable
+      extend ActiveSupport::Concern
+
+      included do
+        def input_group_options
+          default_input_group_options.merge(@input_group || {})
+        end
+
+        private
+
+        def default_input_group_options
+          {
+            bypass: !(prepend || append || @input_group),
+            prepend: prepend,
+            append: append
+          }
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/headmin/form/labelable.rb

@@ -0,0 +1,33 @@
+module Headmin
+  module Form
+    module Labelable
+      extend ActiveSupport::Concern
+      included do
+        def label?
+          label != false
+        end
+
+        def prepend_label?
+          label != false && !float
+        end
+
+        def append_label?
+          label != false && float
+        end
+
+        def label_input_group_options
+          float ? {bypass: true} : {}
+        end
+
+        def label_options
+          {
+            attribute: attribute,
+            form: form,
+            required: required,
+            text: label
+          }
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/headmin/form/listable.rb

@@ -0,0 +1,28 @@
+module Headmin
+  module Form
+    module Listable
+      extend ActiveSupport::Concern
+
+      included do
+        def list
+          datalist_id if @list
+        end
+
+        def datalist?
+          @list.present?
+        end
+
+        def datalist_options
+          {
+            collection: @list,
+            id: datalist_id
+          }
+        end
+
+        def datalist_id
+          "#{attribute}_list"
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/headmin/form/placeholderable.rb

@@ -0,0 +1,13 @@
+module Headmin
+  module Form
+    module Placeholderable
+      extend ActiveSupport::Concern
+
+      included do
+        def placeholder
+          float ? @placeholder || attribute : @placeholder
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/headmin/form/validatable.rb

@@ -0,0 +1,40 @@
+module Headmin
+  module Form
+    module Validatable
+      extend ActiveSupport::Concern
+
+      included do
+        def validation_options
+          {
+            id: validation_id,
+            message: validation_message,
+            valid: valid?
+          }
+        end
+
+        def validate?
+          form.object&.errors&.any?
+        end
+
+        private
+
+        def valid?
+          !form.object&.errors&.has_key?(attribute)
+        end
+
+        def validation_message
+          form.object&.errors&.full_messages_for(attribute)&.join(", ")
+        end
+
+        def validation_id
+          [attribute.to_s, "validation"].join("_").parameterize.underscore
+        end
+
+        def validation_class
+          return unless validate?
+          valid? ? "is-valid" : "is-invalid"
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/headmin/form/wrappable.rb

@@ -0,0 +1,21 @@
+module Headmin
+  module Form
+    module Wrappable
+      extend ActiveSupport::Concern
+
+      included do
+        def wrapper_options
+          default_wrapper_options.merge(@wrapper || {})
+        end
+
+        private
+
+        def default_wrapper_options
+          {
+            bypass: @wrapper == false
+          }
+        end
+      end
+    end
+  end
+end

data/app/models/headmin/blocks_view.rb

@@ -0,0 +1,15 @@
+module Headmin
+  class BlocksView < ViewModel
+    def show_blocks?
+      blockable&.respond_to?(:blocks)
+    end
+
+    def paths
+      @paths || []
+    end
+
+    def prefixes
+      paths + ["website/blocks", "blocks", ""]
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Headmin
+  module Form
+    class BlocksView < ViewModel
+      def repeater_options
+        keys = %i[form attribute names label]
+        options = to_h.slice(*keys)
+        default_repeater_options.merge(options)
+      end
+
+      def paths
+        @paths || []
+      end
+
+      def prefixes
+        paths + ["admin/blocks", "blocks", ""]
+      end
+
+      private
+
+      def default_repeater_options
+        {
+          attribute: "blocks",
+          label: false,
+          templates: names
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Headmin
+  module Form
+    class CheckboxView < ViewModel
+      include Headmin::Form::Hintable
+      include Headmin::Form::Labelable
+      include Headmin::Form::Validatable
+      include Headmin::Form::Wrappable
+
+      def checked_value
+        @checked_value || "1"
+      end
+
+      def unchecked_value
+        @unchecked_value || "0"
+      end
+
+      def input_options
+        keys = attributes - %i[attribute form label validate wrapper checked_value unchecked_value]
+        options = to_h.slice(*keys)
+        default_input_options.merge(options)
+      end
+
+      def label_options
+        {
+          class: ["form-check-label"],
+          attribute: attribute,
+          form: form,
+          required: required,
+          text: label
+        }
+      end
+
+      def wrapper_options
+        default_wrapper_options.merge(
+          {
+            class: %w[form-check mb-3]
+          }
+        ).merge(@wrapper || {})
+      end
+
+      private
+
+      def default_input_options
+        {
+          aria: {describedby: validation_id},
+          class: ["form-check-input", validation_class],
+          placeholder: placeholder
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Headmin
+  module Form
+    class DateRangeView < ViewModel
+      def start_options
+        default_start_options.merge(@start || {})
+      end
+
+      def end_options
+        default_end_options.merge(@end || {})
+      end
+
+      private
+
+      def default_start_options
+        keys = attributes - %i[start]
+        to_h.slice(*keys)
+      end
+
+      def default_end_options
+        keys = attributes - %i[end]
+        to_h.slice(*keys)
+      end
+    end
+  end
+end