Class: Hanami::Helpers::FormHelper::Form

Inherits:

Object

• Object
• Hanami::Helpers::FormHelper::Form

Defined in:

lib/hanami/helpers/form_helper.rb

Overview

Form object

Since:

• 0.2.0

Instance Attribute Summary

• #name ⇒ Symbol readonly private

  The form name.

• #url ⇒ String readonly private

  The form action.

• #values ⇒ ::Hash readonly private

  The form values.

Instance Method Summary

• #initialize(name, url, values = {}, attributes = {}) ⇒ Form constructor

  Initialize a form.

• #verb ⇒ String private

  Return the method specified by the given attributes or fall back to the default value.

Constructor Details

#initialize(name, url, values = {}, attributes = {}) ⇒ Form

Initialize a form

It accepts a set of values that are used in combination with request params to autofill value attributes for fields.

The keys of this Hash, MUST correspond to the structure of the (nested) fields of the form.

For a given input where the name is ‘book`, Hanami will look for `:book` key in values.

If the current params have the same key, it will be PREFERRED over the given values.

For instance, if params.get('book.title') equals to "TDD" while values[:book].title returns "No test", the first will win.

Examples:

Pass A Value

# Given the following view

module Web::Views::Deliveries
  class Edit
    include Web::View

    def form
      Form.new(:delivery, routes.delivery_path(id: delivery.id),
      {delivery: delivery, customer: customer},
      {method: :patch})
    end
  end
end

# And the corresponding template:

<%=
  form_for form do
    date_field :delivered_on

    fields_for :customer do
      text_field :name

      fields_for :address do
        # ...
        text_field :city
      end
    end

    submit 'Update'
  end
%>

<!-- output -->

<form action="/deliveries/1" method="POST" accept-charset="utf-8">
  <input type="hidden" name="_method" value="PATCH">
  <input type="hidden" name="_csrf_token" value="920cd5bfaecc6e58368950e790f2f7b4e5561eeeab230aa1b7de1b1f40ea7d5d">

  # Value taken from delivery.delivered_on
  <input type="date" name="delivery[delivered_on]" id="delivery-delivered-on" value="2015-05-27">

  # Value taken from customer.name
  <input type="text" name="delivery[customer][name]" id="delivery-customer-name" value="Luca">

  # Value taken from customer.address.city
  <input type="text" name="delivery[customer][address][city]" id="delivery-customer-address-city" value="Rome">

  <button type="submit">Update</button>
</form>

Parameters:

• name (Symbol) —

  the name of the form

• url (String) —

  the action of the form

• values (Hash, NilClass) (defaults to: {}) —

  a Hash of values to be used to autofill value attributes for fields

• attributes (Hash, NilClass) (defaults to: {}) —

  a Hash of attributes to pass to the form tag

Since:

• 0.2.0

# File 'lib/hanami/helpers/form_helper.rb', line 203

def initialize(name, url, values = {}, attributes = {})
  @name       = name
  @url        = url
  @values     = values
  @attributes = attributes || {}
end

Instance Attribute Details

#name ⇒ Symbol (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the form name.

Returns:

• (Symbol) —

  the form name

Since:

• 0.2.0

# File 'lib/hanami/helpers/form_helper.rb', line 111

def name
  @name
end

#url ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the form action.

Returns:

• (String) —

  the form action

Since:

• 0.2.0

# File 'lib/hanami/helpers/form_helper.rb', line 117

def url
  @url
end

#values ⇒ ::Hash (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the form values.

Returns:

• (::Hash) —

  the form values

Since:

• 0.2.0

# File 'lib/hanami/helpers/form_helper.rb', line 123

def values
  @values
end

Instance Method Details

#verb ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return the method specified by the given attributes or fall back to the default value

Returns:

• (String) —

  the method for the action

See Also:

• DEFAULT_METHOD

Since:

• 0.2.0

# File 'lib/hanami/helpers/form_helper.rb', line 219

def verb
  @attributes.fetch(:method, DEFAULT_METHOD)
end