vcfb 1.0.0

data/lib/vcfb/acts_as_form_label_component.rb

@@ -0,0 +1,21 @@
+require "active_support/concern"
+
+require "vcfb/acts_as_form_component"
+
+module VCFB
+  module ActsAsFormLabelComponent
+    extend ActiveSupport::Concern
+    include ActsAsFormComponent
+
+    included do
+      delegate :translation, :to_s, to: :label_builder
+    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

data/lib/vcfb/form_builder.rb

@@ -0,0 +1,188 @@
+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
+
+    def initialize(*args)
+      super
+      @template = Template.new(@template, self)
+    end
+
+    # SIMPLE FIELDS
+
+    SIMPLE_FIELDS = %i[color_field date_field datetime_field email_field month_field number_field password_field
+      range_field search_field telephone_field text_area text_field time_field url_field week_field]
+
+    SIMPLE_FIELDS.each do |selector|
+      class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def #{selector}(method, options = {})
+          return super unless component_defined?(#{selector.inspect})
+
+          componentify(#{selector.inspect}, method, objectify_options(options))
+        end
+      RUBY_EVAL
+    end
+
+    alias_method :phone_field, :telephone_field
+    alias_method :datetime_local_field, :datetime_field
+
+    # SIMPLE SELECTS
+
+    SIMPLE_SELECTS = %i[date_select datetime_select time_select]
+    SIMPLE_SELECTS.each do |selector|
+      class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def #{selector}(method, options = {}, html_options = {})
+          return super unless component_defined?(#{selector.inspect})
+
+          componentify(#{selector.inspect}, method, objectify_options(options), html_options)
+        end
+      RUBY_EVAL
+    end
+
+    # MORE COMPLEX FIELDS AND SELECTS
+
+    def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+      return super unless component_defined?(:check_box)
+
+      componentify(:check_box, method, objectify_options(options), checked_value, unchecked_value)
+    end
+
+    def collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
+      return super unless component_defined?(:collection_check_boxes)
+
+      componentify(:collection_check_boxes, method, collection, value_method, text_method, objectify_options(options), @default_html_options.merge(html_options), &block)
+    end
+
+    def collection_check_boxes_label(method, text = nil, options = {}, &block)
+      if component_defined?(:"collection_check_boxes/label")
+        componentify(:"collection_check_boxes/label", method, text, options, &block)
+      elsif component_defined?(:label)
+        componentify(:label, method, text, options, &block)
+      else
+        label(method, text, options, &block)
+      end
+    end
+
+    def collection_check_boxes_check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+      if component_defined?(:"collection_check_boxes/check_box")
+        componentify(:"collection_check_boxes/check_box", method, options, checked_value, unchecked_value)
+      elsif component_defined?(:check_box)
+        componentify(:check_box, method, options, checked_value, unchecked_value)
+      else
+        check_box(method, options, checked_value, unchecked_value)
+      end
+    end
+
+    def collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
+      return super unless component_defined?(:collection_radio_buttons)
+
+      componentify(:collection_radio_buttons, method, collection, value_method, text_method, objectify_options(options), @default_html_options.merge(html_options), &block)
+    end
+
+    def collection_radio_buttons_label(method, text = nil, options = {}, &block)
+      if component_defined?(:"collection_radio_buttons/label")
+        componentify(:"collection_radio_buttons/label", method, text, options, &block)
+      elsif component_defined?(:label)
+        componentify(:label, method, text, options, &block)
+      else
+        label(method, text, options, &block)
+      end
+    end
+
+    def collection_radio_buttons_radio_button(method, value, options = {})
+      if component_defined?(:"collection_radio_buttons/radio_button")
+        componentify(:"collection_radio_buttons/radio_button", method, value, options)
+      elsif component_defined?(:radio_button)
+        componentify(:radio_button, method, value, options)
+      else
+        radio_button(method, options, checked_value, unchecked_value)
+      end
+    end
+
+    def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
+      return super unless component_defined?(:collection_select)
+
+      componentify(:collection_select, method, collection, value_method, text_method, objectify_options(options), @default_html_options.merge(html_options))
+    end
+
+    def file_field(method, options = {})
+      return super unless component_defined?(:file_field)
+
+      self.multipart = true
+      componentify(:file_field, method, objectify_options(options))
+    end
+
+    def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
+      return super unless component_defined?(:grouped_collection_select)
+
+      componentify(:grouped_collection_select, method, collection, group_method, group_label_method, option_key_method, option_value_method, objectify_options(options), @default_html_options.merge(html_options))
+    end
+
+    def label(method, text = nil, options = {}, &block)
+      return super unless component_defined?(:label)
+
+      componentify(:label, method, text, objectify_options(options), &block)
+    end
+
+    def radio_button(method, value, options = {})
+      return super unless component_defined?(:radio_button)
+
+      componentify(:radio_button, method, value, objectify_options(options))
+    end
+
+    def rich_text_area(method, options = {})
+      return super unless component_defined?(:rich_text_area)
+
+      componentify(:rich_text_area, method, objectify_options(options))
+    end
+
+    def select(method, choices = nil, options = {}, html_options = {}, &block)
+      return super unless component_defined?(:select)
+
+      componentify(:select, method, choices, objectify_options(options), @default_html_options.merge(html_options), &block)
+    end
+
+    def time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
+      return super unless component_defined?(:time_zone_select)
+
+      componentify(:time_zone_select, method, priority_zones, objectify_options(options), @default_html_options.merge(html_options))
+    end
+
+    if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new("7.0")
+      def weekday_select(method, options = {}, html_options = {})
+        return super unless component_defined?(:weekday_select)
+
+        componentify(:weekday_select, method, objectify_options(options), html_options)
+      end
+    end
+
+    # COMPONENT LOOKUP
+
+    def component_defined?(form_element)
+      resolve_form_component(form_element).present?
+    rescue
+      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
+    end
+
+    private
+
+    def resolve_form_component(form_element)
+      VCFB::Resolver.call(namespace, form_element)
+    end
+  end
+end

data/lib/vcfb/railtie.rb

@@ -0,0 +1,6 @@
+require "rails/railtie"
+
+module VCFB
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/vcfb/resolver.rb

@@ -0,0 +1,18 @@
+require "active_support/core_ext/string/inflections"
+
+module VCFB
+  class Resolver
+    def initialize(namespace, form_element)
+      @namespace = namespace.to_s.underscore
+      @form_element = form_element.to_s.underscore
+    end
+
+    def call
+      "#{@namespace}/#{@form_element}/component".camelize.constantize
+    end
+
+    def self.call(namespace, form_element)
+      new(namespace, form_element).call
+    end
+  end
+end

data/lib/vcfb/tags/collection_check_boxes.rb

@@ -0,0 +1,26 @@
+require "vcfb/tags/collection_helpers"
+
+module VCFB
+  module Tags
+    class CollectionCheckBoxes < ActionView::Helpers::Tags::CollectionCheckBoxes
+      class CheckBoxBuilder < ActionView::Helpers::Tags::CollectionCheckBoxes::Builder
+        include CollectionHelpers
+
+        def label(extra_html_options = {}, &block)
+          form.collection_check_boxes_label(@sanitized_attribute_name, @text, label_html_options(extra_html_options), &block)
+        end
+
+        def check_box(extra_html_options = {})
+          html_options = extra_html_options.merge(@input_html_options)
+          html_options[:multiple] = true
+          html_options[:skip_default_ids] = false
+          form.collection_check_boxes_check_box(@method_name, html_options, @value, nil)
+        end
+      end
+
+      def render(&block)
+        render_collection_for(CheckBoxBuilder, &block)
+      end
+    end
+  end
+end

data/lib/vcfb/tags/collection_helpers.rb

@@ -0,0 +1,19 @@
+require "action_view/helpers/tags/collection_helpers"
+
+module VCFB
+  module Tags
+    module CollectionHelpers
+      private
+
+      def form
+        @template_object.instance_variable_get(:@form)
+      end
+
+      def label_html_options(extra_html_options)
+        html_options = @input_html_options.slice(:index, :namespace).merge(extra_html_options)
+        html_options[:for] ||= @input_html_options[:id] if @input_html_options[:id]
+        html_options
+      end
+    end
+  end
+end

data/lib/vcfb/tags/collection_radio_buttons.rb

@@ -0,0 +1,25 @@
+require "vcfb/tags/collection_helpers"
+
+module VCFB
+  module Tags
+    class CollectionRadioButtons < ActionView::Helpers::Tags::CollectionRadioButtons
+      class RadioButtonBuilder < ActionView::Helpers::Tags::CollectionRadioButtons::Builder
+        include CollectionHelpers
+
+        def label(extra_html_options = {}, &block)
+          form.collection_radio_buttons_label(@sanitized_attribute_name, @text, label_html_options(extra_html_options), &block)
+        end
+
+        def radio_button(extra_html_options = {})
+          html_options = extra_html_options.merge(@input_html_options)
+          html_options[:skip_default_ids] = false
+          form.collection_radio_buttons_radio_button(@method_name, @value, html_options)
+        end
+      end
+
+      def render(&block)
+        render_collection_for(RadioButtonBuilder, &block)
+      end
+    end
+  end
+end

data/lib/vcfb/template.rb

@@ -0,0 +1,44 @@
+module VCFB
+  class Template
+    def initialize(template, form)
+      @template = template
+      @form = form
+    end
+
+    # Custom Tag Helpers
+
+    def button_tag(value, options, &block)
+      return super unless @form.component_defined?(:button)
+
+      if block
+        value = @template.capture(value, &block)
+      end
+
+      @form.componentify(:button, value, options)
+    end
+
+    def submit_tag(value, options)
+      return super unless @form.component_defined?(:submit)
+
+      @form.componentify(:submit, value, options)
+    end
+
+    # Forward everything else to @template
+
+    def send(method_name, *args, &block)
+      @template.send(method_name, *args, &block)
+    end
+
+    def public_send(method_name, *args, &block)
+      @template.public_send(method_name, *args, &block)
+    end
+
+    def method_missing(method_name, *args, &block)
+      @template.public_send(method_name, *args, &block)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @template.respond_to?(method_name, include_private)
+    end
+  end
+end

data/lib/vcfb/version.rb

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

data/lib/vcfb.rb

@@ -0,0 +1,12 @@
+require "view_component"
+require "vcfb/tags/collection_helpers"
+require "vcfb/tags/collection_check_boxes"
+require "vcfb/tags/collection_radio_buttons"
+require "vcfb/acts_as_form_component"
+require "vcfb/acts_as_form_collection_component"
+require "vcfb/acts_as_form_label_component"
+require "vcfb/form_builder"
+require "vcfb/railtie"
+require "vcfb/resolver"
+require "vcfb/template"
+require "vcfb/version"

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: vcfb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Monroe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.35'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.35'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: FormBuilder for Rails using ViewComponent
+email:
+- alex.monroe@cofense.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/vcfb/components/USAGE.md
+- lib/generators/vcfb/components/components_generator.rb
+- lib/generators/vcfb/components/templates/button/component.html.erb
+- lib/generators/vcfb/components/templates/button/component.rb.tt
+- lib/generators/vcfb/components/templates/check_box/component.html.erb
+- lib/generators/vcfb/components/templates/check_box/component.rb.tt
+- lib/generators/vcfb/components/templates/collection_check_boxes/check_box/component.html.erb
+- lib/generators/vcfb/components/templates/collection_check_boxes/check_box/component.rb.tt
+- lib/generators/vcfb/components/templates/collection_check_boxes/component.html.erb
+- lib/generators/vcfb/components/templates/collection_check_boxes/component.rb.tt
+- lib/generators/vcfb/components/templates/collection_check_boxes/label/component.html.erb
+- lib/generators/vcfb/components/templates/collection_check_boxes/label/component.rb.tt
+- lib/generators/vcfb/components/templates/collection_radio_buttons/component.html.erb
+- lib/generators/vcfb/components/templates/collection_radio_buttons/component.rb.tt
+- lib/generators/vcfb/components/templates/collection_radio_buttons/label/component.html.erb
+- lib/generators/vcfb/components/templates/collection_radio_buttons/label/component.rb.tt
+- lib/generators/vcfb/components/templates/collection_radio_buttons/radio_button/component.html.erb
+- lib/generators/vcfb/components/templates/collection_radio_buttons/radio_button/component.rb.tt
+- lib/generators/vcfb/components/templates/collection_select/component.html.erb
+- lib/generators/vcfb/components/templates/collection_select/component.rb.tt
+- lib/generators/vcfb/components/templates/color_field/component.html.erb
+- lib/generators/vcfb/components/templates/color_field/component.rb.tt
+- lib/generators/vcfb/components/templates/date_field/component.html.erb
+- lib/generators/vcfb/components/templates/date_field/component.rb.tt
+- lib/generators/vcfb/components/templates/date_select/component.html.erb
+- lib/generators/vcfb/components/templates/date_select/component.rb.tt
+- lib/generators/vcfb/components/templates/datetime_field/component.html.erb
+- lib/generators/vcfb/components/templates/datetime_field/component.rb.tt
+- lib/generators/vcfb/components/templates/datetime_select/component.html.erb
+- lib/generators/vcfb/components/templates/datetime_select/component.rb.tt
+- lib/generators/vcfb/components/templates/email_field/component.html.erb
+- lib/generators/vcfb/components/templates/email_field/component.rb.tt
+- lib/generators/vcfb/components/templates/file_field/component.html.erb
+- lib/generators/vcfb/components/templates/file_field/component.rb.tt
+- lib/generators/vcfb/components/templates/grouped_collection_select/component.html.erb
+- lib/generators/vcfb/components/templates/grouped_collection_select/component.rb.tt
+- lib/generators/vcfb/components/templates/label/component.html.erb
+- lib/generators/vcfb/components/templates/label/component.rb.tt
+- lib/generators/vcfb/components/templates/month_field/component.html.erb
+- lib/generators/vcfb/components/templates/month_field/component.rb.tt
+- lib/generators/vcfb/components/templates/number_field/component.html.erb
+- lib/generators/vcfb/components/templates/number_field/component.rb.tt
+- lib/generators/vcfb/components/templates/password_field/component.html.erb
+- lib/generators/vcfb/components/templates/password_field/component.rb.tt
+- lib/generators/vcfb/components/templates/radio_button/component.html.erb
+- lib/generators/vcfb/components/templates/radio_button/component.rb.tt
+- lib/generators/vcfb/components/templates/range_field/component.html.erb
+- lib/generators/vcfb/components/templates/range_field/component.rb.tt
+- lib/generators/vcfb/components/templates/rich_text_area/component.html.erb
+- lib/generators/vcfb/components/templates/rich_text_area/component.rb.tt
+- lib/generators/vcfb/components/templates/search_field/component.html.erb
+- lib/generators/vcfb/components/templates/search_field/component.rb.tt
+- lib/generators/vcfb/components/templates/select/component.html.erb
+- lib/generators/vcfb/components/templates/select/component.rb.tt
+- lib/generators/vcfb/components/templates/submit/component.html.erb
+- lib/generators/vcfb/components/templates/submit/component.rb.tt
+- lib/generators/vcfb/components/templates/telephone_field/component.html.erb
+- lib/generators/vcfb/components/templates/telephone_field/component.rb.tt
+- lib/generators/vcfb/components/templates/text_area/component.html.erb
+- lib/generators/vcfb/components/templates/text_area/component.rb.tt
+- lib/generators/vcfb/components/templates/text_field/component.html.erb
+- lib/generators/vcfb/components/templates/text_field/component.rb.tt
+- lib/generators/vcfb/components/templates/time_field/component.html.erb
+- lib/generators/vcfb/components/templates/time_field/component.rb.tt
+- lib/generators/vcfb/components/templates/time_select/component.html.erb
+- lib/generators/vcfb/components/templates/time_select/component.rb.tt
+- lib/generators/vcfb/components/templates/time_zone_select/component.html.erb
+- lib/generators/vcfb/components/templates/time_zone_select/component.rb.tt
+- lib/generators/vcfb/components/templates/url_field/component.html.erb
+- lib/generators/vcfb/components/templates/url_field/component.rb.tt
+- lib/generators/vcfb/components/templates/week_field/component.html.erb
+- lib/generators/vcfb/components/templates/week_field/component.rb.tt
+- lib/generators/vcfb/components/templates/weekday_select/component.html.erb
+- lib/generators/vcfb/components/templates/weekday_select/component.rb.tt
+- lib/vcfb.rb
+- lib/vcfb/action_view_tag_patch.rb
+- lib/vcfb/acts_as_form_collection_component.rb
+- lib/vcfb/acts_as_form_component.rb
+- lib/vcfb/acts_as_form_label_component.rb
+- lib/vcfb/form_builder.rb
+- lib/vcfb/railtie.rb
+- lib/vcfb/resolver.rb
+- lib/vcfb/tags/collection_check_boxes.rb
+- lib/vcfb/tags/collection_helpers.rb
+- lib/vcfb/tags/collection_radio_buttons.rb
+- lib/vcfb/template.rb
+- lib/vcfb/version.rb
+homepage: https://github.com/wamonroe/vcfb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wamonroe/vcfb
+  source_code_uri: https://github.com/wamonroe/vcfb
+  changelog_uri: https://github.com/wamonroe/vcfb/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: FormBuilder for Rails using ViewComponent
+test_files: []