picky 2.1.2 → 2.2.0

data/lib/picky/sources/delicious.rb

@@ -30,7 +30,7 @@ module Sources
 
     # Harvests the data to index.
     #
-    def harvest _, category
+    def harvest category
       get_data do |indexed_id, data|
         text = data[category.from]
         next unless text

data/lib/picky/sources/wrappers/base.rb

@@ -1,28 +1,27 @@
 module Sources
-  
+
   # Source wrappers can be used to rewrite data before it goes into the index.
   #
   # For example if you want to normalize data.
   #
   module Wrappers # :nodoc:all
-    
+
     class Base
-      
-      attr_reader :backend, :category
-      
+
+      attr_reader :source
+
       # Wraps an indexing category.
       #
-      def initialize category
-        @category = category
-        @backend  = category.source
+      def initialize source
+        @source = source
       end
-      
+
       # Default is delegation for all methods
       #
-      delegate :harvest, :connect_backend, :take_snapshot, :key_format, :to => :backend
-      
+      delegate :harvest, :connect_backend, :take_snapshot, :key_format, :to => :source
+
     end
-      
+
   end
-  
+
 end

data/lib/picky/sources/wrappers/location.rb

@@ -1,82 +1,52 @@
 module Sources
-  
+
   module Wrappers
-    
+
+    # Should this actually just be a tokenizer?
+    #
     class Location < Base
-      
-      attr_reader :precision, :grid
-      
-      # TODO Save min and grid!
-      #
-      def initialize category, options = {}
-        super category
-        
-        @precision   = extract_precision options
-        @calculation = Calculations::Location.new extract_user_grid(options), @precision
-      end
-      
-      #
-      #
-      def extract_user_grid options
-        options[:grid] || raise("Option :grid needs to be passed to a location.")
+
+      attr_reader :calculation
+
+      def initialize source, grid, precision = 1
+        super source
+        @calculation = Internals::Calculations::Location.new grid, precision
       end
-      # Extracts an amount of grids that this 
-      # Precision is given in a value.
-      # 1 is low (up to 16.6% error), 5 is very high (up to 5% error).
-      #
-      # We don't recommend using values higher than 5.
-      #
-      # Default is 1.
+
+      # Yield the data (id, text for id) for the given category.
       #
-      def extract_precision options
-        options[:precision] || 1
-      end
-      
-      # Yield the data (id, text for id) for the given type and category.
-      #
-      def harvest type, category
+      def harvest category
         minimum = 1.0/0
-        
+
         # Cache. TODO Make option?
         #
         locations = []
-        
+
         # Gather min/max.
         #
-        backend.harvest type, category do |indexed_id, location|
+        source.harvest category do |indexed_id, location|
           location = location.to_f
           minimum = location if location < minimum
           locations << [indexed_id, location]
         end
-        
-        @calculation.minimum = minimum
-        
+
+        calculation.minimum = minimum
+
         # Recalculate locations.
         #
         locations.each do |indexed_id, location|
-          locations_for(@calculation.recalculate(location)).each do |new_location|
+          calculation.recalculated_range(location).each do |new_location|
             yield indexed_id, new_location.to_s
           end
         end
-        
+
         # TODO Move to the right place.
         #
         category.exact[:location_minimum] = minimum
       end
-      
-      # Put location onto multiple places on a grid.
-      #
-      # Note: Always returns an integer.
-      #
-      def locations_for repositioned_location
-        min_location = repositioned_location - precision
-        max_location = repositioned_location + precision
-        
-        (min_location..max_location).to_a
-      end
-    
+
     end
-    
+
   end
-  
+
 end

data/lib/tasks/search.rake

@@ -2,9 +2,8 @@
 #
 desc 'Simple terminal search - pass it an URL to search on, e.g. /books.'
 task :search do
-  load File.expand_path '../../picky/auxiliary/terminal.rb', __FILE__
-  url_or_path = ARGV[1] || raise("Usage:\n  rake search <URL> [<result ids>]\n  E.g. rake search /books\n       rake search localhost:8080/books 10")
-  ids         = ARGV[2]
-  terminal = Terminal.new url_or_path, ids
-  terminal.run
+  puts <<-DEPRECATED
+Deprecated. New usage:
+  picky search <URL> [<result id amount = 20>]
+  DEPRECATED
 end

data/lib/tasks/todo.rake

@@ -1,5 +1,5 @@
 desc "Finds where Picky still needs input from you."
-task :'to#{}do' do
+task :"to#{}do" do
   if system "grep -e 'TODO.*' -n --color=always -R *"
     puts "Picky needs a bit of input from you there. Thanks."
   else

data/spec/{lib → aux/picky}/cli_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 # We need to load the CLI file explicitly as the CLI is not loaded with the Loader (not needed in the server, only for script runs).
 #
-require File.expand_path '../../../lib/picky/cli', __FILE__
+require File.expand_path '../../../../aux/picky/cli', __FILE__
 
 # TODO Finish this prototype Spec, redesign.
 #
@@ -15,8 +15,9 @@ describe Picky::CLI do
       Picky::CLI.mapping.should == {
         :generate => [Picky::CLI::Generate, :"{sinatra_client,unicorn_server,empty_unicorn_server}", :app_directory_name],
         :help     => [Picky::CLI::Help],
-        :stats    => [Picky::CLI::Statistics, :"logfile (e.g. log/search.log)", "port (default: 4567)"],
-        :live     => [Picky::CLI::Live, "host:port/path (default: localhost:8080/admin)", "port (default: 4568)"]
+        :live     => [Picky::CLI::Live, "host:port/path (default: localhost:8080/admin)", "port (default: 4568)"],
+        :search   => [Picky::CLI::Search, :url_or_path, 'amount of ids (default 20)'],
+        :stats    => [Picky::CLI::Statistics, :"logfile (e.g. log/search.log)", "port (default: 4567)"]
       }
     end
   end
@@ -34,8 +35,9 @@ describe Picky::CLI do
 Possible commands:
   picky generate {sinatra_client,unicorn_server,empty_unicorn_server} app_directory_name
   picky help 
-  picky stats logfile (e.g. log/search.log) [port (default: 4567)]
   picky live [host:port/path (default: localhost:8080/admin)] [port (default: 4568)]
+  picky search url_or_path [amount of ids (default 20)]
+  picky stats logfile (e.g. log/search.log) [port (default: 4567)]
 HELP
         cli.execute 'help'
       end
@@ -56,12 +58,15 @@ HELP
       it 'returns Help for help' do
         cli.executor_class_for(:help).should == [Picky::CLI::Help]
       end
-      it 'returns Statistics for stats' do
-        cli.executor_class_for(:stats).should == [Picky::CLI::Statistics, :"logfile (e.g. log/search.log)", "port (default: 4567)"]
-      end
       it 'returns Live for live' do
         cli.executor_class_for(:live).should == [Picky::CLI::Live, "host:port/path (default: localhost:8080/admin)", "port (default: 4568)"]
       end
+      it 'returns Search for stats' do
+        cli.executor_class_for(:search).should == [Picky::CLI::Search, :url_or_path, "amount of ids (default 20)"]
+      end
+      it 'returns Statistics for stats' do
+        cli.executor_class_for(:stats).should == [Picky::CLI::Statistics, :"logfile (e.g. log/search.log)", "port (default: 4567)"]
+      end
       it 'returns Help for silly input' do
         cli.executor_class_for(:gagagagagagaga).should == [Picky::CLI::Help]
       end
@@ -76,7 +81,7 @@ HELP
     let(:executor) { described_class.new }
     describe 'usage' do
       it 'calls puts with an usage' do
-        executor.should_receive(:puts).once.with "Usage\n  picky some_name param1 [param2]"
+        executor.should_receive(:puts).once.with "Usage:\n  picky some_name param1 [param2]"
         
         executor.usage :some_name, [:param1, 'param2']
       end

data/spec/lib/application_spec.rb

@@ -8,7 +8,7 @@ describe Application do
     it "should run ok" do
       lambda {
         class MinimalTestApplication < Application
-          books = Index::Memory.new :books, Sources::DB.new('SELECT id, title FROM books', :file => 'app/db.yml')
+          books = Index::Memory.new :books, source: Sources::DB.new('SELECT id, title FROM books', :file => 'app/db.yml')
           books.define_category :title
           
           rack_adapter.stub! :exclaim # Stopping it from exclaiming.
@@ -24,23 +24,23 @@ describe Application do
         # Here we just test if the API can be called ok.
         #
         class TestApplication < Application
-          default_indexing removes_characters:                 /[^a-zA-Z0-9\s\/\-\"\&\.]/,
-                           stopwords:                          /\b(and|the|of|it|in|for)\b/,
-                           splits_text_on:                     /[\s\/\-\"\&\.]/,
-                           removes_characters_after_splitting: /[\.]/,
-                           normalizes_words:                   [[/\$(\w+)/i, '\1 dollars']],
-                           reject_token_if:                    lambda { |token| token.blank? || token == :amistad }
+          indexing  removes_characters:                 /[^a-zA-Z0-9\s\/\-\"\&\.]/,
+                    stopwords:                          /\b(and|the|of|it|in|for)\b/,
+                    splits_text_on:                     /[\s\/\-\"\&\.]/,
+                    removes_characters_after_splitting: /[\.]/,
+                    normalizes_words:                   [[/\$(\w+)/i, '\1 dollars']],
+                    rejects_token_if:                   lambda { |token| token.blank? || token == :amistad }
                            
-          default_querying removes_characters: /[^a-zA-Z0-9äöü\s\/\-\,\&\"\~\*\:]/,
-                           stopwords:          /\b(and|the|of|it|in|for)\b/,
-                           splits_text_on:     /[\s\/\-\,\&]+/,
-                           normalizes_words:   [[/Deoxyribonucleic Acid/i, 'DNA']],
-                           
-                           substitutes_characters_with: CharacterSubstituters::WestEuropean.new,
-                           maximum_tokens: 5
+          searching removes_characters: /[^a-zA-Z0-9äöü\s\/\-\,\&\"\~\*\:]/,
+                    stopwords:          /\b(and|the|of|it|in|for)\b/,
+                    splits_text_on:     /[\s\/\-\,\&]+/,
+                    normalizes_words:   [[/Deoxyribonucleic Acid/i, 'DNA']],
+                    
+                    substitutes_characters_with: CharacterSubstituters::WestEuropean.new,
+                    maximum_tokens: 5 # TODO maximum_words?
           
           books_index = Index::Memory.new :books,
-                              Sources::DB.new('SELECT id, title, author, isbn13 as isbn FROM books', :file => 'app/db.yml')
+                                          source: Sources::DB.new('SELECT id, title, author, isbn13 as isbn FROM books', :file => 'app/db.yml')
           books_index.define_category :title,
                                       similarity: Similarity::DoubleMetaphone.new(3) # Up to three similar title word indexed.
           books_index.define_category :author,
@@ -48,7 +48,9 @@ describe Application do
           books_index.define_category :isbn,
                                       partial: Partial::None.new # Partially searching on an ISBN makes not much sense.
           
-          geo_index = Index::Memory.new :geo, Sources::CSV.new(:location, :north, :east, file: 'data/ch.csv', col_sep: ',') do
+          geo_index = Index::Memory.new :geo do
+            source          Sources::CSV.new(:location, :north, :east, file: 'data/ch.csv', col_sep: ',')
+            indexing        removes_characters: /[^a-z]/
             category        :location,
                             similarity: Similarity::Metaphone.new(4)
             ranged_category :north1, 1, precision: 3, from: :north
@@ -58,6 +60,9 @@ describe Application do
           rack_adapter.stub! :exclaim # Stopping it from exclaiming.
           
           route %r{^/books} => Search.new(books_index)
+          route %r{^/buks}  => Search.new(books_index) do
+            searching removes_characters: /[buks]/
+          end
         end
       }.should_not raise_error
     end

data/spec/lib/index/base_spec.rb

@@ -4,80 +4,127 @@ require 'spec_helper'
 
 describe Index::Base do
   
-  let(:some_source) { stub :source, :harvest => nil }
+  let(:some_source) { stub :source, :harvest => nil, :inspect => 'some_source' }
   
   context 'initializer' do
     it 'works' do
-      expect { described_class.new :some_index_name, some_source }.to_not raise_error
+      expect { described_class.new :some_index_name, source: some_source }.to_not raise_error
     end
     it 'fails correctly' do
-      expect { described_class.new 0, some_source }.to raise_error(<<-ERROR
-The index identifier (you gave "0") for Index::Memory/Index::Redis should be a String/Symbol,
-Examples:
-  Index::Memory.new(:my_cool_index, ...) # Recommended
-  Index::Redis.new("a-redis-index", ...)
-ERROR
-)
+      expect { described_class.new 0, some_source }.to raise_error
     end
     it 'fails correctly' do
-      expect { described_class.new :some_index_name, :some_source }.to raise_error(<<-ERROR
-The index "some_index_name" should use a data source that responds to the method #harvest, which yields(id, text).
-Or it could use one of the built-in sources:
-  Sources::DB,
-  Sources::CSV,
-  Sources::Delicious,
-  Sources::Couch
+      expect { described_class.new :some_index_name, source: :some_source }.to raise_error
+    end
+    it 'fails with a good message deprecated way of source passing is used' do
+      expect { described_class.new :some_index_name, some_source }.to raise_error(<<-ERROR
+
+
+Sources are not passed in as second parameter for Index::Base anymore, but either
+* as :source option:
+  Index::Base.new(:some_index_name, source: some_source)
+or
+* given to the #source method inside the config block:
+  Index::Base.new(:some_index_name) do
+    source some_source
+  end
+
+Sorry about that breaking change (in 2.2.0), didn't want to go to 3.0.0 yet!
+
+All the best
+  -- Picky
+
+
 ERROR
 )
     end
+    it 'does not fail' do
+      expect { described_class.new :some_index_name, source: [] }.to_not raise_error
+    end
     it 'registers with the indexes' do
       @api = described_class.allocate
       
       ::Indexes.should_receive(:register).once.with @api
       
-      @api.send :initialize, :some_index_name, some_source
+      @api.send :initialize, :some_index_name, source: some_source
     end
   end
   
   context 'unit' do
-    before(:each) do
-      @api = described_class.new :some_index_name, some_source
+    let(:api) { described_class.new :some_index_name, source: some_source }
+    
+    describe 'define_source' do
+      it 'delegates to the internal indexing' do
+        indexing = stub :indexing
+        api.stub! :internal_indexing => indexing
+        
+        indexing.should_receive(:define_source).once.with :some_source
+        
+        api.define_source :some_source
+      end
+      it 'has an alias' do
+        indexing = stub :indexing
+        api.stub! :internal_indexing => indexing
+        
+        indexing.should_receive(:define_source).once.with :some_source
+        
+        api.source :some_source
+      end
+    end
+    
+    describe 'define_indexing' do
+      it 'delegates to the internal indexing' do
+        indexing = stub :indexing
+        api.stub! :internal_indexing => indexing
+        
+        indexing.should_receive(:define_indexing).once.with :some_options
+        
+        api.define_indexing :some_options
+      end
+      it 'has an alias' do
+        indexing = stub :indexing
+        api.stub! :internal_indexing => indexing
+        
+        indexing.should_receive(:define_indexing).once.with :some_options
+        
+        api.indexing :some_options
+      end
     end
 
     describe 'define_category' do
       context 'with block' do
         it 'returns itself' do
-          @api.define_category(:some_name){ |indexing, indexed| }.should == @api
+          api.define_category(:some_name){ |indexing, indexed| }.should == api
         end
         it 'takes a string' do
-          lambda { @api.define_category('some_name'){ |indexing, indexed| } }.should_not raise_error
+          lambda { api.define_category('some_name'){ |indexing, indexed| } }.should_not raise_error
         end
         it 'yields both the indexing category and the indexed category' do
-          @api.define_category(:some_name) do |indexing, indexed|
+          api.define_category(:some_name) do |indexing, indexed|
             indexing.should be_kind_of(Internals::Indexing::Category)
             indexed.should be_kind_of(Internals::Indexed::Category)
           end
         end
         it 'yields the indexing category which has the given name' do
-          @api.define_category(:some_name) do |indexing, indexed|
+          api.define_category(:some_name) do |indexing, indexed|
             indexing.name.should == :some_name
           end
         end
         it 'yields the indexed category which has the given name' do
-          @api.define_category(:some_name) do |indexing, indexed|
+          api.define_category(:some_name) do |indexing, indexed|
             indexed.name.should == :some_name
           end
         end
       end
       context 'without block' do
         it 'works' do
-          lambda { @api.define_category(:some_name) }.should_not raise_error
+          lambda { api.define_category(:some_name) }.should_not raise_error
         end
         it 'takes a string' do
-          lambda { @api.define_category('some_name').should == @api }.should_not raise_error
+          lambda { api.define_category('some_name').should == api }.should_not raise_error
         end
         it 'returns itself' do
-          @api.define_category(:some_name).should == @api
+          api.define_category(:some_name).should == api
         end
       end
     end

data/spec/lib/index/redis_spec.rb

@@ -8,7 +8,7 @@ describe Index::Redis do
   
   describe 'initialize' do
     it 'works' do
-      described_class.new :some_name, some_source
+      described_class.new :some_name, source: some_source
     end
   end
   

data/spec/lib/index_bundle_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe IndexBundle do
   
-  let(:some_index) { stub :index, :name => :some_index, :indexed => :indexed_index, :indexing => :indexing_index }
+  let(:some_index) { stub :index, :name => :some_index, :internal_indexed => :indexed_index, :internal_indexing => :indexing_index }
   let(:indexes) { described_class.new }
   let(:indexed) { stub :indexed, :register => nil }
   let(:indexing) { stub :indexing, :register => nil }

data/spec/lib/indexing/indexes_spec.rb

@@ -23,7 +23,7 @@ describe Indexing::Indexes do
           indexes.should_receive(:find).once.with(:index, :category).and_return @index1
         end
         it 'indexes' do
-          @index1.should_receive(:index).once.with
+          @index1.should_receive(:index!).once.with
           
           indexes.generate_index_only :index, :category
         end
@@ -64,10 +64,10 @@ describe Indexing::Indexes do
     describe 'index_for_tests' do
       it 'takes a snapshot, then indexes and caches each' do
         indexes.should_receive(:take_snapshot).once.with.ordered
-        @index1.should_receive(:index).once.with.ordered
-        @index1.should_receive(:cache).once.with.ordered
-        @index2.should_receive(:index).once.with.ordered
-        @index2.should_receive(:cache).once.with.ordered
+        @index1.should_receive(:index!).once.with.ordered
+        @index1.should_receive(:cache!).once.with.ordered
+        @index2.should_receive(:index!).once.with.ordered
+        @index2.should_receive(:cache!).once.with.ordered
         
         indexes.index_for_tests
       end

data/spec/lib/internals/calculations/location_spec.rb

@@ -1,12 +1,23 @@
 require 'spec_helper'
 
-describe Calculations::Location do
+describe Internals::Calculations::Location do
   
   context 'with precision 1' do
     before(:each) do
-      @calculation = Calculations::Location.new 1.5, 1
+      @calculation = described_class.new 1.5, 1
       @calculation.minimum = 42.7
     end
+    describe 'recalculated_range' do
+      it 'returns the right range' do
+        @calculation.recalculated_range(40.0).should == (-2..0)
+      end
+      it 'returns the right range' do
+        @calculation.recalculated_range(41.0).should == (-1..1)
+      end
+      it 'returns the right range' do
+        @calculation.recalculated_range(0).should == (-42..-40)
+      end
+    end
     describe 'recalculate' do
       it 'sets the minimum close value to the minimum minus user grid' do
         @calculation.recalculate(41.2).should == 1
@@ -25,7 +36,7 @@ describe Calculations::Location do
   
   context 'with precision 3' do
     before(:each) do
-      @calculation = Calculations::Location.new 1.5, 3
+      @calculation = described_class.new 1.5, 3
       @calculation.minimum = 42.7
     end
     describe 'recalculate' do

data/spec/lib/internals/index/files_spec.rb

@@ -4,10 +4,9 @@ describe Internals::Index::Files do
 
   before(:each) do
     index         = stub :index, :name => :some_index
-    category      = stub :category, :name => :some_category
-    configuration = Configuration::Index.new index, category
+    category      = Internals::Indexing::Category.new :some_category, index
     
-    @files         = described_class.new :some_name, configuration
+    @files         = described_class.new :some_name, category
     
     @prepared      = @files.prepared