sunspot_suggest 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sunspot_hierarchical_facets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 rainkinz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# SunspotSpellcheck
+
+Adds spellchecking to sunspot
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sunspot_suggest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sunspot_suggest
+
+## Usage
+
+TODO: Write usage instructions here
+
+* Need jar added to solr installation, schema config etc
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sunspot_suggest/plugin.rb

@@ -0,0 +1,20 @@
+require 'sunspot_suggest/sunspot/query/suggest'
+require 'sunspot_suggest/sunspot/query/spellcheck'
+require 'sunspot_suggest/sunspot/query/common_query'
+
+require 'sunspot_suggest/sunspot/search/abstract_search'
+require 'sunspot_suggest/sunspot/dsl/standard_query'
+
+module Sunspot
+  module Util
+    class<<self
+      def method_case(string_or_symbol)
+        string = string_or_symbol.to_s
+        first = true
+        string.split('_').map! { |word| word = first ? word : word.capitalize; first = false; word }.join
+      end
+    end
+  end
+end
+
+

data/lib/sunspot_suggest/sunspot/dsl/standard_query.rb

@@ -0,0 +1,15 @@
+module Sunspot
+  module DSL #:nodoc:
+
+    class StandardQuery
+      def suggest(options = {})
+        @query.suggest(options)
+      end
+
+      def spellcheck(options = {})
+        @query.spellcheck(options)
+      end
+    end
+
+  end
+end

data/lib/sunspot_suggest/sunspot/query/common_query.rb

@@ -0,0 +1,16 @@
+module Sunspot
+  module Query
+
+    class CommonQuery
+
+      def suggest(options = {})
+        @components << Suggest.new(options)
+      end
+
+      def spellcheck(options = {})
+        @components << Spellcheck.new(options)
+      end
+
+    end
+  end
+end

data/lib/sunspot_suggest/sunspot/query/spellcheck.rb

@@ -0,0 +1,22 @@
+module Sunspot
+  module Query
+
+    class Spellcheck < Connective::Conjunction
+      attr_accessor :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def to_params
+        options = {}
+        @options.each do |key, val|
+          options["spellcheck." + Sunspot::Util.method_case(key)] = val
+        end
+        { :spellcheck => true }.merge(options)
+      end
+    end
+
+  end
+
+end

data/lib/sunspot_suggest/sunspot/query/suggest.rb

@@ -0,0 +1,28 @@
+module Sunspot
+  module Query
+
+    class Suggest < Connective::Conjunction
+      attr_accessor :options
+
+      def initialize(opts = {})
+        @options = opts
+      end
+
+      def to_params
+        opts = {}
+        @options.each do |key, val|
+          opts['spellcheck.' + Sunspot::Util.method_case(key)] = val
+        end
+
+        {
+          :spellcheck => true,
+          :rows => 0,
+          'spellcheck.count' => 10,
+        }.merge(opts)
+      end
+
+    end
+
+  end
+
+end

data/lib/sunspot_suggest/sunspot/search/abstract_search.rb

@@ -0,0 +1,130 @@
+module Sunspot
+
+  module Search
+
+    class Spellcheck
+
+      # TODO: Firm up the names of these a bit
+      class Collation
+        attr_reader :query, :suggestions, :hits
+
+        def initialize(args = {})
+          @query = args['collationQuery']
+          @hits = args['hits']
+          @suggestions = parse_corrections(args['misspellingsAndCorrections'])
+        end
+
+        private 
+
+        def parse_corrections(raw)
+          suggestions = []
+          raw.each_slice(2) do |k, v|
+            suggestions << Suggestions.new(k, [Suggestion.new(v)])
+          end
+          suggestions
+        end
+      end
+
+      # TODO: Rename this, make it enumerable?
+      class Suggestions
+        attr_reader :misspelling, :suggestions
+
+        def initialize(misspelling, suggestions)
+          @misspelling = misspelling
+          # TODO: FIXME
+          @suggestions = parse_suggestions(suggestions)
+        end
+
+        private
+
+        # TODO: FIXME
+        def parse_suggestions(suggestions)
+          []
+        end
+      end
+
+      class Suggestion
+        attr_reader :word
+
+        def initialize(word, freq = -1)
+          @word = word
+          @freq = freq
+        end
+
+        def to_s
+          @word
+        end
+      end
+
+      attr_reader :suggestions, :collations
+      attr_writer :correctly_spelled
+
+      def initialize
+        @suggestions = []
+        @collations = []
+      end
+
+      def correctly_spelled?
+        @correctly_spelled
+      end
+
+      def add_collation(collation_values)
+        if collation_values.is_a?(Array)
+          @collations << Collation.new(Hash[*collation_values])
+        else
+          raise ArgumentError, "Don't know how to handle collation: #{collation_values}"
+        end
+      end
+
+      def add_suggestion(word, suggest_values)
+        @suggestions << Suggestions.new(word, suggest_values)
+      end
+
+    end
+
+    class AbstractSearch
+
+      attr_accessor :solr_result
+
+
+      def suggested
+        raw = raw_suggestions
+        return nil unless raw.is_a?(Array)
+
+        s = SuggestedResult.new
+        Hash[*raw].each do |k, v|
+          if k == 'correctlySpelled'
+            s.correctly_spelled = v
+          else
+            s.query = k
+            s.suggestions = v['suggestion']
+          end
+        end
+        s
+      end
+
+
+      def spellcheck
+        spellcheck = Spellcheck.new
+
+        raw_suggestions.each_slice(2) do |k, v|
+          if k == 'collation'
+            spellcheck.add_collation(v)
+          elsif k == 'correctlySpelled'
+            spellcheck.correctly_spelled = (v == 'true')
+          else
+            spellcheck.add_suggestion(k, v)
+          end
+        end
+        spellcheck
+      end
+
+      private
+
+      def raw_suggestions
+        ["spellcheck", "suggestions"].inject(@solr_result) {|h, k| h && h[k]}
+      end
+
+    end
+  end
+end

data/lib/sunspot_suggest/version.rb

@@ -0,0 +1,3 @@
+module SunspotSuggest
+  VERSION = "0.0.1"
+end

data/lib/sunspot_suggest.rb

@@ -0,0 +1,6 @@
+require 'sunspot_suggest/version'
+require 'sunspot_suggest/plugin'
+
+module SunspotSuggest
+  # Your code goes here...
+end

data/spec/api/query/spellcheck_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe 'standard query', :type => :query do
+
+  it 'turns faceting on if facet is requested' do
+    search do
+      spellcheck
+    end
+
+    connection.should have_last_search_with(:spellcheck => true)
+  end
+
+  # TODO: Check other options
+
+  private
+
+  def search(*classes, &block)
+    classes[0] ||= Article
+    session.search(*classes, &block)
+  end
+end

data/spec/api/search/spellcheck_search_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+# Check that the responses from solr are parsed correctly by 
+# sunspot
+describe 'spellcheck', :type => :search do
+
+  context "spellcheck with extended results but no collations" do 
+    before(:each) do 
+      stub_spellcheck [
+      'perform',{
+        'numFound'=>3,
+        'startOffset'=>0,
+        'endOffset'=>7,
+        'origFreq'=>4,
+        'suggestion'=>[{
+            'word'=>'performed',
+            'freq'=>1},
+          {
+            'word'=>'performance',
+            'freq'=>3},
+          {
+            'word'=>'inform',
+            'freq'=>2}]},
+      'hvac',{
+        'numFound'=>1,
+        'startOffset'=>8,
+        'endOffset'=>12,
+        'origFreq'=>4,
+        'suggestion'=>[{
+            'word'=>'has',
+            'freq'=>1}]},
+      'correctlySpelled',false
+      ]
+    end
+
+    it 'creates corrections' do
+      result = session.search Article do
+        fulltext 'perfrm hvc'
+        spellcheck
+      end
+
+      spellcheck = result.spellcheck
+      collations = spellcheck.collations
+      expect(collations.size).to eq(0)
+
+      corrections = spellcheck.suggestions
+      expect(corrections.size).to eq(2)
+    end
+
+  end
+
+  context "spellcheck with extended results and collations" do 
+    before(:each) do 
+      stub_spellcheck [
+          "perfrm",
+          {
+            "numFound"=>3,
+            "startOffset"=>14,
+            "endOffset"=>20,
+            "origFreq"=>0,
+            "suggestion"=>
+              [
+                {"word"=>"perform", "freq"=>4},
+                {"word"=>"performed", "freq"=>1},
+                {"word"=>"performance", "freq"=>3}
+              ]
+          },
+         
+          "hvc",
+          {
+            "numFound"=>2,
+            "startOffset"=>21,
+            "endOffset"=>24,
+            "origFreq"=>0,
+            "suggestion"=>[
+              {"word"=>"hvac", "freq"=>4}, 
+              {"word"=>"have", "freq"=>5}
+            ]
+          },
+
+         "correctlySpelled", false,
+
+         "collation",
+         [
+           "collationQuery", "markup_texts:(perform hvac)",
+            "hits", 4,
+            "misspellingsAndCorrections", ["perfrm", "perform", "hvc", "hvac"]
+         ],
+         
+         "collation",
+         [
+            "collationQuery", "markup_texts:(performed hvac)",
+            "hits", 4,
+            "misspellingsAndCorrections", ["perfrm", "performed", "hvc", "hvac"]
+         ]
+        ]
+
+
+    end
+
+    it 'parses the suggestions' do
+      result = session.search Article do
+        fulltext 'perfrm hvc'
+        spellcheck
+      end
+
+      spelling_suggestions = result.spellcheck
+      collations = spelling_suggestions.collations
+      expect(collations.size).to eq(2)
+      expect(collations.first.query).to eq('markup_texts:(perform hvac)')
+    end
+
+  end
+
+end
+

data/spec/article.rb

@@ -0,0 +1,12 @@
+class Article < SuperClass
+  attr_accessor :title, :body, :category
+end
+
+Sunspot.setup(Post) do
+  text :title
+end
+
+Sunspot.setup(Article) do
+  text :title
+  text :body
+end

data/spec/helpers/indexer_helper.rb

@@ -0,0 +1,17 @@
+module IndexerHelper
+  def post(attrs = {})
+    @post ||= Post.new(attrs)
+  end
+
+  def last_add
+    @connection.adds.last
+  end
+
+  def value_in_last_document_for(field_name)
+    @connection.adds.last.last.field_by_name(field_name).value
+  end
+
+  def values_in_last_document_for(field_name)
+    @connection.adds.last.last.fields_by_name(field_name).map { |field| field.value }
+  end
+end

data/spec/helpers/integration_helper.rb

@@ -0,0 +1,8 @@
+module IntegrationHelper
+  def self.included(base)
+    base.before(:all) do
+      Sunspot.config.solr.url = ENV['SOLR_URL'] || 'http://localhost:8983/solr/default'
+      Sunspot.reset!(true)
+    end
+  end
+end

data/spec/helpers/mock_session_helper.rb

@@ -0,0 +1,13 @@
+module MockSessionHelper
+  def config
+    @config ||= Sunspot::Configuration.build
+  end
+
+  def connection
+    @connection ||= Mock::Connection.new
+  end
+
+  def session
+    @session ||= Sunspot::Session.new(config, connection)
+  end
+end

data/spec/helpers/query_helper.rb

@@ -0,0 +1,26 @@
+module QueryHelper
+  def get_filter_tag(boolean_query)
+    connection.searches.last[:fq].each do |fq|
+      if match = fq.match(/^\{!tag=(.+)\}#{Regexp.escape(boolean_query)}$/)
+        return match[1]
+      end
+    end
+    nil
+  end
+
+  def subqueries(param)
+    q = connection.searches.last[:q]
+    subqueries = []
+    subqueries = q.scan(%r(_query_:"\{!dismax (.*?)\}(.*?)"))
+    subqueries.map do |subquery|
+      params = {}
+      subquery[0].scan(%r((\S+?)='(.+?)')) do |key, value|
+        params[key.to_sym] = value
+      end
+      unless subquery[1].empty?
+        params[:v] = subquery[1]
+      end
+      params
+    end
+  end
+end

data/spec/helpers/search_helper.rb

@@ -0,0 +1,68 @@
+module SearchHelper
+  def stub_nil_results
+    connection.response = { 'response' => nil }
+  end
+
+  def stub_full_results(*results)
+    count =
+      if results.last.is_a?(Integer) then results.pop
+      else results.length
+      end
+    docs = results.map do |result|
+      instance = result.delete('instance')
+      result.merge('id' => "#{instance.class.name} #{instance.id}")
+    end
+    response = {
+      'response' => {
+        'docs' => docs,
+        'numFound' => count
+      }
+    }
+    connection.response = response
+    response
+  end
+
+  def stub_results(*results)
+    stub_full_results(
+      *results.map do |result|
+        if result.is_a?(Integer)
+          result
+        else
+          { 'instance' => result }
+        end
+      end
+    )
+  end
+
+  def stub_facet(name, values)
+    connection.response = {
+      'facet_counts' => {
+        'facet_fields' => {
+          name.to_s => values.to_a.sort_by { |value, count| -count }.flatten
+        }
+      }
+    }
+  end
+
+  def stub_date_facet(name, gap, values)
+    connection.response = {
+      'facet_counts' => {
+        'facet_dates' => {
+          name.to_s => { 'gap' => "+#{gap}SECONDS" }.merge(values)
+        }
+      }
+    }
+  end
+
+  def stub_query_facet(values)
+    connection.response = { 'facet_counts' => { 'facet_queries' => values } }
+  end
+
+  def facet_values(result, field_name)
+    result.facet(field_name).rows.map { |row| row.value }
+  end
+
+  def facet_counts(result, field_name)
+    result.facet(field_name).rows.map { |row| row.count }
+  end
+end

data/spec/helpers/spellcheck_helper.rb

@@ -0,0 +1,66 @@
+module SpellcheckHelper
+   
+  # TODO: Need a better way to build up suggestions
+  def stub_spellcheck(suggestions)
+    connection.response = {
+      'spellcheck' => {
+        'suggestions' => suggestions
+      }
+    }
+    
+    if connection.response['responseHeader'].nil?
+      connection.response['responseHeader'] = {}
+    end
+
+
+  end
+
+{"suggestions"=>
+  [
+    "perfrm",
+    {
+      "numFound"=>3,
+      "startOffset"=>14,
+      "endOffset"=>20,
+      "origFreq"=>0,
+      "suggestion"=>
+        [
+          {"word"=>"perform", "freq"=>4},
+          {"word"=>"performed", "freq"=>1},
+          {"word"=>"performance", "freq"=>3}
+        ]
+    },
+   
+    "hvc",
+    {
+      "numFound"=>2,
+      "startOffset"=>21,
+      "endOffset"=>24,
+      "origFreq"=>0,
+      "suggestion"=>[
+        {"word"=>"hvac", "freq"=>4}, 
+        {"word"=>"have", "freq"=>5}
+      ]
+    },
+
+   "correctlySpelled", false,
+
+   "collation",
+   [
+     "collationQuery", "markup_texts:(perform hvac)",
+      "hits", 4,
+      "misspellingsAndCorrections", ["perfrm", "perform", "hvc", "hvac"]
+   ],
+   
+   "collation",
+   [
+      "collationQuery", "markup_texts:(performed hvac)",
+      "hits", 4,
+      "misspellingsAndCorrections", ["perfrm", "performed", "hvc", "hvac"]
+   ]
+  ]
+}
+
+
+end
+