thinking-sphinx-raspell 1.0.0 → 1.1.0

data/README.textile

@@ -38,13 +38,28 @@ You can also choose to redo the search using the provided suggestion:
   # ...
 end</code></pre>
 
+h2. Configuration
+
+You can customise the following settings - either in your @config/environment.rb@ file, or perhaps in an initializer. Example syntax below highlights the current defaults.
+
+<pre><code>config = ThinkingSphinx::Configuration.instance
+config.raspell.dictionary             = 'en'
+config.raspell.suggestion_mode        = :normal
+config.raspell.options['ignore-case'] = true</code></pre>
+
+You can look at the available options using the following two collections:
+
+<pre><code>config = ThinkingSphinx::Configuration.instance
+config.raspell.dictionaries     #=> ['en', 'en_GB', 'en_US', ... ]
+config.raspell.suggestion_modes #=> [:ultra, :fast, :normal, :badspellers]</code></pre>
+
+If you need more documentation, you can check out the YARD files "on rdoc.info":http://rdoc.info/projects/freelancing-god/thinking-sphinx-raspell.  This isn't a big library, though - what you see in this readme is pretty much what you get.
+
 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.
+Patches are very much welcome - I would like to address this last remaining limitation.
 
 h2. Copyright
 

data/VERSION.yml

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

data/lib/thinking_sphinx/raspell.rb

@@ -1,4 +1,5 @@
 require 'raspell'
+require 'thinking_sphinx/raspell/configuration'
 
 module ThinkingSphinx
   # Module for adding suggestion support into Thinking Sphinx. This gets
@@ -56,19 +57,12 @@ module ThinkingSphinx
       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).
+    # Aspell instance with all appropriate settings defined.
     # 
     # @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
+      ThinkingSphinx::Configuration.instance.raspell.speller
     end
   end
 end

data/lib/thinking_sphinx/raspell/configuration.rb

@@ -0,0 +1,142 @@
+module ThinkingSphinx
+  module Raspell
+    # Configuration settings for spelling suggestions in Thinking Sphinx. You
+    # can access these either by the singleton instance
+    # (ThinkingSphinx::Raspell::Configuration.instance), or through Thinking 
+    # Sphinx's existing configuration instance
+    # (ThinkingSphinx::Configuration.instance.raspell).
+    # 
+    # @author Pat Allan
+    # 
+    class Configuration
+      include Singleton
+      
+      attr_reader :dictionary, :suggestion_mode, :options
+      
+      # Creates the instance of the singleton with the following defaults:
+      # Dictionary is English (en), suggestion mode is normal, and the
+      # ignore-case option is enabled.
+      # 
+      def initialize
+        reset
+      end
+      
+      # Resets the instance to the default settings. Probably not necessary in
+      # general usage, but makes specs easier to run.
+      # 
+      def reset
+        @dictionary      = 'en'
+        @suggestion_mode = :normal
+        @options         = {'ignore-case' => true}
+        @speller         = nil
+      end
+      
+      # Sets the dictionary for the spelling suggestions. Make sure you have the
+      # dictionary installed on your system first.
+      # 
+      # @example
+      #   config.dictionary = 'en_GB'
+      # 
+      # @param [String] dict dictionary code
+      # @raise [ArgumentError] if the dictionary code is not known by Aspell
+      # 
+      def dictionary=(dict)
+        unless dictionaries.include?(dict)
+          raise ArgumentError, 'unknown dictionary'
+        end
+        
+        @dictionary = dict
+      end
+      
+      # The list of dictionaries Aspell has on offer.
+      # 
+      # @return [Array] collection of dictionary codes
+      # 
+      def dictionaries
+        @dictionaries ||= Aspell.list_dicts.collect { |dict| dict.code }
+      end
+      
+      # Set the suggestion mode. Accepts symbols, strings and Aspell constants.
+      # The known values are ultra, fast, normal and badspellers/bad-spellers.
+      # 
+      # @param [Symbol, String] mode suggestion mode
+      # @raise [ArgumentError] if the suggestion mode is not known by Aspell
+      # 
+      def suggestion_mode=(mode)
+        mode = mode.gsub(/-/, '').to_sym if mode.is_a?(String)
+        
+        unless suggestion_modes.include?(mode)
+          raise ArgumentError, 'unknown suggestion mode'
+        end
+        
+        @suggestion_mode = mode
+      end
+      
+      # The allowed suggestion modes.
+      # 
+      # @return [Array] available suggestion modes, as symbols.
+      # 
+      def suggestion_modes
+        [:ultra, :fast, :normal, :badspellers]
+      end
+      
+      # Aspell instance with all appropriate settings defined.
+      # 
+      # @return [Aspell] the prepared Aspell instance
+      # 
+      def speller
+        @speller ||= build_speller
+      end
+      
+      private
+      
+      # Convert the suggestion mode symbol to a string, and ensures the dash
+      # is added to the bad-spellers mode.
+      # 
+      # @return [String] Aspell-friendly suggestion mode
+      # 
+      def actual_suggestion_mode
+        suggestion_mode.to_s.gsub(/badspellers/, 'bad-spellers')
+      end
+      
+      # Converts user-defined options to have string keys, as that's what Aspell
+      # requires.
+      # 
+      # @return [Hash] options with string keys
+      # 
+      def actual_options
+        options.keys.inject({}) do |hash, key|
+          hash[key] = options[key].to_s
+          hash
+        end
+      end
+      
+      # Generate the Aspell instance, setting the dictionary, suggestion mode
+      # and options as defined in the configuration instance.
+      # 
+      # @return [Aspell] a new prepared Aspell instance
+      # 
+      def build_speller
+        speller = Aspell.new(dictionary)
+        speller.suggestion_mode = actual_suggestion_mode
+        actual_options.each do |key, value|
+          speller.set_option key, value
+        end
+        
+        speller
+      end
+    end
+    
+    module Hooks
+      # The singleton ThinkingSphinx::Raspell::Configuration instance.
+      # 
+      # @return [ThinkingSphinx::Raspell::Configuration] config instance
+      # 
+      def raspell
+        ThinkingSphinx::Raspell::Configuration.instance
+      end
+    end
+  end
+end
+
+ThinkingSphinx::Configuration.send(:include, ThinkingSphinx::Raspell::Hooks)

data/spec/thinking_sphinx/raspell/configuration_spec.rb

@@ -0,0 +1,122 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::Configuration do
+  describe '#raspell' do
+    before :each do
+      @config = ThinkingSphinx::Configuration.instance
+    end
+    
+    it "should return a raspell configuration instance" do
+      @config.raspell.should be_a(ThinkingSphinx::Raspell::Configuration)
+    end
+  end
+end
+
+describe ThinkingSphinx::Raspell::Configuration do
+  before :each do
+    @config = ThinkingSphinx::Raspell::Configuration.instance
+    @config.reset
+  end
+  
+  describe '#dictionary' do
+    it "should default to 'en'" do
+      @config.dictionary.should == 'en'
+    end
+  end
+  
+  describe '#dictionary=' do
+    it "should set the dictionary" do
+      @config.dictionary = 'en_GB'
+      @config.dictionary.should == 'en_GB'
+    end
+    
+    it "should raise an argument error if the dictionary code is invalid" do
+      lambda { @config.dictionary = 'zz' }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe '#dictionaries' do
+    it "should return the names of all registered dictionaries" do
+      @config.dictionaries.should == Aspell.list_dicts.collect { |dict|
+        dict.code
+      }
+    end
+  end
+  
+  describe '#suggestion_mode' do
+    it "should default to normal" do
+      @config.suggestion_mode.should == :normal
+    end
+  end
+  
+  describe '#suggestion_mode=' do
+    it "should set the suggestion mode" do
+      @config.suggestion_mode = :ultra
+      @config.suggestion_mode.should == :ultra
+    end
+    
+    it "should raise an argument error if the suggestion mode is invalid" do
+      lambda { @config.suggestion_mode = :smart }.
+        should raise_error(ArgumentError)
+    end
+    
+    it "should translate Aspell constants" do
+      @config.suggestion_mode = Aspell::BADSPELLERS
+      @config.suggestion_mode.should == :badspellers
+    end
+  end
+  
+  describe '#options' do
+    it "should return a Hash" do
+      @config.options.should be_a(Hash)
+    end
+    
+    it "should have ignore-case defaulting to true" do
+      @config.options['ignore-case'].should == true
+    end
+  end
+  
+  describe '#suggestion_modes' do
+    it "should return ultra, fast, normal and badspellers" do
+      @config.suggestion_modes.should == [:ultra, :fast, :normal, :badspellers]
+    end
+  end
+  
+  describe '#speller' do
+    it "should return an Aspell instance" do
+      @config.speller.should be_an(Aspell)
+    end
+    
+    it "should use the configured dictionary" do
+      speller = Aspell.new('en_GB')
+      Aspell.should_receive(:new).with('en_GB').and_return(speller)
+      
+      @config.dictionary = 'en_GB'
+      @config.speller
+    end
+    
+    it "should set the configured suggestion mode" do
+      speller = Aspell.new('en')
+      speller.should_receive(:suggestion_mode=).with('bad-spellers')
+      Aspell.stub!(:new => speller)
+      
+      @config.suggestion_mode = :badspellers
+      @config.speller
+    end
+    
+    it "should set the configured options" do
+      @config.options['ignore-case'] = false
+      
+      @config.speller.get_option('ignore-case').should == 'false'
+    end
+    
+    it "should reuse the generated instance" do
+      Aspell.should_receive(:new).once.and_return(
+        stub('speller').as_null_object
+      )
+      
+      @config.speller
+      @config.speller
+    end
+  end
+end

data/spec/thinking_sphinx/raspell_spec.rb

@@ -1,6 +1,10 @@
 require 'spec/spec_helper'
 
 describe ThinkingSphinx::Search do
+  before :each do
+    ThinkingSphinx::Configuration.instance.raspell.reset
+  end
+  
   describe '#suggestion' do
     it "should return a spelling suggestion, if there is one" do
       search = ThinkingSphinx::Search.new('wodrs incorret on purpose')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thinking-sphinx-raspell
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Pat Allan
@@ -66,6 +66,7 @@ files:
 - README.textile
 - VERSION.yml
 - lib/thinking_sphinx/raspell.rb
+- lib/thinking_sphinx/raspell/configuration.rb
 has_rdoc: true
 homepage: http://ts.freelancing-gods.com
 licenses: []
@@ -96,4 +97,5 @@ specification_version: 3
 summary: An add-on gem for spelling suggestions in Thinking Sphinx
 test_files: 
 - spec/spec_helper.rb
+- spec/thinking_sphinx/raspell/configuration_spec.rb
 - spec/thinking_sphinx/raspell_spec.rb