headmin 0.2.8 → 0.3.1

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

@@ -1,39 +1,48 @@
 <%
   # headmin/forms/url
   #
-  # ==== 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>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
+  # ==== Required parameters
+  # * +form+ - Form object
+  # * +attribute+ - Name of the attribute of the form model
+  #
+  # ==== Optional parameters
+  # * +aria+ - Provide a hash to define all aria attributes
+  # * +autocomplete+ - Value to be autofilled by the browser
+  # * +autofocus+ - Set to true to focus on this field when the page renders
+  # * +data+ - Provide a hash to define all data attributes
+  # * +disabled+ - Sets the placeholder of the field
+  # * +id+ - Input identifier
+  # * +maxlength+ - Maximum amount of characters to be used
+  # * +minlength+ - Minimum amount of characters to be used
+  # * +list+ - Add array of options to show in a data list
+  # * +pattern+ -a  A regular expression that the input's value must match
+  # * +placeholder+ - Sets the placeholder of the field
+  # * +readonly+ - Sets the placeholder of the field
+  # * +required+ - Set to true to mark as required
+  # * +size+ - How much of the input should be shown
+  # * +value+ - Overrides the value of the form
+  #
+  # ==== Extra parameters
+  # Listed in 'headmin/forms/base'
+  #
+  # ==== References
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/text
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/url_field
   #
   # ==== Examples
   #   Basic version
   #   <%= render 'headmin/forms/url', form: form, attribute: :website_url %#>
 
-  append = local_assigns.has_key?(:append) ? append : nil
-  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
-  float = local_assigns.has_key?(:float) ? float : false
-  label = local_assigns.has_key?(:label) ? label : nil
-  prepend = local_assigns.has_key?(:prepend) ? prepend : nil
-  readonly = local_assigns.has_key?(:readonly) ? readonly : false
-  required = local_assigns.has_key?(:required) ? required : false
+  placeholder = local_assigns[:float] ? local_assigns[:placeholder] || attribute : local_assigns[:placeholder]
 
-  options = {
-    'aria-describedby': form_field_validation_id(form, attribute),
-    class: "form-control #{form_field_validation_class(form, attribute)} #{class_names}",
-    data: data,
-    disabled: disabled,
-    placeholder: attribute,
-    readonly: readonly,
-    required: required,
-  }
+  option_keys = %i(aria autocomplete autofocus data disabled id list placeholder maxlength minlength pattern readonly required size value)
+  options = local_assigns.slice(*option_keys).merge(
+    aria: { describedby: form_field_validation_id(form, attribute) },
+    class: ['form-control', form_field_validation_class(form, attribute)].join(' '),
+    placeholder: placeholder
+  )
 %>
 
-<%= render 'headmin/forms/base', form: form, attribute: attribute, append: append, prepend: prepend, float: float, label: label, required: required do |form| %>
+<%= render 'headmin/forms/base', local_assigns do |form| %>
   <%= form.url_field(attribute, options) %>
 <% end %>

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

@@ -2,8 +2,8 @@
   # headmin/forms/validation
   #
   # ==== Options
-  # * <tt>form<tt> - Form object
-  # * <tt>attribute<tt> - Name of the attribute of the form model
+  # * +form+ - Form object
+  # * +attribute+ - Name of the attribute of the form model
   #
   # ==== Examples
   #   Basic version
@@ -11,7 +11,7 @@
 
   show_feedback = form.object && !form_field_valid?(form, attribute)
   id = form_field_validation_id(form, attribute)
-  message = form.object.errors[attribute].join(', ')
+  message = form.object&.errors.try(attribute)&.join(', ')
 %>
 
 <% if show_feedback %>

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

@@ -0,0 +1,21 @@
+<%
+  # name: headmin/forms/video
+  #
+  # ==== Required parameters
+  # * +form+ - Form object
+  # * +attribute+ - Name of the attribute of the form model
+  #
+  # ==== Extra parameters
+  # Listed in 'headmin/forms/file'
+  # Listed in 'headmin/forms/base'
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render 'headmin/forms/video', form: form, attribute: :video %#>
+
+  options = local_assigns.merge(
+    accept: 'video/*'
+  )
+%>
+
+<%= render 'headmin/forms/file', options %>

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

@@ -2,9 +2,9 @@
   # name: headmin/forms/fields/base
   #
   # ==== Options
-  # * <tt>form<tt> - Form object
-  # * <tt>name<tt> - Name for the field
-  # * <tt>field_type<tt> - Type of the field. Options: [:text, :image, :file, :list, :group]
+  # * +form+ - Form object
+  # * +name+ - Name for the field
+  # * +field_type+ - Type of the field. Options: [:text, :image, :file, :list, :group]
   #
   # ==== Examples
   #   Basic version

data/app/views/headmin/forms/fields/_file.html.erb

@@ -2,8 +2,8 @@
   # name: headmin/forms/fields/file
   #
   # ==== Options
-  # * <tt>form<tt> - Form object
-  # * <tt>name<tt> - Name for the field
+  # * +form+ - Form object
+  # * +name+ - Name for the field
   #
   # ==== Examples
   #   Basic version

data/app/views/headmin/forms/fields/_group.html.erb

@@ -2,9 +2,9 @@
   # name: headmin/forms/fields/group
   #
   # ==== Options
-  # * <tt>form<tt> - Form object
-  # * <tt>name<tt> - Name for the field
-  # * <tt>label<tt> - Text to show as label. Label will be hidden if value is false
+  # * +form+ - Form object
+  # * +name+ - Name for the field
+  # * +label+ - Text to show as label. Label will be hidden if value is false
   #
   # ==== Examples
   #   Basic version

data/app/views/headmin/forms/fields/_image.html.erb

@@ -2,8 +2,8 @@
   # name: headmin/forms/fields/image
   #
   # ==== Options
-  # * <tt>form<tt> - Form object
-  # * <tt>name<tt> - Name for the field
+  # * +form+ - Form object
+  # * +name+ - Name for the field
   #
   # ==== Examples
   #   Basic version

data/app/views/headmin/forms/fields/_list.html.erb

@@ -2,9 +2,9 @@
   # name: headmin/forms/fields/list
   #
   # ==== Options
-  # * <tt>form<tt> - Form object
-  # * <tt>name<tt> - Name for the field
-  # * <tt>label<tt> - Text to show as label. Label will be hidden if value is false
+  # * +form+ - Form object
+  # * +name+ - Name for the field
+  # * +label+ - Text to show as label. Label will be hidden if value is false
   #
   # ==== Examples
   #   Basic version

data/app/views/headmin/forms/fields/_text.html.erb

@@ -2,8 +2,8 @@
   # name: headmin/forms/fields/text
   #
   # ==== Options
-  # * <tt>form<tt> - Form object
-  # * <tt>name<tt> - Name for the field
+  # * +form+ - Form object
+  # * +name+ - Name for the field
   #
   # ==== Examples
   #   Basic version

data/app/views/headmin/forms/repeater/_row.html.erb

@@ -18,7 +18,7 @@
   <%= form.hidden_field :id %>
   <%= form.hidden_field :_destroy if destroyable %>
   <%= form.hidden_field :position if draggable %>
-  <%= yield if block_given? %>
+  <%= yield %>
 
   <!--  Drag handle -->
   <% if draggable %>

data/app/views/headmin/heading/_title.html.erb

@@ -21,4 +21,4 @@
       </a>
     <% end %>
   </div>
-</div>
+</div>

data/app/views/headmin/layout/_body.html.erb

@@ -5,5 +5,5 @@
 %>
 
 <div class="body col-sm-12 col-md-11 col-lg-10 p-0">
-  <%= yield if block_given? %>
+  <%= yield %>
 </div>

data/app/views/headmin/layout/_content.html.erb

@@ -5,5 +5,5 @@
 %>
 
 <div class="content py-4">
-  <%= yield if block_given? %>
+  <%= yield %>
 </div>

data/app/views/headmin/layout/_footer.html.erb

@@ -10,7 +10,7 @@
     <div class="text-secondary">
       Headmin v.<%= Headmin::VERSION %>
       <span class="float-end">
-        <%= yield if block_given? %>
+        <%= yield %>
       </span>
     </div>
   </div>

data/app/views/headmin/layout/_header.html.erb

@@ -7,7 +7,7 @@
 <header class="border-bottom d-print-none d-none d-md-block">
   <nav class="navbar navbar-light bg-white">
     <div class="container-fluid">
-      <%= yield if block_given? %>
+      <%= yield %>
     </div>
   </nav>
 </header>

data/app/views/headmin/layout/_main.html.erb

@@ -13,7 +13,7 @@
 <div class="main <%= class_names %>" data-controller="popup">
   <div class="container-fluid">
     <div class="row">
-      <%= yield if block_given? %>
+      <%= yield %>
     </div>
   </div>
 </div>

data/app/views/headmin/layout/_sidebar.html.erb

@@ -7,14 +7,14 @@
 
 <div class="sidebar col-sm-12 col-md-1 col-lg-2 bg-dark overflow-y d-print-none">
   <nav class="navbar navbar-expand-md navbar-dark bg-dark w-100 h-100 flex-md-column">
-    <a href="<%= admin_root_path %>" class="nav-brand mb-lg-4 ms-lg-3 me-lg-auto">
-      <%= logo %>
+    <a href="<%= local_assigns[:url] %>" class="nav-brand mb-lg-4 ms-lg-3 me-lg-auto">
+      <%= local_assigns[:logo] %>
     </a>
     <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#sidebar-nav" aria-controls="sidebar-nav" aria-expanded="false" aria-label="Toggle navigation">
       <span class="navbar-toggler-icon"></span>
     </button>
     <div class="navbar-nav navbar-collapse collapse flex-column align-items-start justify-content-start w-100 h-100" id="sidebar-nav">
-      <%= yield if block_given? %>
+      <%= yield %>
     </div>
   </nav>
 </div>

data/app/views/headmin/layout/sidebar/_bottom.html.erb

@@ -1,4 +1,4 @@
 <div class="mt-auto w-100">
   <hr class="bg-light">
-  <%= yield if block_given? %>
+  <%= yield %>
 </div>

data/app/views/headmin/layout/sidebar/_nav.html.erb

@@ -5,5 +5,5 @@
 %>
 
 <ul class="nav nav-pills flex-column mb-auto w-100">
-  <%= yield if block_given? %>
+  <%= yield %>
 </ul>

data/app/views/headmin/nav/_dropdown.html.erb

@@ -0,0 +1,34 @@
+<%
+  # headmin/nav/dropdown
+  #
+  # ==== Options
+  # * +name</tt> - Name of the nav item
+  # * +url</tt> - URL for this nav item
+  # * +icon</tt> - Optional Bootstrap icon name
+  # * +active</tt> - Set to true if this nav dropdown needs to be highlighted
+  #
+  # ==== Examples
+  #   Basic version.
+  #   <%= render 'headmin/nav/dropdown', name: 'My Account', url: admin_user_path, icon: 'person-circle' do  %#>
+  #     <%= render 'headmin/nav/item', name: 'Edit info', url: edit_admin_user_path(current_user) %#>
+  #     <%= render 'headmin/nav/item', name: 'Log out', url: destroy_user_session_path(current_user) %#>
+  #   <% end %#>
+
+  name = local_assigns.has_key?(:name) ? name : ''
+  icon = local_assigns.has_key?(:icon) ? icon : nil
+  collapse_id = "nav-dropdown-#{name.parameterize}"
+  url = local_assigns.has_key?(:url) ? url : request.url
+  active = local_assigns.has_key?(:active) ? active : current_url?(url)
+%>
+
+<li class="nav-item">
+  <a class="nav-link d-flex align-items-center dropdown-toggle <%= 'active' if active %>" href="#<%= collapse_id %>" role="button" data-bs-toggle="collapse" aria-expanded="<%= active.to_s %>" aria-controls="<%= collapse_id %>">
+    <%= bootstrap_icon(icon, class: 'me-2') if icon %>
+    <span class="d-block d-md-none d-lg-block">
+      <%= name %>
+    </span>
+  </a>
+  <ul class="collapse <%= 'show' if active %>" id="<%= collapse_id %>">
+    <%= yield %>
+  </ul>
+</li>

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

@@ -1,21 +1,30 @@
-<%#
-    headmin/nav/item
-    accepts block: yes
-    parameters:
-      url: (string) Url to be used as anchor in link tag
-      name: (string) Name to be displayed inside link
-      active: (boolean) Whether to highlight the item or not
+<%
+  # headmin/nav/item
+  #
+  # ==== Options
+  # * +name</tt> - Name of the nav item
+  # * +url</tt> - URL for this nav item
+  # * +icon</tt> - Optional Bootstrap icon name
+  # * +active</tt> - Set to true if this nav item needs to be highlighted
+  #
+  # ==== Examples
+  #   Basic version.
+  #   <%= render 'headmin/nav/item', name: 'Dashboard', url: admin_root_path %#>
+  #
+  #   With icon
+  #   <%= render 'headmin/nav/item', name: 'Dashboard', url: admin_root_path, icon: 'speedometer' %#>
+
+  name = local_assigns.has_key?(:name) ? name : ''
+  icon = local_assigns.has_key?(:icon) ? icon : nil
+  url = local_assigns.has_key?(:url) ? url : request.url
+  active = local_assigns.has_key?(:active) ? active : current_url?(url)
 %>
-<% name = local_assigns.has_key?(:name) ? name : '' %>
-<% icon = local_assigns.has_key?(:icon) ? icon : nil %>
-<% url = local_assigns.has_key?(:url) ? url : '' %>
-<% active = local_assigns.has_key?(:active) ? current_url?(url) : false %>
 
 <li class="nav-item">
   <a class="nav-link d-flex align-items-center <%= 'active' if active %>" aria-current="page" href="<%= url %>">
     <%= bootstrap_icon(icon, class: 'me-2') if icon %>
     <span class="d-block d-md-none d-lg-block">
-  <%= name %>
-</span>
+      <%= name %>
+    </span>
   </a>
 </li>

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

@@ -35,7 +35,7 @@
             </label>
             <select class="form-select me-1" data-table-actions-target="select" data-action="change->table-actions#update">
               <option disabled selected="selected"><%= t('.selection') %></option>
-              <%= yield if block_given? %>
+              <%= yield %>
             </select>
           </div>
         </div>

data/app/views/headmin/table/_body.html.erb

@@ -5,7 +5,7 @@
 %>
 
 <% content_for :table_body do %>
-  <%= yield if block_given? %>
+  <%= yield %>
 <% end %>
 
 <tbody data-table-target="body">

data/app/views/headmin/table/_foot.html.erb

@@ -5,7 +5,7 @@
 %>
 
 <% content_for :table_foot do %>
-  <%= yield if block_given? %>
+  <%= yield %>
 <% end %>
 
 <tfoot class="table-light">

data/app/views/headmin/table/_footer.html.erb

@@ -5,5 +5,5 @@
 %>
 
 <div class="d-flex flex-column flex-md-row align-content-start align-items-md-center justify-content-md-between">
-  <%= yield if block_given? %>
+  <%= yield %>
 </div>

data/app/views/headmin/table/_head.html.erb

@@ -7,7 +7,7 @@
 <thead class="table-light fw-light">
 <tr>
   <% content_for :table_head do %>
-    <%= yield if block_given? %>
+    <%= yield %>
   <% end %>
 
   <%= yield :table_head  %>

data/app/views/headmin/table/_header.html.erb

@@ -5,5 +5,5 @@
 %>
 
 <div class="d-flex flex-column flex-md-row align-content-start align-items-md-center justify-content-md-between">
-  <%= yield if block_given? %>
+  <%= yield %>
 </div>

data/app/views/headmin/table/actions/_action.html.erb

@@ -2,10 +2,10 @@
   # headmin/table/actions/action
   #
   # ==== Options
-  # * <tt>name</tt> - Name of the bulk action
-  # * <tt>url</tt> - URL to send the request to
-  # * <tt>method</tt> - HTTP method for the request (defaults to GET)
-  # * <tt>confirm</tt> - Message to show in a confirm dialog. Leave blank if no confirm dialog needs to be shown
+  # * +name</tt> - Name of the bulk action
+  # * +url</tt> - URL to send the request to
+  # * +method</tt> - HTTP method for the request (defaults to GET)
+  # * +confirm</tt> - Message to show in a confirm dialog. Leave blank if no confirm dialog needs to be shown
   #
   # ==== Examples
   #   Basic version.

data/app/views/headmin/table/actions/_delete.html.erb

@@ -2,7 +2,7 @@
   # headmin/table/actions/delete
   #
   # ==== Options
-  # * <tt>url</tt> - URL to send the request to
+  # * +url</tt> - URL to send the request to
   #
   # ==== Examples
   #   Basic version.

data/app/views/headmin/table/actions/_export.html.erb

@@ -2,7 +2,7 @@
   # headmin/table/actions/export
   #
   # ==== Options
-  # * <tt>url</tt> - URL to send the request to
+  # * +url</tt> - URL to send the request to
   #
   # ==== Examples
   #   Basic version.

data/app/views/headmin/table/body/_row.html.erb

@@ -2,7 +2,7 @@
   # headmin/table/body/row
   #
   # ==== Options
-  # * <tt>class</tt> - Custom class names to add to the table row
+  # * +class</tt> - Custom class names to add to the table row
   #
   # ==== Examples
   #   <%= render 'headmin/table/body/row' do %#>
@@ -13,5 +13,5 @@
   class_names = local_assigns.has_key?(:class) ? local_assigns[:class] : false
 %>
 <tr class="<%= class_names %>" data-table-target="row">
-  <%= yield if block_given? %>
+  <%= yield %>
 </tr>

data/config/importmap.rb

@@ -0,0 +1,2 @@
+# Pin npm packages by running ./bin/importmap
+pin "headmin"

data/config/locales/en.yml

@@ -1,5 +1,2 @@
 en:
   language_name: English
-  headmin:
-    popup:
-      add: 'Add %{name}'

data/config/locales/headmin/forms/en.yml

@@ -12,6 +12,11 @@ en:
         title: Status
         view:
           title: View
+      file:
+        not_found: Not available
+        placeholder:
+          one: Browse file or drag & drop it here
+          other: Browse files or drag & drop them here
       group:
         save: Save
       blocks:

data/config/locales/headmin/forms/nl.yml

@@ -12,6 +12,11 @@ nl:
         title: Status
         view:
           title: Bekijken
+      file:
+        not_found: Niet beschikbaar
+        placeholder:
+          one: Kies bestand of sleep het hierheen
+          other: Kies bestanden of sleep ze hierheen
       group:
         save: Opslaan
       blocks:

data/config/locales/headmin/popup/en.yml

@@ -0,0 +1,4 @@
+en:
+  headmin:
+    popup:
+      add: 'Add %{name}'

data/config/locales/headmin/popup/nl.yml

@@ -0,0 +1,4 @@
+nl:
+  headmin:
+    popup:
+      add: '%{name} toevoegen'

data/config/locales/headmin/thumbnail/en.yml

@@ -0,0 +1,4 @@
+en:
+  headmin:
+    thumbnail:
+      title: Title

data/config/locales/headmin/thumbnail/nl.yml

@@ -0,0 +1,4 @@
+nl:
+  headmin:
+    thumbnail:
+      title: Titel

data/config/locales/nl.yml

@@ -1,5 +1,2 @@
 nl:
   language_name: Nederlands
-  headmin:
-    popup:
-      add: '%{name} toevoegen'

data/esbuild-css.js

@@ -0,0 +1,25 @@
+const esbuild = require("esbuild");
+const sassPlugin = require("esbuild-sass-plugin").sassPlugin;
+const watch = process.argv.includes('-w')
+
+// Used to skip external URLs in scss files
+const externalUrlPlugin = {
+    name: "custom-resolver",
+    setup(build) {
+        build.onResolve({filter: /^https?:\/\//}, ({path}) => {
+            return {path, external: true, namespace: "provided"};
+        });
+    }
+}
+
+esbuild.build({
+    entryPoints: ['src/scss/headmin.scss'],
+    outfile: 'app/assets/stylesheets/headmin.css',
+    bundle: true,
+    watch: watch,
+    allowOverwrite: true,
+    plugins: [
+        externalUrlPlugin,
+        sassPlugin()
+    ]
+}).catch((e) => console.error(e.message));

data/esbuild-js.js

@@ -0,0 +1,11 @@
+const esbuild = require("esbuild");
+const watch = process.argv.includes('-w')
+
+esbuild.build({
+    entryPoints: ['src/js/headmin.js'],
+    outfile: 'app/assets/javascripts/headmin.js',
+    bundle: true,
+    allowOverwrite: true,
+    format: 'esm',
+    watch: watch
+}).catch((e) => console.error(e.message));

data/headmin.gemspec

@@ -29,7 +29,10 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_runtime_dependency 'closure_tree'
+  spec.add_runtime_dependency "closure_tree"
+  spec.add_runtime_dependency "inline_svg"
+  spec.add_runtime_dependency "redcarpet"
+  spec.add_runtime_dependency "rouge"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/headmin/engine.rb

@@ -3,10 +3,25 @@ module Headmin
     engine_name 'headmin'
 
     require 'closure_tree'
+    require 'redcarpet'
+    require 'rouge'
 
     # Add translations to main app
     config.before_configuration do
       config.i18n.load_path += Dir["#{config.root}/config/locales/**/*.yml"]
     end
+
+    # Add assets to precompilation list
+    initializer "headmin.assets" do |app|
+      next unless app.config.respond_to?(:assets)
+      app.config.assets.precompile += %w( headmin.js headmin.css headmin.scss)
+    end
+
+    # Add importmap to main app
+    initializer "headmin.importmap", before: "importmap" do |app|
+      next unless app.config.respond_to?(:importmap)
+      app.config.importmap.paths << Engine.root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << Engine.root.join("app/assets/javascripts")
+    end
   end
 end

data/lib/headmin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Headmin
-  VERSION = "0.2.8"
+  VERSION = "0.3.1"
 end