Module: Cocooned::Helpers

Includes:
CocoonCompatibility
Defined in:
lib/cocooned/helpers.rb,
lib/cocooned/helpers/deprecate.rb,
lib/cocooned/helpers/cocoon_compatibility.rb

Overview

rubocop:disable Metrics/ModuleLength

Defined Under Namespace

Modules: CocoonCompatibility, Deprecate

Instance Method Summary collapse

Methods included from CocoonCompatibility

#link_to_add_association, #link_to_remove_association

Methods included from Deprecate

deprecate_release, deprecate_release_message

Instance Method Details

Output an action link to add an item in a nested form.

Signatures

cocooned_add_item_link(label, form, association, options = {})
  # Explicit name

cocooned_add_item_link(form, association, options = {}) do
  # Name as a block
end

cocooned_add_item_link(form, association, options = {})
  # Use default name

Parameters

‘label` is the text to be used as the link label. Just as when you use the Rails builtin helper link_to, you can give an explicit label to your link or use a block to build it. If you provide neither an explicit label nor a block, Cocooned will try to use I18n to find a suitable label. This lookup will check the following keys:

  • ‘cocooned.association.add`

  • ‘cocooned.defaults.add`

If none of these translation exist, it will fallback to ‘Add’.

‘form` is your form builder. Can be a SimpleForm::Builder, Formtastic::Builder or a standard Rails FormBuilder.

‘association` is the name of the nested association. Ex: cocooned_add_item_link “Add an item”, form, :items

Options

‘options` can be any of the following.

Rendering options:

  • partial: the nested form partial. Defaults to ‘Cocooned::Helpers.associationassociation.singular_name_fields`.

  • form_name: name used to access the form builder in the nested form partial. Defaults to ‘:f`.

  • form_options: options to be passed to the nested form builder. Can be used to specify a wrapper for simple_form_fields if you use its Bootstrap setup, for example. No defaults.

  • locals: a hash of local variables, will be forwarded to the partial. No default.

Association options:

  • insertion_method : the jQuery method to be used to insert new items. Can be any of ‘before`, `after`, `append`, `prepend`, `replaceWith`. Defaults to `before`

  • insertion_traversal and insertion_node : respectively the jQuery traversal method and the jQuery compatible selector that will be used to find the insertion node, relative to the generated link. When both are specified, ‘$(addLink).traversal(node)` will be used. When only insertion_node is specified, `$(node)` will be used. When only insertion_traversal is specified, it will be ignored. When none is specified, `$(addLink).parent()` will be used.

  • count: how many item will be inserted on click. Defaults to 1.

  • wrap_object: anything responding to ‘call` to be used to wrap the newly build item instance. Can be useful with decorators or special initialisations. Ex: cocooned_add_item_link “Add an item”, form, :items,

    wrap_object: Proc.new { |comment| CommentDecorator.new(comment) })

    No default.

  • force_non_association_create: force to build instances of the nested model outside association (i.e. without calling ‘build_association` or `association.build`) Can be usefull if, for some specific reason, you need an object to not be created on the association, for example if you did not want `after_add` callbacks to be triggered. Defaults to false.

Link HTML options:

You can pass any option supported by link_to. It will be politely forwarded. See the documentation of link_to for more informations.

Compatibility options:

These options are supported for backward compatibility with the original Cocoon. **Support for these options will be removed in the next major release !**.

  • render_options: A nested Hash originaly used to pass locals and form builder options.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/cocooned/helpers.rb', line 110

def cocooned_add_item_link(*args, &block)
  if block_given?
    cocooned_add_item_link(capture(&block), *args)

  elsif args.first.respond_to?(:object)
    association = args.second
    cocooned_add_item_link(cocooned_default_label(:add, association), *args)

  else
    name, form, association, html_options = *args
    html_options ||= {}
    html_options = html_options.dup.with_indifferent_access

    builder_options = cocooned_extract_builder_options!(html_options)
    render_options = cocooned_extract_render_options!(html_options)

    builder = Cocooned::AssociationBuilder.new(form, association, builder_options)
    rendered = cocooned_render_association(builder, render_options)

    data = cocooned_extract_data!(html_options).merge!(
      association: builder.singular_name,
      associations: builder.plural_name,
      association_insertion_template: CGI.escapeHTML(rendered.to_str).html_safe
    )

    html_options[:data] = (html_options[:data] || {}).merge(data)
    html_options[:class] = [Array(html_options.delete(:class)).collect { |k| k.to_s.split(' ') },
                            Cocooned::HELPER_CLASSES[:add]].flatten.compact.uniq.join(' ')

    link_to(name, '#', html_options)
  end
end

#cocooned_move_item_down_link(name, form = nil, html_options = {}, &block) ⇒ Object

Output an action link to move an item down.

Signatures

cocooned_move_item_down_link(label, html_options = {})
  # Explicit name

cocooned_move_item_down_link(html_options = {}) do
  # Name as a block
end

cocooned_move_item_down_link(html_options = {})
  # Use default name

See the documentation of link_to for valid options.



212
213
214
 
# File 'lib/cocooned/helpers.rb', line 212

def cocooned_move_item_down_link(name, form = nil, html_options = {}, &block)
  cocooned_move_item_link(:down, name, form, html_options, &block)
end

#cocooned_move_item_up_link(name, form = nil, html_options = {}, &block) ⇒ Object

Output an action link to move an item up.

Signatures

cocooned_move_item_up_link(label, form, html_options = {})
  # Explicit name

cocooned_move_item_up_link(form, html_options = {}) do
  # Name as a block
end

cocooned_move_item_up_link(form, html_options = {})
  # Use default name

See the documentation of link_to for valid options.



193
194
195
 
# File 'lib/cocooned/helpers.rb', line 193

def cocooned_move_item_up_link(name, form = nil, html_options = {}, &block)
  cocooned_move_item_link(:up, name, form, html_options, &block)
end

#cocooned_remove_item_link(name, form = nil, html_options = {}, &block) ⇒ Object

Output an action link to remove an item (and an hidden field to mark it as destroyed if it has already been persisted).

Signatures

cocooned_remove_item_link(label, form, html_options = {})
  # Explicit name

cocooned_remove_item_link(form, html_options = {}) do
  # Name as a block
end

cocooned_remove_item_link(form, html_options = {})
  # Use default name

See the documentation of link_to for valid options.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/cocooned/helpers.rb', line 159

def cocooned_remove_item_link(name, form = nil, html_options = {}, &block)
  # rubocop:disable Style/ParallelAssignment
  html_options, form = form, nil if form.is_a?(Hash)
  form, name = name, form if form.nil?
  # rubocop:enable Style/ParallelAssignment

  return cocooned_remove_item_link(capture(&block), form, html_options) if block_given?

  association = form.object.class.to_s.tableize
  return cocooned_remove_item_link(cocooned_default_label(:remove, association), form, html_options) if name.nil?

  link_options = html_options.dup
  link_options[:class] = [html_options[:class], Cocooned::HELPER_CLASSES[:remove]].flatten.compact
  link_options[:class] << (form.object.new_record? ? 'dynamic' : 'existing')
  link_options[:class] << 'destroyed' if form.object.marked_for_destruction?

  form.hidden_field(:_destroy, value: form.object._destroy) << link_to(name, '#', link_options)
end