Module: RecordSelectHelper

Defined in:
lib/record_select/helpers/record_select_helper.rb

Instance Method Summary collapse

Instance Method Details

Adds a link on the page that toggles a RecordSelect widget from the given controller.

Options

onselect

JavaScript code to handle selections client-side. This code has access to two variables: id, label. If the code returns false, the dialog will not close automatically.

params

Extra URL parameters. If any parameter is a column name, the parameter will be used as a search term to filter the result set.

html

Options for A tag

rs

Options for RecordSelect constructor



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 14

def link_to_record_select(name, controller, options = {})
  options[:params] ||= {}
  options[:params].merge!(:controller => controller, :action => :browse)
  options[:onselect] = "(function(id, label) {#{options[:onselect]}})" if options[:onselect]
  options[:html] ||= {}
  options[:html][:id] ||= "rs_#{rand(9999)}"

  assert_controller_responds(options[:params][:controller])
  record_select_options = {id: record_select_id(controller.controller_path), onselect: options[:onselect] || ''}
  record_select_options.merge! options[:rs] if options[:rs]

  html = link_to(name, '#', options[:html])
  html << javascript_tag("new RecordSelect.Dialog(#{options[:html][:id].to_json}, #{url_for(options[:params]).to_json}, #{record_select_options.to_json});")

  return html
end

#permit_rs_browse_params ⇒ Object

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



4
5
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 4

def permit_rs_browse_params
end

#record_multi_select_field(name, current, options = {}) ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 111

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[:rs] if options[:rs]

  html = text_field_tag("#{name}[]", nil, options.merge(:autocomplete => 'off', :onfocus => "this.focused=true", :onblur => "this.focused=false"))
  html << hidden_field_tag("#{name}[]", '', :id => nil)
  html << content_tag('ul', '', :class => 'record-select-list');

  url = url_for({:action => :browse, :controller => controller.controller_path}.merge(params))
  html << javascript_tag("new RecordSelect.Multiple(#{options[:id].to_json}, #{url.to_json}, #{record_select_options.to_json});")

  return html
end

#record_select_autocomplete(name, current, options = {}) ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 78

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[:rs] if options[:rs]

  html = text_field_tag(name, nil, options.merge(:autocomplete => 'off', :onfocus => "this.focused=true", :onblur => "this.focused=false"))
  url = url_for({:action => :browse, :controller => controller.controller_path}.merge(params))
  html << javascript_tag("new RecordSelect.Autocomplete(#{options[:id].to_json}, #{url.to_json}, #{record_select_options.to_json});")

  return html
end

#record_select_config ⇒ Object

Provides view access to the RecordSelect configuration



143
144
145
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 143

def record_select_config #:nodoc:
  controller.send :record_select_config
end

#record_select_field(name, current, options = {}) ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 43

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'

  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]
  if current and not current.new_record?
    record_select_options[:id] = current.id
    record_select_options[:label] = label_for_field(current, controller)
  end
  record_select_options.merge! options[:rs] if options[:rs]

  html = text_field_tag(name, nil, options.merge(:autocomplete => 'off', :onfocus => "this.focused=true", :onblur => "this.focused=false"))
  url = url_for({:action => :browse, :controller => controller.controller_path}.merge(params))
  html << javascript_tag("new RecordSelect.Single(#{options[:id].to_json}, #{url.to_json}, #{record_select_options.to_json});")

  return html
end

#record_select_id(controller = nil) ⇒ Object

The id of the RecordSelect widget for the given controller.



148
149
150
151
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 148

def record_select_id(controller = nil) #:nodoc:
  controller ||= params[:controller]
  "record-select-#{controller.gsub('/', '_')}"
end

#record_select_search_id(controller = nil) ⇒ Object

:nodoc:



153
154
155
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 153

def record_select_search_id(controller = nil) #:nodoc:
  "#{record_select_id(controller)}-search"
end

#render_record_select(options = {}) ⇒ Object

A helper to render RecordSelect partials



136
137
138
139
140
 
# File 'lib/record_select/helpers/record_select_helper.rb', line 136

def render_record_select(options = {}) #:nodoc:
  controller.send(:render_record_select, options) do |options|
    render options
  end
end