sunspot_plus 0.2.2 → 0.3.0

data/README.rdoc

@@ -8,16 +8,17 @@ Particularly useful for using 3rd party or remote solr servers over http as ofte
 
 * Use rails initializer to create the sunspot session
 
-  require 'sunspot_rails'
-  # set the session to the delayed_job handler - this will send all model CRUD reindexing to delayed_job
-  Sunspot.session = Sunspot::SessionProxy::DelayedJobSessionProxy.new(Sunspot.session)
+    require 'sunspot_rails'
+    # set the session to the delayed_job handler - this will send all model CRUD reindexing to delayed_job
+    Sunspot.session = Sunspot::SessionProxy::DelayedJobSessionProxy.new(Sunspot.session)
   
 * Define your searchable blocks as usual in ActiveRecord models.
-  class Model < ActiveRecord::Base
-    searchable do
-      text :name
+
+    class Model < ActiveRecord::Base
+      searchable do
+        text :name
+      end
     end
-  end
   
 == Note on Patches/Pull Requests
  

data/lib/sunspot_plus.rb

@@ -2,4 +2,9 @@ require 'sunspot'
 require 'sunspot_plus/session_proxy/delayed_job_session_proxy'
 require 'sunspot_plus/session_proxy/silent_fail_session_proxy'
 require 'sunspot_plus/session_proxy/delayed_job/indexing_job'
-require 'sunspot_plus/session_proxy/delayed_job/safe_configuration'
+require 'sunspot_plus/session_proxy/delayed_job/safe_configuration'
+require 'sunspot_plus/type/case_insensitive_sort_type'
+require 'sunspot_plus/dsl/fields'
+require 'sunspot_plus/dsl/query/case_insensitive_sort'
+
+Sunspot::DSL::FieldQuery.extend SunspotPlus::DSL::Query::CaseInsensitiveSort

data/lib/sunspot_plus/dsl/fields.rb

@@ -0,0 +1,12 @@
+module Sunspot
+  module DSL
+    class Fields
+      # NOTE : I want to call case_insensitive_sort using method missing but with adjusted name
+      # Could use adjust_solr_params but not sure about this method.
+      def sort_fields(*names, &block)
+        options = names.pop if names.last.is_a?(Hash)
+        names.each{|name| case_insensitive_sort(Sunspot::Type::CaseInsensitiveSortType.instance.field_name(name), options, &block)}
+      end
+    end
+  end
+end

data/lib/sunspot_plus/dsl/query/case_insensitive_sort.rb

@@ -0,0 +1,17 @@
+module SunspotPlus
+  module DSL
+    module Query
+      module CaseInsensitiveSort
+        def self.extended(base)
+          base.send(:include, InstanceMethods)
+        end
+      
+        module InstanceMethods
+          def ci_order_by(field_name, direction = nil)
+            order_by(Sunspot::Type::CaseInsensitiveSortType.instance.field_name(field_name), direction)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunspot_plus/type/case_insensitive_sort_type.rb

@@ -0,0 +1,43 @@
+module Sunspot
+  module Type
+    # 
+     # The CaseInsensitiveSort type represents string data optimised for case insensitve search.
+     #
+     class CaseInsensitiveSortType < StringType
+
+       class << self
+         def pattern
+           @@pattern
+         end
+         
+         def pattern=(value)
+           @@pattern=value
+         end
+       end
+       
+       self.pattern = :downcase
+        
+       def pattern
+         self.class.pattern
+       end
+       
+       def indexed_name(name) #:nodoc:
+         "sort_#{name}_s"
+       end
+       
+       def field_name(name)
+         "case_insensitive_sort_#{name}"
+       end
+       
+       def to_indexed(value) #:nodoc:
+         if value
+           if pattern.is_a?(Symbol)
+             value.to_s.send(pattern) 
+           elsif pattern.is_a?(Proc)
+             pattern.call(value)
+           end
+         end
+       end
+     end
+  end
+end

data/spec/spec_helper.rb

@@ -2,12 +2,16 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rubygems'
 require 'sunspot'
+require 'sunspot_matchers'
 require 'sunspot_plus'
 require 'sunspot/session_proxy/abstract_session_proxy'
-require 'spec'
-require 'spec/autorun'
+require 'rspec'
 require 'helpers/delayed_job_stub'
 
-Spec::Runner.configure do |config|
-  
+RSpec.configure do |config|
+  config.before do
+    Sunspot.session = SunspotMatchers::SunspotSessionSpy.new(Sunspot.session)
+  end
+  config.include SunspotMatchers
 end
+

data/spec/sunspot/types/case_insensitive_sort_type_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+class SomethingToIndex
+  def name
+    "something"
+  end
+  
+  def description
+    "description"
+  end
+  
+  def another
+    "another"
+  end
+end
+
+describe Sunspot::Type::CaseInsensitiveSortType do
+  
+  before(:each) do
+    @sort_type = Sunspot::Type::CaseInsensitiveSortType.instance
+  end
+  
+  it "should have an indexed name" do
+    @sort_type.indexed_name(:test).should == "sort_test_s"
+  end
+  
+  it "should convert a field attribute into a case insensitive field name" do
+    @sort_type.field_name(:test).should == "case_insensitive_sort_test"
+  end
+  
+  it "should make the value lowercase" do
+    @sort_type.to_indexed("This is a sort term that needs to be Case Insensitive").should == "this is a sort term that needs to be case insensitive"
+  end
+  
+  it "should case the value to a string" do
+    @sort_type.cast("string").should == "string" 
+    @sort_type.cast("sting").should be_a(String)
+  end
+  
+  describe "if i want to defined another pattern" do
+    before(:each) do
+      Sunspot::Type::CaseInsensitiveSortType.pattern = :upcase
+    end
+    
+    it "should use upcase to transform the value" do
+      Sunspot::Type::CaseInsensitiveSortType.instance.pattern.should == :upcase
+      @sort_type.to_indexed("This is a sort term that needs to be Case Insensitive").should == "THIS IS A SORT TERM THAT NEEDS TO BE CASE INSENSITIVE"
+    end
+    
+    context "using a proc" do
+      before(:each) do
+        Sunspot::Type::CaseInsensitiveSortType.pattern = Proc.new{|value| value << "999"}
+      end
+      
+      it "should get rid of an and and the and upcase" do
+        Sunspot::Type::CaseInsensitiveSortType.instance.pattern.should be_a(Proc)
+        @sort_type.to_indexed("Please call ").should == "Please call 999"
+      end
+    end
+  end
+  
+  describe "using the type" do
+    before(:each) do
+      Sunspot.setup(SomethingToIndex) do
+        string :name
+        sort_fields :name
+        sort_fields :description, :another
+      end
+      @something = SomethingToIndex.new
+    end
+    
+    it "should index something_to_index with sort field" do
+      Sunspot.search(SomethingToIndex) do
+        keywords "something"
+        order_by((:case_insensitive_sort_name))
+      end
+      Sunspot.session.should have_search_params(:order_by, :case_insensitive_sort_name, :asc)
+    end
+    
+    describe "the ci_order method" do
+      it "should add a new ci_order_by method" do
+        Sunspot.search(SomethingToIndex) do
+          keywords "bobbins"
+          ci_order_by(:name)
+        end
+        Sunspot.session.should have_search_params(:order_by, :case_insensitive_sort_name, :asc)
+      end
+      
+      it "should allow the direction to be changed" do
+        Sunspot.search(SomethingToIndex) do
+          keywords "bobbins"
+          ci_order_by(:description, :desc)
+        end
+        Sunspot.session.should have_search_params(:order_by, :case_insensitive_sort_description, :desc)
+      end
+      
+    end
+  end
+  
+end
+  

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Louis Gillies
@@ -15,13 +15,44 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 +00:00
+date: 2011-03-04 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: sunspot
-  prerelease: false
+  name: rspec
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +61,28 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id001
+  type: :development
+  prerelease: false
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: delayed_job
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,12 +91,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id002
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -61,11 +108,11 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: yard
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -75,8 +122,9 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id004
-description: "A library of extensions for outoftime's sunspot gem for solr indexing server. Using the session adapter design pattern to add support for:\n      1) delayed_job to move indexing commits out of process.\n    "
+  prerelease: false
+  version_requirements: *id007
+description: "A library of extensions for outoftime's sunspot gem for solr indexing server. Using the session adapter design pattern to add support for:\n    1) delayed_job to move indexing commits out of process.\n    Support for case insensitive sort fields by creating indexed copy of fields transformed for sort.\n  "
 email: louisgillies@yahoo.co.uk
 executables: []
 
@@ -87,10 +135,13 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/sunspot_plus.rb
+- lib/sunspot_plus/dsl/fields.rb
+- lib/sunspot_plus/dsl/query/case_insensitive_sort.rb
 - lib/sunspot_plus/session_proxy/delayed_job/indexing_job.rb
 - lib/sunspot_plus/session_proxy/delayed_job/safe_configuration.rb
 - lib/sunspot_plus/session_proxy/delayed_job_session_proxy.rb
 - lib/sunspot_plus/session_proxy/silent_fail_session_proxy.rb
+- lib/sunspot_plus/type/case_insensitive_sort_type.rb
 - LICENSE
 - README.rdoc
 - spec/helpers/delayed_job_stub.rb
@@ -98,6 +149,7 @@ files:
 - spec/sunspot/session_proxy/delayed_job/safe_configuration_spec.rb
 - spec/sunspot/session_proxy/delayed_job_session_proxy_spec.rb
 - spec/sunspot/session_proxy/spec_helper.rb
+- spec/sunspot/types/case_insensitive_sort_type_spec.rb
 - spec/sunspot_plus_spec.rb
 has_rdoc: true
 homepage: http://github.com/playgood/sunspot_plus
@@ -139,4 +191,5 @@ test_files:
 - spec/sunspot/session_proxy/delayed_job/safe_configuration_spec.rb
 - spec/sunspot/session_proxy/delayed_job_session_proxy_spec.rb
 - spec/sunspot/session_proxy/spec_helper.rb
+- spec/sunspot/types/case_insensitive_sort_type_spec.rb
 - spec/sunspot_plus_spec.rb