picky 4.3.1 → 4.3.2

data/lib/picky/query/token.rb

@@ -99,34 +99,107 @@ module Picky
       # So "hello*" will not be partially searched.
       # So "hello"* will be partially searched.
       #
+      @@no_partial_character = '"'
+      @@partial_character = '*'
       @@no_partial = /\"\z/
       @@partial    = /\*\z/
       def partialize
         self.partial = false or return unless @text !~ @@no_partial
         self.partial = true unless @text !~ @@partial
       end
+      # Define a character which stops a token from
+      # being a partial token, even if it is the last token.
+      #
+      # Default is '"'.
+      #
+      # This is used in a regexp (%r{#{char}\z}) for String#!~, 
+      # so escape the character.
+      #
+      # Example:
+      #   Picky::Query::Token.no_partial_character = '\?'
+      #   try.search("tes?") # Won't find "test".
+      #
+      def self.no_partial_character= character
+        @@no_partial_character = character
+        @@no_partial = %r{#{character}\z}
+      end
+      # Define a character which makes a token a partial token.
+      #
+      # Default is '*'.
+      #
+      # This is used in a regexp (%r{#{char}\z}) for String#!~, 
+      # so escape the character.
+      #
+      # Example:
+      #   Picky::Query::Token.partial_character = '\?'
+      #   try.search("tes?") # Will find "test".
+      #
+      def self.partial_character= character
+        @@partial_character = character
+        @@partial = %r{#{character}\z}
+        redefine_illegals
+      end
 
       # If the text ends with ~ similarize it. If with ", don't.
       #
       # The latter wins.
       #
-      @@no_similar = /\"\z/
-      @@similar    = /\~\z/
+      @@no_similar_character = '"'
+      @@similar_character = '~'
+      @@no_similar = %r{#{@@no_similar_character}\z}
+      @@similar    = %r{#{@@similar_character}\z}
       def similarize
         self.similar = false or return unless @text !~ @@no_similar
         self.similar = true unless @text !~ @@similar
       end
-
+      # Define a character which stops a token from
+      # being a similar token, even if it is the last token.
+      #
+      # Default is '"'.
+      #
+      # This is used in a regexp (%r{#{char}\z}) for String#!~, 
+      # so escape the character.
+      #
+      # Example:
+      #   Picky::Query::Token.no_similar_character = '\?'
+      #   try.search("tost?") # Won't find "test".
+      #
+      def self.no_similar_character= character
+        @@no_similar_character = character
+        @@no_similar = %r{#{character}\z}
+      end
+      # Define a character which makes a token a similar token.
+      #
+      # Default is '~'.
+      #
+      # This is used in a regexp (%r{#{char}\z}) for String#!~, 
+      # so escape the character.
+      #
+      # Example:
+      #   Picky::Query::Token.similar_character = '\?'
+      #   try.search("tost?") # Will find "test".
+      #
+      def self.similar_character= character
+        @@similar_character = character
+        @@similar = %r{#{character}\z}
+        redefine_illegals
+      end
+      
+      # Is this a "similar" character?
+      #
       def similar?
         @similar
       end
 
       # Normalizes this token's text.
       #
-      @@illegals = /["*~]/
       def remove_illegals
         @text.gsub! @@illegals, EMPTY_STRING unless @text.blank?
       end
+      def self.redefine_illegals
+        @@illegals = %r{[#{@@no_similar_character}#{@@partial_character}#{@@similar_character}]}
+      end
+      redefine_illegals
 
       # Returns an array of possible combinations.
       #
@@ -145,17 +218,46 @@ module Picky
 
       # Splits text into a qualifier and text.
       #
-      @@split_qualifier_text = ':'
-      @@split_qualifiers     = ','
+      @@qualifier_text_delimiter = ':'
+      @@qualifiers_delimiter     = ','
       def qualify
-        @qualifiers, @text = (@text || EMPTY_STRING).split(@@split_qualifier_text, 2)
+        @qualifiers, @text = (@text || EMPTY_STRING).split(@@qualifier_text_delimiter, 2)
         if @text.blank?
           @text = @qualifiers || EMPTY_STRING
           @qualifiers = nil
         else
-          @qualifiers = @qualifiers.split @@split_qualifiers
+          @qualifiers = @qualifiers.split @@qualifiers_delimiter
         end
       end
+      # Define a character which separates the qualifier
+      # from the search text.
+      #
+      # Default is ':'.
+      #
+      # This is used in a String#split.
+      #
+      # Example:
+      #   Picky::Query::Token.qualifier_text_delimiter = '?'
+      #   try.search("text1?hello text2?world").ids.should == [1]
+      #
+      def self.qualifier_text_delimiter= character
+        @@qualifier_text_delimiter = character
+      end
+      # Define a character which separates the qualifiers
+      # (before the search text).
+      #
+      # Default is ','.
+      #
+      # This is used in a String#split.
+      #
+      # Example:
+      #   Picky::Query::Token.qualifiers_delimiter = '|'
+      #   try.search("text1|text2:hello").ids.should == [1]
+      #
+      
+      def self.qualifiers_delimiter= character
+        @@qualifiers_delimiter = character
+      end
       
       # Returns the qualifiers as an array.
       #

data/spec/functional/custom_delimiters_spec.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe 'custom delimiters' do
+  
+  after(:each) do
+    Picky::Query::Token.partial_character = '\*'
+    Picky::Query::Token.no_partial_character = '"'
+    Picky::Query::Token.similar_character = '~'
+    Picky::Query::Token.no_similar_character = '"'
+    Picky::Query::Token.qualifier_text_delimiter = ':'
+    Picky::Query::Token.qualifiers_delimiter = ','
+  end
+
+  it 'offers custom partial delimiters to be set' do
+    index = Picky::Index.new :custom_delimiters do
+      category :text1
+      category :text2
+    end
+
+    index.add Struct.new(:id, :text1, :text2).new(1, 'hello', 'world')
+
+    try = Picky::Search.new index
+    try.search("hell world").ids.should == []
+    try.search("hell* world").ids.should == [1]
+    try.search("hello world").ids.should == [1]
+    
+    try.search("hell! world").ids.should == []
+    Picky::Query::Token.partial_character = '!'
+    try.search("hell! world").ids.should == [1]
+    
+    try.search('hell!" world').ids.should == []
+    Picky::Query::Token.no_partial_character = '\?'
+    try.search('hell!? world').ids.should == []
+  end
+  
+  it 'offers custom similar delimiters to be set' do
+    index = Picky::Index.new :custom_delimiters do
+      category :text1, similarity: Picky::Similarity::Soundex.new
+      category :text2
+    end
+
+    index.add Struct.new(:id, :text1, :text2).new(1, 'hello', 'world')
+
+    try = Picky::Search.new index
+    try.search("hell world").ids.should == []
+    try.search("hell~ world").ids.should == [1]
+    try.search("hello world").ids.should == [1]
+    
+    try.search("hell? world").ids.should == []
+    Picky::Query::Token.similar_character = '\?'
+    try.search("hell? world").ids.should == [1]
+    
+    try.search('hell?" world').ids.should == []
+    Picky::Query::Token.no_partial_character = '!'
+    try.search('hell?! world').ids.should == []
+  end
+  
+  it 'offers custom similar delimiters to be set' do
+    index = Picky::Index.new :custom_delimiters do
+      category :text1, similarity: Picky::Similarity::Soundex.new
+      category :text2
+    end
+
+    index.add Struct.new(:id, :text1, :text2).new(1, 'hello world', 'world')
+
+    try = Picky::Search.new index
+    try.search("text1:hello text2:world").ids.should == [1]
+    
+    try.search("text1?hello text2?world").ids.should == []
+    Picky::Query::Token.qualifier_text_delimiter = '?'
+    try.search("text1?hello text2?world").ids.should == [1]
+    
+    try.search("text1|text2?hello text2?world").ids.should == []
+    Picky::Query::Token.qualifiers_delimiter = '|'
+    try.search("text1|text2?hello text2?world").ids.should == [1]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-24 00:00:00.000000000 Z
+date: 2012-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70193563400740 !ruby/object:Gem::Requirement
+  requirement: &70364530556040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70193563400740
+  version_requirements: *70364530556040
 - !ruby/object:Gem::Dependency
   name: picky-client
-  requirement: &70193563400240 !ruby/object:Gem::Requirement
+  requirement: &70364530555400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.3.1
+        version: 4.3.2
   type: :development
   prerelease: false
-  version_requirements: *70193563400240
+  version_requirements: *70364530555400
 - !ruby/object:Gem::Dependency
   name: text
-  requirement: &70193563399820 !ruby/object:Gem::Requirement
+  requirement: &70364530554580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193563399820
+  version_requirements: *70364530554580
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70193563399360 !ruby/object:Gem::Requirement
+  requirement: &70364530553900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193563399360
+  version_requirements: *70364530553900
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70193563415200 !ruby/object:Gem::Requirement
+  requirement: &70364530553380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193563415200
+  version_requirements: *70364530553380
 - !ruby/object:Gem::Dependency
   name: procrastinate
-  requirement: &70193563414580 !ruby/object:Gem::Requirement
+  requirement: &70364530552820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70193563414580
+  version_requirements: *70364530552820
 - !ruby/object:Gem::Dependency
   name: rack_fast_escape
-  requirement: &70193563414120 !ruby/object:Gem::Requirement
+  requirement: &70364530552440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193563414120
+  version_requirements: *70364530552440
 description: Fast Ruby semantic text search engine with comfortable single field interface.
 email: florian.hanke+picky@gmail.com
 executables:
@@ -250,6 +250,7 @@ files:
 - spec/functional/backends/special_spec.rb
 - spec/functional/backends/sqlite_bundle_realtime_spec.rb
 - spec/functional/backends/sqlite_spec.rb
+- spec/functional/custom_delimiters_spec.rb
 - spec/functional/dynamic_weights_spec.rb
 - spec/functional/exact_first_spec.rb
 - spec/functional/max_allocations_spec.rb
@@ -400,6 +401,7 @@ test_files:
 - spec/functional/backends/special_spec.rb
 - spec/functional/backends/sqlite_bundle_realtime_spec.rb
 - spec/functional/backends/sqlite_spec.rb
+- spec/functional/custom_delimiters_spec.rb
 - spec/functional/dynamic_weights_spec.rb
 - spec/functional/exact_first_spec.rb
 - spec/functional/max_allocations_spec.rb