picky 4.12.1 → 4.12.2

data/lib/picky/query/indexes.rb

@@ -13,9 +13,7 @@ module Picky
     #
     class Indexes
       
-      delegate :size,
-               :first,
-               :to => :@indexes
+      forward :size, :first, :to => :@indexes
       
       attr_reader :indexes,
                   :ignored_categories
@@ -30,21 +28,23 @@ module Picky
 
         @indexes = indexes
       end
-
-      # Ignore the categories with these qualifiers.
-      #
-      # Example:
-      #   search = Search.new(index1, index2, index3) do
-      #     ignore :name, :first_name
-      #   end
-      #
-      # Note: Cleans up / optimizes after being called.
-      #
-      def ignore *qualifiers
-        @ignored_categories ||= []
-        @ignored_categories += qualifiers.map { |qualifier| @mapper.map qualifier }.compact
-        @ignored_categories.uniq!
-      end
+      
+      # TODO Reinstate.
+      #
+      # # Ignore the categories with these qualifiers.
+      # #
+      # # Example:
+      # #   search = Search.new(index1, index2, index3) do
+      # #     ignore :name, :first_name
+      # #   end
+      # #
+      # # Note: Cleans up / optimizes after being called.
+      # #
+      # def ignore *qualifiers
+      #   @ignored_categories ||= []
+      #   @ignored_categories += qualifiers.map { |qualifier| @qualifier_mapper.map qualifier }.compact
+      #   @ignored_categories.uniq!
+      # end
 
       # Returns a number of prepared (sorted, reduced etc.) allocations for the given tokens.
       #

data/lib/picky/query/token.rb

@@ -15,7 +15,7 @@ module Picky
       attr_writer :similar
       attr_writer :predefined_categories
       
-      delegate :blank?, :to => :@text
+      forward :blank?, :to => :@text
       
       # Normal initializer.
       #

data/lib/picky/query/tokens.rb

@@ -10,9 +10,9 @@ module Picky
 
       attr_reader :tokens, :ignore_unassigned
 
-      # Basically delegates to its internal tokens array.
+      # Basically forwards to its internal tokens array.
       #
-      self.delegate *[Enumerable.instance_methods, :slice!, :[], :uniq!, :last, :reject!, :length, :size, :empty?, :each, :exit, { :to => :@tokens }].flatten
+      forward *[Enumerable.instance_methods, :slice!, :[], :uniq!, :last, :reject!, :length, :size, :empty?, :each, :exit, :to => :@tokens].flatten
 
       # Create a new Tokens object with the array of tokens passed in.
       #

data/lib/picky/rack/harakiri.rb

@@ -28,7 +28,7 @@ module Rack
 
     # #call interface method.
     #
-    # Harakiri is a middleware, so it delegates the the app or
+    # Harakiri is a middleware, so it forwards the the app or
     # the next middleware after checking if it is time to honorably retire.
     #
     def call env

data/lib/picky/results.rb

@@ -41,7 +41,7 @@ module Picky
         allocations.process!(amount, offset, extra_allocations)
     end
 
-    # Delegates to allocations.
+    # Forwards to allocations.
     #
     # Note that this is an expensive call and
     # should not be done repeatedly. Just keep
@@ -51,7 +51,7 @@ module Picky
       allocations.ids only
     end
 
-    # The total results. Delegates to the allocations.
+    # The total results. Forwards to the allocations.
     #
     def total
       @total ||= allocations.total || 0

data/lib/picky/search.rb

@@ -23,10 +23,10 @@ module Picky
     attr_accessor :tokenizer,
                   :boosts
 
-    delegate :ignore,
-             :only,
-             :remap_qualifiers,
-             :to => :indexes
+    forward :ignore,
+            :only,
+            :remap_qualifiers,
+            :to => :indexes
 
     # Takes:
     # * A number of indexes
@@ -213,7 +213,7 @@ module Picky
                    unique
     end
 
-    # Delegates the tokenizing to the query tokenizer.
+    # Forwards the tokenizing to the query tokenizer.
     #
     # Parameters:
     # * text: The string to tokenize.

data/lib/picky/search_facets.rb

@@ -8,12 +8,12 @@ module Picky
     #   category: The category whose facets to return.
     # 
     # Options
-    #   counts: Whether you want counts (returns a Hash) or not (returns an Array).
-    #   at_least: A minimum count a facet needs to have (inclusive). 
+    #   counts: Whether you want counts (returns a Hash) or not (returns an Array). (Default true)
+    #   at_least: A minimum count a facet needs to have (inclusive). (Default 1)
     #   filter: A query to filter the facets with.
     #
     # Usage:
-    #   search.facets :name, filter: 'surname:peter', more_than: 0
+    #   search.facets :name, filter: 'surname:peter', at_least: 2
     #
     def facets category_identifier, options = {}
       # TODO Make it work. How should it work with multiple indexes?

data/lib/picky/sinatra.rb

@@ -2,7 +2,7 @@
 #
 require_relative 'sinatra/index_actions'
 
-# TODO Remove for 5.0.
+# TODO Remove for 5.0 (or rename to Tokenizer.indexing, ...).
 #
 module Picky
 

data/lib/picky/tokenizer/regexp_wrapper.rb

@@ -0,0 +1,19 @@
+class RegexpWrapper
+  
+  def initialize regexp
+    @regexp = regexp
+  end
+  
+  def split text
+    text.split @regexp
+  end
+  
+  def source
+    @regexp.source
+  end
+  
+  def method_missing name, *args, &block
+    @regexp.send name, *args, &block
+  end
+
+end

data/lib/picky/tokenizer.rb

@@ -105,17 +105,6 @@ Case sensitive?     #{@case_sensitive ? "Yes." : "-"}
         RegexpWrapper.new thing
       end
     end
-    class RegexpWrapper
-      def initialize regexp
-        @regexp = regexp
-      end
-      def split text
-        text.split @regexp
-      end
-      def source
-        @regexp.source
-      end
-    end
     def split text
       @splits_text_on.split text
     end
@@ -124,8 +113,8 @@ Case sensitive?     #{@case_sensitive ? "Yes." : "-"}
     #
     # We only allow arrays.
     #
-    # TODO 5.0 Rename to normalizes(config)
-    # TODO 5.0 Rename to normalize(text)
+    # TODO 5.0 Rename to normalizes(config) or normalizes_words
+    # TODO 5.0 Rename to normalize(text) or normalize_words
     #
     def normalizes_words regexp_replaces
       raise ArgumentError.new "#{__method__} takes an Array of replaces as argument, not a #{regexp_replaces.class}." unless regexp_replaces.respond_to?(:to_ary) || regexp_replaces.respond_to?(:normalize_with_patterns)

data/lib/picky/wrappers/bundle/delegators.rb

@@ -6,66 +6,66 @@ module Picky
 
       module Delegator
 
-        delegate :add,
+        forward :add,
 
-                 :inverted,
-                 :weights,
-                 :similarity,
-                 :configuration,
+                :inverted,
+                :weights,
+                :similarity,
+                :configuration,
 
-                 :backup,
-                 :restore,
-                 :delete,
+                :backup,
+                :restore,
+                :delete,
 
-                 :reset_backend,
+                :reset_backend,
 
-                 :raise_unless_cache_exists,
-                 :raise_unless_index_exists,
-                 :raise_unless_similarity_exists,
+                :raise_unless_cache_exists,
+                :raise_unless_index_exists,
+                :raise_unless_similarity_exists,
 
-                 :similar,
+                :similar,
 
-                 :to => :bundle
+                :to => :bundle
 
       end
 
       module IndexingDelegator
 
-        delegate :[]=,
-                 :analyze,
-                 :dump,
-                 :empty,
-                 :empty_configuration,
-                 :generate_caches_from_memory,
-                 :generate_caches_from_source,
-                 :generate_partial_from,
-                 :retrieve,
-                 :size,
-                 :to => :bundle
+        forward :[]=,
+                :analyze,
+                :dump,
+                :empty,
+                :empty_configuration,
+                :generate_caches_from_memory,
+                :generate_caches_from_source,
+                :generate_partial_from,
+                :retrieve,
+                :size,
+                :to => :bundle
 
       end
 
       module IndexedDelegator
 
-        delegate :[],
-                 :add_partialized,
-                 :clear,
-                 :clear_inverted,
-                 :clear_weights,
-                 :clear_similarity,
-                 :clear_configuration,
-                 :clear_realtime,
-                 :identifier,
-                 :ids,
-                 :load,
-                 :load_inverted,
-                 :load_weights,
-                 :load_similarity,
-                 :load_configuration,
-                 :name,
-                 :remove,
-                 :weight,
-                 :to => :bundle
+        forward :[],
+                :add_partialized,
+                :clear,
+                :clear_inverted,
+                :clear_weights,
+                :clear_similarity,
+                :clear_configuration,
+                :clear_realtime,
+                :identifier,
+                :ids,
+                :load,
+                :load_inverted,
+                :load_weights,
+                :load_similarity,
+                :load_configuration,
+                :name,
+                :remove,
+                :weight,
+                :to => :bundle
 
       end
 

data/lib/picky/wrappers/bundle/wrapper.rb

@@ -6,7 +6,7 @@ module Picky
     #
     module Bundle
 
-      # Base wrapper. Just delegates all methods to the bundle.
+      # Base wrapper. Just forwards all methods to the bundle.
       #
       class Wrapper
 

data/lib/picky.rb

@@ -20,10 +20,8 @@ module Picky
   #
   # TODO Remove active support.
   #
-  require 'active_support/core_ext/module/delegation'
   require 'active_support/core_ext/logger'
   require 'active_support/core_ext/object/blank'
-  require 'active_support/core_ext/enumerable'
   require 'active_support/multibyte'
   require 'multi_json'
   require 'rack_fast_escape' if defined? Rack

data/lib/tasks/server.rake

@@ -16,7 +16,8 @@ namespace :server do
   task :start => :framework do
     chdir_to_root
     daemonize = PICKY_ENVIRONMENT == 'production' ? '-D' : ''
-    command = "export PICKY_ENV=#{PICKY_ENVIRONMENT}; unicorn -c unicorn.rb #{daemonize}".strip
+    ENV['PICKY_ENV'] = PICKY_ENVIRONMENT
+    command = "unicorn -c unicorn.rb #{daemonize}".strip
     puts "Running \`#{command}\`."
     exec command
   end

data/spec/functional/backends/redis_bundle_realtime_spec.rb

@@ -125,7 +125,7 @@ describe Picky::Bundle do
     end
   end
 
-  # TODO Add symbols.
+  # SYMBOLS
   #
   # context 'symbols' do
   #   describe 'combined' do

data/spec/functional/backends/sqlite_bundle_realtime_spec.rb

@@ -125,7 +125,7 @@ describe Picky::Bundle do
     end
   end
 
-  # TODO Add symbols.
+  # SYMBOLS
   #
   # context 'symbols' do
   #   describe 'combined' do

data/spec/functional/custom_delimiters_spec.rb

@@ -4,8 +4,6 @@ require 'spec_helper'
 
 describe 'custom delimiters' do
   
-  # TODO Add range query delimiter.
-  #
   after(:each) do
     Picky::Query::Token.partial_character = '\*'
     Picky::Query::Token.no_partial_character = '"'

data/spec/functional/facets_spec.rb

@@ -167,7 +167,7 @@ describe 'facets' do
       it 'is fast enough' do
         performance_of {
           10.times { finder.facets(:age_category, filter: 'surname:meier name:peter', counts: false) }
-        }.should < 0.003
+        }.should < 0.0031
       end
       it 'has one filtered facet' do
         finder.facets(:age_category, filter: 'surname:meier name:peter', counts: false).should == ['45']

data/spec/lib/backends/backend_spec.rb

@@ -5,7 +5,7 @@ describe Picky::Backends::Backend do
   let(:backend) { described_class.new }
 
   describe 'weight' do
-    it 'delegates to the parameter' do
+    it 'forwards to the parameter' do
       combinations = stub :combinations
 
       combinations.should_receive(:score).once.with()

data/spec/lib/backends/file/basic_spec.rb

@@ -19,7 +19,7 @@ describe Picky::Backends::File::Basic do
 
     describe 'to_s' do
       it 'returns the cache path with the default file extension' do
-        basic.to_s.should == 'Picky::Backends::File::Basic(spec/temp/some/cache/path/to/file.file.index,spec/temp/some/cache/path/to/file.file_mapping.index.memory.json)'
+        basic.to_s.should == 'Picky::Backends::File::Basic(spec/temp/some/cache/path/to/file.file.index,spec/temp/some/cache/path/to/file.file_mapping.memory.json)'
       end
     end
   end

data/spec/lib/backends/file_spec.rb

@@ -38,7 +38,7 @@ describe Picky::Backends::File do
     describe 'create_...' do
       [
         [:inverted,      Picky::Backends::File::JSON],
-        [:weights,       Picky::Backends::File::JSON],
+        [:weights,       Picky::Backends::Memory::JSON],
         [:similarity,    Picky::Backends::File::JSON],
         [:configuration, Picky::Backends::File::JSON]
       ].each do |type, kind|

data/spec/lib/backends/memory/json_spec.rb

@@ -18,7 +18,7 @@ describe Picky::Backends::Memory::JSON do
     end
 
     describe "dump" do
-      it "delegates to the given hash" do
+      it "forwards to the given hash" do
         hash = stub :hash
 
         json.should_receive(:dump_json).once.with hash

data/spec/lib/backends/memory/marshal_spec.rb

@@ -18,7 +18,7 @@ describe Picky::Backends::Memory::Marshal do
     end
 
     describe "dump" do
-      it "delegates to the given hash" do
+      it "forwards to the given hash" do
         hash = stub :hash
 
         marshal.should_receive(:dump_marshal).once.with hash

data/spec/lib/backends/redis/float_spec.rb

@@ -17,7 +17,7 @@ describe Picky::Backends::Redis::Float do
   end
 
   describe 'member' do
-    it 'delegates to the backend' do
+    it 'forwards to the backend' do
       client.should_receive(:hget).once.with 'some_namespace', 'some'
 
       backend['some']

data/spec/lib/backends/redis/string_spec.rb

@@ -17,7 +17,7 @@ describe Picky::Backends::Redis::String do
   end
   
   describe 'member' do
-    it 'delegates to the backend' do
+    it 'forwards to the backend' do
       client.should_receive(:hget).once.with :some_namespace, :some_symbol
       
       backend[:some_symbol]

data/spec/lib/backends/sqlite/array_spec.rb

@@ -8,7 +8,7 @@ describe Picky::Backends::SQLite::Array do
     let(:db) { described_class.new 'spec/temp/some/cache/path/to/file' }
 
     describe 'dump' do
-      it 'delegates to the given hash' do
+      it 'forwards to the given hash' do
         hash = stub :hash
 
         db.should_receive(:dump_sqlite).once.with hash
@@ -76,7 +76,7 @@ describe Picky::Backends::SQLite::Array do
     let(:db) { described_class.new 'spec/temp/some/cache/path/to/file', realtime: true }
 
     describe 'dump' do
-      it 'delegates to the given hash' do
+      it 'forwards to the given hash' do
         hash = stub :hash
 
         db.should_receive(:dump_sqlite).never

data/spec/lib/backends/sqlite/value_spec.rb

@@ -8,7 +8,7 @@ describe Picky::Backends::SQLite::Value do
     let(:db) { described_class.new 'spec/temp/some/cache/path/to/file' }
 
     describe 'dump' do
-      it 'delegates to the given hash' do
+      it 'forwards to the given hash' do
         hash = stub :hash
 
         db.should_receive(:dump_sqlite).once.with hash

data/spec/lib/category_indexing_spec.rb

@@ -13,7 +13,7 @@ describe Picky::Category do
     let(:partial) { category.partial }
 
     describe 'clear' do
-      it 'delegates to both bundles' do
+      it 'forwards to both bundles' do
         exact.should_receive(:clear).once.with()
         partial.should_receive(:clear).once.with()
 

data/spec/lib/extensions/module_spec.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 
 describe Module do
 
-  describe 'each_delegate' do
+  describe 'each_forward' do
     context "with correct params" do
-      before(:each) do
-        @klass = Class.new do
+      let(:klass) do
+        Class.new do
 
-          each_delegate :bli, :bla, :blu, :to => :@some_enumerable
+          each_forward :bli, :bla, :blu, :to => :@some_enumerable
 
           def initialize some_enumerable
             @some_enumerable = some_enumerable
@@ -17,7 +17,7 @@ describe Module do
       end
       it 'should send each a bli' do
         bli = stub :bli
-        delegating = @klass.new [bli, bli, bli, bli]
+        delegating = klass.new [bli, bli, bli, bli]
 
         bli.should_receive(:bli).exactly(4).times
 
@@ -25,10 +25,47 @@ describe Module do
       end
     end
     context "without correct params" do
+      it 'should raise an error' do
+        lambda do
+          Class.new do
+            each_forward :bli, :bla, :blu # :to missing
+          end
+        end.should raise_error(ArgumentError)
+      end
+    end
+  end
+  
+  describe 'forward' do
+    context "with correct params" do
+      let(:klass) do
+        Class.new do
+
+          forward :bli, :bla, :blu, :to => :@some_thing
+
+          def initialize some_thing
+            @some_thing = some_thing
+          end
+
+        end
+      end
       it 'should send each a bli' do
+        bli = stub :bli
+        delegating = klass.new bli
+
+        bli.should_receive(:bli).exactly(1).times
+        bli.should_receive(:bla).exactly(1).times
+        bli.should_receive(:blu).exactly(1).times
+
+        delegating.bli
+        delegating.bla
+        delegating.blu
+      end
+    end
+    context "without correct params" do
+      it 'should raise an error' do
         lambda do
           Class.new do
-            each_delegate :bli, :bla, :blu # :to missing
+            forward :bli, :bla, :blu # :to missing
           end
         end.should raise_error(ArgumentError)
       end

data/spec/lib/index_indexed_spec.rb

@@ -31,14 +31,14 @@ describe Picky::Index do
     end
 
     describe "load" do
-      it "delegates to each category" do
+      it "forwards to each category" do
         @categories.should_receive(:load).once.with
 
         @index.load
       end
     end
     describe "possible_combinations" do
-      it "delegates to the combinator" do
+      it "forwards to the combinator" do
         @categories.should_receive(:possible_combinations).once.with :some_token
 
         @index.possible_combinations :some_token

data/spec/lib/index_spec.rb

@@ -63,7 +63,7 @@ describe Picky::Index do
     end
 
     describe 'geo_categories' do
-      it 'delegates correctly' do
+      it 'forwards correctly' do
         api.should_receive(:ranged_category).once.with :some_lat, 0.00898312, from: :some_lat_from
         api.should_receive(:ranged_category).once.with :some_lng, 0.01796624, from: :some_lng_from
 
@@ -103,6 +103,27 @@ describe Picky::Index do
         end
       end
     end
+    
+    describe '#to_stats' do
+      let(:index) do
+        the_source = some_source
+        described_class.new :some_index_name do
+          source the_source
+          category :text1
+          category :text2
+          result_identifier :foobar
+        end
+      end
+      
+      it 'outputs the stats correctly' do
+        index.to_stats.should == <<-EXPECTED
+some_index_name (Picky::Index):
+  source:            some_source
+  categories:        text1, text2
+  result identifier: "foobar"
+EXPECTED
+      end
+    end
   end
 
 end

data/spec/lib/indexers/base_spec.rb

@@ -12,7 +12,7 @@ describe Picky::Indexers::Base do
   end
 
   describe 'source' do
-    it 'delegates it to the index or category' do
+    it 'forwards it to the index or category' do
       some_index_or_category.should_receive(:source).once.with
 
       indexer.source

data/spec/lib/indexes_indexing_spec.rb

@@ -44,7 +44,7 @@ describe Picky::Indexes do
         indexes.indexes.should == []
       end
     end
-    def self.it_delegates_each name
+    def self.it_forwards_each name
       describe name do
         it "calls #{name} on each in order" do
           @index1.should_receive(name).once.with.ordered
@@ -54,7 +54,7 @@ describe Picky::Indexes do
         end
       end
     end
-    it_delegates_each :clear
+    it_forwards_each :clear
   end
 
 end