super 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b01ea90f28d8e14b5a5f4bd454e2a15676b9c95623200a17d1a2ed2fb71d87f
-  data.tar.gz: 753365f90dcc880f4249ab60d9eea04034189fd221ecb03d500a8fc78f02a7a9
+  metadata.gz: 043677dcee80c7b83903b21904f1768a411f807567190d7227928df9bf7922c7
+  data.tar.gz: 5de2f073926089e4823a4228dc4f7be912fed0471d862f9b6f0f56dde280f154
 SHA512:
-  metadata.gz: ec08f45761eefc5645daa6f4976b9b3844fba97c04b81ddbee3217dfd6392666c30eabb7e7a2eca0516f2dad861b4f8a5f85ac8ac36ed583baa6dcb38d7fb4f2
-  data.tar.gz: ed215af314d49cc4454ba98cb8fd84d351ca32808de1eceaa4c079b2199f18bfbd6ebfc1aa8d388738012868b764482741d933e1e232ac1cf30bf02f3effe26f
+  metadata.gz: feeba0baacdaf977c16f9e785e7abf6637679ebe2f624716f1006cce290157e29157b046a01f3d287d1b826378a04ece8c482b59cd2f21dc53bf463a28cf2848
+  data.tar.gz: a7d1a568a4c918ececb0200305f1e30042b4fc48946796f13e9568c27b5f95368b60aaac51ac977211566cb79f4973dd3d96a48a421531934c41884ce33ac084

data/app/assets/javascripts/super/application.js

@@ -4303,8 +4303,6 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
 
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 var _default = /*#__PURE__*/function (_Controller) {
   _inherits(_default, _Controller);
 
@@ -4324,14 +4322,17 @@ var _default = /*#__PURE__*/function (_Controller) {
       var content = this.templateTarget.innerHTML.replace(/TEMPLATEINDEX/g, unixtime.toString());
       this.templateTarget.insertAdjacentHTML("beforebegin", content);
     }
+  }], [{
+    key: "targets",
+    get: function get() {
+      return ["template"];
+    }
   }]);
 
   return _default;
 }(_stimulus.Controller);
 
 exports.default = _default;
-
-_defineProperty(_default, "targets", ["template"]);
 },{"stimulus":"../node_modules/stimulus/index.js"}],"javascripts/super/toggle_pending_destruction_controller.js":[function(require,module,exports) {
 "use strict";
 

data/app/helpers/super/form_builder_helper.rb

@@ -0,0 +1,23 @@
+module Super
+  module FormBuilderHelper
+    def super_form_for(record, options = {}, &block)
+      original = ActionView::Base.field_error_proc
+      ActionView::Base.field_error_proc = Form::Builder::FIELD_ERROR_PROC
+
+      options[:builder] ||= Form::Builder
+      return form_for(record, options, &block)
+    ensure
+      ActionView::Base.field_error_proc = original
+    end
+
+    def super_form_with(**options, &block)
+      original = ActionView::Base.field_error_proc
+      ActionView::Base.field_error_proc = Form::Builder::FIELD_ERROR_PROC
+
+      options[:builder] ||= Form::Builder
+      return form_with(**options, &block)
+    ensure
+      ActionView::Base.field_error_proc = original
+    end
+  end
+end

data/app/views/super/application/_filter.html.erb

@@ -1,6 +1,6 @@
 <%= render(Super::Panel.new) do %>
   <h1 class="text-xl">Filters</h1>
-  <%= form_for(filter, url: filter.url, method: :get, as: :q, html: { class: "mt-4" }) do |form| %>
+  <%= super_form_for(filter, url: filter.url, method: :get, as: :q, html: { class: "mt-4" }) do |form| %>
     <% filter.each_field do |filter_field| %>
       <div class="mt-4">
         <%= render(filter_field, form: form) %>
@@ -8,7 +8,7 @@
     <% end %>
 
     <div>
-      <%= form.submit "Filter", class: "super-button super-button--border-gray mt-6" %>
+      <%= form.super.submit "Filter", class: "super-button--border-gray mt-6" %>
     </div>
   <% end %>
 <% end %>

data/app/views/super/application/_filter_type_select.html.erb

@@ -1,31 +1,18 @@
 <div class="super-field-group">
   <%= form.fields_for(filter_type_select.field_name, filter_type_select) do |form_field| %>
     <%= form_field.label(:q, filter_type_select.humanized_field_name) %>
-    <div class="super-input-select inline-block">
-      <%= form_field.select(
+    <div class="relative inline-block">
+      <%= form_field.super.select(
         :op,
         filter_type_select.operators,
-        {},
-        { class: "super-input super-input-select-field" }
+        { include_blank: false },
       ) %>
-      <div class="super-input-select-icon text-gray-700">
-        <span class="h-4 w-4">
-          <%= render "super/feather/chevron_down" %>
-        </span>
-      </div>
     </div>
-    <div class="super-input-select mt-3">
-      <%= form_field.select(
+    <div class="mt-3">
+      <%= form_field.super.select(
         :q,
         filter_type_select.field_type.collection,
-        { include_blank: true },
-        { class: "super-input super-input-select-field" }
       ) %>
-      <div class="super-input-select-icon text-gray-700">
-        <span class="h-4 w-4">
-          <%= render "super/feather/chevron_down" %>
-        </span>
-      </div>
     </div>
   <% end %>
 </div>

data/app/views/super/application/_filter_type_text.html.erb

@@ -2,21 +2,15 @@
   <%= form.fields_for(filter_type_text.field_name, filter_type_text) do |form_field| %>
     <%= form_field.label(:q, filter_type_text.humanized_field_name) %>
     <div class="relative inline-block">
-      <%= form_field.select(
+      <%= form_field.super.select(
         :op,
         filter_type_text.operators,
-        {},
-        { class: "super-input super-input-select-field" }
+        { include_blank: false }
       ) %>
-      <div class="super-input-select-icon text-gray-700">
-        <span class="h-4 w-4">
-          <%= render "super/feather/chevron_down" %>
-        </span>
-      </div>
     </div>
-    <%= form_field.text_field(
+    <%= form_field.super.text_field(
       :q,
-      class: "super-input w-full mt-3"
+      class: "mt-3"
     ) %>
   <% end %>
 </div>

data/app/views/super/application/_filter_type_timestamp.html.erb

@@ -2,33 +2,21 @@
   <%= form.fields_for(filter_type_timestamp.field_name, filter_type_timestamp) do |form_field| %>
     <%= form_field.label(:q0, filter_type_timestamp.humanized_field_name) %>
     <div class="relative inline-block mt-2">
-      <%= form_field.select(
+      <%= form_field.super.select(
         :op,
         filter_type_timestamp.operators,
-        {},
-        { class: "super-input super-input-select-field" }
+        { include_blank: false}
       ) %>
-      <div class="super-input-select-icon text-gray-700">
-        <span class="h-4 w-4">
-          <%= render "super/feather/chevron_down" %>
-        </span>
-      </div>
     </div>
     <div class="flex items-center mt-3">
       <div class="flex-initial">
-        <%= form_field.text_field(
-          :q0,
-          class: "super-input w-full"
-        ) %>
+        <%= form_field.super.text_field(:q0) %>
       </div>
       <div class="flex-initial px-2">
         &ndash;
       </div>
       <div class="flex-initial">
-        <%= form_field.text_field(
-          :q1,
-          class: "super-input w-full"
-        ) %>
+        <%= form_field.super.text_field(:q1) %>
       </div>
     </div>
   <% end %>

data/app/views/super/application/_form_field__destroy.html.erb

@@ -1,9 +1 @@
-<% if !local_assigns[:ungrouped] %>
-  <div class="super-field-group">
-<% end %>
-  <%= form.check_box(column, data: { action: "toggle-pending-destruction#call" }) %>
-  <%= form.label(column) %>
-  <%= render "form_inline_errors", form: form, column: column %>
-<% if !local_assigns[:ungrouped] %>
-  </div>
-<% end %>
+<%= form.super.check_box!(column, field: { data: { action: "toggle-pending-destruction#call" } }) %>

data/app/views/super/application/_form_field_checkbox.html.erb

@@ -1,15 +1 @@
-<% if !local_assigns[:ungrouped] %>
-  <div class="super-field-group">
-<% end %>
-  <div class="<%= Super::ViewHelper.classes(["mt-1", !local_assigns[:hide_label]]) %>">
-    <div>
-      <%= form.check_box(column) %>
-      <% if !local_assigns[:hide_label] %>
-        <%= form.label(column, class: "select-none") %>
-      <% end %>
-    </div>
-    <%= render "form_inline_errors", form: form, column: column %>
-  </div>
-<% if !local_assigns[:ungrouped] %>
-  </div>
-<% end %>
+<%= form.super.check_box!(column) %>

data/app/views/super/application/_form_field_rich_text_area.html.erb

@@ -1,13 +1 @@
-<% if !local_assigns[:ungrouped] %>
-  <div class="super-field-group">
-<% end %>
-  <% if !local_assigns[:hide_label] %>
-    <%= form.label(column, class: "block") %>
-  <% end %>
-  <div class="<%= Super::ViewHelper.classes(["mt-1", !local_assigns[:hide_label]]) %>">
-    <%= form.rich_text_area(column, class: "trix-content super-input w-full") %>
-    <%= render "form_inline_errors", form: form, column: column %>
-  </div>
-<% if !local_assigns[:ungrouped] %>
-  </div>
-<% end %>
+<%= form.super.rich_text_area!(column) %>

data/app/views/super/application/_form_field_select.html.erb

@@ -1,23 +1 @@
-<% if !local_assigns[:ungrouped] %>
-  <div class="super-field-group">
-<% end %>
-  <% if !local_assigns[:hide_label] %>
-    <%= form.label(column, class: "block") %>
-  <% end %>
-  <div class="<%= Super::ViewHelper.classes("super-input-select", ["mt-1", !local_assigns[:hide_label]]) %>">
-    <%= form.select(
-      column,
-      form_field_select[:collection],
-      { include_blank: true }.merge(form_field_select[:options] || {}),
-      { class: "super-input super-input-select-field" }
-    ) %>
-    <div class="super-input-select-icon text-gray-700">
-      <span class="h-4 w-4">
-        <%= render "super/feather/chevron_down" %>
-      </span>
-    </div>
-  </div>
-  <%= render "form_inline_errors", form: form, column: column %>
-<% if !local_assigns[:ungrouped] %>
-  </div>
-<% end %>
+<%= form.super.select!(column, form_field_select[:collection]) %>

data/app/views/super/application/_form_field_text.html.erb

@@ -1,13 +1 @@
-<% if !local_assigns[:ungrouped] %>
-  <div class="super-field-group">
-<% end %>
-  <% if !local_assigns[:hide_label] %>
-    <%= form.label(column, class: "block") %>
-  <% end %>
-  <div class="<%= Super::ViewHelper.classes(["mt-1", !local_assigns[:hide_label]]) %>">
-    <%= form.text_field(column, class: "super-input w-full") %>
-    <%= render "form_inline_errors", form: form, column: column %>
-  </div>
-<% if !local_assigns[:ungrouped] %>
-  </div>
-<% end %>
+<%= form.super.text_field!(column) %>

data/app/views/super/application/_super_schema_display_index.html.erb

@@ -1,9 +1,9 @@
-<div class="mt-4 overflow-x-auto lg:overflow-x-visible">
+<div class="mt-4 overflow-x-auto">
   <table class="w-full border-separate relative" cellspacing="0" cellpadding="0">
     <thead class="">
       <tr class="">
         <% super_schema_display_index.each_attribute_name do |attribute_name| %>
-          <th class="p-2 first:pl-6 border-b border-b-2 border-gray-400 text-gray-600 text-left text-sm font-normal bg-white sticky top-0 z-10">
+          <th class="p-2 first:pl-6 border-b border-b-2 border-gray-400 text-gray-600 text-left text-sm font-normal bg-white top-0 z-10">
             <%= controls.model.human_attribute_name(attribute_name) %>
           </th>
         <% end %>

data/app/views/super/application/_super_schema_form.html.erb

@@ -1,4 +1,4 @@
-<%= form_for(Super.configuration.path_parts(@record), builder: Super::Form::Builder) do |f| %>
+<%= super_form_for(Super.configuration.path_parts(@record), builder: Super::Form::Builder) do |f| %>
   <div class="max-w-3xl">
     <% super_schema_form.each_attribute do |field, type| %>
       <%= render(
@@ -9,7 +9,7 @@
     <% end %>
 
     <div>
-      <%= f.submit class: "super-button super-button--fill-blue mt-2" %>
+      <%= f.super.submit class: "super-button--fill-blue mt-2" %>
     </div>
   </div>
 <% end %>

data/app/views/super/application/edit.html.erb

@@ -1 +1,2 @@
+<% raise Super::Error::NothingToRender, "edit" if @view.nil? %>
 <%= render(@view) %>

data/app/views/super/application/index.html.erb

@@ -1 +1,2 @@
+<% raise Super::Error::NothingToRender, "index" if @view.nil? %>
 <%= render(@view) %>

data/app/views/super/application/new.html.erb

@@ -1 +1,2 @@
+<% raise Super::Error::NothingToRender, "new" if @view.nil? %>
 <%= render(@view) %>

data/app/views/super/application/show.html.erb

@@ -1 +1,2 @@
+<% raise Super::Error::NothingToRender, "show" if @view.nil? %>
 <%= render(@view) %>

data/frontend/super-frontend/dist/application.js

@@ -4303,8 +4303,6 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
 
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 var _default = /*#__PURE__*/function (_Controller) {
   _inherits(_default, _Controller);
 
@@ -4324,14 +4322,17 @@ var _default = /*#__PURE__*/function (_Controller) {
       var content = this.templateTarget.innerHTML.replace(/TEMPLATEINDEX/g, unixtime.toString());
       this.templateTarget.insertAdjacentHTML("beforebegin", content);
     }
+  }], [{
+    key: "targets",
+    get: function get() {
+      return ["template"];
+    }
   }]);
 
   return _default;
 }(_stimulus.Controller);
 
 exports.default = _default;
-
-_defineProperty(_default, "targets", ["template"]);
 },{"stimulus":"../node_modules/stimulus/index.js"}],"javascripts/super/toggle_pending_destruction_controller.js":[function(require,module,exports) {
 "use strict";
 

data/lib/super.rb

@@ -23,6 +23,7 @@ require "super/filter/schema_types"
 require "super/form"
 require "super/form/builder"
 require "super/form/guesser"
+require "super/form/inline_errors"
 require "super/form/schema_types"
 require "super/form/strong_params"
 require "super/layout"

data/lib/super/engine.rb

@@ -1,6 +1,8 @@
 module Super
   # Configures the host Rails app to work with Super
   class Engine < ::Rails::Engine
+    isolate_namespace Super
+
     initializer "super.assets.precompile" do |app|
       if Super::Assets::Handler.sprockets_available?
         app.config.assets.precompile << "config/super_manifest.js"

data/lib/super/error.rb

@@ -13,5 +13,14 @@ module Super
     class ActionInquirerError < Error; end
     # Error raised when a `Super::Link` couldn't be found
     class LinkNotRegistered < Error; end
+    # Error raised when rendering if `@view` wasn't set by the controller
+    class NothingToRender < Error
+      def initialize(basename)
+        super(
+          "Super's built-in `#{basename}.html.erb` requires `@view` to be set " \
+          "by the controller, but it wasn't set"
+        )
+      end
+    end
   end
 end

data/lib/super/form/builder.rb

@@ -1,48 +1,204 @@
 module Super
   class Form
-    module FieldErrorProc
-      def error_wrapping(html_tag)
-        if Thread.current[:super_form_builder]
-          return html_tag
-        end
+    # Example
+    #
+    # ```ruby
+    # super_form_for([:admin, @member]) do |f|
+    #   # the long way
+    #   f.super.label :name
+    #   f.super.text_field :name
+    #   f.super.inline_errors :name
+    #
+    #   # the short way (slightly different from the long way, for alignment)
+    #   f.super.text_field! :position
+    # end
+    # ```
+    #
+    # Refer to the Rails docs:
+    # https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html
+    class Builder < ActionView::Helpers::FormBuilder
+      FIELD_ERROR_PROC = proc { |html_tag, instance| html_tag }
+      FORM_BUILDER_DEFAULTS = { builder: self }.freeze
 
-        super
+      def super(**options)
+        @super_wrappers ||= Wrappers.new(self, @template)
       end
-    end
 
-    class Builder < ActionView::Helpers::FormBuilder
-      # These methods were originally defined in the following files
-      #
-      # * actionview/lib/action_view/helpers/form_helper.rb
-      # * actionview/lib/action_view/helpers/form_options_helper.rb
-      # * actionview/lib/action_view/helpers/date_helper.rb
-      %w[
-        label text_field password_field hidden_field file_field text_area
-        check_box radio_button color_field search_field telephone_field
-        date_field time_field datetime_field month_field week_field url_field
-        email_field number_field range_field
-
-        select collection_select grouped_collection_select time_zone_select
-        collection_radio_buttons collection_check_boxes
-
-        time_select datetime_select date_select
-      ].each do |field_type_method|
-        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-          def #{field_type_method}(*)
-            Thread.current[:super_form_builder] = true
-            super
-          ensure
-            Thread.current[:super_form_builder] = nil
+      class Wrappers
+        def initialize(builder, template)
+          @builder = builder
+          @template = template
+        end
+
+        def inline_errors(attribute)
+          if @builder.object
+            messages = InlineErrors.error_messages(@builder.object, attribute).map do |msg|
+              error_content_tag(msg)
+            end
+
+            @template.safe_join(messages)
+          else
+            error_content_tag(<<~MSG.html_safe)
+              This form doesn't have an object, so something is probably wrong.
+              Maybe <code>accepts_nested_attributes_for</code> isn't set up?
+            MSG
           end
-        RUBY
-      end
+        end
+
+        def label(attribute, text = nil, options = {}, &block)
+          options, defaults = split_defaults(options, class: "block")
+          options[:class] = join_classes(defaults[:class], options[:class])
+
+          @builder.label(attribute, text, options, &block)
+        end
+
+        def check_box(attribute, options = {}, checked_value = "1", unchecked_value = "0")
+          @builder.check_box(attribute, options, checked_value, unchecked_value)
+        end
+
+        def password_field(attribute, options = {})
+          options, defaults = split_defaults(options, class: "super-input w-full")
+          options[:class] = join_classes(defaults[:class], options[:class])
+
+          @builder.password_field(attribute, options)
+        end
+
+        def rich_text_area(attribute, options = {})
+          options, defaults = split_defaults(options, class: "trix-content super-input w-full")
+          options[:class] = join_classes(defaults[:class], options[:class])
+
+          @builder.rich_text_area(attribute, options)
+        end
+
+        def select(attribute, choices, options = {}, html_options = {}, &block)
+          options, defaults = split_defaults(options, include_blank: true)
+          options = defaults.merge(options)
+          html_options, html_defaults = split_defaults(html_options, class: "super-input super-input-select-field")
+          html_options[:class] = join_classes(html_defaults[:class], html_options[:class])
+
+          parts = [
+            %(<div class="super-input-select">).html_safe,
+            @builder.select(attribute, choices, options, html_options, &block),
+            <<~HTML.html_safe,
+              <div class="super-input-select-icon text-blue-700">
+                <span class="h-4 w-4">
+            HTML
+            @template.render("super/feather/chevron_down"),
+            <<~HTML.html_safe,
+                </span>
+              </div>
+            HTML
+            %(</div>).html_safe,
+          ]
+
+          @template.safe_join(parts)
+        end
+
+        def submit(value = nil, options = {})
+          value, options = nil, value if value.is_a?(Hash)
+          options, defaults = split_defaults(options, class: "super-button")
+          options[:class] = join_classes(defaults[:class], options[:class])
+
+          @builder.submit(value, options)
+        end
+
+        def text_field(attribute, options = {})
+          options, defaults = split_defaults(options, class: "super-input w-full")
+          options[:class] = join_classes(defaults[:class], options[:class])
+
+          @builder.text_field(attribute, options)
+        end
 
-      alias datetime_local_field datetime_field
-      alias phone_field telephone_field
+        def container(&block)
+          @template.content_tag(:div, class: "super-field-group", &block)
+        end
+
+        def check_box!(attribute, checked_value = "1", unchecked_value = "0", label: {}, field: {}, show_errors: true)
+          label[:super] ||= {}
+          label[:super] = { class: "select-none ml-1" }.merge(label[:super])
+          container do
+            compact_join([
+              "<div>".html_safe,
+              public_send(:check_box, attribute, field, checked_value, unchecked_value),
+              public_send(:label, attribute, nil, label),
+              "</div>".html_safe,
+              show_errors && inline_errors(attribute),
+            ])
+          end
+        end
+
+        def password_field!(attribute, label: {}, field: {}, show_errors: true)
+          container do
+            compact_join([
+              public_send(:label, attribute, label),
+              %(<div class="mt-1">).html_safe,
+              public_send(:password_field, attribute, field),
+              show_errors && inline_errors(attribute),
+              %(</div>).html_safe,
+            ])
+          end
+        end
+
+        def rich_text_area!(attribute, label: {}, field: {}, show_errors: true)
+          container do
+            compact_join([
+              public_send(:label, attribute, label),
+              %(<div class="mt-1">).html_safe,
+              public_send(:rich_text_area, attribute, field),
+              show_errors && inline_errors(attribute),
+              %(</div>).html_safe,
+            ])
+          end
+        end
+
+        def select!(attribute, collection, label: {}, field: {}, show_errors: true)
+          container do
+            compact_join([
+              public_send(:label, attribute, label),
+              %(<div class="mt-1">).html_safe,
+              public_send(:select, attribute, collection, field),
+              show_errors && inline_errors(attribute),
+              %(</div>).html_safe,
+            ])
+          end
+        end
+
+        def text_field!(attribute, label: {}, field: {}, show_errors: true)
+          container do
+            compact_join([
+              public_send(:label, attribute, label),
+              %(<div class="mt-1">).html_safe,
+              public_send(:text_field, attribute, field),
+              show_errors && inline_errors(attribute),
+              %(</div>).html_safe,
+            ])
+          end
+        end
+
+        private
+
+        def split_defaults(options, **internal_defaults)
+          defaults = options.delete(:super) || {}
+          # prefer options set in `defaults`, since they are user overrides
+          defaults = internal_defaults.merge(defaults)
+
+          [options, defaults]
+        end
+
+        def join_classes(*class_lists)
+          class_lists.flatten.map(&:presence).compact
+        end
+
+        def error_content_tag(content)
+          @template.content_tag(:p, content, class: "text-red-400 text-xs italic pt-1")
+        end
+
+        def compact_join(*parts)
+          @template.safe_join(
+            parts.flatten.map(&:presence).compact
+          )
+        end
+      end
     end
   end
 end
-
-ActionView::Helpers::Tags::Base.class_eval do
-  prepend Super::Form::FieldErrorProc
-end