headmin 0.3.2 → 0.4.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headmin
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Jef Vlamings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: closure_tree
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.27'
+        version: '3.28'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.27'
+        version: '3.28'
 description: A complete library of commonly used components to build an admin interface
   in your Ruby on Rails project.
 email:
@@ -74,8 +74,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".rubocop.yml"
+- ".nvmrc"
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -86,8 +87,14 @@ files:
 - Rakefile
 - app/assets/config/headmin_manifest.js
 - app/assets/images/avatar.jpg
+- app/assets/images/document.docx
+- app/assets/images/document.pdf
+- app/assets/images/image.jpg
+- app/assets/images/spreadsheet.xls
+- app/assets/images/video.mp4
 - app/assets/javascripts/headmin.js
 - app/assets/javascripts/headmin/config/i18n.js
+- app/assets/javascripts/headmin/controllers/autocomplete_controller.js
 - app/assets/javascripts/headmin/controllers/blocks_controller.js
 - app/assets/javascripts/headmin/controllers/date_range_controller.js
 - app/assets/javascripts/headmin/controllers/dropzone_controller.js
@@ -108,19 +115,25 @@ files:
 - app/assets/stylesheets/headmin.scss
 - app/assets/stylesheets/headmin/filter.scss
 - app/assets/stylesheets/headmin/filters.scss
-- app/assets/stylesheets/headmin/form.scss
+- app/assets/stylesheets/headmin/forms.scss
+- app/assets/stylesheets/headmin/forms/autocomplete.scss
+- app/assets/stylesheets/headmin/forms/file.scss
+- app/assets/stylesheets/headmin/forms/repeater.scss
+- app/assets/stylesheets/headmin/forms/search.scss
 - app/assets/stylesheets/headmin/general.scss
 - app/assets/stylesheets/headmin/layout.scss
 - app/assets/stylesheets/headmin/layout/body.scss
 - app/assets/stylesheets/headmin/layout/sidebar.scss
 - app/assets/stylesheets/headmin/login.scss
 - app/assets/stylesheets/headmin/overrides/bootstrap.scss
-- app/assets/stylesheets/headmin/overrides/redactorx.css
+- app/assets/stylesheets/headmin/overrides/redactorx.scss
 - app/assets/stylesheets/headmin/popup.scss
 - app/assets/stylesheets/headmin/syntax.scss
 - app/assets/stylesheets/headmin/table.scss
 - app/assets/stylesheets/headmin/thumbnail.scss
 - app/assets/stylesheets/headmin/utilities.scss
+- app/assets/stylesheets/headmin/utilities/buttons.scss
+- app/assets/stylesheets/headmin/utilities/dropzone.scss
 - app/assets/stylesheets/headmin/vendor/bootstrap/scss/_accordion.scss
 - app/assets/stylesheets/headmin/vendor/bootstrap/scss/_alert.scss
 - app/assets/stylesheets/headmin/vendor/bootstrap/scss/_badge.scss
@@ -217,7 +230,6 @@ files:
 - app/controllers/concerns/headmin/sortable.rb
 - app/helpers/headmin/admin_helper.rb
 - app/helpers/headmin/bootstrap_helper.rb
-- app/helpers/headmin/documentation_helper.rb
 - app/helpers/headmin/filter_helper.rb
 - app/helpers/headmin/form_helper.rb
 - app/helpers/headmin/notification_helper.rb
@@ -226,15 +238,45 @@ files:
 - app/models/concerns/headmin/blockable.rb
 - app/models/concerns/headmin/field.rb
 - app/models/concerns/headmin/fieldable.rb
-- app/models/headmin/documentation_renderer.rb
-- app/models/headmin/form/base.rb
-- app/models/headmin/form/text.rb
-- app/services/block_service.rb
+- app/models/concerns/headmin/form/autocompletable.rb
+- app/models/concerns/headmin/form/hintable.rb
+- app/models/concerns/headmin/form/input_groupable.rb
+- app/models/concerns/headmin/form/labelable.rb
+- app/models/concerns/headmin/form/listable.rb
+- app/models/concerns/headmin/form/placeholderable.rb
+- app/models/concerns/headmin/form/validatable.rb
+- app/models/concerns/headmin/form/wrappable.rb
+- app/models/headmin/.DS_Store
+- app/models/headmin/blocks_view.rb
+- app/models/headmin/form/blocks_view.rb
+- app/models/headmin/form/checkbox_view.rb
+- app/models/headmin/form/date_range_view.rb
+- app/models/headmin/form/date_view.rb
+- app/models/headmin/form/email_view.rb
+- app/models/headmin/form/file_view.rb
+- app/models/headmin/form/flatpickr_range_view.rb
+- app/models/headmin/form/flatpickr_view.rb
+- app/models/headmin/form/hidden_view.rb
+- app/models/headmin/form/hint_view.rb
+- app/models/headmin/form/input_group_view.rb
+- app/models/headmin/form/label_view.rb
+- app/models/headmin/form/number_view.rb
+- app/models/headmin/form/password_view.rb
+- app/models/headmin/form/redactorx_view.rb
+- app/models/headmin/form/search_view.rb
+- app/models/headmin/form/select_view.rb
+- app/models/headmin/form/switch_view.rb
+- app/models/headmin/form/text_view.rb
+- app/models/headmin/form/textarea_view.rb
+- app/models/headmin/form/url_view.rb
+- app/models/headmin/form/wrapper_view.rb
+- app/models/headmin/form/wysiwyg_view.rb
+- app/models/headmin/thumbnail_view.rb
+- app/models/view_model.rb
 - app/views/examples/admin.html.erb
 - app/views/examples/auth.html.erb
 - app/views/headmin/_blocks.html.erb
 - app/views/headmin/_breadcrumbs.html.erb
-- app/views/headmin/_card.html.erb
 - app/views/headmin/_dropdown.html.erb
 - app/views/headmin/_filters.html.erb
 - app/views/headmin/_form.html.erb
@@ -258,10 +300,10 @@ files:
 - app/views/headmin/filters/filter/_button.html.erb
 - app/views/headmin/filters/filter/_menu_item.html.erb
 - app/views/headmin/filters/filter/_template.html.erb
-- app/views/headmin/forms/_actions.html.erb
-- app/views/headmin/forms/_base.html.erb
+- app/views/headmin/forms/_autocomplete.html.erb
 - app/views/headmin/forms/_blocks.html.erb
 - app/views/headmin/forms/_checkbox.html.erb
+- app/views/headmin/forms/_datalist.html.erb
 - app/views/headmin/forms/_date.html.erb
 - app/views/headmin/forms/_date_range.html.erb
 - app/views/headmin/forms/_email.html.erb
@@ -270,21 +312,24 @@ files:
 - app/views/headmin/forms/_flatpickr.html.erb
 - app/views/headmin/forms/_flatpickr_range.html.erb
 - app/views/headmin/forms/_hidden.html.erb
-- app/views/headmin/forms/_image.html.erb
+- app/views/headmin/forms/_hint.html.erb
+- app/views/headmin/forms/_input_group.html.erb
 - app/views/headmin/forms/_label.html.erb
 - app/views/headmin/forms/_number.html.erb
 - app/views/headmin/forms/_password.html.erb
 - app/views/headmin/forms/_redactorx.html.erb
 - app/views/headmin/forms/_repeater.html.erb
+- app/views/headmin/forms/_search.html.erb
 - app/views/headmin/forms/_select.html.erb
+- app/views/headmin/forms/_switch.html.erb
 - app/views/headmin/forms/_text.html.erb
 - app/views/headmin/forms/_textarea.html.erb
 - app/views/headmin/forms/_url.html.erb
 - app/views/headmin/forms/_validation.html.erb
-- app/views/headmin/forms/_video.html.erb
-- app/views/headmin/forms/actions/_destroy.html.erb
-- app/views/headmin/forms/actions/_save.html.erb
-- app/views/headmin/forms/actions/_view.html.erb
+- app/views/headmin/forms/_wrapper.html.erb
+- app/views/headmin/forms/_wysiwyg.html.erb
+- app/views/headmin/forms/autocomplete/_item.html.erb
+- app/views/headmin/forms/autocomplete/_list.html.erb
 - app/views/headmin/forms/fields/_base.html.erb
 - app/views/headmin/forms/fields/_file.html.erb
 - app/views/headmin/forms/fields/_group.html.erb
@@ -379,10 +424,6 @@ files:
 - config/locales/headmin/views/en.yml
 - config/locales/headmin/views/nl.yml
 - config/locales/nl.yml
-- docs/blocks-and-fields.md
-- docs/blocks.md
-- docs/devise.md
-- docs/fields.md
 - esbuild-css.js
 - esbuild-js.js
 - headmin.gemspec
@@ -416,9 +457,12 @@ files:
 - lib/headmin.rb
 - lib/headmin/engine.rb
 - lib/headmin/version.rb
+- package-lock.json
 - package.json
 - src/js/headmin.js
 - src/scss/headmin.scss
+- view_model_benchmark.rb
+- yarn-error.log
 - yarn.lock
 homepage: https://github.com/insiting/headmin
 licenses:
@@ -442,7 +486,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Admin component library

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/app/assets/stylesheets/headmin/form.scss

@@ -1,132 +0,0 @@
-input[type="search"] {
-  background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='14' height='14' fill='%236c757d' viewBox='0 0 16 16'%3E%3Cpath d='M11.742 10.344a6.5 6.5 0 1 0-1.397 1.398h-.001c.03.04.062.078.098.115l3.85 3.85a1 1 0 0 0 1.415-1.414l-3.85-3.85a1.007 1.007 0 0 0-.115-.1zM12 6.5a5.5 5.5 0 1 1-11 0 5.5 5.5 0 0 1 11 0z'/%3E%3C/svg%3E%0A");
-  background-repeat: no-repeat;
-  background-position: 10px center;
-  padding-left: 35px
-}
-
-.form-control[readonly] {
-  background-color: transparent;
-}
-
-.form-label[required="required"]:after {
-  content: '*';
-  margin-left: 1px;
-}
-
-.forms-group {
-  .card-footer {
-    border-top: none;
-  }
-}
-
-.repeater {
-  position: relative;
-}
-
-.repeater-row {
-  position: relative;
-
-  :hover {
-    & > .repeater-row-remove {
-      visibility: visible;
-    }
-
-    & > .repeater-row-add {
-      visibility: visible;
-    }
-
-    & > .repeater-row-handle {
-      visibility: visible;
-    }
-  }
-}
-
-.repeater-row-remove {
-  position: absolute;
-  top: calc(50% - 17px);
-  right: -22px;
-  z-index: 2;
-  visibility: hidden;
-
-  i.bi {
-    background: white;
-    border-radius: 50%;
-  }
-}
-
-.repeater-row-add {
-  position: absolute;
-  top: calc(100% - 18px);
-  right: calc(50% - 17px);
-  z-index: 2;
-  visibility: hidden;
-
-  i.bi {
-    background: white;
-    border-radius: 50%;
-  }
-}
-
-.repeater-row-handle {
-  position: absolute;
-  top: 0;
-  left: 0;
-  height: 100%;
-  width: 18px;
-  display: flex;
-  align-items: center;
-  justify-content: center;
-  z-index: 2;
-  visibility: hidden;
-  cursor: move;
-}
-
-.h-form-file {
-  position: relative;
-
-  .h-form-file-thumbnails {
-    margin-bottom: map-get($spacers, 2);
-  }
-
-  &.h-dropzone {
-    padding: map-get($spacers, 2);
-
-    .h-form-file-thumbnails {
-      margin-bottom: 0;
-    }
-  }
-}
-
-.h-form-file-thumbnails {
-  position: relative;
-  display: flex;
-  flex-wrap: wrap;
-  gap: map-get($spacers, 2);
-}
-
-.h-form-file-thumbnail {
-  position: relative;
-  pointer-events: initial !important;
-  display: flex;
-}
-
-.h-form-file-thumbnail-remove {
-  position: absolute;
-  top: 0;
-  right: 0;
-  background: $danger;
-  width: 20px;
-  height: 20px;
-  display: flex;
-  align-items: center;
-  justify-content: center;
-  color: white;
-  border-radius: $border-radius;
-  z-index: 3;
-  cursor: pointer;
-
-  &:hover {
-    background: tint-color($danger, $btn-hover-bg-tint-amount)
-  }
-}

data/app/assets/stylesheets/headmin/overrides/redactorx.css

@@ -1,3 +0,0 @@
-.rx-container {
-    width: 100%;
-}

data/app/helpers/headmin/documentation_helper.rb

@@ -1,35 +0,0 @@
-module Headmin
-  module DocumentationHelper
-    def extract_documentation(text)
-      # Get content inside documentation block
-      starts_with = '<% documentation do %>\n'
-      ends_with = '\n<% end %>'
-      between = text[/#{starts_with}(.*?)#{ends_with}/m, 1]
-
-      # Remove leading whitespaces from each line
-      between.lines.map { |line| line.sub('  ', '') }.join
-    end
-
-    def markdown_to_html(text)
-      renderer = Headmin::DocumentationRenderer.new(escape_html: true)
-      markdown = Redcarpet::Markdown.new(renderer, tables: true, fenced_code_blocks: true)
-      markdown.render(text)
-    end
-
-    def documentation(template = nil)
-      # Disable rendering inside block
-      return if block_given?
-
-      # Read contents of template
-      content = @lookup_context.find_template(template, nil, true).encode!
-
-      # Extract documentation
-      content = extract_documentation(content)
-
-      # Convert markdown into HTML
-      html = markdown_to_html(content)
-
-      raw html
-    end
-  end
-end

data/app/models/headmin/documentation_renderer.rb

@@ -1,32 +0,0 @@
-module Headmin
-  class DocumentationRenderer < Redcarpet::Render::HTML
-    def block_code(code, language)
-      if language == "erbx"
-        "<div class=\"card mb-3\"><div class=\"card-body\">#{render_code(code)}</div><div class=\"card-footer\"><pre><code class=\"h-syntax\">#{highlight_syntax(code, 'erb')}</code></pre></div></div>"
-      else
-        "<pre><code class=\"h-syntax\">#{highlight_syntax(code, language)}</code></pre></div>"
-      end
-    end
-
-    def table(header, body)
-      "<table class=\"table table-sm\">#{header}#{body}</table>"
-    end
-
-    private
-
-    def highlight_syntax(code, language)
-      formatter = Rouge::Formatters::HTML.new
-      lexer = Rouge::Lexer.find(language)
-      formatter.format(lexer.lex(code))
-    end
-
-    def render_code(code)
-      ApplicationController.renderer.new(
-        'action_dispatch.request.path_parameters' => {
-          controller: 'main',
-          action: 'index'
-        }
-      ).render(inline: code)
-    end
-  end
-end

data/app/models/headmin/form/base.rb

@@ -1,79 +0,0 @@
-module Headmin
-  module Form
-    class Base
-      def initialize(local_assigns)
-        @local_assigns = local_assigns
-      end
-
-      def class_names
-        class_names = [@local_assigns[:class]]
-        class_names << "form-floating" if float
-        class_names << "mb-3 text-start"
-        class_names.join(" ")
-      end
-
-      def data
-        @local_assigns[:data]
-      end
-
-      def label_options
-        {
-          attribute: attribute,
-          class: "d-block",
-          for: id,
-          form: form,
-          required: required,
-          text: label
-        }
-      end
-
-      def required
-        @local_assigns[:required]
-      end
-
-      def form
-        @local_assigns[:form]
-      end
-
-      def id
-        @local_assigns[:id]
-      end
-
-      def validation_options
-        {
-          attribute: attribute,
-          form: form
-        }
-      end
-
-      def attribute
-        @local_assigns[:attribute]
-      end
-
-      def list
-        @local_assigns[:list]
-      end
-
-      def list_id
-        list ? "#{attribute}_list" : nil
-      end
-
-      def append
-        @local_assigns[:append]
-
-      end
-
-      def prepend
-        @local_assigns[:prepend]
-      end
-
-      def float
-        @local_assigns[:float] || false
-      end
-
-      def label
-        @local_assigns[:label]
-      end
-    end
-  end
-end

data/app/models/headmin/form/text.rb

@@ -1,53 +0,0 @@
-module Headmin
-  module Form
-    class Text
-      def initialize(local_assigns, request)
-        @local_assigns = local_assigns
-        @request = request
-      end
-
-      def placeholder
-        @local_assigns[:float] ? @local_assigns[:placeholder] || attribute : @local_assigns[:placeholder]
-      end
-
-      def attribute
-        @local_assigns[:attribute]
-      end
-
-      def form
-        @local_assigns[:form]
-      end
-
-      def options
-        option_keys = %i(aria autocomplete autofocus data disabled id maxlength minlength list pattern placeholder readonly required spellcheck size value)
-        @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
-        )
-      end
-
-      def local_assigns
-        @local_assigns
-      end
-
-      def form_field_valid?(form, name)
-        return unless form.object
-
-        !form.object.errors.has_key?(name)
-      end
-
-      def form_field_validation_id(form, name)
-        return unless form.object
-
-        [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
-    end
-  end
-end

data/app/services/block_service.rb

@@ -1,72 +0,0 @@
-class BlockService
-  def self.block_names(path:)
-    form_views(path: path).map do |view|
-      view_name(view)
-    end
-  end
-
-  def self.form_view(name, path:)
-    view_by_name(name, form_view_paths(path))
-  end
-
-  def self.frontend_view(name, path:)
-    view_by_name(name, frontend_view_paths(path))
-  end
-
-  def self.frontend_views(path:)
-    views(frontend_view_paths(path))
-  end
-
-  def self.form_views(path:)
-    views(form_view_paths(path))
-  end
-
-  def self.view_name(view)
-    filename = File.basename(view.split('.')[0])
-
-    # Removes leading _ if exists
-    filename.sub(/^_/, '')
-  end
-
-  private
-
-  # Looks for a block view by its name.
-  #
-  # It will first search in a specified path and will fallback to the default path
-  # An exception will be raised if the view is nowhere to be found
-  def self.view_by_name(name, paths)
-    views = views(paths)
-    view = views.find { |view| view.include?("/_#{name}.html.erb") }
-
-    unless view
-      prefixes = paths.map { |path| path.split('app/views/').last }
-      raise ActionView::MissingTemplate.new(paths, name, prefixes, true, "headmin") unless view
-    end
-
-    view
-  end
-
-  def self.form_view_paths(path)
-    [app_view_path(path), app_view_path('admin/blocks')].uniq
-  end
-
-  def self.frontend_view_paths(path)
-    [app_view_path(path), app_view_path('website/blocks')].uniq
-  end
-
-  def self.app_view_path(path)
-    base_path = 'app/views'
-    [base_path, path].join('/')
-  end
-
-  def self.views(paths)
-    paths.map { |path| views_in_path(path) }.flatten
-  end
-
-  def self.views_in_path(path)
-    files = Dir.glob("#{path}/*")
-    files.map do |file|
-      file.split('app/views/').last
-    end
-  end
-end

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

@@ -1,52 +0,0 @@
-<% warn "[DEPRECATION] `headmin/card` is deprecated. Please use plain Bootstrap markup." %>
-<%
-  # DEPRECATED in 0.3
-  # headmin/card
-  #
-  # ==== Options
-  # * +title</tt> - Title for card
-  # * +description</tt> - Description for card
-  # * +id</tt> - HTML Id Attribute
-  # * +padded</tt> - Set to true if you want to render the block content inside the card-body element
-  #
-  # ==== Examples
-  #   Basic version.
-  #   <%= render 'headmin/card' do %#>
-  #      Your content
-  #   <% end %#>
-  #
-  #   Title and description
-  #   <%= render 'headmin/card', title: 'Title', description: 'Description' do %#>
-  #      Your content
-  #   <% end %#>
-
-  id = local_assigns.has_key?(:id) ? id : nil
-  title = local_assigns.has_key?(:title) ? title : nil
-  description = local_assigns.has_key?(:description) ? description : nil
-  padded = local_assigns.has_key?(:padded) ? padded : true
-%>
-
-<div class="card mb-3 shadow-sm" id="<%= id %>">
-
-  <% if padded || title || description %>
-    <div class="card-body">
-      <% if title.present? %>
-        <h5 class="card-title"><%= title %></h5>
-      <% end %>
-
-      <% if description.present? %>
-        <p class="card-text text-secondary"><%= description %></p>
-      <% end %>
-
-      <!-- Render inside body-->
-      <% if padded %>
-        <%= yield %>
-      <% end %>
-    </div>
-  <% end %>
-
-  <!-- Render outside body-->
-  <% unless padded %>
-    <%= yield %>
-  <% end %>
-</div>