vcfb 1.0.0 → 2.0.0

data/lib/vcfb/component/label.rb

@@ -0,0 +1,28 @@
+module VCFB
+  module Component
+    class Label < Base
+      delegate :translation, :to_s, to: :label_builder
+      alias_method :default_text, :translation
+
+      def initialize(form, method, text = nil, options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @text = text
+          @options = options
+        end
+      end
+
+      def form_element(options = {}, &block)
+        label(@form.object_name, @method, options, &block)
+      end
+
+      private
+
+      def label_builder
+        @label_builder ||= ActionView::Helpers::Tags::Label::LabelBuilder
+          .new(@form.template, @form.object_name, @method, @form.object, @options[:value])
+      end
+    end
+  end
+end

data/lib/vcfb/component/month_field.rb

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

data/lib/vcfb/component/number_field.rb

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

data/lib/vcfb/component/password_field.rb

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

data/lib/vcfb/component/radio_button.rb

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

data/lib/vcfb/component/range_field.rb

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

data/lib/vcfb/component/rich_text_area.rb

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

data/lib/vcfb/component/search_field.rb

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

data/lib/vcfb/component/select.rb

@@ -0,0 +1,23 @@
+module VCFB
+  module Component
+    class Select < Base
+      def initialize(form, method, choices = nil, options = {}, html_options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @choices = choices
+          @options = options
+          @html_options = html_options
+        end
+      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
+    end
+  end
+end

data/lib/vcfb/component/submit.rb

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

data/lib/vcfb/component/telephone_field.rb

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

data/lib/vcfb/component/text_area.rb

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

data/lib/vcfb/component/text_field.rb

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

data/lib/vcfb/component/time_field.rb

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

data/lib/vcfb/component/time_select.rb

@@ -0,0 +1,18 @@
+module VCFB
+  module Component
+    class TimeSelect < 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 = {})
+        time_select(@form.object_name, @method, options, html_options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/time_zone_select.rb

@@ -0,0 +1,19 @@
+module VCFB
+  module Component
+    class TimeZoneSelect < Base
+      def initialize(form, method, priority_zones = nil, options = {}, html_options = {})
+        run_callbacks :initialize do
+          @form = form
+          @method = method
+          @priority_zones = priority_zones
+          @options = options
+          @html_options = html_options
+        end
+      end
+
+      def form_element(options = {}, html_options = {})
+        time_zone_select(@form.object_name, @method, @priority_zones, options, html_options)
+      end
+    end
+  end
+end

data/lib/vcfb/component/url_field.rb

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

data/lib/vcfb/component/week_field.rb

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

data/lib/vcfb/component/weekday_select.rb

@@ -0,0 +1,18 @@
+module VCFB
+  module Component
+    class WeekdaySelect < 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 = {})
+        weekday_select(@form.object_name, @method, options, html_options)
+      end
+    end
+  end
+end

data/lib/vcfb/errors/component_missing.rb

@@ -0,0 +1,5 @@
+module VCFB
+  module Errors
+    class ComponentMissing < Error; end
+  end
+end

data/lib/vcfb/errors/error.rb

@@ -0,0 +1,5 @@
+module VCFB
+  module Errors
+    class Error < StandardError; end
+  end
+end

data/lib/vcfb/form_builder.rb

@@ -1,23 +1,27 @@
-require "active_support/core_ext/class/attribute"
-require "view_component"
-
-require "vcfb/acts_as_form_component"
-require "vcfb/acts_as_form_collection_component"
-require "vcfb/acts_as_form_label_component"
-require "vcfb/resolver"
-require "vcfb/template"
-
 module VCFB
   class FormBuilder < ::ActionView::Helpers::FormBuilder
     class_attribute :namespace, instance_writer: false, default: "form"
 
     attr_reader :object, :object_name, :template
+    attr_accessor :form_component
 
     def initialize(*args)
       super
       @template = Template.new(@template, self)
     end
 
+    # FORM COMPONENT
+
+    def self.form_component_class
+      "#{namespace}/component".camelize.constantize
+    end
+
+    def self.form_component_defined?
+      form_component_class.present?
+    rescue Errors::ComponentMissing
+      false
+    end
+
     # SIMPLE FIELDS
 
     SIMPLE_FIELDS = %i[color_field date_field datetime_field email_field month_field number_field password_field
@@ -64,6 +68,7 @@ module VCFB
     end
 
     def collection_check_boxes_label(method, text = nil, options = {}, &block)
+      options, text = text, nil if text.is_a?(Hash)
       if component_defined?(:"collection_check_boxes/label")
         componentify(:"collection_check_boxes/label", method, text, options, &block)
       elsif component_defined?(:label)
@@ -90,10 +95,11 @@ module VCFB
     end
 
     def collection_radio_buttons_label(method, text = nil, options = {}, &block)
+      options, text = text, nil if text.is_a?(Hash)
       if component_defined?(:"collection_radio_buttons/label")
-        componentify(:"collection_radio_buttons/label", method, text, options, &block)
+        componentify_with_slots(:"collection_radio_buttons/label", method, text, options, &block)
       elsif component_defined?(:label)
-        componentify(:label, method, text, options, &block)
+        componentify_with_slots(:label, method, text, options, &block)
       else
         label(method, text, options, &block)
       end
@@ -131,7 +137,8 @@ module VCFB
     def label(method, text = nil, options = {}, &block)
       return super unless component_defined?(:label)
 
-      componentify(:label, method, text, objectify_options(options), &block)
+      options, text = text, nil if text.is_a?(Hash)
+      componentify_with_slots(:label, method, text, objectify_options(options), &block)
     end
 
     def radio_button(method, value, options = {})
@@ -166,23 +173,53 @@ module VCFB
       end
     end
 
-    # COMPONENT LOOKUP
+    # BUTTONS
+
+    # The default #button method captures the block (it never makes it to the
+    # underlying button_tag helper). Stash it here into options so that we can
+    # pull it out later (see vcfb/template) and pass it on to the component so
+    # that we can support slots on button components.
+    def button(value = nil, options = {}, &block)
+      options[:_block_for_component] = block
+      super(value, options, &nil)
+    end
+
+    # COMPONENT SUPPORT
 
     def component_defined?(form_element)
-      resolve_form_component(form_element).present?
-    rescue
+      resolve_component_class(form_element).present?
+    rescue Errors::ComponentMissing
       false
     end
 
     def componentify(form_element, *args, **opts, &block)
-      form_component_class = resolve_form_component(form_element)
-      @template.render form_component_class.new(self, *args, **opts), &block
+      component_class = resolve_component_class(form_element)
+      @template.render component_class.new(self, *args, **opts), &block
     end
 
-    private
+    def componentify_with_slots(form_element, *args, **opts, &block)
+      component_class = resolve_component_class(form_element)
+      @template.render component_class.new(self, *args, **opts) do |component|
+        block&.call(component)
+      end
+    end
 
-    def resolve_form_component(form_element)
+    def resolve_component_class(form_element)
       VCFB::Resolver.call(namespace, form_element)
     end
+
+    # SUPPORT FORM COMPONENT SLOTS
+
+    def method_missing(method_name, *args, **opts, &block)
+      super unless method_name.to_s.start_with?("with_")
+
+      form_component.public_send(method_name, *args, **opts, &block)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super unless method_name.to_s.start_with?("with_")
+
+      form_component.respond_to?(method_name, include_private)
+    end
   end
 end

data/lib/vcfb/form_helper.rb

@@ -0,0 +1,12 @@
+module VCFB
+  module FormHelper
+    def component_form_with(model: nil, scope: nil, url: nil, format: nil, **options, &block)
+      options[:builder] ||= VCFB::FormBuilder
+      if options[:builder].try(:form_component_defined?)
+        render options[:builder].form_component_class.new(model: model, scope: scope, url: url, format: format, **options), &block
+      else
+        form_with(model: model, scope: scope, url: url, format: format, **options, &block)
+      end
+    end
+  end
+end

data/lib/vcfb/railtie.rb

@@ -2,5 +2,12 @@ require "rails/railtie"
 
 module VCFB
   class Railtie < ::Rails::Railtie
+    initializer "vcfb.helper" do |_app|
+      ActionView::Base.send :include, VCFB::FormHelper
+    end
+
+    config.to_prepare do
+      Component.setup!
+    end
   end
 end

data/lib/vcfb/resolver.rb

@@ -1,17 +1,19 @@
-require "active_support/core_ext/string/inflections"
-
 module VCFB
   class Resolver
-    def initialize(namespace, form_element)
+    def initialize(namespace, form_element = nil)
       @namespace = namespace.to_s.underscore
-      @form_element = form_element.to_s.underscore
+      @form_element = form_element.to_s.underscore unless form_element.nil?
     end
 
     def call
-      "#{@namespace}/#{@form_element}/component".camelize.constantize
+      component_name = "#{[@namespace, @form_element].compact.join("/")}/component"
+      component = component_name.camelize.safe_constantize
+      raise Errors::ComponentMissing, "unable to locate component #{component_name}" unless component
+
+      component
     end
 
-    def self.call(namespace, form_element)
+    def self.call(namespace, form_element = nil)
       new(namespace, form_element).call
     end
   end

data/lib/vcfb/tags/collection_check_boxes.rb

@@ -1,8 +1,7 @@
-require "vcfb/tags/collection_helpers"
-
 module VCFB
   module Tags
     class CollectionCheckBoxes < ActionView::Helpers::Tags::CollectionCheckBoxes
+      # Override the #label and #check_box methods to render via component
       class CheckBoxBuilder < ActionView::Helpers::Tags::CollectionCheckBoxes::Builder
         include CollectionHelpers
 
@@ -18,6 +17,7 @@ module VCFB
         end
       end
 
+      # Override the #render method to use our custom CheckBoxBuilder
       def render(&block)
         render_collection_for(CheckBoxBuilder, &block)
       end

data/lib/vcfb/tags/collection_helpers.rb

@@ -1,5 +1,3 @@
-require "action_view/helpers/tags/collection_helpers"
-
 module VCFB
   module Tags
     module CollectionHelpers

data/lib/vcfb/tags/collection_radio_buttons.rb

@@ -1,8 +1,7 @@
-require "vcfb/tags/collection_helpers"
-
 module VCFB
   module Tags
     class CollectionRadioButtons < ActionView::Helpers::Tags::CollectionRadioButtons
+      # Override the #label and #radio_button methods to render via component
       class RadioButtonBuilder < ActionView::Helpers::Tags::CollectionRadioButtons::Builder
         include CollectionHelpers
 
@@ -17,6 +16,7 @@ module VCFB
         end
       end
 
+      # Override the #render method to use our custom RadioButtonBuilder
       def render(&block)
         render_collection_for(RadioButtonBuilder, &block)
       end

data/lib/vcfb/template.rb

@@ -1,4 +1,9 @@
 module VCFB
+  # Several FormBuilder methods are more complex and have changed a good bit
+  # between between Rails releases. Rather than trying to keep up with these
+  # changes, we put together an intermediate Template class (see
+  # VCFB::FormBuilder) to defer the compnetifying until _after_ it's gone
+  # through ActionView::Helpers::FormBuilder.
   class Template
     def initialize(template, form)
       @template = template
@@ -7,14 +12,11 @@ module VCFB
 
     # Custom Tag Helpers
 
-    def button_tag(value, options, &block)
+    def button_tag(value, options)
       return super unless @form.component_defined?(:button)
 
-      if block
-        value = @template.capture(value, &block)
-      end
-
-      @form.componentify(:button, value, options)
+      block = options.delete(:_block_for_component)
+      @form.componentify_with_slots(:button, value, options, &block)
     end
 
     def submit_tag(value, options)

data/lib/vcfb/version.rb

@@ -1,3 +1,3 @@
 module VCFB
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end