Skip to content

Commit

Permalink
Proxy FormBuilder view calls through TemplateProxy
Browse files Browse the repository at this point in the history 
One major drawback to the original `ViewPartialFormBuilder::FormBuilder`
implementation was its obligation to totally re-create the underlying
`FormBuilder` behavior, including minor implementation details like
calling `objectify_options` and setting and unsetting instance variables
like `@emitted_hidden_id = true if method == :id`.

Another drawback is that if the method wasn't declared, there would be
no means of declaring a corresponding view partial. This is exactly what
happened with the `date_select` helper (fixed in [#13][]).

This new implementation proxies calls to render ActionView instances
through the `ViewPartialFormBuilder::TemplateProxy`, which first
attempts to resolve a view partial that matches the method call.

It is not without its quirks. For example, the `#button` and `#submit`
methods are special case, because they invoke a method on the
`@template` that is suffixed with `_tag`.

Additionally, the `#label` helper is a special case because of the
optional nature of the `text = nil` parameter.

[#13]: #13
  • Loading branch information
@seanpdoyle
seanpdoyle committed Jan 22, 2023
1 parent 41ea9c7 commit 608c00d
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 272 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ version links.

## main

Implement the `FormBuilder` interface by proxying its underlying view
`@template` instance to `ViewPartialFormBuilder::TemplateProxy`.

Remove support for `partial:` option to override which partial is to be rendered
by `ViewPartialFormBuilder::FormBuilder`.

Expand Down
276 changes: 4 additions & 272 deletions lib/view_partial_form_builder/form_builder.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,280 +4,12 @@ class FormBuilder < ActionView::Helpers::FormBuilder

def initialize(*)
super

@default = ActionView::Helpers::FormBuilder.new(
object_name,
object,
@template,
options,
)
@lookup_override = LookupOverride.new(
prefixes: @template.lookup_context.prefixes,
object_name: object&.model_name || object_name,
view_partial_directory: ViewPartialFormBuilder.view_partial_directory,
)
end

def label(method, text_or_options = nil, options = {}, &block)
if text_or_options.is_a?(Hash)
options.merge! text_or_options
text_or_options = nil
end

locals = {
method: method,
text: text_or_options,
options: options,
block: block,
}

render_partial("label", locals, fallback: -> { super }, &block)
end

def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
locals = {
method: method,
options: options,
checked_value: checked_value,
unchecked_value: unchecked_value,
}

render_partial("check_box", locals, fallback: -> { super })
end

def radio_button(method, tag_value, options = {})
locals = {
method: method,
tag_value: tag_value,
options: options,
}

render_partial("radio_button", locals, fallback: -> { super })
end

def select(method, choices = nil, options = {}, html_options = {}, &block)
html_options = @default_html_options.merge(html_options)

locals = {
method: method,
choices: choices,
options: options,
html_options: html_options,
block: block,
}

render_partial("select", locals, fallback: -> { super }, &block)
end

def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
html_options = @default_html_options.merge(html_options)

locals = {
method: method,
collection: collection,
value_method: value_method,
text_method: text_method,
options: options,
html_options: html_options,
}

render_partial("collection_select", locals, fallback: -> { super })
end

def collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
html_options = @default_html_options.merge(html_options)

locals = {
method: method,
collection: collection,
value_method: value_method,
text_method: text_method,
options: options,
html_options: html_options,
block: block,
}

render_partial("collection_check_boxes", locals, fallback: -> { super }, &block)
end

def collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
html_options = @default_html_options.merge(html_options)

locals = {
method: method,
collection: collection,
value_method: value_method,
text_method: text_method,
options: options,
html_options: html_options,
block: block,
}

render_partial("collection_radio_buttons", locals, fallback: -> { super }, &block)
end

def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
html_options = @default_html_options.merge(html_options)

locals = {
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,
html_options: html_options,
options: options,
}

render_partial("grouped_collection_select", locals, fallback: -> { super })
end

def time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
html_options = @default_html_options.merge(html_options)

locals = {
method: method,
priority_zones: priority_zones,
html_options: html_options,
options: options,
}

render_partial("time_zone_select", locals, fallback: -> { super })
end

def date_select(method, options = {}, html_options = {})
locals = {
method: method,
options: options,
html_options: html_options,
}

render_partial("date_select", locals, fallback: -> { super })
end

def hidden_field(method, options = {})
@emitted_hidden_id = true if method == :id

locals = {
method: method,
options: options,
}

render_partial("hidden_field", locals, fallback: -> { super })
end

def file_field(method, options = {})
self.multipart = true

locals = {
method: method,
options: options,
}

render_partial("file_field", locals, fallback: -> { super })
end

def submit(value = nil, options = {})
value, options = nil, value if value.is_a?(Hash)
value ||= submit_default_value

locals = {
value: value,
options: options,
}

render_partial("submit", locals, fallback: -> { super })
end

def button(value = nil, options = {})
value, options = nil, value if value.is_a?(Hash)
value ||= submit_default_value

locals = {
value: value,
options: options,
}

render_partial("button", locals, fallback: -> { super })
end

DYNAMICALLY_DECLARED = (
field_helpers +
[:rich_text_area] -
[:label, :check_box, :radio_button, :fields_for, :fields, :hidden_field, :file_field]
)

DYNAMICALLY_DECLARED.each do |selector|
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{selector}(method, options = {})
render_partial(
"#{selector}",
{
method: method,
options: options,
},
fallback: -> { super },
)
end
RUBY
end

private

def render_partial(field, locals, fallback:, &block)
options = objectify_options(locals.fetch(:options, {}))
locals = locals.merge(form: self)

partial = find_partial(field, locals, prefixes: prefixes_after(field))

if partial.nil? || about_to_recurse_infinitely?(partial)
fallback.call
else
partial.render(@template, locals, &block)
end
end

def find_partial(template_name, locals, prefixes:)
template_is_partial = true

@template.lookup_context.find_all(
template_name,
prefixes,
template_is_partial,
locals.keys,
).first.tap do |partial|
root_directory = ViewPartialFormBuilder.view_partial_directory

if partial&.virtual_path == "#{root_directory}/_#{template_name}"
ActiveSupport::Deprecation.new("0.2.0", "ViewPartialFormBuilder").warn(<<~WARNING.strip)
Declare root-level partials in app/views/application/#{root_directory}/, not app/views/#{root_directory}/.
WARNING
end
end
end

def prefixes_after(template_name)
prefixes = @lookup_override.prefixes
current_prefix = current_virtual_path.delete_suffix("/_#{template_name}")

if prefixes.include?(current_prefix)
prefixes.from(prefixes.index(current_prefix).to_i + 1)
else
prefixes
end
end

def about_to_recurse_infinitely?(partial)
partial.virtual_path == current_virtual_path
@default = dup
@template = TemplateProxy.new(builder: self, template: @template)
end

def current_virtual_path
if (current_template = @template.instance_values["current_template"])
current_template.virtual_path.to_s
else
@template.instance_values["virtual_path"].to_s
end
def _object_for_form_builder(object)
object.is_a?(Array) ? object.last : object
end
end
end
8 changes: 8 additions & 0 deletions lib/view_partial_form_builder/lookup_override.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ def prefixes
prefixes.uniq
end

def prefixes_after(current_prefix)
if prefixes.include?(current_prefix)
prefixes.from(prefixes.index(current_prefix).to_i + 1)
else
prefixes
end
end

private

attr_reader :object_name, :view_partial_directory
Expand Down
Loading

0 comments on commit 608c00d

Please sign in to comment.