headmin 0.1.2 → 0.2.0

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

@@ -1,12 +1,13 @@
-<%#
-    name: headmin/index
-    accepts block: yes (required)
-    parameters:
-      search:
-        url: base url to send search query to
-        placeholder: placeholder for search field
+<%
+  # headmin/index
+  #
+  # === Examples
+  #   Basic version
+  #   <%= render 'headmin/index' do %#>
+  #     Index content
+  #   <% end %#>
 %>
 
-<div class="headmin-index container-fluid" data-controller="index">
+<div class="container-fluid">
   <%= yield %>
 </div>

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

@@ -1,3 +1,11 @@
+<%
+  # headmin/notifications
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/notifications" %#>
+%>
+
 <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">

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

@@ -1,13 +1,17 @@
-<%#
-    name: headmin/pagination
-    accepts block: no
-    parameters:
-      collection: Kaminari collection that accepts a method .total_count
+<%
+  # headmin/notifications
+  #
+  # ==== Options
+  # * <tt>collection</tt> - Kaminari collection that accepts a method .total_count
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/pagination, collection: @pages" %#>
 %>
 
-<div class="d-flex flex-row-reverse flex-md-row align-items-center w-100 justify-content-between justify-content-md-end">
+<div class="d-flex flex-row-reverse flex-md-row align-items-center justify-content-between justify-content-md-end my-1">
   <div class="ms-2 me-md-2 text-secondary">
     <%= t('.items', count: collection.total_count) %>
   </div>
-  <%= paginate collection, views_prefix: 'headmin' %>
+  <%= paginate collection, views_prefix: 'headmin/pagination' %>
 </div>

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

@@ -0,0 +1,26 @@
+<%
+  # headmin/popup
+  #
+  # ==== Options
+  # * <tt>id</tt> - Identifier for this popup
+  #
+  # ==== Examples
+  #   To trigger this popup create an element with a data attribute like this
+  #
+  #   <button data-popup-id="popupId">open Popup</button>
+  #   <%= render 'headmin/popup', id: 'popupId' do %#>
+  #     popup Content
+  #   <% end %#>
+  #
+  #   If you want to pass a click event to an element inside the popup without opening the popup you can use the
+  #   "data-popup-pass-thru" attribute.
+  #
+  #   <button data-popup-id="popupId" data-popup-pass-thru="#link">open Popup</button>
+  #   <%= render 'headmin/popup', id: 'popupId' do %#>
+  #     <a href="https://example.com" id="link">
+  #   <% end %#>
+%>
+
+<div class="h-popup closed" data-popup-target="popup" data-popup-id="<%= id %>">
+  <%= yield if block_given? %>
+</div>

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

@@ -1,8 +1,15 @@
-<%#
-    name: headmin/table
-    accepts block: yes
-    parameters: none
+<%
+  # headmin/table
+  #
+  # ==== Options
+  # * <tt>sort_url</tt> - U
+  #
+  # ==== Examples
+  #   <%= render 'headmin/table', sort_url: positions_admin_categories_path do %#>
+  #     table content here
+  #   <% end %#>
 %>
+
 <% sort_url = local_assigns.has_key?(:sort_url) ? sort_url : nil %>
 <div class="h-table card my-2 shadow-sm <%= 'table-drag-sort' if sort_url %>" data-sort-url="<%= sort_url %>">
   <div class="table-responsive">

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

@@ -0,0 +1,13 @@
+<%#
+    headmin/dropdown/button
+    accepts block: yes
+    parameters:
+      id: unique identifier for the dropdown
+      class: css class names as string
+%>
+<% id = local_assigns.has_key?(:id) ? id : 'dropdown-1' %>
+<% class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : 'btn' %>
+
+<a class="dropdown-toggle d-flex align-items-center <%= class_names %>" type="button" id="<%= id %>" data-bs-toggle="dropdown" aria-expanded="false">
+  <%= yield %>
+</a>

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

@@ -0,0 +1,21 @@
+<%#
+    headmin/dropdown/locale
+    accepts block: yes
+    parameters:
+      scope: (symbol) devise scope, i.e. ':users' => current_user
+%>
+
+<% scope = local_assigns.has_key?(:scope) ? scope : :users %>
+<% singular = scope.to_s.singularize.to_sym %>
+<% user = send("current_#{singular}") %>
+
+<%= render 'headmin/dropdown' do %>
+  <%= render 'headmin/dropdown/button' do %>
+    <%= user.to_s %>
+  <% end %>
+  <%= render 'headmin/dropdown/list' do %>
+    <%= render 'headmin/dropdown/item', name: t('.edit_profile'), url: polymorphic_path([:edit, singular, :registration]) %>
+    <%= render 'headmin/dropdown/divider' %>
+    <%= render 'headmin/dropdown/item', name: t('.log_out'), url: polymorphic_path([:destroy, singular, :session]), method: :delete %>
+  <% end %>
+<% end %>

data/app/views/headmin/{layout/dropdown → dropdown}/_divider.html.erb

@@ -1,5 +1,5 @@
 <%#
-    name: headmin/dropdown/item
+    headmin/dropdown/item
     accepts block: no
     parameters: none
 %>

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

@@ -0,0 +1,18 @@
+<%#
+    headmin/dropdown/item
+    accepts block: no
+    parameters:
+      name: Name of the link in the dropdown menu
+      url: Url of the link in the dropdown menu
+      method: Sets data-method of url
+%>
+
+<% method = local_assigns.has_key?(:method) ? method : nil %>
+<% url = local_assigns.has_key?(:url) ? url : '' %>
+<% name = local_assigns.has_key?(:name) ? name : '' %>
+
+<li>
+  <a class="dropdown-item" href="<%= url %>" <%= "data-method=#{method}" if method %>>
+    <%= name %>
+  </a>
+</li>

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

@@ -0,0 +1,11 @@
+<%#
+    headmin/dropdown/list
+    accepts block: yes
+    parameters:
+      id: unique identifier for the dropdown
+%>
+<% id = local_assigns.has_key?(:id) ? id : 'dropdown-1' %>
+
+<ul class="dropdown-menu" aria-labelledby="<%= id %>">
+  <%= yield %>
+</ul>

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

@@ -0,0 +1,17 @@
+<%#
+    headmin/dropdown/locale
+    accepts block: no
+    parameters: none
+%>
+
+<%= render 'headmin/dropdown' do %>
+  <%= render 'headmin/dropdown/button', id: 'locale-dropdown' do %>
+    <%= bootstrap_icon('globe', class: 'me-2') %>
+    <%= t('language_name', locale: ::I18n.locale) %>
+  <% end %>
+  <%= render 'headmin/dropdown/list', id: 'locale-dropdown' do %>
+    <% I18n.available_locales.each do |locale| %>
+      <%= render 'headmin/dropdown/item', name: t('language_name', locale: locale), url: url_for({locale: locale.to_s}) %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/headmin/filters/_date.html.erb

@@ -1,20 +1,25 @@
-<%#
-    name: headmin/filters/date_range
-    accepts block: no
-    parameters:
-      name: (string) Name of the parameter
-      label: (string) Display name
-%>
-<% label = local_assigns.has_key?(:label) ? label : nil %>
-<% name = local_assigns.has_key?(:name) ? name : nil %>
+<%
+  # headmin/filters/date
+  #
+  # ==== Options
+  # * <tt>name</tt> - Name of the filter parameter
+  # * <tt>label</tt> - Display name
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/filters/date", name: :created_at, label: 'Created at' %#>
+
+  label = local_assigns.has_key?(:label) ? label : nil
+  name = local_assigns.has_key?(:name) ? name : nil
 
-<% input_options = {
-  placeholder: 'dd/mm/yyyy',
-  class: "form-control flatpickr",
-  required: true,
-  'data-filters-target': 'input',
-  'data-action': "change->filters#update"
-} %>
+  input_options = {
+    placeholder: 'dd/mm/yyyy',
+    class: "form-control flatpickr",
+    required: true,
+    'data-filters-target': 'input',
+    'data-action': "change->filters#update"
+  }
+%>
 
 <%= content_for :filters_menu do %>
   <%= render 'headmin/filters/filter/menu_item', name: name, label: label %>

data/app/views/headmin/filters/_search.html.erb

@@ -1,22 +1,22 @@
-<%#
-    name: headmin/filters/search
-    accepts block: no
-    parameters:
-      name: (string) Name of the parameter
-      model: (Object) model to create a placeholder for
-      placeholder: (string) placeholder for search field. Defaults to model name
-%>
-<% name = local_assigns.has_key?(:name) ? name : :search %>
-<% label = local_assigns.has_key?(:label) ? label : nil %>
-<% placeholder = local_assigns.has_key?(:placeholder) ? placeholder : t('.placeholder', resource: label) %>
+<%
+  # headmin/filters/search
+  #
+  # ==== Options
+  # * <tt>name</tt> - Name of the filter parameter
+  # * <tt>label</tt> - Name of the resource to be used in the placeholder (search in ...)
+  # * <tt>placeholder</tt> - Placeholder in the search field
+  #
+  # ==== Examples
+  #   Basic version.
+  #   <%= render 'headmin/filters/search', name: :search, label: Poll.model_name.human(count: 2) %#>
+
+  name = local_assigns.has_key?(:name) ? name : :search
+  label = local_assigns.has_key?(:label) ? label : nil
+  placeholder = local_assigns.has_key?(:placeholder) ? placeholder : t('.placeholder', resource: label)
 
-<% value = filter_param_exists?(name) ? params[name] : nil %>
+  value = filter_param_exists?(name) ? params[name] : nil
+%>
 
 <% content_for :filters_search do %>
-  <div class="h-filters-search d-flex">
-    <input class="form-control me-1" type="search" placeholder="<%= raw placeholder.capitalize %>" aria-label="Search" name="<%= name %>" value="<%= value %>">
-    <button class="btn h-btn-outline-light d-none d-md-block" type="submit">
-      <%= t('.button') %>
-    </button>
-  </div>
+  <input class="form-control" type="search" placeholder="<%= raw placeholder.capitalize %>" aria-label="Search" name="<%= name %>" value="<%= value %>">
 <% end %>

data/app/views/headmin/filters/_select.html.erb

@@ -1,23 +1,28 @@
-<%#
-    name: headmin/filters/select
-    accepts block: no
-    parameters:
-      name: (string) Name of the parameter
-      label: (string) Display name
-      options: (array) List of options to select from
-%>
-<% label = local_assigns.has_key?(:label) ? label : nil %>
-<% name = local_assigns.has_key?(:name) ? name : nil %>
-<% options = local_assigns.has_key?(:options) ? options : [] %>
+<%
+  # headmin/filters/select
+  #
+  # ==== Options
+  # * <tt>name</tt> - Name of the filter parameter
+  # * <tt>label</tt> - Display name
+  # * <tt>options</tt> - List of options to select from
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render "headmin/filters/select", name: :poll_type, label: 'Type', options: [["General", "general", "Fun", "fun"]] %#>
+
+  label = local_assigns.has_key?(:label) ? label : nil
+  name = local_assigns.has_key?(:name) ? name : nil
+  options = local_assigns.has_key?(:options) ? options : []
 
-<% select_options = {
-  class: "form-select",
-  prompt: t('.blank'),
-  include_blank: false,
-  required: true,
-  'data-filters-target': 'input',
-  'data-action': "change->filters#update"
-} %>
+  select_options = {
+    class: "form-select",
+    prompt: t('.blank'),
+    include_blank: false,
+    required: true,
+    'data-filters-target': 'input',
+    'data-action': "change->filters#update"
+  }
+%>
 
 <%= content_for :filters_menu do %>
   <%= render 'headmin/filters/filter/menu_item', name: name, label: label %>
@@ -30,10 +35,10 @@
 <% end %>
 
 <%= content_for :filters_buttons do %>
-  <% if filter_param_exists?(name) %>
-    <% option_name = options.select { |value, key| params[name].include?(key.to_s)}.map{|value, key| value}.join(', ') %>
-    <%= render 'headmin/filters/filter/button', name: name, label: label, value: option_name do %>
-      <%= select_tag("#{name}[]", options_for_select(options, params[name]), select_options) %>
+  <% (params[name] || []).each_with_index do |param, index| %>
+    <% value = options.detect { |value, key, config| key == param } %>
+    <%= render 'headmin/filters/filter/button', name: name, label: label, value: value ? value.first : nil, id: "#{name}_#{index}" do %>
+      <%= select_tag("#{name}[]", options_for_select(options, param), select_options) %>
     <% end %>
   <% end %>
 <% end %>

data/app/views/headmin/filters/filter/_button.html.erb

@@ -1,22 +1,31 @@
 <%#
-    name: headmin/filters/filter/button
+    headmin/filters/filter/button
     accepts block: yes
     parameters:
       name: (string) Name of the parameter
       label: (string) Display name
       value: (string) Value of the parameter
 %>
+<% id = local_assigns.has_key?(:id) ? id : Time.now.utc.to_i %>
 <% name = local_assigns.has_key?(:name) ? name : nil %>
 <% label = local_assigns.has_key?(:label) ? label : nil %>
 <% value = local_assigns.has_key?(:value) ? value : nil %>
-<% active = local_assigns.has_key?(:active) ? active : false %>
 
-<div class="h-filter me-1" data-controller="filter" data-filters-target="button" data-filter-name="<%= name %>">
-  <button type="button" class="h-filter-button btn h-btn-outline-transparent ms-1" data-filter-target="button" data-action="click->filter#toggle click@window->filter#close" aria-expanded="<%= active ? 'true' : 'false' %>">
+<div class="h-filter me-1 my-1" data-filter-name="<%= name %>">
+
+  <button
+    type="button"
+    class="h-filter-button btn h-btn-outline-transparent"
+    data-popup-target="button"
+    data-popup-id="<%= id %>"
+    data-action="click->popup#open"
+  >
     <%= "#{label}: #{value || t('.all')}" %>
     <span class="h-filter-remove" data-action="click->filters#remove"><%= bootstrap_icon('x-lg') %></span>
   </button>
-  <div class="h-filter-popup <%= ('closed' unless active) %>" data-filter-target="popup">
+
+  <%= render 'headmin/popup', id: "#{id}" do %>
     <%= yield if block_given? %>
-  </div>
+  <% end %>
+
 </div>

data/app/views/headmin/filters/filter/_menu_item.html.erb

@@ -1,12 +1,12 @@
 <%#
-    name: headmin/filters/filter/menu_item
+    headmin/filters/filter/menu_item
     accepts block: no
     parameters:
       name: (string) Name of the parameter
       label: (string) Display name
 %>
 <li>
-  <a class="dropdown-item" href="#" data-action="click->filters#add" data-filter-name="<%= name %>">
+  <a class="dropdown-item" href="#" data-filters-target="menuItem" data-action="click->filters#add" data-filter-name="<%= name %>">
     <%= label %>
   </a>
 </li>

data/app/views/headmin/filters/filter/_template.html.erb

@@ -1,5 +1,5 @@
 <%#
-    name: headmin/filters/filter/template
+    headmin/filters/filter/template
     accepts block: yes
     parameters:
       name: (string) Name of the parameter
@@ -7,7 +7,7 @@
 %>
 
 <template data-filter-name="<%= name %>" data-filters-target="template">
-  <%= render 'headmin/filters/filter/button', name: name, label: label, value: nil, active: true do %>
+  <%= render 'headmin/filters/filter/button', name: name, label: label, value: nil, id: 'template_id' do %>
     <%= yield if block_given? %>
   <% end %>
 </template>

data/app/views/headmin/forms/_actions.html.erb

@@ -1,8 +1,8 @@
 <%#
-    name: headmin/forms/actions
+    headmin/forms/actions
     accepts block: true
     parameters:
-      form: (string) Form object
+      form: (object) Form object
 %>
 
 <div class="card forms-actions shadow-sm mb-3">
@@ -21,12 +21,8 @@
 
     <%= yield if block_given? %>
 
-    <div class="d-grid">
-      <%= link_to(t('.delete.title'),[:admin, form.object], class: 'btn btn-outline-danger', method: :delete, data: {confirm: t('.delete.confirm')}) %>
-    </div>
+    <%= render 'headmin/forms/actions/destroy', form: form %>
     <hr>
-    <div class="d-grid">
-      <%= form.submit "Opslaan", class: 'btn btn-lg btn-primary' %>
-    </div>
+    <%= render 'headmin/forms/actions/save', form: form %>
   </div>
 </div>

data/app/views/headmin/forms/_base.html.erb

@@ -0,0 +1,60 @@
+<%
+  # headmin/forms/base
+  #
+  # ==== Options
+  # * <tt>form<tt> - Form object
+  # * <tt>attribute<tt> - Name of the attribute of the form model
+  # * <tt>options<tt> - Hash with all HTML options to pass to
+  # * <tt>label<tt> - Text to show as label. Label will be hidden if value is false
+  # * <tt>required<tt> - Set to true to mark as required
+  # * <tt>float<tt> - Set to true if you want to show floating labels
+  # * <tt>append<tt> - Text or icon to be shown on the left hand side of the input, Doesn't work with float
+  # * <tt>prepend<tt> - Text or icon to be shown on the right hand side of the input, Doesn't work with float
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render 'headmin/forms/date', form: form, attribute: :title %#>
+  #
+  #   With datepicker
+  #   <%= render 'headmin/forms/text', form: form, attribute: :title, datepicker: true %#>
+
+  append = local_assigns.has_key?(:append) ? append : nil
+  float = local_assigns.has_key?(:float) ? float : false
+  label = local_assigns.has_key?(:label) ? label : nil
+  prepend = local_assigns.has_key?(:prepend) ? prepend : nil
+  required = local_assigns.has_key?(:required) ? required : false
+
+  show_label = label != false
+%>
+
+<div class="<%= 'form-floating' if float %> <%= ('mb-3 text-start' if show_label) %>">
+  <% if show_label && !float %>
+    <%= render 'headmin/forms/label', form: form, attribute: attribute, name: label, required: required %>
+  <% end %>
+
+  <% if float %>
+    <%= yield form %>
+    <%= render 'headmin/forms/validation', form: form, attribute: attribute %>
+  <% else %>
+    <div class="input-group w-100">
+      <% if prepend %>
+      <span class="input-group-text">
+        <%= prepend %>
+      </span>
+      <% end %>
+
+      <%= yield form %>
+      <%= render 'headmin/forms/validation', form: form, attribute: attribute %>
+
+      <% if append %>
+      <span class="input-group-text">
+        <%= append %>
+      </span>
+      <% end %>
+    </div>
+  <% end %>
+
+  <% if show_label && float %>
+    <%= render 'headmin/forms/label', form: form, attribute: attribute, name: label, required: required %>
+  <% end %>
+</div>

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

@@ -0,0 +1,32 @@
+<%
+  # headmin/forms/blocks
+  #
+  # ==== Options
+  # * <tt>form</tt> - Form object
+  # * <tt>path</tt> - Directory where to look for block templates
+  # * <tt>allow</tt> - Names of block templates that can be added
+  #
+  # ==== Examples
+  #   Basic version. This will only look for blocks in 'admin/blocks'
+  #   <%= render "headmin/forms/blocks", form: form %#>
+  #
+  #   Define the path to look for block templates like this:
+  #   <%= render "headmin/forms/blocks", form: form, path: '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)
+
+  templates = allowed_block_names.map { |name| BlockService.form_view(name, path: path) }
+%>
+
+<%= render 'headmin/forms/repeater', form: form, attribute: :blocks, templates: templates, label: false do |block| %>
+  <% view_path = BlockService.form_view(block.object.name, path: path).gsub('/_', '/') %>
+  <%= render view_path, form: block, name: block.object.name %>
+
+  <span class="position-absolute top-0 end-0 badge bg-light text-dark">
+    <%= block.object.name.titleize %>
+  </span>
+<% end %>

data/app/views/headmin/forms/_checkbox.html.erb

@@ -0,0 +1,39 @@
+<%
+  # headmin/forms/checkbox
+  #
+  # ==== Options
+  # * <tt>form<tt> - Form object
+  # * <tt>attribute<tt> - Name of the attribute of the form model
+  # * <tt>label<tt> - Text to show as label. Label will be hidden if value is false
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render 'headmin/forms/image', form: form, attribute: :image %#>
+
+  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : false
+  data = local_assigns.has_key?(:data) ? data : nil
+  disabled = local_assigns.has_key?(:disabled) ? disabled : false
+  label = local_assigns.has_key?(:label) ? label : nil
+  readonly = local_assigns.has_key?(:readonly) ? readonly : false
+  required = local_assigns.has_key?(:required) ? required : false
+
+  options = {
+    'aria-describedby': form_field_validation_id(form, attribute),
+    class: "form-checkbox-input #{form_field_validation_class(form, attribute)} #{class_names}",
+    data: data,
+    disabled: disabled,
+    placeholder: attribute,
+    readonly: readonly,
+    required: required,
+  }
+
+  show_label = label != false
+%>
+
+<div class="<%= ('mb-3 text-start' if show_label) %>">
+  <%= form.check_box(attribute, options) %>
+  <% if show_label %>
+    <%= render 'headmin/forms/label', form: form, attribute: attribute, name: label, required: required %>
+  <% end %>
+  <%= render 'headmin/forms/validation', form: form, attribute: attribute %>
+</div>

data/app/views/headmin/forms/_ckeditor.html.erb

@@ -0,0 +1,42 @@
+<%
+  # headmin/forms/ckeditor
+  #
+  # ==== Options
+  # * <tt>form<tt> - Form object
+  # * <tt>attribute<tt> - Name of the attribute of the form model
+  # * <tt>label<tt> - Text to show as label. Label will be hidden if value is false
+  # * <tt>toolbar<tt> - Array containing the toolbar items to display
+  # * <tt>upload_path<tt> - URL to upload images to
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render 'headmin/forms/textarea', form: form, attribute: :title %#>
+
+  class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : false
+  data = local_assigns.has_key?(:data) ? data : {}
+  disabled = local_assigns.has_key?(:disabled) ? disabled : false
+  label = local_assigns.has_key?(:label) ? label : nil
+  readonly = local_assigns.has_key?(:readonly) ? readonly : false
+  required = local_assigns.has_key?(:required) ? required : false
+  toolbar = local_assigns.has_key?(:toolbar) ? toolbar : nil
+  upload_path = local_assigns.has_key?(:upload_path) ? upload_path : ''
+
+  data = data.merge(
+    'ckeditor-toolbar': toolbar,
+    'ckeditor-upload-path': upload_path
+  )
+
+  options = {
+    'aria-describedby': form_field_validation_id(form, attribute),
+    class: "ckeditor #{form_field_validation_class(form, attribute)} #{class_names}",
+    data: data,
+    disabled: disabled,
+    placeholder: attribute,
+    readonly: readonly,
+    required: required,
+  }
+%>
+
+<%= render 'headmin/forms/base', form: form, attribute: attribute, label: label, required: required do |form| %>
+  <%= form.text_area(attribute, options) %>
+<% end %>