websolr-rails 0.0.0 → 1.4.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (168) hide show
  1. data/.document +5 -0
  2. data/.gitignore +15 -0
  3. data/CHANGELOG +8 -0
  4. data/LICENSE +19 -0
  5. data/README.rdoc +69 -0
  6. data/Rakefile +112 -0
  7. data/TESTING_THE_PLUGIN +25 -0
  8. data/VERSION +1 -0
  9. data/bin/websolr +10 -0
  10. data/config/solr.yml +15 -0
  11. data/config/solr_environment.rb +22 -0
  12. data/generate_rdoc.sh +13 -0
  13. data/lib/acts_as_solr.rb +65 -0
  14. data/lib/acts_methods.rb +281 -0
  15. data/lib/class_methods.rb +243 -0
  16. data/lib/common_methods.rb +89 -0
  17. data/lib/deprecation.rb +61 -0
  18. data/lib/instance_methods.rb +181 -0
  19. data/lib/lazy_document.rb +18 -0
  20. data/lib/parser_methods.rb +230 -0
  21. data/lib/search_results.rb +72 -0
  22. data/lib/solr.rb +21 -0
  23. data/lib/solr/connection.rb +190 -0
  24. data/lib/solr/document.rb +78 -0
  25. data/lib/solr/exception.rb +13 -0
  26. data/lib/solr/field.rb +39 -0
  27. data/lib/solr/importer.rb +19 -0
  28. data/lib/solr/importer/array_mapper.rb +26 -0
  29. data/lib/solr/importer/delimited_file_source.rb +38 -0
  30. data/lib/solr/importer/hpricot_mapper.rb +27 -0
  31. data/lib/solr/importer/mapper.rb +51 -0
  32. data/lib/solr/importer/solr_source.rb +43 -0
  33. data/lib/solr/importer/xpath_mapper.rb +35 -0
  34. data/lib/solr/indexer.rb +52 -0
  35. data/lib/solr/request.rb +26 -0
  36. data/lib/solr/request/add_document.rb +63 -0
  37. data/lib/solr/request/base.rb +36 -0
  38. data/lib/solr/request/commit.rb +31 -0
  39. data/lib/solr/request/delete.rb +50 -0
  40. data/lib/solr/request/dismax.rb +46 -0
  41. data/lib/solr/request/index_info.rb +22 -0
  42. data/lib/solr/request/modify_document.rb +51 -0
  43. data/lib/solr/request/optimize.rb +21 -0
  44. data/lib/solr/request/ping.rb +36 -0
  45. data/lib/solr/request/select.rb +56 -0
  46. data/lib/solr/request/spellcheck.rb +30 -0
  47. data/lib/solr/request/standard.rb +402 -0
  48. data/lib/solr/request/update.rb +23 -0
  49. data/lib/solr/response.rb +27 -0
  50. data/lib/solr/response/add_document.rb +17 -0
  51. data/lib/solr/response/base.rb +42 -0
  52. data/lib/solr/response/commit.rb +17 -0
  53. data/lib/solr/response/delete.rb +13 -0
  54. data/lib/solr/response/dismax.rb +8 -0
  55. data/lib/solr/response/index_info.rb +26 -0
  56. data/lib/solr/response/modify_document.rb +17 -0
  57. data/lib/solr/response/optimize.rb +14 -0
  58. data/lib/solr/response/ping.rb +28 -0
  59. data/lib/solr/response/ruby.rb +42 -0
  60. data/lib/solr/response/select.rb +17 -0
  61. data/lib/solr/response/spellcheck.rb +20 -0
  62. data/lib/solr/response/standard.rb +64 -0
  63. data/lib/solr/response/xml.rb +42 -0
  64. data/lib/solr/solrtasks.rb +27 -0
  65. data/lib/solr/util.rb +32 -0
  66. data/lib/solr/xml.rb +44 -0
  67. data/lib/solr_fixtures.rb +13 -0
  68. data/lib/tasks/database.rake +18 -0
  69. data/lib/tasks/solr.rake +94 -0
  70. data/lib/tasks/test.rake +7 -0
  71. data/lib/websolr-rails.rb +1 -0
  72. data/lib/websolr.rb +1 -0
  73. data/lib/websolr_controller.rb +233 -0
  74. data/lib/websolr_option_parser.rb +61 -0
  75. data/lib/websolr_rails.rb +1 -0
  76. data/lib/websolr_rails/tasks.rb +4 -0
  77. data/lib/will_paginate_support.rb +12 -0
  78. data/solr/CHANGES.txt +1207 -0
  79. data/solr/LICENSE.txt +712 -0
  80. data/solr/NOTICE.txt +90 -0
  81. data/solr/etc/jetty.xml +205 -0
  82. data/solr/etc/webdefault.xml +379 -0
  83. data/solr/lib/easymock.jar +0 -0
  84. data/solr/lib/jetty-6.1.3.jar +0 -0
  85. data/solr/lib/jetty-util-6.1.3.jar +0 -0
  86. data/solr/lib/jsp-2.1/ant-1.6.5.jar +0 -0
  87. data/solr/lib/jsp-2.1/core-3.1.1.jar +0 -0
  88. data/solr/lib/jsp-2.1/jsp-2.1.jar +0 -0
  89. data/solr/lib/jsp-2.1/jsp-api-2.1.jar +0 -0
  90. data/solr/lib/servlet-api-2.4.jar +0 -0
  91. data/solr/lib/servlet-api-2.5-6.1.3.jar +0 -0
  92. data/solr/lib/xpp3-1.1.3.4.O.jar +0 -0
  93. data/solr/logs/.empty-dir-for-git +0 -0
  94. data/solr/solr/README.txt +52 -0
  95. data/solr/solr/bin/abc +176 -0
  96. data/solr/solr/bin/abo +176 -0
  97. data/solr/solr/bin/backup +108 -0
  98. data/solr/solr/bin/backupcleaner +142 -0
  99. data/solr/solr/bin/commit +128 -0
  100. data/solr/solr/bin/optimize +129 -0
  101. data/solr/solr/bin/readercycle +129 -0
  102. data/solr/solr/bin/rsyncd-disable +77 -0
  103. data/solr/solr/bin/rsyncd-enable +76 -0
  104. data/solr/solr/bin/rsyncd-start +145 -0
  105. data/solr/solr/bin/rsyncd-stop +105 -0
  106. data/solr/solr/bin/scripts-util +83 -0
  107. data/solr/solr/bin/snapcleaner +148 -0
  108. data/solr/solr/bin/snapinstaller +168 -0
  109. data/solr/solr/bin/snappuller +248 -0
  110. data/solr/solr/bin/snappuller-disable +77 -0
  111. data/solr/solr/bin/snappuller-enable +77 -0
  112. data/solr/solr/bin/snapshooter +109 -0
  113. data/solr/solr/conf/admin-extra.html +31 -0
  114. data/solr/solr/conf/protwords.txt +21 -0
  115. data/solr/solr/conf/schema.xml +126 -0
  116. data/solr/solr/conf/scripts.conf +24 -0
  117. data/solr/solr/conf/solrconfig.xml +458 -0
  118. data/solr/solr/conf/stopwords.txt +57 -0
  119. data/solr/solr/conf/synonyms.txt +31 -0
  120. data/solr/solr/conf/xslt/example.xsl +132 -0
  121. data/solr/solr/conf/xslt/example_atom.xsl +63 -0
  122. data/solr/solr/conf/xslt/example_rss.xsl +62 -0
  123. data/solr/start.jar +0 -0
  124. data/solr/tmp/.empty-dir-for-git +0 -0
  125. data/solr/webapps/solr.war +0 -0
  126. data/test/config/solr.yml +2 -0
  127. data/test/db/connections/mysql/connection.rb +10 -0
  128. data/test/db/connections/sqlite/connection.rb +8 -0
  129. data/test/db/migrate/001_create_books.rb +15 -0
  130. data/test/db/migrate/002_create_movies.rb +12 -0
  131. data/test/db/migrate/003_create_categories.rb +11 -0
  132. data/test/db/migrate/004_create_electronics.rb +16 -0
  133. data/test/db/migrate/005_create_authors.rb +12 -0
  134. data/test/db/migrate/006_create_postings.rb +9 -0
  135. data/test/db/migrate/007_create_posts.rb +13 -0
  136. data/test/db/migrate/008_create_gadgets.rb +11 -0
  137. data/test/fixtures/authors.yml +9 -0
  138. data/test/fixtures/books.yml +13 -0
  139. data/test/fixtures/categories.yml +7 -0
  140. data/test/fixtures/db_definitions/mysql.sql +41 -0
  141. data/test/fixtures/electronics.yml +49 -0
  142. data/test/fixtures/movies.yml +9 -0
  143. data/test/fixtures/postings.yml +10 -0
  144. data/test/functional/acts_as_solr_test.rb +413 -0
  145. data/test/functional/association_indexing_test.rb +37 -0
  146. data/test/functional/faceted_search_test.rb +163 -0
  147. data/test/functional/multi_solr_search_test.rb +51 -0
  148. data/test/models/author.rb +10 -0
  149. data/test/models/book.rb +10 -0
  150. data/test/models/category.rb +8 -0
  151. data/test/models/electronic.rb +21 -0
  152. data/test/models/gadget.rb +9 -0
  153. data/test/models/movie.rb +17 -0
  154. data/test/models/novel.rb +2 -0
  155. data/test/models/post.rb +3 -0
  156. data/test/models/posting.rb +11 -0
  157. data/test/test_helper.rb +51 -0
  158. data/test/unit/acts_methods_shoulda.rb +70 -0
  159. data/test/unit/class_methods_shoulda.rb +88 -0
  160. data/test/unit/common_methods_shoulda.rb +112 -0
  161. data/test/unit/instance_methods_shoulda.rb +326 -0
  162. data/test/unit/lazy_document_shoulda.rb +35 -0
  163. data/test/unit/parser_instance.rb +19 -0
  164. data/test/unit/parser_methods_shoulda.rb +278 -0
  165. data/test/unit/solr_instance.rb +46 -0
  166. data/test/unit/test_helper.rb +14 -0
  167. data/websolr-rails.gemspec +243 -0
  168. metadata +229 -18
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,15 @@
1
+ *.log
2
+ *.log
3
+ *_pid
4
+ coverage/*
5
+ coverage.data
6
+ solr/solr/data/*
7
+ .svn
8
+ test/db/*.db
9
+ *.sw?
10
+ .DS_Store
11
+ coverage
12
+ rdoc
13
+ pkg
14
+ *.gem
15
+ doc
data/CHANGELOG ADDED
@@ -0,0 +1,8 @@
1
+ 1.4.2
2
+ - Made connection errors a unique exception.
3
+ 1.4.1
4
+ - Changed start to local:start, stop to local:stop
5
+ - Removed dependency on remote environment
6
+ 1.4.0
7
+ - Added CHANGELOG
8
+ - Added local development server
data/LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (c) 2006 Erik Hatcher, Thiago Jackiw
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ of this software and associated documentation files (the "Software"), to deal
5
+ in the Software without restriction, including without limitation the rights
6
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ copies of the Software, and to permit persons to whom the Software is
8
+ furnished to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+ SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,69 @@
1
+
2
+ = websolr-rails gem
3
+
4
+ This gem provides Rails support for websolr.com, and a command-line tool to interact with
5
+ the indexes hosted there. The Rails support is reverse-compatible with acts_as_solr.
6
+
7
+ == RDoc
8
+
9
+ Ruby documentation is at http://onemorecloud.github.com/websolr-rails
10
+
11
+ == Current Release
12
+
13
+ There is no numbered release yet, but the master branch is always considered stable.
14
+
15
+ == Support
16
+
17
+ For now, please send email to support@onemorecloud.com
18
+
19
+ == Changes
20
+
21
+ Please refer to the CHANGELOG[http://github.com/mattmatt/acts_as_solr/blob/master/CHANGE_LOG]
22
+
23
+ == Installation
24
+
25
+ $: gem sources -a http://gems.github.com
26
+ $: sudo gem install onemorecloud-websolr-rails
27
+
28
+ == Configuration
29
+
30
+ $: export WEBSOLR_USER=my_username
31
+ $: export WEBSOLR_PWD=my_password
32
+ $: cd my_rails_project
33
+ $: websolr add -n my_index_name
34
+ $: websolr configure -e development -n my_index_name
35
+
36
+ == Basic Usage
37
+
38
+ # Just include the line below to any of your ActiveRecord models:
39
+ acts_as_solr
40
+
41
+ # Or if you want, you can specify only the fields that should be indexed:
42
+ acts_as_solr :fields => [:name, :author]
43
+
44
+ # Then to find instances of your model, just do:
45
+ Model.find_by_solr(query) #query is a string representing your query
46
+
47
+ # Please see ActsAsSolr::ActsMethods for a complete info
48
+
49
+ == acts_as_solr in your tests
50
+
51
+ If you would like to mock out Solr calls so that a Solr server is not needed (and your tests will run much faster), just add this to your `test_helper.rb` or similar:
52
+
53
+ class ActsAsSolr::Post
54
+ def self.execute(request)
55
+ true
56
+ end
57
+ end
58
+
59
+ (via[http://www.subelsky.com/2007/10/actsassolr-capistranhttpwwwbloggercomim.html#c1646308013209805416])
60
+
61
+ == Authors
62
+
63
+ Websolr is by Onemorecloud.
64
+
65
+ Based on acts_as_solr by: Erik Hatcher, Thiago Jackiw, Luke Francl, Mathias Meyer, and others.
66
+
67
+ == Release Information
68
+
69
+ Released under the MIT license.
data/Rakefile ADDED
@@ -0,0 +1,112 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+ require 'rake/testtask'
4
+ require 'rake/rdoctask'
5
+
6
+ Dir["#{File.dirname(__FILE__)}/lib/tasks/**/*.rake"].sort.each { |ext| load ext }
7
+
8
+ desc "Default Task"
9
+ task :default => [:test]
10
+
11
+ desc "Runs the unit tests"
12
+ task :test => "test:unit"
13
+
14
+ namespace :test do
15
+ task :setup do
16
+ ENV['RAILS_ENV'] = "test"
17
+ require File.dirname(__FILE__) + '/config/solr_environment'
18
+ puts "Using " + DB
19
+ %x(mysql -u#{MYSQL_USER} < #{File.dirname(__FILE__) + "/test/fixtures/db_definitions/mysql.sql"}) if DB == 'mysql'
20
+
21
+ Rake::Task["test:migrate"].invoke
22
+ end
23
+
24
+ desc 'Measures test coverage using rcov'
25
+ task :rcov => :setup do
26
+ rm_f "coverage"
27
+ rm_f "coverage.data"
28
+ rcov = "rcov --rails --aggregate coverage.data --text-summary -Ilib"
29
+
30
+ system("#{rcov} --html #{Dir.glob('test/**/*_test.rb').join(' ')}")
31
+ system("open coverage/index.html") if PLATFORM['darwin']
32
+ end
33
+
34
+ desc 'Runs the functional tests, testing integration with Solr'
35
+ Rake::TestTask.new('functional' => :setup) do |t|
36
+ t.pattern = "test/functional/*_test.rb"
37
+ t.verbose = true
38
+ end
39
+
40
+ desc "Unit tests"
41
+ Rake::TestTask.new(:unit) do |t|
42
+ t.libs << 'test/unit'
43
+ t.pattern = "test/unit/*_shoulda.rb"
44
+ t.verbose = true
45
+ end
46
+ end
47
+
48
+ Rake::RDocTask.new do |rd|
49
+ rd.main = "README.rdoc"
50
+ rd.rdoc_dir = "rdoc"
51
+ rd.rdoc_files.exclude("lib/solr/**/*.rb", "lib/solr.rb")
52
+ rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
53
+ end
54
+
55
+ require 'rubygems'
56
+ require 'rake'
57
+
58
+ begin
59
+ require 'jeweler'
60
+ Jeweler::Tasks.new do |gem|
61
+ gem.name = "websolr-rails"
62
+ gem.summary = %Q{acts_as_solr compatible gem for websolr}
63
+ gem.description = %Q{acts_as_solr compatible gem for websolr}
64
+ gem.email = "kyle@kylemaxwell.com"
65
+ gem.homepage = "http://github.com/onemorecloud/websolr-rails"
66
+ gem.authors = ["Kyle Maxwell"]
67
+ gem.add_development_dependency "thoughtbot-shoulda"
68
+ gem.default_executable = %q{websolr}
69
+ gem.rdoc_options = ["--main", "README.rdoc", "README.rdoc", "lib"]
70
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
71
+ end
72
+ rescue LoadError
73
+ puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
74
+ end
75
+
76
+ require 'rake/testtask'
77
+ Rake::TestTask.new(:test) do |test|
78
+ test.libs << 'lib' << 'test'
79
+ test.pattern = 'test/**/*_test.rb'
80
+ test.verbose = true
81
+ end
82
+
83
+ begin
84
+ require 'rcov/rcovtask'
85
+ Rcov::RcovTask.new do |test|
86
+ test.libs << 'test'
87
+ test.pattern = 'test/**/*_test.rb'
88
+ test.verbose = true
89
+ end
90
+ rescue LoadError
91
+ task :rcov do
92
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
93
+ end
94
+ end
95
+
96
+ task :test => :check_dependencies
97
+
98
+ task :default => :test
99
+
100
+ require 'rake/rdoctask'
101
+ Rake::RDocTask.new do |rdoc|
102
+ if File.exist?('VERSION')
103
+ version = File.read('VERSION')
104
+ else
105
+ version = ""
106
+ end
107
+
108
+ rdoc.rdoc_dir = 'rdoc'
109
+ rdoc.title = "websolr-rails #{version}"
110
+ rdoc.rdoc_files.include('README*')
111
+ rdoc.rdoc_files.include('lib/**/*.rb')
112
+ end
@@ -0,0 +1,25 @@
1
+ acts_as_solr comes with a quick and fast unit test suite, and with a longer-running
2
+ functional test suite, the latter testing the actual integration with Solr.
3
+
4
+ The unit test suite is written using Shoulda, so make sure you have a recent version
5
+ installed.
6
+
7
+ Running `rake test` or just `rake` will run both test suites. Use `rake test:unit` to
8
+ just run the unit test suite.
9
+
10
+ == How to run functional tests for this plugin:
11
+ To run the acts_as_solr's plugin tests run the following steps:
12
+
13
+ - create a MySQL database called "actsassolr_test" (if you want to use MySQL)
14
+
15
+ - create a new Rails project, if needed (the plugin can only be tested from within a Rails project); move/checkout acts_as_solr into its vendor/plugins/, as usual
16
+
17
+ - copy vendor/plugins/acts_as_solr/config/solr.yml to config/ (the Rails config folder)
18
+
19
+ - rake solr:start RAILS_ENV=test
20
+
21
+ - rake test:functional (Accepts the following arguments: DB=sqlite|mysql and MYSQL_USER=user)
22
+
23
+ == Troubleshooting:
24
+ If for some reason the tests don't run and you get MySQL errors, make sure you edit the MYSQL_USER entry under
25
+ config/environment.rb. It's recommended to create or use a MySQL user with no password.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.4.3
data/bin/websolr ADDED
@@ -0,0 +1,10 @@
1
+ #!/usr/bin/env ruby
2
+ require File.dirname(__FILE__) + "/../lib/websolr_option_parser"
3
+ require File.dirname(__FILE__) + "/../lib/websolr_controller"
4
+
5
+ PWD = File.expand_path(".")
6
+
7
+ parser = WebsolrOptionParser.new
8
+ parser.parse!
9
+ controller = WebsolrController.new(parser)
10
+ controller.start
data/config/solr.yml ADDED
@@ -0,0 +1,15 @@
1
+ # Config file for the acts_as_solr plugin.
2
+ #
3
+ # If you change the host or port number here, make sure you update
4
+ # them in your Solr config file
5
+
6
+ development:
7
+ url: http://127.0.0.1:8982/solr
8
+
9
+ production:
10
+ url: http://127.0.0.1:8983/solr
11
+ jvm_options: -server -d64 -Xmx1024M -Xms64M
12
+
13
+ test:
14
+ url: http://127.0.0.1:8981/solr
15
+
@@ -0,0 +1,22 @@
1
+ # ENV['RAILS_ENV'] = (ENV['RAILS_ENV'] || 'development').dup
2
+ # # RAILS_ROOT isn't defined yet, so figure it out.
3
+ # rails_root_dir = "."
4
+ # SOLR_PATH = "#{File.dirname(File.expand_path(__FILE__))}/../solr" unless defined? SOLR_PATH
5
+ #
6
+ # SOLR_LOGS_PATH = "#{rails_root_dir}/log" unless defined? SOLR_LOGS_PATH
7
+ # SOLR_PIDS_PATH = "#{rails_root_dir}/tmp/pids" unless defined? SOLR_PIDS_PATH
8
+ # SOLR_DATA_PATH = "#{rails_root_dir}/solr/#{ENV['RAILS_ENV']}" unless defined? SOLR_DATA_PATH
9
+ #
10
+ # unless defined? SOLR_PORT
11
+ # config = YAML::load_file(rails_root_dir+'/config/solr.yml')
12
+ #
13
+ # SOLR_PORT = ENV['PORT'] || URI.parse(config[ENV['RAILS_ENV']]['url']).port
14
+ # end
15
+ #
16
+ # SOLR_JVM_OPTIONS = config[ENV['RAILS_ENV']]['jvm_options'] unless defined? SOLR_JVM_OPTIONS
17
+ #
18
+ # if ENV['RAILS_ENV'] == 'test'
19
+ # DB = (ENV['DB'] ? ENV['DB'] : 'mysql') unless defined?(DB)
20
+ # MYSQL_USER = (ENV['MYSQL_USER'].nil? ? 'root' : ENV['MYSQL_USER']) unless defined? MYSQL_USER
21
+ # require File.join(File.dirname(File.expand_path(__FILE__)), '..', 'test', 'db', 'connections', DB, 'connection.rb')
22
+ # end
data/generate_rdoc.sh ADDED
@@ -0,0 +1,13 @@
1
+ #!/bin/sh
2
+ rm -rf /tmp/websolr-rails*
3
+ git clone git@github.com:onemorecloud/websolr-rails.git /tmp/websolr-rails
4
+ rdoc --op /tmp/websolr-rails-rdoc --main README.rdoc README.rdoc lib
5
+ cd /tmp/websolr-rails
6
+ git checkout origin/gh-pages
7
+ git checkout -b gh-pages
8
+ rm -rf /tmp/websolr-rails/*
9
+ mv /tmp/websolr-rails-rdoc/* .
10
+ git add .
11
+ git add -u
12
+ git commit -m "updating rdoc"
13
+ git push origin gh-pages
@@ -0,0 +1,65 @@
1
+ # Copyright (c) 2006 Erik Hatcher, Thiago Jackiw
2
+ #
3
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ # of this software and associated documentation files (the "Software"), to deal
5
+ # in the Software without restriction, including without limitation the rights
6
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ # copies of the Software, and to permit persons to whom the Software is
8
+ # furnished to do so, subject to the following conditions:
9
+ #
10
+ # The above copyright notice and this permission notice shall be included in all
11
+ # copies or substantial portions of the Software.
12
+ #
13
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+ # SOFTWARE.
20
+
21
+ require 'active_record'
22
+ require 'rexml/document'
23
+ require 'net/http'
24
+ require 'yaml'
25
+
26
+ require File.dirname(__FILE__) + '/solr'
27
+ require File.dirname(__FILE__) + '/acts_methods'
28
+ require File.dirname(__FILE__) + '/class_methods'
29
+ require File.dirname(__FILE__) + '/instance_methods'
30
+ require File.dirname(__FILE__) + '/common_methods'
31
+ require File.dirname(__FILE__) + '/deprecation'
32
+ require File.dirname(__FILE__) + '/search_results'
33
+ require File.dirname(__FILE__) + '/lazy_document'
34
+ require File.dirname(__FILE__) + '/will_paginate_support'
35
+
36
+ module ActsAsSolr
37
+ class ConnectionError < RuntimeError; end
38
+
39
+ class Post
40
+ def self.execute(request)
41
+ begin
42
+ # if File.exists?(RAILS_ROOT+'/config/solr.yml')
43
+ # config = YAML::load_file(RAILS_ROOT+'/config/solr.yml')
44
+ # url = config[RAILS_ENV]['url']
45
+ # # for backwards compatibility
46
+ # url ||= "http://#{config[RAILS_ENV]['host']}:#{config[RAILS_ENV]['port']}/#{config[RAILS_ENV]['servlet_path']}"
47
+ # else
48
+ # url = 'http://localhost:8982/solr'
49
+ # end
50
+ unless url = ENV["WEBSOLR_URL"]
51
+ raise "WEBSOLR_URL was not defined. Have you run websolr configure?"
52
+ end
53
+ connection = Solr::Connection.new(url)
54
+ return connection.send(request)
55
+ rescue
56
+ raise ActsAsSolr::ConnectionError, "Couldn't connect to the Solr server at #{url}. #{$!}"
57
+ false
58
+ end
59
+ end
60
+ end
61
+
62
+ end
63
+
64
+ # reopen ActiveRecord and include the acts_as_solr method
65
+ ActiveRecord::Base.extend ActsAsSolr::ActsMethods
@@ -0,0 +1,281 @@
1
+ module ActsAsSolr #:nodoc:
2
+
3
+ module ActsMethods
4
+
5
+ # declares a class as solr-searchable
6
+ #
7
+ # ==== options:
8
+ # fields:: This option can be used to specify only the fields you'd
9
+ # like to index. If not given, all the attributes from the
10
+ # class will be indexed. You can also use this option to
11
+ # include methods that should be indexed as fields
12
+ #
13
+ # class Movie < ActiveRecord::Base
14
+ # acts_as_solr :fields => [:name, :description, :current_time]
15
+ # def current_time
16
+ # Time.now.to_s
17
+ # end
18
+ # end
19
+ #
20
+ # Each field passed can also be a hash with the value being a field type
21
+ #
22
+ # class Electronic < ActiveRecord::Base
23
+ # acts_as_solr :fields => [{:price => :range_float}]
24
+ # def current_time
25
+ # Time.now
26
+ # end
27
+ # end
28
+ #
29
+ # The field types accepted are:
30
+ #
31
+ # :float:: Index the field value as a float (ie.: 12.87)
32
+ # :integer:: Index the field value as an integer (ie.: 31)
33
+ # :boolean:: Index the field value as a boolean (ie.: true/false)
34
+ # :date:: Index the field value as a date (ie.: Wed Nov 15 23:13:03 PST 2006)
35
+ # :string:: Index the field value as a text string, not applying the same indexing
36
+ # filters as a regular text field
37
+ # :range_integer:: Index the field value for integer range queries (ie.:[5 TO 20])
38
+ # :range_float:: Index the field value for float range queries (ie.:[14.56 TO 19.99])
39
+ #
40
+ # Setting the field type preserves its original type when indexed
41
+ #
42
+ # The field may also be passed with a hash value containing options
43
+ #
44
+ # class Author < ActiveRecord::Base
45
+ # acts_as_solr :fields => [{:full_name => {:type => :text, :as => :name}}]
46
+ # def full_name
47
+ # self.first_name + ' ' + self.last_name
48
+ # end
49
+ # end
50
+ #
51
+ # The options accepted are:
52
+ #
53
+ # :type:: Index the field using the specified type
54
+ # :as:: Index the field using the specified field name
55
+ #
56
+ # additional_fields:: This option takes fields to be include in the index
57
+ # in addition to those derived from the database. You
58
+ # can also use this option to include custom fields
59
+ # derived from methods you define. This option will be
60
+ # ignored if the :fields option is given. It also accepts
61
+ # the same field types as the option above
62
+ #
63
+ # class Movie < ActiveRecord::Base
64
+ # acts_as_solr :additional_fields => [:current_time]
65
+ # def current_time
66
+ # Time.now.to_s
67
+ # end
68
+ # end
69
+ #
70
+ # exclude_fields:: This option taks an array of fields that should be ignored from indexing:
71
+ #
72
+ # class User < ActiveRecord::Base
73
+ # acts_as_solr :exclude_fields => [:password, :login, :credit_card_number]
74
+ # end
75
+ #
76
+ # include:: This option can be used for association indexing, which
77
+ # means you can include any :has_one, :has_many, :belongs_to
78
+ # and :has_and_belongs_to_many association to be indexed:
79
+ #
80
+ # class Category < ActiveRecord::Base
81
+ # has_many :books
82
+ # acts_as_solr :include => [:books]
83
+ # end
84
+ #
85
+ # Each association may also be specified as a hash with an option hash as a value
86
+ #
87
+ # class Book < ActiveRecord::Base
88
+ # belongs_to :author
89
+ # has_many :distribution_companies
90
+ # has_many :copyright_dates
91
+ # has_many :media_types
92
+ # acts_as_solr(
93
+ # :fields => [:name, :description],
94
+ # :include => [
95
+ # {:author => {:using => :fullname, :as => :name}},
96
+ # {:media_types => {:using => lambda{|media| type_lookup(media.id)}}}
97
+ # {:distribution_companies => {:as => :distributor, :multivalued => true}},
98
+ # {:copyright_dates => {:as => :copyright, :type => :date}}
99
+ # ]
100
+ # ]
101
+ #
102
+ # The options accepted are:
103
+ #
104
+ # :type:: Index the associated objects using the specified type
105
+ # :as:: Index the associated objects using the specified field name
106
+ # :using:: Index the associated objects using the value returned by the specified method or proc. If a method
107
+ # symbol is supplied, it will be sent to each object to look up the value to index; if a proc is
108
+ # supplied, it will be called once for each object with the object as the only argument
109
+ # :multivalued:: Index the associated objects using one field for each object rather than joining them
110
+ # all into a single field
111
+ #
112
+ # facets:: This option can be used to specify the fields you'd like to
113
+ # index as facet fields
114
+ #
115
+ # class Electronic < ActiveRecord::Base
116
+ # acts_as_solr :facets => [:category, :manufacturer]
117
+ # end
118
+ #
119
+ # boost:: You can pass a boost (float) value that will be used to boost the document and/or a field. To specify a more
120
+ # boost for the document, you can either pass a block or a symbol. The block will be called with the record
121
+ # as an argument, a symbol will result in the according method being called:
122
+ #
123
+ # class Electronic < ActiveRecord::Base
124
+ # acts_as_solr :fields => [{:price => {:boost => 5.0}}], :boost => 10.0
125
+ # end
126
+ #
127
+ # class Electronic < ActiveRecord::Base
128
+ # acts_as_solr :fields => [{:price => {:boost => 5.0}}], :boost => proc {|record| record.id + 120*37}
129
+ # end
130
+ #
131
+ # class Electronic < ActiveRecord::Base
132
+ # acts_as_solr :fields => [{:price => {:boost => :price_rating}}], :boost => 10.0
133
+ # end
134
+ #
135
+ # if:: Only indexes the record if the condition evaluated is true. The argument has to be
136
+ # either a symbol, string (to be eval'ed), proc/method, or class implementing a static
137
+ # validation method. It behaves the same way as ActiveRecord's :if option.
138
+ #
139
+ # class Electronic < ActiveRecord::Base
140
+ # acts_as_solr :if => proc{|record| record.is_active?}
141
+ # end
142
+ #
143
+ # offline:: Assumes that your using an outside mechanism to explicitly trigger indexing records, e.g. you only
144
+ # want to update your index through some asynchronous mechanism. Will accept either a boolean or a block
145
+ # that will be evaluated before actually contacting the index for saving or destroying a document. Defaults
146
+ # to false. It doesn't refer to the mechanism of an offline index in general, but just to get a centralized point
147
+ # where you can control indexing. Note: This is only enabled for saving records. acts_as_solr doesn't always like
148
+ # it, if you have a different number of results coming from the database and the index. This might be rectified in
149
+ # another patch to support lazy loading.
150
+ #
151
+ # class Electronic < ActiveRecord::Base
152
+ # acts_as_solr :offline => proc {|record| record.automatic_indexing_disabled?}
153
+ # end
154
+ #
155
+ # auto_commit:: The commit command will be sent to Solr only if its value is set to true:
156
+ #
157
+ # class Author < ActiveRecord::Base
158
+ # acts_as_solr :auto_commit => false
159
+ # end
160
+ #
161
+ def acts_as_solr(options={}, solr_options={})
162
+
163
+ extend ClassMethods
164
+ include InstanceMethods
165
+ include CommonMethods
166
+ include ParserMethods
167
+
168
+ cattr_accessor :configuration
169
+ cattr_accessor :solr_configuration
170
+
171
+ self.configuration = {
172
+ :fields => nil,
173
+ :additional_fields => nil,
174
+ :exclude_fields => [],
175
+ :auto_commit => true,
176
+ :include => nil,
177
+ :facets => nil,
178
+ :boost => nil,
179
+ :if => "true",
180
+ :offline => false
181
+ }
182
+ self.solr_configuration = {
183
+ :type_field => "type_s",
184
+ :primary_key_field => "pk_i",
185
+ :default_boost => 1.0
186
+ }
187
+
188
+ configuration.update(options) if options.is_a?(Hash)
189
+ solr_configuration.update(solr_options) if solr_options.is_a?(Hash)
190
+ Deprecation.validate_index(configuration)
191
+
192
+ configuration[:solr_fields] = {}
193
+ configuration[:solr_includes] = {}
194
+
195
+ after_save :solr_save
196
+ after_destroy :solr_destroy
197
+
198
+ if configuration[:fields].respond_to?(:each)
199
+ process_fields(configuration[:fields])
200
+ else
201
+ process_fields(self.new.attributes.keys.map { |k| k.to_sym })
202
+ process_fields(configuration[:additional_fields])
203
+ end
204
+
205
+ if configuration[:include].respond_to?(:each)
206
+ process_includes(configuration[:include])
207
+ end
208
+
209
+ alias_method_chain :method_missing, :solr_magic
210
+ end
211
+
212
+ private
213
+ def get_field_value(field)
214
+ field_name, options = determine_field_name_and_options(field)
215
+ configuration[:solr_fields][field_name] = options
216
+
217
+ define_method("#{field_name}_for_solr".to_sym) do
218
+ begin
219
+ value = self[field_name] || self.instance_variable_get("@#{field_name.to_s}".to_sym) || self.send(field_name.to_sym)
220
+ case options[:type]
221
+ # format dates properly; return nil for nil dates
222
+ when :date
223
+ value ? (value.respond_to?(:utc) ? value.utc : value).strftime("%Y-%m-%dT%H:%M:%SZ") : nil
224
+ else value
225
+ end
226
+ rescue
227
+ puts $!
228
+ logger.debug "There was a problem getting the value for the field '#{field_name}': #{$!}"
229
+ value = ''
230
+ end
231
+ end
232
+ end
233
+
234
+ def process_fields(raw_field)
235
+ if raw_field.respond_to?(:each)
236
+ raw_field.each do |field|
237
+ next if configuration[:exclude_fields].include?(field)
238
+ get_field_value(field)
239
+ end
240
+ end
241
+ end
242
+
243
+ def process_includes(includes)
244
+ if includes.respond_to?(:each)
245
+ includes.each do |assoc|
246
+ field_name, options = determine_field_name_and_options(assoc)
247
+ configuration[:solr_includes][field_name] = options
248
+ end
249
+ end
250
+ end
251
+
252
+ def determine_field_name_and_options(field)
253
+ if field.is_a?(Hash)
254
+ name = field.keys.first
255
+ options = field.values.first
256
+ if options.is_a?(Hash)
257
+ [name, {:type => type_for_field(field)}.merge(options)]
258
+ else
259
+ [name, {:type => options}]
260
+ end
261
+ else
262
+ [field, {:type => type_for_field(field)}]
263
+ end
264
+ end
265
+
266
+ def type_for_field(field)
267
+ if configuration[:facets] && configuration[:facets].include?(field)
268
+ :facet
269
+ elsif column = columns_hash[field.to_s]
270
+ case column.type
271
+ when :string then :text
272
+ when :datetime then :date
273
+ when :time then :date
274
+ else column.type
275
+ end
276
+ else
277
+ :text
278
+ end
279
+ end
280
+ end
281
+ end