formstrap 0.1.0

data/app/models/formstrap/search_view.rb

@@ -0,0 +1,46 @@
+module Formstrap
+  class SearchView < ViewModel
+    include Formstrap::Autocompletable
+    include Formstrap::Hintable
+    include Formstrap::InputGroupable
+    include Formstrap::Labelable
+    include Formstrap::Listable
+    include Formstrap::Placeholderable
+    include Formstrap::Validatable
+    include Formstrap::Wrappable
+
+    def input_options
+      keys = attributes - %i[append attribute collection float form input_group label prepend validate wrapper]
+      options = to_h.slice(*keys)
+      options = default_input_options.deep_merge(options)
+      options.deep_merge(autocomplete_input_options)
+    end
+
+    def input_group_options
+      default_input_group_options
+        .deep_merge(autocomplete_input_group_options)
+        .deep_merge(label_input_group_options)
+        .deep_merge(@input_group || {})
+    end
+
+    def wrapper_options
+      default_wrapper_options.deep_merge({
+        class: ["mb-3", ("form-floating" if float)]
+      }).deep_merge(@wrapper || {})
+    end
+
+    private
+
+    def default_input_options
+      {
+        aria: {describedby: validation_id},
+        class: [form_control_class, validation_class],
+        placeholder: placeholder
+      }
+    end
+
+    def form_control_class
+      plaintext ? "form-control-plaintext" : "form-control"
+    end
+  end
+end

data/app/models/formstrap/select_view.rb

@@ -0,0 +1,61 @@
+module Formstrap
+  class SelectView < ViewModel
+    include Formstrap::Hintable
+    include Formstrap::InputGroupable
+    include Formstrap::Labelable
+    include Formstrap::Listable
+    include Formstrap::Placeholderable
+    include Formstrap::Validatable
+    include Formstrap::Wrappable
+
+    def input_options
+      keys = attributes - %i[append attribute collection float form input_group include_blank label prepend validate selected tags wrapper]
+      options = to_h.slice(*keys)
+      default_input_options.deep_merge(options)
+    end
+
+    def input_group_options
+      default_input_group_options
+        .deep_merge(label_input_group_options)
+        .deep_merge(@input_group || {})
+    end
+
+    def wrapper_options
+      default_wrapper_options.deep_merge({
+        class: ["mb-3", ("form-floating" if float)]
+      }).deep_merge(@wrapper || {})
+    end
+
+    def select_options
+      keys = %i[include_blank selected]
+      options = to_h.slice(*keys)
+      default_options.deep_merge(options)
+    end
+
+    private
+
+    def default_options
+      selected = attribute.nil? ? nil : form.object&.send(attribute)
+      {
+        selected: selected
+      }
+    end
+
+    def default_input_options
+      {
+        aria: {describedby: validation_id},
+        class: [form_control_class, validation_class],
+        data: {
+          tags: tags,
+          controller: "select"
+        },
+        multiple: tags,
+        placeholder: placeholder
+      }
+    end
+
+    def form_control_class
+      plaintext ? "form-control-plaintext" : "form-select"
+    end
+  end
+end

data/app/models/formstrap/switch_view.rb

@@ -0,0 +1,21 @@
+module Formstrap
+  class SwitchView < ViewModel
+    def options
+      default_options.deep_merge(to_h)
+    end
+
+    private
+
+    def default_options
+      {
+        wrapper: default_wrapper_options
+      }
+    end
+
+    def default_wrapper_options
+      {
+        class: %w[form-check form-switch mb-3]
+      }
+    end
+  end
+end

data/app/models/formstrap/text_view.rb

@@ -0,0 +1,46 @@
+module Formstrap
+  class TextView < ViewModel
+    include Formstrap::Autocompletable
+    include Formstrap::Hintable
+    include Formstrap::InputGroupable
+    include Formstrap::Labelable
+    include Formstrap::Listable
+    include Formstrap::Placeholderable
+    include Formstrap::Validatable
+    include Formstrap::Wrappable
+
+    def input_options
+      keys = attributes - %i[append attribute collection float form input_group label prepend validate wrapper]
+      options = to_h.slice(*keys)
+      options = default_input_options.deep_merge(options)
+      options.deep_merge(autocomplete_input_options)
+    end
+
+    def input_group_options
+      default_input_group_options
+        .deep_merge(autocomplete_input_group_options)
+        .deep_merge(label_input_group_options)
+        .deep_merge(@input_group || {})
+    end
+
+    def wrapper_options
+      default_wrapper_options.deep_merge({
+        class: ["mb-3", ("form-floating" if float)]
+      }).deep_merge(@wrapper || {})
+    end
+
+    private
+
+    def default_input_options
+      {
+        aria: {describedby: validation_id},
+        class: [form_control_class, validation_class],
+        placeholder: placeholder
+      }
+    end
+
+    def form_control_class
+      plaintext ? "form-control-plaintext" : "form-control"
+    end
+  end
+end

data/app/models/formstrap/textarea_view.rb

@@ -0,0 +1,47 @@
+module Formstrap
+  class TextareaView < ViewModel
+    include Formstrap::Hintable
+    include Formstrap::InputGroupable
+    include Formstrap::Labelable
+    include Formstrap::Placeholderable
+    include Formstrap::Validatable
+    include Formstrap::Wrappable
+
+    def input_options
+      keys = attributes - %i[attribute float form input_group label validate wrapper]
+      options = to_h.slice(*keys)
+      default_input_options.deep_merge(options)
+    end
+
+    def input_group_options
+      default_input_group_options
+        .deep_merge(label_input_group_options)
+        .deep_merge(@input_group || {})
+    end
+
+    def wrapper_options
+      default_wrapper_options.deep_merge({
+        class: ["mb-3", ("form-floating" if float)],
+        data: {controller: :textarea}
+      }).deep_merge(@wrapper || {})
+    end
+
+    private
+
+    def default_input_options
+      {
+        aria: {describedby: validation_id},
+        class: [form_control_class, validation_class],
+        data: {
+          textarea_target: :textarea,
+          action: "input->textarea#update"
+        },
+        placeholder: placeholder
+      }
+    end
+
+    def form_control_class
+      plaintext ? "form-control-plaintext" : "form-control"
+    end
+  end
+end

data/app/models/formstrap/url_view.rb

@@ -0,0 +1,46 @@
+module Formstrap
+  class UrlView < ViewModel
+    include Formstrap::Autocompletable
+    include Formstrap::Hintable
+    include Formstrap::InputGroupable
+    include Formstrap::Labelable
+    include Formstrap::Listable
+    include Formstrap::Placeholderable
+    include Formstrap::Validatable
+    include Formstrap::Wrappable
+
+    def input_options
+      keys = attributes - %i[append attribute collection float form input_group label prepend validate wrapper]
+      options = to_h.slice(*keys)
+      options = default_input_options.deep_merge(options)
+      options.deep_merge(autocomplete_input_options)
+    end
+
+    def input_group_options
+      default_input_group_options
+        .deep_merge(autocomplete_input_group_options)
+        .deep_merge(label_input_group_options)
+        .deep_merge(@input_group || {})
+    end
+
+    def wrapper_options
+      default_wrapper_options.deep_merge({
+        class: ["mb-3", ("form-floating" if float)]
+      }).deep_merge(@wrapper || {})
+    end
+
+    private
+
+    def default_input_options
+      {
+        aria: {describedby: validation_id},
+        class: [form_control_class, validation_class],
+        placeholder: placeholder
+      }
+    end
+
+    def form_control_class
+      plaintext ? "form-control-plaintext" : "form-control"
+    end
+  end
+end

data/app/models/formstrap/wrapper_view.rb

@@ -0,0 +1,17 @@
+module Formstrap
+  class WrapperView < ViewModel
+    def options
+      keys = attributes - %i[bypass]
+      options = to_h.slice(*keys)
+      default_options.deep_merge(options)
+    end
+
+    private
+
+    def default_options
+      {
+        class: ["mb-3"]
+      }
+    end
+  end
+end

data/app/models/formstrap/wysiwyg_view.rb

@@ -0,0 +1,15 @@
+module Formstrap
+  class WysiwygView < ViewModel
+    def options
+      default_options.deep_merge(to_h)
+    end
+
+    private
+
+    def default_options
+      {
+        hybrid: toolbar == false
+      }
+    end
+  end
+end

data/app/models/view_model.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class ViewModel
+  # = View Model
+  #
+  # A View Model is a class that allows you to set an arbitrary hash of attributes and access all values by calling
+  # attribute methods.
+  #
+  # ==== Examples
+  #
+  #   model = ViewModel.new(a: 1, b: {b1: 1, b2: 2}, c: 3)
+  #
+  #   model.a   # => 1
+  #   model.b   # => {b1: 1, b2: 2}
+  #   model.c   # => 3
+  #
+  # Reserved methods or attributes are left untouched. If you want to access an attribute that collides with a reserved
+  # method, you can do it via the +to_hash+ method.
+  #
+  #   model = ViewModel.new(class: "test")
+  #
+  #   model.class             # => ViewModel
+  #   model.to_hash[:class]   # => "test"
+
+  def initialize(hash = {})
+    hash.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end
+  end
+
+  def attributes
+    instance_variables.map { |instance_variable| instance_variable.to_s.delete("@").to_sym }
+  end
+
+  def to_hash
+    attributes.map { |attribute| {attribute => value_for(attribute)} }.inject(:merge) || {}
+  end
+
+  alias_method :to_h, :to_hash
+
+  private
+
+  def is_defined?(attribute)
+    attributes.include?(attribute.to_sym)
+  end
+
+  def value_for(attribute)
+    reserved_methods.include?(attribute) ? instance_variable_get("@#{attribute}") : send(attribute)
+  end
+
+  def method_missing(m, *args, &block)
+    instance_variable_get("@#{m}")
+  end
+
+  def respond_to_missing?
+    true
+  end
+
+  def reserved_methods
+    Class.methods + Class.private_methods
+  end
+end

data/app/views/formstrap/_association.html.erb

@@ -0,0 +1,30 @@
+<%
+  # formstrap/association
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the association
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +collection+ - Values to create option tags for
+  #
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "formstrap/association", form: form, attribute: :product %#>
+  #   <% end %#>
+
+  association = Formstrap::AssociationView.new(local_assigns)
+
+%>
+
+<%= render "formstrap/wrapper", association.wrapper_options do %>
+  <%= render "formstrap/label", association.label_options if association.prepend_label? %>
+  <%= render "formstrap/input_group", association.input_group_options do %>
+    <%= form.select(association.attribute_with_id, formstrap: false, choices: association.collection, options: association.select_options, html_options: association.input_options) %>
+  <% end %>
+  <%= render "formstrap/validation", association.validation_options if association.validate? %>
+  <%= render "formstrap/hint", association.hint_options if association.hint? %>
+  <%= render "formstrap/label", association.label_options if association.append_label? %>
+<% end %>

data/app/views/formstrap/_autocomplete.html.erb

@@ -0,0 +1,11 @@
+<div class="h-autocomplete d-none" data-autocomplete-target="dropdown">
+<% if collection.any? %>
+  <%= render "formstrap/autocomplete/list" do %>
+    <% collection.each do |value, name| %>
+      <%= render "formstrap/autocomplete/item", value: value do %>
+        <%= name %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>
+</div>

data/app/views/formstrap/_blocks.html.erb

@@ -0,0 +1,45 @@
+<%
+  # formstrap/blocks
+  #
+  # ==== Required parameters
+  # * +form</tt> - Form object
+  # * +names</tt> - Names of block templates that can be added
+  #
+  # ==== Optional parameters
+  # * +paths</tt> - Directories where to look for block templates
+  #
+  # ==== Examples
+  #   Basic version. (looks in views/admin/blocks, views/blocks or views directory )
+  #   <%= render "formstrap/blocks", form: form, names: %w(text image button) %#>
+  #
+  #   Define one ore more path where the templates could be located:
+  #   <%= render "formstrap/blocks", form: form, names: %w(text image button), paths: %w(admin/pages/blocks) %#>
+  #
+  #   Limit the types of blocks
+  #   <%= render "formstrap/blocks", form: form, names: %w(text text_image list) %#>
+
+  blocks = Formstrap::BlocksView.new(local_assigns)
+  @lookup_context.prefixes = @lookup_context.prefixes + blocks.prefixes
+%>
+
+<%= render "formstrap/repeater", blocks.repeater_options do |block_form, template| %>
+  <% name = template || block_form.object.name %>
+  <!-- Name input of the block -->
+  <%= block_form.hidden_field :name, value: name %>
+
+  <!-- Render block form fields -->
+  <div class="<%= block_form.object.visible ? "" : "opacity-50" %>">
+    <%= render name, form: block_form %>
+  </div>
+  <% badge_style = blocks.badge_style(block_form.object) %>
+
+  <!-- Label -->
+  <span class="position-absolute top-0 end-0 badge rounded-0 d-flex align-items-center gap-2 bg-danger <%= badge_style %>">
+    <%= t("blocks.#{name}", default: name).humanize %>
+    <button type="button" class="btn p-0 <%= badge_style %>" data-bs-toggle="modal" data-bs-target="#modal-block-<%= block_form.object.id %>">
+      <%= bootstrap_icon("gear") %>
+    </button>
+  </span>
+
+  <%= render "formstrap/blocks/modal", form: block_form, name: name %>
+<% end %>

data/app/views/formstrap/_checkbox.html.erb

@@ -0,0 +1,34 @@
+<%
+  # formstrap/checkbox
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +checked_value+ - Value for checked state
+  # * +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.
+  # * +unchecked_value+ - Value for unchecked state
+  # * +wrapper+ - Hash with all options for the surrounding html tag
+  #
+  # ==== References
+  # https://headmin.dev/docs/forms/checkbox
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/check_box
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "formstrap/checkbox", form: form, attribute: :active %#>
+  #   <% end %#>
+
+  checkbox = Formstrap::CheckboxView.new(local_assigns)
+%>
+
+<%= render "formstrap/wrapper", checkbox.wrapper_options do %>
+  <%= form.check_box(checkbox.attribute, checkbox.input_options, checkbox.checked_value, checkbox.unchecked_value) %>
+  <%= render "formstrap/label", checkbox.label_options if checkbox.label? %>
+  <%= render "formstrap/validation", checkbox.validation_options if checkbox.validate? %>
+  <%= render "formstrap/hint", checkbox.hint_options if checkbox.hint? %>
+<% end %>

data/app/views/formstrap/_color.html.erb

@@ -0,0 +1,32 @@
+<%
+  # formstrap/color
+  #
+  # ==== 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.
+  # * +wrapper+ - Hash with all options for the surrounding html tag
+  #
+  # ==== References
+  # https://headmin.dev/docs/forms/color
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/color
+  # https://apidock.com/rails/v5.2.3/ActionView/Helpers/FormHelper/color_field
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "formstrap/color", form: form, attribute: :active %#>
+  #   <% end %#>
+
+  color = Formstrap::ColorView.new(local_assigns)
+%>
+
+<%= render "formstrap/wrapper", color.wrapper_options do %>
+  <%= render "formstrap/label", color.label_options if color.label? %>
+  <%= form.color_field(color.attribute, color.input_options) %>
+  <%= render "formstrap/validation", color.validation_options if color.validate? %>
+  <%= render "formstrap/hint", color.hint_options if color.hint? %>
+<% end %>

data/app/views/formstrap/_datalist.html.erb

@@ -0,0 +1,3 @@
+<datalist id="<%= id %>">
+  <%= options_for_select(collection) %>
+</datalist>

data/app/views/formstrap/_date.html.erb

@@ -0,0 +1,41 @@
+<%
+  # formstrap/date
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +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.
+  # * +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://headmin.dev/docs/forms/date
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/date_field
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "formstrap/date", form: form, attribute: :date_of_birth %#>
+  #   <% end %#>
+
+  date = Formstrap::DateView.new(local_assigns)
+%>
+
+<%= render "formstrap/wrapper", date.wrapper_options do %>
+  <%= render "formstrap/label", date.label_options if date.prepend_label? %>
+  <%= render "formstrap/input_group", date.input_group_options do %>
+    <%= form.date_field(date.attribute, date.input_options) %>
+    <%= render "formstrap/datalist", date.datalist_options if date.datalist? %>
+  <% end %>
+  <%= render "formstrap/validation", date.validation_options if date.validate? %>
+  <%= render "formstrap/hint", date.hint_options if date.hint? %>
+  <%= render "formstrap/label", date.label_options if date.append_label? %>
+<% end %>

data/app/views/formstrap/_date_range.html.erb

@@ -0,0 +1,40 @@
+<%
+  # formstrap/date_range
+  #
+  # ==== Required parameters
+  # * +form+ - Form object
+  # * +start+ - Hash with all options for the start date input (:attribute is required)
+  # * +end+ - Hash with all options for the end date input (:attribute is required)
+  #
+  # ==== Optional parameters
+  # * +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/date_range
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/date
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/date_field
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "formstrap/date_range", form: form, start: {attribute: :start_date}, end: {attribute: :end_date} %#>
+  #   <% end %#>
+
+  date_range = Formstrap::DateRangeView.new(local_assigns)
+%>
+
+<div class="row">
+  <div class="col">
+    <%= render "formstrap/date", date_range.start_options %>
+  </div>
+  <div class="col">
+    <%= render "formstrap/date", date_range.end_options %>
+  </div>
+</div>
+

data/app/views/formstrap/_datetime.html.erb

@@ -0,0 +1,41 @@
+<%
+  # formstrap/datetime
+  #
+  # ==== Required parameters
+  # * +attribute+ - Name of the attribute of the form model
+  # * +form+ - Form object
+  #
+  # ==== Optional parameters
+  # * +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.
+  # * +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://headmin.dev/docs/forms/datetime
+  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local
+  # https://apidock.com/rails/ActionView/Helpers/FormHelper/datetime_field
+  #
+  # ==== Examples
+  #   Basic version
+  #   <%= form_with do |form| %#>
+  #     <%= render "formstrap/datetime", form: form, attribute: :deadline %#>
+  #   <% end %#>
+
+  datetime = Formstrap::DatetimeView.new(local_assigns)
+%>
+
+<%= render "formstrap/wrapper", datetime.wrapper_options do %>
+  <%= render "formstrap/label", datetime.label_options if datetime.prepend_label? %>
+  <%= render "formstrap/input_group", datetime.input_group_options do %>
+    <%= form.datetime_field(datetime.attribute, datetime.input_options) %>
+    <%= render "formstrap/datalist", datetime.datalist_options if datetime.datalist? %>
+  <% end %>
+  <%= render "formstrap/validation", datetime.validation_options if datetime.validate? %>
+  <%= render "formstrap/hint", datetime.hint_options if datetime.hint? %>
+  <%= render "formstrap/label", datetime.label_options if datetime.append_label? %>
+<% end %>