module RecordSelectHelper

Public Instance Methods

full_text_search?() click to toggle source
# File lib/record_select/helpers/record_select_helper.rb, line 166
def full_text_search?
  controller.send :full_text_search?
end
permit_rs_browse_params() click to toggle source

If you use :params option, define this helper in your controller helpers to return array with those params, so _list partial permits them

# File lib/record_select/helpers/record_select_helper.rb, line 4
def permit_rs_browse_params
end
record_multi_select_field(name, current, options = {}) click to toggle source

Adds a RecordSelect-based form field for multiple selections. The values submit using a list of hidden inputs.

Arguments

name

the input name that will be used to submit the selected records’ ids. empty brackets will be appended to the name.

current

pass a collection of existing associated records

Options

controller

The controller configured to provide the result set.

params

A hash of extra URL parameters

id

The id to use for the input. Defaults based on the input’s name.

rs

Options for RecordSelect constructor

# File lib/record_select/helpers/record_select_helper.rb, line 128
def record_multi_select_field(name, current, options = {})
  options[:controller] ||= current.first.class.to_s.pluralize.underscore
  options[:params] ||= {}
  options[:id] ||= name.gsub(/[\[\]]/, '_')
  options[:class] ||= ''
  options[:class] << ' recordselect'
  options.delete(:name)

  controller = assert_controller_responds(options.delete(:controller))
  params = options.delete(:params)
  record_select_options = {id: record_select_id(controller.controller_path)}
  record_select_options[:current] = current.inject([]) { |memo, record| memo.push({:id => record.id, :label => label_for_field(record, controller)}) }
  record_select_options.merge! options.delete(:rs) if options[:rs]

  options.merge!(autocomplete: 'off', onfocus: "this.focused=true", onblur: "this.focused=false")
  url = url_for({action: :browse, controller: controller.controller_path}.merge(params))
  rs_data = {type: 'Multiple', id: options[:id], url: url, options: record_select_options}
  options[:data] = rs_data.transform_keys { |k| "rs_#{k}" } unless request.xhr?
  html = text_field_tag("#{name}[]", nil, options)
  html << hidden_field_tag("#{name}[]", '', id: nil)
  html << content_tag(:ul, '', class: 'record-select-list')
  html << record_select_js(**rs_data) if request.xhr?

  html
end
record_select_autocomplete(name, current, options = {}) click to toggle source

Adds a RecordSelect-based form field. The field is autocompleted.

Arguments

name

the input name that will be used to submit the selected value.

current

the current object. provide a new record if there’re none currently selected and you have not passed the optional :controller argument.

Options

controller

The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of current (the second argument)

params

A hash of extra URL parameters

id

The id to use for the input. Defaults based on the input’s name.

rs

Options for RecordSelect constructor

# File lib/record_select/helpers/record_select_helper.rb, line 92
def record_select_autocomplete(name, current, options = {})
  options[:controller] ||= current.class.to_s.pluralize.underscore
  options[:params] ||= {}
  options[:id] ||= name.gsub(/[\[\]]/, '_')
  options[:class] ||= ''
  options[:class] << ' recordselect'

  controller = assert_controller_responds(options.delete(:controller))
  params = options.delete(:params)
  record_select_options = {id: record_select_id(controller.controller_path), label: options.delete(:label)}
  if current
    record_select_options[:label] ||= label_for_field(current, controller)
  end
  record_select_options.merge! options.delete(:rs) if options[:rs]

  options.merge!(autocomplete: 'off', onfocus: "this.focused=true", onblur: "this.focused=false")
  url = url_for({action: :browse, controller: controller.controller_path}.merge(params))
  rs_data = {type: 'Autocomplete', id: options[:id], url: url, options: record_select_options}
  options[:data] = rs_data.transform_keys { |k| "rs_#{k}" } unless request.xhr?
  html = text_field_tag(name, nil, options)
  html << record_select_js(**rs_data) if request.xhr?

  html
end
record_select_field(name, current, options = {}) click to toggle source

Adds a RecordSelect-based form field. The field submits the record’s id using a hidden input.

Arguments

name

the input name that will be used to submit the selected record’s id.

current

the currently selected object. provide a new record if there’re none currently selected and you have not passed the optional :controller argument.

Options

controller

The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of current (the second argument)

params

A hash of extra URL parameters

id

The id to use for the input. Defaults based on the input’s name.

field_name

The name to use for the text input. Defaults to ”, so field is not submitted.

rs

Options for RecordSelect constructor

# File lib/record_select/helpers/record_select_helper.rb, line 49
def record_select_field(name, current, options = {})
  options[:controller] ||= current.class.to_s.pluralize.underscore
  options[:params] ||= {}
  options[:id] ||= name.gsub(/[\[\]]/, '_')
  options[:class] ||= ''
  options[:class] << ' recordselect'
  options[:clear_button] = true unless options.include? :clear_button

  controller = assert_controller_responds(options.delete(:controller))
  params = options.delete(:params)
  record_select_options = {id: record_select_id(controller.controller_path)}
  record_select_options[:field_name] = options.delete(:field_name) if options[:field_name]
  clear_button_class = 'clear-input-button'
  if current and not current.new_record?
    record_select_options[:id] = current.id
    record_select_options[:label] = label_for_field(current, controller)
    clear_button_class << ' enabled'
  end
  record_select_options.merge! options.delete(:rs) if options[:rs]

  clear_button = options.delete(:clear_button)
  options.merge!(autocomplete: 'off', onfocus: "this.focused=true", onblur: "this.focused=false")
  url = url_for({action: :browse, controller: controller.controller_path}.merge(params))
  rs_data = {type: 'Single', id: options[:id], url: url, options: record_select_options}
  options[:data] = rs_data.transform_keys { |k| "rs_#{k}" } unless request.xhr?
  html = text_field_tag(name, nil, options)
  html << button_tag('x', type: :button, class: clear_button_class, aria_label: 'Clear input', title: 'Clear input') if clear_button
  html << record_select_js(**rs_data) if request.xhr?

  html
end
record_select_js(type:, id:, url:, options:) click to toggle source
# File lib/record_select/helpers/record_select_helper.rb, line 7
def record_select_js(type:, id:, url:, options:)
  javascript_tag("new RecordSelect.#{type}(#{id.to_json}, #{url.to_json}, #{options.to_json});")
end

Private Instance Methods

assert_controller_responds(controller_name) click to toggle source
# File lib/record_select/helpers/record_select_helper.rb, line 213
def assert_controller_responds(controller_name)
  controller_name = "#{controller_name.camelize}Controller"
  controller = controller_name.constantize
  unless controller.uses_record_select?
    raise "#{controller_name} has not been configured to use RecordSelect."
  end
  controller
end
label_for_field(record, controller = self.controller) click to toggle source

uses the result of render_record_from_config to snag an appropriate record label to display in a field.

if given a controller, searches for a partial in its views path

# File lib/record_select/helpers/record_select_helper.rb, line 199
def label_for_field(record, controller = self.controller)
  renderer = controller.record_select_config.label
  description = case renderer
  when Symbol, String
    # find the <label> element and grab its innerHTML
    render_record_from_config(record, File.join(controller.controller_path, renderer.to_s))

  when Proc
    # just return the string
    render_record_from_config(record, renderer)
  end
  description.match(/<label[^>]*>(.*)<\/label>/){ |match| match[1] } || description if description
end
render_record_from_config(record, renderer = record_select_config.label) click to toggle source

uses renderer (defaults to record_select_config.label) to determine how the given record renders.

# File lib/record_select/helpers/record_select_helper.rb, line 183
def render_record_from_config(record, renderer = record_select_config.label)
  case renderer
  when Symbol, String
    # return full-html from the named partial
    render :partial => renderer.to_s, :locals => {:record => record}

  when Proc
    # return an html-cleaned descriptive string
    instance_exec record, &renderer
  end
end