nxa-sunspot 0.10.7

data/History.txt

@@ -0,0 +1,153 @@
+== 0.10.7 2009-11-16
+* Ignore boost_fields that don't apply
+* Ability to specify text_fields inside connectives
+* Fix bug with newlines in strings incorrectly being considered multi-value
+* Compatibility with RSolr 0.10.1
+* Remove commented-out code entirely
+
+== 0.10.6 2009-11-05
+* Support more dismax parameters
+* Support multiple boost queries
+* Allow "extra" facet rows
+* Allow exclusion of fulltext fields
+* Allow specification of per-field highlighting params
+* Specify coordinates using block extraction
+* Return empty array if no highlights available
+* Get stored text fields from hits
+* Update docs to reflect a requirement of at least one search type
+* added --max-memory and --min-memory parameters to sunspot-solr
+* LocalLucene and LocalSolr compatible with Java 1.5
+
+== 0.10.5 2009-10-22
+* Fix highlighting for multiple-model search
+
+== 0.10.4 2009-10-20
+* Add adjust_params method, allowing experts to manually edit Solr params
+* Track adds and deletes separately in session, and expose delete_dirty? method
+* Allow clients to inject a singleton session proxy
+
+== 0.10.3 2009-10-15
+* Contiguous, not continuous
+* Fail fast if less-than-1 radius passed for local search
+
+== 0.10.2 2009-10-09
+* Add Sunspot.config.xml_builder option, which is passed to RSolr
+
+== 0.10.1 2009-10-08
+* Fix directory bugs in sunspot-solr executable
+
+== 0.10.0 2009-10-08
+* Support for geographical search using LocalSolr
+* Support for keyword highlighting, with custom deferred formatting
+* New fulltext DSL for specifying advanced dismax options
+* Support boost queries
+* Support for search-time field boost
+* Support for phrase fields
+* Support for prefix queries
+* Set default search-time field boost in setup
+* Restrict field facet to a set of desired values
+* Query facets support all facet options
+* Allow scoping by text fields
+* Support executing searches repeatedly
+* Allow setting of Solr URL for integration tests in environment variable
+* Add support for master/slave configurations
+* Added logging options to sunspot-solr executable
+* Added default solr config file location to Sunspot::Configuration
+* Informative, non-firehose Search#inspect
+* No longer require arguments to #paginate
+* Silently ignore keyword calls with nil/blank/whitespace keywords
+* Don't require that all searched types have a referenced field
+* Correct backwards ranges
+* Raise descriptive error if no types passed to search
+* Handle empty query facets, query facet rows, and connectives
+* Quote values in range restrictions if they contain spaces
+* Fix bug in Sunspot::Util.full_const_get
+* Remove support for :other option in time faceting
+* Remove order_by_random() method
+* Removed options and Query from public API
+* Use built-in optparse instead of optiflag in bin/sunspot-solr
+* Remove dependency on haml and use erb since it is only used to generate one file
+
+== 0.9.0 2009-07-21
+* Use Dismax parser for keyword search
+* Field and document boosting
+* Specify which fields to search in keyword search
+* Allow indexing of multiple values in text fields
+* Access keyword relevance score in Hit objects
+* Allow stored fields, retrieve stored values from Hit objects
+* Support more values in shorthand restrictions
+* Disjunctions and conjunctions
+* Random ordering
+* Control all options for field facets
+* Time range facets
+* Get referenced objects from facets on foreign keys
+* Facet by class
+* Batch indexing
+* New Date field type
+* Direct access to data accessors
+* Executable to configure production Solr instances
+* Replace solr-ruby with RSolr
+* Remove accidental ActiveSupport dependency
+
+== 0.8.9 2009-06-23
+* Fix OrderedHash bug in older versions of ActiveSupport
+
+== 0.8.8 2009-06-15
+* Escape type names to support namespaced classes
+* Fix bug with anonymous modules in Ruby 1.9
+
+== 0.8.7 2009-06-10
+* Add --pid-dir option for sunspot-solr executable
+
+== 0.8.5 2009-06-09
+* Added dependencies for sunspot-solr executable to gem dependencies
+* Search for adapters using class ancestors rather than superclasses
+
+== 0.8.3 2009-06-03
+* Index objects passed as a collection in a single HTTP request
+
+== 0.8.2 2009-05-27
+* Allow specification of Solr home when using sunspot-solr
+
+== 0.8.1 2009-05-26
+* Add Search#execute! to public API
+
+== 0.8.0 2009-05-22
+* Access query API directly; instantiate search without running it
+* Dynamic fields
+* Search blocks can be evaluated in calling context
+
+== 0.7.3 2009-05-06
+* Better exception handling when class doesn't have adapter/setup
+
+== 0.7.2 2009-04-29
+* Dirty sessions
+
+== 0.7.1 2009-04-29
+* Removed extlib dependency from gemspec
+
+== 0.7.0 2009-04-28
+* Less magic in the DSL
+* Restrict by empty values
+* Negative scoping using without() method
+* Exclusion by object identity using without(instance)
+* Support for faceting
+* Explicit commits
+* Boolean field type
+* Attribute field flexibility
+* Virtual field blocks can be evaluated in calling context
+* Order available by multiple fields
+* New adapter API
+* Got rid of builder API
+* Full documentation
+
+== 0.0.2 2009-02-14
+* Run sunspot's built-in Solr instance using
+  sunspot-solr executable
+* Search hash interpretation delegated to
+  Builder object
+
+== 0.0.1 2008-12-11
+* Initial release
+* Define indexing for any class using DSL
+* Search indexed classes using DSL

data/LICENSE

@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,191 @@
+= Sunspot
+
+http://outoftime.github.com/sunspot
+
+Sunspot is a Ruby library for expressive, powerful interaction with the Solr search engine.
+Sunspot is built on top of the RSolr gem, which provides a low-level interface for Solr
+interaction; Sunspot provides a simple, intuitive, expressive DSL backed by powerful
+features for indexing objects and searching for them.
+
+Sunspot is designed to be easily plugged in to any ORM, or even non-database-backed
+objects such as the filesystem.
+
+This README is intended as a quick primer on what Sunspot is capable of; for
+detailed treatment of Sunspot's full feature range, check out the wiki:
+http://wiki.github.com/outoftime/sunspot
+
+
+=== Features:
+
+* Define indexing strategy for each searchable class using intuitive block-based API
+* Clean separation between keyword-searchable fields and fields for scoping/ordering
+* Define fields based on existing attributes or "virtual fields" for custom indexing
+* Indexes each object's entire superclass hierarchy, for easy searching for all objects inheriting from a parent class
+* Intuitive DSL for scoping searches, with all the usual boolean operators available
+* Intuitive interface for requesting facets on indexed fields
+* Extensible adapter architecture for easy integration of other ORMs or non-model classes
+* Refine search using field facets, date range facets, or ultra-powerful query facets
+* Full compatibility with will_paginate
+* Ordering
+
+== Installation
+
+  gem install sunspot
+
+In order to start the packaged Solr installation, run:
+
+  sunspot-solr start -- [-d /path/to/data/directory] [-p port] [-s path/to/solr/home] [--pid-dir=path/to/pid/dir]
+
+If you don't specify a data directory, your Solr index will be stored in your operating system's temporary directory.
+
+If you specify a solr home, the directory must contain a <code>conf</code>
+directory, which should contain at least <code>schema.xml</code> and
+<code>solrconfig.xml</code>. Be sure to copy the <code>schema.xml</code> out of
+the Sunspot gem's <code>solr/solr/conf</code> directory. Sunspot relies on the
+field name patterns defined in the packaged <code>schema.xml</code>, so those
+cannot be modified.
+
+You can also run your own instance of Solr wherever you'd like; just copy the solr/config/schema.xml file out of the gem's solr into your installation.
+You can change the URL at which Sunspot accesses Solr with:
+
+  Sunspot.config.solr.url = 'http://solr.my.host:9818/solr'
+
+== Rails Integration
+
+The {Sunspot::Rails}[http://github.com/outoftime/sunspot_rails] plugin makes
+integrating Sunspot into Rails drop-in easy.
+
+== Using Sunspot
+
+=== Define an index:
+
+  class Post
+    #...
+  end
+
+  Sunspot.setup(Post) do
+    text :title, :body
+    string :author_name
+    integer :blog_id
+    integer :category_ids
+    float :average_rating, :using => :ratings_average
+    time :published_at
+    string :sort_title do
+      title.downcase.sub(/^(an?|the)\W+/, ''/) if title = self.title
+    end
+  end
+
+See Sunspot.setup for more information.
+
+Note that in order for a class to be searchable, it must have an adapter
+registered for itself or one of its subclasses. Adapters allow Sunspot to load
+objects out of persistent storage, and to determine their primary key for
+indexing. {Sunspot::Rails}[http://github.com/outoftime/sunspot_rails] comes with
+an adapter for ActiveRecord objects, but for other types of models you will need
+to define your own. See Sunspot::Adapters for more information.
+
+=== Search for objects:
+  
+  search = Sunspot.search Post do
+    keywords 'great pizza'
+    with :author_name, 'Mark Twain'
+    with(:blog_id).any_of [2, 14]
+    with(:category_ids).all_of [4, 10]
+    with(:published_at).less_than Time.now
+    any_of do
+      with(:expired_at).greater_than(Time.now)
+      with(:expired_at, nil)
+    end
+    without :title, 'Bad Title'
+    without bad_instance # specifically exclude this instance from results
+
+    paginate :page => 3, :per_page => 15
+    order_by :average_rating, :desc
+
+    facet :blog_id
+  end
+
+See Sunspot.search for more information.
+
+=== Get data from search:
+
+  search.results
+  search.total
+  search.page
+  search.per_page
+  search.facet(:blog_id)
+
+== About the API documentation
+
+All of the methods documented in the RDoc are considered part of Sunspot's
+public API. Methods that are not part of the public API are documented in the
+code, but excluded from the RDoc. If you find yourself needing to access methods
+that are not part of the public API in order to do what you need, please contact
+me so I can rectify the situation!
+
+== Dependencies
+
+1. RSolr 0.10.1
+2. Daemons 1.x
+4. Java 1.5+
+
+Sunspot has been tested with MRI 1.8.6 and 1.8.7, REE 1.8.6, YARV 1.9.1, and
+JRuby 1.2.0
+
+== Bugs
+
+Please submit bug reports to
+http://outoftime.lighthouseapp.com/projects/20339-sunspot
+
+== Contribution Guidelines
+
+Contributions are very welcome - both new features, enhancements, and bug fixes.
+Bug reports with a failing regression test are also lovely. In order to keep the
+contribution process as organized and smooth as possible, please follow these
+guidelines:
+
+* Contributions should be submitted via Sunspot's Lighthouse account, with an
+  attached git patch. See below for how to create a git patch.
+* Patches should not make any changes in your patch to the gemspec task other
+  than adding/removing dependencies (e.g., changing the name, version, email,
+  description, etc.)
+* Patches should not include any changes to the gemspec itself.
+* Document any new methods, options, arguments, etc.
+* Write tests.
+* As much as possible, follow the coding and testing styles you see in existing
+  code. One could accuse me of being nitpicky about this, but consistent code is
+  easier to read, maintain, and enhance.
+* Don't make any massive changes to the structure of library or test code. If
+  you think something needs a huge refactor or rearrangement, shoot me a
+  message; trying to apply that kind of patch without warning opens the door to
+  a world of conflict hurt.
+
+Here's how to create a Git patch - assuming you're pulling from the canonical
+Sunspot repository at `upstream`:
+
+  git fetch upstream
+  git format-patch upstre
+
+== Further Reading
+
+* Sunspot Discussion: http://groups.google.com/group/ruby-sunspot
+* IRC: #sunspot-ruby @ Freenode
+* Posts about Sunspot from my tumblog: http://outofti.me/tagged/sunspot
+* Read about it on Linux Magazine: http://www.linux-mag.com/id/7341
+
+== Contributors
+
+* Mat Brown (mat@patch.com)
+* Peer Allan (peer.allan@gmail.com)
+* Dmitriy Dzema (dima@dzema.name)
+* Benjamin Krause (bk@benjaminkrause.com)
+* Marcel de Graaf (marcel@slashdev.nl)
+* Brandon Keepers (brandon@opensoul.org)
+* Peter Berkenbosch (peterberkenbosch@me.com)
+* Brian Atkinson
+* Tom Coleman (tom@thesnail.org)
+* Matt Mitchell (goodieboy@gmail.com)
+
+== License
+
+Sunspot is distributed under the MIT License, copyright (c) 2008-2009 Mat Brown

data/Rakefile

@@ -0,0 +1,9 @@
+ENV['RUBYOPT'] = '-W1'
+
+task :environment do
+  require File.dirname(__FILE__) + '/lib/sunspot'
+end
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => 'spec:api'

data/TODO

@@ -0,0 +1,14 @@
+=== 0.10.x ===
+* Can retrieve facets from search via string
+* Allow #latitude and #longitude as coordinate attributes
+* Allow use of #text_fields from inside disjunction
+
+* Assumed inconsistency
+* Support all operations in batches. Make it smart.
+  * Don't use more than one commits when one is equivalent
+  * Preserve adds/deletes that are done after last commit
+  * Don't do adds and deletes for the same document out of order
+  * Don't do more than one add for the same document
+  * Do use as few requests as possible within those constraints
+=== Future ===
+* Support Solr functions (e.g. dismax :bf)

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 10
+:patch: 7
+:major: 0

data/bin/sunspot-configure-solr

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'optparse'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'sunspot', 'schema')
+
+solr_directory = FileUtils.pwd
+
+schema = Sunspot::Schema.new
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: sunspot-configure-solr [options]'
+
+  opts.on '--tokenizer=TOKENIZER', 'Tokenizer class to use' do |tokenizer|
+    schema.tokenizer = tokenizer
+  end
+
+  opts.on '--extra-filter=EXTRA_FILTER', 'Extra filters for tokenized text (you may specify this multiple times)' do |extra_filter|
+    schema.add_filter(extra_filter)
+  end
+
+  opts.on '--dir=CONF_DIR', 'Directory containing Solr configuration and schema' do |dir|
+    solr_directory = File.expand_path(dir)
+  end
+end.parse!
+
+conf_directory = File.join(solr_directory, 'conf')
+schema_file = File.join(conf_directory, 'schema.xml')
+
+FileUtils.mkdir_p(conf_directory)
+
+if File.exist?(schema_file)
+  backup_file = File.join(conf_directory, "schema-#{File.mtime(schema_file).strftime('%Y%m%d%H%M%S')}.xml")
+  STDERR.puts("Backing up current schema file to #{File.expand_path(backup_file)}")
+  FileUtils.mv(schema_file, backup_file)
+end
+
+File.open(File.join(conf_directory, 'schema.xml'), 'w') do |file|
+  file << schema.to_xml
+end

data/bin/sunspot-solr

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+using_gems = false
+begin
+  require 'fileutils'
+  require 'tempfile'
+  require 'tmpdir'
+  require 'optparse'
+  require 'daemons'
+rescue LoadError => e
+  if using_gems
+    raise(e)
+  else
+    using_gems = true
+    require 'rubygems'
+    retry
+  end
+end
+
+working_directory = FileUtils.pwd
+solr_install = File.expand_path(File.join(File.dirname(__FILE__), '..', 'solr'))
+
+port        = '8983'
+data_dir    = File.expand_path(File.join(Dir.tmpdir, 'solr_data'))
+solr_home   = File.join(solr_install, 'solr')
+pid_dir     = working_directory
+log_file    = nil
+log_level   = 'OFF'
+min_memory  = '128m'
+max_memory  = '512m'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: sunspot-solr start [options]"
+
+  opts.on '-p', '--port=PORT', 'Port on which to run Solr (default 8983)' do |p|
+    port = p
+  end
+
+  opts.on '-d', '--data-directory=DIRECTORY', 'Solr data directory' do |d|
+    data_dir = File.expand_path(d)
+  end
+
+  opts.on '-s', '--solr-home=HOME', 'Solr home directory (should contain conf/ directory)' do |s|
+    solr_home = File.expand_path(s)
+  end
+
+  opts.on '--pid-dir=PID_DIR', 'Directory for pid files' do |pd|
+    pid_dir = File.expand_path(pd)
+  end
+
+  opts.on '-l', '--log-level=LOG_LEVEL', 'Solr logging level' do |l|
+    log_level = l
+  end
+
+  opts.on '--log-file=LOG_FILE', 'Path to Solr log file' do |lf|
+    log_file = File.expand_path(lf)
+  end
+  
+  opts.on '--max-memory=MEMORY', 'Specify the maximum size of the memory allocation pool' do |mm|
+    max_memory = mm
+  end
+  
+  opts.on '--min-memory=MEMORY', 'Specify the initial size of the memory allocation pool' do |mm|
+    min_memory = mm
+  end
+end.parse!
+
+options = { :dir_mode => :normal, :dir => pid_dir }
+
+def logging_properties( log_file, log_level )
+  temp_file = Tempfile.new 'logging.properties'
+  temp_file << <<PROPERTIES
+.level = #{log_level}
+handlers = java.util.logging.FileHandler
+java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
+java.util.logging.FileHandler.pattern   = #{log_file}
+PROPERTIES
+  temp_file.flush
+  temp_file.close
+  temp_file.path
+end
+
+Daemons.run_proc('sunspot-solr', options) do
+  FileUtils.cd(solr_install) do
+    args = ['java']
+    args << "-Xms#{min_memory}"
+    args << "-Xmx#{max_memory}"
+    args << "-Djetty.port=#{port}" if port
+    args << "-Dsolr.data.dir=#{data_dir}" if data_dir
+    args << "-Dsolr.solr.home=#{solr_home}" if solr_home
+    args << "-Djava.util.logging.config.file=#{logging_properties(log_file, log_level)}" if log_file and log_level != 'OFF'
+    args << '-jar' << File.join(solr_install, 'start.jar')
+    STDERR.puts(args * ' ')
+    Kernel.exec(*args)
+  end
+end