tanning_bed 0.1.1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+vendor/solr/solr/data/*
+vendor/solr/logs/*
+!vendor/solr/logs/.keep
+vendor/solr/tmp
+spec/tmp/*

data/History.txt

@@ -0,0 +1,24 @@
+== 0.0.8 / 2008-12-31
+
+* Version bump
+
+== 0.0.7 / 2008-12-22
+
+* Better solr_reindex method.  Now clears all previously indexed items first
+
+== 0.0.6 / 2008-12-22
+
+* Solid exception handling with new on_solr_exception hook
+
+== 0.0.5 / 2008-12-21
+
+* Minor updates and fixes
+* Easier to set sorl_connection
+
+== 0.0.3 / 2008-12-16
+
+* Added solr_reindex and solr_load class methods
+
+== 0.0.2 / 2008-12-15
+
+* Added Mr Bones rake tasks and a better gemspec

data/Manifest.txt

@@ -0,0 +1,156 @@
+.gitignore
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/tanning_bed.rb
+spec/fixtures/burnt_model.rb
+spec/fixtures/tanning_model.rb
+spec/spec_helper.rb
+spec/tanning_bed_spec.rb
+tanning_bed.gemspec
+tasks/ann.rake
+tasks/bones.rake
+tasks/gem.rake
+tasks/git.rake
+tasks/manifest.rake
+tasks/notes.rake
+tasks/post_load.rake
+tasks/rdoc.rake
+tasks/rubyforge.rake
+tasks/setup.rb
+tasks/solr.rake
+tasks/solr.rb
+tasks/spec.rake
+tasks/svn.rake
+tasks/test.rake
+vendor/solr-ruby/lib/solr.rb
+vendor/solr-ruby/lib/solr/connection.rb
+vendor/solr-ruby/lib/solr/document.rb
+vendor/solr-ruby/lib/solr/exception.rb
+vendor/solr-ruby/lib/solr/field.rb
+vendor/solr-ruby/lib/solr/importer.rb
+vendor/solr-ruby/lib/solr/importer/array_mapper.rb
+vendor/solr-ruby/lib/solr/importer/delimited_file_source.rb
+vendor/solr-ruby/lib/solr/importer/hpricot_mapper.rb
+vendor/solr-ruby/lib/solr/importer/mapper.rb
+vendor/solr-ruby/lib/solr/importer/solr_source.rb
+vendor/solr-ruby/lib/solr/importer/xpath_mapper.rb
+vendor/solr-ruby/lib/solr/indexer.rb
+vendor/solr-ruby/lib/solr/request.rb
+vendor/solr-ruby/lib/solr/request/add_document.rb
+vendor/solr-ruby/lib/solr/request/base.rb
+vendor/solr-ruby/lib/solr/request/commit.rb
+vendor/solr-ruby/lib/solr/request/delete.rb
+vendor/solr-ruby/lib/solr/request/dismax.rb
+vendor/solr-ruby/lib/solr/request/index_info.rb
+vendor/solr-ruby/lib/solr/request/modify_document.rb
+vendor/solr-ruby/lib/solr/request/optimize.rb
+vendor/solr-ruby/lib/solr/request/ping.rb
+vendor/solr-ruby/lib/solr/request/select.rb
+vendor/solr-ruby/lib/solr/request/spellcheck.rb
+vendor/solr-ruby/lib/solr/request/standard.rb
+vendor/solr-ruby/lib/solr/request/update.rb
+vendor/solr-ruby/lib/solr/response.rb
+vendor/solr-ruby/lib/solr/response/add_document.rb
+vendor/solr-ruby/lib/solr/response/base.rb
+vendor/solr-ruby/lib/solr/response/commit.rb
+vendor/solr-ruby/lib/solr/response/delete.rb
+vendor/solr-ruby/lib/solr/response/dismax.rb
+vendor/solr-ruby/lib/solr/response/index_info.rb
+vendor/solr-ruby/lib/solr/response/modify_document.rb
+vendor/solr-ruby/lib/solr/response/optimize.rb
+vendor/solr-ruby/lib/solr/response/ping.rb
+vendor/solr-ruby/lib/solr/response/ruby.rb
+vendor/solr-ruby/lib/solr/response/select.rb
+vendor/solr-ruby/lib/solr/response/spellcheck.rb
+vendor/solr-ruby/lib/solr/response/standard.rb
+vendor/solr-ruby/lib/solr/response/xml.rb
+vendor/solr-ruby/lib/solr/solrtasks.rb
+vendor/solr-ruby/lib/solr/util.rb
+vendor/solr-ruby/lib/solr/xml.rb
+vendor/solr-ruby/test/unit/add_document_test.rb
+vendor/solr-ruby/test/unit/array_mapper_test.rb
+vendor/solr-ruby/test/unit/changes_yaml_test.rb
+vendor/solr-ruby/test/unit/commit_test.rb
+vendor/solr-ruby/test/unit/connection_test.rb
+vendor/solr-ruby/test/unit/data_mapper_test.rb
+vendor/solr-ruby/test/unit/delete_test.rb
+vendor/solr-ruby/test/unit/delimited_file_source_test.rb
+vendor/solr-ruby/test/unit/dismax_request_test.rb
+vendor/solr-ruby/test/unit/document_test.rb
+vendor/solr-ruby/test/unit/field_test.rb
+vendor/solr-ruby/test/unit/hpricot_mapper_test.rb
+vendor/solr-ruby/test/unit/hpricot_test_file.xml
+vendor/solr-ruby/test/unit/indexer_test.rb
+vendor/solr-ruby/test/unit/modify_document_test.rb
+vendor/solr-ruby/test/unit/ping_test.rb
+vendor/solr-ruby/test/unit/request_test.rb
+vendor/solr-ruby/test/unit/response_test.rb
+vendor/solr-ruby/test/unit/select_test.rb
+vendor/solr-ruby/test/unit/solr_mock_base.rb
+vendor/solr-ruby/test/unit/spellcheck_response_test.rb
+vendor/solr-ruby/test/unit/spellchecker_request_test.rb
+vendor/solr-ruby/test/unit/standard_request_test.rb
+vendor/solr-ruby/test/unit/standard_response_test.rb
+vendor/solr-ruby/test/unit/suite.rb
+vendor/solr-ruby/test/unit/tab_delimited.txt
+vendor/solr-ruby/test/unit/util_test.rb
+vendor/solr-ruby/test/unit/xpath_mapper_test.rb
+vendor/solr-ruby/test/unit/xpath_test_file.xml
+vendor/solr/CHANGES.txt
+vendor/solr/LICENSE.txt
+vendor/solr/NOTICE.txt
+vendor/solr/etc/jetty.xml
+vendor/solr/etc/webdefault.xml
+vendor/solr/lib/commons-codec-1.3.jar
+vendor/solr/lib/commons-csv-0.1-SNAPSHOT.jar
+vendor/solr/lib/commons-fileupload-1.2.jar
+vendor/solr/lib/commons-io-1.2.jar
+vendor/solr/lib/easymock.jar
+vendor/solr/lib/jetty-6.1.3.jar
+vendor/solr/lib/jetty-util-6.1.3.jar
+vendor/solr/lib/jsp-2.1/ant-1.6.5.jar
+vendor/solr/lib/jsp-2.1/core-3.1.1.jar
+vendor/solr/lib/jsp-2.1/jsp-2.1.jar
+vendor/solr/lib/jsp-2.1/jsp-api-2.1.jar
+vendor/solr/lib/lucene-analyzers-2007-05-20_00-04-53.jar
+vendor/solr/lib/lucene-core-2007-05-20_00-04-53.jar
+vendor/solr/lib/lucene-highlighter-2007-05-20_00-04-53.jar
+vendor/solr/lib/lucene-snowball-2007-05-20_00-04-53.jar
+vendor/solr/lib/lucene-spellchecker-2007-05-20_00-04-53.jar
+vendor/solr/lib/servlet-api-2.4.jar
+vendor/solr/lib/servlet-api-2.5-6.1.3.jar
+vendor/solr/lib/xpp3-1.1.3.4.O.jar
+vendor/solr/logs/.keep
+vendor/solr/solr/README.txt
+vendor/solr/solr/bin/abc
+vendor/solr/solr/bin/abo
+vendor/solr/solr/bin/backup
+vendor/solr/solr/bin/backupcleaner
+vendor/solr/solr/bin/commit
+vendor/solr/solr/bin/optimize
+vendor/solr/solr/bin/readercycle
+vendor/solr/solr/bin/rsyncd-disable
+vendor/solr/solr/bin/rsyncd-enable
+vendor/solr/solr/bin/rsyncd-start
+vendor/solr/solr/bin/rsyncd-stop
+vendor/solr/solr/bin/scripts-util
+vendor/solr/solr/bin/snapcleaner
+vendor/solr/solr/bin/snapinstaller
+vendor/solr/solr/bin/snappuller
+vendor/solr/solr/bin/snappuller-disable
+vendor/solr/solr/bin/snappuller-enable
+vendor/solr/solr/bin/snapshooter
+vendor/solr/solr/conf/admin-extra.html
+vendor/solr/solr/conf/protwords.txt
+vendor/solr/solr/conf/schema.xml
+vendor/solr/solr/conf/scripts.conf
+vendor/solr/solr/conf/solrconfig.xml
+vendor/solr/solr/conf/stopwords.txt
+vendor/solr/solr/conf/synonyms.txt
+vendor/solr/solr/conf/xslt/example.xsl
+vendor/solr/solr/conf/xslt/example_atom.xsl
+vendor/solr/solr/conf/xslt/example_rss.xsl
+vendor/solr/start.jar
+vendor/solr/webapps/solr.war

data/README.rdoc

@@ -0,0 +1,103 @@
+tanning_bed
+    by Rob Kaufman (notch8.com)
+    with permission and support from the Assay Depot (assaydepot.com)
+
+== DESCRIPTION:
+
+Tanning Bed is Solr for models.
+Tanning Bed provides a Ruby interface for the Solr (http://lucene.apache.org/solr/) search engine to use in you're models not matter whether they are Datamapper, Active Record, Couchrest or just general Ruby classes.
+
+== FEATURES/PROBLEMS:
+
+* Incredibly simple in design, no fancy hooks
+* Very Ruby
+* {Ruby 1.9 Compatible}[http://notch8.github.com/files/Ruby19Badge.png]
+
+== SYNOPSIS:
+
+=== Setup
+  Using TanningBed for a given class involves including the TanningBed model and then implementing a few (easy) methods.
+   
+  Objects must implement:
+  
+  * id - unique identifier for the record
+  * Class.get - this method receives and object's id and loads it
+  * solr_keys - an array of method names, the method results will be added to the index
+
+==== Examples
+
+===== CouchRest
+  id is already implemented and so is get.  CouchRest has a method called keys which we'll use
+  
+    class MyDocument < CouchRest::Model
+      include TanningBed
+      
+      key_accessor :name
+      key_accessor :address
+      
+      def solr_keys
+        keys
+      end
+  
+===== ActiveRecord
+
+  id is implemented in ActiveRecord already
+  
+   class MyModel < ActiveRecord::Base
+     include TanningBed
+     
+     def get(value)
+       find(value)
+     end
+     
+     def solr_keys
+       attribute_names
+     end
+   end
+
+=== Adding, Updating or Deleting
+  Adding a record is accomplished by 
+  
+=== Changing Solr connection
+  To change the url for Solr or to change whether autocommit is on or not add the following to you're instantiation (for example config/enviroments/production.rb) 
+  
+   TanningBed.solr_connection(YOUR_SOLR_URL, :off)
+   
+=== Handling connection issues
+  Only you can decide the best way to handle Solr exceptions in your application.  TanningBed provides a simple hook to allow you to do just that.  By default connection exceptions (Errno::ECONNREFUSED) in TanningBed methods simply output to STDERR.  This isn't really sufficient unless you're watching STDERR on you're application for problems.  A common thing to want to do is simply be notified of the error while failing silently.  To do that you might setup something like this: 
+  
+   TanningBed.on_solr_exception = Proc.new {|e| deliver_solr_down_email(e) } 
+   
+== REQUIREMENTS:
+
+* Solr (bundled)
+* Solr-Ruby library (bundled)
+
+== INSTALL:
+
+* sudo gem install notch8-tanning-bed --source http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Assay Depot Inc.
+
+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.txt

@@ -0,0 +1,103 @@
+tanning_bed
+    by Rob Kaufman (notch8.com)
+    with permission and support from the Assay Depot (assaydepot.com)
+
+== DESCRIPTION:
+
+Tanning Bed is Solr for models.
+Tanning Bed provides a Ruby interface for the Solr (http://lucene.apache.org/solr/) search engine to use in you're models not matter whether they are Datamapper, Active Record, Couchrest or just general Ruby classes.
+
+== FEATURES/PROBLEMS:
+
+* Incredibly simple in design, no fancy hooks
+* Very Ruby
+* {Ruby 1.9 Compatible}[http://notch8.github.com/files/Ruby19Badge.png]
+
+== SYNOPSIS:
+
+=== Setup
+  Using TanningBed for a given class involves including the TanningBed model and then implementing a few (easy) methods.
+   
+  Objects must implement:
+  
+  * id - unique identifier for the record
+  * Class.get - this method receives and object's id and loads it
+  * solr_keys - an array of method names, the method results will be added to the index
+
+==== Examples
+
+===== CouchRest
+  id is already implemented and so is get.  CouchRest has a method called keys which we'll use
+  
+    class MyDocument < CouchRest::Model
+      include TanningBed
+      
+      key_accessor :name
+      key_accessor :address
+      
+      def solr_keys
+        keys
+      end
+  
+===== ActiveRecord
+
+  id is implemented in ActiveRecord already
+  
+   class MyModel < ActiveRecord::Base
+     include TanningBed
+     
+     def get(value)
+       find(value)
+     end
+     
+     def solr_keys
+       attribute_names
+     end
+   end
+
+=== Adding, Updating or Deleting
+  Adding a record is accomplished by 
+  
+=== Changing Solr connection
+  To change the url for Solr or to change whether autocommit is on or not add the following to you're instantiation (for example config/enviroments/production.rb) 
+  
+   TanningBed.solr_connection(YOUR_SOLR_URL, :off)
+   
+=== Handling connection issues
+  Only you can decide the best way to handle Solr exceptions in your application.  TanningBed provides a simple hook to allow you to do just that.  By default connection exceptions (Errno::ECONNREFUSED) in TanningBed methods simply output to STDERR.  This isn't really sufficient unless you're watching STDERR on you're application for problems.  A common thing to want to do is simply be notified of the error while failing silently.  To do that you might setup something like this: 
+  
+   TanningBed.on_solr_exception = Proc.new {|e| deliver_solr_down_email(e) } 
+   
+== REQUIREMENTS:
+
+* Solr (bundled)
+* Solr-Ruby library (bundled)
+
+== INSTALL:
+
+* sudo gem install notch8-tanning-bed --source http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Assay Depot Inc.
+
+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/Rakefile

@@ -0,0 +1,29 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+
+ensure_in_path 'lib'
+require 'tanning_bed'
+
+task :default => 'spec:run'
+
+Bones {
+  name  'tanning_bed'
+  authors  'Rob Kaufman'
+  email    'rob@notch8.com'
+  url      'http://notch8.com'
+  rubyforge.name = 'tanning_bed'
+  spec.opts << '--color'
+  depend_on 'solr-ruby', '0.0.8'
+  depend_on 'tanning_bed_solr', :development => true
+}
+
+
+# EOF

data/lib/tanning_bed.rb

@@ -0,0 +1,205 @@
+__DIR__ = File.dirname(__FILE__) + "/"
+begin
+  require 'solr'
+rescue LoadError
+  require 'rubygems'
+  require 'solr'
+end
+
+# $Id$
+
+# Equivalent to a header guard in C/C++
+# Used to prevent the class/module from being loaded more than once
+unless defined? TanningBed
+
+module TanningBed
+  module ClassMethods
+    def solr_search(query_string, options={})
+      TanningBed.solr_connection.query(query_string + " AND type_t:#{self}", options)
+    rescue Errno::ECONNREFUSED => e
+      TanningBed.solr_exception(e)      
+    end
+    
+    def solr_load(results)
+      key_set = results.collect do |result|
+        key = result["search_id"].first.split(" ")
+        next if key[0] != self.to_s
+        Kernel.const_get(key[0]).send(:get, key[1])
+      end
+      key_set.delete(nil)
+      return key_set
+    end
+    
+    def solr_reindex
+      # Remove all the old entries for this class
+      TanningBed.solr_connection.delete_by_query(self.to_s)
+      
+      #Add all the current records into the index
+      self.all.each do |item|
+        item.solr_add
+      end
+    end
+  end
+  
+  def self.included(base)
+    @@conn = nil
+    @@on_solr_exception = nil
+    base.extend(ClassMethods)
+  end
+  
+  # connect to the solr instance
+  def self.solr_connection(url='http://localhost:8983/solr', autocommit=:on, reset=false)
+    if reset
+      @@conn = Solr::Connection.new(url, :autocommit => autocommit) 
+    else
+      @@conn ||= Solr::Connection.new(url, :autocommit => autocommit)
+    end
+  end  
+  
+  def self.solr_exception(e)
+    if TanningBed.on_solr_exception
+      TanningBed.on_solr_exception.call(e)
+    else
+      $stderr.puts("SOLR - " + e.to_s)
+    end
+  end
+  
+  def self.on_solr_exception
+    @@on_solr_exception
+  end
+  
+  def self.on_solr_exception=(value)
+    @@on_solr_exception = value
+  end
+  
+  def solr_id
+    "#{self.class} #{self.id}"
+  end
+
+  # add a document to the index
+  def solr_add
+    TanningBed.solr_connection.add(search_fields)
+  rescue Errno::ECONNREFUSED => e
+    TanningBed.solr_exception(e)
+  end
+
+  def solr_update
+    TanningBed.solr_connection.update(search_fields)
+  rescue Errno::ECONNREFUSED => e
+    TanningBed.solr_exception(e)
+  end
+
+  def self.solr_search(query_string, options={})
+    TanningBed.solr_connection.query(query_string, options)
+  rescue Errno::ECONNREFUSED => e
+    TanningBed.solr_exception(e)
+  end
+  
+  def self.solr_load(results)
+    key_set = results.collect do |result|
+      key = result["search_id"].first.split(" ")
+      Kernel.const_get(key[0]).send(:get, key[1])
+    end
+    return key_set
+  end
+
+  def solr_delete
+    TanningBed.solr_connection.delete(solr_id)
+  rescue Errno::ECONNREFUSED => e
+    TanningBed.solr_exception(e)
+  end
+
+  def solr_keys
+    raise "You must define the method solr_keys in the class you want to use for Solr.\n  This should return an array of method names to call on you're class for indexing\n eg: ['id', 'name', 'description']"
+  end
+  
+  def search_fields
+    @fields = {}
+    self.solr_keys.each do |key|
+      if self.respond_to?(key)
+        value = self.send(key)
+        key_type = lookup_key_type(key, value.class)        
+        @fields["#{key}#{key_type}"] = value
+      end
+    end
+    @fields[:search_id] = solr_id
+    @fields[:type_t] = self.class.to_s
+    @fields[:id_t] = self.id
+    return @fields
+  end
+
+  def lookup_key_type(key, klass)
+    # is the key already in the correct_format?
+    key_postfix = key.split("_").last
+    return nil if ["i", "facet", "t", "f", "d", "mv"].include?(key_postfix)
+    
+    # Add the helper to the key string
+    case klass.to_s
+    when "Fixnum"
+      "_i"
+    when "String"
+      if key.size < 255
+        "_facet"
+      else
+        "_t"
+      end
+    when "Float"
+      "_f"
+    when "Date", "Datetime", "Time"
+      "_d"
+    when "Array"
+      "_s_mv"
+    else
+      "_t"
+    end
+  end
+
+
+  # :stopdoc:
+  VERSION = '0.0.11'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, *args)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, *args)
+  end
+
+  # Utility method used to rquire all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module TanningBed
+
+TanningBed.require_all_libs_relative_to __FILE__
+
+end  # unless defined?
+
+# EOF

data/spec/fixtures/burnt_model.rb

@@ -0,0 +1,22 @@
+class BurntModel
+  include TanningBed
+  attr_accessor :name, :description
+
+  def initialize
+    @name = "Big Bad Voodoo Daddy"
+    @description = "Not really that bad after all."
+  end
+  
+  def id
+    666
+  end
+  
+  def find(value)
+    666
+  end
+  alias :get :find
+
+  def solr_keys
+    ["name", "description"]
+  end
+end

data/spec/fixtures/tanning_model.rb

@@ -0,0 +1,23 @@
+class TanningModel
+  include TanningBed
+  attr_accessor :name, :description, :tan_facet, :keywords
+  def initialize
+    @name        = "Big Bad Voodoo Daddy"
+    @description = "Not really that bad after all."
+    @tan_facet   = "dark"
+    @keywords = ["Record", "stuff", "other"]
+  end
+  
+  def id
+    666
+  end
+
+  def keywords_facet
+    keywords
+  end
+  
+  
+  def solr_keys
+    ["name", "description", "tan_facet", "keywords_facet"]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# $Id$
+require 'spec'
+
+__DIR__ = File.dirname(__FILE__) + "/"
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib tanning_bed]))
+
+require __DIR__ + "fixtures/tanning_model.rb"
+require __DIR__ + "fixtures/burnt_model.rb"
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

data/spec/tanning_bed_spec.rb

@@ -0,0 +1,105 @@
+# $Id$
+require 'open-uri'
+__DIR__ = File.dirname(__FILE__) + "/"
+
+require __DIR__ + 'spec_helper.rb'
+
+describe "TanningBed" do
+  before(:all) do
+    begin
+      open("http://localhost:8984/solr")
+    rescue
+      puts "Solr must be started on port 8984 before you run the specs.  Use rake solr:start SOLR_PORT=8984"
+      exit 1
+    end
+    TanningBed.solr_connection('http://localhost:8984/solr', :on)
+  end
+    
+  before(:each) do
+    @tanning = TanningModel.new
+    @burnt = BurntModel.new
+  end
+  
+  it "should be includeable in a ruby class" do
+    TanningModel.included_modules.should include(TanningBed)
+  end
+  
+  it "should enable adding a record to solr" do
+    @tanning.respond_to?("solr_add").should be_true
+    @tanning.solr_add.should be_true    
+  end
+  
+  it "should enable updating a record in solr" do
+    @tanning.solr_add
+    old_total = TanningBed.solr_connection.query("Big Bad Voodoo Daddy").total_hits
+    @tanning.name = "Joe the Plumber"
+    @tanning.solr_update
+    new_total = TanningBed.solr_connection.query("Big Bad Voodoo Daddy").total_hits
+    new_total.should be_eql(old_total - 1)
+  end
+  
+  it "should enable deleting a record in solr" do
+    @tanning.solr_add
+    old_total = TanningBed.solr_connection.query("Big Bad Voodoo Daddy").total_hits
+    @tanning.solr_delete
+    new_total = TanningBed.solr_connection.query("Big Bad Voodoo Daddy").total_hits
+    new_total.should be_equal(old_total - 1)
+  end
+  
+  it "should enable searching solr for a set of search_ids" do 
+    @tanning.solr_add
+    @burnt.solr_add
+    result = TanningBed.solr_search("Big")
+    result.total_hits.should be_equal(2)
+    result.hits.first["search_id"].should eql(["TanningModel 666"])
+    result.hits.last["search_id"].should eql(["BurntModel 666"])
+  end
+  
+  it "should allow searching for only records of a specific class" do
+    @tanning.solr_add
+    @burnt.solr_add
+    result = TanningModel.solr_search("Big")
+    result.total_hits.should be_equal(1)
+    result.hits.first["search_id"].should eql(["TanningModel 666"])
+  end
+  
+  it "should not add a postfix to a key that is already in the correct format" do
+    ["_i", "_facet", "_t", "_f", "_d"].each do |postfix|
+      @tanning.lookup_key_type("test_#{postfix}", String).should be_nil
+    end
+  end
+  
+  it "should swallow exceptions by default if Solr is down" do
+    tmp_file = __DIR__ + "/tmp/solr_err.tmp"
+    FileUtils.mkdir_p(__DIR__ + "/tmp")
+    TanningBed.solr_connection('http://localhost:9999/solr', :on, true)
+
+    old_err = $stderr
+    $stderr = File.open(tmp_file, "w")
+    TanningBed.solr_search("test")
+    $stderr.flush
+    $stderr.close
+    $stderr = old_err
+    File.open(tmp_file, "r") do |file|
+      file.read.should == "SOLR - Connection refused - connect(2)\n"
+    end
+    TanningBed.solr_connection('http://localhost:8984/solr', :on, true)
+    
+  end
+  
+  it "should store a proc to handle exceptions if Solr is down" do
+    tmp_file = __DIR__ + "/tmp/solr_err.tmp"
+
+    TanningBed.solr_connection('http://localhost:9999/solr', :on, true)
+    
+    TanningBed.on_solr_exception = Proc.new {|e| raise e}
+    lambda {TanningBed.solr_search("test")}.should raise_error(Errno::ECONNREFUSED)
+
+    TanningBed.on_solr_exception = nil
+    TanningBed.solr_connection('http://localhost:8984/solr', :on, true)    
+  end
+  
+
+end
+
+# EOF

data/tanning_bed.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tanning_bed}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob Kaufman"]
+  s.date = %q{2010-03-15}
+  s.description = %q{Tanning Bed is Solr for models.
+Tanning Bed provides a Ruby interface for the Solr (http://lucene.apache.org/solr/) search engine to use in you're models not matter whether they are Datamapper, Active Record, Couchrest or just general Ruby classes.}
+  s.email = %q{rob@notch8.com}
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc", "README.txt", "version.txt"]
+  s.files = [".gitignore", "History.txt", "Manifest.txt", "README.rdoc", "README.txt", "Rakefile", "lib/tanning_bed.rb", "spec/fixtures/burnt_model.rb", "spec/fixtures/tanning_model.rb", "spec/spec_helper.rb", "spec/tanning_bed_spec.rb", "tanning_bed.gemspec", "tasks/solr.rake", "tasks/solr.rb", "version.txt"]
+  s.homepage = %q{http://notch8.com}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{tanning_bed}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Tanning Bed is Solr for models}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<solr-ruby>, [">= 0.0.8"])
+      s.add_development_dependency(%q<tanning_bed_solr>, [">= 0.0.1"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.0"])
+    else
+      s.add_dependency(%q<solr-ruby>, [">= 0.0.8"])
+      s.add_dependency(%q<tanning_bed_solr>, [">= 0.0.1"])
+      s.add_dependency(%q<bones>, [">= 3.4.0"])
+    end
+  else
+    s.add_dependency(%q<solr-ruby>, [">= 0.0.8"])
+    s.add_dependency(%q<tanning_bed_solr>, [">= 0.0.1"])
+    s.add_dependency(%q<bones>, [">= 3.4.0"])
+  end
+end

data/tasks/solr.rake

@@ -0,0 +1,2 @@
+__DIR__ = File.dirname(__FILE__)
+require __DIR__ + '/solr.rb'

data/tasks/solr.rb

@@ -0,0 +1,88 @@
+require 'rubygems'
+require 'rake'
+require 'net/http'
+require 'fileutils'
+
+namespace :solr do
+  
+  desc 'Start Solr for tests.  Sets SOLR_PORT to 8984 and index is puts in /tmp'
+  task :start_testing do
+    ENV["SOLR_PORT"] = '8984'
+    solr_command = "java -Dsolr.data.dir=/tmp -Djetty.port=#{solr_port} -jar start.jar"
+    start_solr(solr_command)
+  end
+
+  desc 'Starts Solr. SOLR_PORT=XX. SOLR_PATH=yy'
+  task :start do
+    solr_command = "java -Dsolr.data.dir=solr/data -Djetty.port=#{solr_port} -jar start.jar"
+    start_solr(solr_command)
+  end
+  
+  desc 'Stops Solr.'
+  task :stop do
+    fork do
+      file_path = "#{solr_path}/tmp/solr_pid"
+      if File.exists?(file_path)
+        File.open(file_path, "r") do |f| 
+          pid = f.readline
+          Process.kill('TERM', pid.to_i)
+        end
+        File.unlink(file_path)
+        # Rake::Task["solr:destroy_index"].invoke if ENV['RAILS_ENV'] == 'test'
+        puts "Solr shutdown successfully."
+      else
+        puts "Solr is not running.  I haven't done anything."
+      end
+    end
+  end
+  
+  desc 'Remove Solr index'
+  task :destroy_index do
+    index_path = "#{solr_path}/solr/data"
+    if File.exists?(index_path)
+      Dir[ index_path + "/index/*"].each{|f| File.unlink(f)}
+      Dir.rmdir(index_path + "/index")
+      puts "Index files removed under #{index_path}/index" 
+    end
+  end
+  
+  def solr_port
+    if ENV["SOLR_PORT"]
+      return ENV["SOLR_PORT"]
+    else
+      return "8983"
+    end
+  end
+  
+  def solr_path
+    return @solr_path if @solr_path
+    return @solr_path = ENV["SOLR_PATH"] if ENV["SOLR_PATH"]
+    if Gem.available? 'tanning_bed_solr'
+      return @solr_path = "#{Gem.searcher.find('tanning_bed_solr').full_gem_path}/vendor/solr"
+    else
+      raise 'No solr install found, either set SOLR_PATH or install tanning_bed_solr gem'
+    end
+  end
+  
+  def start_solr(solr_command)
+    begin
+      n = Net::HTTP.new('localhost', solr_port)
+      n.request_head('/').value 
+
+    rescue Net::HTTPServerException #responding
+      puts "Port #{solr_port} in use" and return
+
+    rescue Errno::ECONNREFUSED #not responding
+      Dir.chdir(solr_path) do
+        pid = fork do
+          #STDERR.close
+          exec solr_command
+        end
+        sleep(5)
+        FileUtils.mkdir_p("#{solr_path}/tmp")
+        File.open("#{solr_path}/tmp/solr_pid", "w"){ |f| f << pid}
+        puts "Solr started successfully on #{solr_port}, pid: #{pid}."
+      end
+    end
+  end
+end

data/version.txt

@@ -0,0 +1 @@
+0.1.1

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: tanning_bed
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Rob Kaufman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: solr-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 8
+        version: 0.0.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: tanning_bed_solr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 4
+        - 0
+        version: 3.4.0
+  type: :development
+  version_requirements: *id003
+description: |-
+  Tanning Bed is Solr for models.
+  Tanning Bed provides a Ruby interface for the Solr (http://lucene.apache.org/solr/) search engine to use in you're models not matter whether they are Datamapper, Active Record, Couchrest or just general Ruby classes.
+email: rob@notch8.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- README.txt
+- version.txt
+files: 
+- .gitignore
+- History.txt
+- Manifest.txt
+- README.rdoc
+- README.txt
+- Rakefile
+- lib/tanning_bed.rb
+- spec/fixtures/burnt_model.rb
+- spec/fixtures/tanning_model.rb
+- spec/spec_helper.rb
+- spec/tanning_bed_spec.rb
+- tanning_bed.gemspec
+- tasks/solr.rake
+- tasks/solr.rb
+- version.txt
+has_rdoc: true
+homepage: http://notch8.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: tanning_bed
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Tanning Bed is Solr for models
+test_files: []
+