Class: SimpleForm::Wrappers::Builder

Inherits:
Object
  • Object
show all
Defined in:
lib/simple_form/wrappers/builder.rb

Overview

Provides the builder syntax for components. The builder provides three methods `use`, `optional` and `wrapper` and they allow the following invocations:

config.wrappers do |b|
  # Use a single component
  b.use :html5

  # Use the component, but do not automatically lookup. It will only be triggered when
  # :placeholder is explicitly set.
  b.optional :placeholder

  # Use a component with specific wrapper options
  b.use :error, wrap_with: { tag: "span", class: "error" }

  # Use a set of components by wrapping them in a tag+class.
  b.wrapper tag: "div", class: "another" do |ba|
    ba.use :label
    ba.use :input
  end

  # Use a set of components by wrapping them in a tag+class.
  # This wrapper is identified by :label_input, which means it can
  # be turned off on demand with `f.input :name, label_input: false`
  b.wrapper :label_input, tag: "div", class: "another" do |ba|
    ba.use :label
    ba.use :input
  end
end

The builder also accepts default options at the root level. This is usually used if you want a component to be disabled by default:

config.wrappers hint: false do |b|
  b.use :hint
  b.use :label_input
end

In the example above, hint defaults to false, which means it won't automatically do the lookup anymore. It will only be triggered when :hint is explicitly set.

Instance Method Summary (collapse)

Constructor Details

- (Builder) initialize(options)

A new instance of Builder



43
44
45
46
 
# File 'lib/simple_form/wrappers/builder.rb', line 43

def initialize(options)
  @options    = options
  @components = []
end

Instance Method Details

- (Object) optional(name, options = nil, &block) 



56
57
58
59
 
# File 'lib/simple_form/wrappers/builder.rb', line 56

def optional(name, options=nil, &block)
  @options[name] = false
  use(name, options, &block)
end

- (Object) to_a 



74
75
76
 
# File 'lib/simple_form/wrappers/builder.rb', line 74

def to_a
  @components
end

- (Object) use(name, options = nil, &block) 



48
49
50
51
52
53
54
 
# File 'lib/simple_form/wrappers/builder.rb', line 48

def use(name, options=nil, &block)
  if options && wrapper = options[:wrap_with]
    @components << Single.new(name, wrapper)
  else
    @components << name
  end
end

- (Object) wrapper(name, options = nil) 



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/simple_form/wrappers/builder.rb', line 61

def wrapper(name, options=nil)
  if block_given?
    name, options = nil, name if name.is_a?(Hash)
    builder = self.class.new(@options)
    options ||= {}
    options[:tag] = :div if options[:tag].nil?
    yield builder
    @components << Many.new(name, builder.to_a, options)
  else
    raise ArgumentError, "A block is required as argument to wrapper"
  end
end