jakewendt-active_record_sunspotter 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efc5d2892a72ebadab5312d46eb1bab1d30821be
+  data.tar.gz: f58e5becead798a846087b9ce8641ac8a705b90e
+SHA512:
+  metadata.gz: 15fd738ed93098d20eb9e563c73f90f7d0818e1e8956fefd2ad5bf4b54de3f4f4752597a66a7053dee7e7ec0bf672bb1112337b4e16ea086c02f725c931c50a8
+  data.tar.gz: 3f6705aa87f2e0a77ea34f37b9f14bf43f90f179d41b019da958f61b2613eb8797066536e484cc5e2ea51ff65d456abd389275a55358e636362781c54a7d92e9

data/README.rdoc

@@ -0,0 +1,26 @@
+= active_record_sunspotter
+
+
+
+
+
+
+
+
+
+
+== Gemified with Jeweler
+
+ vi Rakefile
+ rake version:write
+
+ rake version:bump:patch
+ rake version:bump:minor
+ rake version:bump:major
+
+ rake gemspec
+
+ rake install
+ rake release
+
+Copyright (c) 2010 [Jake Wendt], released under the MIT license

data/lib/active_record_sunspotter.rb

@@ -0,0 +1,18 @@
+
+#	why do I have to explicitly require it here, but not when gem included in app's Gemfile?
+require 'sunspot_rails'
+
+module ActiveRecordSunspotter; end
+require 'active_record_sunspotter/sunspot_rails_server'
+require 'active_record_sunspotter/sunspot_column'
+require 'active_record_sunspotter/sunspotability'
+require 'active_record_sunspotter/search_sunspot_for'
+require 'active_record_sunspotter/sunspot_helper'
+
+
+if defined?(Rails)
+	require 'active_record_sunspotter/rails/engine'
+	require 'active_record_sunspotter/rails/railtie'
+
+	ActionController::Base.append_view_path( File.join(File.dirname(__FILE__), '../vendor/views'))
+end

data/lib/active_record_sunspotter/rails/engine.rb

@@ -0,0 +1,9 @@
+#
+#	really just to flag this to look for include javascripts and stylesheets
+#
+module ActiveRecordSunspotter
+	module Rails
+		class Engine < ::Rails::Engine
+		end
+	end
+end

data/lib/active_record_sunspotter/rails/railtie.rb

@@ -0,0 +1,12 @@
+module ActiveRecordSunspotter
+	class Railtie < ::Rails::Railtie
+		initializer 'add_helpers_to_actionview' do |app|
+			ActiveSupport.on_load :action_view do
+				ActionView::Base.send(:include, ActiveRecordSunspotter::SunspotHelper)
+			end
+		end
+#		rake_tasks do
+#			Dir["#{File.dirname(__FILE__)}/../tasks/**/*.rake"].sort.each { |ext| load ext }
+#		end
+	end
+end

data/lib/active_record_sunspotter/search_sunspot_for.rb

@@ -0,0 +1,247 @@
+module ActiveRecordSunspotter::SearchSunspotFor
+
+	def search_sunspot_for( search_class )
+		@sunspot_search_class = search_class
+
+		#	Formerly a before_filter, but after being genericized,
+		#	we don't know the search class until the search begins.
+		@sunspot_search_class.methods.include?(:solr_search) ||
+			access_denied("Sunspot server probably wasn't started first!", root_path)
+
+#
+#	Something has changed that causes this now when :search is stubbed.
+#	Unstubbing makes testing raise and error and basically stop.
+#
+#/opt/local/lib/ruby2.0/gems/2.0.0/gems/mocha-0.13.3/lib/mocha/class_method.rb:80:in `public': undefined method `search' for class `Class' (NameError)
+#
+#	changing this to use solr_search rather than search seems to make it ok.
+#	search is actually an alias to solr_search which may be the cause.
+#	new ruby, new rules?  Perhaps a newer mocha would work, but I've had
+#	a number of problems with newer versions.
+#
+
+		begin
+			@search = @sunspot_search_class.solr_search do
+
+				if params[:q].present?
+					fulltext params[:q]
+				end
+
+				self.instance_variable_get('@setup').clazz.sunspot_all_filters.each do |f|	#	don't use |facet|
+
+					p=f.name
+
+					if f.range
+
+						range_facet_and_filter_for(p,params.dup,f.range)
+
+					elsif f.ranges	#	YES, PLURAL for an array of fixed ranges
+
+						fixed_range_facet_and_filter_for(p,params.dup,f.ranges)
+
+					else
+
+						if params[p]
+							#
+							#	20130423 - be advised that false.blank? is true so the boolean attributes
+							#						will not work correctly here.  Need to find another way.
+							#			I don't use boolean columns anymore
+							#
+							params[p] = [params[p].dup].flatten.reject{|x|x.blank?}
+
+							if params[p+'_op'] && params[p+'_op'].match(/AND/i).present?
+								unless params[p].blank?	#	empty?	#	blank? works for arrays too
+									with(p).all_of params[p]
+								else
+									params.delete(p)	#	remove the key so doesn't show in view
+								end
+
+							#
+							#	NOTE This is an INTEGER SORT for the BETWEEN filter!
+							#
+							elsif params[p+'_op'] && params[p+'_op'].match(/BETWEEN/i).present?
+								unless params[p].blank?	#empty?	# blank? works for arrays too
+									#	between is expecting an array with a first and last (can be array of 1 really)
+									with(p).between [params[p].sort_by(&:to_i)].flatten
+								else
+									params.delete(p)	#	remove the key so doesn't show in view
+								end
+
+							else	#	using 'OR'
+								unless params[p].blank?	#empty?	# blank? works for arrays too
+									with(p).any_of params[p]
+								else
+									params.delete(p)	#	remove the key so doesn't show in view
+								end
+							end	#	if params[p+'_op'] && params[p+'_op']=='AND'
+
+						end	#	if params[p]
+
+						#	facet.sort
+						#	This param determines the ordering of the facet field constraints.
+						#	    count - sort the constraints by count (highest count first)
+						#	    index - to return the constraints sorted in their index order 
+						#			(lexicographic by indexed term). For terms in the ascii range, 
+						#				this will be alphabetically sorted. 
+						#	The default is count if facet.limit is greater than 0, index otherwise.
+						#	Prior to Solr1.4, one needed to use true instead of count and false instead of index.
+						#	This parameter can be specified on a per field basis. 
+						#
+						#	put this inside the else condition as the if block is
+						#	for ranges and it calls facet
+						facet p.to_sym, :sort => :index if f.facetable
+
+					end
+
+				end	#	@sunspot_search_class.sunspot_all_filters.each do |p|
+	
+				order_by *search_order
+	
+				if request.format.to_s.match(/csv|json/)
+					#	don't paginate csv file.  Only way seems to be to make BIG query
+					#	rather than the arbitrarily big number, I could possibly
+					#	use the @search.total from the previous search sent as param?
+					paginate :page => 1, :per_page => 1000000
+				else
+					paginate :page => params[:page], :per_page => params[:per_page]||=50
+				end
+			end	#	@search = @sunspot_search_class.solr_search do
+
+		rescue Errno::ECONNREFUSED
+			flash[:error] = "Solr seems to be down for the moment."
+			redirect_to root_path
+		end	#	begin
+
+	end
+
+	def search_order
+		if params[:order] and @sunspot_search_class.sunspot_orderable_column_names.include?(
+				params[:order].downcase )
+			order_string = params[:order]
+			dir = case params[:dir].try(:downcase)
+				when 'desc' then 'desc'
+				else 'asc'
+			end
+			return order_string.to_sym, dir.to_sym
+		else
+			return :id, :asc
+		end
+	end
+
+	::Sunspot::DSL::Search.class_eval do
+
+		def range_filter_for(field,params={})
+			if params[field]
+#	"expect"=>["1e-5..1e0"]
+				any_of do
+					params[field].each do |pp|
+#						if pp =~ /^Under (\d+)$/
+						if pp =~ /^Under (.+)$/
+							with( field.to_sym ).less_than $1     #	actually less than or equal to
+#						elsif pp =~ /^Over (\d+)$/
+						elsif pp =~ /^Over (.+)$/
+							with( field.to_sym ).greater_than $1  #	actually greater than or equal to
+#						elsif pp =~ /^\d+\.\.\d+$/
+						elsif pp =~ /^.+\.\..+$/
+							with( field.to_sym, eval(pp) )	#	NOTE could add parantheses then use Range.new( $1,$2 )???
+						elsif pp =~ /^\d+$/
+							with( field.to_sym, pp )	#	primarily for testing?  No range, just value
+						end
+					end
+				end
+			end
+		end
+
+		def fixed_range_facet_and_filter_for(field,params={},options={})
+			range_filter_for(field,params)
+			facet field.to_sym do
+				options.each do |h|
+#					row "#{h[:name]}" do
+#					row "#{h[:between].sort.first}..#{h[:between].sort.last}" do
+#						with( field.to_sym, Range.new(h[:between].sort.first,h[:between].sort.last) )
+					row "#{h[:range]}" do
+						with( field.to_sym, h[:range] )
+					end
+				end	#	options.each do |h|
+			end	#	facet field.to_sym do
+		end
+
+#
+#	what's the difference between 
+#		with( field, Range.new(range,range+step) )
+#	and
+#		with( field ).between( [range,range+step] )
+#	I don't think that there is any
+#	Note that 
+#		with( field, [range,range+step] )
+#	IS NOT THE SAME.  That would be an ANY check.
+#	And using Range.new probably only works with integers.
+#	Not floats, doubles, text, dates, etc.
+#	Actually the example uses 3.0..5.0 but I'm not sure
+#	how ruby would interpret that. Base on the number of given decimal places?
+#	Exponential notation probably would not work.
+#
+
+		def range_facet_and_filter_for(field,params={},options={})
+			start = (options[:start] || 20)	#.to_i
+			stop  = (options[:stop]  || 50)	#.to_i
+			step  = (options[:step]  || 10)	#.to_i
+			log   = (options[:log]   || false)	#.to_i
+			range_filter_for(field,params)
+#			if params[field]
+##	"expect"=>["1e-5..1e0"]
+#				any_of do
+#					params[field].each do |pp|
+##						if pp =~ /^Under (\d+)$/
+#						if pp =~ /^Under (.+)$/
+#							with( field.to_sym ).less_than $1     #	actually less than or equal to
+##						elsif pp =~ /^Over (\d+)$/
+#						elsif pp =~ /^Over (.+)$/
+#							with( field.to_sym ).greater_than $1  #	actually greater than or equal to
+##						elsif pp =~ /^\d+\.\.\d+$/
+#						elsif pp =~ /^.+\.\..+$/
+#							with( field.to_sym, eval(pp) )	#	NOTE could add parantheses then use Range.new( $1,$2 )???
+#						elsif pp =~ /^\d+$/
+#							with( field.to_sym, pp )	#	primarily for testing?  No range, just value
+#						end
+#					end
+#				end
+#			end
+			facet field.to_sym do
+				if log
+					row "Under 1e#{start}" do
+						with( field.to_sym ).less_than "1e#{start}".to_f
+					end
+					(start..(stop-step)).step(step).each do |range|
+						row "1e#{range}..1e#{range+step}" do
+							with( field.to_sym, Range.new("1e#{range}".to_f,"1e#{range+step}".to_f) )
+						end
+					end
+					row "Over 1e#{stop}" do
+						with( field.to_sym ).greater_than "1e#{stop}".to_f
+					end
+				else
+					#	row "text label for facet in view", block for facet.query
+					row "Under #{start}" do
+						#	Is less_than just less_than or does it also include equal_to?
+						#	Results appear to include equal_to which makes it actually incorrect and misleading.
+						with( field.to_sym ).less_than start		#	facet query to pre-show count if selected (NOT A FILTER)
+					end
+					#	this works when like 1-100 step 10
+					(start..(stop-step)).step(step).each do |range|
+						row "#{range}..#{range+step}" do
+							with( field.to_sym, Range.new(range,range+step) )
+						end
+					end
+					row "Over #{stop}" do
+						#	Is greater_than just greater_than or does it also include equal_to?
+						#	Results appear to include equal_to which makes it actually incorrect and misleading.
+						with( field.to_sym ).greater_than stop
+					end
+				end
+			end
+		end
+
+	end	#	Sunspot::DSL::Search.class_eval do
+
+end

data/lib/active_record_sunspotter/sunspot_column.rb

@@ -0,0 +1,51 @@
+require 'ostruct'
+class ActiveRecordSunspotter::SunspotColumn < OpenStruct
+
+	def initialize(*args)
+		#	some sensible defaults
+		default_options = {
+			:type      => :string, 
+			:orderable => true, 
+			:facetable => false, 
+			:filterable => false, 
+			:multiple  => false, 
+			:default   => false
+		}
+		options = args.extract_options!.with_indifferent_access
+		if [String,Symbol].include?( args.first.class ) and !options.has_key?(:name)
+			options[:name] = args.first.to_s
+		end
+
+#		if( options[:type] == :null_yndk_string ) && options[:meth].blank?
+#			options[:meth] = ->(s){ YNDK[s.send(:name)]||'NULL' }
+#			options[:type] = :string
+#		end
+
+		default_options.update(options)
+#		default_options[:orderable] = false if options[:type] == :multistring
+		default_options[:orderable] = false if options[:multiple]
+		default_options[:filterable] = true if options[:facetable]
+		super default_options
+	end
+
+	def hash_table
+		instance_variable_get("@table")
+	end
+
+	def to_s
+		name
+	end
+
+end
+
+
+__END__
+
+
+Add :index option.  Default to true.
+False would effectively mean that it is only useful as a column.
+This may be the same as facetable.
+WAIT!  If aren't indexed, then can't be sorted on.
+
+So could skip adding if weren't facetable, orderable or multiple.
+

data/lib/active_record_sunspotter/sunspot_helper.rb

@@ -0,0 +1,187 @@
+module ActiveRecordSunspotter::SunspotHelper
+
+	#	Rails helpers are already "html_safe".
+	#	Manually creating the strings will require adding it.
+
+	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
+
+#	originally from CLIC
+
+	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
+
+	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
+
+	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
+
+	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
+
+	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
+
+	#
+	#	NEVER use send on a tainted string!
+	#
+	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
+
+
+
+
+	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
+
+end

data/lib/active_record_sunspotter/sunspot_rails_server.rb

@@ -0,0 +1,15 @@
+class Sunspot::Rails::Server
+	# http://opensoul.org/blog/archives/2010/04/07/cucumber-and-sunspot/
+	def running?
+		begin
+			open("http://localhost:#{self.port}/")
+			true
+		rescue Errno::ECONNREFUSED => e
+			# server not running yet
+			false
+		rescue OpenURI::HTTPError
+			# getting a response so the server is running
+			true
+		end
+	end
+end

data/lib/active_record_sunspotter/sunspotability.rb

@@ -0,0 +1,127 @@
+module ActiveRecordSunspotter::Sunspotability
+	def self.included(base)
+		base.extend(ClassMethods)
+		base.class_eval do
+			
+			#
+			#	MUST delay execution of code until included as cattr_accessor is ActiveRecord specific
+			#
+			cattr_accessor :all_sunspot_columns
+			self.all_sunspot_columns = []		#	order is only relevant to the facets
+		end
+	end
+
+	module ClassMethods
+
+		def add_sunspot_column(*args)
+			all_sunspot_columns.push( ActiveRecordSunspotter::SunspotColumn.new( *args ) )
+		end
+	
+		def sunspot_orderable_columns
+			all_sunspot_columns.select{|c|c.orderable}
+		end
+	
+		def sunspot_orderable_column_names
+			sunspot_orderable_columns.collect(&:name)
+		end
+	
+		def sunspot_default_columns
+			all_sunspot_columns.select{|c|c.default}
+		end
+	
+		def sunspot_default_column_names
+			sunspot_default_columns.collect(&:name)
+		end
+	
+		def sunspot_all_filters
+			all_sunspot_columns.select{|c|c.filterable}
+		end
+
+		#	in the order that they will appear on the page
+		def sunspot_all_facets
+			all_sunspot_columns.select{|c|c.facetable}
+		end
+		def sunspot_all_facet_names
+			sunspot_all_facets.collect(&:name)
+		end
+	
+		def sunspot_columns
+			all_sunspot_columns
+		end
+	
+		def sunspot_column_names
+			all_sunspot_columns.collect(&:name)
+		end
+	
+		def sunspot_available_column_names
+			sunspot_column_names.sort
+		end
+	
+		def sunspot_date_columns
+			all_sunspot_columns.select{|c|c.type == :date }
+		end
+	
+		def searchable_plus(&block)
+			searchable do
+				#
+				#	Trying to simplify.  Simplify?  Minimize?
+				#	Will I need all of the above methods after this is done?
+				#
+#	.select{|c| c.facetable }
+#	or just use "sunspot_all_facets" instead of "all_sunspot_columns"
+#	WAIT!  If aren't indexed, then can't be sorted on.
+				all_sunspot_columns.select{|c| ![:boolean,:nulled_string].include?(c.type) }.each{|c|
+					options = {}
+					options[:multiple] = true if( c.multiple )
+#
+#	I don't think that trie works with :long or :double
+#	I got this when I tried a :double
+#	Trie fields are only valid for numeric and time types
+#
+#	I found documentation that says that Lucene/Solr should work for longs and doubles?
+#
+#
+#	these are missing in sunspot 2.0.  I added them in my taxonomy app
+#
+#	module Sunspot::Type
+#		class TrieDoubleType < DoubleType
+#			def indexed_name(name)
+#				"#{super}t"
+#			end
+#		end
+#		class TrieLongType < LongType
+#			def indexed_name(name)
+#				"#{super}t"
+#			end
+#		end
+#	end
+#
+#					options[:trie] = true if( [:integer,:long,:double,:float,:time].include?(c.type) )
+					options[:trie] = true if( [:integer,:float,:time].include?(c.type) )
+					send( c.type, c.name, options ){
+						c.hash_table.has_key?(:meth) ? c.meth.call(self) : send( c.name )
+					}
+	#
+	#	booleans? nulled_strings?
+	#
+				}
+	
+	
+	#			yield if block_given?
+	#			yield block if block_given?
+			end	
+	
+	#	this works, but why can't I just yield inside the block
+			searchable &block if block_given?
+	
+		end
+
+	end	#	module ClassMethods
+
+end
+__END__
+
+What's the point of adding a column to the index that isn't faceted?
+It would basically just be useful as a column, which is why I was
+considering creating an "index" option.
+WAIT!  If aren't indexed, then can't be sorted on.

data/lib/jakewendt-active_record_sunspotter.rb

@@ -0,0 +1 @@
+require 'active_record_sunspotter'

data/vendor/assets/javascripts/sunspot.js

@@ -0,0 +1,27 @@
+jQuery(function(){
+
+	jQuery('div.facet_toggle a').click(function(){
+//		jQuery(this).parent().next().toggle(500);
+//  added 'blind' so doesn't resize stuff and just slides in.
+//	be advised that this effect temporarily wraps the target in a div until done.
+		jQuery(this).parent().next().toggle('blind',500);
+		jQuery(this).prev().toggleClass('ui-icon-triangle-1-e');
+		jQuery(this).prev().toggleClass('ui-icon-triangle-1-s');
+		return false;
+	});
+
+	jQuery( "#selected_columns, #unselected_columns" ).sortable({
+		connectWith: ".selectable_columns"
+	}).disableSelection();
+
+	jQuery('form').submit(function(){
+		jQuery('#selected_columns li').each(function(){
+			jQuery('<input>').attr({ 
+				name: 'c[]', 
+				type: 'hidden', 
+				value: $(this).text() 
+			}).appendTo('form');
+		});
+	});
+
+});

data/vendor/assets/stylesheets/sunspot.css.scss

@@ -0,0 +1,207 @@
+body {
+	min-width: 100%;
+	padding:0;
+	margin:0;
+}
+div#header {
+	margin:0;
+	padding:0;
+	background-color: #6A7780;
+	height: auto;
+	div#header_top {
+		height: 50px;
+		display:block;
+		padding: 0px;
+		margin: 0px;
+		border: 0px;
+		clear:both;
+	}
+}
+div#logo {
+	float:left;
+	padding-left: 10px;
+	font-family: Times New Roman,LeagueGothicRegular,helvetica,arial,sans-serif;
+	h2 {
+		font-size: 30px;
+		margin: 10px;
+		margin-top: 3px;
+		margin-bottom: 0px;
+		color:white;
+		text-shadow: #000 0 2px 3px;
+		display:inline-block;
+	}
+	a {
+		color:white;
+		text-decoration:none;
+	}
+}
+#container {
+	padding: 0;
+	margin: auto 0px;
+	display:table;
+//	width: 100%;
+	min-width: 100%;
+}
+
+#footer {
+	clear:both;
+	padding-top: 1ex;
+	padding-bottom: 1ex;
+	text-align:center;
+	font-size:8pt;
+	line-height:8pt;
+	background-color: #EEE;
+	color: gray;
+}
+
+
+.table {
+	/* this holds the table-row open, otherwise shrinks to whatever */
+	display:table;
+	width:100%;
+	.row {
+		display:table-row;
+		> div {
+			display:table-cell;
+			vertical-align: top;
+			text-align: center;
+		}
+	}
+}
+table {
+	width: 100%;
+}
+
+tr:nth-child(2n)   { background-color: #FCF9EF; }
+tr:nth-child(2n+1) { background-color: #F5F1E8; }
+
+
+
+
+
+
+
+
+
+
+
+#refine {
+	min-width: 300px;
+	/* still don't understand why, but when min-width is used, the facet column flickers too wide for a second when toggling? */
+	/* interestingly, having both width and min-width seems to do exactly what I want without flicker.  Yay */
+	width: 400px;
+	border-right: 2px solid silver;
+	padding: 0 10px;
+	form input[type=submit] {
+		font-size:14pt;
+		font-weight:bold;
+		border: 1px solid black;
+		width: 100%;
+		margin: 10px 0;
+
+		/* http://css-radius.heroku.com */
+		-webkit-border-radius: 8px;
+		-moz-border-radius: 8px;
+		border-radius: 8px;
+
+		background-color: #DDDDDD;
+		/* for webkit browsers */
+		background-image: -webkit-gradient(linear, left top, left bottom, from(#FFFFFF), to(#BBBBBB)); 
+		/* for firefox 3.6+  */
+		background-image: -moz-linear-gradient(top,  #FFFFFF,  #BBBBBB); 
+		/* for ie , but doesn't seem to work as expected despite other examples working */
+		filter: progid:DXImageTransform.Microsoft.gradient(StartColorStr='#FFFFFF', EndColorStr='#BBBBBB');
+	}
+}
+
+
+
+.facets {
+	border: 1px solid silver;
+	border-top: 0;
+	div.facet_toggle {
+		display:block;
+		padding: 5px;
+		border-top: 1px solid silver;
+		background-color:#EEE;
+		text-align: left;
+		* {
+			vertical-align:middle;
+		}
+		span {
+			display: inline-block;
+			padding-right:5px;
+		}
+		a {
+			display:inline-block;
+			text-align: left;
+		}
+	}
+	div.facet_field {
+		display:none;
+		ul {
+			padding-left: 35px;
+		/* I want a 10px padding, but also want the wordwrap indented 
+			further. so large padding and negative indent */
+			li {
+				list-style: none;
+				text-align: left;
+				text-indent: -30px;
+				label {
+					padding-left: 5px;
+				}
+			}
+		}
+	}
+}
+
+#results {
+	padding: 0 10px;
+	background-color: #FFF;
+}
+
+#filters {
+	padding: 0 10px;
+	border: 1px solid gray;
+	h3 {
+		margin-top:0;
+		padding-top:10px;
+	}
+}
+
+
+
+ul.selectable_columns {
+	background-color: silver;
+	padding: 10px;
+	list-style: none;
+	text-align: left;
+	text-indent: 20px;
+}
+
+
+
+
+/* only used in ODMS so should probably move it there */
+div#map_canvas_background {
+	position: absolute; 
+	width: 100%; 
+	height: 100%; 
+	background-color: gray; 
+	opacity: 0.6;
+	filter:alpha(opacity=60); 
+	top: 0px;
+}
+div#map_canvas_wrapper {
+	position: absolute; 
+	width: 100%; 
+	height: 100%; 
+	margin: auto; 
+	text-align: center; 
+	top: 0px;
+}
+div#map_canvas {
+	width: 90%; 
+	height: 90%; 
+	margin: 10px auto;
+}

data/vendor/views/layouts/_footer.html.erb

@@ -0,0 +1,5 @@
+<div id='footer'>
+<p>
+<small>2010 California Childhood Leukemia Study, UC Berkeley School of Public Health</small>
+</p>
+</div><!-- footer -->

data/vendor/views/layouts/_sunspot_head.html.erb

@@ -0,0 +1,14 @@
+<head>
+<meta name="ROBOTS" content="NOINDEX, NOFOLLOW" />
+<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+<%# explicity adding root_url to href making an absolute path
+	actually allows the cal favicon to load %>
+<link rel="shortcut icon" href="<%=root_url%><%=image_path('favicon.ico')%>" />
+<title><%= @page_title || "Sunspotter" -%></title>
+<link href="//ajax.googleapis.com/ajax/libs/jqueryui/1.10.1/themes/base/jquery-ui.css" media="screen" rel="stylesheet" type="text/css" />
+<%= stylesheet_link_tag 'sunspot' %>
+<script src="//ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min.js" type="text/javascript"></script>
+<script src="//ajax.googleapis.com/ajax/libs/jqueryui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
+<%= javascript_include_tag 'application','sunspot' %>
+<%= yield :head %>
+</head>

data/vendor/views/layouts/_sunspot_header.html.erb

@@ -0,0 +1,5 @@
+<div id='header'>
+<div id='header_top'>
+<div id='logo'><h2>Sunspotter<span>[beta]</span></h2></div>
+</div><!-- id='header_top' -->
+</div><!-- header -->

data/vendor/views/layouts/sunspot.html.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<%#= yield :doctype -%>
+<%# 
+	Could add "valid" tag attributes by ...
+[
+  <!ATTLIST tag myAttri CDATA #IMPLIED>
+] %>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<%= render 'layouts/sunspot_head' %>
+<body>
+<div id='container'>
+<%= render 'layouts/sunspot_header' %>
+<div class='table'>
+ <div class='row'>
+    <%= yield %>
+ </div><!-- row -->
+</div><!-- table -->
+<%= render 'layouts/footer' %>
+</div><!-- container -->
+</body>
+</html>

data/vendor/views/sunspot/_download_csv.html.erb

@@ -0,0 +1,5 @@
+<% if @search.total < 5000 %>
+	<p><%= link_to 'Download ALL as CSV', params.merge(:format => :csv) %></p>
+<% else %>
+	<p>More than 5000 samples.<br/>CSV download disabled.</p>
+<% end %>

data/vendor/views/sunspot/_facets.html.erb

@@ -0,0 +1,15 @@
+<div class='facets'>
+	<% @search.facets.each do |facet| -%>
+		<% next if facet.rows.empty? -%><%# don't show empty facets -%>
+		<%= facet_for(facet,
+			:multiselector => @sunspot_search_class.sunspot_columns.detect{|c|
+					c.name == facet.name.to_s }.try(:multiple),
+			:facet_counts  => true ) %>
+		<%# 
+			multiselector is for when a single subject could have many
+			Either as an array in itself or perhaps some implementation
+			of a has_many for enrollments or something
+		%>
+	<% end -%><%# @search.facets.each do |facet| -%>
+	<%= render 'select_columns' %>
+</div><!-- class='facets' -->

data/vendor/views/sunspot/_filters.html.erb

@@ -0,0 +1,16 @@
+<%  @sunspot_search_class.sunspot_all_filters.each do |f| %>
+	<% unless f.facetable %>
+		<% if params["#{f.name}_op"].present? %>
+			<%= hidden_field_tag "#{f.name}_op", params["#{f.name}_op"], :id => nil %>
+		<% end %>
+		<% if params[f.name].present? %>
+			<% if params[f.name].is_a?(Array) %>
+				<% params[f.name].each do |value| %>
+					<%= hidden_field_tag "#{f.name}[]", value, :id => nil %>
+				<% end %>
+			<% else %>
+
+			<% end %>
+		<% end %><%# if params[f.name].present? %>
+	<% end %><%# unless f.facetable %>
+<% end %><%#  @sunspot_search_class.sunspot_all_filters.each do |f| %>

data/vendor/views/sunspot/_link.html.erb

@@ -0,0 +1 @@
+LINK

data/vendor/views/sunspot/_per_page.html.erb

@@ -0,0 +1,4 @@
+<div class='field_wrapper'>
+	<%= label_tag( :per_page, 'per page (html only) ' )%>
+	<%= select_tag( :per_page, options_for_select([25,50,100], params[:per_page]||50) )%>
+</div><!-- class='field_wrapper' -->

data/vendor/views/sunspot/_results.html.erb

@@ -0,0 +1,24 @@
+<div id='results'>
+	<% unless @search.results.empty? %>
+		<table><thead><tr>
+			<th>&nbsp;</th>
+			<% columns.each do |column| %>
+				<th><%= column_header(column) %></th>
+			<% end %>
+		</tr></thead><tbody>
+			<% @search.results.each do |result| %>
+				<tr class='row'>
+					<td><%= render 'link', :result => result %></td>
+					<% columns.each do |column| %>
+						<td><%#= column_content(result,column).to_s.gsub(/\s+/,'&nbsp;').html_safe || '&nbsp;'.html_safe -%><%= html_column_content(result,column) %></td>
+					<% end %>
+				</tr>
+			<% end %>
+		</tbody></table>
+		<br/><%= will_paginate(@search.hits) %>
+		<p class='page_info'>Displaying page <%=@search.hits.current_page%> of 
+			<%=@search.hits.total_pages%> out of <%=@search.total%> results</p>
+	<% else %>
+		<p>No results</p>
+	<% end %>
+</div>

data/vendor/views/sunspot/_select_columns.html.erb

@@ -0,0 +1,21 @@
+<div class="facet_toggle">
+<span class="ui-icon ui-icon-triangle-1-e">&nbsp;</span><a href="javascript:void(0)">Column Selection</a>
+</div>
+<div id='columns' class='facet_field'>
+	<p>Used Columns</p>
+	<ul id="selected_columns" class="selectable_columns">
+		<% columns.each do |column| %>
+			<%# NEED to find a way to use the id, but already using id matching these 
+					column names in the facet selectors %>
+			<%= content_tag(:li, column )%>
+		<% end %>
+	</ul>
+	<p>Unused Columns</p>
+	<ul id="unselected_columns" class="selectable_columns">
+		<% (@sunspot_search_class.sunspot_available_column_names - columns).each do |column| %>
+			<%# NEED to find a way to use the id, but already using id matching these 
+					column names in the facet selectors %>
+			<%= content_tag(:li, column )%>
+		<% end %>
+	</ul>
+</div>

data/vendor/views/sunspot/index.csv.erb

@@ -0,0 +1,25 @@
+<% require 'csv' -%>
+<%# 
+	adding :headers => true is supposed to set a flag in the file 
+	somewhere marking it as having a header row, but I don't 
+	think that it actually does.
+
+	also, use a - with the ruby closing tag to avoid extra lines in csv file.
+
+	Unfortunately, when Access imports a csv file it adds a type to columns, I think.
+
+	The hospital_no is treated like an integer.  If it gets too big or contains
+	a non-digit character, it just leaves the field blank.  This is an absolutely
+	awful idea.  Thanks again Microsoft.  Because of this, I force quotes.
+	I really only need to quote the hospital_no, but it is easier to just quote them all.
+
+-%>
+<%= columns.to_csv( :headers => true) -%>
+<% @search.results.each do |result| %>
+<%= columns.collect{|c| column_content(result,c) }.to_csv(:force_quotes => true).html_safe -%>
+<% end -%>
+<%#
+
+I added html_safe to stop any html encoding just in case
+
+-%>

data/vendor/views/sunspot/index.json.erb

@@ -0,0 +1,25 @@
+<%# require 'csv' -%>
+<%# 
+	adding :headers => true is supposed to set a flag in the file 
+	somewhere marking it as having a header row, but I don't 
+	think that it actually does.
+
+	also, use a - with the ruby closing tag to avoid extra lines in csv file.
+
+	Unfortunately, when Access imports a csv file it adds a type to columns, I think.
+
+	The hospital_no is treated like an integer.  If it gets too big or contains
+	a non-digit character, it just leaves the field blank.  This is an absolutely
+	awful idea.  Thanks again Microsoft.  Because of this, I force quotes.
+	I really only need to quote the hospital_no, but it is easier to just quote them all.
+
+-%>
+<%#= columns.to_csv( :headers => true) -%>
+<%= @search.results.collect do |result| -%>
+<% columns.inject({}){|h,c| h[c] = column_content(result,c); h} -%>
+<% end.to_json.html_safe -%>
+<%#
+
+I added html_safe to stop any html encoding just in case
+
+-%>

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: jakewendt-active_record_sunspotter
+version: !ruby/object:Gem::Version
+  version: 0.0.12
+platform: ruby
+authors:
+- George 'Jake' Wendt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sunspot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: sunspot_solr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: progress_bar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: active_record_sunspotter
+email: github@jakewendt.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/active_record_sunspotter.rb
+- lib/active_record_sunspotter/rails/engine.rb
+- lib/active_record_sunspotter/rails/railtie.rb
+- lib/active_record_sunspotter/search_sunspot_for.rb
+- lib/active_record_sunspotter/sunspot_column.rb
+- lib/active_record_sunspotter/sunspot_helper.rb
+- lib/active_record_sunspotter/sunspot_rails_server.rb
+- lib/active_record_sunspotter/sunspotability.rb
+- lib/jakewendt-active_record_sunspotter.rb
+- vendor/assets/javascripts/sunspot.js
+- vendor/assets/stylesheets/sunspot.css.scss
+- vendor/views/layouts/_footer.html.erb
+- vendor/views/layouts/_sunspot_head.html.erb
+- vendor/views/layouts/_sunspot_header.html.erb
+- vendor/views/layouts/sunspot.html.erb
+- vendor/views/sunspot/_download_csv.html.erb
+- vendor/views/sunspot/_facets.html.erb
+- vendor/views/sunspot/_filters.html.erb
+- vendor/views/sunspot/_link.html.erb
+- vendor/views/sunspot/_per_page.html.erb
+- vendor/views/sunspot/_results.html.erb
+- vendor/views/sunspot/_select_columns.html.erb
+- vendor/views/sunspot/index.csv.erb
+- vendor/views/sunspot/index.json.erb
+- README.rdoc
+homepage: http://github.com/jakewendt/active_record_sunspotter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: active_record_sunspotter
+test_files: []