picky 2.7.0 → 3.0.0.pre1

data/lib/picky/tokenizers/location.rb

@@ -1,47 +1,51 @@
-module Tokenizers
+module Picky
 
-  class Location < Base
+  module Tokenizers
 
-    attr_reader :calculation
+    class Location < Base
 
-    def initialize options = {}
-      super options
+      attr_reader :calculation
 
-      grid      = options[:grid]
-      precision = options[:precision] || 1
+      def initialize options = {}
+        super options
 
-      @calculation = Calculations::Location.new grid, precision
+        grid      = options[:grid]
+        precision = options[:precision] || 1
 
-      @minimum = 1.0 / 0
+        @calculation = Calculations::Location.new grid, precision
 
-      @locations = []
-    end
+        @minimum = 1.0 / 0
 
-    #
-    #
-    def tokenize text
+        @locations = []
+      end
 
-      # Gather min/max.
       #
-      source.harvest category do |indexed_id, location|
-        location = location.to_f
-        minimum = location if location < minimum
-        locations << [indexed_id, location]
-      end
+      #
+      def tokenize text
+
+        # Gather min/max.
+        #
+        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|
-        calculation.recalculated_range(location).each do |new_location|
-          yield indexed_id, new_location.to_s
+        # Recalculate locations.
+        #
+        locations.each do |indexed_id, 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.indexing_exact[:location_minimum] = minimum
       end
 
-      # TODO Move to the right place.
-      #
-      category.indexing_exact[:location_minimum] = minimum
     end
 
   end

data/lib/picky/tokenizers/query.rb

@@ -1,53 +1,59 @@
 # encoding: utf-8
 #
-module Tokenizers
-
-  # There are a few class methods that you can use to configure how a query works.
-  #
-  # removes_characters regexp
-  # illegal_after_normalizing regexp
-  # stopwords regexp
-  # contracts_expressions regexp, to_string
-  # splits_text_on regexp
-  # normalizes_words [[/regexp1/, 'replacement1'], [/regexp2/, 'replacement2']]
-  #
-  class Query < Base
-
-    def self.default= new_default
-      @default = new_default
-    end
-    def self.default
-      @default ||= new
-    end
+module Picky
 
-    attr_reader :maximum_tokens
-
-    def initialize options = {}
-      super options
-      @maximum_tokens = options[:maximum_tokens] || 5
-    end
+  module Tokenizers
 
-    # Let each token process itself.
-    # Reject, limit, and partialize tokens.
+    # There are a few class methods that you can use to configure how a query works.
     #
-    # In querying we work with real tokens (in indexing it's just symbols).
+    # removes_characters regexp
+    # illegal_after_normalizing regexp
+    # stopwords regexp
+    # contracts_expressions regexp, to_string
+    # splits_text_on regexp
+    # normalizes_words [[/regexp1/, 'replacement1'], [/regexp2/, 'replacement2']]
     #
-    def process tokens
-      tokens.reject                # Reject any tokens that don't meet criteria.
-      tokens.cap maximum_tokens    # Cut off superfluous tokens.
-      tokens.partialize_last       # Set certain tokens as partial.
-      tokens
-    end
+    class Query < Base
+
+      attr_reader :qualifiers
+
+      def self.default= new_default
+        @default = new_default
+      end
+      def self.default
+        @default ||= new
+      end
+
+      attr_reader :maximum_tokens
+
+      def initialize options = {}
+        super options
+        @maximum_tokens = options[:maximum_tokens] || 5
+      end
+
+      # Let each token process itself.
+      # Reject, limit, and partialize tokens.
+      #
+      # In querying we work with real tokens (in indexing it's just symbols).
+      #
+      def process tokens
+        tokens.reject                # Reject any tokens that don't meet criteria.
+        tokens.cap maximum_tokens    # Cut off superfluous tokens.
+        tokens.partialize_last       # Set certain tokens as partial.
+        tokens
+      end
+
+      # Converts words into real tokens.
+      #
+      def tokens_for words
+        Picky::Query::Tokens.processed words, downcase?
+      end
+      # Returns a tokens object.
+      #
+      def empty_tokens
+        Picky::Query::Tokens.new
+      end
 
-    # Converts words into real tokens.
-    #
-    def tokens_for words
-      ::Query::Tokens.processed words, downcase?
-    end
-    # Returns a tokens object.
-    #
-    def empty_tokens
-      ::Query::Tokens.new
     end
 
   end

data/lib/picky.rb

@@ -1,16 +1,24 @@
-# Require the constants.
-#
-require File.expand_path '../constants', __FILE__
+module Picky
 
-# Library bundling.
-#
-require File.expand_path '../bundling', __FILE__
+  # Require the constants.
+  #
+  require ::File.expand_path '../picky/constants', __FILE__
 
-# Loader which handles framework and app loading.
-#
-require File.expand_path '../picky/loader', __FILE__
+  # Library bundling.
+  #
+  require ::File.expand_path '../picky/bundling', __FILE__
 
-# Load the framework
-#
-Loader.load_framework
-puts "Loaded picky with environment '#{PICKY_ENVIRONMENT}' in #{PICKY_ROOT} on Ruby #{RUBY_VERSION}."
+  # Loader which handles framework and app loading.
+  #
+  require ::File.expand_path '../picky/loader', __FILE__
+
+  # Load the framework
+  #
+  Loader.load_framework
+  puts "Loaded picky with environment '#{PICKY_ENVIRONMENT}' in #{PICKY_ROOT} on Ruby #{RUBY_VERSION}."
+
+  # Check if delegators need to be installed.
+  #
+  require ::File.expand_path '../picky/sinatra', __FILE__
+
+end

data/lib/tasks/application.rake

@@ -3,5 +3,5 @@
 # Note: This is used by tasks to load the application (and the framework) as a dependency.
 #
 task :application => :framework do
-  Loader.load_application
+  Picky::Loader.load_application
 end

data/lib/tasks/index.rake

@@ -4,7 +4,7 @@ desc "Generate the index (index, category optional)."
 task :index, [:index, :category] => :application do |_, options|
   index, category = options.index, options.category
 
-  specific = Indexes
+  specific = Picky::Indexes
   specific = specific[index]    if index
   specific = specific[category] if category
   specific.index
@@ -16,11 +16,11 @@ namespace :index do
   #
   # desc "Takes a snapshot, indexes, and caches in random order."
   task :randomly => :application do
-    Indexes.index true
+    Picky::Indexes.index true
   end
   # desc "Takes a snapshot, indexes, and caches in order given."
   task :ordered => :application do
-    Indexes.index false
+    Picky::Indexes.index false
   end
 
 end

data/lib/tasks/routes.rake

@@ -2,7 +2,7 @@
 #
 desc "Shows the available URL paths."
 task :routes => :application do
-  Application.apps.each do |app|
+  Picky::Application.apps.each do |app|
     puts app.to_routes
   end
 end

data/lib/tasks/server.rake

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

data/spec/lib/adapters/rack/base_spec.rb

@@ -2,7 +2,7 @@
 #
 require 'spec_helper'
 
-describe Adapters::Rack::Base do
+describe Picky::Adapters::Rack::Base do
   
   before(:each) do
     @adapter = described_class.new

data/spec/lib/adapters/rack/live_parameters_spec.rb

@@ -2,7 +2,7 @@
 #
 require 'spec_helper'
 
-describe Adapters::Rack::LiveParameters do
+describe Picky::Adapters::Rack::LiveParameters do
   
   let(:live_parameters) { stub :live_parameters }
   let(:adapter) { described_class.new live_parameters }

data/spec/lib/adapters/rack/query_spec.rb

@@ -2,7 +2,7 @@
 #
 require 'spec_helper'
 
-describe Adapters::Rack::Query do
+describe Picky::Adapters::Rack::Search do
   
   before(:each) do
     @query   = stub :query

data/spec/lib/application_spec.rb

@@ -2,28 +2,32 @@
 #
 require 'spec_helper'
 
-describe Application do
+describe Picky::Application do
   
   describe "integration" do
     it "should run ok" do
       lambda {
-        class MinimalTestApplication < Application
-          books = Index::Memory.new :books, source: Sources::DB.new('SELECT id, title FROM books', :file => 'app/db.yml')
+        class MinimalTestApplication < described_class
+          books = Picky::Indexes::Memory.new :books,
+                                             source: Picky::Sources::DB.new(
+                                               'SELECT id, title FROM books',
+                                               :file => 'app/db.yml'
+                                             )
           books.define_category :title
           
           rack_adapter.stub! :exclaim # Stopping it from exclaiming.
           
-          route %r{^/books} => Search.new(books)
+          route %r{^/books} => Picky::Search.new(books)
         end
-        Tokenizers::Index.default.tokenize 'some text'
-        Tokenizers::Query.default.tokenize 'some text'
+        Picky::Tokenizers::Index.default.tokenize 'some text'
+        Picky::Tokenizers::Query.default.tokenize 'some text'
       }.should_not raise_error
     end
     it "should run ok" do
       lambda {
         # Here we just test if the API can be called ok.
         #
-        class TestApplication < Application
+        class TestApplication < described_class
           indexing  removes_characters:                 /[^a-zA-Z0-9\s\/\-\"\&\.]/,
                     stopwords:                          /\b(and|the|of|it|in|for)\b/,
                     splits_text_on:                     /[\s\/\-\"\&\.]/,
@@ -36,31 +40,34 @@ describe Application do
                     splits_text_on:     /[\s\/\-\,\&]+/,
                     normalizes_words:   [[/Deoxyribonucleic Acid/i, 'DNA']],
                     
-                    substitutes_characters_with: CharacterSubstituters::WestEuropean.new,
+                    substitutes_characters_with: Picky::CharacterSubstituters::WestEuropean.new,
                     maximum_tokens: 5
           
-          books_index = Index::Memory.new :books,
-                                          source: Sources::DB.new('SELECT id, title, author, isbn13 as isbn FROM books', :file => 'app/db.yml')
+          books_index = Picky::Indexes::Memory.new :books,
+                                                   source: Picky::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.
+                                      similarity: Picky::Similarity::DoubleMetaphone.new(3) # Up to three similar title word indexed.
           books_index.define_category :author,
-                                      similarity: Similarity::Soundex.new(2)
+                                      similarity: Picky::Similarity::Soundex.new(2)
           books_index.define_category :isbn,
-                                      partial: Partial::None.new # Partially searching on an ISBN makes not much sense.
+                                      partial: Picky::Partial::None.new # Partially searching on an ISBN makes not much sense.
           
-          geo_index = Index::Memory.new :geo do
-            source          Sources::CSV.new(:location, :north, :east, file: 'data/ch.csv', col_sep: ',')
+          geo_index = Picky::Indexes::Memory.new :geo do
+            source          Picky::Sources::CSV.new(:location, :north, :east, file: 'data/ch.csv', col_sep: ',')
             indexing        removes_characters: /[^a-z]/
             category        :location,
-                            similarity: Similarity::Metaphone.new(4)
+                            similarity: Picky::Similarity::Metaphone.new(4)
             ranged_category :north1, 1, precision: 3, from: :north
             ranged_category :east1,  1, precision: 3, from: :east
           end
           
           rack_adapter.stub! :exclaim # Stopping it from exclaiming.
           
-          route %r{^/books} => Search.new(books_index)
-          route %r{^/buks}  => Search.new(books_index) do
+          route %r{^/books} => Picky::Search.new(books_index)
+          route %r{^/buks}  => Picky::Search.new(books_index) do
             searching removes_characters: /[buks]/
           end
         end
@@ -70,57 +77,57 @@ describe Application do
   
   describe 'finalize' do
     before(:each) do
-      Application.stub! :check
+      described_class.stub! :check
     end
     it 'checks if all is ok' do
-      Application.should_receive(:check).once.with
+      described_class.should_receive(:check).once.with
       
-      Application.finalize
+      described_class.finalize
     end
     it 'tells the rack adapter to finalize' do
-      Application.rack_adapter.should_receive(:finalize).once.with
+      described_class.rack_adapter.should_receive(:finalize).once.with
       
-      Application.finalize
+      described_class.finalize
     end
   end
   
   describe 'check' do
     it 'does something' do
-      Application.should_receive(:warn).once.with "\nWARNING: No routes defined for application configuration in Class.\n\n"
+      described_class.should_receive(:warn).once.with "\nWARNING: No routes defined for application configuration in Class.\n\n"
       
-      Application.check
+      described_class.check
     end
   end
   
   describe 'delegation' do
     it "should delegate route" do
-      Application.rack_adapter.should_receive(:route).once.with :path => :query
+      described_class.rack_adapter.should_receive(:route).once.with :path => :query
       
-      Application.route :path => :query
+      described_class.route :path => :query
     end
   end
   
   describe 'rack_adapter' do
     it 'should be there' do
-      lambda { Application.rack_adapter }.should_not raise_error
+      lambda { described_class.rack_adapter }.should_not raise_error
     end
     it "should return a new FrontendAdapters::Rack instance" do
-      Application.rack_adapter.should be_kind_of(FrontendAdapters::Rack)
+      described_class.rack_adapter.should be_kind_of(Picky::FrontendAdapters::Rack)
     end
     it "should cache the instance" do
-      Application.rack_adapter.should == Application.rack_adapter
+      described_class.rack_adapter.should == described_class.rack_adapter
     end
   end
   
   describe 'call' do
     before(:each) do
       @routes = stub :routes
-      Application.stub! :rack_adapter => @routes
+      described_class.stub! :rack_adapter => @routes
     end
     it 'should delegate' do
       @routes.should_receive(:call).once.with :env
       
-      Application.call :env
+      described_class.call :env
     end
   end
   

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

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Backend::File::Basic do
+describe Picky::Backend::File::Basic do
   
   let(:file) { described_class.new 'some/cache/path/to/file' }
   
@@ -18,7 +18,7 @@ describe Backend::File::Basic do
   
   describe 'to_s' do
     it 'returns the cache path with the default file extension' do
-      file.to_s.should == 'Backend::File::Basic(some/cache/path/to/file.index)'
+      file.to_s.should == 'Picky::Backend::File::Basic(some/cache/path/to/file.index)'
     end
   end
   

data/spec/lib/backend/file/json_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Backend::File::JSON do
+describe Picky::Backend::File::JSON do
   
   let(:file) { described_class.new 'some/cache/path/to/file' }
   
@@ -24,7 +24,7 @@ describe Backend::File::JSON do
   
   describe 'to_s' do
     it 'returns the cache path with the default file extension' do
-      file.to_s.should == 'Backend::File::JSON(some/cache/path/to/file.json)'
+      file.to_s.should == 'Picky::Backend::File::JSON(some/cache/path/to/file.json)'
     end
   end
   

data/spec/lib/backend/file/marshal_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Backend::File::Marshal do
+describe Picky::Backend::File::Marshal do
   
   let(:file) { described_class.new 'some/cache/path/to/file' }
   
@@ -24,7 +24,7 @@ describe Backend::File::Marshal do
   
   describe 'to_s' do
     it 'returns the cache path with the default file extension' do
-      file.to_s.should == 'Backend::File::Marshal(some/cache/path/to/file.dump)'
+      file.to_s.should == 'Picky::Backend::File::Marshal(some/cache/path/to/file.dump)'
     end
   end
   

data/spec/lib/backend/file/text_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Backend::File::Text do
+describe Picky::Backend::File::Text do
   
   before(:each) do
     @file = described_class.new "some_cache_path"

data/spec/lib/backend/files_spec.rb

@@ -1,14 +1,13 @@
 require 'spec_helper'
 
-describe Backend::Files do
+describe Picky::Backend::Files do
 
   before(:each) do
-    index         = Index::Memory.new :some_index, source: []
-    category      = Category.new :some_category, index
+    index         = Picky::Indexes::Memory.new :some_index, source: []
+    category      = Picky::Category.new :some_category, index
+    bundle        = Picky::Indexing::Bundle::Base.new :some_bundle, category, nil, nil, nil
     
-    @files         = described_class.new :some_name, category
-    
-    @prepared      = @files.prepared
+    @files         = described_class.new bundle
     
     @index         = @files.inverted
     @weights       = @files.weights
@@ -16,14 +15,6 @@ describe Backend::Files do
     @configuration = @files.configuration
   end
   
-  describe "retrieve" do
-    it "delegates to the prepared" do
-      @prepared.should_receive(:retrieve).once.with
-      
-      @files.retrieve
-    end
-  end
-  
   describe "dump indexes" do
     before(:each) do
       @files.stub! :timed_exclaim
@@ -66,7 +57,7 @@ describe Backend::Files do
       it "uses the right file" do
         Yajl::Parser.stub! :parse
         
-        File.should_receive(:open).once.with 'spec/test_directory/index/test/some_index/some_category_some_name_inverted.json', 'r'
+        File.should_receive(:open).once.with 'spec/test_directory/index/test/some_index/some_category_some_bundle_inverted.json', 'r'
         
         @files.load_inverted
       end
@@ -75,7 +66,7 @@ describe Backend::Files do
       it "uses the right file" do
         Yajl::Parser.stub! :parse
         
-        File.should_receive(:open).once.with 'spec/test_directory/index/test/some_index/some_category_some_name_weights.json', 'r'
+        File.should_receive(:open).once.with 'spec/test_directory/index/test/some_index/some_category_some_bundle_weights.json', 'r'
         
         @files.load_weights
       end
@@ -84,7 +75,7 @@ describe Backend::Files do
       it "uses the right file" do
         Marshal.stub! :load
         
-        File.should_receive(:open).once.with 'spec/test_directory/index/test/some_index/some_category_some_name_similarity.dump', 'r:binary'
+        File.should_receive(:open).once.with 'spec/test_directory/index/test/some_index/some_category_some_bundle_similarity.dump', 'r:binary'
         
         @files.load_similarity
       end
@@ -93,7 +84,7 @@ describe Backend::Files do
       it "uses the right file" do
         Yajl::Parser.stub! :parse
         
-        File.should_receive(:open).once.with 'spec/test_directory/index/test/some_index/some_category_some_name_configuration.json', 'r'
+        File.should_receive(:open).once.with 'spec/test_directory/index/test/some_index/some_category_some_bundle_configuration.json', 'r'
         
         @files.load_configuration
       end
@@ -181,18 +172,17 @@ describe Backend::Files do
   
   describe 'initialization' do
     it 'should initialize the name correctly' do
-      @files.bundle_name.should == :some_name
+      @files.bundle.name.should == :some_bundle
     end
   end
   
   describe 'to_s' do
     it 'returns the right value' do
-      category = stub :category,
-                      :identifier => "category_identifier",
-                      :prepared_index_path => "prepared/index/path",
-                      :index_path => 'index/path'
+      bundle   = stub :bundle,
+                      :index_path => 'index/path',
+                      :prepared_index_path => 'prepared/index/path'
       
-      described_class.new("some_bundle", category).to_s.should == "Backend::Files(Backend::File::Text(prepared/index/path.txt), Backend::File::JSON(index/path.json), Backend::File::JSON(index/path.json), Backend::File::Marshal(index/path.dump), Backend::File::JSON(index/path.json))"
+      described_class.new(bundle).to_s.should == "Picky::Backend::Files(Picky::Backend::File::JSON(index/path.json), Picky::Backend::File::JSON(index/path.json), Picky::Backend::File::Marshal(index/path.dump), Picky::Backend::File::JSON(index/path.json))"
     end
   end
 

data/spec/lib/backend/redis/basic_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Backend::Redis::Basic do
+describe Picky::Backend::Redis::Basic do
   
   let(:redis) { described_class.new "some_namespace" }
 
@@ -66,7 +66,7 @@ describe Backend::Redis::Basic do
   
   describe 'to_s' do
     it 'returns the cache path with the default file extension' do
-      redis.to_s.should == 'Backend::Redis::Basic(some_namespace:*)'
+      redis.to_s.should == 'Picky::Backend::Redis::Basic(some_namespace:*)'
     end
   end
   

data/spec/lib/backend/redis/list_hash_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Backend::Redis::ListHash do
+describe Picky::Backend::Redis::ListHash do
   
   let(:index) { described_class.new :some_namespace }
   
@@ -8,7 +8,7 @@ describe Backend::Redis::ListHash do
     it 'raises an error' do
       expect {
         index.member :some_sym
-      }.to raise_error("Can't retrieve single value :some_sym from a Redis ListHash. Use Index::Redis::StringHash.")
+      }.to raise_error("Can't retrieve single value :some_sym from a Redis ListHash. Use Indexes::Redis::StringHash.")
     end
   end
   
@@ -33,7 +33,7 @@ describe Backend::Redis::ListHash do
   
   describe 'to_s' do
     it 'returns the cache path with the default file extension' do
-      index.to_s.should == 'Backend::Redis::ListHash(some_namespace:*)'
+      index.to_s.should == 'Picky::Backend::Redis::ListHash(some_namespace:*)'
     end
   end