kristopher-sunspot_rails 0.10.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. data/LICENSE +18 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.rdoc +233 -0
  4. data/Rakefile +19 -0
  5. data/VERSION.yml +4 -0
  6. data/dev_tasks/gemspec.rake +29 -0
  7. data/dev_tasks/rdoc.rake +7 -0
  8. data/dev_tasks/release.rake +4 -0
  9. data/dev_tasks/todo.rake +4 -0
  10. data/generators/sunspot/sunspot_generator.rb +9 -0
  11. data/generators/sunspot/templates/sunspot.yml +19 -0
  12. data/install.rb +1 -0
  13. data/lib/sunspot/rails.rb +13 -0
  14. data/lib/sunspot/rails/adapters.rb +54 -0
  15. data/lib/sunspot/rails/configuration.rb +169 -0
  16. data/lib/sunspot/rails/request_lifecycle.rb +18 -0
  17. data/lib/sunspot/rails/searchable.rb +305 -0
  18. data/lib/sunspot/rails/tasks.rb +47 -0
  19. data/rails/init.rb +10 -0
  20. data/spec/configuration_spec.rb +53 -0
  21. data/spec/mock_app/app/controllers/application.rb +10 -0
  22. data/spec/mock_app/app/controllers/application_controller.rb +10 -0
  23. data/spec/mock_app/app/controllers/posts_controller.rb +6 -0
  24. data/spec/mock_app/app/models/blog.rb +2 -0
  25. data/spec/mock_app/app/models/post.rb +5 -0
  26. data/spec/mock_app/app/models/post_with_auto.rb +9 -0
  27. data/spec/mock_app/config/boot.rb +110 -0
  28. data/spec/mock_app/config/database.yml +4 -0
  29. data/spec/mock_app/config/environment.rb +41 -0
  30. data/spec/mock_app/config/environments/development.rb +27 -0
  31. data/spec/mock_app/config/environments/test.rb +27 -0
  32. data/spec/mock_app/config/initializers/new_rails_defaults.rb +19 -0
  33. data/spec/mock_app/config/initializers/session_store.rb +15 -0
  34. data/spec/mock_app/config/routes.rb +43 -0
  35. data/spec/mock_app/config/sunspot.yml +14 -0
  36. data/spec/model_lifecycle_spec.rb +38 -0
  37. data/spec/model_spec.rb +278 -0
  38. data/spec/request_lifecycle_spec.rb +30 -0
  39. data/spec/schema.rb +14 -0
  40. data/spec/spec_helper.rb +32 -0
  41. metadata +184 -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,233 @@
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
+ For recent versions of Rails, In your project's <code>config/environment.rb</code>, add the following gem dependencies:
22
+
23
+ config.gem 'outoftime-sunspot', :lib => 'sunspot',
24
+ :source => 'http://gems.github.com'
25
+ config.gem 'outoftime-sunspot_rails', :lib => 'sunspot/rails',
26
+ :source => 'http://gems.github.com'
27
+
28
+ Install the gems with:
29
+
30
+ rake gems:install
31
+
32
+ If you are using an older version of Rails that doesn't support plugins-as-gems, install the gems manually and install the plugin:
33
+
34
+ sudo gem install outoftime-sunspot outoftime-sunspot_rails --source=http://gems.github.com
35
+
36
+ script/plugin install git://github.com/outoftime/sunspot_rails.git
37
+
38
+ Generate the file <code>config/sunspot.yml</code>:
39
+
40
+ script/generate sunspot
41
+
42
+ Rails doesn't automatically load rake tasks from plugins installed as gems
43
+ (https://rails.lighthouseapp.com/projects/8994/tickets/59). If you installed
44
+ Sunspot::Rails as a gem, add the following line to your project's Rakefile:
45
+
46
+ require 'sunspot/rails/tasks'
47
+
48
+ If you wish to make modifications to the Solr schema, you can create a custom
49
+ Solr home in your project directory. In order to do so, create the directory
50
+ <code>RAILS_ROOT/solr/conf</code>, and copy in the contents of the Solr gem's
51
+ <code>solr/solr/conf</code> directory. If the files are in the right place,
52
+ Sunspot::Rails will detect them and tell Solr to use your local configurations.
53
+ Use caution when modifying <code>schema.xml</code> - Sunspot relies on the
54
+ field naming scheme in the packaged schema file.
55
+
56
+ To start up a Solr instance, issue the following:
57
+
58
+ rake sunspot:solr:start
59
+
60
+ Note that using the built-in Solr instance packaged with Sunspot is great for
61
+ development, but is not recommended for production. See the Sunspot
62
+ documentation for more information.
63
+
64
+ == Usage
65
+
66
+ === Setup
67
+
68
+ In order for an ActiveRecord model to be indexable and searchable, it must be
69
+ configured for search. For example:
70
+
71
+ class Post < ActiveRecord::Base
72
+ searchable do
73
+ text :title, :body
74
+ integer :blog_id
75
+ time :updated_at
76
+ string :sort_title do
77
+ title.downcase.sub(/^(an?|the) /, '')
78
+ end
79
+ end
80
+ end
81
+
82
+ See the documentation for Sunspot.setup for full details on what can go in the
83
+ configuration block.
84
+
85
+ === Indexing
86
+
87
+ By default, models are indexed whenever they are saved, and removed from the
88
+ index whenever they are destroyed. This behavior can be disabled:
89
+
90
+ class Post < ActiveRecord::Base
91
+ searchable :auto_index => false, :auto_remove => false do
92
+ # setup...
93
+ end
94
+ end
95
+
96
+ Note that <b>using the <code>:auto_remove</code> option is not recommended
97
+ </b>, as destroying an object without removing it from the index will
98
+ create an orphaned document in the index, which is a Bad Thing. Turning off
99
+ <code>:auto_index</code> is perfectly safe if you prefer to manage indexing manually
100
+ (perhaps using a background job).
101
+
102
+ If you have disabled lifecycle indexing hooks, you can invoke indexing
103
+ operations directly on your model:
104
+
105
+ post = Post.create
106
+ post.index
107
+ post.remove_from_index
108
+
109
+ === Committing
110
+
111
+ When data is changed in Solr, it is initially stored in memory and not made
112
+ available to the currently running searcher instance. Issuing a +commit+ to Solr
113
+ will cause it to write the changes to disk, and instantiate a new searcher
114
+ instance. This operation is fairly expensive, so rather than issuing a commit
115
+ every time a document is added or removed, Sunspot::Rails issues a commit at
116
+ the end of any request where data has been added to or removed from Solr. If
117
+ you need to immediately issue a commit, bang!-versions of the methods are
118
+ available:
119
+
120
+ post = Post.create
121
+ post.index!
122
+ # this is the same as...
123
+ post.index
124
+ Sunspot.commit
125
+
126
+ When writing tests outside of the context of a controller request, you will want
127
+ to use one of these two approaches.
128
+
129
+ === Searching
130
+
131
+ Do it like this:
132
+
133
+ Post.search do
134
+ with :blog_id, 1
135
+ with(:updated_at).greater_than(Time.now - 2.weeks)
136
+ order :sort_title, :asc
137
+ paginate :page => 1, :per_page => 15
138
+ end
139
+
140
+ See the documentation for <code>Sunspot.search</code> for all the options
141
+ available in the search block, and the information available in the result
142
+ block.
143
+
144
+ === Searching for IDs
145
+
146
+ In some situations, you may want to get the IDs for models returned by a search
147
+ without actually loading the models out of the database. For that, you can
148
+ call +search_ids+, using the same block format as #search. This will return an
149
+ array of IDs.
150
+
151
+
152
+ === Searching for multiple types
153
+
154
+ Sunspot is entirely agnostic about whether searches are for one or more types;
155
+ the only restriction is that columns used for restriction, ordering, etc. are
156
+ defined in the same way for all types being searched. Sunspot::Rails does not
157
+ provide any additional support for this, since there is not anything useful to
158
+ be added, so just use the interface provided by Sunspot:
159
+
160
+ Sunspot.search(Post, Comment) do
161
+ with :blog_id, 1
162
+ order :created_at, :asc
163
+ end
164
+
165
+ Be sure to check out the Sunspot documentation for all the details.
166
+
167
+ === Adding search functionality in mixins
168
+
169
+ Sunspot does not require that search setup for a given class happen all in one
170
+ place; it is perfectly acceptable to call the <code>Sunspot.setup</code> method
171
+ more than once. This capability is particularly useful for adding search
172
+ functionality in mixins. For instance, if you have a +Ratable+ module, you may
173
+ wish to add additional search fields for searchable classes that mix in that
174
+ module. For example:
175
+
176
+ module Ratable
177
+ def self.included(base)
178
+ if base.searchable?
179
+ base.searchable do
180
+ float :average_rating do
181
+ ratings.average(:value)
182
+ end
183
+ end
184
+ end
185
+ end
186
+ end
187
+
188
+ Note the use of <code>base.searchable?</code> - this ensures that only classes
189
+ that already have search enabled will have the additional configuration added.
190
+ The above pattern requires that the class be declared searchable before the
191
+ module is mixed in; other patterns (such as passing a :searchable option to an
192
+ acts_as_-style declaration) may be more flexible.
193
+
194
+ === Utility methods
195
+
196
+ If you need to completely reindex all of the instances of a given model class,
197
+ you can issue:
198
+
199
+ Post.reindex
200
+
201
+ If for some reason models get deleted from the database, but not from the index,
202
+ they will become index orphans - not a good situation. To get IDs that exist in
203
+ the index but not the database, you can use the +index_orphans+ method; to
204
+ remove those documents from the index, use +clean_index_orphans+. Note that
205
+ neither of these operations should be needed if Sunspot and Sunspot::Rails are
206
+ used as intended.
207
+
208
+ == Further Reading
209
+
210
+ Reading the {Sunspot documentation}[http://outoftime.github.com/sunspot/docs] is
211
+ highly recommended. Sunspot::Rails exists to wrap Sunspot with a Rails-friendly
212
+ API, but almost all of the functionality you use in Sunspot::Rails is
213
+ implemented in Sunspot.
214
+
215
+ Posts about Sunspot on my blog are available at http://outofti.me/tagged/sunspot
216
+
217
+ == Bugs
218
+
219
+ Please submit bug reports to
220
+ http://outoftime.lighthouseapp.com/projects/20339-sunspot
221
+
222
+ == Contributors
223
+
224
+ - Mat Brown (mat@patch.com)
225
+ - Peer Allan (peer.allan@gmail.com)
226
+ - Michael Moen (michael@underpantsgnome.com)
227
+ - Benjamin Krause (bk@benjaminkrause.com)
228
+ - Adam Salter (adam@codebright.net)
229
+ - Brandon Keepers (brandon@opensoul.org)
230
+
231
+ == License
232
+
233
+ 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,4 @@
1
+ ---
2
+ :minor: 10
3
+ :patch: 6
4
+ :major: 0
@@ -0,0 +1,29 @@
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', 'Adam Salter', 'Brandon Keepers']
11
+ s.rubyforge_project = 'sunspot'
12
+ s.files = FileList['[A-Z]*',
13
+ '{lib,tasks,dev_tasks}/**/*',
14
+ 'generators/**/*',
15
+ 'install.rb',
16
+ 'MIT-LICENSE',
17
+ 'rails/*',
18
+ 'spec/*.rb',
19
+ 'spec/mock_app/{app,lib,db,vendor,config}/**/*',
20
+ 'spec/mock_app/{tmp,log,solr}']
21
+ s.add_dependency 'rails', '~> 2.1'
22
+ s.add_dependency 'escape', '>= 0.0.4'
23
+ s.add_dependency 'outoftime-sunspot', '>= 0.8.2'
24
+ s.add_development_dependency 'rspec', '~> 1.2'
25
+ s.add_development_dependency 'rspec-rails', '~> 1.2'
26
+ s.add_development_dependency 'ruby-debug', '~> 0.10'
27
+ s.add_development_dependency 'technicalpickles-jeweler', '~> 1.0'
28
+ end
29
+ end
@@ -0,0 +1,7 @@
1
+ require 'rake/rdoctask'
2
+
3
+ Rake::RDocTask.new(:doc) do |rdoc|
4
+ rdoc.main = 'README.rdoc'
5
+ rdoc.rdoc_files.include('README.rdoc', 'lib/sunspot/rails/**/*.rb')
6
+ rdoc.rdoc_dir = 'doc'
7
+ end
@@ -0,0 +1,4 @@
1
+ namespace :release do
2
+ desc 'Release gem on RubyForge and GitHub'
3
+ task :all => [:release, :"rubyforge:release:gem"]
4
+ end
@@ -0,0 +1,4 @@
1
+ desc 'Show all TODO and related tags'
2
+ task :todo do
3
+ FileList['lib/**/*.rb'].egrep(/#.*(TODO|FIXME|XXX)/)
4
+ end
@@ -0,0 +1,9 @@
1
+ class SunspotGenerator < Rails::Generator::Base
2
+
3
+ def manifest
4
+ record do |m|
5
+ m.template 'sunspot.yml', 'config/sunspot.yml'
6
+ end
7
+ end
8
+
9
+ end
@@ -0,0 +1,19 @@
1
+ common: &common
2
+ solr:
3
+ hostname: localhost
4
+ port: 8983
5
+
6
+ production:
7
+ <<: *common
8
+ solr:
9
+ path: /solr/myindex
10
+
11
+ development:
12
+ <<: *common
13
+ solr:
14
+ port: 8982
15
+
16
+ test:
17
+ <<: *common
18
+ solr:
19
+ port: 8981
data/install.rb ADDED
@@ -0,0 +1 @@
1
+ # Install hook code here
@@ -0,0 +1,13 @@
1
+ require 'sunspot'
2
+
3
+ module Sunspot #:nodoc:
4
+ module Rails #:nodoc:
5
+ class <<self
6
+ attr_writer :configuration
7
+
8
+ def configuration
9
+ @configuration ||= Sunspot::Rails::Configuration.new
10
+ end
11
+ end
12
+ end
13
+ end
@@ -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