thinking-sphinx-raspell 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Pat Allan
+
+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.textile

@@ -0,0 +1,51 @@
+h1. Thinking Sphinx with Raspell
+
+This library adds Aspell/Raspell support to "Thinking Sphinx":http://ts.freelancing-gods.com.
+
+h2. Installation
+
+You'll need "the Aspell library":http://www.aspell.net (easily compiled by source, or installed via MacPorts). Don't forget to install the English library as well - there's instructions for both in Evan Weaver's "Raspell README":http://github.com/fauna/raspell.
+
+Once that's set up, grab the gem from "GemCutter":http://gemcutter.org:
+
+<pre><code>sudo gem install thinking-sphinx-raspell \
+  --source http://gemcutter.org</code></pre>
+
+You'll want to add the gem to your @config/environment.rb@ file (assuming you're working on a Rails application):
+
+<pre><code>config.gem('thinking-sphinx-raspell',
+  :lib     => 'thinking_sphinx/raspell',
+  :source  => 'http://gemcutter.org',
+  :version => '>= 1.0.0'
+)</code></pre>
+
+Or, if you wish to do a manual require yourself:
+
+<pre><code>require 'thinking_sphinx/raspell'</code></pre>
+
+h2. Usage
+
+By default, Thinking Sphinx will not overwrite your search query, but you can view suggestions:
+
+<pre><code>@articles = Article.search 'pnacakes'
+@articles.suggestion? #=> true
+@articles.suggestion  #=> 'pancakes'</code></pre>
+
+You can also choose to redo the search using the provided suggestion:
+
+<pre><code>@articles.redo_with_suggestion
+@articles.each do |article|
+  # ...
+end</code></pre>
+
+h2. Limitations
+
+* Currently only uses (and thus requires) the en_US dictionary.
+* Spelling suggestions are done via Raspell's normal mode, and are case insensitive.
+* Only checks normal query strings, not field-specific queries via the @:conditions@ hash.
+
+Patches are very much welcome - I would like to address all of the above limitations.
+
+h2. Copyright
+
+Copyright (c) 2009 "Pat Allan":http://freelancing-gods.com. Released under an MIT licence.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 0
+:patch: 0

data/lib/thinking_sphinx/raspell.rb

@@ -0,0 +1,76 @@
+require 'raspell'
+
+module ThinkingSphinx
+  # Module for adding suggestion support into Thinking Sphinx. This gets
+  # included into ThinkingSphinx::Search.
+  # 
+  # @author Pat Allan
+  # 
+  module Raspell
+    # The original query, with words considered mispelt replaced with the first
+    # suggestion from Aspell/Raspell.
+    # 
+    # @return [String] the suggested query
+    # 
+    def suggestion
+      @suggestion ||= all_args.gsub(/[\w\']+/) { |word| corrected_word(word) }
+    end
+    
+    # An indication of whether there are any spelling corrections for the
+    # original query.
+    # 
+    # @return [Boolean] true if the suggested query is different from the
+    #   original
+    # 
+    def suggestion?
+      suggestion != query
+    end
+    
+    # Modifies the current search object, switching queries and removing any
+    # previously stored results.
+    # 
+    def redo_with_suggestion
+      @query      = nil
+      @args       = [suggestion]
+      @populated  = false
+    end
+    
+    private
+    
+    # The search query as a single string, excluding any field-focused values
+    # provided using the :conditions option.
+    # 
+    # @return [String] all query arguments joined together by spaces.
+    # 
+    def all_args
+      args.join(' ')
+    end
+    
+    # The first spelling suggestion, if the given word is considered incorrect,
+    # otherwise the word is returned unchanged.
+    # 
+    # @param [String] word The word to check.
+    # @return [String] Spelling correction for the given word.
+    # 
+    def corrected_word(word)
+      speller.check(word) ? word : speller.suggest(word).first
+    end
+    
+    # Aspell instance with all appropriate settings defined (dictionary set to
+    # en_US, suggestion mode set to Aspell::NORMAL, and ignore-case set to
+    # true).
+    # 
+    # @return [Aspell] the prepared Aspell instance
+    # 
+    def speller
+      @speller ||= begin
+        speller = Aspell.new('en_US')
+        speller.suggestion_mode = Aspell::NORMAL
+        speller.set_option "ignore-case", "true"
+        speller
+      end
+    end
+  end
+end
+
+ThinkingSphinx::Search.send(:include, ThinkingSphinx::Raspell)

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'spec'
+require 'spec/autorun'
+
+require 'thinking_sphinx'
+require 'raspell'
+require 'thinking_sphinx/raspell'
+
+Spec::Runner.configure do |config|
+  #
+end

data/spec/thinking_sphinx/raspell_spec.rb

@@ -0,0 +1,56 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::Search do
+  describe '#suggestion' do
+    it "should return a spelling suggestion, if there is one" do
+      search = ThinkingSphinx::Search.new('wodrs incorret on purpose')
+      search.suggestion.should == 'words incorrect on purpose'
+    end
+    
+    it "should be actual query if there is no suggestion" do
+      search = ThinkingSphinx::Search.new('words all correct here')
+      search.suggestion.should == 'words all correct here'
+    end
+  end
+  
+  describe '#suggestion?' do
+    it "should return true if there is a spelling suggestion" do
+      search = ThinkingSphinx::Search.new('wodrs incorret on purpose')
+      search.suggestion?.should be_true
+    end
+    
+    it "should return false if there is no spelling suggestion" do
+      search = ThinkingSphinx::Search.new('words all correct here')
+      search.suggestion?.should be_false
+    end
+  end
+  
+  describe '#redo_with_suggestion' do
+    before :each do
+      @config = ThinkingSphinx::Configuration.instance
+      @client = Riddle::Client.new
+
+      @config.stub!(:client => @client)
+      @client.stub!(:query => {:matches => [], :total_found => 0, :total => 0})
+    end
+    
+    it "should repeat the query with the spelling suggestion" do
+      @client.should_receive(:query) do |query, index, comment|
+        query.should == 'words incorrect on purpose'
+      end
+      
+      search = ThinkingSphinx::Search.new('wodrs incorret on purpose')
+      search.redo_with_suggestion
+      search.first
+    end
+    
+    it "should redo the query if it's already been populated" do
+      @client.should_receive(:query).twice
+      
+      search = ThinkingSphinx::Search.new('wodrs incorret on purpose')
+      search.first
+      search.redo_with_suggestion
+      search.first
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: thinking-sphinx-raspell
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thinking-sphinx
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: raspell
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Adds spelling suggestions to Thinking Sphinx searches.
+email: pat@freelancing-gods.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- LICENSE
+- README.textile
+- VERSION.yml
+- lib/thinking_sphinx/raspell.rb
+has_rdoc: true
+homepage: http://ts.freelancing-gods.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An add-on gem for spelling suggestions in Thinking Sphinx
+test_files: 
+- spec/spec_helper.rb
+- spec/thinking_sphinx/raspell_spec.rb