picky 2.0.0.pre1 → 2.0.0.pre2

data/lib/picky/analyzer.rb

@@ -3,9 +3,7 @@
 
 # Analyzes indexes (index bundles, actually).
 #
-# Can be output using to_s.
-#
-class Analyzer
+class Analyzer # :nodoc:all
 
   attr_reader :analysis, :comments
 

data/lib/picky/index/base.rb

@@ -21,6 +21,12 @@ module Index
     # * result_identifier: Use if you'd like a different identifier/name in the results than the name of the index.
     # * after_indexing: As of this writing only used in the db source. Executes the given after_indexing as SQL after the indexing process.
     #
+    # Example:
+    #   my_index = Index::Memory.new(:my_index, some_source) do
+    #     define_category :bla
+    #   end
+    #
+    #
     def initialize name, source, options = {}
       check name, source
 
@@ -31,6 +37,10 @@ module Index
       # Centralized registry.
       #
       Indexes.register self
+
+      #
+      #
+      instance_eval(&Proc.new) if block_given?
     end
     #
     # Since this is an API, we fail hard quickly.

data/lib/picky/indexed/indexes.rb

@@ -1,4 +1,4 @@
-module Indexed
+module Indexed # :nodoc:all
 
   # Registers the indexes held at runtime, for queries.
   #

data/lib/picky/indexing/indexes.rb

@@ -1,4 +1,4 @@
-module Indexing
+module Indexing # :nodoc:all
 
   # Registers the indexes held at index time, for indexing.
   #

data/lib/picky/internals.rb

@@ -0,0 +1,2 @@
+module Internals # :nodoc:all
+end

data/lib/picky/loader.rb

@@ -88,6 +88,8 @@ module Loader # :nodoc:all
   # (Not for the user)
   #
   def self.load_framework_internals
+    load_relative 'internals'
+
     # Load compiled C code.
     #
     load_internals 'ext/maybe_compile'
@@ -275,6 +277,7 @@ module Loader # :nodoc:all
     # Search.
     #
     load_relative 'search'
+    load_relative 'query'
     #
     # load_relative 'query/solr'
 

data/lib/picky/query.rb

@@ -0,0 +1,2 @@
+module Query # :nodoc:all
+end

data/lib/picky/results.rb

@@ -1,93 +1,89 @@
-module Internals
+# This is the internal results object. Usually, to_marshal, or to_json
+# is called on it to get a string for the answer.
+#
+class Results
 
-  # This is the internal results object. Usually, to_marshal, or to_json
-  # is called on it to get a string for the answer.
+  # Duration is set externally by the query.
   #
-  class Results
+  attr_writer :duration
+  attr_reader :allocations, :offset, :amount
 
-    # Duration is set externally by the query.
-    #
-    attr_writer :duration
-    attr_reader :allocations, :offset, :amount
-
-    # Takes instances of Query::Allocations as param.
-    #
-    def initialize amount = 0, offset = 0, allocations = Query::Allocations.new
-      @offset      = offset
-      @amount      = amount
-      @allocations = allocations
-    end
-    # Create new results and calculate the ids.
-    #
-    def self.from amount, offset, allocations
-      results = new amount, offset, allocations
-      results.prepare!
-      results
-    end
-
-    # Returns a hash with the allocations, offset, duration and total.
-    #
-    def serialize
-      { allocations: allocations.to_result,
-        offset:      offset,
-        duration:    duration,
-        total:       total }
-    end
-    # The default format is json.
-    #
-    def to_response options = {}
-      to_json options
-    end
-    # Convert to json format.
-    #
-    def to_json options = {}
-      serialize.to_json options
-    end
+  # Takes instances of Query::Allocations as param.
+  #
+  def initialize amount = 0, offset = 0, allocations = Internals::Query::Allocations.new
+    @offset      = offset
+    @amount      = amount
+    @allocations = allocations
+  end
+  # Create new results and calculate the ids.
+  #
+  def self.from amount, offset, allocations
+    results = new amount, offset, allocations
+    results.prepare!
+    results
+  end
 
-    # This starts the actual processing.
-    #
-    # Without this, the allocations are not processed,
-    # and no ids are calculated.
-    #
-    def prepare!
-      allocations.process! amount, offset
-    end
+  # Returns a hash with the allocations, offset, duration and total.
+  #
+  def serialize
+    { allocations: allocations.to_result,
+      offset:      offset,
+      duration:    duration,
+      total:       total }
+  end
+  # The default format is json.
+  #
+  def to_response options = {}
+    to_json options
+  end
+  # Convert to json format.
+  #
+  def to_json options = {}
+    serialize.to_json options
+  end
 
-    # Duration default is 0.
-    #
-    def duration
-      @duration || 0
-    end
-    # The total results. Delegates to the allocations.
-    #
-    # Caches.
-    #
-    def total
-      @total || @total = allocations.total || 0
-    end
+  # This starts the actual processing.
+  #
+  # Without this, the allocations are not processed,
+  # and no ids are calculated.
+  #
+  def prepare!
+    allocations.process! amount, offset
+  end
 
-    # Convenience methods.
-    #
+  # Duration default is 0.
+  #
+  def duration
+    @duration || 0
+  end
+  # The total results. Delegates to the allocations.
+  #
+  # Caches.
+  #
+  def total
+    @total || @total = allocations.total || 0
+  end
 
-    # Delegates to allocations.
-    #
-    def ids amount = 20
-      allocations.ids amount
-    end
+  # Convenience methods.
+  #
 
-    # Human readable log.
-    #
-    def to_log query
-      "#{log_type}|#{Time.now.to_s(:db)}|#{'%8f' % duration}|#{'%-50s' % query}|#{'%8d' % total}|#{'%4d' % offset}|#{'%2d' % allocations.size}|"
-    end
-    # The first character in the blog designates what type of query it is.
-    #
-    # No calculated ids means: No results.
-    #
-    def log_type
-      amount.zero?? :'.' : :'>'
-    end
+  # Delegates to allocations.
+  #
+  def ids amount = 20
+    allocations.ids amount
+  end
 
+  # Human readable log.
+  #
+  def to_log query
+    "#{log_type}|#{Time.now.to_s(:db)}|#{'%8f' % duration}|#{'%-50s' % query}|#{'%8d' % total}|#{'%4d' % offset}|#{'%2d' % allocations.size}|"
+  end
+  # The first character in the blog designates what type of query it is.
+  #
+  # No calculated ids means: No results.
+  #
+  def log_type
+    amount.zero?? :'.' : :'>'
   end
 
 end

data/lib/picky/search.rb

@@ -99,7 +99,7 @@ class Search
   # Note: Internal method, use #search_with_text.
   #
   def execute tokens, ids, offset
-    Internals::Results.from ids, offset, sorted_allocations(tokens)
+    Results.from ids, offset, sorted_allocations(tokens)
   end
 
   # Delegates the tokenizing to the query tokenizer.

data/lib/picky/statistics.rb

@@ -1,12 +1,9 @@
 # encoding: utf-8
 #
 
-# Gathers different statistics
-# when methods are called.
+# Gathers various statistics.
 #
-# Can be output using to_s.
-#
-class Statistics
+class Statistics # :nodoc:all
 
   def self.instance
     @statistics ||= new

data/lib/tasks/try.rake

@@ -6,7 +6,7 @@ namespace :try do
   task :index, [:text, :index, :category] => :application do |_, options|
     text, index, category = options.text, options.index, options.category
 
-    tokenizer = index && category ? Indexes.find(index, category).tokenizer : Internals::Tokenizers::Index.default
+    tokenizer = category ? Indexes.find(index, category).tokenizer : Internals::Tokenizers::Index.default
 
     puts "\"#{text}\" is saved in the index as             #{tokenizer.tokenize(text.dup).to_a}"
   end
@@ -22,6 +22,9 @@ namespace :try do
   task :both, [:text, :index, :category] => :application do |_, options|
     text, index, category = options.text, options.index, options.category
 
+    puts
+    fail "\x1b[31mrake try needs a text to try indexing and query preparation\x1b[m, e.g. rake 'try[yourtext]'." unless text
+
     Rake::Task[:"try:index"].invoke text, index, category
     Rake::Task[:"try:query"].invoke text
   end

data/spec/lib/application_spec.rb

@@ -47,10 +47,11 @@ 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: ',')
-          geo_index.define_category :location
-          geo_index.define_ranged_category(:north1, 1, precision: 3, from: :north)
-                   .define_ranged_category(:east1,  1, precision: 3, from: :east)
+          geo_index = Index::Memory.new :geo, Sources::CSV.new(:location, :north, :east, file: 'data/ch.csv', col_sep: ',') do
+            category        :location
+            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.
           

data/spec/lib/internals/frontend_adapters/rack_spec.rb

@@ -102,7 +102,7 @@ describe Internals::FrontendAdapters::Rack do
       env = rack_defaults_for '/searches/some_route?query=some_query'
       
       search = stub :search
-      search.should_receive(:search_with_text).once.with(anything, 20, 0).and_return(Internals::Results.new)
+      search.should_receive(:search_with_text).once.with(anything, 20, 0).and_return(Results.new)
       Search.stub! :new => search
       
       @rack_adapter.route '/searches/some_route' => Search.new(:some_index, :some_other_index)
@@ -114,7 +114,7 @@ describe Internals::FrontendAdapters::Rack do
       env = rack_defaults_for '/searches/some_route?query=some_query&type=some_type'
       
       search = stub :search
-      search.should_receive(:search_with_text).once.with(anything, 20, 0).and_return(Internals::Results.new)
+      search.should_receive(:search_with_text).once.with(anything, 20, 0).and_return(Results.new)
       Search.stub! :new => search
       
       @rack_adapter.route '/searches/some_route' => Search.new(:some_index, :some_other_index), :query => { :type => :some_type }

data/spec/lib/results_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Internals::Results do
+describe Results do
   
   describe "from" do
     before(:each) do

metadata

@@ -2,7 +2,7 @@
 name: picky
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 2.0.0.pre1
+  version: 2.0.0.pre2
 platform: ruby
 authors: 
 - Florian Hanke
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-18 00:00:00 +01:00
+date: 2011-03-21 00:00:00 +01:00
 default_executable: picky
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,9 +127,11 @@ files:
 - lib/picky/internals/tokenizers/base.rb
 - lib/picky/internals/tokenizers/index.rb
 - lib/picky/internals/tokenizers/query.rb
+- lib/picky/internals.rb
 - lib/picky/loader.rb
 - lib/picky/loggers/search.rb
 - lib/picky/query/solr.rb
+- lib/picky/query.rb
 - lib/picky/rack/harakiri.rb
 - lib/picky/results.rb
 - lib/picky/search.rb