picky 4.6.3 → 4.6.4

data/spec/lib/generators/partial_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Picky::Generators::Partial do
+  let(:partial) { described_class } # "class", actually a module.
+  context 'extract_partial' do
+    context 'with nil' do
+      it 'returns the default' do
+        partial.from(nil).should == Picky::Partial::Default
+      end
+    end
+    context 'with a partial object' do
+      let(:partializer) do
+        Class.new do
+          def each_partial text
+            'tex'
+          end
+        end.new
+      end
+      it 'yields the partial' do
+        partial.from(partializer).each_partial('whatevs') do |text|
+          text.should == 'tex'
+        end
+      end
+    end
+    context 'invalid partial' do
+      it 'raises with a nice error message' do
+        expect {
+          partial.from Object.new
+        }.to raise_error(<<-ERROR)
+partial options should be either
+* for example a Partial::Substring.new(from: m, to: n), Partial::Postfix.new(from: n), Partial::Infix.new(min: m, max: n) etc.
+or
+* an object that responds to #each_partial(str_or_sym) and yields each partial
+ERROR
+      end
+      it 'raises with a nice error message' do
+        expect {
+          partial.from Object.new, 'some_index'
+        }.to raise_error(<<-ERROR)
+partial options for some_index should be either
+* for example a Partial::Substring.new(from: m, to: n), Partial::Postfix.new(from: n), Partial::Infix.new(min: m, max: n) etc.
+or
+* an object that responds to #each_partial(str_or_sym) and yields each partial
+ERROR
+      end
+      it 'raises with a nice error message' do
+        expect {
+          partial.from Object.new, 'some_index', 'some_category'
+        }.to raise_error(<<-ERROR)
+partial options for some_index:some_category should be either
+* for example a Partial::Substring.new(from: m, to: n), Partial::Postfix.new(from: n), Partial::Infix.new(min: m, max: n) etc.
+or
+* an object that responds to #each_partial(str_or_sym) and yields each partial
+ERROR
+      end
+    end
+  end
+end

data/spec/lib/generators/similarity_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Picky::Generators::Similarity do
+  let(:similarity) { described_class } # "class", actually a module.
+  context 'encode' do
+    context 'with nil' do
+      it 'returns the default' do
+        similarity.from(nil).should == Picky::Similarity::Default
+      end
+    end
+    context 'with a similarity object' do
+      let(:similarizer) do
+        Class.new do
+          def encode text
+            :encoded
+          end
+          def prioritize ary, encoded
+
+          end
+        end.new
+      end
+      it 'returns the encoded string' do
+        similarity.from(similarizer).encode('whatevs').should == :encoded
+      end
+    end
+    context 'invalid weight' do
+      it 'raises with a nice error message' do
+        expect {
+          similarity.from Object.new
+        }.to raise_error(<<-ERROR)
+similarity options should be either
+* for example a Similarity::Phonetic.new(n), Similarity::Metaphone.new(n), Similarity::DoubleMetaphone.new(n) etc.
+or
+* an object that responds to #encode(text) => encoded_text and #prioritize(array_of_encoded, encoded)
+ERROR
+      end
+      it 'raises with a nice error message' do
+        expect {
+          similarity.from Object.new, 'some_index'
+        }.to raise_error(<<-ERROR)
+similarity options for some_index should be either
+* for example a Similarity::Phonetic.new(n), Similarity::Metaphone.new(n), Similarity::DoubleMetaphone.new(n) etc.
+or
+* an object that responds to #encode(text) => encoded_text and #prioritize(array_of_encoded, encoded)
+ERROR
+      end
+      it 'raises with a nice error message' do
+        expect {
+          similarity.from Object.new, 'some_index', 'some_category'
+        }.to raise_error(<<-ERROR)
+similarity options for some_index:some_category should be either
+* for example a Similarity::Phonetic.new(n), Similarity::Metaphone.new(n), Similarity::DoubleMetaphone.new(n) etc.
+or
+* an object that responds to #encode(text) => encoded_text and #prioritize(array_of_encoded, encoded)
+ERROR
+      end
+    end
+  end
+end

data/spec/lib/generators/weights_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Picky::Generators::Weights do
+  let(:weights) { described_class } # "class", actually a module.
+  context 'self.from' do
+    context 'with nil' do
+      it 'returns the default' do
+        weights.from(nil).should == Picky::Weights::Default
+      end
+    end
+    context 'with a number' do
+      it 'returns a logarithmic weighter' do
+        weights.from(7.3).should be_kind_of(Picky::Weights::Logarithmic)
+      end
+      it 'returns a logarithmic weighter' do
+        weights.from(3.14).weight_for(10).should == 5.443 # ln(10) + 3.14 = 2.3025 + 3.14
+      end
+    end
+    context 'with a weight object' do
+      let(:weighter) do
+        Class.new do
+          def weight_for amount
+            7.0
+          end
+        end.new
+      end
+      it 'creates a tokenizer' do
+        weights.from(weighter).weight_for(21).should == 7.0
+      end
+    end
+    context 'invalid weight' do
+      it 'raises with a nice error message' do
+        expect {
+          weights.from Object.new
+        }.to raise_error(<<-ERROR)
+weight options should be either
+* for example a Weights::Logarithmic.new, Weights::Constant.new(int = 0), Weights::Dynamic.new(&block) etc.
+or
+* an object that responds to #weight_for(amount_of_ids_for_token) => float
+ERROR
+      end
+    end
+    context 'invalid weight' do
+      it 'raises with a nice error message' do
+        expect {
+          weights.from Object.new, 'some_index_name'
+        }.to raise_error(<<-ERROR)
+weight options for some_index_name should be either
+* for example a Weights::Logarithmic.new, Weights::Constant.new(int = 0), Weights::Dynamic.new(&block) etc.
+or
+* an object that responds to #weight_for(amount_of_ids_for_token) => float
+ERROR
+      end
+    end
+    context 'invalid weight' do
+      it 'raises with a nice error message' do
+        expect {
+          weights.from Object.new, 'some_index_name', 'some_category_name'
+        }.to raise_error(<<-ERROR)
+weight options for some_index_name:some_category_name should be either
+* for example a Weights::Logarithmic.new, Weights::Constant.new(int = 0), Weights::Dynamic.new(&block) etc.
+or
+* an object that responds to #weight_for(amount_of_ids_for_token) => float
+ERROR
+      end
+    end
+  end
+end

data/spec/lib/index_indexing_spec.rb

@@ -68,16 +68,14 @@ describe Picky::Index do
       end
     end
     context 'with non#each source' do
-      let(:source) { stub :source, :harvest => nil }
-
       it 'raises' do
-        the_source = source
+        the_source = stub :source, :harvest => nil
         expect {
           described_class.new :some_name do
             source the_source
           end
         }.to raise_error(<<-ERROR)
-The some_name source should respond to either the method #each or
+The source for some_name should respond to either the method #each or
 it can be a lambda/block, returning such a source.
 ERROR
       end

data/spec/lib/index_spec.rb

@@ -55,6 +55,12 @@ describe Picky::Index do
         source the_source
       end
     end
+    
+    describe 'directory' do
+      it 'is correct' do
+        api.directory.should == 'spec/test_directory/index/test/some_index_name'
+      end
+    end
 
     describe 'geo_categories' do
       it 'delegates correctly' do

data/spec/lib/pool_spec.rb

@@ -4,72 +4,76 @@ require 'spec_helper'
 
 describe Picky::Pool do
   
-  class PoolTest
-    extend Picky::Pool
+  let(:pool) do
+    Class.new do
+      extend Picky::Pool
     
-    attr_reader :number
+      attr_reader :number
     
-    def initialize number
-      @number = number
+      def initialize number
+        @number = number
+      end
     end
   end
-  class OtherPoolTest
-    extend Picky::Pool
+  let(:other) do
+    Class.new do
+      extend Picky::Pool
     
-    attr_reader :number
+      attr_reader :number
     
-    def initialize number
-      @number = number
+      def initialize number
+        @number = number
+      end
     end
   end
   
   context 'functional' do
     before(:each) do
       described_class.clear
-      PoolTest.clear
-      OtherPoolTest.clear
+      pool.clear
+      other.clear
     end
     it 'lets me get an instance' do
-      PoolTest.new(1).should be_kind_of(PoolTest)
+      pool.new(1).should be_kind_of(pool)
     end
     it 'does not create a new reference if it has free ones' do
-      pt1 = PoolTest.new 1
-      pt2 = PoolTest.new 2
-      pt1.release
+      p1 = pool.new 1
+      p2 = pool.new 2
+      p1.release
       
-      PoolTest.free_size.should == 1
+      pool.free_size.should == 1
     end
     it 'gives me the released reference if I try to new' do
-      pt1 = PoolTest.new 1
-      pt2 = PoolTest.new 2
-      pt1.release
+      p1 = pool.new 1
+      p2 = pool.new 2
+      p1.release
       
-      PoolTest.new(3).number.should == 3
+      pool.new(3).number.should == 3
     end
     it 'releases all PoolTests if called on PoolTest' do
-      pt1 = PoolTest.new 1
-      PoolTest.new 2
-      OtherPoolTest.new 1
-      OtherPoolTest.new 2
+      p1 = pool.new 1
+      pool.new 2
+      other.new 1
+      other.new 2
       
-      OtherPoolTest.free_size.should == 0 
+      other.free_size.should == 0 
       
-      PoolTest.release_all
+      pool.release_all
       
-      PoolTest.new(3).should == pt1
-      OtherPoolTest.free_size.should == 0
+      pool.new(3).should == p1
+      other.free_size.should == 0
     end
     it 'releases all if called on Pool' do
-      PoolTest.new 1
-      PoolTest.new 2
-      OtherPoolTest.new 1
-      OtherPoolTest.new 2
+      pool.new 1
+      pool.new 2
+      other.new 1
+      other.new 2
       
-      PoolTest.free_size.should == 0
+      pool.free_size.should == 0
       
       described_class.release_all
       
-      PoolTest.free_size.should == 2
+      pool.free_size.should == 2
     end
   end
   

data/spec/lib/sinatra_spec.rb

@@ -16,10 +16,10 @@ describe Picky::Sinatra do
       extendee.extend Picky::Sinatra
     end
     it 'has Picky specific methods' do
-      extendee.send :indexing, some: 'option'
+      extendee.send :indexing, splits_text_on: /something/
     end
     it 'has Picky specific methods' do
-      extendee.send :searching, some: 'option'
+      extendee.send :searching, splits_text_on: /something/
     end
     it 'gets delegated correctly' do
       Picky::Tokenizer.should_receive(:default_indexing_with).once.with some: 'option'

data/spec/lib/source_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Picky::Source do
+  context 'unblock_source' do
+    context 'with block' do
+      it 'unblocks' do
+        result = described_class.from ->() { :some_source }, false
+
+        result.call == :some_source
+      end
+    end
+    context 'with #each' do
+      it 'takes the source directly' do
+        described_class.from([:some_source], true) == :some_source
+      end
+      it 'takes the source directly' do
+        described_class.from([:some_source], false) == :some_source
+      end
+    end
+  end
+  context 'extract_source' do
+    context 'block with source hash' do
+      it 'extracts a source' do
+        described_class.from(->(){}, false).should be_kind_of(Proc)
+      end
+    end
+    context 'each source' do
+      let(:source) do
+        Class.new do
+          def each
+
+          end
+        end.new
+      end
+      it 'extracts a source' do
+        described_class.from(source, false).should == source
+      end
+    end
+    context 'invalid source with nil not ok' do
+      it 'raises with a nice error message' do
+        expect {
+          described_class.from Object.new, false
+        }.to raise_error(<<-ERROR)
+The source should respond to either the method #each or
+it can be a lambda/block, returning such a source.
+ERROR
+      end
+      it 'raises with a nice error message' do
+        expect {
+          described_class.from Object.new, false, 'some_index'
+        }.to raise_error(<<-ERROR)
+The source for some_index should respond to either the method #each or
+it can be a lambda/block, returning such a source.
+ERROR
+      end
+    end
+    context 'with nil ok' do
+      it 'simply returns nil back' do
+        described_class.from(nil, true).should == nil
+      end
+    end
+  end
+end

data/spec/lib/tokenizer_spec.rb

@@ -4,6 +4,14 @@ require 'spec_helper'
 
 describe Picky::Tokenizer do
 
+  describe 'with wrong/incorrectly spelled option' do
+    it 'informs the user nicely' do
+      expect {
+        described_class.new rejetcs_token_if: :blank?.to_proc
+      }.to raise_error(%Q{The option "rejetcs_token_if" is not a valid option for a Picky tokenizer.\nPlease see https://github.com/floere/picky/wiki/Indexing-configuration for valid options.})
+    end
+  end
+
   context 'with special instance' do
     let (:tokenizer) { described_class.new rejects_token_if: lambda { |token| token.to_s.length < 2 || token == :hello }, case_sensitive: true }
     it 'rejects tokens with length < 2' do
@@ -19,7 +27,7 @@ Removes characters: -
 Stopwords:          -
 Splits text on:     /\\s/
 Normalizes words:   -
-Rejects tokens?     Yes, see line 8 in app/application.rb
+Rejects tokens?     Yes, see line 16 in app/application.rb
 Substitutes chars?  -
 Case sensitive?     Yes.
 EXPECTED
@@ -49,7 +57,7 @@ EXPECTED
         tokenizer.reject(['a', nil, '', 'b']).should == ['a', 'b']
       end
       it 'rejects tokens based on the given rejection criteria if set' do
-        tokenizer.rejects_token_if &:nil?
+        tokenizer.rejects_token_if :nil?.to_proc
 
         tokenizer.reject(['a', nil, '', 'b']).should == ['a', '', 'b']
       end
@@ -222,5 +230,59 @@ ERROR
       end
     end
   end
+  
+  context 'from' do
+    context 'options hash' do
+      it 'creates a tokenizer' do
+        described_class.from(splits_text_on: /\t/).
+          tokenize("hello\tworld").should == [['hello', 'world'], ['hello', 'world']]
+      end
+    end
+    context 'tokenizer' do
+      let(:tokenizer) do
+        Class.new do
+          def tokenize text
+            ['unmoved', 'by', 'your', 'texts']
+          end
+        end.new
+      end
+      it 'creates a tokenizer' do
+        described_class.from(tokenizer).
+          tokenize("hello\tworld").should == ['unmoved', 'by', 'your', 'texts']
+      end
+    end
+    context 'invalid tokenizer' do
+      it 'raises with a nice error message' do
+        expect {
+          described_class.from Object.new
+        }.to raise_error(<<-ERROR)
+indexing options should be either
+* a Hash
+or
+* an object that responds to #tokenize(text) => [[token1, token2, ...], [original1, original2, ...]]
+ERROR
+      end
+      it 'raises with a nice error message' do
+        expect {
+          described_class.from Object.new, 'some_index'
+        }.to raise_error(<<-ERROR)
+indexing options for some_index should be either
+* a Hash
+or
+* an object that responds to #tokenize(text) => [[token1, token2, ...], [original1, original2, ...]]
+ERROR
+      end
+      it 'raises with a nice error message' do
+        expect {
+          described_class.from Object.new, 'some_index', 'some_category'
+        }.to raise_error(<<-ERROR)
+indexing options for some_index:some_category should be either
+* a Hash
+or
+* an object that responds to #tokenize(text) => [[token1, token2, ...], [original1, original2, ...]]
+ERROR
+      end
+    end
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.6.3
+  version: 4.6.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-12 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.6.3
+        version: 4.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.6.3
+        version: 4.6.4
 - !ruby/object:Gem::Dependency
   name: text
   requirement: !ruby/object:Gem::Requirement
@@ -136,13 +136,8 @@ files:
 - lib/maybe_compile.rb
 - lib/picky/analytics.rb
 - lib/picky/analyzer.rb
-- lib/picky/api/category/partial.rb
-- lib/picky/api/category/similarity.rb
-- lib/picky/api/category/weight.rb
 - lib/picky/api/search/boost.rb
-- lib/picky/api/source.rb
 - lib/picky/api/tokenizer/character_substituter.rb
-- lib/picky/api/tokenizer.rb
 - lib/picky/backends/backend.rb
 - lib/picky/backends/file/basic.rb
 - lib/picky/backends/file/json.rb
@@ -186,7 +181,6 @@ files:
 - lib/picky/character_substituters/west_european.rb
 - lib/picky/console.rb
 - lib/picky/constants.rb
-- lib/picky/deployment.rb
 - lib/picky/extensions/array.rb
 - lib/picky/extensions/class.rb
 - lib/picky/extensions/hash.rb
@@ -201,6 +195,7 @@ files:
 - lib/picky/generators/partial/postfix.rb
 - lib/picky/generators/partial/strategy.rb
 - lib/picky/generators/partial/substring.rb
+- lib/picky/generators/partial.rb
 - lib/picky/generators/similarity/default.rb
 - lib/picky/generators/similarity/double_metaphone.rb
 - lib/picky/generators/similarity/metaphone.rb
@@ -208,6 +203,7 @@ files:
 - lib/picky/generators/similarity/phonetic.rb
 - lib/picky/generators/similarity/soundex.rb
 - lib/picky/generators/similarity/strategy.rb
+- lib/picky/generators/similarity.rb
 - lib/picky/generators/strategy.rb
 - lib/picky/generators/weights/constant.rb
 - lib/picky/generators/weights/default.rb
@@ -215,6 +211,8 @@ files:
 - lib/picky/generators/weights/logarithmic.rb
 - lib/picky/generators/weights/strategy.rb
 - lib/picky/generators/weights/stub.rb
+- lib/picky/generators/weights.rb
+- lib/picky/helpers/identification.rb
 - lib/picky/helpers/indexing.rb
 - lib/picky/helpers/measuring.rb
 - lib/picky/index.rb
@@ -259,6 +257,7 @@ files:
 - lib/picky/search_facets.rb
 - lib/picky/sinatra/index_actions.rb
 - lib/picky/sinatra.rb
+- lib/picky/source.rb
 - lib/picky/statistics.rb
 - lib/picky/tasks.rb
 - lib/picky/tokenizer.rb
@@ -299,6 +298,7 @@ files:
 - spec/functional/only_spec.rb
 - spec/functional/realtime_spec.rb
 - spec/functional/regression_spec.rb
+- spec/functional/remap_qualifiers_spec.rb
 - spec/functional/speed_spec.rb
 - spec/functional/terminate_early_spec.rb
 - spec/functional/tokenizer_spec.rb
@@ -306,13 +306,8 @@ files:
 - spec/integration/sinatra_index_actions_spec.rb
 - spec/lib/analytics_spec.rb
 - spec/lib/analyzer_spec.rb
-- spec/lib/api/category/partial_spec.rb
-- spec/lib/api/category/similarity_spec.rb
-- spec/lib/api/category/weight_spec.rb
 - spec/lib/api/search/boost_spec.rb
-- spec/lib/api/source_spec.rb
 - spec/lib/api/tokenizer/character_substituter_spec.rb
-- spec/lib/api/tokenizer_spec.rb
 - spec/lib/backends/backend_spec.rb
 - spec/lib/backends/file/basic_spec.rb
 - spec/lib/backends/file_spec.rb
@@ -357,14 +352,17 @@ files:
 - spec/lib/generators/partial/none_spec.rb
 - spec/lib/generators/partial/postfix_spec.rb
 - spec/lib/generators/partial/substring_spec.rb
+- spec/lib/generators/partial_spec.rb
 - spec/lib/generators/similarity/double_metaphone_spec.rb
 - spec/lib/generators/similarity/metaphone_spec.rb
 - spec/lib/generators/similarity/none_spec.rb
 - spec/lib/generators/similarity/phonetic_spec.rb
 - spec/lib/generators/similarity/soundex_spec.rb
+- spec/lib/generators/similarity_spec.rb
 - spec/lib/generators/weights/constant_spec.rb
 - spec/lib/generators/weights/dynamic_spec.rb
 - spec/lib/generators/weights/logarithmic_spec.rb
+- spec/lib/generators/weights_spec.rb
 - spec/lib/helpers/measuring_spec.rb
 - spec/lib/index_indexed_spec.rb
 - spec/lib/index_indexing_spec.rb
@@ -405,6 +403,7 @@ files:
 - spec/lib/search_spec.rb
 - spec/lib/sinatra_spec.rb
 - spec/lib/solr/schema_generator_spec.rb
+- spec/lib/source_spec.rb
 - spec/lib/statistics_spec.rb
 - spec/lib/tasks/try_spec.rb
 - spec/lib/tokenizer_spec.rb
@@ -456,6 +455,7 @@ test_files:
 - spec/functional/only_spec.rb
 - spec/functional/realtime_spec.rb
 - spec/functional/regression_spec.rb
+- spec/functional/remap_qualifiers_spec.rb
 - spec/functional/speed_spec.rb
 - spec/functional/terminate_early_spec.rb
 - spec/functional/tokenizer_spec.rb
@@ -463,13 +463,8 @@ test_files:
 - spec/integration/sinatra_index_actions_spec.rb
 - spec/lib/analytics_spec.rb
 - spec/lib/analyzer_spec.rb
-- spec/lib/api/category/partial_spec.rb
-- spec/lib/api/category/similarity_spec.rb
-- spec/lib/api/category/weight_spec.rb
 - spec/lib/api/search/boost_spec.rb
-- spec/lib/api/source_spec.rb
 - spec/lib/api/tokenizer/character_substituter_spec.rb
-- spec/lib/api/tokenizer_spec.rb
 - spec/lib/backends/backend_spec.rb
 - spec/lib/backends/file/basic_spec.rb
 - spec/lib/backends/file_spec.rb
@@ -514,14 +509,17 @@ test_files:
 - spec/lib/generators/partial/none_spec.rb
 - spec/lib/generators/partial/postfix_spec.rb
 - spec/lib/generators/partial/substring_spec.rb
+- spec/lib/generators/partial_spec.rb
 - spec/lib/generators/similarity/double_metaphone_spec.rb
 - spec/lib/generators/similarity/metaphone_spec.rb
 - spec/lib/generators/similarity/none_spec.rb
 - spec/lib/generators/similarity/phonetic_spec.rb
 - spec/lib/generators/similarity/soundex_spec.rb
+- spec/lib/generators/similarity_spec.rb
 - spec/lib/generators/weights/constant_spec.rb
 - spec/lib/generators/weights/dynamic_spec.rb
 - spec/lib/generators/weights/logarithmic_spec.rb
+- spec/lib/generators/weights_spec.rb
 - spec/lib/helpers/measuring_spec.rb
 - spec/lib/index_indexed_spec.rb
 - spec/lib/index_indexing_spec.rb
@@ -562,6 +560,8 @@ test_files:
 - spec/lib/search_spec.rb
 - spec/lib/sinatra_spec.rb
 - spec/lib/solr/schema_generator_spec.rb
+- spec/lib/source_spec.rb
 - spec/lib/statistics_spec.rb
 - spec/lib/tasks/try_spec.rb
 - spec/lib/tokenizer_spec.rb
+has_rdoc: