adamsalter-sunspot_rails 0.10.4
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +18 -0
- data/MIT-LICENSE +20 -0
- data/README.rdoc +246 -0
- data/Rakefile +19 -0
- data/VERSION.yml +4 -0
- data/dev_tasks/gemspec.rake +27 -0
- data/dev_tasks/rdoc.rake +7 -0
- data/dev_tasks/todo.rake +4 -0
- data/install.rb +1 -0
- data/lib/sunspot/rails/adapters.rb +54 -0
- data/lib/sunspot/rails/configuration.rb +151 -0
- data/lib/sunspot/rails/request_lifecycle.rb +18 -0
- data/lib/sunspot/rails/searchable.rb +304 -0
- data/lib/sunspot/rails/tasks.rb +47 -0
- data/lib/sunspot/rails.rb +11 -0
- data/rails/init.rb +10 -0
- data/spec/configuration_spec.rb +16 -0
- data/spec/mock_app/app/controllers/application.rb +10 -0
- data/spec/mock_app/app/controllers/application_controller.rb +10 -0
- data/spec/mock_app/app/controllers/posts_controller.rb +6 -0
- data/spec/mock_app/app/models/blog.rb +2 -0
- data/spec/mock_app/app/models/post.rb +5 -0
- data/spec/mock_app/app/models/post_with_auto.rb +9 -0
- data/spec/mock_app/config/boot.rb +110 -0
- data/spec/mock_app/config/database.yml +4 -0
- data/spec/mock_app/config/environment.rb +41 -0
- data/spec/mock_app/config/environments/development.rb +27 -0
- data/spec/mock_app/config/environments/test.rb +27 -0
- data/spec/mock_app/config/initializers/new_rails_defaults.rb +19 -0
- data/spec/mock_app/config/initializers/session_store.rb +15 -0
- data/spec/mock_app/config/routes.rb +43 -0
- data/spec/mock_app/config/sunspot.yml +13 -0
- data/spec/model_lifecycle_spec.rb +38 -0
- data/spec/model_spec.rb +278 -0
- data/spec/request_lifecycle_spec.rb +10 -0
- data/spec/schema.rb +14 -0
- data/spec/spec_helper.rb +30 -0
- metadata +180 -0
data/LICENSE
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
2
|
+
a copy of this software and associated documentation files (the
|
3
|
+
'Software'), to deal in the Software without restriction, including
|
4
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
5
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
6
|
+
permit persons to whom the Software is furnished to do so, subject to
|
7
|
+
the following conditions:
|
8
|
+
|
9
|
+
The above copyright notice and this permission notice shall be
|
10
|
+
included in all copies or substantial portions of the Software.
|
11
|
+
|
12
|
+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
13
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
14
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
15
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
16
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
17
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
18
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Mat Brown
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,246 @@
|
|
1
|
+
= Sunspot::Rails
|
2
|
+
|
3
|
+
Sunspot::Rails is a Rails plugin that provides drop-in integration of the
|
4
|
+
Sunspot[http://outoftime.github.com/sunspot] Solr search library with Rails. It
|
5
|
+
provides the following features:
|
6
|
+
|
7
|
+
* Configure Sunspot using config/sunspot.yml
|
8
|
+
* Extend ActiveRecord for easy index configuration, search, and indexing
|
9
|
+
* Automatically index ActiveRecord objects when they are saved, and remove them
|
10
|
+
from the index when they are destroyed (can be disabled)
|
11
|
+
* Automatically commit Solr changes at the end of each request
|
12
|
+
* Provide utility methods to find and fix orphaned documents and rebuild the
|
13
|
+
Solr index for a given class
|
14
|
+
* Provide rake tasks for starting and stopping the development Solr instance,
|
15
|
+
using the configuration in sunspot.yml
|
16
|
+
|
17
|
+
Sunspot::Rails has been tested with Rails versions 2.1, 2.2, and 2.3
|
18
|
+
|
19
|
+
== Installation
|
20
|
+
|
21
|
+
First, install the Sunspot and Sunspot::Rails gems:
|
22
|
+
|
23
|
+
sudo gem install outoftime-sunspot outoftime-sunspot_rails --source=http://gems.github.com
|
24
|
+
|
25
|
+
In your project's <code>config/environment.rb</code>, add the following gem dependencies:
|
26
|
+
|
27
|
+
config.gem 'outoftime-sunspot', :lib => 'sunspot'
|
28
|
+
config.gem 'outoftime-sunspot_rails', :lib => 'sunspot/rails'
|
29
|
+
|
30
|
+
If you are using an older version of Rails that doesn't support plugins-as-gems,
|
31
|
+
use:
|
32
|
+
|
33
|
+
script/plugin install git://github.com/outoftime/sunspot_rails.git
|
34
|
+
|
35
|
+
Create the file <code>config/sunspot.yml</code> and set it up for your environments. Here is a sample:
|
36
|
+
|
37
|
+
common: &common
|
38
|
+
solr:
|
39
|
+
hostname: localhost
|
40
|
+
port: 8983
|
41
|
+
|
42
|
+
production:
|
43
|
+
<<: *common
|
44
|
+
solr:
|
45
|
+
path: /solr/myindex
|
46
|
+
|
47
|
+
development:
|
48
|
+
<<: *common
|
49
|
+
solr:
|
50
|
+
port: 8982
|
51
|
+
|
52
|
+
test:
|
53
|
+
<<: *common
|
54
|
+
solr:
|
55
|
+
port: 8981
|
56
|
+
|
57
|
+
Rails doesn't automatically load rake tasks from plugins installed as gems
|
58
|
+
(https://rails.lighthouseapp.com/projects/8994/tickets/59). If you installed
|
59
|
+
Sunspot::Rails as a gem, add the following line to your project's Rakefile:
|
60
|
+
|
61
|
+
require 'sunspot/rails/tasks'
|
62
|
+
|
63
|
+
If you wish to make modifications to the Solr schema, you can create a custom
|
64
|
+
Solr home in your project directory. In order to do so, create the directory
|
65
|
+
<code>RAILS_ROOT/solr/conf</code>, and copy in the contents of the Solr gem's
|
66
|
+
<code>solr/solr/conf</code> directory. If the files are in the right place,
|
67
|
+
Sunspot::Rails will detect them and tell Solr to use your local configurations.
|
68
|
+
Use caution when modifying <code>schema.xml</code> - Sunspot relies on the
|
69
|
+
field naming scheme in the packaged schema file.
|
70
|
+
|
71
|
+
To start up a Solr instance, issue the following:
|
72
|
+
|
73
|
+
rake sunspot:solr:start
|
74
|
+
|
75
|
+
Note that using the built-in Solr instance packaged with Sunspot is great for
|
76
|
+
development, but is not recommended for production. See the Sunspot
|
77
|
+
documentation for more information.
|
78
|
+
|
79
|
+
== Usage
|
80
|
+
|
81
|
+
=== Setup
|
82
|
+
|
83
|
+
In order for an ActiveRecord model to be indexable and searchable, it must be
|
84
|
+
configured for search. For example:
|
85
|
+
|
86
|
+
class Post < ActiveRecord::Base
|
87
|
+
searchable do
|
88
|
+
text :title, :body
|
89
|
+
integer :blog_id
|
90
|
+
time :updated_at
|
91
|
+
string :sort_title do
|
92
|
+
title.downcase.sub(/^(an?|the) /, '')
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
See the documentation for Sunspot.setup for full details on what can go in the
|
98
|
+
configuration block.
|
99
|
+
|
100
|
+
=== Indexing
|
101
|
+
|
102
|
+
By default, models are indexed whenever they are saved, and removed from the
|
103
|
+
index whenever they are destroyed. This behavior can be disabled:
|
104
|
+
|
105
|
+
class Post < ActiveRecord::Base
|
106
|
+
searchable :auto_index => false, :auto_remove => false do
|
107
|
+
# setup...
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
Note that <b>using the <code>:auto_remove</code> option is not recommended
|
112
|
+
</b>, as destroying an object without removing it from the index will
|
113
|
+
create an orphaned document in the index, which is a Bad Thing. Turning off
|
114
|
+
<code>:auto_index</code> is perfectly safe if you prefer to manage indexing manually
|
115
|
+
(perhaps using a background job).
|
116
|
+
|
117
|
+
If you have disabled lifecycle indexing hooks, you can invoke indexing
|
118
|
+
operations directly on your model:
|
119
|
+
|
120
|
+
post = Post.create
|
121
|
+
post.index
|
122
|
+
post.remove_from_index
|
123
|
+
|
124
|
+
=== Committing
|
125
|
+
|
126
|
+
When data is changed in Solr, it is initially stored in memory and not made
|
127
|
+
available to the currently running searcher instance. Issuing a +commit+ to Solr
|
128
|
+
will cause it to write the changes to disk, and instantiate a new searcher
|
129
|
+
instance. This operation is fairly expensive, so rather than issuing a commit
|
130
|
+
every time a document is added or removed, Sunspot::Rails issues a commit at
|
131
|
+
the end of any request where data has been added to or removed from Solr. If
|
132
|
+
you need to immediately issue a commit, bang!-versions of the methods are
|
133
|
+
available:
|
134
|
+
|
135
|
+
post = Post.create
|
136
|
+
post.index!
|
137
|
+
# this is the same as...
|
138
|
+
post.index
|
139
|
+
Sunspot.commit
|
140
|
+
|
141
|
+
When writing tests outside of the context of a controller request, you will want
|
142
|
+
to use one of these two approaches.
|
143
|
+
|
144
|
+
=== Searching
|
145
|
+
|
146
|
+
Do it like this:
|
147
|
+
|
148
|
+
Post.search do
|
149
|
+
with :blog_id, 1
|
150
|
+
with(:updated_at).greater_than(Time.now - 2.weeks)
|
151
|
+
order :sort_title, :asc
|
152
|
+
paginate :page => 1, :per_page => 15
|
153
|
+
end
|
154
|
+
|
155
|
+
See the documentation for <code>Sunspot.search</code> for all the options
|
156
|
+
available in the search block, and the information available in the result
|
157
|
+
block.
|
158
|
+
|
159
|
+
=== Searching for IDs
|
160
|
+
|
161
|
+
In some situations, you may want to get the IDs for models returned by a search
|
162
|
+
without actually loading the models out of the database. For that, you can
|
163
|
+
call +search_ids+, using the same block format as #search. This will return an
|
164
|
+
array of IDs.
|
165
|
+
|
166
|
+
|
167
|
+
=== Searching for multiple types
|
168
|
+
|
169
|
+
Sunspot is entirely agnostic about whether searches are for one or more types;
|
170
|
+
the only restriction is that columns used for restriction, ordering, etc. are
|
171
|
+
defined in the same way for all types being searched. Sunspot::Rails does not
|
172
|
+
provide any additional support for this, since there is not anything useful to
|
173
|
+
be added, so just use the interface provided by Sunspot:
|
174
|
+
|
175
|
+
Sunspot.search(Post, Comment) do
|
176
|
+
with :blog_id, 1
|
177
|
+
order :created_at, :asc
|
178
|
+
end
|
179
|
+
|
180
|
+
Be sure to check out the Sunspot documentation for all the details.
|
181
|
+
|
182
|
+
=== Adding search functionality in mixins
|
183
|
+
|
184
|
+
Sunspot does not require that search setup for a given class happen all in one
|
185
|
+
place; it is perfectly acceptable to call the <code>Sunspot.setup</code> method
|
186
|
+
more than once. This capability is particularly useful for adding search
|
187
|
+
functionality in mixins. For instance, if you have a +Ratable+ module, you may
|
188
|
+
wish to add additional search fields for searchable classes that mix in that
|
189
|
+
module. For example:
|
190
|
+
|
191
|
+
module Ratable
|
192
|
+
def self.included(base)
|
193
|
+
if base.searchable?
|
194
|
+
base.searchable do
|
195
|
+
float :average_rating do
|
196
|
+
ratings.average(:value)
|
197
|
+
end
|
198
|
+
end
|
199
|
+
end
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
Note the use of <code>base.searchable?</code> - this ensures that only classes
|
204
|
+
that already have search enabled will have the additional configuration added.
|
205
|
+
The above pattern requires that the class be declared searchable before the
|
206
|
+
module is mixed in; other patterns (such as passing a :searchable option to an
|
207
|
+
acts_as_-style declaration) may be more flexible.
|
208
|
+
|
209
|
+
=== Utility methods
|
210
|
+
|
211
|
+
If you need to completely reindex all of the instances of a given model class,
|
212
|
+
you can issue:
|
213
|
+
|
214
|
+
Post.reindex
|
215
|
+
|
216
|
+
If for some reason models get deleted from the database, but not from the index,
|
217
|
+
they will become index orphans - not a good situation. To get IDs that exist in
|
218
|
+
the index but not the database, you can use the +index_orphans+ method; to
|
219
|
+
remove those documents from the index, use +clean_index_orphans+. Note that
|
220
|
+
neither of these operations should be needed if Sunspot and Sunspot::Rails are
|
221
|
+
used as intended.
|
222
|
+
|
223
|
+
== Further Reading
|
224
|
+
|
225
|
+
Reading the {Sunspot documentation}[http://outoftime.github.com/sunspot/docs] is
|
226
|
+
highly recommended. Sunspot::Rails exists to wrap Sunspot with a Rails-friendly
|
227
|
+
API, but almost all of the functionality you use in Sunspot::Rails is
|
228
|
+
implemented in Sunspot.
|
229
|
+
|
230
|
+
Posts about Sunspot on my blog are available at http://outofti.me/tagged/sunspot
|
231
|
+
|
232
|
+
== Bugs
|
233
|
+
|
234
|
+
Please submit bug reports to
|
235
|
+
http://outoftime.lighthouseapp.com/projects/20339-sunspot
|
236
|
+
|
237
|
+
== Contributors
|
238
|
+
|
239
|
+
- Mat Brown (mat@patch.com)
|
240
|
+
- Peer Allan (peer.allan@gmail.com)
|
241
|
+
- Michael Moen (michael@underpantsgnome.com)
|
242
|
+
- Benjamin Krause (bk@benjaminkrause.com)
|
243
|
+
|
244
|
+
== License
|
245
|
+
|
246
|
+
Sunspot::Rails is distributed under the MIT License, copyright (c) 2009 Mat Brown
|
data/Rakefile
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'rake'
|
2
|
+
require 'spec/rake/spectask'
|
3
|
+
require 'rake/rdoctask'
|
4
|
+
|
5
|
+
task :default => :spec
|
6
|
+
|
7
|
+
desc 'Run all specs'
|
8
|
+
Spec::Rake::SpecTask.new(:spec) do |t|
|
9
|
+
t.spec_files = FileList['spec/**/*_spec.rb']
|
10
|
+
t.spec_opts << '--color'
|
11
|
+
end
|
12
|
+
|
13
|
+
task :environment do
|
14
|
+
ENV['RAILS_ROOT'] ||= File.join(File.dirname(__FILE__), 'spec', 'mock_app')
|
15
|
+
ENV['RAILS_ENV'] ||= 'test'
|
16
|
+
require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config', 'environment.rb'))
|
17
|
+
end
|
18
|
+
|
19
|
+
FileList['dev_tasks/*.rake', 'lib/sunspot/rails/tasks.rb'].each { |file| load(file) }
|
data/VERSION.yml
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
begin
|
2
|
+
gem 'technicalpickles-jeweler', '~> 1.0'
|
3
|
+
require 'jeweler'
|
4
|
+
Jeweler::Tasks.new do |s|
|
5
|
+
s.name = 'sunspot_rails'
|
6
|
+
s.summary = 'Rails integration for the Sunspot Solr search library'
|
7
|
+
s.email = 'mat@patch.com'
|
8
|
+
s.homepage = 'http://github.com/outoftime/sunspot_rails'
|
9
|
+
s.description = 'Rails integration for the Sunspot Solr search library'
|
10
|
+
s.authors = ['Mat Brown', 'Peer Allan', 'Michael Moen', 'Benjamin Krause']
|
11
|
+
s.files = FileList['[A-Z]*',
|
12
|
+
'{lib,tasks,dev_tasks}/**/*',
|
13
|
+
'install.rb',
|
14
|
+
'MIT-LICENSE',
|
15
|
+
'rails/*',
|
16
|
+
'spec/*.rb',
|
17
|
+
'spec/mock_app/{app,lib,db,vendor,config}/**/*',
|
18
|
+
'spec/mock_app/{tmp,log,solr}']
|
19
|
+
s.add_dependency 'rails', '~> 2.1'
|
20
|
+
s.add_dependency 'escape', '>= 0.0.4'
|
21
|
+
s.add_dependency 'outoftime-sunspot', '>= 0.8.2'
|
22
|
+
s.add_development_dependency 'rspec', '~> 1.2'
|
23
|
+
s.add_development_dependency 'rspec-rails', '~> 1.2'
|
24
|
+
s.add_development_dependency 'ruby-debug', '~> 0.10'
|
25
|
+
s.add_development_dependency 'technicalpickles-jeweler', '~> 1.0'
|
26
|
+
end
|
27
|
+
end
|
data/dev_tasks/rdoc.rake
ADDED
data/dev_tasks/todo.rake
ADDED
data/install.rb
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
# Install hook code here
|
@@ -0,0 +1,54 @@
|
|
1
|
+
module Sunspot #:nodoc:
|
2
|
+
module Rails #:nodoc:
|
3
|
+
#
|
4
|
+
# This module provides Sunspot Adapter implementations for ActiveRecord
|
5
|
+
# models.
|
6
|
+
#
|
7
|
+
module Adapters
|
8
|
+
class ActiveRecordInstanceAdapter < Sunspot::Adapters::InstanceAdapter
|
9
|
+
#
|
10
|
+
# Return the primary key for the adapted instance
|
11
|
+
#
|
12
|
+
# ==== Returns
|
13
|
+
#
|
14
|
+
# Integer:: Database ID of model
|
15
|
+
#
|
16
|
+
def id
|
17
|
+
@instance.id
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
class ActiveRecordDataAccessor < Sunspot::Adapters::DataAccessor
|
22
|
+
#
|
23
|
+
# Get one ActiveRecord instance out of the database by ID
|
24
|
+
#
|
25
|
+
# ==== Parameters
|
26
|
+
#
|
27
|
+
# id<String>:: Database ID of model to retreive
|
28
|
+
#
|
29
|
+
# ==== Returns
|
30
|
+
#
|
31
|
+
# ActiveRecord::Base:: ActiveRecord model
|
32
|
+
#
|
33
|
+
def load(id)
|
34
|
+
@clazz.find(id.to_i)
|
35
|
+
end
|
36
|
+
|
37
|
+
#
|
38
|
+
# Get a collection of ActiveRecord instances out of the database by ID
|
39
|
+
#
|
40
|
+
# ==== Parameters
|
41
|
+
#
|
42
|
+
# ids<Array>:: Database IDs of models to retrieve
|
43
|
+
#
|
44
|
+
# ==== Returns
|
45
|
+
#
|
46
|
+
# Array:: Collection of ActiveRecord models
|
47
|
+
#
|
48
|
+
def load_all(ids)
|
49
|
+
@clazz.find(ids.map { |id| id.to_i })
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
@@ -0,0 +1,151 @@
|
|
1
|
+
module Sunspot #:nodoc:
|
2
|
+
module Rails #:nodoc:
|
3
|
+
#
|
4
|
+
# Sunspot::Rails is configured via the config/sunspot.yml file, which
|
5
|
+
# contains properties keyed by environment name. A sample sunspot.yml file
|
6
|
+
# would look like:
|
7
|
+
#
|
8
|
+
# development:
|
9
|
+
# solr:
|
10
|
+
# hostname: localhost
|
11
|
+
# port: 8982
|
12
|
+
# test:
|
13
|
+
# solr:
|
14
|
+
# hostname: localhost
|
15
|
+
# port: 8983
|
16
|
+
#
|
17
|
+
# production:
|
18
|
+
# solr:
|
19
|
+
# hostname: localhost
|
20
|
+
# port: 8983
|
21
|
+
# path: /solr/myindex
|
22
|
+
#
|
23
|
+
# Sunspot::Rails uses the configuration to set up the Solr connection, as
|
24
|
+
# well as for starting Solr with the appropriate port using the
|
25
|
+
# <code>rake sunspot:solr:start</code> task.
|
26
|
+
#
|
27
|
+
class Configuration
|
28
|
+
#
|
29
|
+
# The host name at which to connect to Solr. Default 'localhost'.
|
30
|
+
#
|
31
|
+
# ==== Returns
|
32
|
+
#
|
33
|
+
# String:: host name
|
34
|
+
#
|
35
|
+
def hostname
|
36
|
+
@hostname ||=
|
37
|
+
if user_configuration.has_key?('solr')
|
38
|
+
user_configuration['solr']['hostname']
|
39
|
+
end || 'localhost'
|
40
|
+
end
|
41
|
+
|
42
|
+
#
|
43
|
+
# The port at which to connect to Solr. Default 8983.
|
44
|
+
#
|
45
|
+
# ==== Returns
|
46
|
+
#
|
47
|
+
# Integer:: port
|
48
|
+
#
|
49
|
+
def port
|
50
|
+
@port ||=
|
51
|
+
if user_configuration.has_key?('solr')
|
52
|
+
user_configuration['solr']['port']
|
53
|
+
end || 8983
|
54
|
+
end
|
55
|
+
|
56
|
+
#
|
57
|
+
# The url path to the Solr servlet (useful if you are running multicore).
|
58
|
+
# Default '/solr'.
|
59
|
+
#
|
60
|
+
# ==== Returns
|
61
|
+
#
|
62
|
+
# String:: path
|
63
|
+
#
|
64
|
+
def path
|
65
|
+
@path ||=
|
66
|
+
if user_configuration.has_key?('solr')
|
67
|
+
"#{user_configuration['solr']['path'] || '/solr'}"
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
#
|
72
|
+
# The path to the Solr indexes. (Used by the rake tasks).
|
73
|
+
# Default RAILS_ROOT + '/solr/data/' + ENVIRONMENT
|
74
|
+
#
|
75
|
+
# ==== Returns
|
76
|
+
#
|
77
|
+
# String:: path
|
78
|
+
#
|
79
|
+
def data_path
|
80
|
+
@data_path ||=
|
81
|
+
if user_configuration.has_key?('solr')
|
82
|
+
"#{user_configuration['solr']['data_path'] || File.join(::Rails.root, 'solr', 'data', ::Rails.env)}"
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
#
|
87
|
+
# The path to the Solr pids
|
88
|
+
# Default RAILS_ROOT + '/solr/pids/' + ENVIRONMENT
|
89
|
+
#
|
90
|
+
# ==== Returns
|
91
|
+
#
|
92
|
+
# String:: path
|
93
|
+
#
|
94
|
+
def pid_path
|
95
|
+
@pids_path ||=
|
96
|
+
if user_configuration.has_key?('solr')
|
97
|
+
"#{user_configuration['solr']['pid_path'] || File.join(::Rails.root, 'solr', 'pids', ::Rails.env)}"
|
98
|
+
end
|
99
|
+
end
|
100
|
+
|
101
|
+
#
|
102
|
+
# The path to the Solr home directory
|
103
|
+
# Default nil (runs the solr with sunspot default settings).
|
104
|
+
#
|
105
|
+
# If you have a custom solr conf directory,
|
106
|
+
# change this to the directory above your solr conf files
|
107
|
+
#
|
108
|
+
# e.g. conf files in RAILS_ROOT/solr/conf
|
109
|
+
# solr_home: RAILS_ROOT/solr
|
110
|
+
#
|
111
|
+
# ==== Returns
|
112
|
+
#
|
113
|
+
# String:: path
|
114
|
+
#
|
115
|
+
def solr_home
|
116
|
+
@solr_home ||=
|
117
|
+
if user_configuration.has_key?('solr')
|
118
|
+
if user_configuration['solr']['solr_home'].present?
|
119
|
+
user_configuration['solr']['solr_home']
|
120
|
+
elsif %w(solrconfig schema).all? { |file| File.exist?(File.join(::Rails.root, 'solr', 'conf', "#{file}.xml")) }
|
121
|
+
File.join(::Rails.root, 'solr')
|
122
|
+
else
|
123
|
+
nil
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
128
|
+
private
|
129
|
+
|
130
|
+
#
|
131
|
+
# Memoized hash of configuration options for the current Rails environment
|
132
|
+
# as specified in config/sunspot.yml
|
133
|
+
#
|
134
|
+
# ==== Returns
|
135
|
+
#
|
136
|
+
# Hash:: configuration options for current environment
|
137
|
+
#
|
138
|
+
def user_configuration
|
139
|
+
@user_configuration ||=
|
140
|
+
begin
|
141
|
+
path = File.join(::Rails.root, 'config', 'sunspot.yml')
|
142
|
+
if File.exist?(path)
|
143
|
+
File.open(path) do |file|
|
144
|
+
YAML.load(file)[::Rails.env]
|
145
|
+
end
|
146
|
+
end
|
147
|
+
end
|
148
|
+
end
|
149
|
+
end
|
150
|
+
end
|
151
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
module Sunspot #:nodoc:
|
2
|
+
module Rails #:nodoc:
|
3
|
+
#
|
4
|
+
# This module adds an after_filter to ActionController::Base that commits
|
5
|
+
# the Sunspot session if any documents have been added, changed, or removed
|
6
|
+
# in the course of the request.
|
7
|
+
#
|
8
|
+
module RequestLifecycle
|
9
|
+
class <<self
|
10
|
+
def included(base) #:nodoc:
|
11
|
+
base.after_filter do
|
12
|
+
Sunspot.commit_if_dirty
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|