picky 0.11.1 → 0.11.2

data/lib/picky/bundle.rb

@@ -6,7 +6,7 @@ class Bundle
   delegate :[], :[]=, :clear, :to => :index
   
   def initialize name, category, type, similarity_strategy
-    @identifier = "#{name}: #{type.name} #{category.name}"
+    @identifier = "#{type.name}: #{name} #{category.name}"
     
     @index      = {}
     @weights    = {}

data/lib/picky/cacher/partial/none.rb

@@ -11,6 +11,12 @@ module Cacher
       def generate_from index
         {}
       end
+      
+      # Returns if this strategy's generated file is saved.
+      #
+      def saved?
+        false
+      end
 
     end
 

data/lib/picky/cacher/partial/strategy.rb

@@ -2,6 +2,8 @@ module Cacher
   module Partial
     # Superclass for partial strategies.
     #
-    class Strategy; end
+    class Strategy < Cacher::Strategy
+      
+    end
   end
 end

data/lib/picky/cacher/similarity/none.rb

@@ -17,6 +17,12 @@ module Cacher
       def generate_from index
         {}
       end
+      
+      # Returns if this strategy's generated file is saved.
+      #
+      def saved?
+        false
+      end
 
     end
 

data/lib/picky/cacher/similarity/strategy.rb

@@ -2,6 +2,8 @@ module Cacher
   module Similarity
     # Base class for all similarity strategies.
     #
-    class Strategy; end
+    class Strategy < Cacher::Strategy
+      
+    end
   end
 end

data/lib/picky/cacher/strategy.rb

@@ -0,0 +1,12 @@
+module Cacher
+  class Strategy
+    
+    # By default, all caches are saved in a
+    # storage (like a file).
+    #
+    def saved?
+      true
+    end
+    
+  end
+end

data/lib/picky/cacher/weights/strategy.rb

@@ -2,6 +2,8 @@ module Cacher
   module Weights
     # Superclass for weighing strategies.
     #
-    class Strategy; end
+    class Strategy < Cacher::Strategy
+      
+    end
   end
 end

data/lib/picky/extensions/object.rb

@@ -1,10 +1,14 @@
-module Kernel
-  
+class Object
   
+  # Puts a text in the form:
+  #   12:34:56: text here
+  #
   def timed_exclaim text
     exclaim "#{Time.now.strftime("%H:%M:%S")}: #{text}"
   end
   
+  # Just puts the given text.
+  #
   def exclaim text
     puts text
   end

data/lib/picky/index/file/basic.rb

@@ -49,7 +49,7 @@ module Index
       # Is the cache small?
       #
       def cache_small?
-        size_of(cache_path) < 16
+        size_of(cache_path) < 8
       end
       # Is the cache ok? I.e. larger than four Bytes in size.
       #

data/lib/picky/index/file/json.rb

@@ -14,7 +14,7 @@ module Index
         hash.dump_json cache_path
       end
       def retrieve
-        raise "Can't retrieve from marshalled file. Use text file."
+        raise "Can't retrieve from JSON file. Use text file."
       end
       
     end

data/lib/picky/indexing/bundle.rb

@@ -131,16 +131,39 @@ module Indexing
     # Alerts the user if an index is missing.
     #
     def raise_unless_cache_exists
-      warn_cache_small :index      if files.index_cache_small?
+      raise_unless_index_exists
+      raise_unless_similarity_exists
+    end
+    def raise_unless_index_exists
+      if partial_strategy.saved?
+        warn_if_index_small
+        raise_unless_index_ok
+      end
+    end
+    def raise_unless_similarity_exists
+      if similarity_strategy.saved?
+        warn_if_similarity_small
+        raise_unless_similarity_ok
+      end
+    end
+    def warn_if_similarity_small
       warn_cache_small :similarity if files.similarity_cache_small?
-      warn_cache_small :weights    if files.weights_cache_small?
-
-      raise_cache_missing :index      unless files.index_cache_ok?
+    end
+    def raise_unless_similarity_ok
       raise_cache_missing :similarity unless files.similarity_cache_ok?
-      raise_cache_missing :weights    unless files.weights_cache_ok?
+    end
+    # TODO Spec on down.
+    #
+    def warn_if_index_small
+      warn_cache_small :index   if files.index_cache_small?
+      warn_cache_small :weights if files.weights_cache_small?
+    end
+    def raise_unless_index_ok
+      raise_cache_missing :index   unless files.index_cache_ok?
+      raise_cache_missing :weights unless files.weights_cache_ok?
     end
     def warn_cache_small what
-      puts "#{what} cache for #{identifier} smaller than 16 bytes."
+      puts "Warning: #{what} cache for #{identifier} smaller than 16 bytes."
     end
     # Raises an appropriate error message.
     #

data/lib/picky/loader.rb

@@ -123,7 +123,11 @@ module Loader
     load_relative 'indexers/default'
     #
     # load_relative 'indexers/solr'
-
+    
+    # Cacher.
+    #
+    load_relative 'cacher/strategy'
+    
     # Partial index generation strategies.
     #
     load_relative 'cacher/partial/strategy'

data/lib/picky/sources/base.rb

@@ -1,26 +1,47 @@
 module Sources
   
   # Sources are where your data comes from.
-  # Harvest is the most important method as it is used always to get data.
   #
+  # Basically, a source has 1-3 methods.
+  # * harvest: Used by the indexer to gather data.
+  #            Yields an indexed_id (string or integer) and a string value.
+  #
+  # * connect_backend: Optional, called once for each type/category pair.
+  # * take_snapshot: Optional, called once for each type.
   class Base
     
     # Note: Methods listed for illustrative purposes.
     #
     
-    # Yield the data (id, text for id) for the given type and field.
+    # Called by the indexer when gathering data.
+    #
+    # Yields the data (id, text for id) for the given type and field.
+    #
+    # When implementing or overriding your own,
+    # be sure to <tt>yield</tt> (or <tt>block.call</tt>) an id (as string or integer)
+    # and a corresponding text for the given type symbol and
+    # category symbol.
     #
-    def harvest type, field
+    def harvest type, category
       # yields nothing
     end
     
-    # Connects to the backend.
+    # Connect to the backend.
+    #
+    # Note: Called once per index/category combination
+    #       before harvesting.
+    #
+    # For example, the db backend connects the db adapter.
     #
     def connect_backend
       
     end
     
-    # Take a snapshot of your data, if it is fast changing.
+    # Used to take a snapshot of your data if it is fast changing.
+    # e.g. in a database, a table based on the source's select
+    # statement is created.
+    #
+    # Note: Called before harvesting.
     #
     def take_snapshot type
       

data/lib/picky/sources/db.rb

@@ -93,8 +93,6 @@ module Sources
     # Example:
     #   "SELECT indexed_id, value FROM bla_table st WHERE kind = 'bla'"
     #
-    # TODO Perhaps it should be just harvest field.
-    #
     def harvest type, field
       connect_backend
       

data/lib/picky/types.rb

@@ -8,11 +8,12 @@ class Types
            :load_from_cache,
            :to => :@indexes
   
-  delegate :find,
+  delegate :check_caches,
+           :find,
+           :generate_cache_only,
+           :generate_index_only,
            :index,
            :index_for_tests,
-           :generate_index_only,
-           :generate_cache_only,
            :to => :@indexings
   
   def initialize

data/lib/tasks/index.rake

@@ -2,16 +2,6 @@
 #
 namespace :index do
   
-  # Not necessary anymore.
-  #
-  # namespace :directories do
-  #   desc 'Creates the directory structure for the indexes.'
-  #   task :make => :application do
-  #     Indexes.create_directory_structure
-  #     puts "Directory structure generated."
-  #   end
-  # end
-  
   desc "Takes a snapshot, indexes, and caches in random order."
   task :randomly => :application do
     Indexes.index true
@@ -26,12 +16,6 @@ namespace :index do
     Indexes.take_snapshot
   end
   
-  # desc "E.g. Generates a specific index table. Note: intermediate indexes need to be there."
-  # task :only, [:type, :field] => :application do |_, options|
-  #   type, field = options.type, options.field
-  #   Indexes.generate_index_only type.to_sym, field.to_sym
-  # end
-  
   desc "Generates a specific index from index snapshots."
   task :specific, [:type, :field] => :application do |_, options|
     type, field = options.type, options.field
@@ -39,4 +23,10 @@ namespace :index do
     Indexes.generate_cache_only type.to_sym, field.to_sym
   end
   
+  desc 'Checks the index files for files that are suspiciously small or missing.'
+  task :check => :application do
+    Indexes.check_caches
+    puts "All indexes look ok."
+  end
+  
 end

data/spec/lib/cacher/cacher_strategy_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Cacher::Strategy do
+  
+  describe "saved?" do
+    it "returns the right answer" do
+      Cacher::Strategy.new.saved?.should == true
+    end
+  end
+  
+end

data/spec/lib/cacher/similarity/none_spec.rb

@@ -7,7 +7,13 @@ describe Cacher::Similarity::None do
   before(:each) do
     @similarity = Cacher::Similarity::None.new
   end
-
+  
+  describe "saved?" do
+    it "returns the right answer" do
+      @similarity.saved?.should == false
+    end
+  end
+  
   describe 'encode' do
     it 'should always return nil' do
       @similarity.encoded(:whatever).should == nil

data/spec/lib/index/bundle_spec.rb

@@ -12,7 +12,7 @@ describe Index::Bundle do
 
   describe 'identifier' do
     it 'should return a specific identifier' do
-      @index.identifier.should == 'some_name: some_type some_category'
+      @index.identifier.should == 'some_type: some_name some_category'
     end
   end
   

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

@@ -19,7 +19,7 @@ describe Index::File::JSON do
     it "raises" do
       lambda do
         @file.retrieve
-      end.should raise_error("Can't retrieve from marshalled file. Use text file.")
+      end.should raise_error("Can't retrieve from JSON file. Use text file.")
     end
   end
   

data/spec/lib/indexing/bundle_spec.rb

@@ -14,7 +14,7 @@ describe Indexing::Bundle do
 
   describe 'identifier' do
     it 'should return a specific identifier' do
-      @index.identifier.should == 'some_name: some_type some_category'
+      @index.identifier.should == 'some_type: some_name some_category'
     end
   end
   
@@ -99,47 +99,114 @@ describe Indexing::Bundle do
       @index.dump
     end
   end
-  
+
   describe 'raise_unless_cache_exists' do
-    before(:each) do
-      @files = stub :files
-      @files.stub! :index_cache_ok? => true
-      @files.stub! :similarity_cache_ok? => true
-      @files.stub! :weights_cache_ok? => true
-      @files.stub! :index_cache_small? => false
-      @files.stub! :similarity_cache_small? => false
-      @files.stub! :weights_cache_small? => false
+    it "calls methods in order" do
+      @index.should_receive(:raise_unless_index_exists).once.ordered
+      @index.should_receive(:raise_unless_similarity_exists).once.ordered
       
-      @index.stub! :files => @files
+      @index.raise_unless_cache_exists
     end
-    context 'weights cache missing' do
+  end
+  describe 'raise_unless_index_exists' do
+    context 'partial strategy saved' do
       before(:each) do
-        @files.stub! :weights_cache_ok? => false
+        strategy = stub :strategy, :saved? => true
+        @index.stub! :partial_strategy => strategy
       end
-      it 'should raise' do
-        lambda do
-          @index.raise_unless_cache_exists
-        end.should raise_error("weights cache for some_name: some_type some_category missing.")
+      it "calls the methods in order" do
+        @index.should_receive(:warn_if_index_small).once.ordered
+        @index.should_receive(:raise_unless_index_ok).once.ordered
+        
+        @index.raise_unless_index_exists
       end
     end
-    context 'similarity cache missing' do
+    context 'partial strategy not saved' do
       before(:each) do
-        @files.stub! :similarity_cache_ok? => false
+        strategy = stub :strategy, :saved? => false
+        @index.stub! :partial_strategy => strategy
       end
-      it 'should raise' do
-        lambda do
-          @index.raise_unless_cache_exists
-        end.should raise_error("similarity cache for some_name: some_type some_category missing.")
+      it "calls nothing" do
+        @index.should_receive(:warn_if_index_small).never
+        @index.should_receive(:raise_unless_index_ok).never
+        
+        @index.raise_unless_index_exists
+      end
+    end
+  end
+  describe 'raise_unless_similarity_exists' do
+    context 'similarity strategy saved' do
+      before(:each) do
+        strategy = stub :strategy, :saved? => true
+        @index.stub! :similarity_strategy => strategy
       end
+      it "calls the methods in order" do
+        @index.should_receive(:warn_if_similarity_small).once.ordered
+        @index.should_receive(:raise_unless_similarity_ok).once.ordered
+        
+        @index.raise_unless_similarity_exists
+      end
+    end
+    context 'similarity strategy not saved' do
+      before(:each) do
+        strategy = stub :strategy, :saved? => false
+        @index.stub! :similarity_strategy => strategy
+      end
+      it "calls nothing" do
+        @index.should_receive(:warn_if_similarity_small).never
+        @index.should_receive(:raise_unless_similarity_ok).never
+        
+        @index.raise_unless_similarity_exists
+      end
+    end
+  end
+  describe 'warn_if_similarity_small' do
+    before(:each) do
+      @files = @index.files
     end
-    context 'index cache missing' do
+    context "files similarity cache small" do
       before(:each) do
-        @files.stub! :index_cache_ok? => false
+        @files.stub! :similarity_cache_small? => true
+      end
+      it "warns" do
+        @index.should_receive(:warn_cache_small).once.with :similarity
+        
+        @index.warn_if_similarity_small
+      end
+    end
+    context "files similarity cache not small" do
+      before(:each) do
+        @files.stub! :similarity_cache_small? => false
+      end
+      it "does not warn" do
+        @index.should_receive(:warn_cache_small).never
+        
+        @index.warn_if_similarity_small
+      end
+    end
+  end
+  describe 'raise_unless_similarity_ok' do
+    before(:each) do
+      @files = @index.files
+    end
+    context "files similarity cache ok" do
+      before(:each) do
+        @files.stub! :similarity_cache_ok? => true
+      end
+      it "warns" do
+        @index.should_receive(:raise_cache_missing).never
+        
+        @index.raise_unless_similarity_ok
+      end
+    end
+    context "files similarity cache not ok" do
+      before(:each) do
+        @files.stub! :similarity_cache_ok? => false
       end
-      it 'should raise' do
-        lambda do
-          @index.raise_unless_cache_exists
-        end.should raise_error("index cache for some_name: some_type some_category missing.")
+      it "does not warn" do
+        @index.should_receive(:raise_cache_missing).once.with :similarity
+        
+        @index.raise_unless_similarity_ok
       end
     end
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 11
-  - 1
-  version: 0.11.1
+  - 2
+  version: 0.11.2
 platform: ruby
 authors: 
 - Florian Hanke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-09 00:00:00 +01:00
+date: 2010-11-10 00:00:00 +01:00
 default_executable: picky
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
-description: Fast Combinatorial Ruby Search Engine
+description: Fast Ruby small-text search engine with comfortable single field interface.
 email: florian.hanke+picky@gmail.com
 executables: 
 - picky
@@ -57,6 +57,7 @@ files:
 - lib/picky/cacher/similarity/none.rb
 - lib/picky/cacher/similarity/strategy.rb
 - lib/picky/cacher/similarity_generator.rb
+- lib/picky/cacher/strategy.rb
 - lib/picky/cacher/weights/default.rb
 - lib/picky/cacher/weights/logarithmic.rb
 - lib/picky/cacher/weights/strategy.rb
@@ -159,6 +160,7 @@ files:
 - project_prototype/unicorn.ru
 - spec/ext/performant_spec.rb
 - spec/lib/application_spec.rb
+- spec/lib/cacher/cacher_strategy_spec.rb
 - spec/lib/cacher/partial/default_spec.rb
 - spec/lib/cacher/partial/none_spec.rb
 - spec/lib/cacher/partial/subtoken_spec.rb
@@ -256,10 +258,11 @@ rubyforge_project: http://rubyforge.org/projects/picky
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Picky the Search Engine
+summary: "Picky: Helps you find your data."
 test_files: 
 - spec/ext/performant_spec.rb
 - spec/lib/application_spec.rb
+- spec/lib/cacher/cacher_strategy_spec.rb
 - spec/lib/cacher/partial/default_spec.rb
 - spec/lib/cacher/partial/none_spec.rb
 - spec/lib/cacher/partial/subtoken_spec.rb