pixeltrix-thinking-sphinx 1.1.5 → 1.2.1

data/lib/thinking_sphinx/deltas.rb

@@ -4,18 +4,26 @@ require 'thinking_sphinx/deltas/datetime_delta'
 
 module ThinkingSphinx
   module Deltas
-    def self.parse(index, options)
-      case options.delete(:delta)
+    def self.parse(index)
+      delta_option = index.local_options.delete(:delta)
+      case delta_option
       when TrueClass, :default
-        DefaultDelta.new index, options
+        DefaultDelta.new index, index.local_options
       when :delayed
-        DelayedDelta.new index, options
+        DelayedDelta.new index, index.local_options
       when :datetime
-        DatetimeDelta.new index, options
+        DatetimeDelta.new index, index.local_options
       when FalseClass, nil
         nil
       else
-        raise "Unknown delta type"
+        if delta_option.is_a?(String)
+          delta_option = Kernel.const_get(delta_option)
+        end
+        if delta_option.ancestors.include?(ThinkingSphinx::Deltas::DefaultDelta)
+          delta_option.new index, index.local_options
+        else
+          raise "Unknown delta type"
+        end
       end
     end
   end

data/lib/thinking_sphinx/deploy/capistrano.rb

@@ -0,0 +1,98 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :thinking_sphinx do
+    namespace :install do
+      desc <<-DESC
+        Install Sphinx by source
+        
+        If Postgres is available, Sphinx will use it.
+        
+        If the variable :thinking_sphinx_configure_args is set, it will
+        be passed to the Sphinx configure script. You can use this to
+        install Sphinx in a non-standard location:
+        
+          set :thinking_sphinx_configure_args, "--prefix=$HOME/software"
+DESC
+
+      task :sphinx do
+        with_postgres = false
+        begin
+          run "which pg_config" do |channel, stream, data|
+            with_postgres = !(data.nil? || data == "")
+          end
+        rescue Capistrano::CommandError => e
+          puts "Continuing despite error: #{e.message}"
+        end
+      
+        args = []
+        if with_postgres
+          run "pg_config --pkgincludedir" do |channel, stream, data|
+            args << "--with-pgsql=#{data}"
+          end
+        end
+        args << fetch(:thinking_sphinx_configure_args, '')
+        
+        commands = <<-CMD
+        wget -q http://www.sphinxsearch.com/downloads/sphinx-0.9.8.1.tar.gz >> sphinx.log
+        tar xzvf sphinx-0.9.8.1.tar.gz
+        cd sphinx-0.9.8.1
+        ./configure #{args.join(" ")}
+        make
+        #{try_sudo} make install
+        rm -rf sphinx-0.9.8.1 sphinx-0.9.8.1.tar.gz
+        CMD
+        run commands.split(/\n\s+/).join(" && ")
+      end
+    
+      desc "Install Thinking Sphinx as a gem from GitHub"
+      task :ts do
+        run "#{try_sudo} gem install freelancing-god-thinking-sphinx --source http://gems.github.com"
+      end
+    end
+  
+    desc "Generate the Sphinx configuration file"
+    task :configure do
+      rake "thinking_sphinx:configure"
+    end
+  
+    desc "Index data"
+    task :index do
+      rake "thinking_sphinx:index"
+    end
+  
+    desc "Start the Sphinx daemon"
+    task :start do
+      configure
+      rake "thinking_sphinx:start"
+    end
+  
+    desc "Stop the Sphinx daemon"
+    task :stop do
+      configure
+      rake "thinking_sphinx:stop"
+    end
+  
+    desc "Stop and then start the Sphinx daemon"
+    task :restart do
+      stop
+      start
+    end
+  
+    desc "Stop, re-index and then start the Sphinx daemon"
+    task :rebuild do
+      stop
+      index
+      start
+    end
+  
+    desc "Add the shared folder for sphinx files for the production environment"
+    task :shared_sphinx_folder, :roles => :web do
+      run "mkdir -p #{shared_path}/db/sphinx/production"
+    end
+
+    def rake(*tasks)
+      tasks.each do |t|
+        run "cd #{current_path} && rake #{t} RAILS_ENV=production"
+      end
+    end
+  end
+end

data/lib/thinking_sphinx/excerpter.rb

@@ -0,0 +1,22 @@
+module ThinkingSphinx
+  class Excerpter
+    CoreMethods = %w( kind_of? object_id respond_to? should should_not stub! )
+    # Hide most methods, to allow them to be passed through to the instance.
+    instance_methods.select { |method|
+      method.to_s[/^__/].nil? && !CoreMethods.include?(method.to_s)
+    }.each { |method|
+      undef_method method
+    }
+    
+    def initialize(search, instance)
+      @search   = search
+      @instance = instance
+    end
+    
+    def method_missing(method, *args, &block)
+      string = @instance.send(method, *args, &block).to_s
+      
+      @search.excerpt_for(string, @instance.class)
+    end
+  end
+end

data/lib/thinking_sphinx/facet.rb

@@ -1,34 +1,80 @@
 module ThinkingSphinx
   class Facet
-    attr_reader :reference
+    attr_reader :property
     
-    def initialize(reference)
-      @reference = reference
+    def initialize(property)
+      @property = property
       
-      if reference.columns.length != 1
+      if property.columns.length != 1
         raise "Can't translate Facets on multiple-column field or attribute"
       end
     end
+
+    def self.name_for(facet)
+      case facet
+      when Facet
+        facet.name
+      when String, Symbol
+        facet.to_s.gsub(/(_facet|_crc)$/,'').to_sym
+      end
+    end
+    
+    def self.attribute_name_for(name)
+      name.to_s == 'class' ? 'class_crc' : "#{name}_facet"
+    end
+    
+    def self.attribute_name_from_value(name, value)
+      case value
+      when String
+        attribute_name_for(name)
+      when Array
+        if value.all? { |val| val.is_a?(Integer) }
+          name
+        else
+          attribute_name_for(name)
+        end
+      else
+        name
+      end
+    end
+    
+    def self.translate?(property)
+      return true if property.is_a?(Field)
+      
+      case property.type
+      when :string
+        true
+      when :integer, :boolean, :datetime, :float
+        false
+      when :multi
+        !property.all_ints?
+      end
+    end
     
     def name
-      reference.unique_name
+      property.unique_name
     end
     
     def attribute_name
-      @attribute_name ||= case @reference
-      when Attribute
-        @reference.unique_name.to_s
-      when Field
-        @reference.unique_name.to_s + "_sort"
+      if translate?
+        Facet.attribute_name_for(@property.unique_name)
+      else
+        @property.unique_name.to_s
       end
     end
     
+    def translate?
+      Facet.translate?(@property)
+    end
+    
+    def type
+      @property.is_a?(Field) ? :string : @property.type
+    end
+    
     def value(object, attribute_value)
-      return translate(object, attribute_value) if @reference.is_a?(Field)
+      return translate(object, attribute_value) if translate?
       
-      case @reference.type
-      when :string, :multi
-        translate(object, attribute_value)
+      case @property.type
       when :datetime
         Time.at(attribute_value)
       when :boolean
@@ -46,13 +92,17 @@ module ThinkingSphinx
     
     def translate(object, attribute_value)
       column.__stack.each { |method|
-        object = object.send(method)
+        return nil unless object = object.send(method)
       }
-      object.send(column.__name)
+      if object.is_a?(Array)
+        object.collect { |item| item.send(column.__name) }
+      else
+        object.send(column.__name)
+      end
     end
     
     def column
-      @reference.columns.first
+      @property.columns.first
     end
   end
-end
+end

data/lib/thinking_sphinx/facet_search.rb

@@ -0,0 +1,134 @@
+module ThinkingSphinx
+  class FacetSearch < Hash
+    attr_accessor :args, :options
+    
+    def initialize(*args)
+      @options      = args.extract_options!
+      @args         = args
+      
+      set_default_options
+      
+      populate
+    end
+    
+    def for(hash = {})
+      for_options = {:with => {}}.merge(options)
+      
+      hash.each do |key, value|
+        attrib = ThinkingSphinx::Facet.attribute_name_from_value(key, value)
+        for_options[:with][attrib] = underlying_value key, value
+      end
+      
+      ThinkingSphinx.search *(args + [for_options])
+    end
+    
+    def facet_names
+      @facet_names ||= begin
+        names = options[:all_facets] ?
+          facet_names_for_all_classes : facet_names_common_to_all_classes
+        
+        names.delete "class_crc" unless options[:class_facet]
+        names
+      end
+    end
+    
+    private
+    
+    def set_default_options
+      options[:all_facets]  ||= false
+      if options[:class_facet].nil?
+        options[:class_facet] = ((options[:classes] || []).length != 1)
+      end
+    end
+    
+    def populate
+      facet_names.each do |name|
+        search_options = facet_search_options.merge(:group_by => name)
+        add_from_results name, ThinkingSphinx.search(
+          *(args + [search_options])
+        )
+      end
+    end
+    
+    def facet_search_options
+      config = ThinkingSphinx::Configuration.instance
+      max    = config.configuration.searchd.max_matches || 1000
+      
+      options.merge(
+        :group_function => :attr,
+        :limit          => max,
+        :max_matches    => max,
+        :page           => 1
+      )
+    end
+    
+    def facet_classes
+      (
+        options[:classes] || ThinkingSphinx.indexed_models.collect { |model|
+          model.constantize
+        }
+      ).select { |klass| klass.sphinx_facets.any? }
+    end
+    
+    def all_facets
+      facet_classes.collect { |klass|
+        klass.sphinx_facets
+      }.flatten.select { |facet|
+        options[:facets].blank? || Array(options[:facets]).include?(facet.name)
+      }
+    end
+    
+    def facet_names_for_all_classes
+      all_facets.group_by { |facet|
+        facet.name
+      }.collect { |name, facets|
+        if facets.collect { |facet| facet.type }.uniq.length > 1
+          raise "Facet #{name} exists in more than one model with different types"
+        end
+        facets.first.attribute_name
+      }
+    end
+    
+    def facet_names_common_to_all_classes
+      facet_names_for_all_classes.select { |name|
+        facet_classes.all? { |klass|
+          klass.sphinx_facets.detect { |facet|
+            facet.attribute_name == name
+          }
+        }
+      }
+    end
+    
+    def add_from_results(facet, results)
+      name = ThinkingSphinx::Facet.name_for(facet)
+      
+      self[name]  ||= {}
+      
+      return if results.empty?
+      
+      facet = facet_from_object(results.first, facet) if facet.is_a?(String)
+      
+      results.each_with_groupby_and_count { |result, group, count|
+        facet_value = facet.value(result, group)
+        
+        self[name][facet_value] ||= 0
+        self[name][facet_value]  += count
+      }
+    end
+    
+    def underlying_value(key, value)
+      case value
+      when Array
+        value.collect { |item| underlying_value(key, item) }
+      when String
+        value.to_crc32
+      else
+        value
+      end
+    end
+    
+    def facet_from_object(object, name)
+      object.sphinx_facets.detect { |facet| facet.attribute_name == name }
+    end
+  end
+end

data/lib/thinking_sphinx/field.rb

@@ -7,9 +7,8 @@ module ThinkingSphinx
   # generate SQL statements, you'll need to set the base model, and all the
   # associations. Which can get messy. Use Index.link!, it really helps.
   # 
-  class Field
-    attr_accessor :alias, :columns, :sortable, :associations, :model, :infixes,
-      :prefixes, :faceted
+  class Field < ThinkingSphinx::Property
+    attr_accessor :sortable, :infixes, :prefixes
     
     # To create a new field, you'll need to pass in either a single Column
     # or an array of them, and some (optional) options. The columns are
@@ -53,17 +52,14 @@ module ThinkingSphinx
     #     :as => :posts, :prefixes => true
     #   )
     # 
-    def initialize(columns, options = {})
-      @columns      = Array(columns)
-      @associations = {}
-
-      raise "Cannot define a field with no columns. Maybe you are trying to index a field with a reserved name (id, name). You can fix this error by using a symbol rather than a bare name (:id instead of id)." if @columns.empty? || @columns.any? { |column| !column.respond_to?(:__stack) }
+    def initialize(source, columns, options = {})
+      super
       
-      @alias    = options[:as]
       @sortable = options[:sortable] || false
       @infixes  = options[:infixes]  || false
       @prefixes = options[:prefixes] || false
-      @faceted  = options[:facet]    || false
+      
+      source.fields << self
     end
     
     # Get the part of the SELECT clause related to this field. Don't forget
@@ -77,96 +73,10 @@ module ThinkingSphinx
         column_with_prefix(column)
       }.join(', ')
       
-      clause = adapter.concatenate(clause) if concat_ws?
+      clause = adapter.concatenate(clause)       if concat_ws?
       clause = adapter.group_concatenate(clause) if is_many?
       
       "#{adapter.cast_to_string clause } AS #{quote_column(unique_name)}"
     end
-    
-    # Get the part of the GROUP BY clause related to this field - if one is
-    # needed. If not, all you'll get back is nil. The latter will happen if
-    # there's multiple data values (read: a has_many or has_and_belongs_to_many
-    # association).
-    #
-    def to_group_sql
-      case
-      when is_many?, ThinkingSphinx.use_group_by_shortcut?
-        nil
-      else
-        @columns.collect { |column|
-          column_with_prefix(column)
-        }
-      end
-    end
-    
-    # Returns the unique name of the field - which is either the alias of
-    # the field, or the name of the only column - if there is only one. If
-    # there isn't, there should be an alias. Else things probably won't work.
-    # Consider yourself warned.
-    #
-    def unique_name
-      if @columns.length == 1
-        @alias || @columns.first.__name
-      else
-        @alias
-      end
-    end
-    
-    def to_facet
-      return nil unless @faceted
-      
-      ThinkingSphinx::Facet.new(self)
-    end
-    
-    private
-    
-    def adapter
-      @adapter ||= @model.sphinx_database_adapter
-    end
-    
-    def quote_column(column)
-      @model.connection.quote_column_name(column)
-    end
-    
-    # Indication of whether the columns should be concatenated with a space
-    # between each value. True if there's either multiple sources or multiple
-    # associations.
-    # 
-    def concat_ws?
-      @columns.length > 1 || multiple_associations?
-    end
-        
-    # Checks whether any column requires multiple associations (which only
-    # happens for polymorphic situations).
-    # 
-    def multiple_associations?
-      associations.any? { |col,assocs| assocs.length > 1 }
-    end
-    
-    # Builds a column reference tied to the appropriate associations. This
-    # dives into the associations hash and their corresponding joins to
-    # figure out how to correctly reference a column in SQL.
-    #
-    def column_with_prefix(column)
-      if column.is_string?
-        column.__name
-      elsif associations[column].empty?
-        "#{@model.quoted_table_name}.#{quote_column(column.__name)}"
-      else
-        associations[column].collect { |assoc|
-          assoc.has_column?(column.__name) ?
-          "#{@model.connection.quote_table_name(assoc.join.aliased_table_name)}" + 
-          ".#{quote_column(column.__name)}" :
-          nil
-        }.compact.join(', ')
-      end
-    end
-    
-    # Could there be more than one value related to the parent record? If so,
-    # then this will return true. If not, false. It's that simple.
-    #
-    def is_many?
-      associations.values.flatten.any? { |assoc| assoc.is_many? }
-    end
   end
 end