sunspot_rails_mongoid 1.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. data/History.txt +51 -0
  2. data/LICENSE +18 -0
  3. data/MIT-LICENSE +20 -0
  4. data/README.rdoc +260 -0
  5. data/Rakefile +18 -0
  6. data/TESTING.md +35 -0
  7. data/TODO +8 -0
  8. data/VERSION.yml +4 -0
  9. data/dev_tasks/rdoc.rake +24 -0
  10. data/dev_tasks/release.rake +4 -0
  11. data/dev_tasks/spec.rake +22 -0
  12. data/dev_tasks/todo.rake +4 -0
  13. data/generators/sunspot/sunspot_generator.rb +9 -0
  14. data/generators/sunspot/templates/sunspot.yml +18 -0
  15. data/install.rb +1 -0
  16. data/lib/generators/sunspot_rails.rb +9 -0
  17. data/lib/generators/sunspot_rails/install/install_generator.rb +13 -0
  18. data/lib/generators/sunspot_rails/install/templates/config/sunspot.yml +17 -0
  19. data/lib/sunspot/rails.rb +58 -0
  20. data/lib/sunspot/rails/adapters.rb +92 -0
  21. data/lib/sunspot/rails/configuration.rb +319 -0
  22. data/lib/sunspot/rails/init.rb +2 -0
  23. data/lib/sunspot/rails/railtie.rb +21 -0
  24. data/lib/sunspot/rails/request_lifecycle.rb +36 -0
  25. data/lib/sunspot/rails/searchable.rb +357 -0
  26. data/lib/sunspot/rails/server.rb +173 -0
  27. data/lib/sunspot/rails/solr_logging.rb +63 -0
  28. data/lib/sunspot/rails/spec_helper.rb +26 -0
  29. data/lib/sunspot/rails/stub_session_proxy.rb +88 -0
  30. data/lib/sunspot/rails/tasks.rb +50 -0
  31. data/lib/sunspot/rails/version.rb +5 -0
  32. data/lib/sunspot_rails_mongoid.rb +7 -0
  33. data/spec/configuration_spec.rb +173 -0
  34. data/spec/model_lifecycle_spec.rb +63 -0
  35. data/spec/model_spec.rb +329 -0
  36. data/spec/request_lifecycle_spec.rb +61 -0
  37. data/spec/schema.rb +27 -0
  38. data/spec/server_spec.rb +37 -0
  39. data/spec/session_spec.rb +24 -0
  40. data/spec/spec_helper.rb +45 -0
  41. data/spec/stub_session_proxy_spec.rb +122 -0
  42. metadata +191 -0
data/History.txt ADDED
@@ -0,0 +1,51 @@
1
+ == 1.2.0 2010-12-28
2
+ * Compatible with both Rails 2 and Rails 3
3
+ * Configure Sunspot with a SOLR_URL or WEBSOLR_URL environment variable, also
4
+ provide a default port based on Rails.env.
5
+ * Fix the 'Anonymous modules' ArgumentError for Ruby 1.9.2 and Rails 2.3
6
+ * Fix SQL's ambiguous ID issue when tables are joined
7
+
8
+ == 1.1.0 2010-04-01
9
+ * Added include option to searchable options to allow definition of eager
10
+ loading associations when indexing
11
+
12
+ == 1.0.4 2010-03-19
13
+ * Fix StubSessionProxy to match new internal API
14
+
15
+ == 1.0.2 2010-03-11
16
+ * Allow use of ActiveRecord object for coordinates extraction
17
+ * Works with non-standard primary keys
18
+ * Add :include, :select options to Searchable::search()
19
+ * Allow specification of min_memory and max_memory in config/sunspot.yml
20
+ * Searchable now more considerate of model namespaces
21
+
22
+ == 1.0.1 2010-03-05
23
+ * Fix Solr logging compatibility with RSolr 0.12.1
24
+
25
+ == 1.0.0 2010-03-03
26
+ * Sunspot::Rails::Server subclasses Sunspot::Server; no longer needs to shell out
27
+ * Use Sunspot built-in session proxies in Sunspot::Rails
28
+ * Sunspot::Rails adapter compatible with assumed inconsistency
29
+ * Use session proxy for disconnecting Sunspot in specs
30
+ * Allow specification of first ID for reindex batches.
31
+ * Log Solr requests in Rails logger
32
+ * Use class_inheritable_hash for sunspot_options
33
+ * Add `index` class method, which is like `reindex` but doesn't clear first
34
+ * Rename sunspot:solr:reindex to sunspot:reindex
35
+ * Use Sunspot::Installer to bootstrap Rails Solr home
36
+
37
+ == 0.10.7
38
+ * Added Sunspot::Rails::Server class to start/stop/run/bootstrap the solr server
39
+ * Added log_level key to sunspot.yml, see java docs for valid values (http://java.sun.com/j2se/1.5.0/docs/api/java/util/logging/Level.html)
40
+ * Added log_file key to sunspot.yml. This defaults to RAILS_ROOT/log/solr_<environment>.log.
41
+ * Added support for localsolr in sunspot_rails. You can add custom extension.jar files to your Rails.root/solr/lib directory
42
+ * Added an option to not reindex an object when certain columns have changed.
43
+
44
+ == 0.10.6
45
+ * Added script/generate sunspot support to generate the required sunspot.yml
46
+ file [Brandon Keepers]
47
+
48
+ == 0.10.5
49
+ * Added a auto_commit_after_request option to sunspot.yml. Sunspot will not
50
+ automatically commit any changes in solr if you set this value to false.
51
+ Strongly encouraged for production environment.
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,260 @@
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 Mongoid documents for easy index configuration, search, and indexing
9
+ * Automatically index Mongoid 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 (can be disabled)
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.3 and 3.0
18
+
19
+ == Installation in Rails 3
20
+
21
+ In your <code>Gemfile</code>:
22
+
23
+ gem 'sunspot_rails'
24
+
25
+ == Installation in Rails 2
26
+
27
+ In your project's <code>config/environment.rb</code>, add the following gem dependencies:
28
+
29
+ config.gem 'sunspot'
30
+ config.gem 'sunspot_rails'
31
+
32
+ Install the gems with:
33
+
34
+ rake gems:install
35
+
36
+ Generate the file <code>config/sunspot.yml</code>:
37
+
38
+ script/generate sunspot
39
+
40
+ Rails doesn't automatically load rake tasks from plugins installed as gems
41
+ (https://rails.lighthouseapp.com/projects/8994/tickets/59). If you installed
42
+ Sunspot::Rails as a gem, add the following line to your project's Rakefile:
43
+
44
+ require 'sunspot/rails/tasks'
45
+
46
+ == Using Sunspot::Rails
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 Mongoid model to be indexable and searchable, it must be
69
+ configured for search. For example:
70
+
71
+ class Post
72
+ include Sunspot::Rails::Mongoid
73
+ searchable do
74
+ text :title, :body
75
+ integer :blog_id
76
+ time :updated_at
77
+ string :sort_title do
78
+ title.downcase.sub(/^(an?|the) /, '')
79
+ end
80
+ end
81
+ end
82
+
83
+ See the documentation for Sunspot.setup for full details on what can go in the
84
+ configuration block.
85
+
86
+ === Indexing
87
+
88
+ By default, models are indexed whenever they are saved, and removed from the
89
+ index whenever they are destroyed. This behavior can be disabled:
90
+
91
+ class Post
92
+ include Sunspot::Rails::Mongoid
93
+ searchable :auto_index => false, :auto_remove => false do
94
+ # setup...
95
+ end
96
+ end
97
+
98
+ Note that <b>using the <code>:auto_remove</code> option is not recommended
99
+ </b>, as destroying an object without removing it from the index will
100
+ create an orphaned document in the index, which is a Bad Thing. Turning off
101
+ <code>:auto_index</code> is perfectly safe if you prefer to manage indexing manually
102
+ (perhaps using a background job).
103
+
104
+ If you have disabled lifecycle indexing hooks, you can invoke indexing
105
+ operations directly on your model:
106
+
107
+ post = Post.create
108
+ post.index
109
+ post.remove_from_index
110
+
111
+ === Committing
112
+
113
+ When data is changed in Solr, it is initially stored in memory and not made
114
+ available to the currently running searcher instance. Issuing a +commit+ to Solr
115
+ will cause it to write the changes to disk, and instantiate a new searcher
116
+ instance. This operation is fairly expensive, so rather than issuing a commit
117
+ every time a document is added or removed, Sunspot::Rails issues a commit at
118
+ the end of any request where data has been added to or removed from Solr. If
119
+ you need to immediately issue a commit, bang!-versions of the methods are
120
+ available:
121
+
122
+ post = Post.create
123
+ post.index!
124
+ # this is the same as...
125
+ post.index
126
+ Sunspot.commit
127
+
128
+ When writing tests outside of the context of a controller request, you will want
129
+ to use one of these two approaches.
130
+
131
+ === Searching
132
+
133
+ Do it like this:
134
+
135
+ Post.search do
136
+ with :blog_id, 1
137
+ with(:updated_at).greater_than(Time.now - 2.weeks)
138
+ order :sort_title, :asc
139
+ paginate :page => 1, :per_page => 15
140
+ end
141
+
142
+ See the documentation for <code>Sunspot.search</code> for all the options
143
+ available in the search block, and the information available in the result
144
+ block.
145
+
146
+ === Searching for IDs
147
+
148
+ In some situations, you may want to get the IDs for models returned by a search
149
+ without actually loading the models out of the database. For that, you can
150
+ call +search_ids+, using the same block format as #search. This will return an
151
+ array of IDs.
152
+
153
+
154
+ === Searching for multiple types
155
+
156
+ Sunspot is entirely agnostic about whether searches are for one or more types;
157
+ the only restriction is that columns used for restriction, ordering, etc. are
158
+ defined in the same way for all types being searched. Sunspot::Rails does not
159
+ provide any additional support for this, since there is not anything useful to
160
+ be added, so just use the interface provided by Sunspot:
161
+
162
+ Sunspot.search(Post, Comment) do
163
+ with :blog_id, 1
164
+ order :created_at, :asc
165
+ end
166
+
167
+ Be sure to check out the Sunspot documentation for all the details.
168
+
169
+ === Adding search functionality in mixins
170
+
171
+ Sunspot does not require that search setup for a given class happen all in one
172
+ place; it is perfectly acceptable to call the <code>Sunspot.setup</code> method
173
+ more than once. This capability is particularly useful for adding search
174
+ functionality in mixins. For instance, if you have a +Ratable+ module, you may
175
+ wish to add additional search fields for searchable classes that mix in that
176
+ module. For example:
177
+
178
+ module Ratable
179
+ def self.included(base)
180
+ if base.searchable?
181
+ base.searchable do
182
+ float :average_rating do
183
+ ratings.average(:value)
184
+ end
185
+ end
186
+ end
187
+ end
188
+ end
189
+
190
+ Note the use of <code>base.searchable?</code> - this ensures that only classes
191
+ that already have search enabled will have the additional configuration added.
192
+ The above pattern requires that the class be declared searchable before the
193
+ module is mixed in; other patterns (such as passing a :searchable option to an
194
+ acts_as_-style declaration) may be more flexible.
195
+
196
+ === Utility methods
197
+
198
+ If you need to completely reindex all of the instances of a given model class,
199
+ you can issue:
200
+
201
+ Post.reindex
202
+
203
+ If for some reason models get deleted from the database, but not from the index,
204
+ they will become index orphans - not a good situation. To get IDs that exist in
205
+ the index but not the database, you can use the +index_orphans+ method; to
206
+ remove those documents from the index, use +clean_index_orphans+. Note that
207
+ neither of these operations should be needed if Sunspot and Sunspot::Rails are
208
+ used as intended.
209
+
210
+
211
+ == Testing Solr integration using RSpec
212
+
213
+ To disable the sunspot-solr integration for your active record models, require
214
+ the file `sunspot/rails/spec_helper`
215
+
216
+ Then, in your spec, use the #disconnect_sunspot method:
217
+
218
+ require 'sunspot/rails/spec_helper'
219
+
220
+ describe Post do
221
+ disconnect_sunspot
222
+
223
+ it 'should have some behavior'
224
+ # ...
225
+ end
226
+ end
227
+
228
+ In all of the examples in this group, all Sunspot calls will be stubbed out. The
229
+ Sunspot#search method will return a stub search object that mimics a search with
230
+ no results.
231
+
232
+ == Further Reading
233
+
234
+ Reading the {Sunspot documentation}[http://outoftime.github.com/sunspot/docs] is
235
+ highly recommended. Sunspot::Rails exists to wrap Sunspot with a Rails-friendly
236
+ API, but almost all of the functionality you use in Sunspot::Rails is
237
+ implemented in Sunspot.
238
+
239
+ Posts about Sunspot on my blog are available at http://outofti.me/tagged/sunspot
240
+
241
+ == Bugs
242
+
243
+ Please submit bug reports to
244
+ http://outoftime.lighthouseapp.com/projects/20339-sunspot
245
+
246
+ == Contributors
247
+
248
+ - Mat Brown (mat@patch.com)
249
+ - Peer Allan (peer.allan@gmail.com)
250
+ - Michael Moen (michael@underpantsgnome.com)
251
+ - Benjamin Krause (bk@benjaminkrause.com)
252
+ - Adam Salter (adam@codebright.net)
253
+ - Brandon Keepers (brandon@opensoul.org)
254
+ - Paul Canavese (paul@canavese.org)
255
+ - John Eberly (jeberly@elctech.com)
256
+ - Gert Thiel (gertthiel@gmail.com)
257
+
258
+ == License
259
+
260
+ Sunspot::Rails is distributed under the MIT License, copyright (c) 2009 Mat Brown
data/Rakefile ADDED
@@ -0,0 +1,18 @@
1
+ require 'rake'
2
+ require 'rake/rdoctask'
3
+
4
+ if File.exist?(sunspot_lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'sunspot', 'lib')))
5
+ STDERR.puts("Using sunspot lib at #{sunspot_lib}")
6
+ $: << sunspot_lib
7
+ end
8
+
9
+ task :environment do
10
+ if ENV['SUNSPOT_LIB']
11
+ $: << ENV['SUNSPOT_LIB']
12
+ end
13
+ ENV['RAILS_ROOT'] ||= File.join(File.dirname(__FILE__), 'spec', 'rails3')
14
+ ENV['RAILS_ENV'] ||= 'test'
15
+ require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config', 'environment.rb'))
16
+ end
17
+
18
+ FileList['dev_tasks/*.rake', 'lib/sunspot/rails/tasks.rb'].each { |file| load(file) }
data/TESTING.md ADDED
@@ -0,0 +1,35 @@
1
+ # Testing `sunspot_rails`
2
+
3
+ Note: All the paths mentioned in here are relative to the current directory, or `sunspot/sunspot_rails`.
4
+
5
+ The `sunspot_rails` gem is tested with RSpec, and its spec suite is located in `spec`.
6
+
7
+ These specs are to be run against up to date Rails 2 and Rails 3 applications, included at `spec/rails2` and `spec/rails3`, respectively. The `spec_helper.rb` file loads the environment for these applications based on the `RAILS_ROOT` provided when invoking tests, outlined below.
8
+
9
+ ## Start Solr
10
+
11
+ Specs expect to connect to Solr on `http://localhost:8980/solr`
12
+
13
+ rake sunspot:solr:start
14
+
15
+ ## Install dependencies
16
+
17
+ Each application uses Bundler to manage its dependencies. The `Gemfile` also installs the `sunspot` and `sunspot_rails` gems from your copies checked out locally. Because Bundler expands the full path to `sunspot` and `sunspot_rails`, we're excluding its generated `Gemfile.lock` file from version control.
18
+
19
+ pushd spec/rails2
20
+ bundle install
21
+ cd ../rails3
22
+ bundle install
23
+ popd
24
+
25
+ ## Invoke specs
26
+
27
+ The project contains wrapper scripts that set up the environment to run the
28
+ specs under Rails 2 and Rails 3 respectively:
29
+
30
+ rake spec:rails2
31
+ rake spec:rails3
32
+
33
+ Or you can run them both:
34
+
35
+ rake spec
data/TODO ADDED
@@ -0,0 +1,8 @@
1
+ * Delegate new_search method
2
+ =======
3
+ * Fix final status output for reindex
4
+ * Add batch-per-request option
5
+ * Optionally yield from reindex
6
+ * Access to all searchable classes
7
+ * Add a method to disable sunspot updates for certain values, e.g.
8
+ if you just touch a record, sunspot shouldn't index the
data/VERSION.yml ADDED
@@ -0,0 +1,4 @@
1
+ ---
2
+ :patch: 4
3
+ :major: 0
4
+ :minor: 11
@@ -0,0 +1,24 @@
1
+ begin
2
+ require 'hanna/rdoctask'
3
+ rescue LoadError
4
+ if require 'rubygems'
5
+ retry
6
+ end
7
+ # It's OK if hanna isn't installed.
8
+ end
9
+
10
+ Rake::RDocTask.new(:doc) do |rdoc|
11
+ rdoc.main = 'README.rdoc'
12
+ rdoc.rdoc_files.include('README.rdoc', 'lib/sunspot/rails/**/*.rb', 'lib/sunspot/rails.rb')
13
+ rdoc.rdoc_dir = 'doc'
14
+ end
15
+
16
+ namespace :doc do
17
+ desc 'Generate rdoc and move into pages directory'
18
+ task :publish => :redoc do
19
+ doc_dir = File.join(File.dirname(__FILE__), '..', 'doc')
20
+ publish_dir = File.join(File.dirname(__FILE__), '..', '..', 'pages', 'rails', 'docs')
21
+ FileUtils.rm_rf(publish_dir) if File.exist?(publish_dir)
22
+ FileUtils.cp_r(doc_dir, publish_dir)
23
+ end
24
+ end