spree_sphinx_search 0.30.0.beta1

data/README.markdown

@@ -0,0 +1,28 @@
+Sphinx Search
+=============
+
+### Installation
+
+1. Install Sphinx 0.9.9
+1. Install Aspell 0.6 and at least one Aspell dictionary
+      Mac:
+        sudo port install aspell aspell-dict-en
+
+      Ubuntu:
+        sudo apt-get install aspell libaspell-dev aspell-en
+
+1. `script/extension install git://github.com/pronix/spree-sphinx-search.git`
+1. Copy config/sphinx.yml to RAILS_ROOT/config/sphinx.yml
+
+**NOTE:** This extension works only with Spree 0.30 and higher.
+
+### Usage
+
+To perform the indexing:
+
+    rake ts:index
+
+To start Sphinx for development:
+
+    cd RAILS_ROOT/config
+    sphinxd --config development.sphinx.conf

data/Rakefile

@@ -0,0 +1,137 @@
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? SPREE_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["SPREE_ENV_FILE"]
+    require File.dirname(ENV["SPREE_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/SPREE/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(SPREE_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the SPREE_ROOT constant so specs will load the environment
+Object.send(:remove_const, :SPREE_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList["#{extension_root}/spec/**/*_spec.rb"]
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the sphinx_search extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SphinxSearchExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the sphinx_search extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+namespace :test do
+  desc 'Functional test the sphinx_search extension.'
+  Rake::TestTask.new(:functionals) do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/functional/*_test.rb'
+    t.verbose = true
+  end
+
+  desc 'Unit test the sphinx_search extension.'
+  Rake::TestTask.new(:units) do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/unit/*_test.rb'
+    t.verbose = true
+  end
+end
+
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/controllers/products_controller_decorator.rb

@@ -0,0 +1,15 @@
+ProductsController.class_eval do
+  helper :sphinx
+  helper_method :option_values
+  private
+  def option_values(ids = [])
+    @option_values ||= {}
+    return @option_values if ids.empty?
+    option_values_for_ids = {}
+    OptionValue.find(ids).each do |ov|
+      option_values_for_ids[ov.id] = ov.presentation
+    end
+    @option_values.merge!(option_values_for_ids)
+    return option_values_for_ids
+  end
+end

data/app/helpers/sphinx_helper.rb

@@ -0,0 +1,8 @@
+module SphinxHelper
+  def link_to_facet(name, value, count, link_name = "#{value} (#{count})") 
+      facets_hash = params[:facets]
+      facets_hash = {} unless facets_hash.is_a?(Hash)
+      facets_hash = facets_hash.merge({name => [value, facets_hash[name]].join(', ')})
+      link_to(link_name, :overwrite_params => params.merge({:facets => facets_hash}))
+  end
+end

data/app/models/product_decorator.rb

@@ -0,0 +1,36 @@
+Product.class_eval do
+
+      define_index do
+        is_active_sql = "(products.deleted_at IS NULL AND products.available_on <= NOW() #{'AND (products.count_on_hand > 0)' unless Spree::Config[:allow_backorders]} )"
+        option_sql = lambda do |option_name|
+          sql = <<-eos
+            SELECT DISTINCT p.id, ov.id
+            FROM option_values AS ov
+            LEFT JOIN option_types AS ot ON (ov.option_type_id = ot.id)
+            LEFT JOIN option_values_variants AS ovv ON (ovv.option_value_id = ov.id)
+            LEFT JOIN variants AS v ON (ovv.variant_id = v.id)
+            LEFT JOIN products AS p ON (v.product_id = p.id)
+            WHERE (ot.name = '#{option_name}' AND p.id>=$start AND p.id<=$end);
+          eos
+          sql.gsub("\n", ' ').gsub('  ', '')
+        end
+
+    brand_sql = option_sql.call('brand')
+    color_sql = option_sql.call('color')
+    size_sql  = option_sql.call('size')
+
+        set_property :sql_range_step => 1000000
+        indexes :name
+        indexes :description
+        indexes :meta_description
+        indexes :meta_keywords
+        indexes taxons.name, :as => :taxon, :facet => true
+        has taxons(:id), :as => :taxon_ids
+        group_by :deleted_at
+        group_by :available_on
+        has is_active_sql, :as => :is_active, :type => :boolean
+        has brand_sql , :as => :brand_option, :source => :ranged_query, :type => :multi, :facet => true
+#        has color_sql , :as => :color_option, :source => :ranged_query, :type => :multi, :facet => true
+#        has size_sql , :as => :size_option, :source => :ranged_query, :type => :multi, :facet => true
+      end
+end

data/app/views/products/_facets.html.erb

@@ -0,0 +1,23 @@
+<%
+facets = @searcher.facets || []
+price_ranges = YAML::load(Spree::Config[:product_price_ranges])
+  for facet in facets
+    options = facet.options
+    options = options.sort{|x,y| y.count <=> x.count} unless facet.name == :price_range
+    unless options.empty? %>
+      <h4><%= t "#{facet.name}_facet" %></h4>
+      <ul><%
+        for option in options %>
+          <li>
+            <% if facet.name == :price_range -%>
+              <%= link_to_facet(facet.name, option.name, option.count,
+                                "#{price_ranges[option.name.to_i]} (#{option.count})") -%>
+            <% else -%>
+              <%= link_to_facet(facet.name, option.name, option.count) -%>
+            <% end -%>
+          </li><%
+        end %>
+      </ul><%
+    end
+  end
+%>

data/app/views/products/_suggestion.html.erb

@@ -0,0 +1,6 @@
+<% if suggestion = @searcher.suggest %>
+  <p>
+    <%= t(:did_you_mean, :default => "Did you mean") %>
+    <%= link_to h(suggestion), :overwrite_params => { :keywords => suggestion } %>?
+  </p>
+<% end %>

data/config/locales/en-US.yml

@@ -0,0 +1,6 @@
+en-US:
+  taxon_facet: "Category"
+  price_range_facet: "Price"
+  brand_option_facet: "Brand"
+  color_option_facet: "Color"
+  size_option_facet: "Size"

data/config/locales/ru-RU.yml

@@ -0,0 +1,4 @@
+ru-RU:
+  taxon_facet: "Категория"
+  price_range_facet: "Цена"
+  did_you_mean: "Вы имели в виду"

data/config/routes.rb

@@ -0,0 +1,5 @@
+# Put your extension routes here.
+
+# map.namespace :admin do |admin|
+#   admin.resources :whatever
+# end  

data/config/sphinx.yml

@@ -0,0 +1,15 @@
+development:
+  sql_range_step: 10000000
+  enable_star: 1
+  min_infix_len: 1
+  morphology: stem_en
+  mem_limit: 128M
+  max_matches: 25000
+
+production:
+  sql_range_step: 10000000
+  enable_star: 1
+  min_infix_len: 1
+  morphology: stem_en
+  mem_limit: 128M
+  max_matches: 25000

data/lib/spree/search/thinking_sphinx.rb

@@ -0,0 +1,101 @@
+module Spree::Search
+  class ThinkingSphinx < Spree::Search::Base
+    protected
+    # method should return AR::Relations with conditions {:conditions=> "..."} for Product model
+    def get_products_conditions_for(base_scope,query)
+      search_options = {:page => page, :per_page => per_page}
+      if order_by_price
+        search_options.merge!(:order => :price,
+                              :sort_mode => (order_by_price == 'descend' ? :desc : :asc))
+      end
+      if facets_hash
+        search_options.merge!(:conditions => facets_hash)
+      end
+      with_opts = {:is_active => 1}
+      if taxon
+        taxon_ids = taxon.self_and_descendants.map(&:id)
+        with_opts.merge!(:taxon_ids => taxon_ids)
+      end
+      search_options.merge!(:with => with_opts)
+      facets = Product.facets(query, search_options)
+      products = facets.for
+
+      @properties[:products] = products
+      @properties[:facets] = parse_facets_hash(facets)
+      @properties[:suggest] = nil if @properties[:suggest] == query
+      
+      Product.where("id IN (?)", products.map(&:id))
+    end
+
+    def prepare(params)
+      @properties[:facets_hash] = params[:facets] || {}
+      @properties[:taxon] = params[:taxon].blank? ? nil : Taxon.find(params[:taxon])
+      @properties[:keywords] = params[:keywords]
+      per_page = params[:per_page].to_i
+      @properties[:per_page] = per_page > 0 ? per_page : Spree::Config[:products_per_page]
+      @properties[:page] = (params[:page].to_i <= 0) ? 1 : params[:page].to_i
+      @properties[:manage_pagination] = true
+      @properties[:order_by_price] = params[:order_by_price]
+      if !params[:order_by_price].blank?
+        @product_group = ProductGroup.new.from_route([params[:order_by_price]+"_by_master_price"])
+      elsif params[:product_group_name]
+        @cached_product_group = ProductGroup.find_by_permalink(params[:product_group_name])
+        @product_group = ProductGroup.new
+      elsif params[:product_group_query]
+        @product_group = ProductGroup.new.from_route(params[:product_group_query].split("/"))
+      else
+        @product_group = ProductGroup.new
+      end
+      @product_group = @product_group.from_search(params[:search]) if params[:search]
+    end
+
+private
+
+    # method should return new scope based on base_scope
+    def parse_facets_hash(facets_hash = {})
+      facets = []
+      price_ranges = YAML::load(Spree::Config[:product_price_ranges])
+      facets_hash.each do |name, options|
+        next if options.size <= 1
+        facet = Facet.new(name)
+        options.each do |value, count|
+          next if value.blank?
+          facet.options << FacetOption.new(value, count)
+        end
+        facets << facet
+      end
+      facets
+    end
+  end
+
+  class Facet
+    attr_accessor :options
+    attr_accessor :name
+    def initialize(name, options = [])
+      self.name = name
+      self.options = options
+    end
+
+    def self.translate?(property)
+      return true if property.is_a?(ThinkingSphinx::Field)
+
+      case property.type
+      when :string
+        true
+      when :integer, :boolean, :datetime, :float
+        false
+      when :multi
+        false # !property.all_ints?
+      end
+    end
+  end
+
+  class FacetOption
+    attr_accessor :name
+    attr_accessor :count
+    def initialize(name, count)
+      self.name = name
+      self.count = count
+    end
+  end
+end

data/lib/spree_sphinx_search.rb

@@ -0,0 +1,23 @@
+require 'spree_core'
+require 'spree_sphinx_search_hooks'
+require 'thinking-sphinx'
+
+module SpreeSphinxSearch
+  class Engine < Rails::Engine
+    def self.activate
+      ENV['RAILS_ENV'] = Rails.env
+
+      if Spree::Config.instance
+        Spree::Config.searcher_class = Spree::Search::ThinkingSphinx
+        Spree::Config.set(:product_price_ranges => 
+                      ["Under $25", "$25 to $50", "$50 to $100", "$100 to $200", "$200 and above"])
+      end
+
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env == "production" ? require(c) : load(c)
+      end
+    end
+    config.to_prepare &method(:activate).to_proc
+    config.autoload_paths += %W(#{config.root}/lib)
+  end
+end

data/lib/spree_sphinx_search_hooks.rb

@@ -0,0 +1,4 @@
+class SphinxSearchHooks < Spree::ThemeSupport::HookListener
+  insert_before :search_results, 'products/facets'
+  insert_before :search_results, 'products/suggestion'
+end

data/lib/tasks/thinking_sphinx_tasks.rake

@@ -0,0 +1,5 @@
+begin
+  require 'thinking_sphinx/tasks'
+rescue LoadError
+  puts "WARNING: thinking-sphinx gem appears to be unavailable. Please install with rake gems:install."
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+unless defined? SPREE_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["SPREE_ENV_FILE"]
+    require ENV["SPREE_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/SPREE/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{SPREE_ROOT}/spec/spec_helper"
+
+if File.directory?(File.dirname(__FILE__) + "/scenarios")
+  Scenario.load_paths.unshift File.dirname(__FILE__) + "/scenarios"
+end
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

data/spree_sphinx_search.gemspec

@@ -0,0 +1,29 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{spree_sphinx_search}
+  s.version = "0.30.0.beta1"
+  s.authors = ["Roman Smirnov"]
+  s.description = "Search for Spree via Sphinx."
+  s.summary = "Search for Spree via Sphinx."
+  s.required_ruby_version = '>= 1.8.7'  
+
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.homepage = %q{http://github.com/romul/spree-sphinx-search}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.add_dependency(%q<spree_core>, [">= 0.30.0"])
+    s.add_dependency(%q<thinking-sphinx>, [">= 2.0.2.1"])
+    s.add_dependency(%q<thinking-sphinx-raspell>,[">= 1.1.0"])
+  end
+end
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: spree_sphinx_search
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 30
+  - 0
+  - beta1
+  version: 0.30.0.beta1
+platform: ruby
+authors: 
+- Roman Smirnov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-09 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 30
+        - 0
+        version: 0.30.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thinking-sphinx
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 2
+        - 1
+        version: 2.0.2.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thinking-sphinx-raspell
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id003
+description: Search for Spree via Sphinx.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- app/controllers/products_controller_decorator.rb
+- app/helpers/sphinx_helper.rb
+- app/models/product_decorator.rb
+- app/views/products/_facets.html.erb
+- app/views/products/_suggestion.html.erb
+- config/locales/en-US.yml
+- config/locales/ru-RU.yml
+- config/routes.rb
+- config/sphinx.yml
+- lib/spree/search/thinking_sphinx.rb
+- lib/spree_sphinx_search.rb
+- lib/spree_sphinx_search_hooks.rb
+- lib/tasks/thinking_sphinx_tasks.rake
+- spec/spec.opts
+- spec/spec_helper.rb
+- spree_sphinx_search.gemspec
+has_rdoc: true
+homepage: http://github.com/romul/spree-sphinx-search
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Search for Spree via Sphinx.
+test_files: []
+