module StandardHelper

action_icon(icon, label = nil) click to toggle source

Outputs an icon for an action with an optional label.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 138
def action_icon(icon, label = nil)
  html = content_tag(:i, "", :class => "icon-#{icon}")
  html << ' ' << label if label
  html
end

add_css_class(options, classes) click to toggle source

Adds a class to the given options, even if there are already classes.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 206
def add_css_class(options, classes)
  if options[:class]
    options[:class] += ' ' + classes
  else
    options[:class] = classes
  end
end

captionize(text, clazz = nil) click to toggle source

Transform the given text into a form as used by labels or table headers.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 57
def captionize(text, clazz = nil)
  text = text.to_s
  if clazz.respond_to?(:human_attribute_name)
    clazz.human_attribute_name(text.end_with?('_ids') ? text[0..-5].pluralize : text)
  else
    text.humanize.titleize
  end
end

content_tag_nested(tag, collection, options = {}, &block) click to toggle source

render a content tag with the collected contents rendered by &block for each item in collection.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 117
def content_tag_nested(tag, collection, options = {}, &block)
  content_tag(tag, safe_join(collection, &block), options)
end

f(value) click to toggle source

Formats a single value

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 11
def f(value)
  case value
    when Fixnum then number_with_delimiter(value)
    when Float, BigDecimal then number_with_precision(value, :precision => t('number.format.precision'), 
                                                             :delimiter => t('number.format.delimiter'))
    when Date   then l(value)
    when Time   then l(value, :format => :time)
    when true   then t(:"global.yes")
    when false  then t(:"global.no")
    when nil    then EMPTY_STRING
    else value.to_s
  end
end

flash_class(level) click to toggle source

Returns the css class for the given flash level.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 197
def flash_class(level)
  case level
  when :notice then 'success'
  when :alert then 'error'
  else level.to_s
  end
end

format_attr(obj, attr) click to toggle source

Formats an arbitrary attribute of the given ActiveRecord object. If no specific format_{type}_{attr} or format_{attr} method is found, formats the value as follows: If the value is an associated model, renders the label of this object. Otherwise, calls format_type.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 30
def format_attr(obj, attr)
  format_type_attr_method = obj.class.respond_to?(:model_name) ? :"format_#{obj.class.model_name.underscore}_#{attr.to_s}" : :"format_#{obj.class.name.underscore}_#{attr.to_s}"
  format_attr_method = :"format_#{attr.to_s}"
  if respond_to?(format_type_attr_method)
    send(format_type_attr_method, obj)
  elsif respond_to?(format_attr_method)
    send(format_attr_method, obj)
  elsif assoc = association(obj, attr, :belongs_to)
    format_assoc(obj, assoc)
  elsif assoc = association(obj, attr, :has_many, :has_and_belongs_to_many)
    format_many_assoc(obj, assoc)
  else
    format_type(obj, attr)
  end
end

labeled(label, content = nil, &block) click to toggle source

Renders an arbitrary content with the given label. Used for uniform presentation.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 51
def labeled(label, content = nil, &block)
  content = capture(&block) if block_given?
  render 'shared/labeled', :label => label, :content => content
end

labeled_attr(obj, attr) click to toggle source

Renders the formatted content of the given attribute with a label.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 73
def labeled_attr(obj, attr)
  labeled(captionize(attr, obj.class), format_attr(obj, attr))
end

link_action(label, icon = nil, url = {}, html_options = {}) click to toggle source

A generic helper method to create action links. These link could be styled to look like buttons, for example.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 131
def link_action(label, icon = nil, url = {}, html_options = {})
  add_css_class html_options, 'action btn'
  link_to(icon ? action_icon(icon, label) : label,
          url, html_options)
end

render_attrs(obj, *attrs) click to toggle source

Renders a list of attributes with label and value for a given object. Optionally surrounded with a div.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 68
def render_attrs(obj, *attrs)
  safe_join(attrs) { |a| labeled_attr(obj, a) }
end

safe_join(array, sep = $,, &block) click to toggle source

Overridden method that takes a block that is executed for each item in array before appending the results.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 123
def safe_join(array, sep = $,, &block)
  super(block_given? ? array.collect(&block) : array, sep)
end

simple_list(items,ul_options={}) { |item| ... } click to toggle source

Renders a simple unordered list, which will simply render all passed items or yield them to your block.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 109
def simple_list(items,ul_options={},&blk)
  content_tag_nested(:ul, items, ul_options) do |item|
    content_tag(:li, block_given? ? yield(item) : f(item))
  end
end

standard_form(object, options = {}, &block) click to toggle source

Renders a standard form using StandardFormBuilder. Before the input fields, the error messages are rendered, if present.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 95
def standard_form(object, options = {}, &block)
  options[:builder] ||= StandardFormBuilder
  options[:html] ||= {}
  add_css_class options[:html], 'form-horizontal'

  form_for(object, options) do |form|
    content = form.error_messages
    content << capture(form, &block)
  end
end

ta(key, assoc = nil, variables = {}) click to toggle source

Alias for: translate_association

table(entries, *attrs) { |t| ... } click to toggle source

Renders a table for the given entries. One column is rendered for each attribute passed. If a block is given, the columns defined therein are appended to the attribute columns. If entries is empty, an appropriate message is rendered. An options hash may be given as the last argument.

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 81
def table(entries, *attrs, &block)
  entries.inspect # force evaluation of relations
  if entries.present?
    StandardTableBuilder.table(entries, self, attrs.extract_options!) do |t|
      t.attrs(*attrs)
      yield t if block_given?
    end
  else
    content_tag(:div, ti(:no_list_entries), :class => 'table')
  end
end

ti(key, variables = {}) click to toggle source

Alias for: translate_inheritable

translate_association(key, assoc = nil, variables = {}) click to toggle source

Translates the passed key for an active record association. This helper is used for rendering association dependent keys in forms like :no_entry, :none_available or :please_select. The key is looked up in the following order:

- activerecord.associations.models.{model_name}.{association_name}.{key}
- activerecord.associations.{association_model_name}.{key}
- global.associations.{key}

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 182
def translate_association(key, assoc = nil, variables = {})
  primary = if assoc
    variables[:default] ||= [:"activerecord.associations.#{assoc.klass.model_name.underscore}.#{key}",
                             :"global.associations.#{key}"]
    :"activerecord.associations.models.#{assoc.active_record.model_name.underscore}.#{assoc.name}.#{key}"
  else
    :"global.associations.#{key}"
  end
  t(primary, variables)
end

Also aliased as: ta

translate_inheritable(key, variables = {}) click to toggle source

Translates the passed key by looking it up over the controller hierarchy. The key is searched in the following order:

- {controller}.{current_partial}.{key}
- {controller}.{current_action}.{key}
- {controller}.global.{key}
- {parent_controller}.{current_partial}.{key}
- {parent_controller}.{current_action}.{key}
- {parent_controller}.global.{key}
- ...
- global.{key}

# File lib/generators/dry_crud/templates/app/helpers/standard_helper.rb, line 154
def translate_inheritable(key, variables = {})
  defaults = []
  partial = @virtual_path ? @virtual_path.gsub(%r{.*/_?}, "") : nil
  current = controller.class
  while current < ActionController::Base
    folder = current.controller_path
    if folder.present?
      defaults << :"#{folder}.#{partial}.#{key}" if partial
      defaults << :"#{folder}.#{action_name}.#{key}"
      defaults << :"#{folder}.global.#{key}"
    end
    current = current.superclass
  end
  defaults << :"global.#{key}"

  variables[:default] ||= defaults
  t(defaults.shift, variables)
end

Also aliased as: ti

module StandardHelper

Constants

Public Instance Methods