headmin 0.3.4 → 0.4.2

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

@@ -2,49 +2,38 @@
   # headmin/forms/textarea
   #
   # ==== Required parameters
-  # * +form+ - Form object
   # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
   #
   # ==== Optional parameters
-  # * +aria+ - Provide a hash to define all aria attributes
-  # * +autocomplete+ - Value to be autofilled by the browser
-  # * +autofocus+ - Value to be autofilled by the browser
-  # * +cols+ - Visible width in average charachter width (default = 20)
-  # * +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
-  # * +placeholder+ - Sets the placeholder of the field
-  # * +readonly+ - Sets the placeholder of the field
-  # * +required+ - Set to true to mark as required
-  # * +rows+ - Visible text lines
-  # * +spellcheck+ - Indicate whether or not to enable spell checking by the browser
-  # * +value+ - Overrides the value of the form
-  # * +wrap+ - How to wrap text. Soft (default), hard, or off
-  #
-  # ==== Extra parameters
-  # Listed in 'headmin/forms/base'
+  # * +append+ - Display as input group with text on the right-hand side
+  # * +float+ - Use floating labels. Defaults to false
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +plaintext+ - Render input as plain text.
+  # * +prepend+ - Display as input group with text on the left-hand side
+  # * +wrapper+ - Hash with all options for the surrounding html tag
   #
   # ==== References
+  # https://headmin.dev/docs/forms/textarea
   # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea
   # https://apidock.com/rails/ActionView/Helpers/FormHelper/text_area
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/textarea', form: form, attribute: :title %#>
-
-  placeholder = local_assigns[:float] ? local_assigns[:placeholder] || attribute : local_assigns[:placeholder]
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/textarea", form: form, attribute: :text %#>
+  #   <% end %#>
 
-  option_keys = %i(aria autocomplete autofocus cols data disabled id maxlength minlength placeholder readonly required rows spellcheck value wrap)
-  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(' '),
-    list: local_assigns[:list] ? "#{attribute}_list" : nil,
-    placeholder: placeholder
-  )
+  textarea = Headmin::Form::TextareaView.new(local_assigns)
 %>
 
-<%= render 'headmin/forms/base', local_assigns do |form| %>
-  <%= form.text_area(attribute, options) %>
+<%= render "headmin/forms/wrapper", textarea.wrapper_options do %>
+  <%= render "headmin/forms/label", textarea.label_options if textarea.prepend_label? %>
+  <%= render "headmin/forms/input_group", textarea.input_group_options do %>
+    <%= form.text_area(textarea.attribute, textarea.input_options) %>
+  <% end %>
+  <%= render "headmin/forms/validation", textarea.validation_options if textarea.validate? %>
+  <%= render "headmin/forms/hint", textarea.hint_options if textarea.hint? %>
+  <%= render "headmin/forms/label", textarea.label_options if textarea.append_label? %>
 <% end %>

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

@@ -2,47 +2,42 @@
   # headmin/forms/url
   #
   # ==== Required parameters
-  # * +form+ - Form object
   # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
   #
   # ==== 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'
+  # * +append+ - Display as input group with text on the right-hand side
+  # * +collection+ - Values to be suggested while typing. Can be an collection array or a remote URL.
+  # * +float+ - Use floating labels. Defaults to false
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +list+ - Options are passed through options_for_select
+  # * +plaintext+ - Render input as plain text.
+  # * +prepend+ - Display as input group with text on the left-hand side
+  # * +wrapper+ - Hash with all options for the surrounding html tag
   #
   # ==== References
-  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/text
+  # https://headmin.dev/docs/forms/url
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/url
   # https://apidock.com/rails/ActionView/Helpers/FormHelper/url_field
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/url', form: form, attribute: :website_url %#>
-
-  placeholder = local_assigns[:float] ? local_assigns[:placeholder] || attribute : local_assigns[:placeholder]
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/url", form: form, attribute: :website_url %#>
+  #   <% end %#>
 
-  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
-  )
+  url = Headmin::Form::UrlView.new(local_assigns)
 %>
 
-<%= render 'headmin/forms/base', local_assigns do |form| %>
-  <%= form.url_field(attribute, options) %>
+<%= render "headmin/forms/wrapper", url.wrapper_options do %>
+  <%= render "headmin/forms/label", url.label_options if url.prepend_label? %>
+  <%= render "headmin/forms/input_group", url.input_group_options do %>
+    <%= form.url_field(url.attribute, url.input_options) %>
+    <%= render "headmin/forms/datalist", url.datalist_options if url.datalist? %>
+    <%= render "headmin/forms/autocomplete", url.autocomplete_options if url.autocomplete? %>
+  <% end %>
+  <%= render "headmin/forms/validation", url.validation_options if url.validate? %>
+  <%= render "headmin/forms/hint", url.hint_options if url.hint? %>
+  <%= render "headmin/forms/label", url.label_options if url.append_label? %>
 <% end %>

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

@@ -1,21 +1,18 @@
 <%
   # headmin/forms/validation
   #
-  # ==== Options
-  # * +form+ - Form object
-  # * +attribute+ - Name of the attribute of the form model
+  # ==== Required parameters
+  # * +id+ - Form object
+  # * +message+ - Name of the attribute of the form model
+  #
+  # ==== Optional parameters
+  # * +valid+ - Show success message when true, failure message when false (default: true)
   #
   # ==== Examples
   #   Basic version
-  #   <%= render 'headmin/forms/validation', form: form, attribute: attribute %#>
-
-  show_feedback = form.object && !form_field_valid?(form, attribute)
-  id = form_field_validation_id(form, attribute)
-  message = form.object&.errors[attribute]&.join(', ')
+  #   <%= render "headmin/forms/validation", id: id, message: message %#>
 %>
 
-<% if show_feedback %>
-  <div class="invalid-feedback" id="<%= id %>">
-    <%= message %>
-  </div>
-<% end %>
+<div class="<%= valid ? "valid-feedback" : "invalid-feedback" %>" id="<%= id %>">
+  <%= message %>
+</div>

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

@@ -0,0 +1,9 @@
+<% wrapper = Headmin::Form::WrapperView.new(local_assigns) %>
+
+<% if wrapper.bypass %>
+  <%= yield %>
+<% else %>
+  <div <%= tag.attributes(wrapper.options) %>>
+    <%= yield %>
+  </div>
+<% end %>

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

@@ -0,0 +1,28 @@
+<%
+  # headmin/forms/wysiwyg
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +hint+ - Informative text to assist with data input. HTML markup is allowed.
+  # * +label+ - Text to display inside label tag. Defaults to the attribute name. Set to false if you don"t want to show a label.
+  # * +toolbar+ - Show toolbar (default true)
+  # * +wrapper+ - Hash with all options for the surrounding html tag
+  #
+  # ==== References
+  # https://headmin.dev/docs/forms/redactorx
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/text_area
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "headmin/forms/redactorx", form: form, attribute: :text %#>
+  #   <% end %#>
+
+  wysiwyg = Headmin::Form::WysiwygView.new(local_assigns)
+%>
+
+<%= render "headmin/forms/redactorx", wysiwyg.options %>

data/app/views/headmin/forms/autocomplete/_item.html.erb

@@ -0,0 +1,3 @@
+<li class="list-group-item list-group-item-action" data-autocomplete-target="dropdownItem" value="<%= value %>" data-action="click->autocomplete#select">
+  <%= yield %>
+</li>

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

@@ -0,0 +1,3 @@
+<ul class="list-group-flush">
+  <%= yield %>
+</ul>

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

@@ -13,5 +13,5 @@
 %>
 
 <%= render 'headmin/forms/fields/base', form: form, field_type: :file, name: name do |field, label| %>
-  <% yield field, :file, label %>
+  <% yield field, :files, label %>
 <% end %>

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

@@ -0,0 +1,17 @@
+<%
+  # name: headmin/forms/fields/file
+  #
+  # ==== Options
+  # * +form+ - Form object
+  # * +name+ - Name for the field
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= render 'headmin/forms/fields/file', form: group, name: :file do |field, attribute, label| %#>
+  #     <%= render "headmin/forms/file", form: field, attribute: attribute, label: label %#>
+  #   <% end %#>
+%>
+
+<%= render 'headmin/forms/fields/base', form: form, field_type: :files, name: name do |field, label| %>
+  <% yield field, :files, label %>
+<% end %>

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

@@ -24,6 +24,7 @@
   #   <% end %#>
 
   label = local_assigns.has_key?(:label) ? label : nil
+  wrapper = local_assigns.has_key?(:wrapper) ? local_assigns[:wrapper] : true
   show_label = label != false
 %>
 
@@ -32,7 +33,13 @@
     <%= render 'headmin/forms/label', form: form, attribute: :value, text: label || field_label %>
   <% end %>
 
-  <li class="list-group-item mb-3">
+  <% if wrapper %>
+  <ul class="list-group mb-3">
+    <li class="list-group-item">
+      <%= yield group %>
+    </li>
+  </ul>
+  <% else %>
     <%= yield group %>
-  </li>
+  <% end %>
 <% end %>

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

@@ -28,7 +28,7 @@
   <% end %>
 
   <!--  Add button-->
-  <a href="#"
+  <div
      class="repeater-row-add btn btn-link"
      title="<%= t('.add') %>"
      data-repeater-target="addButton"
@@ -38,14 +38,14 @@
      data-action="click->repeater#resetButtonIndices click->popup#open"
   >
     <%= bootstrap_icon('plus-circle') %>
-  </a>
+  </div>
 
   <!--  Remove button-->
-  <a href="#"
+  <div
      class="repeater-row-remove btn btn-link"
      title="<%= t('.remove') %>"
      data-action="click->repeater#removeRow"
   >
     <%= bootstrap_icon('dash-circle') %>
-  </a>
+  </div>
 </div>

data/bin/console

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 require "bundler/setup"
 require "headmin"

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

@@ -1,17 +1,6 @@
 en:
   headmin:
     forms:
-      actions:
-        description: Status & visibility
-        destroy:
-          title: Delete
-          confirm: Are you sure you want to delete this?
-        format: '%m-%d-%Y %H:%M'
-        save:
-          title: Save
-        title: Status
-        view:
-          title: View
       file:
         not_found: Not available
         placeholder:
@@ -33,7 +22,7 @@ en:
         blank: Make a choice
       repeater:
         add: "Add %{name}"
-        empty: This list is empty for now.
+        empty: Start by adding your first block
         row:
           add: Add row
           remove: Remove row

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

@@ -1,17 +1,6 @@
 nl:
   headmin:
     forms:
-      actions:
-        description: Status & zichtbaarheid
-        destroy:
-          title: Verwijderen
-          confirm: Ben je zeker dat je dit wil verwijderen?
-        format: '%d-%m-%Y %H:%M'
-        save:
-          title: Opslaan
-        title: Status
-        view:
-          title: Bekijken
       file:
         not_found: Niet beschikbaar
         placeholder:
@@ -32,7 +21,7 @@ nl:
         blank: Maak een keuze
       repeater:
         add: "%{name} toevoegen"
-        empty: Deze lijst is voorlopig nog leeg.
+        empty: Voeg je eerste blok toe om te beginnen
         row:
           add: Rij toevoegen
           remove: Rij verwijderen

data/esbuild-css.js

@@ -1,25 +1,25 @@
-const esbuild = require("esbuild");
-const sassPlugin = require("esbuild-sass-plugin").sassPlugin;
+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"};
-        });
-    }
+  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));
+  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

@@ -1,11 +1,11 @@
-const esbuild = require("esbuild");
+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));
+  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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require_relative "lib/headmin/version"
 
 Gem::Specification.new do |spec|
@@ -32,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "closure_tree", "~> 7.4"
   spec.add_runtime_dependency "inline_svg", "~> 1.7"
   spec.add_runtime_dependency "redcarpet", "~> 3.5"
-  spec.add_runtime_dependency "rouge", "~> 3.27"
+  spec.add_runtime_dependency "rouge", "~> 3.28"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/generators/templates/controllers/auth/confirmations_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class Auth::ConfirmationsController < Devise::ConfirmationsController
   layout "auth"
   # GET /resource/confirmation/new

data/lib/generators/templates/controllers/auth/omniauth_callbacks_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class Auth::OmniauthCallbacksController < Devise::OmniauthCallbacksController
   layout "auth"
   # You should configure your model like this:

data/lib/generators/templates/controllers/auth/passwords_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class Auth::PasswordsController < Devise::PasswordsController
   layout "auth"
   # GET /resource/password/new

data/lib/generators/templates/controllers/auth/registrations_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class Auth::RegistrationsController < Devise::RegistrationsController
   layout "auth"
   # before_action :configure_sign_up_params, only: [:create]

data/lib/generators/templates/controllers/auth/sessions_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class Auth::SessionsController < Devise::SessionsController
   layout "auth"
   # before_action :configure_sign_in_params, only: [:create]

data/lib/generators/templates/controllers/auth/unlocks_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class Auth::UnlocksController < Devise::UnlocksController
   layout "auth"
   # GET /resource/unlock/new

data/lib/headmin/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Headmin
-  VERSION = "0.3.4"
+  VERSION = "0.4.2"
 end

data/lib/headmin.rb

@@ -1,4 +1,2 @@
-# frozen_string_literal: true
-
 require_relative "headmin/version"
 require_relative "headmin/engine"