headmin 0.1.1

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

@@ -0,0 +1,5 @@
+module Headmin
+  module Filter
+    include Headmin::FilterHelper
+  end
+end

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

@@ -0,0 +1,23 @@
+module Headmin
+  module Pagination
+    def paginate(collection)
+      @records_filtered = collection.count
+      collection.page(page).per(per_page)
+    end
+
+    def page
+      if params[:page]
+        params[:page]
+      elsif params[:start]
+        (params[:start].to_i / per_page) + 1
+      else
+        1
+      end
+    end
+
+    def per_page
+      length = (params[:per_page] || params[:length]).to_i
+      length > 0 ? length : 24
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Headmin
+  module Searchable
+    def search(collection)
+      if search_params&.present?
+        collection.search(search_params)
+      else
+        collection
+      end
+    end
+
+    def search_params
+      @search_params ||= params[:search] && params[:search].to_s
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Headmin
+  module Sortable
+    def sort(collection)
+      if sort_params.to_h.any?
+        sort_by_params(collection)
+      elsif collection.attribute_names.include?(:created_at.to_s)
+        collection.order(created_at: :desc)
+      else
+        collection
+      end
+    end
+
+    def sort_by_params(collection)
+      sort_params.each do |key, value|
+        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)
+          column = collection.arel_table[attribute]
+        elsif collection.respond_to?(:translation_class) && collection.translation_class.attribute_names.include?(attribute.to_s)
+          column = collection.translation_class.arel_table[attribute]
+        else
+          next
+        end
+
+        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)
+        elsif collection.respond_to?(sort_scope)
+          collection = collection.send(sort_scope, value)
+        else
+          collection = collection.order(column.send(value))
+        end
+      end
+      collection
+    end
+
+    def sort_params
+      params.permit!.select { |p| p.to_s.include?('sort_') }
+    end
+  end
+end

data/app/helpers/headmin/admin_helper.rb

@@ -0,0 +1,65 @@
+module Headmin
+  module AdminHelper
+    include Headmin::FilterHelper
+    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 menu_item_active?(link)
+      uri = URI(link)
+      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 == link
+      if link == 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
+  end
+end

data/app/helpers/headmin/filter_helper.rb

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

data/app/helpers/headmin/notification_helper.rb

@@ -0,0 +1,31 @@
+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',
+          }
+      }
+
+      name = name.to_sym
+      color.key?(name) ? color[name] : color[:fallback]
+    end
+  end
+end

data/app/views/admin/users/confirmations/new.html.erb

@@ -0,0 +1,9 @@
+<%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: {method: :post}) do |f| %>
+  <%= render "admin/users/shared/error_messages", resource: resource %>
+
+  <%= render 'headmin/forms/fields/email', form: f, attribute: :email, required: true, label: :float %>
+
+  <%= f.submit t('.resend'), class: 'btn btn-lg btn-primary w-100' %>
+
+  <%= render "admin/users/shared/links" %>
+<% end %>

data/app/views/admin/users/mailer/confirmation_instructions.html.erb

@@ -0,0 +1,5 @@
+<p><%= t('.welcome', email: @email) %></p>
+
+<p><%= t('.confirm_email') %></p>
+
+<p><%= link_to t('.confirm'), confirmation_url(@resource, confirmation_token: @token) %></p>

data/app/views/admin/users/mailer/email_changed.html.erb

@@ -0,0 +1,7 @@
+<p><%= t('.greeting', email: @email) %></p>
+
+<% if @resource.try(:unconfirmed_email?) %>
+  <p><%= t('.email_is_changing_to', email: @resource.unconfirmed_email) %></p>
+<% else %>
+  <p><%= t('.email_is_changed_to', email: @resource.email) %></p>
+<% end %>

data/app/views/admin/users/mailer/password_change.html.erb

@@ -0,0 +1,3 @@
+<p><%= t('.greeting', email: @resource.email) %></p>
+
+<p><%= t('.password_has_changed') %></p>

data/app/views/admin/users/mailer/reset_password_instructions.html.erb

@@ -0,0 +1,8 @@
+<p><%= t('.greeting', email: @resource.email) %></p>
+
+<p><%= t('.someone_requested') %></p>
+
+<p><%= link_to t('.change'), edit_password_url(@resource, reset_password_token: @token) %></p>
+
+<p><%= t('.not_requested')%></p>
+<p><%= t('.password_not_changed_until') %></p>

data/app/views/admin/users/mailer/unlock_instructions.html.erb

@@ -0,0 +1,7 @@
+<p><%= t('.greeting', email: @resource.email) %></p>
+
+<p><%= t('.account_locked') %></p>
+
+<p><%= t('.click_link') %></p>
+
+<p><%= link_to t('.unlock_account'), unlock_url(@resource, unlock_token: @token) %></p>

data/app/views/admin/users/passwords/edit.html.erb

@@ -0,0 +1,12 @@
+<%= form_for(resource, as: resource_name, url: password_path(resource_name), html: {method: :put}) do |f| %>
+  <%= render "admin/users/shared/error_messages", resource: resource %>
+
+  <%= f.hidden_field :reset_password_token %>
+
+  <%= render 'headmin/forms/fields/password', form: f, attribute: :password, required: true, label: :float %>
+  <%= render 'headmin/forms/fields/password', form: f, attribute: :password_confirmation, required: true, label: :float %>
+
+  <%= f.submit t('.change_password'), class: 'btn btn-lg btn-primary w-100' %>
+
+  <%= render "admin/users/shared/links" %>
+<% end %>

data/app/views/admin/users/passwords/new.html.erb

@@ -0,0 +1,9 @@
+<%= form_for(resource, as: resource_name, url: password_path(resource_name), html: {method: :post}) do |f| %>
+  <%= render "admin/users/shared/error_messages", resource: resource %>
+
+  <%= render 'headmin/forms/fields/email', form: f, attribute: :email, required: true, label: :float %>
+
+  <%= f.submit t('.send_instructions'), class: 'btn btn-lg btn-primary w-100' %>
+
+  <%= render "admin/users/shared/links" %>
+<% end %>

data/app/views/admin/users/registrations/edit.html.erb

@@ -0,0 +1,24 @@
+<div>
+  <%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: {method: :put}) do |f| %>
+    <%= render "admin/users/shared/error_messages", resource: resource %>
+
+    <%= render 'headmin/forms/fields/email', form: f, attribute: :email, required: true, label: :float %>
+
+    <% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
+      <div><%= t('.waiting_confirmation', email: resource.unconfirmed_email) %></div>
+    <% end %>
+
+    <%= render 'headmin/forms/fields/password', form: f, attribute: :password, required: true, label: :float %>
+    <%= render 'headmin/forms/fields/password', form: f, attribute: :password_confirmation, required: true, label: :float %>
+    <%= render 'headmin/forms/fields/password', form: f, attribute: :current_password, required: true, label: :float %>
+
+    <%= f.submit t('.change'), class: 'btn btn-lg btn-primary w-100' %>
+  <% end %>
+
+  <div class="mt-5">
+    <h4><%= t('.cancel') %></h4>
+
+    <p><%= t('.unhappy') %></p>
+    <%= button_to t('.cancel'), registration_path(resource_name), class: 'btn btn-lg btn-danger w-100', data: {confirm: "Are you sure?"}, method: :delete %>
+  </div>
+</div>

data/app/views/admin/users/registrations/new.html.erb

@@ -0,0 +1,11 @@
+<%= form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
+  <%= render "admin/users/shared/error_messages", resource: resource %>
+
+  <%= render 'headmin/forms/fields/email', form: f, attribute: :email, required: true, label: :float %>
+  <%= render 'headmin/forms/fields/password', form: f, attribute: :password, required: true, label: :float %>
+  <%= render 'headmin/forms/fields/password', form: f, attribute: :password_confirmation, required: true, label: :float %>
+
+  <%= f.submit t('.sign_up'), class: 'btn btn-lg btn-primary w-100' %>
+
+  <%= render "admin/users/shared/links" %>
+<% end %>

data/app/views/admin/users/sessions/new.html.erb

@@ -0,0 +1,13 @@
+<%= form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
+
+  <%= render 'headmin/forms/fields/email', form: f, attribute: :email, required: true, label: :float %>
+  <%= render 'headmin/forms/fields/password', form: f, attribute: :password, required: true, label: :float %>
+
+  <% if devise_mapping.rememberable? %>
+    <%= render 'headmin/forms/fields/checkbox', form: f, attribute: :remember_me, label: true %>
+  <% end %>
+
+  <%= f.submit t('.login'), class: 'btn btn-lg btn-primary w-100' %>
+
+  <%= render "admin/users/shared/links" %>
+<% end %>

data/app/views/admin/users/shared/_error_messages.html.erb

@@ -0,0 +1,7 @@
+<% if resource.errors.any? %>
+  <% resource.errors.full_messages.each do |message| %>
+    <div class="alert alert-danger" role="alert">
+      <%= message %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/admin/users/shared/_links.html.erb

@@ -0,0 +1,27 @@
+<div class="bg-light mt-5 text-end">
+<%- if controller_name != 'sessions' %>
+  <%= link_to "Log in", new_session_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.registerable? && controller_name != 'registrations' %>
+  <%= link_to "Sign up", new_registration_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.recoverable? && controller_name != 'passwords' && controller_name != 'registrations' %>
+  <%= link_to "Forgot your password?", new_password_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.confirmable? && controller_name != 'confirmations' %>
+  <%= link_to "Didn't receive confirmation instructions?", new_confirmation_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks' %>
+  <%= link_to "Didn't receive unlock instructions?", new_unlock_path(resource_name) %><br />
+<% end %>
+
+<%- if devise_mapping.omniauthable? %>
+  <%- resource_class.omniauth_providers.each do |provider| %>
+    <%= link_to "Sign in with #{OmniAuth::Utils.camelize(provider)}", omniauth_authorize_path(resource_name, provider), method: :post %><br />
+  <% end %>
+<% end %>
+</div>

data/app/views/admin/users/unlocks/new.html.erb

@@ -0,0 +1,10 @@
+<%= form_for(resource, as: resource_name, url: unlock_path(resource_name), html: {method: :post}) do |f| %>
+  <%= render "admin/users/shared/error_messages", resource: resource %>
+
+  <%= render 'headmin/forms/fields/email', form: f, attribute: :email, required: true, label: :float %>
+
+  <%= f.submit t('.resend'), class: 'btn btn-lg btn-primary w-100' %>
+
+  <%= render "admin/users/shared/links" %>
+
+<% end %>

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

@@ -0,0 +1,23 @@
+<%#
+    name: headmin/heading/breadcrumbs
+    accepts block: no
+    parameters:
+      breadcrumbs: Breadcrumbs collection
+%>
+
+<nav aria-label="breadcrumb">
+  <ol class="breadcrumb">
+    <% breadcrumb_count = breadcrumbs.count %>
+    <% breadcrumbs.each_with_index do |breadcrumb, index| %>
+      <% last = (index == breadcrumb_count - 1) %>
+      <li class="breadcrumb-item text-muted" aria-current="<%= last ? 'page' : nil %>">
+        <% if last %>
+          <%= breadcrumb.name %>
+        <% else %>
+          <%= link_to_unless_current(breadcrumb.name, breadcrumb.path, class: 'text-muted text-decoration-none') %>
+        <% end %>
+      </li>
+    <% end %>
+    <li>&nbsp;</li>
+  </ol>
+</nav>

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

@@ -0,0 +1,47 @@
+<%#
+    name: headmin/filters
+    accepts block: yes
+    parameters:
+      url: base url to send filter query to
+%>
+<% action = local_assigns.has_key?(:url) ? url : request.url %>
+
+<form class="h-filters d-flex align-items-center mb-2" action="<%= action %>" data-controller="filters" data-filters-target="form">
+  <%= yield if block_given? %>
+
+  <!-- Default parameters (e.g. sorting, pagination) -->
+  <% default_params.each do |name, value| %>
+    <%= hidden_field_tag(name.to_sym, value) %>
+  <% end %>
+
+  <!-- Filter buttons -->
+  <div class="h-filter-list d-flex" data-filters-target="list">
+    <%= content_for :filters_buttons %>
+  </div>
+
+  <!-- Filter templates -->
+  <%= content_for :filters_templates %>
+
+  <!-- Menu -->
+  <% if content_for :filters_menu %>
+    <div class="btn-group">
+      <button type="button" class="btn btn-link dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
+        <%= bootstrap_icon('funnel-fill') %>
+        <%= t('.button') %>
+      </button>
+      <ul class="dropdown-menu">
+        <%= content_for :filters_menu %>
+        <li><hr class="dropdown-divider"></li>
+        <li><a class="dropdown-item text-danger" href="#" data-action="click->filters#removeAll"><%= t('.remove_all') %></a></li>
+      </ul>
+    </div>
+  <% end %>
+
+  <!-- Separator -->
+  <% if content_for(:filters_menu) && content_for(:filters_search) %>
+    <span class="separator"></span>
+  <% end %>
+
+  <!-- Search -->
+  <%= content_for :filters_search %>
+</form>

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

@@ -0,0 +1,11 @@
+<%#
+    name: headmin/form
+    accepts block: yes (required)
+    parameters: model
+%>
+
+<div class="headmin-form container">
+  <%= form_with model: model do |form| %>
+    <%= yield(form) %>
+  <% end %>
+</div>

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

@@ -0,0 +1,9 @@
+<%#
+    name: headmin/heading
+    accepts block: yes
+    parameters: none
+%>
+
+<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? %>
+</div>

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

@@ -0,0 +1,12 @@
+<%#
+    name: headmin/index
+    accepts block: yes (required)
+    parameters:
+      search:
+        url: base url to send search query to
+        placeholder: placeholder for search field
+%>
+
+<div class="headmin-index container-fluid" data-controller="index">
+  <%= yield %>
+</div>

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

@@ -0,0 +1,12 @@
+<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="d-flex">
+        <div class="toast-body <%= notification_color(name.to_sym)[:text] %>">
+          <%= message %>
+        </div>
+        <button type="button" class="btn-close btn-close-white me-2 m-auto" data-bs-dismiss="toast" aria-label="Close"></button>
+      </div>
+    </div>
+  <% end %>
+</div>

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

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

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

@@ -0,0 +1,13 @@
+<%#
+    name: headmin/table
+    accepts block: yes
+    parameters: none
+%>
+<% 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">
+    <table class="table table-hover m-0" data-controller="table" data-table-target="table" data-table-url-value="<%= sort_url %>">
+      <%= yield if block_given? %>
+    </table>
+  </div>
+</div>

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

@@ -0,0 +1,46 @@
+<%#
+    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 %>
+
+<% 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 %>
+<% end %>
+
+<%= content_for :filters_templates do %>
+  <%= render 'headmin/filters/filter/template', name: name, label: label do %>
+    <div class="input-group">
+      <span class="input-group-text">
+        <%= bootstrap_icon('calendar') %>
+      </span>
+      <%= date_field_tag(name, nil, input_options) %>
+    </div>
+  <% end %>
+<% end %>
+
+<%= content_for :filters_buttons do %>
+  <% if filter_param_exists?(name) %>
+    <% value_formatted = Date.parse(params[name]).strftime('%d/%m/%Y') %>
+    <%= render 'headmin/filters/filter/button', name: name, label: label, value: value_formatted do %>
+      <div class="input-group">
+        <span class="input-group-text">
+          <%= bootstrap_icon('calendar') %>
+        </span>
+        <%= date_field_tag(name, params[name], input_options) %>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>

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

@@ -0,0 +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) %>
+
+<% 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>
+<% end %>

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

@@ -0,0 +1,39 @@
+<%#
+    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 : [] %>
+
+<% 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 %>
+<% end %>
+
+<%= content_for :filters_templates do %>
+  <%= render 'headmin/filters/filter/template', name: name, label: label do %>
+    <%= select_tag("#{name}[]", options_for_select(options), select_options) %>
+  <% end %>
+<% 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) %>
+    <% end %>
+  <% end %>
+<% end %>