gojee-sunspot 2.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (176) hide show
  1. data/.gitignore +12 -0
  2. data/Gemfile +5 -0
  3. data/History.txt +252 -0
  4. data/LICENSE +18 -0
  5. data/Rakefile +13 -0
  6. data/TODO +13 -0
  7. data/lib/light_config.rb +40 -0
  8. data/lib/sunspot.rb +579 -0
  9. data/lib/sunspot/adapters.rb +265 -0
  10. data/lib/sunspot/batcher.rb +62 -0
  11. data/lib/sunspot/class_set.rb +23 -0
  12. data/lib/sunspot/composite_setup.rb +202 -0
  13. data/lib/sunspot/configuration.rb +53 -0
  14. data/lib/sunspot/data_extractor.rb +50 -0
  15. data/lib/sunspot/dsl.rb +5 -0
  16. data/lib/sunspot/dsl/adjustable.rb +47 -0
  17. data/lib/sunspot/dsl/field_group.rb +57 -0
  18. data/lib/sunspot/dsl/field_query.rb +327 -0
  19. data/lib/sunspot/dsl/fields.rb +103 -0
  20. data/lib/sunspot/dsl/fulltext.rb +243 -0
  21. data/lib/sunspot/dsl/function.rb +27 -0
  22. data/lib/sunspot/dsl/functional.rb +44 -0
  23. data/lib/sunspot/dsl/more_like_this_query.rb +56 -0
  24. data/lib/sunspot/dsl/paginatable.rb +32 -0
  25. data/lib/sunspot/dsl/query_facet.rb +36 -0
  26. data/lib/sunspot/dsl/restriction.rb +25 -0
  27. data/lib/sunspot/dsl/restriction_with_near.rb +160 -0
  28. data/lib/sunspot/dsl/scope.rb +217 -0
  29. data/lib/sunspot/dsl/search.rb +30 -0
  30. data/lib/sunspot/dsl/standard_query.rb +123 -0
  31. data/lib/sunspot/field.rb +193 -0
  32. data/lib/sunspot/field_factory.rb +129 -0
  33. data/lib/sunspot/indexer.rb +136 -0
  34. data/lib/sunspot/query.rb +11 -0
  35. data/lib/sunspot/query/abstract_field_facet.rb +52 -0
  36. data/lib/sunspot/query/bbox.rb +15 -0
  37. data/lib/sunspot/query/boost_query.rb +24 -0
  38. data/lib/sunspot/query/common_query.rb +96 -0
  39. data/lib/sunspot/query/composite_fulltext.rb +36 -0
  40. data/lib/sunspot/query/connective.rb +206 -0
  41. data/lib/sunspot/query/date_field_facet.rb +14 -0
  42. data/lib/sunspot/query/dismax.rb +132 -0
  43. data/lib/sunspot/query/field_facet.rb +41 -0
  44. data/lib/sunspot/query/field_group.rb +36 -0
  45. data/lib/sunspot/query/filter.rb +38 -0
  46. data/lib/sunspot/query/function_query.rb +52 -0
  47. data/lib/sunspot/query/geo.rb +53 -0
  48. data/lib/sunspot/query/geofilt.rb +16 -0
  49. data/lib/sunspot/query/highlighting.rb +62 -0
  50. data/lib/sunspot/query/more_like_this.rb +61 -0
  51. data/lib/sunspot/query/more_like_this_query.rb +12 -0
  52. data/lib/sunspot/query/pagination.rb +42 -0
  53. data/lib/sunspot/query/query_facet.rb +16 -0
  54. data/lib/sunspot/query/restriction.rb +262 -0
  55. data/lib/sunspot/query/scope.rb +9 -0
  56. data/lib/sunspot/query/sort.rb +109 -0
  57. data/lib/sunspot/query/sort_composite.rb +34 -0
  58. data/lib/sunspot/query/standard_query.rb +16 -0
  59. data/lib/sunspot/query/text_field_boost.rb +17 -0
  60. data/lib/sunspot/schema.rb +151 -0
  61. data/lib/sunspot/search.rb +9 -0
  62. data/lib/sunspot/search/abstract_search.rb +281 -0
  63. data/lib/sunspot/search/date_facet.rb +35 -0
  64. data/lib/sunspot/search/facet_row.rb +27 -0
  65. data/lib/sunspot/search/field_facet.rb +88 -0
  66. data/lib/sunspot/search/field_group.rb +32 -0
  67. data/lib/sunspot/search/group.rb +50 -0
  68. data/lib/sunspot/search/highlight.rb +38 -0
  69. data/lib/sunspot/search/hit.rb +150 -0
  70. data/lib/sunspot/search/hit_enumerable.rb +72 -0
  71. data/lib/sunspot/search/more_like_this_search.rb +31 -0
  72. data/lib/sunspot/search/paginated_collection.rb +57 -0
  73. data/lib/sunspot/search/query_facet.rb +67 -0
  74. data/lib/sunspot/search/standard_search.rb +21 -0
  75. data/lib/sunspot/session.rb +262 -0
  76. data/lib/sunspot/session_proxy.rb +95 -0
  77. data/lib/sunspot/session_proxy/abstract_session_proxy.rb +29 -0
  78. data/lib/sunspot/session_proxy/class_sharding_session_proxy.rb +66 -0
  79. data/lib/sunspot/session_proxy/id_sharding_session_proxy.rb +89 -0
  80. data/lib/sunspot/session_proxy/master_slave_session_proxy.rb +43 -0
  81. data/lib/sunspot/session_proxy/multicore_session_proxy.rb +67 -0
  82. data/lib/sunspot/session_proxy/sharding_session_proxy.rb +222 -0
  83. data/lib/sunspot/session_proxy/silent_fail_session_proxy.rb +42 -0
  84. data/lib/sunspot/session_proxy/thread_local_session_proxy.rb +37 -0
  85. data/lib/sunspot/setup.rb +350 -0
  86. data/lib/sunspot/text_field_setup.rb +29 -0
  87. data/lib/sunspot/type.rb +393 -0
  88. data/lib/sunspot/util.rb +252 -0
  89. data/lib/sunspot/version.rb +3 -0
  90. data/script/console +10 -0
  91. data/spec/api/adapters_spec.rb +33 -0
  92. data/spec/api/batcher_spec.rb +112 -0
  93. data/spec/api/binding_spec.rb +50 -0
  94. data/spec/api/class_set_spec.rb +24 -0
  95. data/spec/api/hit_enumerable_spec.rb +47 -0
  96. data/spec/api/indexer/attributes_spec.rb +149 -0
  97. data/spec/api/indexer/batch_spec.rb +72 -0
  98. data/spec/api/indexer/dynamic_fields_spec.rb +42 -0
  99. data/spec/api/indexer/fixed_fields_spec.rb +57 -0
  100. data/spec/api/indexer/fulltext_spec.rb +43 -0
  101. data/spec/api/indexer/removal_spec.rb +53 -0
  102. data/spec/api/indexer/spec_helper.rb +1 -0
  103. data/spec/api/indexer_spec.rb +14 -0
  104. data/spec/api/query/advanced_manipulation_examples.rb +35 -0
  105. data/spec/api/query/connectives_examples.rb +189 -0
  106. data/spec/api/query/dsl_spec.rb +18 -0
  107. data/spec/api/query/dynamic_fields_examples.rb +165 -0
  108. data/spec/api/query/faceting_examples.rb +397 -0
  109. data/spec/api/query/fulltext_examples.rb +313 -0
  110. data/spec/api/query/function_spec.rb +79 -0
  111. data/spec/api/query/geo_examples.rb +68 -0
  112. data/spec/api/query/group_spec.rb +32 -0
  113. data/spec/api/query/highlighting_examples.rb +245 -0
  114. data/spec/api/query/more_like_this_spec.rb +140 -0
  115. data/spec/api/query/ordering_pagination_examples.rb +116 -0
  116. data/spec/api/query/scope_examples.rb +275 -0
  117. data/spec/api/query/spatial_examples.rb +27 -0
  118. data/spec/api/query/spec_helper.rb +1 -0
  119. data/spec/api/query/standard_spec.rb +29 -0
  120. data/spec/api/query/text_field_scoping_examples.rb +30 -0
  121. data/spec/api/query/types_spec.rb +20 -0
  122. data/spec/api/search/dynamic_fields_spec.rb +33 -0
  123. data/spec/api/search/faceting_spec.rb +360 -0
  124. data/spec/api/search/highlighting_spec.rb +69 -0
  125. data/spec/api/search/hits_spec.rb +131 -0
  126. data/spec/api/search/paginated_collection_spec.rb +36 -0
  127. data/spec/api/search/results_spec.rb +72 -0
  128. data/spec/api/search/search_spec.rb +23 -0
  129. data/spec/api/search/spec_helper.rb +1 -0
  130. data/spec/api/session_proxy/class_sharding_session_proxy_spec.rb +85 -0
  131. data/spec/api/session_proxy/id_sharding_session_proxy_spec.rb +30 -0
  132. data/spec/api/session_proxy/master_slave_session_proxy_spec.rb +41 -0
  133. data/spec/api/session_proxy/sharding_session_proxy_spec.rb +77 -0
  134. data/spec/api/session_proxy/silent_fail_session_proxy_spec.rb +24 -0
  135. data/spec/api/session_proxy/spec_helper.rb +9 -0
  136. data/spec/api/session_proxy/thread_local_session_proxy_spec.rb +39 -0
  137. data/spec/api/session_spec.rb +232 -0
  138. data/spec/api/spec_helper.rb +3 -0
  139. data/spec/api/sunspot_spec.rb +29 -0
  140. data/spec/ext.rb +11 -0
  141. data/spec/helpers/indexer_helper.rb +17 -0
  142. data/spec/helpers/integration_helper.rb +8 -0
  143. data/spec/helpers/mock_session_helper.rb +13 -0
  144. data/spec/helpers/query_helper.rb +26 -0
  145. data/spec/helpers/search_helper.rb +68 -0
  146. data/spec/integration/dynamic_fields_spec.rb +57 -0
  147. data/spec/integration/faceting_spec.rb +251 -0
  148. data/spec/integration/field_grouping_spec.rb +66 -0
  149. data/spec/integration/geospatial_spec.rb +85 -0
  150. data/spec/integration/highlighting_spec.rb +44 -0
  151. data/spec/integration/indexing_spec.rb +55 -0
  152. data/spec/integration/keyword_search_spec.rb +317 -0
  153. data/spec/integration/local_search_spec.rb +64 -0
  154. data/spec/integration/more_like_this_spec.rb +43 -0
  155. data/spec/integration/scoped_search_spec.rb +354 -0
  156. data/spec/integration/stored_fields_spec.rb +12 -0
  157. data/spec/integration/test_pagination.rb +43 -0
  158. data/spec/integration/unicode_spec.rb +15 -0
  159. data/spec/mocks/adapters.rb +32 -0
  160. data/spec/mocks/blog.rb +3 -0
  161. data/spec/mocks/comment.rb +21 -0
  162. data/spec/mocks/connection.rb +126 -0
  163. data/spec/mocks/mock_adapter.rb +30 -0
  164. data/spec/mocks/mock_class_sharding_session_proxy.rb +24 -0
  165. data/spec/mocks/mock_record.rb +52 -0
  166. data/spec/mocks/mock_sharding_session_proxy.rb +15 -0
  167. data/spec/mocks/photo.rb +11 -0
  168. data/spec/mocks/post.rb +86 -0
  169. data/spec/mocks/super_class.rb +2 -0
  170. data/spec/mocks/user.rb +13 -0
  171. data/spec/spec_helper.rb +40 -0
  172. data/sunspot.gemspec +42 -0
  173. data/tasks/rdoc.rake +27 -0
  174. data/tasks/schema.rake +19 -0
  175. data/tasks/todo.rake +4 -0
  176. metadata +409 -0
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ sunspot-solr.pid
2
+ *.swp
3
+ coverage
4
+ pkg
5
+ /doc
6
+ .DS_Store
7
+
8
+ .yardoc
9
+ README.rdoc
10
+ .bundle
11
+ Gemfile.lock
12
+ *un~
data/Gemfile ADDED
@@ -0,0 +1,5 @@
1
+ source "http://rubygems.org"
2
+
3
+ gem 'sunspot_solr', :path => File.expand_path('../../sunspot_solr', __FILE__)
4
+
5
+ gemspec
data/History.txt ADDED
@@ -0,0 +1,252 @@
1
+ == 2.0.0
2
+ * Adds support for field grouping (Andy Lindeman)
3
+ * Adds support for native geospatial searches and ordering (Eric Tang, Bruno Miranda, Andy Lindeman)
4
+ * Bundled Solr installation (`sunspot_solr`) is version 3.5.0 (Chris Parker)
5
+ * Adds #query_time method to retrieve the Solr query time in
6
+ milliseconds (Jason Weathered)
7
+ * Fixes syntax of highlighting when used with nested dismax queries (Marco Crepaldi)
8
+ * Adds ability to nest `Sunspot.batch` calls (Thorbjørn Hermansen)
9
+ * Adds `open_timeout` and `read_timeout` configuration options (Rob Di
10
+ Marco)
11
+
12
+ == 1.3.0 2011-11-26
13
+ * Requests to Solr use HTTP POST verb by default to avoid issues when the query string grows too large for GET (Johan Van Ryseghem)
14
+ * `sunspot.yml` supports ERB (Andrew Cholakian)
15
+ * An error is raised when attempting to run the packaged Solr if Java is not available (Lucas Parry)
16
+ * Pagination operates correctly without dependency on `will_paginate` (Larry Sprock, Dave Krupinski)
17
+ * Stored boolean fields with `false` value are returned correctly (yipdw)
18
+ * `highlight` accepts `:formatter` and `:fragmenter` parameters (Jeremy McNevin)
19
+ * Default `headerBufferSize` is increased for packaged Solr make sure the limit is not reached during large queries (gjb83)
20
+ * Packaged Solr respects the `data_path` configuration setting from `sunspot.yml` (djmaze)
21
+ * Packaged Solr correctly uses the `pid_dir` configuration option from `sunspot.yml` (Russen Guggemos)
22
+ * Specs run correctly in 1.9.2 (Larry Sprock)
23
+ * Documentation improvements (Thibaut Barrère, gjb83, Breno Santos Salgado)
24
+ * Adds :offset option to paginate method (Benjamin Fleischer)
25
+ * Requires rsolr 1.0.6, which fixes issues with Unicode characters
26
+ returned by Solr
27
+
28
+ == 1.2.1 2010-12-28
29
+ * Decreased default reindexing batch size from 500 to 50
30
+
31
+ == 1.2.0 2010-12-28
32
+ * Replace solr-spatial-light with client-side geohash-based spatial search
33
+ * Override Solr field naming conventions using :as option
34
+ * Delegate #id method directly to calling context inside DSL
35
+ * Create a SilentFailSessionProxy that rescues exceptions on write operations.
36
+ * Inclusion by identity
37
+ * Solr optimize command
38
+ * Ignore negative :limit option for query facets
39
+ * Eliminated value sorting for range scopes
40
+ * Correctly cast stored boolean values if they are booleans
41
+ * Correctly cast and return stored values for multi-valued fields
42
+
43
+ == 1.1.0 2010-04-01
44
+ * MoreLikeThis support
45
+ * Allow multiple fulltext queries in one search
46
+ * Function queries
47
+ * Update solr-spatial-light to 0.0.6 build
48
+ * Support for :prefix when faceting.
49
+ * Allow specification of solr jar
50
+ * Updated reindex task to allow setting of batch size and list of models to index
51
+ * Use a '*:*' query for deleting the entire index
52
+ * Ability to specify custom request handler for queries
53
+ * Gracefully handle nonexistent search result
54
+
55
+ == 1.0.4 2010-03-19
56
+ * Update solr-spatial-light to 0.0.5
57
+ * Fix NullPointerException in repeated geo search
58
+ * Fix missing distances in repeated geo search
59
+ * Don't query the data store more than once when results are missing
60
+
61
+ == 1.0.2 2010-03-11
62
+ * Restore Hit#distance for result geo distance
63
+ * Remove :distance special sort
64
+ * Quote reserved keywords in boolean queries
65
+ * Add Search#facets accessor to retrieve all facets
66
+
67
+ == 1.0.1 2010-03-05
68
+ * Copy all needed config files when sunspot-installer run with force option
69
+
70
+ == 1.0.0 2010-03-03
71
+ * Multiselect Field Faceting
72
+ * Named field facets
73
+ * Upgrade to Solr 1.4
74
+ * Deletion by query
75
+ * Allow :latitude and :longitude as coordinate method names
76
+ * Assumed inconsistency
77
+ * Support for TrieField numeric/time types
78
+ * Built-in Session Proxies: Thread-local, master/slave, sharding
79
+ * Give DSL blocks access to calling context
80
+ * Create sunspot-installer executable, which modifies an existing
81
+ schema/solrconfig to work with Sunspot
82
+ * Support for Long and Double types
83
+ * new_search method accepts DSL block
84
+ * Sunspot::Server now a real class that manages embedded Sunspot instance
85
+ * Add Search#each_hit_with_result method
86
+ * Able to access stored dynamic fields
87
+ * Access dynamic facets using the #facet method
88
+ * Remove accidental existence of dynamic_text fields
89
+ * Upgrade to RSolr 0.12.1
90
+ * Switch from LocalSolr to solr-spatial-light
91
+ * Turn off request logging in Jetty for default Solr install
92
+ * Full support for class-reloading of Sunspot-setup classes
93
+ * Support time ranges outside of 32-bit range
94
+ * Remove sunspot-configure-solr executable
95
+ * new_search method accepts DSL block
96
+
97
+ == 0.10.8 2009-11-24
98
+ * Strictly enforce RSolr 0.9.6 gem dependency (newer ones broken)
99
+
100
+ == 0.10.7 2009-11-16
101
+ * Ignore boost_fields that don't apply
102
+ * Ability to specify text_fields inside connectives
103
+ * Fix bug with newlines in strings incorrectly being considered multi-value
104
+ * Compatibility with RSolr 0.10.1
105
+ * Remove commented-out code entirely
106
+
107
+ == 0.10.6 2009-11-05
108
+ * Support more dismax parameters
109
+ * Support multiple boost queries
110
+ * Allow "extra" facet rows
111
+ * Allow exclusion of fulltext fields
112
+ * Allow specification of per-field highlighting params
113
+ * Specify coordinates using block extraction
114
+ * Return empty array if no highlights available
115
+ * Get stored text fields from hits
116
+ * Update docs to reflect a requirement of at least one search type
117
+ * added --max-memory and --min-memory parameters to sunspot-solr
118
+ * LocalLucene and LocalSolr compatible with Java 1.5
119
+
120
+ == 0.10.5 2009-10-22
121
+ * Fix highlighting for multiple-model search
122
+
123
+ == 0.10.4 2009-10-20
124
+ * Add adjust_params method, allowing experts to manually edit Solr params
125
+ * Track adds and deletes separately in session, and expose delete_dirty? method
126
+ * Allow clients to inject a singleton session proxy
127
+
128
+ == 0.10.3 2009-10-15
129
+ * Contiguous, not continuous
130
+ * Fail fast if less-than-1 radius passed for local search
131
+
132
+ == 0.10.2 2009-10-09
133
+ * Add Sunspot.config.xml_builder option, which is passed to RSolr
134
+
135
+ == 0.10.1 2009-10-08
136
+ * Fix directory bugs in sunspot-solr executable
137
+
138
+ == 0.10.0 2009-10-08
139
+ * Support for geographical search using LocalSolr
140
+ * Support for keyword highlighting, with custom deferred formatting
141
+ * New fulltext DSL for specifying advanced dismax options
142
+ * Support boost queries
143
+ * Support for search-time field boost
144
+ * Support for phrase fields
145
+ * Support for prefix queries
146
+ * Set default search-time field boost in setup
147
+ * Restrict field facet to a set of desired values
148
+ * Query facets support all facet options
149
+ * Allow scoping by text fields
150
+ * Support executing searches repeatedly
151
+ * Allow setting of Solr URL for integration tests in environment variable
152
+ * Add support for master/slave configurations
153
+ * Added logging options to sunspot-solr executable
154
+ * Added default solr config file location to Sunspot::Configuration
155
+ * Informative, non-firehose Search#inspect
156
+ * No longer require arguments to #paginate
157
+ * Silently ignore keyword calls with nil/blank/whitespace keywords
158
+ * Don't require that all searched types have a referenced field
159
+ * Correct backwards ranges
160
+ * Raise descriptive error if no types passed to search
161
+ * Handle empty query facets, query facet rows, and connectives
162
+ * Quote values in range restrictions if they contain spaces
163
+ * Fix bug in Sunspot::Util.full_const_get
164
+ * Remove support for :other option in time faceting
165
+ * Remove order_by_random() method
166
+ * Removed options and Query from public API
167
+ * Use built-in optparse instead of optiflag in bin/sunspot-solr
168
+ * Remove dependency on haml and use erb since it is only used to generate one file
169
+
170
+ == 0.9.0 2009-07-21
171
+ * Use Dismax parser for keyword search
172
+ * Field and document boosting
173
+ * Specify which fields to search in keyword search
174
+ * Allow indexing of multiple values in text fields
175
+ * Access keyword relevance score in Hit objects
176
+ * Allow stored fields, retrieve stored values from Hit objects
177
+ * Support more values in shorthand restrictions
178
+ * Disjunctions and conjunctions
179
+ * Random ordering
180
+ * Control all options for field facets
181
+ * Time range facets
182
+ * Get referenced objects from facets on foreign keys
183
+ * Facet by class
184
+ * Batch indexing
185
+ * New Date field type
186
+ * Direct access to data accessors
187
+ * Executable to configure production Solr instances
188
+ * Replace solr-ruby with RSolr
189
+ * Remove accidental ActiveSupport dependency
190
+
191
+ == 0.8.9 2009-06-23
192
+ * Fix OrderedHash bug in older versions of ActiveSupport
193
+
194
+ == 0.8.8 2009-06-15
195
+ * Escape type names to support namespaced classes
196
+ * Fix bug with anonymous modules in Ruby 1.9
197
+
198
+ == 0.8.7 2009-06-10
199
+ * Add --pid-dir option for sunspot-solr executable
200
+
201
+ == 0.8.5 2009-06-09
202
+ * Added dependencies for sunspot-solr executable to gem dependencies
203
+ * Search for adapters using class ancestors rather than superclasses
204
+
205
+ == 0.8.3 2009-06-03
206
+ * Index objects passed as a collection in a single HTTP request
207
+
208
+ == 0.8.2 2009-05-27
209
+ * Allow specification of Solr home when using sunspot-solr
210
+
211
+ == 0.8.1 2009-05-26
212
+ * Add Search#execute! to public API
213
+
214
+ == 0.8.0 2009-05-22
215
+ * Access query API directly; instantiate search without running it
216
+ * Dynamic fields
217
+ * Search blocks can be evaluated in calling context
218
+
219
+ == 0.7.3 2009-05-06
220
+ * Better exception handling when class doesn't have adapter/setup
221
+
222
+ == 0.7.2 2009-04-29
223
+ * Dirty sessions
224
+
225
+ == 0.7.1 2009-04-29
226
+ * Removed extlib dependency from gemspec
227
+
228
+ == 0.7.0 2009-04-28
229
+ * Less magic in the DSL
230
+ * Restrict by empty values
231
+ * Negative scoping using without() method
232
+ * Exclusion by object identity using without(instance)
233
+ * Support for faceting
234
+ * Explicit commits
235
+ * Boolean field type
236
+ * Attribute field flexibility
237
+ * Virtual field blocks can be evaluated in calling context
238
+ * Order available by multiple fields
239
+ * New adapter API
240
+ * Got rid of builder API
241
+ * Full documentation
242
+
243
+ == 0.0.2 2009-02-14
244
+ * Run sunspot's built-in Solr instance using
245
+ sunspot-solr executable
246
+ * Search hash interpretation delegated to
247
+ Builder object
248
+
249
+ == 0.0.1 2008-12-11
250
+ * Initial release
251
+ * Define indexing for any class using DSL
252
+ * Search indexed classes using DSL
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/Rakefile ADDED
@@ -0,0 +1,13 @@
1
+ # encoding: UTF-8
2
+
3
+ require 'rspec/core/rake_task'
4
+
5
+ Dir['tasks/**/*.rake'].each { |t| load t }
6
+
7
+ desc "Run all examples"
8
+ RSpec::Core::RakeTask.new(:spec) do |t|
9
+ t.rspec_opts = '--format documentation'
10
+ t.ruby_opts = "-W1"
11
+ end
12
+
13
+ task :default => :spec
data/TODO ADDED
@@ -0,0 +1,13 @@
1
+ === Sunspot 1.1.x ===
2
+ * commitWithin (needs support from RSolr, currently available in master)
3
+ * commit options (non-blocking, etc.)
4
+
5
+ === Someday ===
6
+ * Shorthand arguments to Sunspot#search
7
+ * Rudimentary fulltext prefixing support
8
+
9
+ === Solr 1.5 ===
10
+ * Field Collapsing (SOLR-236)
11
+ * Support for official spatial support (SOLR-773)
12
+ * Support sorting by function
13
+ * Support string constants in functions
@@ -0,0 +1,40 @@
1
+ module LightConfig
2
+ class Configuration
3
+ def initialize(&block)
4
+ @properties = {}
5
+ ::LightConfig::Builder.new(self).instance_eval(&block)
6
+ singleton = (class <<self; self; end)
7
+ @properties.keys.each do |property|
8
+ singleton.module_eval do
9
+ define_method property do
10
+ @properties[property]
11
+ end
12
+
13
+ define_method "#{property}=" do |value|
14
+ @properties[property] = value
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
20
+
21
+ class Builder
22
+ def initialize(configuration)
23
+ @configuration = configuration
24
+ end
25
+
26
+ def method_missing(method, *args, &block)
27
+ raise ArgumentError("wrong number of arguments(#{args.length} for 1)") unless args.length < 2
28
+ value = if block then ::LightConfig::Configuration.new(&block)
29
+ else args.first
30
+ end
31
+ @configuration.instance_variable_get(:@properties)[method] = value
32
+ end
33
+ end
34
+
35
+ class <<self
36
+ def build(&block)
37
+ LightConfig::Configuration.new(&block)
38
+ end
39
+ end
40
+ end
data/lib/sunspot.rb ADDED
@@ -0,0 +1,579 @@
1
+ require 'set'
2
+ require 'time'
3
+ require 'date'
4
+ require 'enumerator'
5
+ require 'cgi'
6
+ begin
7
+ require 'rsolr'
8
+ rescue LoadError
9
+ require 'rubygems'
10
+ require 'rsolr'
11
+ end
12
+
13
+ require File.join(File.dirname(__FILE__), 'light_config')
14
+
15
+ %w(util adapters configuration setup composite_setup text_field_setup field
16
+ field_factory data_extractor indexer query search session session_proxy
17
+ type dsl class_set).each do |filename|
18
+ require File.join(File.dirname(__FILE__), 'sunspot', filename)
19
+ end
20
+
21
+ #
22
+ # The Sunspot module provides class-method entry points to most of the
23
+ # functionality provided by the Sunspot library. Internally, the Sunspot
24
+ # singleton class contains a (non-thread-safe!) instance of Sunspot::Session,
25
+ # to which it delegates most of the class methods it exposes. In the method
26
+ # documentation below, this instance is referred to as the "singleton session".
27
+ #
28
+ # Though the singleton session provides a convenient entry point to Sunspot,
29
+ # it is by no means required to use the Sunspot class methods. Multiple sessions
30
+ # may be instantiated and used (if you need to connect to multiple Solr
31
+ # instances, for example.)
32
+ #
33
+ # Note that the configuration of classes for index/search (the +setup+
34
+ # method) is _not_ session-specific, but rather global.
35
+ #
36
+ module Sunspot
37
+ UnrecognizedFieldError = Class.new(StandardError)
38
+ UnrecognizedRestrictionError = Class.new(StandardError)
39
+ NoAdapterError = Class.new(StandardError)
40
+ NoSetupError = Class.new(StandardError)
41
+ IllegalSearchError = Class.new(StandardError)
42
+ NotImplementedError = Class.new(StandardError)
43
+
44
+ autoload :Installer, File.join(File.dirname(__FILE__), 'sunspot', 'installer')
45
+
46
+ # Array to track classes that have been set up for searching.
47
+ # Used by, e.g., Sunspot::Rails for reindexing all searchable classes.
48
+ @searchable = ClassSet.new
49
+
50
+ class <<self
51
+ #
52
+ # Clients can inject a session proxy, allowing them to implement custom
53
+ # session-management logic while retaining the Sunspot singleton API as
54
+ # an available interface. The object assigned to this attribute must
55
+ # respond to all of the public methods of the Sunspot::Session class.
56
+ #
57
+ attr_writer :session
58
+
59
+ #
60
+ # Access the list of classes set up to be searched.
61
+ #
62
+ attr_reader :searchable
63
+
64
+ # Configures indexing and search for a given class.
65
+ #
66
+ # ==== Parameters
67
+ #
68
+ # clazz<Class>:: class to configure
69
+ #
70
+ # ==== Example
71
+ #
72
+ # Sunspot.setup(Post) do
73
+ # text :title, :body
74
+ # string :author_name
75
+ # integer :blog_id
76
+ # integer :category_ids
77
+ # float :average_rating, :using => :ratings_average
78
+ # time :published_at
79
+ # string :sort_title do
80
+ # title.downcase.sub(/^(an?|the)\W+/, ''/) if title = self.title
81
+ # end
82
+ # end
83
+ #
84
+ # ====== Attribute Fields vs. Virtual Fields
85
+ #
86
+ # Attribute fields call a method on the indexed object and index the
87
+ # return value. All of the fields defined above except for the last one are
88
+ # attribute fields. By default, the field name will also be the attribute
89
+ # used; this can be overriden with the +:using+ option, as in
90
+ # +:average_rating+ above. In that case, the attribute +:ratings_average+
91
+ # will be indexed with the field name +:average_rating+.
92
+ #
93
+ # +:sort_title+ is a virtual field, which evaluates the block inside the
94
+ # context of the instance being indexed, and indexes the value returned
95
+ # by the block. If the block you pass takes an argument, it will be passed
96
+ # the instance rather than being evaluated inside of it; so, the following
97
+ # example is equivalent to the one above (assuming #title is public):
98
+ #
99
+ # Sunspot.setup(Post) do
100
+ # string :sort_title do |post|
101
+ # post.title.downcase.sub(/^(an?|the)\W+/, ''/) if title = self.title
102
+ # end
103
+ # end
104
+ #
105
+ # ===== Field Types
106
+ #
107
+ # The available types are:
108
+ #
109
+ # * +text+
110
+ # * +string+
111
+ # * +integer+
112
+ # * +float+
113
+ # * +time+
114
+ # * +boolean+
115
+ #
116
+ # Note that the +text+ type behaves quite differently from the others -
117
+ # this is the type that is indexed as fulltext, and is searched using the
118
+ # +keywords+ method inside the search DSL. Text fields cannot have
119
+ # restrictions set on them, nor can they be used in order statements or
120
+ # for facets. All other types are indexed literally, and thus can be used
121
+ # for all of those operations. They will not, however, be searched in
122
+ # fulltext. In this way, Sunspot provides a complete barrier between
123
+ # fulltext fields and value fields.
124
+ #
125
+ # It is fine to specify a field both as a text field and a string field;
126
+ # internally, the fields will have different names so there is no danger
127
+ # of conflict.
128
+ #
129
+ # ===== Dynamic Fields
130
+ #
131
+ # For use cases which have highly dynamic data models (for instance, an
132
+ # open set of key-value pairs attached to a model), it may be useful to
133
+ # defer definition of fields until indexing time. Sunspot exposes dynamic
134
+ # fields, which define a data accessor (either attribute or virtual, see
135
+ # above), which accepts a hash of field names to values. Note that the field
136
+ # names in the hash are internally scoped to the base name of the dynamic
137
+ # field, so any time they are referred to, they are referred to using both
138
+ # the base name and the dynamic (runtime-specified) name.
139
+ #
140
+ # Dynamic fields are speficied in the setup block using the type name
141
+ # prefixed by +dynamic_+. For example:
142
+ #
143
+ # Sunspot.setup(Post) do
144
+ # dynamic_string :custom_values do
145
+ # key_value_pairs.inject({}) do |hash, key_value_pair|
146
+ # hash[key_value_pair.key.to_sym] = key_value_pair.value
147
+ # end
148
+ # end
149
+ # end
150
+ #
151
+ # If you later wanted to facet all of the values for the key "cuisine",
152
+ # you could issue:
153
+ #
154
+ # Sunspot.search(Post) do
155
+ # dynamic :custom_values do
156
+ # facet :cuisine
157
+ # end
158
+ # end
159
+ #
160
+ # In the documentation, +:custom_values+ is referred to as the "base name" -
161
+ # that is, the one specified statically - and +:cuisine+ is referred to as
162
+ # the dynamic name, which is the part that is specified at indexing time.
163
+ #
164
+ def setup(clazz, &block)
165
+ Sunspot.searchable << clazz
166
+ Setup.setup(clazz, &block)
167
+ end
168
+
169
+ # Indexes objects on the singleton session.
170
+ #
171
+ # ==== Parameters
172
+ #
173
+ # objects...<Object>:: objects to index (may pass an array or varargs)
174
+ #
175
+ # ==== Example
176
+ #
177
+ # post1, post2 = new Array(2) { Post.create }
178
+ # Sunspot.index(post1, post2)
179
+ #
180
+ # Note that indexed objects won't be reflected in search until a commit is
181
+ # sent - see Sunspot.index! and Sunspot.commit
182
+ #
183
+ def index(*objects)
184
+ session.index(*objects)
185
+ end
186
+
187
+ # Indexes objects on the singleton session and commits immediately.
188
+ #
189
+ # See: Sunspot.index and Sunspot.commit
190
+ #
191
+ # ==== Parameters
192
+ #
193
+ # objects...<Object>:: objects to index (may pass an array or varargs)
194
+ #
195
+ def index!(*objects)
196
+ session.index!(*objects)
197
+ end
198
+
199
+ # Commits the singleton session
200
+ #
201
+ # When documents are added to or removed from Solr, the changes are
202
+ # initially stored in memory, and are not reflected in Solr's existing
203
+ # searcher instance. When a commit message is sent, the changes are written
204
+ # to disk, and a new searcher is spawned. Commits are thus fairly
205
+ # expensive, so if your application needs to index several documents as part
206
+ # of a single operation, it is advisable to index them all and then call
207
+ # commit at the end of the operation.
208
+ #
209
+ # Note that Solr can also be configured to automatically perform a commit
210
+ # after either a specified interval after the last change, or after a
211
+ # specified number of documents are added. See
212
+ # http://wiki.apache.org/solr/SolrConfigXml
213
+ #
214
+ def commit
215
+ session.commit
216
+ end
217
+
218
+ # Optimizes the index on the singletion session.
219
+ #
220
+ # Frequently adding and deleting documents to Solr, leaves the index in a
221
+ # fragmented state. The optimize command merges all index segments into
222
+ # a single segment and removes any deleted documents, making it faster to
223
+ # search. Since optimize rebuilds the index from scratch, it takes some
224
+ # time and requires double the space on the hard disk while it's rebuilding.
225
+ # Note that optimize also commits.
226
+ def optimize
227
+ session.optimize
228
+ end
229
+
230
+ #
231
+ # Create a new Search instance, but do not execute it immediately. Generally
232
+ # you will want to use the #search method to build and execute searches in
233
+ # one step, but if you are building searches piecemeal you may call
234
+ # #new_search and then call #build one or more times to add components to
235
+ # the query.
236
+ #
237
+ # ==== Example
238
+ #
239
+ # search = Sunspot.new_search do
240
+ # with(:blog_id, 1)
241
+ # end
242
+ # search.build do
243
+ # keywords('some keywords')
244
+ # end
245
+ # search.build do
246
+ # order_by(:published_at, :desc)
247
+ # end
248
+ # search.execute
249
+ #
250
+ # # This is equivalent to:
251
+ # Sunspot.search do
252
+ # with(:blog_id, 1)
253
+ # keywords('some keywords')
254
+ # order_by(:published_at, :desc)
255
+ # end
256
+ #
257
+ # ==== Parameters
258
+ #
259
+ # types<Class>...::
260
+ # One or more types to search for. If no types are passed, all
261
+ # configured types will be searched for.
262
+ #
263
+ # ==== Returns
264
+ #
265
+ # Sunspot::Search::
266
+ # Search object, not yet executed. Query parameters can be added manually;
267
+ # then #execute should be called.
268
+ #
269
+ def new_search(*types, &block)
270
+ session.new_search(*types, &block)
271
+ end
272
+
273
+
274
+ # Search for objects in the index.
275
+ #
276
+ # ==== Parameters
277
+ #
278
+ # types<Class>...::
279
+ # One or more types to search for. If no types are passed, all
280
+ # configured types will be searched.
281
+ #
282
+ # ==== Returns
283
+ #
284
+ # Sunspot::Search:: Object containing results, facets, count, etc.
285
+ #
286
+ # The fields available for restriction, ordering, etc. are those that meet
287
+ # the following criteria:
288
+ #
289
+ # * They are not of type +text+.
290
+ # * They are defined for at least one of the classes being searched
291
+ # * They have the same data type for all of the classes being searched.
292
+ # * They have the same multiple flag for all of the classes being searched.
293
+ # * They have the same stored flag for all of the classes being searched.
294
+ #
295
+ # The restrictions available are the constants defined in the
296
+ # Sunspot::Restriction class. The standard restrictions are:
297
+ #
298
+ # with(:field_name).equal_to(value)
299
+ # with(:field_name, value) # shorthand for above
300
+ # with(:field_name).less_than(value)
301
+ # with(:field_name).greater_than(value)
302
+ # with(:field_name).between(value1..value2)
303
+ # with(:field_name).any_of([value1, value2, value3])
304
+ # with(:field_name).all_of([value1, value2, value3])
305
+ # without(some_instance) # exclude that particular instance
306
+ #
307
+ # +without+ can be substituted for +with+, causing the restriction to be
308
+ # negated. In the last example above, only +without+ works, as it does not
309
+ # make sense to search only for an instance you already have.
310
+ #
311
+ # Equality restrictions can take +nil+ as a value, which restricts the
312
+ # results to documents that have no value for the given field. Passing +nil+
313
+ # as a value to other restriction types is illegal. Thus:
314
+ #
315
+ # with(:field_name, nil) # ok
316
+ # with(:field_name).equal_to(nil) # ok
317
+ # with(:field_name).less_than(nil) # bad
318
+ #
319
+ # ==== Example
320
+ #
321
+ # Sunspot.search(Post) do
322
+ # keywords 'great pizza'
323
+ # with(:published_at).less_than Time.now
324
+ # with :blog_id, 1
325
+ # without current_post
326
+ # facet :category_ids
327
+ # order_by :published_at, :desc
328
+ # paginate 2, 15
329
+ # end
330
+ #
331
+ # If the block passed to #search takes an argument, that argument will
332
+ # present the DSL, and the block will be evaluated in the calling context.
333
+ # This will come in handy for building searches using instance data or
334
+ # methods, e.g.:
335
+ #
336
+ # Sunspot.search(Post) do |query|
337
+ # query.with(:blog_id, @current_blog.id)
338
+ # end
339
+ #
340
+ # See Sunspot::DSL::Search, Sunspot::DSL::Scope, Sunspot::DSL::FieldQuery
341
+ # and Sunspot::DSL::StandardQuery for the full API presented inside the
342
+ # block.
343
+ #
344
+ def search(*types, &block)
345
+ session.search(*types, &block)
346
+ end
347
+
348
+ def new_more_like_this(object, *types, &block)
349
+ session.new_more_like_this(object, *types, &block)
350
+ end
351
+
352
+ #
353
+ # Initiate a MoreLikeThis search. MoreLikeThis is a special type of search
354
+ # that finds similar documents using fulltext comparison. The fields to be
355
+ # compared are `text` fields set up with the `:more_like_this` option set to
356
+ # `true`. By default, more like this returns objects of the same type as the
357
+ # object used for comparison, but a list of types can optionally be passed
358
+ # to this method to return similar documents of other types. This will only
359
+ # work for types that have common fields.
360
+ #
361
+ # The DSL for MoreLikeThis search exposes several methods for setting
362
+ # options specific to this type of search. See the
363
+ # Sunspot::DSL::MoreLikeThis class and the MoreLikeThis documentation on
364
+ # the Solr wiki: http://wiki.apache.org/solr/MoreLikeThis
365
+ #
366
+ # MoreLikeThis searches have all of the same scoping, ordering, and faceting
367
+ # functionality as standard searches; the only thing you can't do in a MLT
368
+ # search is fulltext matching (since the MLT itself is a fulltext query).
369
+ #
370
+ # ==== Example
371
+ #
372
+ # post = Post.first
373
+ # Sunspot.more_like_this(post, Post, Page) do
374
+ # fields :title, :body
375
+ # with(:updated_at).greater_than(1.month.ago)
376
+ # facet(:category_ids)
377
+ # end
378
+ #
379
+ #
380
+ def more_like_this(object, *types, &block)
381
+ session.more_like_this(object, *types, &block)
382
+ end
383
+
384
+ # Remove objects from the index. Any time an object is destroyed, it must
385
+ # be removed from the index; otherwise, the index will contain broken
386
+ # references to objects that do not exist, which will cause errors when
387
+ # those objects are matched in search results.
388
+ #
389
+ # If a block is passed, it is evaluated as a search scope; in this way,
390
+ # documents can be removed by an arbitrary query. In this case, the
391
+ # arguments to the method should be the classes to run the query on.
392
+ #
393
+ # ==== Parameters
394
+ #
395
+ # objects...<Object>::
396
+ # Objects to remove from the index (may pass an array or varargs)
397
+ #
398
+ # ==== Example (remove a document)
399
+ #
400
+ # post.destroy
401
+ # Sunspot.remove(post)
402
+ #
403
+ # ==== Example (remove by query)
404
+ #
405
+ # Sunspot.remove(Post) do
406
+ # with(:created_at).less_than(Time.now - 14.days)
407
+ # end
408
+ #
409
+ def remove(*objects, &block)
410
+ session.remove(*objects, &block)
411
+ end
412
+
413
+ #
414
+ # Remove objects from the index and immediately commit. See Sunspot.remove
415
+ #
416
+ # ==== Parameters
417
+ #
418
+ # objects...<Object>:: Objects to remove from the index
419
+ #
420
+ def remove!(*objects)
421
+ session.remove!(*objects)
422
+ end
423
+
424
+ #
425
+ # Remove an object from the index using its class name and primary key.
426
+ # Useful if you know this information and want to remove an object without
427
+ # instantiating it from persistent storage
428
+ #
429
+ # ==== Parameters
430
+ #
431
+ # clazz<Class>:: Class of the object, or class name as a string or symbol
432
+ # id::
433
+ # Primary key of the object. This should be the same id that would be
434
+ # returned by the class's instance adapter.
435
+ #
436
+ def remove_by_id(clazz, id)
437
+ session.remove_by_id(clazz, id)
438
+ end
439
+
440
+ #
441
+ # Remove an object by class name and primary key, and immediately commit.
442
+ # See #remove_by_id and #commit
443
+ #
444
+ def remove_by_id!(clazz, id)
445
+ session.remove_by_id!(clazz, id)
446
+ end
447
+
448
+ # Remove all objects of the given classes from the index. There isn't much
449
+ # use for this in general operations but it can be useful for maintenance,
450
+ # testing, etc. If no arguments are passed, remove everything from the
451
+ # index.
452
+ #
453
+ # ==== Parameters
454
+ #
455
+ # classes...<Class>::
456
+ # classes for which to remove all instances from the index (may pass an
457
+ # array or varargs)
458
+ #
459
+ # ==== Example
460
+ #
461
+ # Sunspot.remove_all(Post, Blog)
462
+ #
463
+ def remove_all(*classes)
464
+ session.remove_all(*classes)
465
+ end
466
+
467
+ #
468
+ # Remove all objects of the given classes from the index and immediately
469
+ # commit. See Sunspot.remove_all
470
+ #
471
+ # ==== Parameters
472
+ #
473
+ # classes...<Class>::
474
+ # classes for which to remove all instances from the index
475
+ def remove_all!(*classes)
476
+ session.remove_all!(*classes)
477
+ end
478
+
479
+ #
480
+ # Process all adds in a batch. Any Sunspot adds initiated inside the block
481
+ # will be sent in bulk when the block finishes. Useful if your application
482
+ # initiates index adds from various places in code as part of a single
483
+ # operation; doing a batch add will give better performance.
484
+ #
485
+ # ==== Example
486
+ #
487
+ # Sunspot.batch do
488
+ # post = Post.new
489
+ # Sunspot.add(post)
490
+ # comment = Comment.new
491
+ # Sunspot.add(comment)
492
+ # end
493
+ #
494
+ # Sunspot will send both the post and the comment in a single request.
495
+ #
496
+ def batch(&block)
497
+ session.batch(&block)
498
+ end
499
+
500
+ #
501
+ # True if documents have been added, updated, or removed since the last
502
+ # commit.
503
+ #
504
+ # ==== Returns
505
+ #
506
+ # Boolean:: Whether there have been any updates since the last commit
507
+ #
508
+ def dirty?
509
+ session.dirty?
510
+ end
511
+
512
+ #
513
+ # Sends a commit if the session is dirty (see #dirty?).
514
+ #
515
+ def commit_if_dirty
516
+ session.commit_if_dirty
517
+ end
518
+
519
+ #
520
+ # True if documents have been removed since the last commit.
521
+ #
522
+ # ==== Returns
523
+ #
524
+ # Boolean:: Whether there have been any deletes since the last commit
525
+ #
526
+ def delete_dirty?
527
+ session.delete_dirty?
528
+ end
529
+
530
+ #
531
+ # Sends a commit if the session has deletes since the last commit (see #delete_dirty?).
532
+ #
533
+ def commit_if_delete_dirty
534
+ session.commit_if_delete_dirty
535
+ end
536
+
537
+ # Returns the configuration associated with the singleton session. See
538
+ # Sunspot::Configuration for details.
539
+ #
540
+ # ==== Returns
541
+ #
542
+ # LightConfig::Configuration:: configuration for singleton session
543
+ #
544
+ def config
545
+ session.config
546
+ end
547
+
548
+ #
549
+ # Resets the singleton session. This is useful for clearing out all
550
+ # static data between tests, but probably nowhere else.
551
+ #
552
+ # ==== Parameters
553
+ #
554
+ # keep_config<Boolean>::
555
+ # Whether to retain the configuration used by the current singleton
556
+ # session. Default false.
557
+ #
558
+ def reset!(keep_config = false)
559
+ config =
560
+ if keep_config
561
+ session.config
562
+ else
563
+ Configuration.build
564
+ end
565
+ @session = Session.new(config)
566
+ end
567
+
568
+ #
569
+ # Get the singleton session, creating it if none yet exists.
570
+ #
571
+ # ==== Returns
572
+ #
573
+ # Sunspot::Session:: the singleton session
574
+ #
575
+ def session #:nodoc:
576
+ @session ||= Session.new
577
+ end
578
+ end
579
+ end