picky 0.12.3 → 1.0.0

data/lib/picky/sources/db.rb

@@ -1,11 +1,32 @@
 module Sources
   
-  # Describes a database source. Just give it a select statement
+  # Describes a database source. Needs a SELECT statement
   # (with id in it), and a file option or the options from an AR config file.
   #
+  # The select statement can be as complicated as you want,
+  # as long as it has an id in it and as long as it can be
+  # used in a CREATE TABLE AS statement.
+  # (working on that last one)
+  #
+  # Examples:
+  #  Sources::DB.new('SELECT id, title, author, year FROM books') # Uses the config from app/db.yml by default.
+  #  Sources::DB.new('SELECT id, title, author, year FROM books', file: 'app/some_db.yml')
+  #  Sources::DB.new('SELECT b.id, b.title, b.author, b.publishing_year as year FROM books b INNER JOIN ON ...', file: 'app/some_db.yml')
+  #  Sources::DB.new('SELECT id, title, author, year FROM books', adapter: 'mysql', host:'localhost', ...)
+  #
   class DB < Base
     
-    attr_reader :select_statement, :database, :connection_options
+    # The select statement that was passed in.
+    #
+    attr_reader :select_statement
+    
+    # The database adapter.
+    #
+    attr_reader :database
+    
+    # The database connection options that were either passed in or loaded from the given file.
+    #
+    attr_reader :connection_options
     
     def initialize select_statement, options = { file: 'app/db.yml' }
       @select_statement = select_statement
@@ -13,17 +34,10 @@ module Sources
       @options          = options
     end
     
-    # Get a configured Database backend.
-    #
-    # Options:
-    #  Either
-    #  * file => 'some/filename.yml' # With an active record configuration.
-    #  Or
-    #  * The configuration as a hash.
-    #
-    # TODO Do not use ActiveRecord directly.
-    #
-    def create_database_adapter
+    # Creates a database adapter for use with this source.
+    def create_database_adapter # :nodoc:
+      # TODO Do not use ActiveRecord directly.
+      #
       adapter_class = Class.new ActiveRecord::Base
       adapter_class.abstract_class = true
       adapter_class
@@ -37,7 +51,7 @@ module Sources
     #  Or
     #  * The configuration as a hash.
     #
-    def configure options
+    def configure options # :nodoc:
       @connection_options = if filename = options[:file]
         File.open(File.join(PICKY_ROOT, filename)) { |file| YAML::load(file) }
       else
@@ -48,13 +62,17 @@ module Sources
     
     # Connect the backend.
     #
+    # Will raise unless connection options have been given.
+    #
     def connect_backend
       configure @options
       raise "Database backend not configured" unless connection_options
       database.establish_connection connection_options
     end
     
-    # Take the snapshot.
+    # Take a snapshot of the data.
+    #
+    # Uses CREATE TABLE AS with the given SELECT statement to create a snapshot of the data.
     #
     def take_snapshot type
       connect_backend
@@ -75,23 +93,19 @@ module Sources
     
     # Counts all the entries that are used for the index.
     #
-    def count type
+    def count type # :nodoc:
       connect_backend
       
       database.connection.select_value("SELECT COUNT(id) FROM #{snapshot_table_name(type)}").to_i
     end
     
-    # Ok here?
     #
-    def snapshot_table_name type
+    #
+    def snapshot_table_name type # :nodoc:
       "#{type.name}_type_index"
     end
     
-    # Harvests the data to index, chunked.
-    #
-    # Subclasses should override harvest_statement to define how their data is found.
-    # Example:
-    #   "SELECT indexed_id, value FROM bla_table st WHERE kind = 'bla'"
+    # Harvests the data to index in chunks.
     #
     def harvest type, category
       connect_backend
@@ -105,9 +119,9 @@ module Sources
       end
     end
     
-    # Gets database from the backend.
+    # Gets the data from the backend.
     #
-    def get_data type, category, offset
+    def get_data type, category, offset # :nodoc:
       database.connection.execute harvest_statement_with_offset(type, category, offset)
     end
     
@@ -115,7 +129,7 @@ module Sources
     #
     # TODO Use the adapter for this.
     #
-    def harvest_statement_with_offset type, category, offset
+    def harvest_statement_with_offset type, category, offset # :nodoc:
       statement = harvest_statement type, category
       
       statement += statement.include?('WHERE') ? ' AND' : ' WHERE'
@@ -123,15 +137,17 @@ module Sources
       "#{statement} st.id > #{offset} LIMIT #{chunksize}"
     end
     
-    # Base harvest statement for dbs.
+    # The harvest statement used to pull data from the snapshot table.
     #
-    def harvest_statement type, category
+    def harvest_statement type, category # :nodoc:
       "SELECT indexed_id, #{category.from} FROM #{snapshot_table_name(type)} st"
     end
     
-    # Override in subclasses.
+    # The amount of records that are loaded each chunk.
     #
-    def chunksize
+    def chunksize # :nodoc:
+      # TODO Make parametrizable.
+      #
       25_000
     end
     

data/lib/picky/sources/delicious.rb

@@ -1,5 +1,15 @@
 module Sources
   
+  # Describes a Delicious (http://deli.cio.us) source.
+  #
+  # This source has a fixed set of categories:
+  # * title
+  # * tags
+  # * url
+  #
+  # Examples:
+  #  Sources::CSV.new('usrnam', 'paswrd')
+  #
   class Delicious < Base
     
     def initialize username, password
@@ -7,7 +17,7 @@ module Sources
       @username = username
       @password = password
     end
-    def check_gem
+    def check_gem # :nodoc:
       require 'www/delicious'
     rescue LoadError
       puts "Delicious gem missing!\nTo use the delicious source, you need to:\n  1. Add the following line to Gemfile:\n     gem 'www-delicious'\n  2. Then, run:\n     bundle update\n"
@@ -28,7 +38,7 @@ module Sources
     
     #
     #
-    def get_data
+    def get_data # :nodoc:
       @generated_id ||= 0
       @posts ||= WWW::Delicious.new(@username, @password).posts_recent(count: 100)
       @posts.each do |post|

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

@@ -1,6 +1,8 @@
 module Sources
   
-  module Wrappers
+  # TODO Document.
+  #
+  module Wrappers # :nodoc:all
     
     class Base
       

data/lib/picky/tokenizers/base.rb

@@ -1,4 +1,4 @@
-module Tokenizers
+module Tokenizers # :nodoc:all
   
   # Defines tokenizing processes used both in indexing and querying.
   #

data/project_prototype/Gemfile

@@ -2,7 +2,7 @@ source :gemcutter
 
 # Gems required by Picky.
 #
-gem 'picky',            '~> 0.12.0'
+gem 'picky',            '~> 1.0.0'
 gem 'rake'
 gem 'bundler'
 gem 'rack',             '~> 1.2.1'

data/project_prototype/app/README

@@ -2,5 +2,4 @@ All your application definitions go here.
 
 /app needs a few files defined by picky:
   * application.rb - how to handle indexing, queries, routing.
-  * application.ru - rackup.
   * logging.rb

data/spec/lib/calculations/location_spec.rb

@@ -2,32 +2,44 @@ require 'spec_helper'
 
 describe Calculations::Location do
   
-  context 'without margin' do
+  context 'with precision 1' do
     before(:each) do
-      @calculation = Calculations::Location.new 3, 1
-      @calculation.minimum = 5
+      @calculation = Calculations::Location.new 1.5, 1
+      @calculation.minimum = 42.7
     end
-    describe 'reposition' do
-      it 'calculates correctly' do
-        @calculation.recalculate(13).should == 5
+    describe 'recalculate' do
+      it 'sets the minimum close value to the minimum minus user grid' do
+        @calculation.recalculate(41.2).should == 1
       end
-      it 'calculates correctly' do
-        @calculation.recalculate(5).should == 1
+      it 'sets the minimum value to 1 plus precision' do
+        @calculation.recalculate(42.7).should == 2
+      end
+      it 'sets the minimum value plus 2/3 of the grid size to 2 plus 1 grid length' do
+        @calculation.recalculate(43.7).should == 3
+      end
+      it 'sets the minimum value plus 20/3 of the grid size to 2 plus 10 grid length' do
+        @calculation.recalculate(52.7).should == 12
       end
     end
   end
   
-  context 'without margin' do
+  context 'with precision 3' do
     before(:each) do
-      @calculation = Calculations::Location.new 3, 3
-      @calculation.minimum = 5
+      @calculation = Calculations::Location.new 1.5, 3
+      @calculation.minimum = 42.7
     end
-    describe 'reposition' do
-      it 'calculates correctly' do
-        @calculation.recalculate(13).should == 12
+    describe 'recalculate' do
+      it 'sets the minimum close value to the minimum minus user grid' do
+        @calculation.recalculate(41.2).should == 1
+      end
+      it 'sets the minimum value to 1 plus precision' do
+        @calculation.recalculate(42.7).should == 4
+      end
+      it 'sets the minimum value plus 2/3 of the grid size plus 1 plus precision plus 1 grid length' do
+        @calculation.recalculate(43.7).should == 6
       end
-      it 'calculates correctly' do
-        @calculation.recalculate(5).should == 3
+      it 'sets the minimum value plus 20/3 of the grid size to 2 plus 10 grid length' do
+        @calculation.recalculate(52.7).should == 27
       end
     end
   end

data/spec/lib/index_api_spec.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe IndexAPI do
+  
+  context 'initializer' do
+    it 'works' do
+      lambda { IndexAPI.new :some_index_name, :some_source }.should_not raise_error
+    end
+    it 'registers with the indexes' do
+      @api = IndexAPI.allocate
+      
+      Indexes.should_receive(:register).once.with @api
+      
+      @api.send :initialize, :some_index_name, :some_source
+    end
+  end
+  
+  context 'unit' do
+    before(:each) do
+      @api = IndexAPI.new :some_index_name, :some_source
+    end
+
+    describe 'define_category' do
+      context 'with block' do
+        it 'returns itself' do
+          @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
+        end
+        it 'yields both the indexing category and the indexed category' do
+          @api.define_category(:some_name) do |indexing, indexed|
+            indexing.should be_kind_of(Indexing::Category)
+            indexed.should be_kind_of(Indexed::Category)
+          end
+        end
+        it 'yields the indexing category which has the given name' do
+          @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|
+            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
+        end
+        it 'takes a string' do
+          lambda { @api.define_category('some_name').should == @api }.should_not raise_error
+        end
+        it 'returns itself' do
+          @api.define_category(:some_name).should == @api
+        end
+      end
+    end
+  end
+  
+end

data/spec/lib/indexed/index_spec.rb

@@ -7,8 +7,8 @@ describe Indexed::Index do
       @categories = stub :categories
       
       @index = Indexed::Index.new :some_name
-      @index.add_category :some_category_name1
-      @index.add_category :some_category_name2
+      @index.define_category :some_category_name1
+      @index.define_category :some_category_name2
       
       @index.stub! :categories => @categories
     end

data/spec/lib/indexed/wrappers/exact_first_spec.rb

@@ -16,7 +16,7 @@ describe Indexed::Wrappers::ExactFirst do
       #
       # it "wraps each category" do
       #   type = Index::Type.new :type_name
-      #   type.add_category :some_category
+      #   type.define_category :some_category
       #   
       #   Index::Wrappers::ExactFirst.wrap type
       #   
@@ -24,7 +24,7 @@ describe Indexed::Wrappers::ExactFirst do
       # end
       it "returns the type" do
         type = Indexed::Index.new :type_name
-        type.add_category :some_category
+        type.define_category :some_category
         
         Indexed::Wrappers::ExactFirst.wrap(type).should == type
       end

data/spec/lib/indexing/index_spec.rb

@@ -9,8 +9,8 @@ describe Indexing::Index do
       @categories = stub :categories
       
       @index = Indexing::Index.new :some_name, @source
-      @index.add_category :some_category_name1
-      @index.add_category :some_category_name2
+      @index.define_category :some_category_name1
+      @index.define_category :some_category_name2
       
       @index.stub! :categories => @categories
     end

data/spec/lib/rack/harakiri_spec.rb

@@ -7,21 +7,33 @@ describe Rack::Harakiri do
   end
   context "defaults" do
     before(:each) do
-      @harakiri = Rack::Harakiri.new @app
+      @ronin = Rack::Harakiri.new @app
     end
-    it "should quit after an amount of requests" do
-      @harakiri.quit_after_requests.should == 50
+    it "should quit after a default amount of requests" do
+      @ronin.instance_variable_get(:@quit_after_requests).should == 50
+    end
+    describe 'harakiri?' do
+      it "should be true after 50 harakiri calls" do
+        50.times { @ronin.harakiri }
+        
+        @ronin.harakiri?.should == true
+      end
+      it "should not be true after just 49 harakiri calls" do
+        49.times { @ronin.harakiri }
+        
+        @ronin.harakiri?.should == false
+      end
     end
     describe "harakiri" do
       it "should kill the process after 50 harakiri calls" do
         Process.should_receive(:kill).once
         
-        50.times { @harakiri.harakiri }
+        50.times { @ronin.harakiri }
       end
       it "should not kill the process after 49 harakiri calls" do
         Process.should_receive(:kill).never
         
-        49.times { @harakiri.harakiri }
+        49.times { @ronin.harakiri }
       end
     end
     describe "call" do
@@ -30,27 +42,27 @@ describe Rack::Harakiri do
         @app.stub! :harakiri
       end
       it "calls harakiri" do
-        @harakiri.should_receive(:harakiri).once.with
+        @ronin.should_receive(:harakiri).once.with
         
-        @harakiri.call :env
+        @ronin.call :env
       end
       it "calls the app" do
         @app.should_receive(:call).once.with :env
         
-        @harakiri.call :env
+        @ronin.call :env
       end
     end
   end
   context "with harakiri set" do
     before(:each) do
       Rack::Harakiri.after = 100
-      @harakiri = Rack::Harakiri.new @app
+      @ronin = Rack::Harakiri.new @app
     end
     after(:each) do
       Rack::Harakiri.after = nil
     end
     it "should quit after an amount of requests" do
-      @harakiri.quit_after_requests.should == 100
+      @ronin.instance_variable_get(:@quit_after_requests).should == 100
     end
   end
   

metadata

@@ -3,10 +3,10 @@ name: picky
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 12
-  - 3
-  version: 0.12.3
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Florian Hanke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-28 00:00:00 +01:00
+date: 2010-12-09 00:00:00 +01:00
 default_executable: picky
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,6 +103,7 @@ files:
 - lib/picky/indexing/indexes.rb
 - lib/picky/loader.rb
 - lib/picky/loggers/search.rb
+- lib/picky/performant.rb
 - lib/picky/query/allocation.rb
 - lib/picky/query/allocations.rb
 - lib/picky/query/base.rb
@@ -189,6 +190,7 @@ files:
 - spec/lib/index/file/marshal_spec.rb
 - spec/lib/index/file/text_spec.rb
 - spec/lib/index/files_spec.rb
+- spec/lib/index_api_spec.rb
 - spec/lib/indexed/bundle_spec.rb
 - spec/lib/indexed/categories_spec.rb
 - spec/lib/indexed/category_spec.rb
@@ -294,6 +296,7 @@ test_files:
 - spec/lib/index/file/marshal_spec.rb
 - spec/lib/index/file/text_spec.rb
 - spec/lib/index/files_spec.rb
+- spec/lib/index_api_spec.rb
 - spec/lib/indexed/bundle_spec.rb
 - spec/lib/indexed/categories_spec.rb
 - spec/lib/indexed/category_spec.rb