vcfb 1.0.0 → 2.0.0

data/lib/generators/vcfb/components/templates/rich_text_area/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module RichTextArea
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      rich_text_area(@form.object_name, @method, options)
-    end
+  class Component < VCFB::Component::RichTextArea
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/search_field/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module SearchField
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      search_field(@form.object_name, @method, options)
-    end
+  class Component < VCFB::Component::SearchField
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/select/component.rb.tt

@@ -1,23 +1,6 @@
 <% module_namespacing do -%>
 module Select
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, choices = nil, options = {}, html_options = {})
-      @form = form
-      @method = method
-      @choices = choices
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-      @html_options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(html_options)" : "html_options" %>
-    end
-
-    def before_render
-      @choices = content if content.present?
-    end
-
-    def form_element(options = {}, html_options = {})
-      select(@form.object_name, @method, @choices, options, html_options)
-    end
+  class Component < VCFB::Component::Select
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/submit/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module Submit
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, text = nil, options = {})
-      @form = form
-      @text = text
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      submit_tag(@text, options)
-    end
+  class Component < VCFB::Component::Submit
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/telephone_field/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module TelephoneField
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      telephone_field(@form.object_name, @method, options)
-    end
+  class Component < VCFB::Component::TelephoneField
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/text_area/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module TextArea
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      text_area(@form.object_name, @method, options)
-    end
+  class Component < VCFB::Component::TextArea
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/text_field/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module TextField
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      text_field(@form.object_name, @method, options)
-    end
+  class Component < VCFB::Component::TextField
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/time_field/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module TimeField
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      time_field(@form.object_name, @method, options)
-    end
+  class Component < VCFB::Component::TimeField
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/time_select/component.rb.tt

@@ -1,18 +1,6 @@
 <% module_namespacing do -%>
 module TimeSelect
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {}, html_options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-      @html_options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(html_options)" : "html_options" %>
-    end
-
-    def form_element(options = {}, html_options = {})
-      time_select(@form.object_name, @method, options, html_options)
-    end
+  class Component < VCFB::Component::TimeSelect
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/time_zone_select/component.rb.tt

@@ -1,19 +1,6 @@
 <% module_namespacing do -%>
 module TimeZoneSelect
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, priority_zones = nil, options = {}, html_options = {})
-      @form = form
-      @method = method
-      @priority_zones = priority_zones
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-      @html_options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(html_options)" : "html_options" %>
-    end
-
-    def form_element(options = {}, html_options = {})
-      time_zone_select(@form.object_name, @method, @priority_zones, options, html_options)
-    end
+  class Component < VCFB::Component::TimeZoneSelect
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/url_field/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module UrlField
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      url_field(@form.object_name, @method, options)
-    end
+  class Component < VCFB::Component::UrlField
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/week_field/component.rb.tt

@@ -1,17 +1,6 @@
 <% module_namespacing do -%>
 module WeekField
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-    end
-
-    def form_element(options = {})
-      week_field(@form.object_name, @method, options)
-    end
+  class Component < VCFB::Component::WeekField
   end
 end
 <% end -%>

data/lib/generators/vcfb/components/templates/weekday_select/component.rb.tt

@@ -1,18 +1,6 @@
 <% module_namespacing do -%>
 module WeekdaySelect
-  class Component < <%= defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base" %>
-    include VCFB::ActsAsFormComponent
-
-    def initialize(form, method, options = {}, html_options = {})
-      @form = form
-      @method = method
-      @options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(options)" : "options" %>
-      @html_options = <%= defined?(TagOptions::Hash) ? "TagOptions::Hash.new(html_options)" : "html_options" %>
-    end
-
-    def form_element(options = {}, html_options = {})
-      weekday_select(@form.object_name, @method, options, html_options)
-    end
+  class Component < VCFB::Component::WeekdaySelect
   end
 end
 <% end -%>

data/lib/generators/vcfb/initializer/initializer_generator.rb

@@ -0,0 +1,12 @@
+require "active_support/core_ext/string/inflections"
+require "rails/generators/base"
+
+module Vcfb
+  class InitializerGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("template", __dir__)
+
+    def create_form_component
+      template "vcfb.rb.tt", "config/initializers/vcfb.rb"
+    end
+  end
+end

data/lib/generators/vcfb/initializer/template/vcfb.rb.tt

@@ -0,0 +1,3 @@
+VCFB.configure do |config|
+  config.parent_component = <%= defined?(ApplicationComponent) ? '"ApplicationComponent"' : '"ViewComponent::Base"' %>
+end

data/lib/vcfb/component/base.rb

@@ -0,0 +1,27 @@
+module VCFB
+  module Component
+    class Base < VCFB.parent_component.constantize
+      extend ActiveModel::Callbacks
+
+      # Define initialize callback to reduce need to override the initialize
+      # method on form components.
+      define_model_callbacks :initialize
+
+      # Work around ViewComponent not having access helpers we need via
+      # ActionText. For more information, see:
+      #   https://github.com/github/view_component/blob/main/docs/compatibility.md#actiontext
+      delegate :rich_text_area_tag, to: :helpers
+
+      # Override the built-in methods to allow us to render custom collection
+      # tag builders that render using labels, check boxes, and radio buttons
+      # via components.
+      def collection_check_boxes(object, method, collection, value_method, text_method, options = {}, html_options = {}, &block)
+        VCFB::Tags::CollectionCheckBoxes.new(object, method, self, collection, value_method, text_method, options, html_options).render(&block)
+      end
+
+      def collection_radio_buttons(object, method, collection, value_method, text_method, options = {}, html_options = {}, &block)
+        VCFB::Tags::CollectionRadioButtons.new(object, method, self, collection, value_method, text_method, options, html_options).render(&block)
+      end
+    end
+  end
+end

data/lib/vcfb/component/base_collection.rb

@@ -0,0 +1,16 @@
+module VCFB
+  module Component
+    class BaseCollection < Base
+      private
+
+      def content
+        @__vc_content = if @view_context && @__vc_render_in_block
+          view_context.capture(@builder, &@__vc_render_in_block)
+        else
+          default_content
+        end
+        super()
+      end
+    end
+  end
+end

data/lib/vcfb/component/button.rb

@@ -0,0 +1,17 @@
+module VCFB
+  module Component
+    class Button < Base
+      def initialize(form, text = nil, options = {})
+        run_callbacks :initialize do
+          @form = form
+          @text = text
+          @options = options
+        end
+      end
+
+      def form_element(options = {}, &block)
+        button_tag(options, &block)
+      end
+    end
+  end
+end

data/lib/vcfb/component/check_box.rb

@@ -0,0 +1,19 @@
+module VCFB
+  module Component
+    class CheckBox < Base
+      def initialize(form, method, options = {}, checked_value = "1", unchecked_value = "0")
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @options = options
+          @checked_value = checked_value
+          @unchecked_value = unchecked_value
+        end
+      end
+
+      def form_element(options = {})
+        check_box(@form.object_name, @method, options, @checked_value, @unchecked_value)
+      end
+    end
+  end
+end

data/lib/vcfb/component/collection_check_boxes.rb

@@ -0,0 +1,36 @@
+module VCFB
+  module Component
+    class CollectionCheckBoxes < BaseCollection
+      def initialize(form, method, collection, value_method, text_method, options = {}, html_options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @collection = collection
+          @value_method = value_method
+          @text_method = text_method
+          @options = options
+          @html_options = html_options
+        end
+      end
+
+      # The form element #collection_check_boxes yields a special builder that
+      # can be used to define a template to render each checkbox. We yield that
+      # builder here and override the ViewComponent #content method (see
+      # BaseCollection) to support render these elements using components.
+      def form_element(options = {}, html_options = {}, &block)
+        collection_check_boxes(@form.object_name, @method, @collection, @value_method, @text_method, options, html_options) do |builder|
+          @builder = builder
+          block&.call(@builder)
+        end
+      end
+
+      private
+
+      # Define the default content / template to use if a block is not passed
+      # when calling #collection_check_boxes
+      def default_content
+        @builder.check_box + @builder.label
+      end
+    end
+  end
+end

data/lib/vcfb/component/collection_radio_buttons.rb

@@ -0,0 +1,36 @@
+module VCFB
+  module Component
+    class CollectionRadioButtons < BaseCollection
+      def initialize(form, method, collection, value_method, text_method, options = {}, html_options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @collection = collection
+          @value_method = value_method
+          @text_method = text_method
+          @options = options
+          @html_options = html_options
+        end
+      end
+
+      # The form element #collection_radio_buttons yields a special builder that
+      # can be used to define a template to render each radio button. We yield
+      # that builder here and override the ViewComponent #content method (see
+      # BaseCollection) to support render these elements using components.
+      def form_element(options = {}, html_options = {}, &block)
+        collection_radio_buttons(@form.object_name, @method, @collection, @value_method, @text_method, options, html_options) do |builder|
+          @builder = builder
+          block&.call(@builder)
+        end
+      end
+
+      private
+
+      # Define the default content / template to use if a block is not passed
+      # when calling #collection_radio_buttons
+      def default_content
+        @builder.radio_button + @builder.label
+      end
+    end
+  end
+end

data/lib/vcfb/component/collection_select.rb

@@ -0,0 +1,21 @@
+module VCFB
+  module Component
+    class CollectionSelect < Base
+      def initialize(form, method, collection, value_method, text_method, options = {}, html_options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @collection = collection
+          @value_method = value_method
+          @text_method = text_method
+          @options = options
+          @html_options = html_options
+        end
+      end
+
+      def form_element(options = {}, html_options = {})
+        collection_select(@form.object_name, @method, @collection, @value_method, @text_method, options, html_options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/color_field.rb

@@ -0,0 +1,17 @@
+module VCFB
+  module Component
+    class ColorField < Base
+      def initialize(form, method, options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @options = options
+        end
+      end
+
+      def form_element(options = {})
+        color_field(@form.object_name, @method, options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/date_field.rb

@@ -0,0 +1,17 @@
+module VCFB
+  module Component
+    class DateField < Base
+      def initialize(form, method, options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @options = options
+        end
+      end
+
+      def form_element(options = {})
+        date_field(@form.object_name, @method, options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/date_select.rb

@@ -0,0 +1,18 @@
+module VCFB
+  module Component
+    class DateSelect < Base
+      def initialize(form, method, options = {}, html_options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @options = options
+          @html_options = html_options
+        end
+      end
+
+      def form_element(options = {}, html_options = {})
+        date_select(@form.object_name, @method, options, html_options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/datetime_field.rb

@@ -0,0 +1,17 @@
+module VCFB
+  module Component
+    class DatetimeField < Base
+      def initialize(form, method, options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @options = options
+        end
+      end
+
+      def form_element(options = {})
+        datetime_field(@form.object_name, @method, options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/datetime_select.rb

@@ -0,0 +1,18 @@
+module VCFB
+  module Component
+    class DatetimeSelect < Base
+      def initialize(form, method, options = {}, html_options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @options = options
+          @html_options = html_options
+        end
+      end
+
+      def form_element(options = {}, html_options = {})
+        datetime_select(@form.object_name, @method, options, html_options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/email_field.rb

@@ -0,0 +1,17 @@
+module VCFB
+  module Component
+    class EmailField < Base
+      def initialize(form, method, options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @options = options
+        end
+      end
+
+      def form_element(options = {})
+        email_field(@form.object_name, @method, options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/file_field.rb

@@ -0,0 +1,17 @@
+module VCFB
+  module Component
+    class FileField < Base
+      def initialize(form, method, options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @options = options
+        end
+      end
+
+      def form_element(options = {})
+        file_field(@form.object_name, @method, options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/form.rb

@@ -0,0 +1,40 @@
+module VCFB
+  module Component
+    class Form < Base
+      def initialize(model: nil, scope: nil, url: nil, format: nil, **options)
+        run_callbacks :initialize do
+          @model = model
+          @scope = scope
+          @url = url
+          @format = format
+          @options = options
+          @form = nil
+        end
+      end
+
+      # Because we've overridden the #content and #get_slot methods below to
+      # support yielding the form, we need to save the component to our custom
+      # form builder to support rendering slots in the form components.
+      def form_tag(options = {}, &block)
+        form_with(model: @model, scope: @scope, url: @url, format: @format, **options) do |form|
+          form.form_component = self if form.respond_to?(:form_component=)
+          @form = form
+          block&.call(@form)
+        end
+      end
+
+      private
+
+      private
+
+      # Override #content and #get_slot from ViewComponent so that we can yield
+      # the form element (and not the component).
+      def content
+        if @view_context && @__vc_render_in_block
+          @__vc_content = view_context.capture(@form, &@__vc_render_in_block)
+        end
+        super()
+      end
+    end
+  end
+end

data/lib/vcfb/component/grouped_collection_select.rb

@@ -0,0 +1,23 @@
+module VCFB
+  module Component
+    class GroupedCollectionSelect < Base
+      def initialize(form, method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @collection = collection
+          @group_method = group_method
+          @group_label_method = group_label_method
+          @option_key_method = option_key_method
+          @option_value_method = option_value_method
+          @options = options
+          @html_options = html_options
+        end
+      end
+
+      def form_element(options = {}, html_options = {})
+        grouped_collection_select(@form.object_name, @method, @collection, @group_method, @group_label_method, @option_key_method, @option_value_method, options, html_options)
+      end
+    end
+  end
+end