spree_solr_search 0.30.0.beta1

data/.gitignore

@@ -0,0 +1,3 @@
+solr
+log/*.log
+tmp/pids/*

data/README.md

@@ -0,0 +1,34 @@
+Solr Search
+===========
+
+### Installation
+
+1. Add `gem "spree_solr_search"` to your Gemfile
+1. Run `bundle install`
+1. Run `rails g spree_solr_search:install`
+
+**NOTE:** Master branch works only with Spree 0.30.x. 
+If you want use this extension with Spree 0.10.x or 0.11.x, then you should use spree-0-11-stable branch
+    
+### Usage
+
+To perform the indexing:
+
+    rake solr:reindex BATCH=500
+
+
+To start Solr demo-server:
+
+    rake solr:start SOLR_PATH="/home/roman/www/jetty-solr"
+
+To stop Solr demo-server:
+
+    rake solr:stop
+    
+To configure production Solr server:
+
+    edit RAILS_ROOT/config/solr.yml
+
+P.S. For development recommended use [jetty-solr](http://github.com/dcrec1/jetty-solr) server.
+
+

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'rubygems'
+begin
+  require 'jeweler'
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+  exit 1
+end
+#gem 'rdoc', '= 2.2'
+#require 'rdoc'
+require 'rake'
+require 'rake/testtask'
+#require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+Jeweler::Tasks.new do |s|
+  s.name = "spree_solr_search"
+  s.summary = "Provides search via Apache Solr for a Spree store."
+  s.description = s.summary
+  s.email = "roman@railsdog.com"
+  s.homepage = "http://github.com/romul/spree-solr-search"
+  s.authors = ["Roman Smirnov"]
+  # s.add_dependency 'spree_core', ['>= 0.30.0.beta1']
+  s.add_dependency 'acts_as_solr_reloaded', ['>= 1.4.0']
+  s.has_rdoc = false
+  #s.extra_rdoc_files = [ "README.rdoc"]
+  #s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
+  #s.test_files = Dir['test/**/*.{yml,rb}']
+end
+Jeweler::GemcutterTasks.new
+
+desc "Default Task"
+task :default => [ :test ]
+
+# Run the unit tests
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.warning = true
+}

data/VERSION

@@ -0,0 +1 @@
+0.30.0.beta1

data/app/controllers/spree/base_controller_decorator.rb

@@ -0,0 +1,9 @@
+Spree::BaseController.class_eval do
+  helper :solr
+  before_filter :set_searcher
+  RAILS_ROOT = Rails.root.to_s
+  private
+  def set_searcher
+    Spree::Config.searcher = Spree::Search::Solr.new    
+  end
+end

data/app/helpers/solr_helper.rb

@@ -0,0 +1,8 @@
+module SolrHelper
+  def link_to_facet(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("#{value} (#{count})", url_for(request.params.merge({:facets => facets_hash})))
+  end
+end

data/app/models/product_decorator.rb

@@ -0,0 +1,66 @@
+Product.class_eval do
+  acts_as_solr  :fields => [:name, :description, :is_active, {:price => :float}, 
+                            :taxon_ids, :price_range, :taxon_names,
+                            :brand_property, :color_option, :size_option],
+                :facets=>[:price_range, :taxon_names,
+                          :brand_property, :color_option, :size_option]
+
+  def taxon_ids
+    taxons.map(&:id)
+  end
+  
+  def is_active
+    !deleted_at && 
+      (available_on <= Time.zone.now) && 
+        (Spree::Config[:allow_backorders] || count_on_hand > 0)
+  end
+  
+  private
+  
+  def taxon_names
+    taxons.map(&:name)
+  end
+  
+  def price_range
+    price_ranges = YAML.load(Spree::Config[:product_price_ranges])
+    case price
+      when 0..25
+        price_ranges[0]
+      when 25..50
+        price_ranges[1]
+      when 50..100
+        price_ranges[2]
+      when 100..200
+        price_ranges[3]
+      else
+        price_ranges[4]
+    end
+  end
+  
+  def brand_property
+    pp = ProductProperty.first(:joins => :property, 
+          :conditions => {:product_id => self.id, :properties => {:name => 'brand'}})
+    pp ? pp.value : ''
+  end
+
+  def color_option
+    get_option_values('color')
+  end
+
+  def size_option
+    get_option_values('size')
+  end
+  
+  def get_option_values(option_name)
+    sql = <<-eos
+      SELECT DISTINCT ov.id, ov.presentation
+      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 = #{self.id});
+    eos
+    OptionValue.find_by_sql(sql).map(&:presentation)     
+  end
+end

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

@@ -0,0 +1,18 @@
+<% 
+facets = Spree::Config.searcher.facets || []
+  taxon_names = @taxon ? @taxon.self_and_descendants.map(&:name) : []
+  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>
+            <%= link_to_facet(facet.name, option.name, option.count) %>
+          </li><%
+        end %> 
+      </ul><%
+    end
+  end 
+%>

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

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

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  taxon_names_facet: "Taxon"
+  price_range_facet: "Price"
+  brand_property_facet: "Brand"
+  color_option_facet: "Color"
+  size_option_facet: "Size"

data/config/locales/ru-RU.yml

@@ -0,0 +1,6 @@
+ru-RU:
+  taxon_names_facet: "Категория"
+  price_range_facet: "Цена"
+  brand_property_facet: "Бренд"
+  color_option_facet: "Цвет"
+  size_option_facet: "Размер"

data/config/locales/ru.yml

@@ -0,0 +1,6 @@
+ru:
+  taxon_names_facet: "Категория"
+  price_range_facet: "Цена"
+  brand_property_facet: "Бренд"
+  color_option_facet: "Цвет"
+  size_option_facet: "Размер"

data/lib/generators/spree_solr_search/install_generator.rb

@@ -0,0 +1,17 @@
+module SpreeSolrSearch
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Configures your Rails application for use with spree_solr_search."
+
+      def copy_config
+        template "solr.yml", "config/solr.yml"
+      end
+
+      # def show_readme
+      #   readme "README" if behavior == :invoke
+      # end
+    end
+  end
+end

data/lib/generators/templates/solr.yml

@@ -0,0 +1,15 @@
+# Config file for the acts_as_solr plugin.
+#
+# If you change the host or port number here, make sure you update 
+# them in your Solr config file
+
+development:
+  url: http://127.0.0.1:8982/solr
+  
+production:
+  url: http://127.0.0.1:8983/solr
+  jvm_options: -server -d64 -Xmx1024M -Xms64M
+
+test:
+  url: http://127.0.0.1:8981/solr
+

data/lib/solr_pagination.rb

@@ -0,0 +1,19 @@
+# By Henrik Nyh <http://henrik.nyh.se> 2007-06-15.
+# Free to modify and redistribute with credit.
+
+# Adds a find_all_by_solr method to acts_as_solr models to enable 
+# will_paginate for acts_as_solr search results.
+
+module ActsAsSolr
+  module PaginationExtension
+
+    def find_all_by_solr(query, options)
+      Spree::Config.searcher.products.slice(options[:offset], options[:limit])
+    end
+
+  end
+end
+
+module ActsAsSolr::ClassMethods
+  include ActsAsSolr::PaginationExtension
+end

data/lib/spree/search/solr.rb

@@ -0,0 +1,92 @@
+module Spree::Search
+  class Solr < Spree::Search::Base
+    # method should return hash with conditions {:conditions=> "..."} for Product model
+    def get_products_conditions_for(query)
+      facets = {
+          :fields => [:price_range, :taxon_names, :brand_property, :color_option, :size_option],
+          :browse => @properties[:facets_hash].map{|k,v| "#{k}:#{v}"},
+          :zeros => false 
+      }
+      search_options = {:facets => facets, :limit => 25000, :lazy => true}
+      if order_by_price
+        search_options.merge!(:order => (order_by_price == 'descend') ? "price desc" : "price asc")
+      end
+      full_query = query + " AND is_active:(true)"
+      if taxon 
+        taxons_query = taxon.self_and_descendants.map{|t| "taxon_ids:(#{t.id})"}.join(" OR ")
+        full_query += " AND (#{taxons_query})"
+      end
+
+      result = Product.find_by_solr(full_query, search_options)
+      @properties[:products] = result.records
+      count = result.records.size
+
+      products = Product.paginate(query, :finder => 'find_all_by_solr',
+                  :page => page, :per_page => per_page, :total_entries => count)
+
+      @properties[:products] = products
+      @properties[:suggest] = nil
+      begin
+      if suggest = result.suggest
+        suggest.sub!(/\sAND.*/, '')
+        @properties[:suggest] = suggest if suggest != query
+      end
+      rescue
+      end
+      
+      @properties[:facets] = parse_facets_hash(result.facets)
+      {:conditions=> ["products.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[:per_page] = params[:per_page]
+      @properties[:page] = params[:page]
+      @properties[:manage_pagination] = true
+      @properties[:order_by_price] = params[:order_by_price]
+    end
+    
+    private
+    
+    def parse_facets_hash(facets_hash = {"facet_fields" => {}})
+      facets = []
+      price_ranges = YAML::load(Spree::Config[:product_price_ranges])
+      facets_hash["facet_fields"].each do |name, options|
+        next if options.size <= 1
+        facet = Facet.new(name.sub('_facet', ''))
+        if name == 'price_range_facet'
+          price_ranges.each do |price_range|           
+            count = options[price_range]
+            facet.options << FacetOption.new(price_range, count) if count
+          end
+        else
+          options.each do |value, count|
+            facet.options << FacetOption.new(value, count)
+          end
+        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
+  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_solr_search.rb

@@ -0,0 +1,21 @@
+require 'spree_core'
+require 'spree_solr_search_hooks'
+
+module SpreeSolrSearch
+  class Engine < Rails::Engine
+    def self.activate
+      require 'acts_as_solr'
+      require 'solr_pagination'   
+      ENV['RAILS_ENV'] = Rails.env
+
+      Spree::Config.set(:product_price_ranges => 
+           ["Under $25", "$25 to $50", "$50 to $100", "$100 to $200", "$200 and above"])
+
+      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_solr_search_hooks.rb

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

data/lib/tasks/acts_as_solr.rake

@@ -0,0 +1,10 @@
+begin
+  ENV['ONLY'] = "Product"
+  SOLR_PATH = ENV['SOLR_PATH']
+  RAILS_DEFAULT_LOGGER = Logger.new(Rails.root.join("log", Rails.env + ".log"))
+  RAILS_ROOT = Rails.root.to_s
+  require 'acts_as_solr_reloaded'
+  load 'tasks/solr.rake'
+rescue LoadError
+  puts "WARNING: acts_as_solr_reloaded gem appears to be unavailable.  Please install with bundle install."
+end

data/spree_solr_search.gemspec

@@ -0,0 +1,59 @@
+# 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_solr_search}
+  s.version = "0.30.0.beta1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roman Smirnov"]
+  s.date = %q{2010-08-26}
+  s.description = %q{Provides search via Apache Solr for a Spree store.}
+  s.email = %q{roman@railsdog.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/spree/base_controller_decorator.rb",
+     "app/helpers/solr_helper.rb",
+     "app/models/product_decorator.rb",
+     "app/views/products/_facets.html.erb",
+     "app/views/products/_suggestion.html.erb",
+     "config/locales/en.yml",
+     "config/locales/ru-RU.yml",
+     "config/locales/ru.yml",
+     "lib/generators/spree_solr_search/install_generator.rb",
+     "lib/generators/templates/solr.yml",
+     "lib/solr_pagination.rb",
+     "lib/spree/search/solr.rb",
+     "lib/spree_solr_search.rb",
+     "lib/spree_solr_search_hooks.rb",
+     "lib/tasks/acts_as_solr.rake",
+     "spree_solr_search.gemspec"
+  ]
+  s.homepage = %q{http://github.com/romul/spree-solr-search}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Provides search via Apache Solr for a Spree store.}
+
+  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<acts_as_solr_reloaded>, [">= 1.4.0"])
+    else
+      s.add_dependency(%q<acts_as_solr_reloaded>, [">= 1.4.0"])
+    end
+  else
+    s.add_dependency(%q<acts_as_solr_reloaded>, [">= 1.4.0"])
+  end
+end
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: spree_solr_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: 2010-08-26 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: acts_as_solr_reloaded
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id001
+description: Provides search via Apache Solr for a Spree store.
+email: roman@railsdog.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- app/controllers/spree/base_controller_decorator.rb
+- app/helpers/solr_helper.rb
+- app/models/product_decorator.rb
+- app/views/products/_facets.html.erb
+- app/views/products/_suggestion.html.erb
+- config/locales/en.yml
+- config/locales/ru-RU.yml
+- config/locales/ru.yml
+- lib/generators/spree_solr_search/install_generator.rb
+- lib/generators/templates/solr.yml
+- lib/solr_pagination.rb
+- lib/spree/search/solr.rb
+- lib/spree_solr_search.rb
+- lib/spree_solr_search_hooks.rb
+- lib/tasks/acts_as_solr.rake
+- spree_solr_search.gemspec
+has_rdoc: true
+homepage: http://github.com/romul/spree-solr-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: 
+      - 0
+      version: "0"
+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: Provides search via Apache Solr for a Spree store.
+test_files: []
+