greglu-solr-ruby 0.0.7

data/CHANGES.yml

@@ -0,0 +1,50 @@
+v0.0.8:
+  release_date: TBD
+  changes:
+    - Updated Solr::Request::Standard to use modern style sort parameter rather
+    
+v0.0.7:
+  release_date: 2009-03-06
+  changes:
+    - Fixed string parameters with carriage returns in Solr::Request::Select (due to String.each pain)
+    - SOLR-1047 - added support for facet.method
+
+v0.0.6:
+  release_date: 2008-07-14
+  changes:
+    - Added Solr::Request::Spellcheck
+    - Enabled Solr::Request::Select to work as a general pass through to any registered request handler
+    - Fixed modify_document_test.rb so as to not be brittle with Hash ordering
+    - Added support for alternate field highlighting to Solr::Request::Standard (and thus DisMax)
+    - Added facet.offset support to Solr::Request::Standard/Dismax
+    - Added shards parameter to Solr::Request::Standard/Dismax
+  
+v0.0.5:
+  release_date: 2007-08-27
+  changes:
+    - Added support for highlighter fragment size to Solr::Request::Standard
+    - Added support for MoreLikeThese to Solr::Request::Standard
+    - Added Solr::Request::ModifyDocument (requires SOLR-139 patch)
+    - Added Solr::Util.query_parser_escape()
+
+v0.0.4:
+  release_date: 2007-08-16
+  changes:
+    - Solr::Indexer#solr added to gain access to the Solr::Connection instance
+    - Fixed issue with multi-line String field values when field set multiValued="false"
+    - Fixed tests to work without either Hpricot or libxml2
+      
+v0.0.3:
+  release_date: 2007-05-22
+  changes:
+    - Adjusted HpricotMapper and XPathMapper, and tests, to load only if their dependencies are available.
+
+v0.0.2:
+  release_date: 2007-05-15
+  changes:
+    - mappers, etc
+
+v0.0.1: 
+  release_date: 2007-02-15
+  changes:
+    - initial release

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README

@@ -0,0 +1,56 @@
+solr-ruby exposes the power of Solr as a Ruby  DSL (domain specific language).
+
+  Visit the solr-ruby wiki for more information: http://wiki.apache.org/solr/solr-ruby
+
+USAGE 
+
+First launch Solr:
+
+  cd solr
+  java -jar start.jar
+
+In a separate shell, launch {{{irb -Ilib}}}:
+
+  require 'solr'  # load the library
+  include Solr    # Allow Solr:: to be omitted from class/module references
+
+  # connect to the solr instance
+  conn = Connection.new('http://localhost:8983/solr', :autocommit => :on)
+
+  # add a document to the index
+  conn.add(:id => 123, :title_text => 'Lucene in Action')
+
+  # update the document
+  conn.update(:id => 123, :title_text => 'Solr in Action')
+
+  # print out the first hit in a query for 'action'
+  response = conn.query('action')
+  print response.hits[0]
+
+  # iterate through all the hits for 'action'
+  conn.query('action') do |hit|
+    puts hit.inspect
+  end
+
+  # delete document by id
+  conn.delete(123)
+
+INSTALLATION
+
+First run the tests:
+
+  rake
+  
+then build the gem:
+
+  rake package
+
+and install the versioned gem:
+
+  gem install pkg/solr-x.x.x.gem 
+
+LICENSE
+
+This package is licensed using the Apache Software License 2.0.
+
+<http://www.apache.org/licenses/LICENSE-2.0>

data/Rakefile

@@ -0,0 +1,190 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# the default task is to run both the unit and functional tests
+# functional tests require that a solr test server is running
+# but this Rakefil should take care of starting and stopping it 
+# for you
+# 
+# if you just want to run unit tests:
+#
+#    rake test_units
+#
+# and if you just want to run functional tests
+#
+#    rake test_functionals
+#
+# if you would like to see solr startup messages on STDERR
+# when starting solr test server during functional tests use:
+# 
+#    rake SOLR_CONSOLE=true
+
+SOLR_RUBY_VERSION = '0.0.7'
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'test/functional/test_solr_server'
+
+task :default => [:test_units]
+
+SOLR_PARAMS = {
+  :quiet => ENV['SOLR_CONSOLE'] ? false : true,
+  :jetty_home => ENV['SOLR_JETTY_HOME'] || File.expand_path('../../../example'),
+  :jetty_port => ENV['SOLR_JETTY_PORT'] || 8888,
+  :solr_home => ENV['SOLR_HOME'] || File.expand_path('test')
+}
+
+
+spec = Gem::Specification.new do |s|
+  s.name = 'solr-ruby'
+  s.version = SOLR_RUBY_VERSION
+  s.author = 'Apache Solr'
+  s.email = 'ruby-dev@lucene.apache.org'
+  s.homepage = 'http://wiki.apache.org/solr/solr-ruby'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Ruby library for working with Apache Solr'
+  
+  # Omit functional tests from gem for now, as that requires a Solr instance
+  s.files = Dir.glob("lib/**/*").concat(Dir.glob("test/unit/**/*"))
+  s.require_path = 'lib'
+  s.autorequire = 'solr'
+  s.has_rdoc = true
+end
+
+namespace :gem do
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+    pkg.package_dir = "pkg/gem"
+  end
+end
+
+namespace :rails do
+  desc "Creates rails plugin structure and distributable packages. init.rb is created and removed on the fly."
+  task :package => "init.rb" do
+    File.rm_f("init.rb")
+  end
+  Rake::PackageTask.new("solr-ruby-rails", SOLR_RUBY_VERSION) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+    pkg.package_dir = "pkg/rails"
+    pkg.package_files.include("lib/**/*.rb", "test/unit/**/*.rb", "init.rb", "LICENSE.txt", "README")
+  end
+  
+  file "init.rb" do
+    open("init.rb", "w") do |file|
+      file.puts LICENSE
+      file.puts "require 'solr.rb'"
+    end
+  end
+  
+  desc "Install the Rails plugin version into the vendor/plugins dir. Need to set PLUGINS_DIR environment variable."
+  task :install_solr_ruby => :package do
+    plugins_dir = ENV["PLUGINS_DIR"] or raise "You must set PLUGINS_DIR"
+    mkdir File.join(plugins_dir, "solr-ruby-rails-#{SOLR_RUBY_VERSION}/") rescue nil
+    File.cp_r(File.join("pkg","rails", "solr-ruby-rails-#{SOLR_RUBY_VERSION}/"), plugins_dir)
+  end
+end
+
+task :package => ["rails:package", "gem:package"]
+task :repackage => [:clobber_package, :package]
+task :clobber_package => ["rails:clobber_package", "gem:clobber_package"] do rm_r "pkg" rescue nil end
+task :clobber => [:clobber_package]
+
+desc "Generate rdoc documentation"
+Rake::RDocTask.new('doc') do |rd|
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_files.include('README', 'CHANGES.yml', 'LICENSE.txt')
+  rd.main = 'README'
+  rd.rdoc_dir = 'doc'
+end
+
+desc "Run unit tests"
+Rake::TestTask.new(:test_units) do |t|
+  t.pattern = 'test/unit/*_test.rb'
+  t.verbose = true
+  t.ruby_opts = ['-r solr', '-r test/unit', '-Itest/unit']
+end
+
+# NOTE: test_functionals does not work standalone currently.  It needs the TestSolrServer wrapper in the :test task
+Rake::TestTask.new(:test_functionals) do |t|
+  t.pattern = 'test/functional/*_test.rb'
+  t.verbose = true
+  t.ruby_opts = ['-r solr', '-r test/unit', '-Itest/functional']
+end
+
+desc "Run unit and functional tests"
+task :test => [:test_units] do
+  rm_rf "test/data"  # remove functional test temp data directory
+  
+  # wrap functional tests with a test-specific Solr server
+  got_error = TestSolrServer.wrap(SOLR_PARAMS) do
+    Rake::Task[:test_functionals].invoke 
+  end
+
+  raise "test failures" if got_error
+end
+
+# TODO: consider replacing system() to rcov with the included
+#       Rake task: http://eigenclass.org/hiki.rb?cmd=view&p=rcov+FAQ&key=rake
+namespace :test do
+  desc 'Measures test coverage'
+  # borrowed from here: http://clarkware.com/cgi/blosxom/2007/01/05#RcovRakeTask
+  task :coverage do
+    rm_rf "coverage"
+    rm_rf "coverage.data"
+    TestSolrServer.wrap(SOLR_PARAMS) do
+      system("rcov --aggregate coverage.data --text-summary -Ilib:test/functional test/functional/*_test.rb")
+    end
+    system("rcov --aggregate coverage.data --text-summary -Ilib:test/unit test/unit/*_test.rb")
+    system("open coverage/index.html") if PLATFORM['darwin']
+  end
+end
+
+
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+        count += 1
+        if line =~ pattern
+          puts "#{fn}:#{count}:#{line}"
+        end
+      end
+    end
+  end
+end
+
+desc "Report TODO/FIXME/TBD tags in the code"
+task :todo do
+  egrep /#.*(FIXME|TODO|TBD)/
+end
+
+LICENSE = <<STR
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+STR