Module: ActiveRecordSunspotter::SunspotHelper

Defined in:
lib/active_record_sunspotter/sunspot_helper.rb

Instance Method Summary collapse

Instance Method Details

#column_content(subject, column) ⇒ Object

NEVER use send on a tainted string!



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 140

def column_content(subject,column)
	case column.to_s

		#
		#	Just wanting to format any date columns
		#
		when *@sunspot_search_class.sunspot_date_columns.collect(&:name)
			col = @sunspot_search_class.sunspot_columns.detect{|c|
				c.name == column.to_s }
			( col.hash_table.has_key?(:meth) ) ?
				[col.meth.call(subject)].flatten.join(',') :
				( subject.respond_to?(column) ) ?
					subject.try(column).try(:strftime,'%m/%d/%Y') : 
					'DATE COLUMN NOT FOUND?'

		#
		#	All valid columns can use meth, so I don't need to define them.
		#
		when *@sunspot_search_class.sunspot_column_names
			col = @sunspot_search_class.sunspot_columns.detect{|c|
				c.name == column.to_s }
			( col.hash_table.has_key?(:meth) ) ?
				[col.meth.call(subject)].flatten.join(',') :
				( subject.respond_to?(column) ) ?
					subject.try(column) : 
					'COLUMN NOT FOUND?'

		else
			'UNKNOWN COLUMN'
	end
end

#column_header(column) ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 129

def column_header(column)
	if @sunspot_search_class.sunspot_orderable_column_names.include?(column.to_s)
		sort_link(column,:image => false)
	else
		column
	end
end

#columns ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 121

def columns
	columns ||= if( params[:c].present? )
		[params[:c]].flatten.uniq	#	sometimes this is needed and others it is not?
	else
		@sunspot_search_class.sunspot_default_column_names
	end
end

#facet_for(facet, options = {}) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 53

def facet_for(facet,options={})
	return if facet.rows.empty?

	#	options include :multiselector, :facetcount
	style, icon = if( params[facet.name] )
		[" style='display:block;'", "ui-icon-triangle-1-s"]
	else
		[                      nil, "ui-icon-triangle-1-e"]
	end
	s =  facet_toggle(facet,icon)

	#	Wrap all the rest in a div which will be toggled
	s << "\n<div id='#{facet.name}' class='facet_field'#{style}>\n".html_safe
	s << multi_select_operator_for(facet.name) if options[:multiselector]



	col = @sunspot_search_class.sunspot_columns.detect{|c|
		c.name == facet.name.to_s }



	s << "<ul class='facet_field_values'>\n".html_safe
	facet.rows.each do |row|

		#
		#	NOTE for now, if a blank field has made it into the index, IGNORE IT.
		#		Unfortunately, searching for a '' creates syntactically incorrect query.
		#
		#		Of course, this mucks up the count.  Errr!!!
		#		So I had to handle it yet again.
		#

		#
		#	20130423 - false.blank? is true so boolean fields won't work here
		#
		next if row.value.blank?

		label = if col.ranges
			col.ranges.detect{|r| r[:range].to_s == row.value.to_s }[:name] || 'RANGE NOT FOUND'
		else
			row.value
		end

		#	TODO figure out how to facet on NULL and BLANK values
		#		I don't think that NULL gets faceted
		#		and blank creates a syntactically incorrect query

		s << "<li>".html_safe
		if options[:radio]
			s << radio_button_tag( "#{facet.name}[]", row.value,
					[params[facet.name]].flatten.include?(row.value.to_s),
					{ :id => "#{facet.name}_#{row.value.html_friendly}" } )
		else
			s << check_box_tag( "#{facet.name}[]", row.value, 
					[params[facet.name]].flatten.include?(row.value.to_s),
					{ :id => "#{facet.name}_#{row.value.html_friendly}" } )
		end
		s << "<label for='#{facet.name}_#{row.value.html_friendly}'>".html_safe
#			s << "<span>#{row.value}</span>".html_safe
		s << "<span>#{label}</span>".html_safe
		s << "&nbsp;(&nbsp;#{row.count}&nbsp;)".html_safe if options[:facet_counts]
		s << "</label></li>\n".html_safe
	end
	s << "</ul>\n".html_safe	#	"<ul class='facet_field_values'>"
	s << "</div>\n".html_safe	#	"<div id='#{facet.name}' class='facet_field'#{style}>"
end

#facet_toggle(facet, icon) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 23

def facet_toggle(facet,icon)
	content_tag(:div,:class => 'facet_toggle') do
		s =  content_tag(:span,'&nbsp;'.html_safe,:class => "ui-icon #{icon}")
		#	Don't include the blank fields, so don't count them.
		#	May need to figure out how to deal with blanks in the future
		#	as occassionally they are what one would be searching for.
#
#	20130423 - false.blank? is true so boolean fields won't work here
#
#				perhaps do r.value.to_s.blank? as 'false'.blank? is false
#
		non_blank_row_count = facet.rows.reject{|r|r.value.blank?}.length
		facet_label = facet.name.to_s
		facet_label = if( facet_label.match(/^hex_/) )
#				[facet_label.gsub(/^hex_/,'').split(/:/).first].pack('H*')
			l = facet_label.gsub(/^hex_/,'').split(/:/)
			l[0] = [l[0]].pack('H*')
			l.join(' : ')
		else
			column = @sunspot_search_class.all_sunspot_columns.detect{|c|c.name == facet_label}

			#	Check if a translation exists. Use it if it does, otherwise ...
			#	http://stackoverflow.com/questions/12353416/rails-i18n-check-if-translation-exists
			column.label || ( I18n.t("#{@sunspot_search_class.to_s.underscore}.#{facet.name}",
				:scope => "activerecord.attributes",:raise => true ) rescue false ) || facet_label.titleize
		end
		s << link_to("#{facet_label}&nbsp;(#{non_blank_row_count})".html_safe, 'javascript:void()')
	end
end

#html_column_content(result, column) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 175

def html_column_content(result,column)
	content = column_content(result,column).to_s.gsub(/\s+/,'&nbsp;') || '&nbsp;'

	col = @sunspot_search_class.sunspot_columns.detect{|c|
		c.name == column.to_s }
	html_content = ( col.hash_table.has_key?(:link_to) ) ?
		link_to( content, col.link_to.call(result), :target => :new ) : content

	html_content.html_safe
end

#multi_select_operator_for(name) ⇒ Object

originally from CLIC



14
15
16
17
18
19
20
21
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 14

def multi_select_operator_for(name)
	content_tag(:div) do
		selected = ( params["#{name}_op"] && params["#{name}_op"] == 'AND' ) ? 'AND' : 'OR'
		s  = content_tag(:span,"Multi-select operator")
		s << operator_radio_button_tag_and_label(name,'AND',selected)
		s << operator_radio_button_tag_and_label(name,'OR',selected)
	end
end

#operator_radio_button_tag_and_label(name, operator, selected) ⇒ Object

Rails helpers are already “html_safe”. Manually creating the strings will require adding it.



6
7
8
9
10
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 6

def operator_radio_button_tag_and_label(name,operator,selected)
	s =  radio_button_tag( "#{name}_op", operator, selected == operator,
			:id => "#{name}_op_#{operator.downcase}" )
	s << label_tag( "#{name}_op_#{operator.downcase}", operator )
end

#sort_link(*args) ⇒ Object

&uarr; and &darr;



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/active_record_sunspotter/sunspot_helper.rb', line 188

def sort_link(*args)
	options = {
		:image => true
	}.merge(args.extract_options!)
	column = args[0]
	text = args[1]
	#	make local copy so mods to muck up real params which
	#	may still be references elsewhere.
	local_params = params.dup

#
#	May want to NOT flip dir for other columns.  Only the current order.
#	Will wait until someone else makes the suggestion.
#
	order = column.to_s.downcase.gsub(/\s+/,'_')
	dir = ( local_params[:dir] && local_params[:dir] == 'asc' ) ? 'desc' : 'asc'

	local_params[:page] = nil
	link_text = text||column
	classes = ['sortable',order]
	arrow = ''
	if local_params[:order] && local_params[:order] == order
		classes.push('sorted')
		arrow = if dir == 'desc'
#				if File.exists?( sort_down_image ) && options[:image]
#					image_tag( File.basename(sort_down_image), :class => 'down arrow')
#				else
				"<span class='down arrow'>&darr;</span>"
#				end
		else
#				if File.exists?( sort_up_image ) && options[:image]
#					image_tag( File.basename(sort_up_image), :class => 'up arrow')
#				else
				"<span class='up arrow'>&uarr;</span>"
#				end
		end
	end
	s = "<div class='#{classes.join(' ')}'>"
	s << link_to(link_text.html_safe,local_params.merge(:order => order,:dir => dir))
	s << arrow unless arrow.blank?
	s << "</div>"
	s.html_safe
end