sunspot 0.10.9 → 1.0.0

data/lib/sunspot/type.rb

@@ -17,6 +17,19 @@ module Sunspot
   #   Ruby type.
   #
   module Type
+    class AbstractType #:nodoc:
+      class <<self
+        def instance
+          @instance ||= new
+        end
+        private :new
+      end
+
+      def accepts_dynamic?
+        true
+      end
+    end
+
     # 
     # Text is a special type that stores data for fulltext search. Unlike other
     # types, Text fields are tokenized and are made available to the keyword
@@ -24,76 +37,91 @@ module Sunspot
     # restrictions. Similarly, text fields are the only fields that are made
     # available to keyword search.
     #
-    module TextType
-      class <<self
-        def indexed_name(name) #:nodoc:
+    class TextType < AbstractType
+      def indexed_name(name) #:nodoc:
         "#{name}_text"
-        end
+      end
 
-        def to_indexed(value) #:nodoc:
-          value.to_s if value
-        end
+      def to_indexed(value) #:nodoc:
+        value.to_s if value
+      end
 
-        def cast(text)
-          text
-        end
+      def cast(text)
+        text
+      end
+
+      def accepts_dynamic?
+        false
       end
     end
 
     # 
     # The String type represents string data.
     #
-    module StringType
-      class <<self
-        def indexed_name(name) #:nodoc:
+    class StringType < AbstractType
+      def indexed_name(name) #:nodoc:
         "#{name}_s"
-        end
+      end
 
-        def to_indexed(value) #:nodoc:
-          value.to_s if value
-        end
+      def to_indexed(value) #:nodoc:
+        value.to_s if value
+      end
 
-        def cast(string) #:nodoc:
-          string
-        end
+      def cast(string) #:nodoc:
+        string
       end
     end
 
     # 
     # The Integer type represents integers.
     #
-    module IntegerType
-      class <<self
-        def indexed_name(name) #:nodoc:
+    class IntegerType < AbstractType
+      def indexed_name(name) #:nodoc:
         "#{name}_i"
-        end
+      end
 
-        def to_indexed(value) #:nodoc:
-          value.to_i.to_s if value
-        end
+      def to_indexed(value) #:nodoc:
+        value.to_i.to_s if value
+      end
 
-        def cast(string) #:nodoc:
-          string.to_i
-        end
+      def cast(string) #:nodoc:
+        string.to_i
+      end
+    end
+
+    # 
+    # The Long type indexes Ruby Fixnum and Bignum numbers into Java Longs
+    #
+    class LongType < IntegerType
+      def indexed_name(name) #:nodoc:
+        "#{name}_l"
       end
     end
 
     # 
     # The Float type represents floating-point numbers.
     #
-    module FloatType
-      class <<self
-        def indexed_name(name) #:nodoc:
+    class FloatType < AbstractType
+      def indexed_name(name) #:nodoc:
         "#{name}_f"
-        end
+      end
 
-        def to_indexed(value) #:nodoc:
-          value.to_f.to_s if value
-        end
+      def to_indexed(value) #:nodoc:
+        value.to_f.to_s if value
+      end
 
-        def cast(string) #:nodoc:
-          string.to_f
-        end
+      def cast(string) #:nodoc:
+        string.to_f
+      end
+    end
+
+    # 
+    # The Double type indexes Ruby Floats (which are in fact doubles) into Java
+    # Double fields
+    #
+    class DoubleType < FloatType
+      def indexed_name(name)
+        "#{name}_e"
       end
     end
 
@@ -101,27 +129,40 @@ module Sunspot
     # The time type represents times. Note that times are always converted to
     # UTC before indexing, and facets of Time fields always return times in UTC.
     #
-    module TimeType
+    class TimeType < AbstractType
+      XMLSCHEMA = "%Y-%m-%dT%H:%M:%SZ"
 
-      class <<self
-        def indexed_name(name) #:nodoc:
+      def indexed_name(name) #:nodoc:
         "#{name}_d"
-        end
+      end
 
-        def to_indexed(value) #:nodoc:
-          if value
-            time =
-              if value.respond_to?(:utc)
-                value
-              else
-                Time.parse(value.to_s)
-              end
-            time.utc.xmlschema
-          end
+      def to_indexed(value) #:nodoc:
+        if value
+          value_to_utc_time(value).strftime(XMLSCHEMA)
         end
+      end
 
-        def cast(string) #:nodoc:
+      def cast(string) #:nodoc:
+        begin
           Time.xmlschema(string)
+        rescue ArgumentError
+          DateTime.strptime(string, XMLSCHEMA)
+        end
+      end
+
+      private
+
+      def value_to_utc_time(value)
+        if value.respond_to?(:utc)
+          value.utc
+        elsif value.respond_to?(:new_offset)
+          value.new_offset
+        else
+          begin
+            Time.parse(value.to_s).utc
+          rescue ArgumentError
+            DateTime.parse(value.to_s).new_offset
+          end
         end
       end
     end
@@ -132,72 +173,93 @@ module Sunspot
     # Solr's DateField type (which is actually date/time), midnight UTC of the
     # indexed date.
     #
-    module DateType
-      class <<self
-        def indexed_name(name) #:nodoc:
-          "#{name}_d"
+    class DateType < TimeType
+      def to_indexed(value) #:nodoc:
+        if value
+          time = 
+            if %w(year mon mday).all? { |method| value.respond_to?(method) }
+              Time.utc(value.year, value.mon, value.mday)
+            else
+              date = Date.parse(value.to_s)
+              Time.utc(date.year, date.mon, date.mday)
+            end
+          super(time)
         end
+      end
 
-        def to_indexed(value) #:nodoc:
-          if value
-            time = 
-              if %w(year mon mday).all? { |method| value.respond_to?(method) }
-                Time.utc(value.year, value.mon, value.mday)
-              else
-                date = Date.parse(value.to_s)
-                Time.utc(date.year, date.mon, date.mday)
-              end
-            time.utc.xmlschema
-          end
-        end
+      def cast(string) #:nodoc:
+        time = super
+        Date.civil(time.year, time.mon, time.mday)
+      end
+    end
 
-        def cast(string) #:nodoc:
-          time = Time.xmlschema(string)
-          Date.civil(time.year, time.mon, time.mday)
-        end
+    # 
+    # Store integers in a TrieField, which makes range queries much faster.
+    #
+    class TrieIntegerType < IntegerType
+      def indexed_name(name)
+        "#{super}t"
+      end
+    end
+
+    # 
+    # Store floats in a TrieField, which makes range queries much faster.
+    #
+    class TrieFloatType < FloatType
+      def indexed_name(name)
+        "#{super}t"
       end
     end
 
+    # 
+    # Index times using a TrieField. Internally, trie times are indexed as
+    # Unix timestamps in a trie integer field, as TrieField does not support
+    # datetime types natively. This distinction should have no effect from the
+    # standpoint of the library's API.
+    #
+    class TrieTimeType < TimeType
+      def indexed_name(name)
+        "#{super}t"
+      end
+    end
+
+
     # 
     # The boolean type represents true/false values. Note that +nil+ will not be
     # indexed at all; only +false+ will be indexed with a false value.
     #
-    module BooleanType
-      class <<self
-        def indexed_name(name) #:nodoc:
+    class BooleanType < AbstractType
+      def indexed_name(name) #:nodoc:
         "#{name}_b"
-        end
+      end
 
-        def to_indexed(value) #:nodoc:
-          unless value.nil?
-            value ? 'true' : 'false'
-          end
+      def to_indexed(value) #:nodoc:
+        unless value.nil?
+          value ? 'true' : 'false'
         end
+      end
 
-        def cast(string) #:nodoc:
-          case string
-          when 'true'
-            true
-          when 'false'
-            false
-          end
+      def cast(string) #:nodoc:
+        case string
+        when 'true'
+          true
+        when 'false'
+          false
         end
       end
     end
 
-    module ClassType
-      class <<self
-        def indexed_name(name) #:nodoc:
-          'class_name'
-        end
+    class ClassType < AbstractType
+      def indexed_name(name) #:nodoc:
+        'class_name'
+      end
 
-        def to_indexed(value) #:nodoc:
-          value.name
-        end
+      def to_indexed(value) #:nodoc:
+        value.name
+      end
 
-        def cast(string) #:nodoc:
-          Sunspot::Util.full_const_get(string)
-        end
+      def cast(string) #:nodoc:
+        Sunspot::Util.full_const_get(string)
       end
     end
   end

data/lib/sunspot/util.rb

@@ -83,7 +83,7 @@ module Sunspot
         if block.arity > 0
           block.call(object)
         else
-          object.instance_eval(&block)
+          ContextBoundDelegate.instance_eval_with_context(object, &block)
         end
       end
 
@@ -189,8 +189,10 @@ module Sunspot
       def lat
         if @coords.respond_to?(:[])
           @coords[0]
-        else
+        elsif @coords.respond_to?(:lat)
           @coords.lat
+        else
+          @coords.latitude
         end.to_f
       end
 
@@ -203,8 +205,48 @@ module Sunspot
           @coords.lon
         elsif @coords.respond_to?(:long)
           @coords.long
+        elsif @coords.respond_to?(:longitude)
+          @coords.longitude
         end.to_f
       end
     end
+
+    class ContextBoundDelegate
+      class <<self
+        def instance_eval_with_context(receiver, &block)
+          calling_context = eval('self', block.binding)
+          if parent_calling_context = calling_context.instance_eval{@__calling_context__}
+            calling_context = parent_calling_context
+          end
+          new(receiver, calling_context).instance_eval(&block)
+        end
+        private :new
+      end
+
+      BASIC_METHODS = Set[:==, :equal?, :"!", :"!=", :instance_eval,
+                          :object_id, :__send__, :__id__]
+
+      instance_methods.each do |method|
+        unless BASIC_METHODS.include?(method.to_sym)
+          undef_method(method)
+        end
+      end
+
+      def initialize(receiver, calling_context)
+        @__receiver__, @__calling_context__ = receiver, calling_context
+      end
+
+      def method_missing(method, *args, &block)
+        begin
+          @__receiver__.send(method.to_sym, *args, &block)
+        rescue ::NoMethodError => e
+          begin
+            @__calling_context__.send(method.to_sym, *args, &block)
+          rescue ::NoMethodError
+            raise(e)
+          end
+        end
+      end
+    end
   end
 end

data/lib/sunspot/version.rb

@@ -0,0 +1,3 @@
+module Sunspot
+  VERSION = '1.0.0'
+end

data/lib/sunspot.rb

@@ -2,6 +2,7 @@ require 'set'
 require 'time'
 require 'date'
 require 'enumerator'
+require 'cgi'
 begin
   require 'rsolr'
 rescue LoadError
@@ -12,8 +13,8 @@ end
 require File.join(File.dirname(__FILE__), 'light_config')
 
 %w(util adapters configuration setup composite_setup text_field_setup field
-   field_factory data_extractor indexer query search session type
-   dsl).each do |filename|
+   field_factory data_extractor indexer query search session session_proxy
+   type dsl).each do |filename|
   require File.join(File.dirname(__FILE__), 'sunspot', filename)
 end
 
@@ -33,12 +34,15 @@ end
 # method) is _not_ session-specific, but rather global.
 #
 module Sunspot
-  UnrecognizedFieldError = Class.new(Exception)
-  UnrecognizedRestrictionError = Class.new(Exception)
-  NoAdapterError = Class.new(Exception)
-  NoSetupError = Class.new(Exception)
-  IllegalSearchError = Class.new(Exception)
+  UnrecognizedFieldError = Class.new(StandardError)
+  UnrecognizedRestrictionError = Class.new(StandardError)
+  NoAdapterError = Class.new(StandardError)
+  NoSetupError = Class.new(StandardError)
+  IllegalSearchError = Class.new(StandardError)
+  NotImplementedError = Class.new(StandardError)
 
+  autoload :Server, File.join(File.dirname(__FILE__), 'sunspot', 'server')
+  autoload :Installer, File.join(File.dirname(__FILE__), 'sunspot', 'installer')
 
   class <<self
     # 
@@ -204,9 +208,30 @@ module Sunspot
 
     # 
     # Create a new Search instance, but do not execute it immediately. Generally
-    # you will want to use the #search method to execute searches using the
-    # DSL; however, if you are building searches dynamically (using the Builder
-    # pattern, for instance), it may be easier to access the Query API directly.
+    # you will want to use the #search method to build and execute searches in
+    # one step, but if you are building searches piecemeal you may call
+    # #new_search and then call #build one or more times to add components to
+    # the query.
+    #
+    # ==== Example
+    #
+    #   search = Sunspot.new_search do
+    #     with(:blog_id, 1)
+    #   end
+    #   search.build do
+    #     keywords('some keywords')
+    #   end
+    #   search.build do
+    #     order_by(:published_at, :desc)
+    #   end
+    #   search.execute
+    #
+    #   # This is equivalent to:
+    #   Sunspot.search do
+    #     with(:blog_id, 1)
+    #     keywords('some keywords')
+    #     order_by(:published_at, :desc)
+    #   end
     # 
     # ==== Parameters
     #
@@ -220,8 +245,8 @@ module Sunspot
     #   Search object, not yet executed. Query parameters can be added manually;
     #   then #execute! should be called.
     # 
-    def new_search(*types)
-      session.new_search(*types)
+    def new_search(*types, &block)
+      session.new_search(*types, &block)
     end
 
 
@@ -303,18 +328,28 @@ module Sunspot
     # references to objects that do not exist, which will cause errors when
     # those objects are matched in search results.
     #
+    # If a block is passed, it is evaluated as a search scope; in this way,
+    # documents can be removed by an arbitrary query. In this case, the
+    # arguments to the method should be the classes to run the query on.
+    #
     # ==== Parameters
     #
     # objects...<Object>::
     #   Objects to remove from the index (may pass an array or varargs)
     #
-    # ==== Example
+    # ==== Example (remove a document)
     #
     #   post.destroy
     #   Sunspot.remove(post)
     #
-    def remove(*objects)
-      session.remove(*objects)
+    # ==== Example (remove by query)
+    #
+    #   Sunspot.remove(Post) do
+    #     with(:created_at).less_than(Time.now - 14.days)
+    #   end
+    #
+    def remove(*objects, &block)
+      session.remove(*objects, &block)
     end
 
     # 
@@ -472,8 +507,6 @@ module Sunspot
       @session = Session.new(config)
     end
 
-    private
-
     # 
     # Get the singleton session, creating it if none yet exists.
     #

data/solr/etc/jetty.xml

@@ -189,17 +189,19 @@
     <!-- contexts configuration (see $(jetty.home)/contexts/test.xml -->
     <!-- for an example).                                            -->
     <!-- =========================================================== -->
+    <!--
     <Ref id="RequestLog">
       <Set name="requestLog">
-        <!-- New id="RequestLogImpl" class="org.mortbay.jetty.NCSARequestLog">
+        <New id="RequestLogImpl" class="org.mortbay.jetty.NCSARequestLog">
           <Arg><SystemProperty name="jetty.logs" default="./logs"/>/yyyy_mm_dd.request.log</Arg>
           <Set name="retainDays">90</Set>
           <Set name="append">true</Set>
           <Set name="extended">false</Set>
           <Set name="LogTimeZone">GMT</Set>
-        </New -->
+        </New>
       </Set>
     </Ref>
+    -->
 
     <!-- =========================================================== -->
     <!-- extra options                                               -->

data/solr/solr/conf/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ 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 content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->