super 0.0.6 → 0.0.11

data/lib/super/form.rb

@@ -1,48 +1,37 @@
+# frozen_string_literal: true
+
 module Super
+  # This schema type is used on your +#edit+ and +#new+ forms
+  #
+  # ```ruby
+  # class MembersController::Controls
+  #   # ...
+  #
+  #   def new_schema
+  #     Super::Form.new do |fields, type|
+  #       fields[:name] = type.string
+  #       fields[:rank] = type.select
+  #       fields[:position] = type.string
+  #       fields[:ship_id] = type.select(
+  #         collection: Ship.all.map { |s| ["#{s.name} (Ship ##{s.id})", s.id] },
+  #       )
+  #     end
+  #   end
+  #
+  #   # ...
+  # end
+  # ```
   class Form
-    module FieldErrorProc
-      def error_wrapping(html_tag)
-        if Thread.current[:super_form_builder]
-          return html_tag
-        end
+    include Schema::Common
 
-        super
-      end
+    def initialize
+      @fields = Schema::Fields.new
+      @schema_types = SchemaTypes.new(fields: @fields)
+      yield(@fields, @schema_types)
     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
-          end
-        RUBY
-      end
-
-      alias datetime_local_field datetime_field
-      alias phone_field telephone_field
+    def to_partial_path
+      "super_schema_form"
     end
   end
 end
-
-ActionView::Helpers::Tags::Base.class_eval do
-  prepend Super::Form::FieldErrorProc
-end

data/lib/super/form/builder.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module Super
+  class Form
+    # 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
+
+      def super(**options)
+        @super_wrappers ||= Wrappers.new(self, @template)
+      end
+
+      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
+        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
+
+        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

data/lib/super/form/guesser.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Super
+  class Form
+    class Guesser
+      def initialize(model:, fields:, type:)
+        @model = model
+        @fields = fields
+        @type = type
+      end
+
+      def call
+        Schema::Guesser
+          .new(model: @model, fields: @fields, type: @type)
+          .assign_type { |attribute_name| attribute_type_for(attribute_name) }
+          .reject { |attribute_name| attribute_name == "id" }
+          .reject { |attribute_name| attribute_name == "created_at" }
+          .reject { |attribute_name| attribute_name == "updated_at" }
+          .call
+      end
+
+      private
+
+      def attribute_type_for(attribute_name)
+        @type.string
+      end
+    end
+  end
+end

data/lib/super/form/inline_errors.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Super
+  class Form
+    module InlineErrors
+      module_function
+
+      def error_messages(model_instance, column_or_association)
+        errable_fields(model_instance, column_or_association)
+          .flat_map { |field| Compatability.errable_fields(field) }
+          .flat_map { |field| model_instance.errors.full_messages_for(field) }
+          .uniq
+      end
+
+      def errable_fields(model_instance, column_or_association)
+        column_or_association = column_or_association.to_s
+        reflection = model_instance.class.reflect_on_association(column_or_association)
+        reflection ||= model_instance.class.reflections.values.find { |r| r.foreign_key == column_or_association }
+
+        if reflection
+          [reflection.name.to_s, reflection.foreign_key.to_s]
+        else
+          [column_or_association]
+        end
+      end
+    end
+  end
+end

data/lib/super/form/schema_types.rb

@@ -1,26 +1,7 @@
+# frozen_string_literal: true
+
 module Super
   class Form
-    # This schema type is used on your +#edit+ and +#new+ forms
-    #
-    # ```ruby
-    # class MembersController::Controls
-    #   # ...
-    #
-    #   def new_schema
-    #     Super::Schema.new(Super::Form::SchemaTypes.new) do |fields, type|
-    #       fields[:name] = type.generic("form_field_text")
-    #       fields[:rank] = type.generic("form_field_select", collection: Member.ranks.keys)
-    #       fields[:position] = type.generic("form_field_text")
-    #       fields[:ship_id] = type.generic(
-    #         "form_field_select",
-    #         collection: Ship.all.map { |s| ["#{s.name} (Ship ##{s.id})", s.id] },
-    #       )
-    #     end
-    #   end
-    #
-    #   # ...
-    # end
-    # ```
     class SchemaTypes
       class Generic
         def initialize(partial_path:, extras:, nested:)
@@ -31,6 +12,16 @@ module Super
 
         attr_reader :nested_fields
 
+        def each_attribute
+          if block_given?
+            @nested_fields.each do |key, value|
+              yield(key, value)
+            end
+          end
+
+          enum_for(:each_attribute)
+        end
+
         # This takes advantage of a feature of Rails. If the value of
         # `#to_partial_path` is `my_form_field`, Rails renders
         # `app/views/super/application/_my_form_field.html.erb`, and this
@@ -69,17 +60,32 @@ module Super
         end
       end
 
-      def before_yield(fields:)
+      def initialize(fields:)
         @fields = fields
       end
 
-      def after_yield
-      end
-
       def generic(partial_path, **extras)
         Generic.new(partial_path: partial_path, extras: extras, nested: {})
       end
 
+      def select(**extras)
+        Generic.new(partial_path: "form_field_select", extras: extras, nested: {})
+      end
+
+      def string(**extras)
+        Generic.new(partial_path: "form_field_text", extras: extras, nested: {})
+      end
+
+      alias text string
+
+      def rich_text_area(**extras)
+        Generic.new(partial_path: "form_field_rich_text_area", extras: extras, nested: {})
+      end
+
+      def checkbox(**extras)
+        Generic.new(partial_path: "form_field_checkbox", extras: extras, nested: {})
+      end
+
       def has_many(reader, **extras)
         nested = @fields.nested do
           yield
@@ -113,10 +119,6 @@ module Super
           nested: {}
         )
       end
-
-      def to_partial_path
-        "super_schema_form"
-      end
     end
   end
 end

data/lib/super/form/strong_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Super
+  class Form
+    class StrongParams
+      def initialize(form_schema)
+        @form_schema = form_schema
+      end
+
+      def require(model)
+        model.model_name.singular
+      end
+
+      def permit
+        unfurl(@form_schema)
+      end
+
+      private
+
+      def unfurl(responds_to_each_attribute)
+        responds_to_each_attribute.each_attribute.map do |name, type|
+          if type.nested_fields&.any?
+            { name => [:id, *unfurl(type)] }
+          else
+            name
+          end
+        end
+      end
+    end
+  end
+end