sunspot 2.0.0.pre.120720 → 2.0.0.pre.120924

data/Rakefile

@@ -1,13 +1,37 @@
-# encoding: UTF-8
+desc 'Release Sunspot, Sunspot::Rails and Sunspot::Solr to Gemcutter'
+task :release do
+  FileUtils.cp('README.md', 'sunspot/')
 
-require 'rspec/core/rake_task'
+  require File.expand_path('../sunspot/lib/sunspot/version', __FILE__)
 
-Dir['tasks/**/*.rake'].each { |t| load t }
+  version_tag = "v#{Sunspot::VERSION}"
+  system "git tag -am 'Release version #{Sunspot::VERSION}' '#{version_tag}'"
+  system "git push origin #{version_tag}:#{version_tag}"
 
-desc "Run all examples"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = '--format documentation'
-  t.ruby_opts  = "-W1"
+  FileUtils.cd 'sunspot' do
+    system "gem build sunspot.gemspec"
+    system "gem push sunspot-#{Sunspot::VERSION}.gem"
+    FileUtils.rm "sunspot-#{Sunspot::VERSION}.gem"
+  end
+
+  FileUtils.cd 'sunspot_rails' do
+    system "gem build sunspot_rails.gemspec"
+    system "gem push sunspot_rails-#{Sunspot::VERSION}.gem"
+    FileUtils.rm("sunspot_rails-#{Sunspot::VERSION}.gem")
+  end
+
+  FileUtils.cd 'sunspot_solr' do
+    system "gem build sunspot_solr.gemspec"
+    system "gem push sunspot_solr-#{Sunspot::VERSION}.gem"
+    FileUtils.rm("sunspot_solr-#{Sunspot::VERSION}.gem")
+  end
 end
 
-task :default => :spec
+
+desc 'Run all the tests'
+task :default do
+  exit system([ "GEM=sunspot ci/travis.sh",
+                "GEM=sunspot_rails RAILS=3.0.15 ci/travis.sh",
+                "GEM=sunspot_rails RAILS=3.1.6  ci/travis.sh",
+                "GEM=sunspot_rails RAILS=3.2.6  ci/travis.sh" ].join(" && ")) ? 0 : 1
+end

data/ci/travis.sh

@@ -0,0 +1,67 @@
+#!/bin/sh
+
+set +e
+
+solr_responding() {
+  port=$1
+  curl -o /dev/null "http://localhost:$port/solr/admin/ping" > /dev/null 2>&1
+}
+
+wait_until_solr_responds() {
+  port=$1
+  while ! solr_responding $1; do
+    /bin/echo -n "."
+    sleep 1
+  done
+}
+
+case $GEM in
+  "sunspot")
+    
+    cd sunspot
+    /bin/echo -n "Starting Solr on port 8983 for Sunspot specs..."
+    bundle install --quiet --path vendor/bundle
+    if [ -f sunspot-solr.pid ]; then bundle exec sunspot-solr stop || true; fi
+
+    bundle exec sunspot-solr start -p 8983 -d /tmp/solr
+    wait_until_solr_responds 8983
+    /bin/echo "done."
+    
+    # Invoke the sunspot specs
+    bundle exec rake spec
+    rv=$?
+    
+    /bin/echo -n "Stopping Solr... "
+    bundle exec sunspot-solr stop
+    /bin/echo "done."
+
+    exit $rv
+    ;;
+    
+  "sunspot_rails")
+  
+    cd sunspot
+    /bin/echo -n "Starting Solr on port 8983 for Sunspot specs..."
+    bundle install --quiet --path vendor/bundle
+    if [ -f sunspot-solr.pid ]; then bundle exec sunspot-solr stop || true; fi
+
+    bundle exec sunspot-solr start -p 8983 -d /tmp/solr
+    wait_until_solr_responds 8983
+    /bin/echo "done."
+    
+    # Install gems for test Rails application
+    cd ../sunspot_rails
+    rake spec RAILS=$RAILS
+    rv=$?
+    
+    # Cleanup Solr
+    /bin/echo -n "Stopping Solr... "
+    cd ../sunspot
+    bundle exec sunspot-solr stop
+    /bin/echo "done."
+
+    exit $rv
+    ;;
+    
+  *)
+esac

data/sunspot/.gitignore

@@ -0,0 +1,13 @@
+sunspot-solr.pid
+*.swp
+*.swo
+*~
+coverage
+pkg
+/doc
+.DS_Store
+
+.yardoc
+README.rdoc
+.bundle
+Gemfile.lock

data/sunspot/Rakefile

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+require 'rspec/core/rake_task'
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--format documentation'
+  t.ruby_opts  = "-W1"
+end
+
+task :default => :spec

data/{lib → sunspot/lib}/sunspot/adapters.rb

@@ -1,5 +1,5 @@
 module Sunspot
-  # 
+  #
   # Sunspot works by saving references to the primary key (or natural ID) of
   # each indexed object, and then retrieving the objects from persistent storage
   # when their IDs are referenced in search results. In order for Sunspot to
@@ -53,7 +53,7 @@ module Sunspot
         @instance = instance
       end
 
-      # 
+      #
       # The universally-unique ID for this instance that will be stored in solr
       #
       # ==== Returns
@@ -149,7 +149,7 @@ module Sunspot
       end
     end
 
-    # Subclasses of the DataAccessor class take care of retreiving instances of
+    # Subclasses of the DataAccessor class take care of retrieving instances of
     # the adapted class from (usually persistent) storage. Subclasses must
     # implement the #load method, which takes an id (the value returned by
     # InstanceAdapter#id, as a string), and returns the instance referenced by
@@ -170,8 +170,13 @@ module Sunspot
     #   Sunspot::Adapters::DataAccessor.register(FileAccessor, File)
     #
     class DataAccessor
+      # Attributes that should be passed to other adapted subclasses
+      attr_accessor :inherited_attributes
+      attr_reader :clazz
+
       def initialize(clazz) #:nodoc:
         @clazz = clazz
+        @inherited_attributes = []
       end
 
       # Subclasses can override this class to provide more efficient bulk
@@ -193,7 +198,7 @@ module Sunspot
       class <<self
         # Create a DataAccessor for the given class, searching registered
         # adapters for the best match. See InstanceAdapter#adapt for discussion
-        # of inheritence.
+        # of inheritance.
         #
         # ==== Parameters
         #
@@ -217,7 +222,7 @@ module Sunspot
         #
         # data_accessor<Class>:: The data accessor class to register
         # classes...<Class>::
-        #   One or more classes that this data accessor providess access to
+        #   One or more classes that this data accessor provides access to
         #
         def register(data_accessor, *classes)
           classes.each do |clazz|
@@ -265,5 +270,80 @@ module Sunspot
         end
       end
     end
+
+    # Allows to have a registry of the classes adapted by a DataAccessor. This
+    # registry does the class registration using DataAccessor's #create and while
+    # doing so also allows a registered class to notify which attributes
+    # should be inherited by its subclasses. 
+    # This is useful in cases such us ActiveRecord's #include option, where 
+    # you may need to run a search in all the subclasses of a searchable model 
+    # and including some associations for all of them when it loads.
+    #
+    # ==== Example
+    #
+    # # ActiveRecordDataAccessor marks :include and :select as inherited_attributes
+    # class ActiveRecordDataAccessor < Sunspot::Adapters::DataAccessor
+    #   # options for the find
+    #   attr_accessor :include, :select
+    #
+    #   def initialize(clazz)
+    #     super(clazz)
+    #     @inherited_attributes = [:include, :select]
+    #   end
+    # end
+    #
+    # class Event < ActiveRecord::Base
+    #   searchable do
+    #    #stuff here
+    #   end
+    # end
+    # class Play < Event ; end
+    # class Movie < Event ; end
+    #
+    # # This will push the :include to ALL of the Event's subclasses
+    # @search = Event.search(include: [:images])
+    #
+    # # You can also set the value just one class's attribute
+    # @search.data_accessor_for(Play).include = [ :images, :location]
+    #
+    class Registry
+      extend Forwardable
+
+      def initialize
+        @reg = {}
+      end
+      def_delegator :@reg, :keys, :registered
+      def_delegators :@reg, :include?
+
+      def retrieve(clazz)
+        key = clazz.name.to_sym
+        if !@reg.include?(key)
+          data_accessor = inject_inherited_attributes_for( Adapters::DataAccessor.create(clazz) )
+          @reg[key] ||= data_accessor
+        end
+        @reg[key]
+      end
+
+      # It will inject declared attributes to be inherited from ancestors
+      # only if they are not already present in the data_accessor for each class.
+      def inject_inherited_attributes_for(data_accessor)
+        return data_accessor if @reg.empty?
+
+        data_accessor.inherited_attributes.each do |attribute|
+          if data_accessor.send(attribute).nil? # Inject only if the current class didn't define one.
+            inherited_value = nil
+            # Now try to find a value for the attribute in the chain of ancestors
+            data_accessor.clazz.ancestors.each do |ancestor|
+              next if ancestor.name.nil? || ancestor.name.empty?
+              key = ancestor.name.to_sym
+              inherited_value = @reg[key].send(attribute) if @reg[key]
+              break unless inherited_value.nil?
+            end
+            data_accessor.send("#{attribute.to_s}=", inherited_value) unless inherited_value.nil?
+          end
+        end
+        data_accessor
+      end
+    end
   end
 end

data/{lib → sunspot/lib}/sunspot/dsl/field_group.rb

@@ -1,8 +1,8 @@
 module Sunspot
   module DSL
     class FieldGroup
-      def initialize(query, setup, group)
-        @query, @setup, @group = query, setup, group
+      def initialize(setup, group)
+        @setup, @group = setup, group
       end
 
       #

data/{lib → sunspot/lib}/sunspot/dsl/field_query.rb

@@ -79,7 +79,7 @@ module Sunspot
 
           if block
             Sunspot::Util.instance_eval_or_call(
-              FieldGroup.new(@query, @setup, group),
+              FieldGroup.new(@setup, group),
               &block
             )
           end

data/{lib → sunspot/lib}/sunspot/dsl/scope.rb

@@ -8,8 +8,6 @@ module Sunspot
     # allows operations on specific fields.
     #
     class Scope
-      NONE = Object.new
-
       def initialize(scope, setup) #:nodoc:
         @scope, @setup = scope, setup
       end
@@ -193,20 +191,19 @@ module Sunspot
         case args.first
         when String, Symbol
           raise ArgumentError if args.length > 2
-          field_name = args[0]
-          value = args.length > 1 ? args[1] : NONE
-          if value == NONE
-            DSL::Restriction.new(@setup.field(field_name.to_sym), @scope, negated)
-          else
-            @scope.add_shorthand_restriction(negated, @setup.field(field_name.to_sym), value)
+          field = @setup.field(args[0].to_sym)
+          if args.length > 1
+            value = args[1]
+            @scope.add_shorthand_restriction(negated, field, value)
+          else # NONE
+            DSL::Restriction.new(field, @scope, negated)
           end
-        else
-          instances = args.flatten
+        else # args are instances
           @scope.add_restriction(
             negated,
             IdField.instance,
             Sunspot::Query::Restriction::AnyOf,
-            instances.flatten.map { |instance|
+            args.flatten.map { |instance|
               Sunspot::Adapters::InstanceAdapter.adapt(instance).index_id }
           )
         end

data/{lib → sunspot/lib}/sunspot/dsl/standard_query.rb

@@ -108,10 +108,9 @@ module Sunspot
       def with(*args)
         case args.first
         when String, Symbol
-          field_name = args[0]
-          value = args.length > 1 ? args[1] : Scope::NONE
-          if value == Scope::NONE
-            return DSL::RestrictionWithNear.new(@setup.field(field_name.to_sym), @scope, @query, false)
+          if args.length == 1 # NONE
+            field = @setup.field(args[0].to_sym)
+            return DSL::RestrictionWithNear.new(field, @scope, @query, false)
           end
         end
 

data/{lib → sunspot/lib}/sunspot/query/abstract_field_facet.rb

@@ -30,7 +30,7 @@ module Sunspot
           params[qualified_param('offset')] = @options[:offset].to_i
         end
         if @options[:prefix]
-          params[qualified_param('prefix')] = escape(@options[:prefix].to_s)
+          params[qualified_param('prefix')] = @options[:prefix].to_s
         end
         params[qualified_param('mincount')] = 
           case

data/{lib → sunspot/lib}/sunspot/query/range_facet.rb

@@ -7,6 +7,7 @@ module Sunspot
         params[qualified_param('range.start')] = @field.to_indexed(@options[:range].first)
         params[qualified_param('range.end')] = @field.to_indexed(@options[:range].last)
         params[qualified_param('range.gap')] = "#{@options[:range_interval] || 10}"
+        params[qualified_param('range.include')] = @options[:include].to_s if @options[:include]
         params
       end
     end

data/{lib → sunspot/lib}/sunspot/query/restriction.rb

@@ -144,6 +144,18 @@ module Sunspot
         end
       end
 
+      class InRadius < Base
+        def initialize(negated, field, lat, lon, radius)
+          @lat, @lon, @radius = lat, lon, radius
+          super negated, field, [lat, lon, radius]
+        end
+
+        private
+          def to_positive_boolean_phrase
+            "_query_:\"{!geofilt sfield=#{@field.indexed_name} pt=#{@lat},#{@lon} d=#{@radius}}\""
+          end
+      end
+
       # 
       # Results must have field with value equal to given value. If the value
       # is nil, results must have no value for the given field.

data/{lib → sunspot/lib}/sunspot/search/abstract_search.rb

@@ -208,8 +208,8 @@ module Sunspot
         "<Sunspot::Search:#{query.to_params.inspect}>"
       end
 
-      def add_field_group(field, options = {}) #:nodoc:
-        add_group(field.name, FieldGroup.new(field, self, options))
+      def add_field_group(field) #:nodoc:
+        add_group(field.name, FieldGroup.new(field, self))
       end
   
       def add_field_facet(field, options = {}) #:nodoc:

data/sunspot/lib/sunspot/search/field_group.rb

@@ -0,0 +1,70 @@
+require 'sunspot/search/paginated_collection'
+
+module Sunspot
+  module Search
+    class FieldGroup
+      def initialize(field, search) #:nodoc:
+        @field, @search = field, search
+      end
+
+      def groups
+        @groups ||=
+          if solr_response
+            paginate_collection(
+              solr_response['groups'].map do |group|
+                Group.new(group['groupValue'], group['doclist'], @search)
+              end
+            )
+          end
+      end
+
+      def matches
+        if solr_response
+          solr_response['matches'].to_i
+        end
+      end
+
+      def total
+        if solr_response
+          solr_response['ngroups'].to_i
+        end
+      end
+
+      #
+      # It populates all grouped hits at once.
+      # Useful for eager loading fall grouped results at once.
+      #
+      def populate_all_hits
+        # Init a 2 dimension Hash that contains an array per key
+        id_hit_hash = Hash.new { |hash, key| hash[key] = Hash.new{ |h, k| h[k] = [] } }
+        groups.each do |g|
+          # Take all hits to being populated later on
+          g.hits.each do |hit|
+            id_hit_hash[hit.class_name][hit.primary_key] |= [hit]
+          end
+        end
+        # Go for each class and load the results' objects into each of the hits
+        id_hit_hash.each_pair do |class_name, many_hits|
+          ids = many_hits.keys
+          data_accessor = @search.data_accessor_for(Util.full_const_get(class_name))
+          hits_for_class = id_hit_hash[class_name]
+          data_accessor.load_all(ids).each do |result|
+            hits = hits_for_class.delete(Adapters::InstanceAdapter.adapt(result).id.to_s)
+            hits.each{ |hit| hit.result = result }
+          end
+          hits_for_class.values.each { |hits| hits.each{|hit| hit.result = nil } }
+        end
+      end
+
+      private
+
+      def solr_response
+        @search.group_response[@field.indexed_name.to_s]
+      end
+
+      def paginate_collection(collection)
+        PaginatedCollection.new(collection, @search.query.page, @search.query.per_page, total)
+      end
+    end
+  end
+end

data/{lib → sunspot/lib}/sunspot/search/hit_enumerable.rb

@@ -27,7 +27,7 @@ module Sunspot
         end
         id_hit_hash.each_pair do |class_name, hits|
           ids = hits.map { |id, hit| hit.primary_key }
-          data_accessor = data_accessor_for(Util.full_const_get(class_name))
+          data_accessor = data_accessor_for(Util.full_const_get(class_name))          
           hits_for_class = id_hit_hash[class_name]
           data_accessor.load_all(ids).each do |result|
             hit = hits_for_class.delete(Adapters::InstanceAdapter.adapt(result).id.to_s)
@@ -46,9 +46,8 @@ module Sunspot
       # for more information).
       #
       def each_hit_with_result
-        verified_hits.each do |hit|
-          yield(hit, hit.result)
-        end
+        return enum_for(:each_hit_with_result) unless block_given?
+        verified_hits.each { |hit| yield hit, hit.result }
       end
 
       # 
@@ -61,11 +60,8 @@ module Sunspot
       # the block DSL.
       #
       def data_accessor_for(clazz) #:nodoc:
-        # FIXME: This method does not belong here, but I was getting bogged
-        # down trying to figure out where it should go. Punted for now.
-        # - AL 27 Nov 2011
-        (@data_accessors ||= {})[clazz.name.to_sym] ||=
-          Adapters::DataAccessor.create(clazz)
+        @registry ||= Sunspot::Adapters::Registry.new
+        @registry.retrieve(clazz)
       end
     end
   end